Import 2.3.99pre3-7
[davej-history.git] / Documentation / parport.txt
blobb4d7ff89585aeca548389edcaf2bdcb9a95c83cc
1 The `parport' code provides parallel-port support under Linux.  This
2 includes the ability to share one port between multiple device
3 drivers.
5 You can pass parameters to the parport code to override its automatic
6 detection of your hardware.  This is particularly useful if you want
7 to use IRQs, since in general these can't be autoprobed successfully.
8 By default IRQs are not used even if they _can_ be probed.  This is
9 because there are a lot of people using the same IRQ for their
10 parallel port and a sound card or network card.
12 The parport code is split into two parts: generic (which deals with
13 port-sharing) and architecture-dependent (which deals with actually
14 using the port).
17 Parport as modules
18 ==================
20 If you load the parport code as a module, say
22         # insmod parport.o
24 to load the generic parport code.  You then must load the
25 architecture-dependent code with (for example):
27         # insmod parport_pc.o io=0x3bc,0x378,0x278 irq=none,7,auto
29 to tell the parport code that you want three PC-style ports, one at
30 0x3bc with no IRQ, one at 0x378 using IRQ 7, and one at 0x278 with an
31 auto-detected IRQ.  Currently, PC-style (parport_pc), Sun `bpp',
32 Amiga, Atari, and MFC3 hardware is supported.
34 PCI parallel I/O card support comes from parport_pc.  Base I/O
35 addresses should not be specified for supported PCI cards since they
36 are automatically detected.
39 KMod
40 ----
42 If you use kmod, you will find it useful to edit /etc/modules.conf.
43 Here is an example of the lines that need to be added:
45         alias parport_lowlevel parport_pc
46         options parport_pc io=0x378,0x278 irq=7,auto
48 KMod will then automatically load parport_pc (with the options
49 "io=0x378,0x278 irq=7,auto") whenever a parallel port device driver
50 (such as lp) is loaded.
52 Note that these are example lines only!  You shouldn't in general need
53 to specify any options to parport_pc in order to be able to use a
54 parallel port.
57 Parport probe [optional]
58 -------------
60 In 2.2 kernels there was a module called parport_probe, which was used
61 for collecting IEEE 1284 device ID information.  This has now been
62 enhanced and now lives with the IEEE 1284 support.  When a parallel
63 port is detected, the devices that are connected to it are analysed,
64 and information is logged like this:
66         parport0: Printer, BJC-210 (Canon)
68 The probe information is available from files in /proc/sys/dev/parport/.
71 Parport linked into the kernel statically
72 =========================================
74 If you compile the parport code into the kernel, then you can use
75 kernel boot parameters to get the same effect.  Add something like the
76 following to your LILO command line:
78         parport=0x3bc parport=0x378,7 parport=0x278,auto,nofifo
80 You can have many `parport=...' statements, one for each port you want
81 to add.  Adding `parport=0' to the kernel command-line will disable
82 parport support entirely.  Adding `parport=auto' to the kernel
83 command-line will make parport use any IRQ lines or DMA channels that
84 it auto-detects.
87 Files in /proc
88 ==============
90 If you have configured the /proc filesystem into your kernel, you will
91 see a new directory entry: /proc/sys/dev/parport.  In there will be a
92 directory entry for each parallel port for which parport is
93 configured.  In each of those directories are a collection of files
94 describing that parallel port.
96 The /proc/sys/dev/parport directory tree looks like:
98 parport
99 |-- default
100 |   |-- spintime
101 |   `-- timeslice
102 |-- parport0
103 |   |-- autoprobe
104 |   |-- autoprobe0
105 |   |-- autoprobe1
106 |   |-- autoprobe2
107 |   |-- autoprobe3
108 |   |-- devices
109 |   |   |-- active
110 |   |   `-- lp
111 |   |       `-- timeslice
112 |   |-- hardware
113 |   `-- spintime
114 `-- parport1
115     |-- autoprobe
116     |-- autoprobe0
117     |-- autoprobe1
118     |-- autoprobe2
119     |-- autoprobe3
120     |-- devices
121     |   |-- active
122     |   `-- ppa
123     |       `-- timeslice
124     |-- hardware
125     `-- spintime
128 File:           Contents:
130 devices/active  A list of the device drivers using that port.  A "+"
131                 will appear by the name of the device currently using
132                 the port (it might not appear against any).  The
133                 string "none" means that there are no device drivers
134                 using that port.
136 hardware        Parallel port's base address, IRQ line and DMA channel.
138 autoprobe       Any IEEE-1284 device ID information that has been
139                 acquired from the (non-IEEE 1284.3) device.
141 autoprobe[0-3]  IEEE 1284 device ID information retrieved from
142                 daisy-chain devices that conform to IEEE 1284.3.
144 spintime        The number of microseconds to busy-loop while waiting
145                 for the peripheral to respond.  You might find that
146                 adjusting this improves performance, depending on your
147                 peripherals.  This is a port-wide setting, i.e. it
148                 applies to all devices on a particular port.
150 timeslice       The number of miliseconds that a device driver is
151                 allowed to keep a port claimed for.  This is advisory,
152                 and driver can ignore it if it must.
154 default/*       The defaults for spintime and timeslice. When a new
155                 port is registered, it picks up the default spintime.
156                 When a new device is registered, it picks up the
157                 default timeslice.
159 Device drivers
160 ==============
162 Once the parport code is initialised, you can attach device drivers to
163 specific ports.  Normally this happens automatically; if the lp driver
164 is loaded it will create one lp device for each port found.  You can
165 override this, though, by using parameters either when you load the lp
166 driver:
168         # insmod lp.o parport=0,2
170 or on the LILO command line:
172         lp=parport0 lp=parport2
174 Both the above examples would inform lp that you want /dev/lp0 to be
175 the first parallel port, and /dev/lp1 to be the _third_ parallel port,
176 with no lp device associated with the second port (parport1).  Note
177 that this is different to the way older kernels worked; there used to
178 be a static association between the I/O port address and the device
179 name, so /dev/lp0 was always the port at 0x3bc.  This is no longer the
180 case - if you only have one port, it will default to being /dev/lp0,
181 regardless of base address.
183 Also:
185  * If you selected the IEEE 1284 support at compile time, you can say
186    `lp=auto' on the kernel command line, and lp will create devices
187    only for those ports that seem to have printers attached.
189  * If you give PLIP the `timid' parameter, either with `plip=timid' on
190    the command line, or with `insmod plip timid=1' when using modules,
191    it will avoid any ports that seem to be in use by other devices.
193  * IRQ autoprobing works only for a few port types at the moment.
196 Philip.Blundell@pobox.com
197 tim@cyberelk.demon.co.uk