drivers/usb/serial/usb-serial.h

   1 /*
   2  * USB Serial Converter driver
   3  *
   4  *      Copyright (C) 1999, 2000
   5  *          Greg Kroah-Hartman (greg@kroah.com)
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  * See Documentation/usb/usb-serial.txt for more information on using this driver
  13  *
  14  */
  15
  16
  17 #ifndef __LINUX_USB_SERIAL_H
  18 #define __LINUX_USB_SERIAL_H
  19
  20 #include <linux/config.h>
  21
  22 #define SERIAL_TTY_MAJOR        188     /* Nice legal number now */
  23 #define SERIAL_TTY_MINORS       255     /* loads of devices :) */
  24
  25 #define MAX_NUM_PORTS           8       /* The maximum number of ports one device can grab at once */
  26
  27 #define USB_SERIAL_MAGIC        0x6702  /* magic number for usb_serial struct */
  28 #define USB_SERIAL_PORT_MAGIC   0x7301  /* magic number for usb_serial_port struct */
  29
  30 /* parity check flag */
  31 #define RELEVANT_IFLAG(iflag)   (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
  32
  33
  34 struct usb_serial_port {
  35         int                     magic;
  36         struct usb_serial       *serial;        /* pointer back to the owner of this port */
  37         struct tty_struct *     tty;            /* the coresponding tty for this port */
  38         unsigned char           minor;
  39         unsigned char           number;
  40         char                    active;         /* someone has this device open */
  41
  42         unsigned char *         interrupt_in_buffer;
  43         struct urb *            interrupt_in_urb;
  44
  45         unsigned char *         bulk_in_buffer;
  46         struct urb *            read_urb;
  47
  48         unsigned char *         bulk_out_buffer;
  49         int                     bulk_out_size;
  50         struct urb *            write_urb;
  51
  52         wait_queue_head_t       write_wait;
  53
  54         struct tq_struct        tqueue;         /* task queue for line discipline waking up */
  55
  56         void *                  private;        /* data private to the specific port */
  57 };
  58
  59 struct usb_serial {
  60         int                             magic;
  61         struct usb_device *             dev;
  62         struct usb_serial_device_type * type;                   /* the type of usb serial device this is */
  63         struct tty_driver *             tty_driver;             /* the tty_driver for this device */
  64         unsigned char                   minor;                  /* the starting minor number for this device */
  65         unsigned char                   num_ports;              /* the number of ports this device has */
  66         char                            num_interrupt_in;       /* number of interrupt in endpoints we have */
  67         char                            num_bulk_in;            /* number of bulk in endpoints we have */
  68         char                            num_bulk_out;           /* number of bulk out endpoints we have */
  69         struct usb_serial_port          port[MAX_NUM_PORTS];
  70
  71         void *                  private;                /* data private to the specific driver */
  72 };
  73
  74
  75 #define MUST_HAVE_NOT   0x01
  76 #define MUST_HAVE       0x02
  77 #define DONT_CARE       0x03
  78
  79 #define HAS             0x02
  80 #define HAS_NOT         0x01
  81
  82 #define NUM_DONT_CARE   (-1)
  83
  84
  85 /* This structure defines the individual serial converter. */
  86 struct usb_serial_device_type {
  87         char    *name;
  88         __u16   *idVendor;
  89         __u16   *idProduct;
  90         char    needs_interrupt_in;
  91         char    needs_bulk_in;
  92         char    needs_bulk_out;
  93         char    num_interrupt_in;
  94         char    num_bulk_in;
  95         char    num_bulk_out;
  96         char    num_ports;              /* number of serial ports this device has */
  97
  98         /* function call to make before accepting driver */
  99         int (*startup) (struct usb_serial *serial);     /* return 0 to continue initialization, anything else to abort */
 100         void (*shutdown) (struct usb_serial *serial);
 101
 102         /* serial function calls */
 103         int  (*open)            (struct usb_serial_port *port, struct file * filp);
 104         void (*close)           (struct usb_serial_port *port, struct file * filp);
 105         int  (*write)           (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
 106         int  (*write_room)      (struct usb_serial_port *port);
 107         int  (*ioctl)           (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
 108         void (*set_termios)     (struct usb_serial_port *port, struct termios * old);
 109         void (*break_ctl)       (struct usb_serial_port *port, int break_state);
 110         int  (*chars_in_buffer) (struct usb_serial_port *port);
 111         void (*throttle)        (struct usb_serial_port *port);
 112         void (*unthrottle)      (struct usb_serial_port *port);
 113
 114         void (*read_int_callback)(struct urb *urb);
 115         void (*read_bulk_callback)(struct urb *urb);
 116         void (*write_bulk_callback)(struct urb *urb);
 117 };
 118
 119
 120
 121 extern struct usb_serial_device_type handspring_device;
 122 extern struct usb_serial_device_type whiteheat_fake_device;
 123 extern struct usb_serial_device_type whiteheat_device;
 124 extern struct usb_serial_device_type ftdi_sio_device;
 125 extern struct usb_serial_device_type keyspan_pda_fake_device;
 126 extern struct usb_serial_device_type keyspan_pda_device;
 127 extern struct usb_serial_device_type zyxel_omninet_device;
 128 extern struct usb_serial_device_type digi_acceleport_device;
 129
 130
 131 /* determine if we should include the EzUSB loader functions */
 132 #if defined(CONFIG_USB_SERIAL_KEYSPAN_PDA) || defined(CONFIG_USB_SERIAL_WHITEHEAT)
 133         #define USES_EZUSB_FUNCTIONS
 134         extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest);
 135         extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit);
 136 #else
 137         #undef  USES_EZUSB_FUNCTIONS
 138 #endif
 139
 140
 141 /* Inline functions to check the sanity of a pointer that is passed to us */
 142 static inline int serial_paranoia_check (struct usb_serial *serial, const char *function)
 143 {
 144         if (!serial) {
 145                 dbg("%s - serial == NULL", function);
 146                 return -1;
 147         }
 148         if (serial->magic != USB_SERIAL_MAGIC) {
 149                 dbg("%s - bad magic number for serial", function);
 150                 return -1;
 151         }
 152         if (!serial->type) {
 153                 dbg("%s - serial->type == NULL!", function);
 154                 return -1;
 155         }
 156
 157         return 0;
 158 }
 159
 160
 161 static inline int port_paranoia_check (struct usb_serial_port *port, const char *function)
 162 {
 163         if (!port) {
 164                 dbg("%s - port == NULL", function);
 165                 return -1;
 166         }
 167         if (port->magic != USB_SERIAL_PORT_MAGIC) {
 168                 dbg("%s - bad magic number for port", function);
 169                 return -1;
 170         }
 171         if (!port->serial) {
 172                 dbg("%s - port->serial == NULL", function);
 173                 return -1;
 174         }
 175         if (!port->tty) {
 176                 dbg("%s - port->tty == NULL", function);
 177                 return -1;
 178         }
 179
 180         return 0;
 181 }
 182
 183 #endif  /* ifdef __LINUX_USB_SERIAL_H */
 184