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