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 this later. */
112 struct pc_parport_state {
117 struct ax_parport_state {
123 /* used by both parport_amiga and parport_mfc3 */
124 struct amiga_parport_state {
125 unsigned char data; /* ciaa.prb */
126 unsigned char datadir; /* ciaa.ddrb */
127 unsigned char status; /* ciab.pra & 7 */
128 unsigned char statusdir;/* ciab.ddrb & 7 */
131 struct ip32_parport_state {
136 struct parport_state {
138 struct pc_parport_state pc;
139 /* ARC has no state. */
140 struct ax_parport_state ax;
141 struct amiga_parport_state amiga;
142 /* Atari has not state. */
143 struct ip32_parport_state ip32;
148 struct parport_operations {
149 /* IBM PC-style virtual registers. */
150 void (*write_data)(struct parport *, unsigned char);
151 unsigned char (*read_data)(struct parport *);
153 void (*write_control)(struct parport *, unsigned char);
154 unsigned char (*read_control)(struct parport *);
155 unsigned char (*frob_control)(struct parport *, unsigned char mask,
158 unsigned char (*read_status)(struct parport *);
161 void (*enable_irq)(struct parport *);
162 void (*disable_irq)(struct parport *);
164 /* Data direction. */
165 void (*data_forward) (struct parport *);
166 void (*data_reverse) (struct parport *);
168 /* For core parport code. */
169 void (*init_state)(struct pardevice *, struct parport_state *);
170 void (*save_state)(struct parport *, struct parport_state *);
171 void (*restore_state)(struct parport *, struct parport_state *);
173 /* Block read/write */
174 size_t (*epp_write_data) (struct parport *port, const void *buf,
175 size_t len, int flags);
176 size_t (*epp_read_data) (struct parport *port, void *buf, size_t len,
178 size_t (*epp_write_addr) (struct parport *port, const void *buf,
179 size_t len, int flags);
180 size_t (*epp_read_addr) (struct parport *port, void *buf, size_t len,
183 size_t (*ecp_write_data) (struct parport *port, const void *buf,
184 size_t len, int flags);
185 size_t (*ecp_read_data) (struct parport *port, void *buf, size_t len,
187 size_t (*ecp_write_addr) (struct parport *port, const void *buf,
188 size_t len, int flags);
190 size_t (*compat_write_data) (struct parport *port, const void *buf,
191 size_t len, int flags);
192 size_t (*nibble_read_data) (struct parport *port, void *buf,
193 size_t len, int flags);
194 size_t (*byte_read_data) (struct parport *port, void *buf,
195 size_t len, int flags);
196 struct module *owner;
199 struct parport_device_info {
200 parport_device_class class;
201 const char *class_name;
205 const char *description;
208 /* Each device can have two callback functions:
209 * 1) a preemption function, called by the resource manager to request
210 * that the driver relinquish control of the port. The driver should
211 * return zero if it agrees to release the port, and nonzero if it
212 * refuses. Do not call parport_release() - the kernel will do this
215 * 2) a wake-up function, called by the resource manager to tell drivers
216 * that the port is available to be claimed. If a driver wants to use
217 * the port, it should call parport_claim() here.
220 /* A parallel port device */
223 struct parport *port;
225 int (*preempt)(void *);
226 void (*wakeup)(void *);
228 void (*irq_func)(int, void *, struct pt_regs *);
230 struct pardevice *next;
231 struct pardevice *prev;
232 struct parport_state *state; /* saved status over preemption */
233 wait_queue_head_t wait_q;
234 unsigned long int time;
235 unsigned long int timeslice;
236 volatile long int timeout;
237 unsigned long waiting; /* long req'd for set_bit --RR */
238 struct pardevice *waitprev;
239 struct pardevice *waitnext;
243 /* IEEE1284 information */
245 /* IEEE1284 phases. These are exposed to userland through ppdev IOCTL
246 * PP[GS]ETPHASE, so do not change existing values. */
247 enum ieee1284_phase {
248 IEEE1284_PH_FWD_DATA,
249 IEEE1284_PH_FWD_IDLE,
250 IEEE1284_PH_TERMINATE,
251 IEEE1284_PH_NEGOTIATION,
252 IEEE1284_PH_HBUSY_DNA,
253 IEEE1284_PH_REV_IDLE,
254 IEEE1284_PH_HBUSY_DAVAIL,
255 IEEE1284_PH_REV_DATA,
256 IEEE1284_PH_ECP_SETUP,
257 IEEE1284_PH_ECP_FWD_TO_REV,
258 IEEE1284_PH_ECP_REV_TO_FWD,
259 IEEE1284_PH_ECP_DIR_UNKNOWN,
261 struct ieee1284_info {
263 volatile enum ieee1284_phase phase;
264 struct semaphore irq;
267 /* A parallel port */
269 unsigned long base; /* base address */
270 unsigned long base_hi; /* base address (hi - ECR) */
271 unsigned int size; /* IO extent */
274 int irq; /* interrupt (or -1 for none) */
276 int muxport; /* which muxport (if any) this is */
277 int portnum; /* which physical parallel port (not mux) */
279 struct parport *physport;
280 /* If this is a non-default mux
281 parport, i.e. we're a clone of a real
282 physical port, this is a pointer to that
283 port. The locking is only done in the
284 real port. For a clone port, the
285 following structure members are
286 meaningless: devices, cad, muxsel,
287 waithead, waittail, flags, pdir,
290 It this is a default mux parport, or
291 there is no mux involved, this points to
294 struct pardevice *devices;
295 struct pardevice *cad; /* port owner */
296 int daisy; /* currently selected daisy addr */
297 int muxsel; /* currently selected mux port */
299 struct pardevice *waithead;
300 struct pardevice *waittail;
302 struct list_head list;
306 struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
307 struct ieee1284_info ieee1284;
309 struct parport_operations *ops;
310 void *private_data; /* for lowlevel driver */
312 int number; /* port index - the `n' in `parportn' */
313 spinlock_t pardevice_lock;
314 spinlock_t waitlist_lock;
320 struct list_head full_list;
321 struct parport *slaves[3];
324 #define DEFAULT_SPIN_TIME 500 /* us */
326 struct parport_driver {
328 void (*attach) (struct parport *);
329 void (*detach) (struct parport *);
330 struct list_head list;
333 /* parport_register_port registers a new parallel port at the given
334 address (if one does not already exist) and returns a pointer to it.
335 This entails claiming the I/O region, IRQ and DMA. NULL is returned
336 if initialisation fails. */
337 struct parport *parport_register_port(unsigned long base, int irq, int dma,
338 struct parport_operations *ops);
340 /* Once a registered port is ready for high-level drivers to use, the
341 low-level driver that registered it should announce it. This will
342 call the high-level drivers' attach() functions (after things like
343 determining the IEEE 1284.3 topology of the port and collecting
345 void parport_announce_port (struct parport *port);
347 /* Unregister a port. */
348 extern void parport_remove_port(struct parport *port);
350 /* Register a new high-level driver. */
351 extern int parport_register_driver (struct parport_driver *);
353 /* Unregister a high-level driver. */
354 extern void parport_unregister_driver (struct parport_driver *);
356 /* If parport_register_driver doesn't fit your needs, perhaps
357 * parport_find_xxx does. */
358 extern struct parport *parport_find_number (int);
359 extern struct parport *parport_find_base (unsigned long);
361 /* Reference counting for ports. */
362 extern struct parport *parport_get_port (struct parport *);
363 extern void parport_put_port (struct parport *);
365 /* parport_register_device declares that a device is connected to a
366 port, and tells the kernel all it needs to know.
367 - pf is the preemption function (may be NULL for no callback)
368 - kf is the wake-up function (may be NULL for no callback)
369 - irq_func is the interrupt handler (may be NULL for no interrupts)
370 - handle is a user pointer that gets handed to callback functions. */
371 struct pardevice *parport_register_device(struct parport *port,
373 int (*pf)(void *), void (*kf)(void *),
374 void (*irq_func)(int, void *, struct pt_regs *),
375 int flags, void *handle);
377 /* parport_unregister unlinks a device from the chain. */
378 extern void parport_unregister_device(struct pardevice *dev);
380 /* parport_claim tries to gain ownership of the port for a particular
381 driver. This may fail (return non-zero) if another driver is busy.
382 If this driver has registered an interrupt handler, it will be
384 extern int parport_claim(struct pardevice *dev);
386 /* parport_claim_or_block is the same, but sleeps if the port cannot
387 be claimed. Return value is 1 if it slept, 0 normally and -errno
389 extern int parport_claim_or_block(struct pardevice *dev);
391 /* parport_release reverses a previous parport_claim. This can never
392 fail, though the effects are undefined (except that they are bad)
393 if you didn't previously own the port. Once you have released the
394 port you should make sure that neither your code nor the hardware
395 on the port tries to initiate any communication without first
396 re-claiming the port. If you mess with the port state (enabling
397 ECP for example) you should clean up before releasing the port. */
399 extern void parport_release(struct pardevice *dev);
402 * parport_yield - relinquish a parallel port temporarily
403 * @dev: a device on the parallel port
405 * This function relinquishes the port if it would be helpful to other
406 * drivers to do so. Afterwards it tries to reclaim the port using
407 * parport_claim(), and the return value is the same as for
408 * parport_claim(). If it fails, the port is left unclaimed and it is
409 * the driver's responsibility to reclaim the port.
411 * The parport_yield() and parport_yield_blocking() functions are for
412 * marking points in the driver at which other drivers may claim the
413 * port and use their devices. Yielding the port is similar to
414 * releasing it and reclaiming it, but is more efficient because no
415 * action is taken if there are no other devices needing the port. In
416 * fact, nothing is done even if there are other devices waiting but
417 * the current device is still within its "timeslice". The default
418 * timeslice is half a second, but it can be adjusted via the /proc
421 static __inline__ int parport_yield(struct pardevice *dev)
423 unsigned long int timeslip = (jiffies - dev->time);
424 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
426 parport_release(dev);
427 return parport_claim(dev);
431 * parport_yield_blocking - relinquish a parallel port temporarily
432 * @dev: a device on the parallel port
434 * This function relinquishes the port if it would be helpful to other
435 * drivers to do so. Afterwards it tries to reclaim the port using
436 * parport_claim_or_block(), and the return value is the same as for
437 * parport_claim_or_block().
439 static __inline__ int parport_yield_blocking(struct pardevice *dev)
441 unsigned long int timeslip = (jiffies - dev->time);
442 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
444 parport_release(dev);
445 return parport_claim_or_block(dev);
448 /* Flags used to identify what a device does. */
449 #define PARPORT_DEV_TRAN 0 /* WARNING !! DEPRECATED !! */
450 #define PARPORT_DEV_LURK (1<<0) /* WARNING !! DEPRECATED !! */
451 #define PARPORT_DEV_EXCL (1<<1) /* Need exclusive access. */
453 #define PARPORT_FLAG_EXCL (1<<1) /* EXCL driver registered. */
455 /* IEEE1284 functions */
456 extern void parport_ieee1284_interrupt (int, void *, struct pt_regs *);
457 extern int parport_negotiate (struct parport *, int mode);
458 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
459 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
461 #define PARPORT_INACTIVITY_O_NONBLOCK 1
462 extern long parport_set_timeout (struct pardevice *, long inactivity);
464 extern int parport_wait_event (struct parport *, long timeout);
465 extern int parport_wait_peripheral (struct parport *port,
468 extern int parport_poll_peripheral (struct parport *port,
473 /* For architectural drivers */
474 extern size_t parport_ieee1284_write_compat (struct parport *,
475 const void *, size_t, int);
476 extern size_t parport_ieee1284_read_nibble (struct parport *,
477 void *, size_t, int);
478 extern size_t parport_ieee1284_read_byte (struct parport *,
479 void *, size_t, int);
480 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
481 void *, size_t, int);
482 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
483 const void *, size_t, int);
484 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
485 const void *, size_t, int);
486 extern size_t parport_ieee1284_epp_write_data (struct parport *,
487 const void *, size_t, int);
488 extern size_t parport_ieee1284_epp_read_data (struct parport *,
489 void *, size_t, int);
490 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
491 const void *, size_t, int);
492 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
493 void *, size_t, int);
495 /* IEEE1284.3 functions */
496 extern int parport_daisy_init (struct parport *port);
497 extern void parport_daisy_fini (struct parport *port);
498 extern struct pardevice *parport_open (int devnum, const char *name,
501 void (*irqf) (int, void *,
503 int flags, void *handle);
504 extern void parport_close (struct pardevice *dev);
505 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
506 extern int parport_device_num (int parport, int mux, int daisy);
507 extern void parport_daisy_deselect_all (struct parport *port);
508 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
510 /* Lowlevel drivers _can_ call this support function to handle irqs. */
511 static __inline__ void parport_generic_irq(int irq, struct parport *port,
512 struct pt_regs *regs)
514 parport_ieee1284_interrupt (irq, port, regs);
515 read_lock(&port->cad_lock);
516 if (port->cad && port->cad->irq_func)
517 port->cad->irq_func(irq, port->cad->private, regs);
518 read_unlock(&port->cad_lock);
521 /* Prototypes from parport_procfs */
522 extern int parport_proc_register(struct parport *pp);
523 extern int parport_proc_unregister(struct parport *pp);
524 extern int parport_device_proc_register(struct pardevice *device);
525 extern int parport_device_proc_unregister(struct pardevice *device);
527 /* If PC hardware is the only type supported, we can optimise a bit. */
528 #if !defined(CONFIG_PARPORT_NOT_PC)
530 #include <linux/parport_pc.h>
531 #define parport_write_data(p,x) parport_pc_write_data(p,x)
532 #define parport_read_data(p) parport_pc_read_data(p)
533 #define parport_write_control(p,x) parport_pc_write_control(p,x)
534 #define parport_read_control(p) parport_pc_read_control(p)
535 #define parport_frob_control(p,m,v) parport_pc_frob_control(p,m,v)
536 #define parport_read_status(p) parport_pc_read_status(p)
537 #define parport_enable_irq(p) parport_pc_enable_irq(p)
538 #define parport_disable_irq(p) parport_pc_disable_irq(p)
539 #define parport_data_forward(p) parport_pc_data_forward(p)
540 #define parport_data_reverse(p) parport_pc_data_reverse(p)
542 #else /* !CONFIG_PARPORT_NOT_PC */
544 /* Generic operations vector through the dispatch table. */
545 #define parport_write_data(p,x) (p)->ops->write_data(p,x)
546 #define parport_read_data(p) (p)->ops->read_data(p)
547 #define parport_write_control(p,x) (p)->ops->write_control(p,x)
548 #define parport_read_control(p) (p)->ops->read_control(p)
549 #define parport_frob_control(p,m,v) (p)->ops->frob_control(p,m,v)
550 #define parport_read_status(p) (p)->ops->read_status(p)
551 #define parport_enable_irq(p) (p)->ops->enable_irq(p)
552 #define parport_disable_irq(p) (p)->ops->disable_irq(p)
553 #define parport_data_forward(p) (p)->ops->data_forward(p)
554 #define parport_data_reverse(p) (p)->ops->data_reverse(p)
556 #endif /* !CONFIG_PARPORT_NOT_PC */
558 #endif /* __KERNEL__ */
559 #endif /* _PARPORT_H_ */