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/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>
 107
 108 /* Define this later. */
 109 struct parport;
 110 struct pardevice;
 111
 112 struct pc_parport_state {
 113         unsigned int ctr;
 114         unsigned int ecr;
 115 };
 116
 117 struct ax_parport_state {
 118         unsigned int ctr;
 119         unsigned int ecr;
 120         unsigned int dcsr;
 121 };
 122
 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 */
 129 };
 130
 131 struct parport_state {
 132         union {
 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. */
 138                 void *misc;
 139         } u;
 140 };
 141
 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 *);
 146
 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,
 150                                       unsigned char val);
 151
 152         unsigned char (*read_status)(struct parport *);
 153
 154         /* IRQs. */
 155         void (*enable_irq)(struct parport *);
 156         void (*disable_irq)(struct parport *);
 157
 158         /* Data direction. */
 159         void (*data_forward) (struct parport *);
 160         void (*data_reverse) (struct parport *);
 161
 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 *);
 166
 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,
 171                                  int flags);
 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,
 175                                  int flags);
 176
 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,
 180                                  int flags);
 181         size_t (*ecp_write_addr) (struct parport *port, const void *buf,
 182                                   size_t len, int flags);
 183
 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;
 191 };
 192
 193 struct parport_device_info {
 194         parport_device_class class;
 195         const char *class_name;
 196         const char *mfr;
 197         const char *model;
 198         const char *cmdset;
 199         const char *description;
 200 };
 201
 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
 207  *     implicitly.
 208  *
 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.
 212  */
 213
 214 /* A parallel port device */
 215 struct pardevice {
 216         const char *name;
 217         struct parport *port;
 218         int daisy;
 219         int (*preempt)(void *);
 220         void (*wakeup)(void *);
 221         void *private;
 222         void (*irq_func)(int, void *, struct pt_regs *);
 223         unsigned int flags;
 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;
 234         void * sysctl_table;
 235 };
 236
 237 /* IEEE1284 information */
 238
 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_HBUSY_DNA,
 246         IEEE1284_PH_REV_IDLE,
 247         IEEE1284_PH_HBUSY_DAVAIL,
 248         IEEE1284_PH_REV_DATA,
 249         IEEE1284_PH_ECP_SETUP,
 250         IEEE1284_PH_ECP_FWD_TO_REV,
 251         IEEE1284_PH_ECP_REV_TO_FWD,
 252         IEEE1284_PH_ECP_DIR_UNKNOWN,
 253 };
 254 struct ieee1284_info {
 255         int mode;
 256         volatile enum ieee1284_phase phase;
 257         struct semaphore irq;
 258 };
 259
 260 /* A parallel port */
 261 struct parport {
 262         unsigned long base;     /* base address */
 263         unsigned long base_hi;  /* base address (hi - ECR) */
 264         unsigned int size;      /* IO extent */
 265         const char *name;
 266         unsigned int modes;
 267         int irq;                /* interrupt (or -1 for none) */
 268         int dma;
 269         int muxport;            /* which muxport (if any) this is */
 270         int portnum;            /* which physical parallel port (not mux) */
 271
 272         struct parport *physport;
 273                                 /* If this is a non-default mux
 274                                    parport, i.e. we're a clone of a real
 275                                    physical port, this is a pointer to that
 276                                    port. The locking is only done in the
 277                                    real port.  For a clone port, the
 278                                    following structure members are
 279                                    meaningless: devices, cad, muxsel,
 280                                    waithead, waittail, flags, pdir,
 281                                    ieee1284, *_lock.
 282
 283                                    It this is a default mux parport, or
 284                                    there is no mux involved, this points to
 285                                    ourself. */
 286
 287         struct pardevice *devices;
 288         struct pardevice *cad;  /* port owner */
 289         int daisy;              /* currently selected daisy addr */
 290         int muxsel;             /* currently selected mux port */
 291
 292         struct pardevice *waithead;
 293         struct pardevice *waittail;
 294
 295         struct list_head list;
 296         unsigned int flags;
 297
 298         void *sysctl_table;
 299         struct parport_device_info probe_info[5]; /* 0-3 + non-IEEE1284.3 */
 300         struct ieee1284_info ieee1284;
 301
 302         struct parport_operations *ops;
 303         void *private_data;     /* for lowlevel driver */
 304
 305         int number;             /* port index - the `n' in `parportn' */
 306         spinlock_t pardevice_lock;
 307         spinlock_t waitlist_lock;
 308         rwlock_t cad_lock;
 309
 310         int spintime;
 311         atomic_t ref_count;
 312
 313         struct list_head full_list;
 314         struct parport *slaves[3];
 315 };
 316
 317 #define DEFAULT_SPIN_TIME 500 /* us */
 318
 319 struct parport_driver {
 320         const char *name;
 321         void (*attach) (struct parport *);
 322         void (*detach) (struct parport *);
 323         struct list_head list;
 324 };
 325
 326 /* parport_register_port registers a new parallel port at the given
 327    address (if one does not already exist) and returns a pointer to it.
 328    This entails claiming the I/O region, IRQ and DMA.  NULL is returned
 329    if initialisation fails. */
 330 struct parport *parport_register_port(unsigned long base, int irq, int dma,
 331                                       struct parport_operations *ops);
 332
 333 /* Once a registered port is ready for high-level drivers to use, the
 334    low-level driver that registered it should announce it.  This will
 335    call the high-level drivers' attach() functions (after things like
 336    determining the IEEE 1284.3 topology of the port and collecting
 337    DeviceIDs). */
 338 void parport_announce_port (struct parport *port);
 339
 340 /* Unregister a port. */
 341 extern void parport_remove_port(struct parport *port);
 342
 343 /* Register a new high-level driver. */
 344 extern int parport_register_driver (struct parport_driver *);
 345
 346 /* Unregister a high-level driver. */
 347 extern void parport_unregister_driver (struct parport_driver *);
 348
 349 /* If parport_register_driver doesn't fit your needs, perhaps
 350  * parport_find_xxx does. */
 351 extern struct parport *parport_find_number (int);
 352 extern struct parport *parport_find_base (unsigned long);
 353
 354 /* Reference counting for ports. */
 355 extern struct parport *parport_get_port (struct parport *);
 356 extern void parport_put_port (struct parport *);
 357
 358 /* parport_register_device declares that a device is connected to a
 359    port, and tells the kernel all it needs to know.
 360    - pf is the preemption function (may be NULL for no callback)
 361    - kf is the wake-up function (may be NULL for no callback)
 362    - irq_func is the interrupt handler (may be NULL for no interrupts)
 363    - handle is a user pointer that gets handed to callback functions.  */
 364 struct pardevice *parport_register_device(struct parport *port,
 365                           const char *name,
 366                           int (*pf)(void *), void (*kf)(void *),
 367                           void (*irq_func)(int, void *, struct pt_regs *),
 368                           int flags, void *handle);
 369
 370 /* parport_unregister unlinks a device from the chain. */
 371 extern void parport_unregister_device(struct pardevice *dev);
 372
 373 /* parport_claim tries to gain ownership of the port for a particular
 374    driver.  This may fail (return non-zero) if another driver is busy.
 375    If this driver has registered an interrupt handler, it will be
 376    enabled.  */
 377 extern int parport_claim(struct pardevice *dev);
 378
 379 /* parport_claim_or_block is the same, but sleeps if the port cannot
 380    be claimed.  Return value is 1 if it slept, 0 normally and -errno
 381    on error.  */
 382 extern int parport_claim_or_block(struct pardevice *dev);
 383
 384 /* parport_release reverses a previous parport_claim.  This can never
 385    fail, though the effects are undefined (except that they are bad)
 386    if you didn't previously own the port.  Once you have released the
 387    port you should make sure that neither your code nor the hardware
 388    on the port tries to initiate any communication without first
 389    re-claiming the port.  If you mess with the port state (enabling
 390    ECP for example) you should clean up before releasing the port. */
 391
 392 extern void parport_release(struct pardevice *dev);
 393
 394 /**
 395  * parport_yield - relinquish a parallel port temporarily
 396  * @dev: a device on the parallel port
 397  *
 398  * This function relinquishes the port if it would be helpful to other
 399  * drivers to do so.  Afterwards it tries to reclaim the port using
 400  * parport_claim(), and the return value is the same as for
 401  * parport_claim().  If it fails, the port is left unclaimed and it is
 402  * the driver's responsibility to reclaim the port.
 403  *
 404  * The parport_yield() and parport_yield_blocking() functions are for
 405  * marking points in the driver at which other drivers may claim the
 406  * port and use their devices.  Yielding the port is similar to
 407  * releasing it and reclaiming it, but is more efficient because no
 408  * action is taken if there are no other devices needing the port.  In
 409  * fact, nothing is done even if there are other devices waiting but
 410  * the current device is still within its "timeslice".  The default
 411  * timeslice is half a second, but it can be adjusted via the /proc
 412  * interface.
 413  **/
 414 static __inline__ int parport_yield(struct pardevice *dev)
 415 {
 416         unsigned long int timeslip = (jiffies - dev->time);
 417         if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
 418                 return 0;
 419         parport_release(dev);
 420         return parport_claim(dev);
 421 }
 422
 423 /**
 424  * parport_yield_blocking - relinquish a parallel port temporarily
 425  * @dev: a device on the parallel port
 426  *
 427  * This function relinquishes the port if it would be helpful to other
 428  * drivers to do so.  Afterwards it tries to reclaim the port using
 429  * parport_claim_or_block(), and the return value is the same as for
 430  * parport_claim_or_block().
 431  **/
 432 static __inline__ int parport_yield_blocking(struct pardevice *dev)
 433 {
 434         unsigned long int timeslip = (jiffies - dev->time);
 435         if ((dev->port->waithead == NULL) || (timeslip < dev->timeslice))
 436                 return 0;
 437         parport_release(dev);
 438         return parport_claim_or_block(dev);
 439 }
 440
 441 /* Flags used to identify what a device does. */
 442 #define PARPORT_DEV_TRAN                0       /* WARNING !! DEPRECATED !! */
 443 #define PARPORT_DEV_LURK                (1<<0)  /* WARNING !! DEPRECATED !! */
 444 #define PARPORT_DEV_EXCL                (1<<1)  /* Need exclusive access. */
 445
 446 #define PARPORT_FLAG_EXCL               (1<<1)  /* EXCL driver registered. */
 447
 448 /* IEEE1284 functions */
 449 extern void parport_ieee1284_interrupt (int, void *, struct pt_regs *);
 450 extern int parport_negotiate (struct parport *, int mode);
 451 extern ssize_t parport_write (struct parport *, const void *buf, size_t len);
 452 extern ssize_t parport_read (struct parport *, void *buf, size_t len);
 453
 454 #define PARPORT_INACTIVITY_O_NONBLOCK 1
 455 extern long parport_set_timeout (struct pardevice *, long inactivity);
 456
 457 extern int parport_wait_event (struct parport *, long timeout);
 458 extern int parport_wait_peripheral (struct parport *port,
 459                                     unsigned char mask,
 460                                     unsigned char val);
 461 extern int parport_poll_peripheral (struct parport *port,
 462                                     unsigned char mask,
 463                                     unsigned char val,
 464                                     int usec);
 465
 466 /* For architectural drivers */
 467 extern size_t parport_ieee1284_write_compat (struct parport *,
 468                                              const void *, size_t, int);
 469 extern size_t parport_ieee1284_read_nibble (struct parport *,
 470                                             void *, size_t, int);
 471 extern size_t parport_ieee1284_read_byte (struct parport *,
 472                                           void *, size_t, int);
 473 extern size_t parport_ieee1284_ecp_read_data (struct parport *,
 474                                               void *, size_t, int);
 475 extern size_t parport_ieee1284_ecp_write_data (struct parport *,
 476                                                const void *, size_t, int);
 477 extern size_t parport_ieee1284_ecp_write_addr (struct parport *,
 478                                                const void *, size_t, int);
 479 extern size_t parport_ieee1284_epp_write_data (struct parport *,
 480                                                const void *, size_t, int);
 481 extern size_t parport_ieee1284_epp_read_data (struct parport *,
 482                                               void *, size_t, int);
 483 extern size_t parport_ieee1284_epp_write_addr (struct parport *,
 484                                                const void *, size_t, int);
 485 extern size_t parport_ieee1284_epp_read_addr (struct parport *,
 486                                               void *, size_t, int);
 487
 488 /* IEEE1284.3 functions */
 489 extern int parport_daisy_init (struct parport *port);
 490 extern void parport_daisy_fini (struct parport *port);
 491 extern struct pardevice *parport_open (int devnum, const char *name,
 492                                        int (*pf) (void *),
 493                                        void (*kf) (void *),
 494                                        void (*irqf) (int, void *,
 495                                                      struct pt_regs *),
 496                                        int flags, void *handle);
 497 extern void parport_close (struct pardevice *dev);
 498 extern ssize_t parport_device_id (int devnum, char *buffer, size_t len);
 499 extern int parport_device_num (int parport, int mux, int daisy);
 500 extern void parport_daisy_deselect_all (struct parport *port);
 501 extern int parport_daisy_select (struct parport *port, int daisy, int mode);
 502
 503 /* Lowlevel drivers _can_ call this support function to handle irqs.  */
 504 static __inline__ void parport_generic_irq(int irq, struct parport *port,
 505                                            struct pt_regs *regs)
 506 {
 507         parport_ieee1284_interrupt (irq, port, regs);
 508         read_lock(&port->cad_lock);
 509         if (port->cad && port->cad->irq_func)
 510                 port->cad->irq_func(irq, port->cad->private, regs);
 511         read_unlock(&port->cad_lock);
 512 }
 513
 514 /* Prototypes from parport_procfs */
 515 extern int parport_proc_register(struct parport *pp);
 516 extern int parport_proc_unregister(struct parport *pp);
 517 extern int parport_device_proc_register(struct pardevice *device);
 518 extern int parport_device_proc_unregister(struct pardevice *device);
 519
 520 /* If PC hardware is the only type supported, we can optimise a bit.  */
 521 #if !defined(CONFIG_PARPORT_NOT_PC)
 522
 523 #include <linux/parport_pc.h>
 524 #define parport_write_data(p,x)            parport_pc_write_data(p,x)
 525 #define parport_read_data(p)               parport_pc_read_data(p)
 526 #define parport_write_control(p,x)         parport_pc_write_control(p,x)
 527 #define parport_read_control(p)            parport_pc_read_control(p)
 528 #define parport_frob_control(p,m,v)        parport_pc_frob_control(p,m,v)
 529 #define parport_read_status(p)             parport_pc_read_status(p)
 530 #define parport_enable_irq(p)              parport_pc_enable_irq(p)
 531 #define parport_disable_irq(p)             parport_pc_disable_irq(p)
 532 #define parport_data_forward(p)            parport_pc_data_forward(p)
 533 #define parport_data_reverse(p)            parport_pc_data_reverse(p)
 534
 535 #else  /*  !CONFIG_PARPORT_NOT_PC  */
 536
 537 /* Generic operations vector through the dispatch table. */
 538 #define parport_write_data(p,x)            (p)->ops->write_data(p,x)
 539 #define parport_read_data(p)               (p)->ops->read_data(p)
 540 #define parport_write_control(p,x)         (p)->ops->write_control(p,x)
 541 #define parport_read_control(p)            (p)->ops->read_control(p)
 542 #define parport_frob_control(p,m,v)        (p)->ops->frob_control(p,m,v)
 543 #define parport_read_status(p)             (p)->ops->read_status(p)
 544 #define parport_enable_irq(p)              (p)->ops->enable_irq(p)
 545 #define parport_disable_irq(p)             (p)->ops->disable_irq(p)
 546 #define parport_data_forward(p)            (p)->ops->data_forward(p)
 547 #define parport_data_reverse(p)            (p)->ops->data_reverse(p)
 548
 549 #endif /*  !CONFIG_PARPORT_NOT_PC  */
 550
 551 #endif /* __KERNEL__ */
 552 #endif /* _PARPORT_H_ */