1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>PortIO, python low level port I/O for Linux x86 — PortIO 0.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/default.css" />
<script src="_static/documentation_options.js?v=1c28bd9a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="portio-python-low-level-port-i-o-for-linux-x86">
<h1>PortIO, python low level port I/O for Linux x86</h1>
<section id="what-is">
<h2>What is</h2>
<p>PortIO is a Python wrapper for the port I/O macros like <strong>outb, inb</strong>, etc.
provided by the C library on Linux x86 platforms. Both python 2 and 3 are
supported. This module is useful when a general pourpose port I/O at the low
level is needed. Programmers that want to perform I/O on the parallel port
at an higher level, will be better satisfied by the
<a class="reference external" href="https://github.com/pyparallel/pyparallel">pyParallel</a> module.
A similar module Ioport has inspired the writing of PortIO.</p>
<p>PortIO is released under the <a class="reference external" href="http://www.gnu.org/licenses/gpl.txt">GNU General Public License</a>.</p>
<p><em>At present, version 0.6.2, PortIO is in beta status. Any debugging aid is
welcome.</em></p>
<p>For any question, suggestion, contribution contact the author
<cite>Fabrizio Pollastri</cite> <mxgbot_a_t_gmail.com>.</p>
<p>The PortIO web site is hosted at <a class="reference external" href="http://portio.inrim.it/">http://portio.inrim.it/</a>.</p>
</section>
<section id="usage-example">
<h2>Usage example</h2>
<p>This sample program toggle on and off all the data lines of the parallel port
lp0 with a 6 seconds period. Note the check for root privileges before
the call to <strong>ioperm</strong> to acquire the proper I/O permissions for the involved
ports.</p>
<p>Download the sample program <a class="reference external" href="./toggle.py">toggle.py</a></p>
</section>
<section id="module-reference">
<h2>Module reference</h2>
<p>PortIO is a Python front end to the low level functions provided by the
C library on Linux 386 platforms for the hardware input and output ports:
<strong>outb, outw, outl, outsb, outsw, outsl, outb_p, outw_p, outl_p, inb, inw,
inl, insb, insw, insl, inb_p, inw_p, inl_p, ioperm, iopl</strong>.</p>
<p>Before doing port I/O, it is mandatory to acquire proper privileges by
calling <strong>ioperm</strong> or <strong>iopl</strong>. Otherwise you will get a segmentation fault.</p>
<dl>
<dt><strong>outb (data,port)</strong></dt><dd><p>Output the byte <strong>data</strong> to the I/O address <strong>port</strong>.</p>
</dd>
<dt><strong>outb_p (data,port)</strong></dt><dd><p>The same as <strong>outb</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>outw (data,port)</strong></dt><dd><p>Output the 16 bit word <strong>data</strong> to the I/O address <strong>port</strong>.</p>
</dd>
<dt><strong>outw_p (data,port)</strong></dt><dd><p>The same as <strong>outw</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>outl (data,port)</strong></dt><dd><p>Output the 32 bit word <strong>data</strong> to the I/O address <strong>port</strong>.</p>
</dd>
<dt><strong>outl_p (data,port)</strong></dt><dd><p>The same as <strong>outl</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>outsb (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the output of a byte to the I/O address <strong>port</strong>,
reading it from buffer of bytes starting at <strong>data</strong> and with length
<strong>count</strong>.</p>
</dd>
<dt><strong>outsw (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the output of a 16 bit word to the I/O address
<strong>port</strong>, reading it from buffer of 16 bit words starting at <strong>data</strong> and
with length <strong>count</strong> x 2.</p>
</dd>
<dt><strong>outsl (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the output of a 32 bit word to the I/O address
<strong>port</strong>, reading it from buffer of 32 bit words starting at <strong>data</strong> and
with length <strong>count</strong> x 4.</p>
</dd>
<dt><strong>inb (port)</strong></dt><dd><p>Input a byte from the I/O address <strong>port</strong> and return it as integer.</p>
</dd>
<dt><strong>inb_p (port)</strong></dt><dd><p>The same as <strong>inb</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>inw (port)</strong></dt><dd><p>Input a 16 bit word from the I/O address <strong>port</strong> and return it as integer.</p>
</dd>
<dt><strong>inw_p (port)</strong></dt><dd><p>The same as <strong>inw</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>inl (port)</strong></dt><dd><p>Input a 32 bit word from the I/O address <strong>port</strong> and return it as integer.</p>
</dd>
<dt><strong>inl_p (port)</strong></dt><dd><p>The same as <strong>inl</strong>, but waits for I/O completion.</p>
</dd>
<dt><strong>insb (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the input of a byte from the I/O address <strong>port</strong>
and write it to a buffer of bytes starting at <strong>data</strong> and with length
<strong>count</strong> bytes.</p>
</dd>
<dt><strong>insw (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the input of a 16 bit word from the I/O address
<strong>port</strong> and write it to a buffer of 16 bit words starting at <strong>data</strong>
and with length <strong>count</strong> x 2 bytes.</p>
</dd>
<dt><strong>insl (port,data,count)</strong></dt><dd><p>Repeat <strong>count</strong> times the input of a 32 bit word from the I/O address
<strong>port</strong> and write it to a buffer of 32 bit words starting at <strong>data</strong>
and with length <strong>count</strong> x 4 bytes.</p>
</dd>
<dt><strong>ioperm (from,extent,enable)</strong></dt><dd><p>Set port access permission starting from address <strong>from</strong> for <strong>extent</strong>
bytes. If the <strong>enable</strong> is True, access is enabled, otherwise is disabled.
On success, zero is returned. On error, the errno code is returned.
The use of ioperm requires root privileges.</p>
<p>Only the first 0x3ff I/O ports can be specified in this manner. To gain
access to any I/O port in the whole (0x0000-0xffff) address range, use
the iopl function.</p>
</dd>
<dt><strong>iopl (level)</strong></dt><dd><p>Set the I/O privilege level of the current process. When <strong>level</strong> is 3
access is granted to any I/O port.
On success, zero is returned. On error, the errno code is returned.
The use of iopl requires root privileges.</p>
</dd>
</dl>
</section>
<section id="requirements">
<h2>Requirements</h2>
<p>A <strong>linux on an X86 architecture</strong>.</p>
<p>To run the code, <strong>Python 2.6 or later</strong> or <strong>Python 3.0 or later</strong> must
already be installed. The latest release is recommended. Python is
available from <a class="reference external" href="http://www.python.org/">http://www.python.org/</a>.</p>
</section>
<section id="installation">
<h2>Installation</h2>
<section id="with-easy-install">
<h3>With easy_install</h3>
<ol class="arabic">
<li><p>Open a shell.</p></li>
<li><p>Get root privileges and install the package. Command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">portio</span>
</pre></div>
</div>
</li>
</ol>
</section>
<section id="from-tarball">
<h3>From tarball</h3>
<p>Download PortIO tarball from <a class="reference external" href="http://portio.inrim.it/portio-0.6.2.tar.gz">http://portio.inrim.it/portio-0.6.2.tar.gz</a> .</p>
<p>The first step is to expand the <code class="docutils literal notranslate"><span class="pre">.tgz</span></code> archive in a temporary
directory (<strong>not</strong> directly in Python’s <code class="docutils literal notranslate"><span class="pre">site-packages</span></code>). It
contains a distutils setup file “setup.py”.</p>
<ol class="arabic">
<li><p>Open a shell.</p></li>
<li><p>Unpack the tarball in a temporary directory (<strong>not</strong> directly in
Python’s <code class="docutils literal notranslate"><span class="pre">site-packages</span></code>). Command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tar</span> <span class="n">zxf</span> <span class="n">portio</span><span class="o">-</span><span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">gz</span>
</pre></div>
</div>
<p>X and Y are the major and minor version numbers of the tarball.</p>
</li>
</ol>
<ol class="arabic" start="2">
<li><p>Go to the directory created by expanding the tarball. Command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">portio</span><span class="o">-</span><span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span>
</pre></div>
</div>
</li>
<li><p>Get root privileges and install the package. Command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">su</span>
<span class="p">(</span><span class="n">enter</span> <span class="n">root</span> <span class="n">password</span><span class="p">)</span>
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">build</span>
</pre></div>
</div>
<p>If the python executable isn’t on your path, you’ll have to specify
the complete path, such as /usr/local/bin/python.</p>
</li>
</ol>
</section>
</section>
<section id="changelog">
<h2>Changelog</h2>
<p><strong>Portio 0.6.2 released 19-Oct-2024</strong></p>
<ul class="simple">
<li><p>Remove absolute paths and cleanup build, contributed by James Hilliard
<james.hilliard1_a_t_gmail.com></p></li>
</ul>
<p><strong>Portio 0.6.0 released 14-Jul-2024</strong></p>
<ul class="simple">
<li><p>Use Py_buffer instead of C strings, contributed by Stephen Horvath
<me_a_t_stevetech.au></p></li>
<li><p>Add pyproject.toml file</p></li>
</ul>
<p><strong>Portio 0.5 released 25-Oct-2012</strong></p>
<ul class="simple">
<li><p>Porting to python 3 also contributed by Stjepan Henc <sthenc_a_t_gmail.com>.</p></li>
</ul>
<p><strong>Portio 0.4 released 25-Aug-2009</strong></p>
<ul class="simple">
<li><p>Fixed some argument type mismatch in I/O macros.</p></li>
<li><p>Upgraded PyArg_ParseTuple format strings with the new “unsigned” formats
available from python 2.3 . So portio now requires python version => 2.3 .</p></li>
</ul>
<p><strong>Portio 0.3 released 21-May-2009</strong></p>
<ul class="simple">
<li><p>Fixed missing documentation files.</p></li>
</ul>
<p><strong>Portio 0.2 released 11-Nov-2008</strong></p>
<ul class="simple">
<li><p>Added return of status code for <strong>ioperm</strong> and <strong>iopl</strong>.</p></li>
<li><p>Fixed invalid argument type for <strong>ioperm</strong>.</p></li>
<li><p>Updated <strong>toggle.py</strong> example with <strong>ioperm</strong> error check.</p></li>
<li><p>Generated documentation with Sphinx.</p></li>
</ul>
<p><strong>Portio 0.1 released 23-Feb-2006</strong></p>
<ul class="simple">
<li><p>First release.</p></li>
</ul>
</section>
<section id="credits">
<h2>Credits</h2>
<ul class="simple">
<li><p>Thanks to Stjepan Henc <sthenc_a_t_gmail.com> for his contribution to python 3 porting.</p></li>
</ul>
<hr class="docutils" />
<p>Copyright 2006-2024 by <cite>Fabrizio Pollastri</cite> <mxgbot_a_t_gmail.com></p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">PortIO</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2006-2024, Fabrizio Pollastri.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/README.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|
