Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[firefly-linux-kernel-4.4.55.git] / include / linux / parport.h
1 /* $Id: parport.h,v 1.1 1998/05/17 10:57:52 andrea Exp andrea $ */
2
3 /*
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.
7  */
8
9 #ifndef _PARPORT_H_
10 #define _PARPORT_H_
11
12 /* Start off with user-visible constants */
13
14 /* Maximum of 16 ports per machine */
15 #define PARPORT_MAX  16
16
17 /* Magic numbers */
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
26
27 #define PARPORT_CONTROL_STROBE    0x1
28 #define PARPORT_CONTROL_AUTOFD    0x2
29 #define PARPORT_CONTROL_INIT      0x4
30 #define PARPORT_CONTROL_SELECT    0x8
31
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
37
38 /* Type classes for Plug-and-Play probe.  */
39 typedef enum {
40         PARPORT_CLASS_LEGACY = 0,       /* Non-IEEE1284 device */
41         PARPORT_CLASS_PRINTER,
42         PARPORT_CLASS_MODEM,
43         PARPORT_CLASS_NET,
44         PARPORT_CLASS_HDC,              /* Hard disk controller */
45         PARPORT_CLASS_PCMCIA,
46         PARPORT_CLASS_MEDIA,            /* Multimedia device */
47         PARPORT_CLASS_FDC,              /* Floppy disk controller */
48         PARPORT_CLASS_PORTS,
49         PARPORT_CLASS_SCANNER,
50         PARPORT_CLASS_DIGCAM,
51         PARPORT_CLASS_OTHER,            /* Anything else */
52         PARPORT_CLASS_UNSPEC,           /* No CLS field in ID */
53         PARPORT_CLASS_SCSIADAPTER
54 } parport_device_class;
55
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. */
65
66 /* IEEE1284 modes: 
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
83                                                  * be requested, using
84                                                  * bits 0-6. */
85
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 */
91
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 */
95
96 /* The rest is for the kernel only */
97 #ifdef __KERNEL__
98
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>
106
107 /* Define this later. */
108 struct parport;
109 struct pardevice;
110
111 struct pc_parport_state {
112         unsigned int ctr;
113         unsigned int ecr;
114 };
115
116 struct ax_parport_state {
117         unsigned int ctr;
118         unsigned int ecr;
119         unsigned int dcsr;
120 };
121
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 */
128 };
129
130 struct ip32_parport_state {
131         unsigned int dcr;
132         unsigned int ecr;
133 };
134
135 struct parport_state {
136         union {
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;
143                 void *misc; 
144         } u;
145 };
146
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 *);
151
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,
155                                       unsigned char val);
156
157         unsigned char (*read_status)(struct parport *);
158
159         /* IRQs. */
160         void (*enable_irq)(struct parport *);
161         void (*disable_irq)(struct parport *);
162
163         /* Data direction. */
164         void (*data_forward) (struct parport *);
165         void (*data_reverse) (struct parport *);
166
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 *);
171
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,
176                                  int flags);
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,
180                                  int flags);
181
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,
185                                  int flags);
186         size_t (*ecp_write_addr) (struct parport *port, const void *buf,
187                                   size_t len, int flags);
188
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;
196 };
197
198 struct parport_device_info {
199         parport_device_class class;
200         const char *class_name;
201         const char *mfr;
202         const char *model;
203         const char *cmdset;
204         const char *description;
205 };
206
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
212  *     implicitly.
213  *
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.
217  */
218
219 /* A parallel port device */
220 struct pardevice {
221         const char *name;
222         struct parport *port;
223         int daisy;
224         int (*preempt)(void *);
225         void (*wakeup)(void *);
226         void *private;
227         void (*irq_func)(int, void *, struct pt_regs *);
228         unsigned int flags;
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;
239         void * sysctl_table;
240 };
241
242 /* IEEE1284 information */
243
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,
259 };
260 struct ieee1284_info {
261         int mode;
262         volatile enum ieee1284_phase phase;
263         struct semaphore irq;
264 };
265
266 /* A parallel port */
267 struct parport {
268         unsigned long base;     /* base address */
269         unsigned long base_hi;  /* base address (hi - ECR) */
270         unsigned int size;      /* IO extent */
271         const char *name;
272         unsigned int modes;
273         int irq;                /* interrupt (or -1 for none) */
274         int dma;
275         int muxport;            /* which muxport (if any) this is */
276         int portnum;            /* which physical parallel port (not mux) */
277
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,
287                                    ieee1284, *_lock.
288
289                                    It this is a default mux parport, or
290                                    there is no mux involved, this points to
291                                    ourself. */
292
293         struct pardevice *devices;
294         struct pardevice *cad;  /* port owner */
295         int daisy;              /* currently selected daisy addr */
296         int muxsel;             /* currently selected mux port */
297
298         struct pardevice *waithead;
299         struct pardevice *waittail;
300         
301         struct list_head list;
302         unsigned int flags;
303
304         void *sysctl_table;
305         struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
306         struct ieee1284_info ieee1284;
307
308         struct parport_operations *ops;
309         void *private_data;     /* for lowlevel driver */
310
311         int number;             /* port index - the `n' in `parportn' */
312         spinlock_t pardevice_lock;
313         spinlock_t waitlist_lock;
314         rwlock_t cad_lock;
315
316         int spintime;
317         atomic_t ref_count;
318
319         struct list_head full_list;
320         struct parport *slaves[3];
321 };
322
323 #define DEFAULT_SPIN_TIME 500 /* us */
324
325 struct parport_driver {
326         const char *name;
327         void (*attach) (struct parport *);
328         void (*detach) (struct parport *);
329         struct list_head list;
330 };
331
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);
338
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
343    DeviceIDs). */
344 void parport_announce_port (struct parport *port);
345
346 /* Unregister a port. */
347 extern void parport_remove_port(struct parport *port);
348
349 /* Register a new high-level driver. */
350 extern int parport_register_driver (struct parport_driver *);
351
352 /* Unregister a high-level driver. */
353 extern void parport_unregister_driver (struct parport_driver *);
354
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);
359
360 /* Reference counting for ports. */
361 extern struct parport *parport_get_port (struct parport *);
362 extern void parport_put_port (struct parport *);
363
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, 
371                           const char *name,
372                           int (*pf)(void *), void (*kf)(void *),
373                           void (*irq_func)(int, void *, struct pt_regs *), 
374                           int flags, void *handle);
375
376 /* parport_unregister unlinks a device from the chain. */
377 extern void parport_unregister_device(struct pardevice *dev);
378
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
382    enabled.  */
383 extern int parport_claim(struct pardevice *dev);
384
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
387    on error.  */
388 extern int parport_claim_or_block(struct pardevice *dev);
389
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. */
397
398 extern void parport_release(struct pardevice *dev);
399
400 /**
401  * parport_yield - relinquish a parallel port temporarily
402  * @dev: a device on the parallel port
403  *
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.
409  *
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
418  * interface.
419  **/
420 static __inline__ int parport_yield(struct pardevice *dev)
421 {
422         unsigned long int timeslip = (jiffies - dev->time);
423         if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
424                 return 0;
425         parport_release(dev);
426         return parport_claim(dev);
427 }
428
429 /**
430  * parport_yield_blocking - relinquish a parallel port temporarily
431  * @dev: a device on the parallel port
432  *
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().
437  **/
438 static __inline__ int parport_yield_blocking(struct pardevice *dev)
439 {
440         unsigned long int timeslip = (jiffies - dev->time);
441         if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
442                 return 0;
443         parport_release(dev);
444         return parport_claim_or_block(dev);
445 }
446
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. */
451
452 #define PARPORT_FLAG_EXCL               (1<<1)  /* EXCL driver registered. */
453
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);
459
460 #define PARPORT_INACTIVITY_O_NONBLOCK 1
461 extern long parport_set_timeout (struct pardevice *, long inactivity);
462
463 extern int parport_wait_event (struct parport *, long timeout);
464 extern int parport_wait_peripheral (struct parport *port,
465                                     unsigned char mask,
466                                     unsigned char val);
467 extern int parport_poll_peripheral (struct parport *port,
468                                     unsigned char mask,
469                                     unsigned char val,
470                                     int usec);
471
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);
493
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,
498                                        int (*pf) (void *),
499                                        void (*kf) (void *),
500                                        void (*irqf) (int, void *,
501                                                      struct pt_regs *),
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);
508
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)
512 {
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);
518 }
519
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);
525
526 /* If PC hardware is the only type supported, we can optimise a bit.  */
527 #if !defined(CONFIG_PARPORT_NOT_PC)
528
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)
540
541 #else  /*  !CONFIG_PARPORT_NOT_PC  */
542
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)
554
555 #endif /*  !CONFIG_PARPORT_NOT_PC  */
556
557 #endif /* __KERNEL__ */
558 #endif /* _PARPORT_H_ */