KEYS: Fix up comments in key management code
[linux-2.6/next.git] / include / linux / parport.h
blob38a423ed3c01d4468a57240a1ad3c5c33a418f9b
1 /*
2 * Any part of this program may be used in documents licensed under
3 * the GNU Free Documentation License, Version 1.1 or any later version
4 * published by the Free Software Foundation.
5 */
7 #ifndef _PARPORT_H_
8 #define _PARPORT_H_
10 /* Start off with user-visible constants */
12 /* Maximum of 16 ports per machine */
13 #define PARPORT_MAX 16
15 /* Magic numbers */
16 #define PARPORT_IRQ_NONE -1
17 #define PARPORT_DMA_NONE -1
18 #define PARPORT_IRQ_AUTO -2
19 #define PARPORT_DMA_AUTO -2
20 #define PARPORT_DMA_NOFIFO -3
21 #define PARPORT_DISABLE -2
22 #define PARPORT_IRQ_PROBEONLY -3
23 #define PARPORT_IOHI_AUTO -1
25 #define PARPORT_CONTROL_STROBE 0x1
26 #define PARPORT_CONTROL_AUTOFD 0x2
27 #define PARPORT_CONTROL_INIT 0x4
28 #define PARPORT_CONTROL_SELECT 0x8
30 #define PARPORT_STATUS_ERROR 0x8
31 #define PARPORT_STATUS_SELECT 0x10
32 #define PARPORT_STATUS_PAPEROUT 0x20
33 #define PARPORT_STATUS_ACK 0x40
34 #define PARPORT_STATUS_BUSY 0x80
36 /* Type classes for Plug-and-Play probe. */
37 typedef enum {
38 PARPORT_CLASS_LEGACY = 0, /* Non-IEEE1284 device */
39 PARPORT_CLASS_PRINTER,
40 PARPORT_CLASS_MODEM,
41 PARPORT_CLASS_NET,
42 PARPORT_CLASS_HDC, /* Hard disk controller */
43 PARPORT_CLASS_PCMCIA,
44 PARPORT_CLASS_MEDIA, /* Multimedia device */
45 PARPORT_CLASS_FDC, /* Floppy disk controller */
46 PARPORT_CLASS_PORTS,
47 PARPORT_CLASS_SCANNER,
48 PARPORT_CLASS_DIGCAM,
49 PARPORT_CLASS_OTHER, /* Anything else */
50 PARPORT_CLASS_UNSPEC, /* No CLS field in ID */
51 PARPORT_CLASS_SCSIADAPTER
52 } parport_device_class;
54 /* The "modes" entry in parport is a bit field representing the
55 capabilities of the hardware. */
56 #define PARPORT_MODE_PCSPP (1<<0) /* IBM PC registers available. */
57 #define PARPORT_MODE_TRISTATE (1<<1) /* Can tristate. */
58 #define PARPORT_MODE_EPP (1<<2) /* Hardware EPP. */
59 #define PARPORT_MODE_ECP (1<<3) /* Hardware ECP. */
60 #define PARPORT_MODE_COMPAT (1<<4) /* Hardware 'printer protocol'. */
61 #define PARPORT_MODE_DMA (1<<5) /* Hardware can DMA. */
62 #define PARPORT_MODE_SAFEININT (1<<6) /* SPP registers accessible in IRQ. */
64 /* IEEE1284 modes:
65 Nibble mode, byte mode, ECP, ECPRLE and EPP are their own
66 'extensibility request' values. Others are special.
67 'Real' ECP modes must have the IEEE1284_MODE_ECP bit set. */
68 #define IEEE1284_MODE_NIBBLE 0
69 #define IEEE1284_MODE_BYTE (1<<0)
70 #define IEEE1284_MODE_COMPAT (1<<8)
71 #define IEEE1284_MODE_BECP (1<<9) /* Bounded ECP mode */
72 #define IEEE1284_MODE_ECP (1<<4)
73 #define IEEE1284_MODE_ECPRLE (IEEE1284_MODE_ECP | (1<<5))
74 #define IEEE1284_MODE_ECPSWE (1<<10) /* Software-emulated */
75 #define IEEE1284_MODE_EPP (1<<6)
76 #define IEEE1284_MODE_EPPSL (1<<11) /* EPP 1.7 */
77 #define IEEE1284_MODE_EPPSWE (1<<12) /* Software-emulated */
78 #define IEEE1284_DEVICEID (1<<2) /* This is a flag */
79 #define IEEE1284_EXT_LINK (1<<14) /* This flag causes the
80 * extensibility link to
81 * be requested, using
82 * bits 0-6. */
84 /* For the benefit of parport_read/write, you can use these with
85 * parport_negotiate to use address operations. They have no effect
86 * other than to make parport_read/write use address transfers. */
87 #define IEEE1284_ADDR (1<<13) /* This is a flag */
88 #define IEEE1284_DATA 0 /* So is this */
90 /* Flags for block transfer operations. */
91 #define PARPORT_EPP_FAST (1<<0) /* Unreliable counts. */
92 #define PARPORT_W91284PIC (1<<1) /* have a Warp9 w91284pic in the device */
94 /* The rest is for the kernel only */
95 #ifdef __KERNEL__
97 #include <linux/jiffies.h>
98 #include <linux/proc_fs.h>
99 #include <linux/spinlock.h>
100 #include <linux/wait.h>
101 #include <linux/irqreturn.h>
102 #include <linux/semaphore.h>
103 #include <asm/system.h>
104 #include <asm/ptrace.h>
106 /* Define this later. */
107 struct parport;
108 struct pardevice;
110 struct pc_parport_state {
111 unsigned int ctr;
112 unsigned int ecr;
115 struct ax_parport_state {
116 unsigned int ctr;
117 unsigned int ecr;
118 unsigned int dcsr;
121 /* used by both parport_amiga and parport_mfc3 */
122 struct amiga_parport_state {
123 unsigned char data; /* ciaa.prb */
124 unsigned char datadir; /* ciaa.ddrb */
125 unsigned char status; /* ciab.pra & 7 */
126 unsigned char statusdir;/* ciab.ddrb & 7 */
129 struct ax88796_parport_state {
130 unsigned char cpr;
133 struct ip32_parport_state {
134 unsigned int dcr;
135 unsigned int ecr;
138 struct parport_state {
139 union {
140 struct pc_parport_state pc;
141 /* ARC has no state. */
142 struct ax_parport_state ax;
143 struct amiga_parport_state amiga;
144 struct ax88796_parport_state ax88796;
145 /* Atari has not state. */
146 struct ip32_parport_state ip32;
147 void *misc;
148 } u;
151 struct parport_operations {
152 /* IBM PC-style virtual registers. */
153 void (*write_data)(struct parport *, unsigned char);
154 unsigned char (*read_data)(struct parport *);
156 void (*write_control)(struct parport *, unsigned char);
157 unsigned char (*read_control)(struct parport *);
158 unsigned char (*frob_control)(struct parport *, unsigned char mask,
159 unsigned char val);
161 unsigned char (*read_status)(struct parport *);
163 /* IRQs. */
164 void (*enable_irq)(struct parport *);
165 void (*disable_irq)(struct parport *);
167 /* Data direction. */
168 void (*data_forward) (struct parport *);
169 void (*data_reverse) (struct parport *);
171 /* For core parport code. */
172 void (*init_state)(struct pardevice *, struct parport_state *);
173 void (*save_state)(struct parport *, struct parport_state *);
174 void (*restore_state)(struct parport *, struct parport_state *);
176 /* Block read/write */
177 size_t (*epp_write_data) (struct parport *port, const void *buf,
178 size_t len, int flags);
179 size_t (*epp_read_data) (struct parport *port, void *buf, size_t len,
180 int flags);
181 size_t (*epp_write_addr) (struct parport *port, const void *buf,
182 size_t len, int flags);
183 size_t (*epp_read_addr) (struct parport *port, void *buf, size_t len,
184 int flags);
186 size_t (*ecp_write_data) (struct parport *port, const void *buf,
187 size_t len, int flags);
188 size_t (*ecp_read_data) (struct parport *port, void *buf, size_t len,
189 int flags);
190 size_t (*ecp_write_addr) (struct parport *port, const void *buf,
191 size_t len, int flags);
193 size_t (*compat_write_data) (struct parport *port, const void *buf,
194 size_t len, int flags);
195 size_t (*nibble_read_data) (struct parport *port, void *buf,
196 size_t len, int flags);
197 size_t (*byte_read_data) (struct parport *port, void *buf,
198 size_t len, int flags);
199 struct module *owner;
202 struct parport_device_info {
203 parport_device_class class;
204 const char *class_name;
205 const char *mfr;
206 const char *model;
207 const char *cmdset;
208 const char *description;
211 /* Each device can have two callback functions:
212 * 1) a preemption function, called by the resource manager to request
213 * that the driver relinquish control of the port. The driver should
214 * return zero if it agrees to release the port, and nonzero if it
215 * refuses. Do not call parport_release() - the kernel will do this
216 * implicitly.
218 * 2) a wake-up function, called by the resource manager to tell drivers
219 * that the port is available to be claimed. If a driver wants to use
220 * the port, it should call parport_claim() here.
223 /* A parallel port device */
224 struct pardevice {
225 const char *name;
226 struct parport *port;
227 int daisy;
228 int (*preempt)(void *);
229 void (*wakeup)(void *);
230 void *private;
231 void (*irq_func)(void *);
232 unsigned int flags;
233 struct pardevice *next;
234 struct pardevice *prev;
235 struct parport_state *state; /* saved status over preemption */
236 wait_queue_head_t wait_q;
237 unsigned long int time;
238 unsigned long int timeslice;
239 volatile long int timeout;
240 unsigned long waiting; /* long req'd for set_bit --RR */
241 struct pardevice *waitprev;
242 struct pardevice *waitnext;
243 void * sysctl_table;
246 /* IEEE1284 information */
248 /* IEEE1284 phases. These are exposed to userland through ppdev IOCTL
249 * PP[GS]ETPHASE, so do not change existing values. */
250 enum ieee1284_phase {
251 IEEE1284_PH_FWD_DATA,
252 IEEE1284_PH_FWD_IDLE,
253 IEEE1284_PH_TERMINATE,
254 IEEE1284_PH_NEGOTIATION,
255 IEEE1284_PH_HBUSY_DNA,
256 IEEE1284_PH_REV_IDLE,
257 IEEE1284_PH_HBUSY_DAVAIL,
258 IEEE1284_PH_REV_DATA,
259 IEEE1284_PH_ECP_SETUP,
260 IEEE1284_PH_ECP_FWD_TO_REV,
261 IEEE1284_PH_ECP_REV_TO_FWD,
262 IEEE1284_PH_ECP_DIR_UNKNOWN,
264 struct ieee1284_info {
265 int mode;
266 volatile enum ieee1284_phase phase;
267 struct semaphore irq;
270 /* A parallel port */
271 struct parport {
272 unsigned long base; /* base address */
273 unsigned long base_hi; /* base address (hi - ECR) */
274 unsigned int size; /* IO extent */
275 const char *name;
276 unsigned int modes;
277 int irq; /* interrupt (or -1 for none) */
278 int dma;
279 int muxport; /* which muxport (if any) this is */
280 int portnum; /* which physical parallel port (not mux) */
281 struct device *dev; /* Physical device associated with IO/DMA.
282 * This may unfortulately be null if the
283 * port has a legacy driver.
286 struct parport *physport;
287 /* If this is a non-default mux
288 parport, i.e. we're a clone of a real
289 physical port, this is a pointer to that
290 port. The locking is only done in the
291 real port. For a clone port, the
292 following structure members are
293 meaningless: devices, cad, muxsel,
294 waithead, waittail, flags, pdir,
295 dev, ieee1284, *_lock.
297 It this is a default mux parport, or
298 there is no mux involved, this points to
299 ourself. */
301 struct pardevice *devices;
302 struct pardevice *cad; /* port owner */
303 int daisy; /* currently selected daisy addr */
304 int muxsel; /* currently selected mux port */
306 struct pardevice *waithead;
307 struct pardevice *waittail;
309 struct list_head list;
310 unsigned int flags;
312 void *sysctl_table;
313 struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
314 struct ieee1284_info ieee1284;
316 struct parport_operations *ops;
317 void *private_data; /* for lowlevel driver */
319 int number; /* port index - the `n' in `parportn' */
320 spinlock_t pardevice_lock;
321 spinlock_t waitlist_lock;
322 rwlock_t cad_lock;
324 int spintime;
325 atomic_t ref_count;
327 unsigned long devflags;
328 #define PARPORT_DEVPROC_REGISTERED 0
329 struct pardevice *proc_device; /* Currently register proc device */
331 struct list_head full_list;
332 struct parport *slaves[3];
335 #define DEFAULT_SPIN_TIME 500 /* us */
337 struct parport_driver {
338 const char *name;
339 void (*attach) (struct parport *);
340 void (*detach) (struct parport *);
341 struct list_head list;
344 /* parport_register_port registers a new parallel port at the given
345 address (if one does not already exist) and returns a pointer to it.
346 This entails claiming the I/O region, IRQ and DMA. NULL is returned
347 if initialisation fails. */
348 struct parport *parport_register_port(unsigned long base, int irq, int dma,
349 struct parport_operations *ops);
351 /* Once a registered port is ready for high-level drivers to use, the
352 low-level driver that registered it should announce it. This will
353 call the high-level drivers' attach() functions (after things like
354 determining the IEEE 1284.3 topology of the port and collecting
355 DeviceIDs). */
356 void parport_announce_port (struct parport *port);
358 /* Unregister a port. */
359 extern void parport_remove_port(struct parport *port);
361 /* Register a new high-level driver. */
362 extern int parport_register_driver (struct parport_driver *);
364 /* Unregister a high-level driver. */
365 extern void parport_unregister_driver (struct parport_driver *);
367 /* If parport_register_driver doesn't fit your needs, perhaps
368 * parport_find_xxx does. */
369 extern struct parport *parport_find_number (int);
370 extern struct parport *parport_find_base (unsigned long);
372 /* generic irq handler, if it suits your needs */
373 extern irqreturn_t parport_irq_handler(int irq, void *dev_id);
375 /* Reference counting for ports. */
376 extern struct parport *parport_get_port (struct parport *);
377 extern void parport_put_port (struct parport *);
379 /* parport_register_device declares that a device is connected to a
380 port, and tells the kernel all it needs to know.
381 - pf is the preemption function (may be NULL for no callback)
382 - kf is the wake-up function (may be NULL for no callback)
383 - irq_func is the interrupt handler (may be NULL for no interrupts)
384 - handle is a user pointer that gets handed to callback functions. */
385 struct pardevice *parport_register_device(struct parport *port,
386 const char *name,
387 int (*pf)(void *), void (*kf)(void *),
388 void (*irq_func)(void *),
389 int flags, void *handle);
391 /* parport_unregister unlinks a device from the chain. */
392 extern void parport_unregister_device(struct pardevice *dev);
394 /* parport_claim tries to gain ownership of the port for a particular
395 driver. This may fail (return non-zero) if another driver is busy.
396 If this driver has registered an interrupt handler, it will be
397 enabled. */
398 extern int parport_claim(struct pardevice *dev);
400 /* parport_claim_or_block is the same, but sleeps if the port cannot
401 be claimed. Return value is 1 if it slept, 0 normally and -errno
402 on error. */
403 extern int parport_claim_or_block(struct pardevice *dev);
405 /* parport_release reverses a previous parport_claim. This can never
406 fail, though the effects are undefined (except that they are bad)
407 if you didn't previously own the port. Once you have released the
408 port you should make sure that neither your code nor the hardware
409 on the port tries to initiate any communication without first
410 re-claiming the port. If you mess with the port state (enabling
411 ECP for example) you should clean up before releasing the port. */
413 extern void parport_release(struct pardevice *dev);
416 * parport_yield - relinquish a parallel port temporarily
417 * @dev: a device on the parallel port
419 * This function relinquishes the port if it would be helpful to other
420 * drivers to do so. Afterwards it tries to reclaim the port using
421 * parport_claim(), and the return value is the same as for
422 * parport_claim(). If it fails, the port is left unclaimed and it is
423 * the driver's responsibility to reclaim the port.
425 * The parport_yield() and parport_yield_blocking() functions are for
426 * marking points in the driver at which other drivers may claim the
427 * port and use their devices. Yielding the port is similar to
428 * releasing it and reclaiming it, but is more efficient because no
429 * action is taken if there are no other devices needing the port. In
430 * fact, nothing is done even if there are other devices waiting but
431 * the current device is still within its "timeslice". The default
432 * timeslice is half a second, but it can be adjusted via the /proc
433 * interface.
435 static __inline__ int parport_yield(struct pardevice *dev)
437 unsigned long int timeslip = (jiffies - dev->time);
438 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
439 return 0;
440 parport_release(dev);
441 return parport_claim(dev);
445 * parport_yield_blocking - relinquish a parallel port temporarily
446 * @dev: a device on the parallel port
448 * This function relinquishes the port if it would be helpful to other
449 * drivers to do so. Afterwards it tries to reclaim the port using
450 * parport_claim_or_block(), and the return value is the same as for
451 * parport_claim_or_block().
453 static __inline__ int parport_yield_blocking(struct pardevice *dev)
455 unsigned long int timeslip = (jiffies - dev->time);
456 if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
457 return 0;
458 parport_release(dev);
459 return parport_claim_or_block(dev);
462 /* Flags used to identify what a device does. */
463 #define PARPORT_DEV_TRAN 0 /* WARNING !! DEPRECATED !! */
464 #define PARPORT_DEV_LURK (1<<0) /* WARNING !! DEPRECATED !! */
465 #define PARPORT_DEV_EXCL (1<<1) /* Need exclusive access. */
467 #define PARPORT_FLAG_EXCL (1<<1) /* EXCL driver registered. */
469 /* IEEE1284 functions */
470 extern void parport_ieee1284_interrupt (void *);
471 extern int parport_negotiate (struct parport *, int mode);
472 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
473 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
475 #define PARPORT_INACTIVITY_O_NONBLOCK 1
476 extern long parport_set_timeout (struct pardevice *, long inactivity);
478 extern int parport_wait_event (struct parport *, long timeout);
479 extern int parport_wait_peripheral (struct parport *port,
480 unsigned char mask,
481 unsigned char val);
482 extern int parport_poll_peripheral (struct parport *port,
483 unsigned char mask,
484 unsigned char val,
485 int usec);
487 /* For architectural drivers */
488 extern size_t parport_ieee1284_write_compat (struct parport *,
489 const void *, size_t, int);
490 extern size_t parport_ieee1284_read_nibble (struct parport *,
491 void *, size_t, int);
492 extern size_t parport_ieee1284_read_byte (struct parport *,
493 void *, size_t, int);
494 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
495 void *, size_t, int);
496 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
497 const void *, size_t, int);
498 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
499 const void *, size_t, int);
500 extern size_t parport_ieee1284_epp_write_data (struct parport *,
501 const void *, size_t, int);
502 extern size_t parport_ieee1284_epp_read_data (struct parport *,
503 void *, size_t, int);
504 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
505 const void *, size_t, int);
506 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
507 void *, size_t, int);
509 /* IEEE1284.3 functions */
510 extern int parport_daisy_init (struct parport *port);
511 extern void parport_daisy_fini (struct parport *port);
512 extern struct pardevice *parport_open (int devnum, const char *name);
513 extern void parport_close (struct pardevice *dev);
514 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
515 extern void parport_daisy_deselect_all (struct parport *port);
516 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
518 /* Lowlevel drivers _can_ call this support function to handle irqs. */
519 static inline void parport_generic_irq(struct parport *port)
521 parport_ieee1284_interrupt (port);
522 read_lock(&port->cad_lock);
523 if (port->cad && port->cad->irq_func)
524 port->cad->irq_func(port->cad->private);
525 read_unlock(&port->cad_lock);
528 /* Prototypes from parport_procfs */
529 extern int parport_proc_register(struct parport *pp);
530 extern int parport_proc_unregister(struct parport *pp);
531 extern int parport_device_proc_register(struct pardevice *device);
532 extern int parport_device_proc_unregister(struct pardevice *device);
534 /* If PC hardware is the only type supported, we can optimise a bit. */
535 #if !defined(CONFIG_PARPORT_NOT_PC)
537 #include <linux/parport_pc.h>
538 #define parport_write_data(p,x) parport_pc_write_data(p,x)
539 #define parport_read_data(p) parport_pc_read_data(p)
540 #define parport_write_control(p,x) parport_pc_write_control(p,x)
541 #define parport_read_control(p) parport_pc_read_control(p)
542 #define parport_frob_control(p,m,v) parport_pc_frob_control(p,m,v)
543 #define parport_read_status(p) parport_pc_read_status(p)
544 #define parport_enable_irq(p) parport_pc_enable_irq(p)
545 #define parport_disable_irq(p) parport_pc_disable_irq(p)
546 #define parport_data_forward(p) parport_pc_data_forward(p)
547 #define parport_data_reverse(p) parport_pc_data_reverse(p)
549 #else /* !CONFIG_PARPORT_NOT_PC */
551 /* Generic operations vector through the dispatch table. */
552 #define parport_write_data(p,x) (p)->ops->write_data(p,x)
553 #define parport_read_data(p) (p)->ops->read_data(p)
554 #define parport_write_control(p,x) (p)->ops->write_control(p,x)
555 #define parport_read_control(p) (p)->ops->read_control(p)
556 #define parport_frob_control(p,m,v) (p)->ops->frob_control(p,m,v)
557 #define parport_read_status(p) (p)->ops->read_status(p)
558 #define parport_enable_irq(p) (p)->ops->enable_irq(p)
559 #define parport_disable_irq(p) (p)->ops->disable_irq(p)
560 #define parport_data_forward(p) (p)->ops->data_forward(p)
561 #define parport_data_reverse(p) (p)->ops->data_reverse(p)
563 #endif /* !CONFIG_PARPORT_NOT_PC */
565 extern unsigned long parport_default_timeslice;
566 extern int parport_default_spintime;
568 #endif /* __KERNEL__ */
569 #endif /* _PARPORT_H_ */