1 /* $Id: parport.h,v 1.1 1998/05/17 10:57:52 andrea Exp andrea $ */
4 * Any part of this program may be used in documents licensed under
5 * the GNU Free Documentation License, Version 1.1 or any later version
6 * published by the Free Software Foundation.
12 /* Start off with user-visible constants */
14 /* Maximum of 16 ports per machine */
15 #define PARPORT_MAX 16
18 #define PARPORT_IRQ_NONE -1
19 #define PARPORT_DMA_NONE -1
20 #define PARPORT_IRQ_AUTO -2
21 #define PARPORT_DMA_AUTO -2
22 #define PARPORT_DMA_NOFIFO -3
23 #define PARPORT_DISABLE -2
24 #define PARPORT_IRQ_PROBEONLY -3
25 #define PARPORT_IOHI_AUTO -1
27 #define PARPORT_CONTROL_STROBE 0x1
28 #define PARPORT_CONTROL_AUTOFD 0x2
29 #define PARPORT_CONTROL_INIT 0x4
30 #define PARPORT_CONTROL_SELECT 0x8
32 #define PARPORT_STATUS_ERROR 0x8
33 #define PARPORT_STATUS_SELECT 0x10
34 #define PARPORT_STATUS_PAPEROUT 0x20
35 #define PARPORT_STATUS_ACK 0x40
36 #define PARPORT_STATUS_BUSY 0x80
38 /* Type classes for Plug-and-Play probe. */
40 PARPORT_CLASS_LEGACY = 0, /* Non-IEEE1284 device */
41 PARPORT_CLASS_PRINTER,
44 PARPORT_CLASS_HDC, /* Hard disk controller */
46 PARPORT_CLASS_MEDIA, /* Multimedia device */
47 PARPORT_CLASS_FDC, /* Floppy disk controller */
49 PARPORT_CLASS_SCANNER,
51 PARPORT_CLASS_OTHER, /* Anything else */
52 PARPORT_CLASS_UNSPEC, /* No CLS field in ID */
53 PARPORT_CLASS_SCSIADAPTER
54 } parport_device_class;
56 /* The "modes" entry in parport is a bit field representing the
57 capabilities of the hardware. */
58 #define PARPORT_MODE_PCSPP (1<<0) /* IBM PC registers available. */
59 #define PARPORT_MODE_TRISTATE (1<<1) /* Can tristate. */
60 #define PARPORT_MODE_EPP (1<<2) /* Hardware EPP. */
61 #define PARPORT_MODE_ECP (1<<3) /* Hardware ECP. */
62 #define PARPORT_MODE_COMPAT (1<<4) /* Hardware 'printer protocol'. */
63 #define PARPORT_MODE_DMA (1<<5) /* Hardware can DMA. */
64 #define PARPORT_MODE_SAFEININT (1<<6) /* SPP registers accessible in IRQ. */
67 Nibble mode, byte mode, ECP, ECPRLE and EPP are their own
68 'extensibility request' values. Others are special.
69 'Real' ECP modes must have the IEEE1284_MODE_ECP bit set. */
70 #define IEEE1284_MODE_NIBBLE 0
71 #define IEEE1284_MODE_BYTE (1<<0)
72 #define IEEE1284_MODE_COMPAT (1<<8)
73 #define IEEE1284_MODE_BECP (1<<9) /* Bounded ECP mode */
74 #define IEEE1284_MODE_ECP (1<<4)
75 #define IEEE1284_MODE_ECPRLE (IEEE1284_MODE_ECP | (1<<5))
76 #define IEEE1284_MODE_ECPSWE (1<<10) /* Software-emulated */
77 #define IEEE1284_MODE_EPP (1<<6)
78 #define IEEE1284_MODE_EPPSL (1<<11) /* EPP 1.7 */
79 #define IEEE1284_MODE_EPPSWE (1<<12) /* Software-emulated */
80 #define IEEE1284_DEVICEID (1<<2) /* This is a flag */
81 #define IEEE1284_EXT_LINK (1<<14) /* This flag causes the
82 * extensibility link to
86 /* For the benefit of parport_read/write, you can use these with
87 * parport_negotiate to use address operations. They have no effect
88 * other than to make parport_read/write use address transfers. */
89 #define IEEE1284_ADDR (1<<13) /* This is a flag */
90 #define IEEE1284_DATA 0 /* So is this */
92 /* Flags for block transfer operations. */
93 #define PARPORT_EPP_FAST (1<<0) /* Unreliable counts. */
94 #define PARPORT_W91284PIC (1<<1) /* have a Warp9 w91284pic in the device */
96 /* The rest is for the kernel only */
99 #include <linux/config.h>
100 #include <linux/jiffies.h>
101 #include <linux/proc_fs.h>
102 #include <linux/spinlock.h>
103 #include <linux/wait.h>
104 #include <asm/system.h>
105 #include <asm/ptrace.h>
106 #include <asm/semaphore.h>
108 #define PARPORT_NEED_GENERIC_OPS
110 /* Define this later. */
114 struct pc_parport_state {
119 struct ax_parport_state {
125 /* used by both parport_amiga and parport_mfc3 */
126 struct amiga_parport_state {
127 unsigned char data; /* ciaa.prb */
128 unsigned char datadir; /* ciaa.ddrb */
129 unsigned char status; /* ciab.pra & 7 */
130 unsigned char statusdir;/* ciab.ddrb & 7 */
133 struct parport_state {
135 struct pc_parport_state pc;
136 /* ARC has no state. */
137 struct ax_parport_state ax;
138 struct amiga_parport_state amiga;
139 /* Atari has not state. */
144 struct parport_operations {
145 /* IBM PC-style virtual registers. */
146 void (*write_data)(struct parport *, unsigned char);
147 unsigned char (*read_data)(struct parport *);
149 void (*write_control)(struct parport *, unsigned char);
150 unsigned char (*read_control)(struct parport *);
151 unsigned char (*frob_control)(struct parport *, unsigned char mask,
154 unsigned char (*read_status)(struct parport *);
157 void (*enable_irq)(struct parport *);
158 void (*disable_irq)(struct parport *);
160 /* Data direction. */
161 void (*data_forward) (struct parport *);
162 void (*data_reverse) (struct parport *);
164 /* For core parport code. */
165 void (*init_state)(struct pardevice *, struct parport_state *);
166 void (*save_state)(struct parport *, struct parport_state *);
167 void (*restore_state)(struct parport *, struct parport_state *);
169 /* Block read/write */
170 size_t (*epp_write_data) (struct parport *port, const void *buf,
171 size_t len, int flags);
172 size_t (*epp_read_data) (struct parport *port, void *buf, size_t len,
174 size_t (*epp_write_addr) (struct parport *port, const void *buf,
175 size_t len, int flags);
176 size_t (*epp_read_addr) (struct parport *port, void *buf, size_t len,
179 size_t (*ecp_write_data) (struct parport *port, const void *buf,
180 size_t len, int flags);
181 size_t (*ecp_read_data) (struct parport *port, void *buf, size_t len,
183 size_t (*ecp_write_addr) (struct parport *port, const void *buf,
184 size_t len, int flags);
186 size_t (*compat_write_data) (struct parport *port, const void *buf,
187 size_t len, int flags);
188 size_t (*nibble_read_data) (struct parport *port, void *buf,
189 size_t len, int flags);
190 size_t (*byte_read_data) (struct parport *port, void *buf,
191 size_t len, int flags);
192 struct module *owner;
195 struct parport_device_info {
196 parport_device_class class;
197 const char *class_name;
201 const char *description;
204 /* Each device can have two callback functions:
205 * 1) a preemption function, called by the resource manager to request
206 * that the driver relinquish control of the port. The driver should
207 * return zero if it agrees to release the port, and nonzero if it
208 * refuses. Do not call parport_release() - the kernel will do this
211 * 2) a wake-up function, called by the resource manager to tell drivers
212 * that the port is available to be claimed. If a driver wants to use
213 * the port, it should call parport_claim() here.
216 /* A parallel port device */
219 struct parport *port;
221 int (*preempt)(void *);
222 void (*wakeup)(void *);
224 void (*irq_func)(int, void *, struct pt_regs *);
226 struct pardevice *next;
227 struct pardevice *prev;
228 struct parport_state *state; /* saved status over preemption */
229 wait_queue_head_t wait_q;
230 unsigned long int time;
231 unsigned long int timeslice;
232 volatile long int timeout;
233 unsigned long waiting; /* long req'd for set_bit --RR */
234 struct pardevice *waitprev;
235 struct pardevice *waitnext;
239 /* IEEE1284 information */
241 /* IEEE1284 phases */
242 enum ieee1284_phase {
243 IEEE1284_PH_FWD_DATA,
244 IEEE1284_PH_FWD_IDLE,
245 IEEE1284_PH_TERMINATE,
246 IEEE1284_PH_NEGOTIATION,
247 IEEE1284_PH_HBUSY_DNA,
248 IEEE1284_PH_REV_IDLE,
249 IEEE1284_PH_HBUSY_DAVAIL,
250 IEEE1284_PH_REV_DATA,
251 IEEE1284_PH_ECP_SETUP,
252 IEEE1284_PH_ECP_FWD_TO_REV,
253 IEEE1284_PH_ECP_REV_TO_FWD,
254 IEEE1284_PH_ECP_DIR_UNKNOWN,
256 struct ieee1284_info {
258 volatile enum ieee1284_phase phase;
259 struct semaphore irq;
262 /* A parallel port */
264 unsigned long base; /* base address */
265 unsigned long base_hi; /* base address (hi - ECR) */
266 unsigned int size; /* IO extent */
269 int irq; /* interrupt (or -1 for none) */
271 int muxport; /* which muxport (if any) this is */
272 int portnum; /* which physical parallel port (not mux) */
274 struct parport *physport;
275 /* If this is a non-default mux
276 parport, i.e. we're a clone of a real
277 physical port, this is a pointer to that
278 port. The locking is only done in the
279 real port. For a clone port, the
280 following structure members are
281 meaningless: devices, cad, muxsel,
282 waithead, waittail, flags, pdir,
285 It this is a default mux parport, or
286 there is no mux involved, this points to
289 struct pardevice *devices;
290 struct pardevice *cad; /* port owner */
291 int daisy; /* currently selected daisy addr */
292 int muxsel; /* currently selected mux port */
294 struct pardevice *waithead;
295 struct pardevice *waittail;
297 struct list_head list;
301 struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
302 struct ieee1284_info ieee1284;
304 struct parport_operations *ops;
305 void *private_data; /* for lowlevel driver */
307 int number; /* port index - the `n' in `parportn' */
308 spinlock_t pardevice_lock;
309 spinlock_t waitlist_lock;
315 struct list_head full_list;
316 struct parport *slaves[3];
319 #define DEFAULT_SPIN_TIME 500 /* us */
321 struct parport_driver {
323 void (*attach) (struct parport *);
324 void (*detach) (struct parport *);
325 struct list_head list;
328 /* parport_register_port registers a new parallel port at the given
329 address (if one does not already exist) and returns a pointer to it.
330 This entails claiming the I/O region, IRQ and DMA. NULL is returned
331 if initialisation fails. */
332 struct parport *parport_register_port(unsigned long base, int irq, int dma,
333 struct parport_operations *ops);
335 /* Once a registered port is ready for high-level drivers to use, the
336 low-level driver that registered it should announce it. This will
337 call the high-level drivers' attach() functions (after things like
338 determining the IEEE 1284.3 topology of the port and collecting
340 void parport_announce_port (struct parport *port);
342 /* Unregister a port. */
343 extern void parport_remove_port(struct parport *port);
345 /* Register a new high-level driver. */
346 extern int parport_register_driver (struct parport_driver *);
348 /* Unregister a high-level driver. */
349 extern void parport_unregister_driver (struct parport_driver *);
351 /* If parport_register_driver doesn't fit your needs, perhaps
352 * parport_find_xxx does. */
353 extern struct parport *parport_find_number (int);
354 extern struct parport *parport_find_base (unsigned long);
356 /* Reference counting for ports. */
357 extern struct parport *parport_get_port (struct parport *);
358 extern void parport_put_port (struct parport *);
360 /* parport_register_device declares that a device is connected to a
361 port, and tells the kernel all it needs to know.
362 - pf is the preemption function (may be NULL for no callback)
363 - kf is the wake-up function (may be NULL for no callback)
364 - irq_func is the interrupt handler (may be NULL for no interrupts)
365 - handle is a user pointer that gets handed to callback functions. */
366 struct pardevice *parport_register_device(struct parport *port,
368 int (*pf)(void *), void (*kf)(void *),
369 void (*irq_func)(int, void *, struct pt_regs *),
370 int flags, void *handle);
372 /* parport_unregister unlinks a device from the chain. */
373 extern void parport_unregister_device(struct pardevice *dev);
375 /* parport_claim tries to gain ownership of the port for a particular
376 driver. This may fail (return non-zero) if another driver is busy.
377 If this driver has registered an interrupt handler, it will be
379 extern int parport_claim(struct pardevice *dev);
381 /* parport_claim_or_block is the same, but sleeps if the port cannot
382 be claimed. Return value is 1 if it slept, 0 normally and -errno
384 extern int parport_claim_or_block(struct pardevice *dev);
386 /* parport_release reverses a previous parport_claim. This can never
387 fail, though the effects are undefined (except that they are bad)
388 if you didn't previously own the port. Once you have released the
389 port you should make sure that neither your code nor the hardware
390 on the port tries to initiate any communication without first
391 re-claiming the port. If you mess with the port state (enabling
392 ECP for example) you should clean up before releasing the port. */
394 extern void parport_release(struct pardevice *dev);
397 * parport_yield - relinquish a parallel port temporarily
398 * @dev: a device on the parallel port
400 * This function relinquishes the port if it would be helpful to other
401 * drivers to do so. Afterwards it tries to reclaim the port using
402 * parport_claim(), and the return value is the same as for
403 * parport_claim(). If it fails, the port is left unclaimed and it is
404 * the driver's responsibility to reclaim the port.
406 * The parport_yield() and parport_yield_blocking() functions are for
407 * marking points in the driver at which other drivers may claim the
408 * port and use their devices. Yielding the port is similar to
409 * releasing it and reclaiming it, but is more efficient because no
410 * action is taken if there are no other devices needing the port. In
411 * fact, nothing is done even if there are other devices waiting but
412 * the current device is still within its "timeslice". The default
413 * timeslice is half a second, but it can be adjusted via the /proc
416 static __inline__ int parport_yield(struct pardevice *dev)
418 unsigned long int timeslip = (jiffies - dev->time);
419 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
421 parport_release(dev);
422 return parport_claim(dev);
426 * parport_yield_blocking - relinquish a parallel port temporarily
427 * @dev: a device on the parallel port
429 * This function relinquishes the port if it would be helpful to other
430 * drivers to do so. Afterwards it tries to reclaim the port using
431 * parport_claim_or_block(), and the return value is the same as for
432 * parport_claim_or_block().
434 static __inline__ int parport_yield_blocking(struct pardevice *dev)
436 unsigned long int timeslip = (jiffies - dev->time);
437 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
439 parport_release(dev);
440 return parport_claim_or_block(dev);
443 /* Flags used to identify what a device does. */
444 #define PARPORT_DEV_TRAN 0 /* WARNING !! DEPRECATED !! */
445 #define PARPORT_DEV_LURK (1<<0) /* WARNING !! DEPRECATED !! */
446 #define PARPORT_DEV_EXCL (1<<1) /* Need exclusive access. */
448 #define PARPORT_FLAG_EXCL (1<<1) /* EXCL driver registered. */
450 /* IEEE1284 functions */
451 extern void parport_ieee1284_interrupt (int, void *, struct pt_regs *);
452 extern int parport_negotiate (struct parport *, int mode);
453 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
454 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
456 #define PARPORT_INACTIVITY_O_NONBLOCK 1
457 extern long parport_set_timeout (struct pardevice *, long inactivity);
459 extern int parport_wait_event (struct parport *, long timeout);
460 extern int parport_wait_peripheral (struct parport *port,
463 extern int parport_poll_peripheral (struct parport *port,
468 /* For architectural drivers */
469 extern size_t parport_ieee1284_write_compat (struct parport *,
470 const void *, size_t, int);
471 extern size_t parport_ieee1284_read_nibble (struct parport *,
472 void *, size_t, int);
473 extern size_t parport_ieee1284_read_byte (struct parport *,
474 void *, size_t, int);
475 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
476 void *, size_t, int);
477 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
478 const void *, size_t, int);
479 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
480 const void *, size_t, int);
481 extern size_t parport_ieee1284_epp_write_data (struct parport *,
482 const void *, size_t, int);
483 extern size_t parport_ieee1284_epp_read_data (struct parport *,
484 void *, size_t, int);
485 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
486 const void *, size_t, int);
487 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
488 void *, size_t, int);
490 /* IEEE1284.3 functions */
491 extern int parport_daisy_init (struct parport *port);
492 extern void parport_daisy_fini (struct parport *port);
493 extern struct pardevice *parport_open (int devnum, const char *name,
496 void (*irqf) (int, void *,
498 int flags, void *handle);
499 extern void parport_close (struct pardevice *dev);
500 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
501 extern int parport_device_num (int parport, int mux, int daisy);
502 extern void parport_daisy_deselect_all (struct parport *port);
503 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
505 /* Lowlevel drivers _can_ call this support function to handle irqs. */
506 static __inline__ void parport_generic_irq(int irq, struct parport *port,
507 struct pt_regs *regs)
509 parport_ieee1284_interrupt (irq, port, regs);
510 read_lock(&port->cad_lock);
511 if (port->cad && port->cad->irq_func)
512 port->cad->irq_func(irq, port->cad->private, regs);
513 read_unlock(&port->cad_lock);
516 /* Prototypes from parport_procfs */
517 extern int parport_proc_register(struct parport *pp);
518 extern int parport_proc_unregister(struct parport *pp);
519 extern int parport_device_proc_register(struct pardevice *device);
520 extern int parport_device_proc_unregister(struct pardevice *device);
522 /* If PC hardware is the only type supported, we can optimise a bit. */
523 #if (defined(CONFIG_PARPORT_PC) || defined(CONFIG_PARPORT_PC_MODULE)) && !(defined(CONFIG_PARPORT_ARC) || defined(CONFIG_PARPORT_ARC_MODULE)) && !(defined(CONFIG_PARPORT_AMIGA) || defined(CONFIG_PARPORT_AMIGA_MODULE)) && !(defined(CONFIG_PARPORT_MFC3) || defined(CONFIG_PARPORT_MFC3_MODULE)) && !(defined(CONFIG_PARPORT_ATARI) || defined(CONFIG_PARPORT_ATARI_MODULE)) && !(defined(CONFIG_USB_USS720) || defined(CONFIG_USB_USS720_MODULE)) && !(defined(CONFIG_PARPORT_SUNBPP) || defined(CONFIG_PARPORT_SUNBPP_MODULE)) && !defined(CONFIG_PARPORT_OTHER)
525 #undef PARPORT_NEED_GENERIC_OPS
526 #include <linux/parport_pc.h>
527 #define parport_write_data(p,x) parport_pc_write_data(p,x)
528 #define parport_read_data(p) parport_pc_read_data(p)
529 #define parport_write_control(p,x) parport_pc_write_control(p,x)
530 #define parport_read_control(p) parport_pc_read_control(p)
531 #define parport_frob_control(p,m,v) parport_pc_frob_control(p,m,v)
532 #define parport_read_status(p) parport_pc_read_status(p)
533 #define parport_enable_irq(p) parport_pc_enable_irq(p)
534 #define parport_disable_irq(p) parport_pc_disable_irq(p)
535 #define parport_data_forward(p) parport_pc_data_forward(p)
536 #define parport_data_reverse(p) parport_pc_data_reverse(p)
539 #ifdef PARPORT_NEED_GENERIC_OPS
540 /* Generic operations vector through the dispatch table. */
541 #define parport_write_data(p,x) (p)->ops->write_data(p,x)
542 #define parport_read_data(p) (p)->ops->read_data(p)
543 #define parport_write_control(p,x) (p)->ops->write_control(p,x)
544 #define parport_read_control(p) (p)->ops->read_control(p)
545 #define parport_frob_control(p,m,v) (p)->ops->frob_control(p,m,v)
546 #define parport_read_status(p) (p)->ops->read_status(p)
547 #define parport_enable_irq(p) (p)->ops->enable_irq(p)
548 #define parport_disable_irq(p) (p)->ops->disable_irq(p)
549 #define parport_data_forward(p) (p)->ops->data_forward(p)
550 #define parport_data_reverse(p) (p)->ops->data_reverse(p)
553 #endif /* __KERNEL__ */
554 #endif /* _PARPORT_H_ */