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 parport_state {
133 struct pc_parport_state pc;
134 /* ARC has no state. */
135 struct ax_parport_state ax;
136 struct amiga_parport_state amiga;
137 /* Atari has not state. */
142 struct parport_operations {
143 /* IBM PC-style virtual registers. */
144 void (*write_data)(struct parport *, unsigned char);
145 unsigned char (*read_data)(struct parport *);
147 void (*write_control)(struct parport *, unsigned char);
148 unsigned char (*read_control)(struct parport *);
149 unsigned char (*frob_control)(struct parport *, unsigned char mask,
152 unsigned char (*read_status)(struct parport *);
155 void (*enable_irq)(struct parport *);
156 void (*disable_irq)(struct parport *);
158 /* Data direction. */
159 void (*data_forward) (struct parport *);
160 void (*data_reverse) (struct parport *);
162 /* For core parport code. */
163 void (*init_state)(struct pardevice *, struct parport_state *);
164 void (*save_state)(struct parport *, struct parport_state *);
165 void (*restore_state)(struct parport *, struct parport_state *);
167 /* Block read/write */
168 size_t (*epp_write_data) (struct parport *port, const void *buf,
169 size_t len, int flags);
170 size_t (*epp_read_data) (struct parport *port, void *buf, size_t len,
172 size_t (*epp_write_addr) (struct parport *port, const void *buf,
173 size_t len, int flags);
174 size_t (*epp_read_addr) (struct parport *port, void *buf, size_t len,
177 size_t (*ecp_write_data) (struct parport *port, const void *buf,
178 size_t len, int flags);
179 size_t (*ecp_read_data) (struct parport *port, void *buf, size_t len,
181 size_t (*ecp_write_addr) (struct parport *port, const void *buf,
182 size_t len, int flags);
184 size_t (*compat_write_data) (struct parport *port, const void *buf,
185 size_t len, int flags);
186 size_t (*nibble_read_data) (struct parport *port, void *buf,
187 size_t len, int flags);
188 size_t (*byte_read_data) (struct parport *port, void *buf,
189 size_t len, int flags);
190 struct module *owner;
193 struct parport_device_info {
194 parport_device_class class;
195 const char *class_name;
199 const char *description;
202 /* Each device can have two callback functions:
203 * 1) a preemption function, called by the resource manager to request
204 * that the driver relinquish control of the port. The driver should
205 * return zero if it agrees to release the port, and nonzero if it
206 * refuses. Do not call parport_release() - the kernel will do this
209 * 2) a wake-up function, called by the resource manager to tell drivers
210 * that the port is available to be claimed. If a driver wants to use
211 * the port, it should call parport_claim() here.
214 /* A parallel port device */
217 struct parport *port;
219 int (*preempt)(void *);
220 void (*wakeup)(void *);
222 void (*irq_func)(int, void *, struct pt_regs *);
224 struct pardevice *next;
225 struct pardevice *prev;
226 struct parport_state *state; /* saved status over preemption */
227 wait_queue_head_t wait_q;
228 unsigned long int time;
229 unsigned long int timeslice;
230 volatile long int timeout;
231 unsigned long waiting; /* long req'd for set_bit --RR */
232 struct pardevice *waitprev;
233 struct pardevice *waitnext;
237 /* IEEE1284 information */
239 /* IEEE1284 phases */
240 enum ieee1284_phase {
241 IEEE1284_PH_FWD_DATA,
242 IEEE1284_PH_FWD_IDLE,
243 IEEE1284_PH_TERMINATE,
244 IEEE1284_PH_NEGOTIATION,
245 IEEE1284_PH_REV_IDLE,
246 IEEE1284_PH_HBUSY_DAVAIL,
247 IEEE1284_PH_REV_DATA,
248 IEEE1284_PH_ECP_SETUP,
249 IEEE1284_PH_ECP_FWD_TO_REV,
250 IEEE1284_PH_ECP_REV_TO_FWD,
251 IEEE1284_PH_ECP_DIR_UNKNOWN,
253 struct ieee1284_info {
255 volatile enum ieee1284_phase phase;
256 struct semaphore irq;
259 /* A parallel port */
261 unsigned long base; /* base address */
262 unsigned long base_hi; /* base address (hi - ECR) */
263 unsigned int size; /* IO extent */
266 int irq; /* interrupt (or -1 for none) */
268 int muxport; /* which muxport (if any) this is */
269 int portnum; /* which physical parallel port (not mux) */
271 struct parport *physport;
272 /* If this is a non-default mux
273 parport, i.e. we're a clone of a real
274 physical port, this is a pointer to that
275 port. The locking is only done in the
276 real port. For a clone port, the
277 following structure members are
278 meaningless: devices, cad, muxsel,
279 waithead, waittail, flags, pdir,
282 It this is a default mux parport, or
283 there is no mux involved, this points to
286 struct pardevice *devices;
287 struct pardevice *cad; /* port owner */
288 int daisy; /* currently selected daisy addr */
289 int muxsel; /* currently selected mux port */
291 struct pardevice *waithead;
292 struct pardevice *waittail;
294 struct list_head list;
298 struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
299 struct ieee1284_info ieee1284;
301 struct parport_operations *ops;
302 void *private_data; /* for lowlevel driver */
304 int number; /* port index - the `n' in `parportn' */
305 spinlock_t pardevice_lock;
306 spinlock_t waitlist_lock;
312 struct list_head full_list;
313 struct parport *slaves[3];
316 #define DEFAULT_SPIN_TIME 500 /* us */
318 struct parport_driver {
320 void (*attach) (struct parport *);
321 void (*detach) (struct parport *);
322 struct list_head list;
325 /* parport_register_port registers a new parallel port at the given
326 address (if one does not already exist) and returns a pointer to it.
327 This entails claiming the I/O region, IRQ and DMA. NULL is returned
328 if initialisation fails. */
329 struct parport *parport_register_port(unsigned long base, int irq, int dma,
330 struct parport_operations *ops);
332 /* Once a registered port is ready for high-level drivers to use, the
333 low-level driver that registered it should announce it. This will
334 call the high-level drivers' attach() functions (after things like
335 determining the IEEE 1284.3 topology of the port and collecting
337 void parport_announce_port (struct parport *port);
339 /* Unregister a port. */
340 extern void parport_remove_port(struct parport *port);
342 /* Register a new high-level driver. */
343 extern int parport_register_driver (struct parport_driver *);
345 /* Unregister a high-level driver. */
346 extern void parport_unregister_driver (struct parport_driver *);
348 /* If parport_register_driver doesn't fit your needs, perhaps
349 * parport_find_xxx does. */
350 extern struct parport *parport_find_number (int);
351 extern struct parport *parport_find_base (unsigned long);
353 /* Reference counting for ports. */
354 extern struct parport *parport_get_port (struct parport *);
355 extern void parport_put_port (struct parport *);
357 /* parport_register_device declares that a device is connected to a
358 port, and tells the kernel all it needs to know.
359 - pf is the preemption function (may be NULL for no callback)
360 - kf is the wake-up function (may be NULL for no callback)
361 - irq_func is the interrupt handler (may be NULL for no interrupts)
362 - handle is a user pointer that gets handed to callback functions. */
363 struct pardevice *parport_register_device(struct parport *port,
365 int (*pf)(void *), void (*kf)(void *),
366 void (*irq_func)(int, void *, struct pt_regs *),
367 int flags, void *handle);
369 /* parport_unregister unlinks a device from the chain. */
370 extern void parport_unregister_device(struct pardevice *dev);
372 /* parport_claim tries to gain ownership of the port for a particular
373 driver. This may fail (return non-zero) if another driver is busy.
374 If this driver has registered an interrupt handler, it will be
376 extern int parport_claim(struct pardevice *dev);
378 /* parport_claim_or_block is the same, but sleeps if the port cannot
379 be claimed. Return value is 1 if it slept, 0 normally and -errno
381 extern int parport_claim_or_block(struct pardevice *dev);
383 /* parport_release reverses a previous parport_claim. This can never
384 fail, though the effects are undefined (except that they are bad)
385 if you didn't previously own the port. Once you have released the
386 port you should make sure that neither your code nor the hardware
387 on the port tries to initiate any communication without first
388 re-claiming the port. If you mess with the port state (enabling
389 ECP for example) you should clean up before releasing the port. */
391 extern void parport_release(struct pardevice *dev);
394 * parport_yield - relinquish a parallel port temporarily
395 * @dev: a device on the parallel port
397 * This function relinquishes the port if it would be helpful to other
398 * drivers to do so. Afterwards it tries to reclaim the port using
399 * parport_claim(), and the return value is the same as for
400 * parport_claim(). If it fails, the port is left unclaimed and it is
401 * the driver's responsibility to reclaim the port.
403 * The parport_yield() and parport_yield_blocking() functions are for
404 * marking points in the driver at which other drivers may claim the
405 * port and use their devices. Yielding the port is similar to
406 * releasing it and reclaiming it, but is more efficient because no
407 * action is taken if there are no other devices needing the port. In
408 * fact, nothing is done even if there are other devices waiting but
409 * the current device is still within its "timeslice". The default
410 * timeslice is half a second, but it can be adjusted via the /proc
413 static __inline__ int parport_yield(struct pardevice *dev)
415 unsigned long int timeslip = (jiffies - dev->time);
416 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
418 parport_release(dev);
419 return parport_claim(dev);
423 * parport_yield_blocking - relinquish a parallel port temporarily
424 * @dev: a device on the parallel port
426 * This function relinquishes the port if it would be helpful to other
427 * drivers to do so. Afterwards it tries to reclaim the port using
428 * parport_claim_or_block(), and the return value is the same as for
429 * parport_claim_or_block().
431 static __inline__ int parport_yield_blocking(struct pardevice *dev)
433 unsigned long int timeslip = (jiffies - dev->time);
434 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
436 parport_release(dev);
437 return parport_claim_or_block(dev);
440 /* Flags used to identify what a device does. */
441 #define PARPORT_DEV_TRAN 0 /* WARNING !! DEPRECATED !! */
442 #define PARPORT_DEV_LURK (1<<0) /* WARNING !! DEPRECATED !! */
443 #define PARPORT_DEV_EXCL (1<<1) /* Need exclusive access. */
445 #define PARPORT_FLAG_EXCL (1<<1) /* EXCL driver registered. */
447 /* IEEE1284 functions */
448 extern void parport_ieee1284_interrupt (int, void *, struct pt_regs *);
449 extern int parport_negotiate (struct parport *, int mode);
450 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
451 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
453 #define PARPORT_INACTIVITY_O_NONBLOCK 1
454 extern long parport_set_timeout (struct pardevice *, long inactivity);
456 extern int parport_wait_event (struct parport *, long timeout);
457 extern int parport_wait_peripheral (struct parport *port,
460 extern int parport_poll_peripheral (struct parport *port,
465 /* For architectural drivers */
466 extern size_t parport_ieee1284_write_compat (struct parport *,
467 const void *, size_t, int);
468 extern size_t parport_ieee1284_read_nibble (struct parport *,
469 void *, size_t, int);
470 extern size_t parport_ieee1284_read_byte (struct parport *,
471 void *, size_t, int);
472 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
473 void *, size_t, int);
474 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
475 const void *, size_t, int);
476 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
477 const void *, size_t, int);
478 extern size_t parport_ieee1284_epp_write_data (struct parport *,
479 const void *, size_t, int);
480 extern size_t parport_ieee1284_epp_read_data (struct parport *,
481 void *, size_t, int);
482 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
483 const void *, size_t, int);
484 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
485 void *, size_t, int);
487 /* IEEE1284.3 functions */
488 extern int parport_daisy_init (struct parport *port);
489 extern void parport_daisy_fini (struct parport *port);
490 extern struct pardevice *parport_open (int devnum, const char *name,
493 void (*irqf) (int, void *,
495 int flags, void *handle);
496 extern void parport_close (struct pardevice *dev);
497 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
498 extern int parport_device_num (int parport, int mux, int daisy);
499 extern void parport_daisy_deselect_all (struct parport *port);
500 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
502 /* Lowlevel drivers _can_ call this support function to handle irqs. */
503 static __inline__ void parport_generic_irq(int irq, struct parport *port,
504 struct pt_regs *regs)
506 parport_ieee1284_interrupt (irq, port, regs);
507 read_lock(&port->cad_lock);
508 if (port->cad && port->cad->irq_func)
509 port->cad->irq_func(irq, port->cad->private, regs);
510 read_unlock(&port->cad_lock);
513 /* Prototypes from parport_procfs */
514 extern int parport_proc_register(struct parport *pp);
515 extern int parport_proc_unregister(struct parport *pp);
516 extern int parport_device_proc_register(struct pardevice *device);
517 extern int parport_device_proc_unregister(struct pardevice *device);
519 /* If PC hardware is the only type supported, we can optimise a bit. */
520 #if !defined(CONFIG_PARPORT_NOT_PC)
522 #include <linux/parport_pc.h>
523 #define parport_write_data(p,x) parport_pc_write_data(p,x)
524 #define parport_read_data(p) parport_pc_read_data(p)
525 #define parport_write_control(p,x) parport_pc_write_control(p,x)
526 #define parport_read_control(p) parport_pc_read_control(p)
527 #define parport_frob_control(p,m,v) parport_pc_frob_control(p,m,v)
528 #define parport_read_status(p) parport_pc_read_status(p)
529 #define parport_enable_irq(p) parport_pc_enable_irq(p)
530 #define parport_disable_irq(p) parport_pc_disable_irq(p)
531 #define parport_data_forward(p) parport_pc_data_forward(p)
532 #define parport_data_reverse(p) parport_pc_data_reverse(p)
534 #else /* !CONFIG_PARPORT_NOT_PC */
536 /* Generic operations vector through the dispatch table. */
537 #define parport_write_data(p,x) (p)->ops->write_data(p,x)
538 #define parport_read_data(p) (p)->ops->read_data(p)
539 #define parport_write_control(p,x) (p)->ops->write_control(p,x)
540 #define parport_read_control(p) (p)->ops->read_control(p)
541 #define parport_frob_control(p,m,v) (p)->ops->frob_control(p,m,v)
542 #define parport_read_status(p) (p)->ops->read_status(p)
543 #define parport_enable_irq(p) (p)->ops->enable_irq(p)
544 #define parport_disable_irq(p) (p)->ops->disable_irq(p)
545 #define parport_data_forward(p) (p)->ops->data_forward(p)
546 #define parport_data_reverse(p) (p)->ops->data_reverse(p)
548 #endif /* !CONFIG_PARPORT_NOT_PC */
550 #endif /* __KERNEL__ */
551 #endif /* _PARPORT_H_ */