include/linux/usb/serial.h

   1 /*
   2  * USB Serial Converter stuff
   3  *
   4  *      Copyright (C) 1999 - 2005
   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; version 2 of the License.
  10  *
  11  */
  12
  13
  14 #ifndef __LINUX_USB_SERIAL_H
  15 #define __LINUX_USB_SERIAL_H
  16
  17 #include <linux/kref.h>
  18 #include <linux/mutex.h>
  19
  20 #define SERIAL_TTY_MAJOR        188     /* Nice legal number now */
  21 #define SERIAL_TTY_MINORS       255     /* loads of devices :) */
  22
  23 #define MAX_NUM_PORTS           8       /* The maximum number of ports one device can grab at once */
  24
  25 /* parity check flag */
  26 #define RELEVANT_IFLAG(iflag)   (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
  27
  28 /**
  29  * usb_serial_port: structure for the specific ports of a device.
  30  * @serial: pointer back to the struct usb_serial owner of this port.
  31  * @tty: pointer to the corresponding tty for this port.
  32  * @lock: spinlock to grab when updating portions of this structure.
  33  * @mutex: mutex used to synchronize serial_open() and serial_close()
  34  *      access for this port.
  35  * @number: the number of the port (the minor number).
  36  * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
  37  * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
  38  * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
  39  *      for this port.
  40  * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
  41  * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
  42  * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
  43  * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
  44  *      for this port.
  45  * @bulk_in_buffer: pointer to the bulk in buffer for this port.
  46  * @read_urb: pointer to the bulk in struct urb for this port.
  47  * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
  48  *      port.
  49  * @bulk_out_buffer: pointer to the bulk out buffer for this port.
  50  * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
  51  * @write_urb: pointer to the bulk out struct urb for this port.
  52  * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
  53  *      port.
  54  * @write_wait: a wait_queue_head_t used by the port.
  55  * @work: work queue entry for the line discipline waking up.
  56  * @open_count: number of times this port has been opened.
  57  *
  58  * This structure is used by the usb-serial core and drivers for the specific
  59  * ports of a device.
  60  */
  61 struct usb_serial_port {
  62         struct usb_serial *     serial;
  63         struct tty_struct *     tty;
  64         spinlock_t              lock;
  65         struct mutex            mutex;
  66         unsigned char           number;
  67
  68         unsigned char *         interrupt_in_buffer;
  69         struct urb *            interrupt_in_urb;
  70         __u8                    interrupt_in_endpointAddress;
  71
  72         unsigned char *         interrupt_out_buffer;
  73         int                     interrupt_out_size;
  74         struct urb *            interrupt_out_urb;
  75         __u8                    interrupt_out_endpointAddress;
  76
  77         unsigned char *         bulk_in_buffer;
  78         int                     bulk_in_size;
  79         struct urb *            read_urb;
  80         __u8                    bulk_in_endpointAddress;
  81
  82         unsigned char *         bulk_out_buffer;
  83         int                     bulk_out_size;
  84         struct urb *            write_urb;
  85         int                     write_urb_busy;
  86         __u8                    bulk_out_endpointAddress;
  87
  88         wait_queue_head_t       write_wait;
  89         struct work_struct      work;
  90         int                     open_count;
  91         struct device           dev;
  92 };
  93 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
  94
  95 /* get and set the port private data pointer helper functions */
  96 static inline void *usb_get_serial_port_data (struct usb_serial_port *port)
  97 {
  98         return dev_get_drvdata(&port->dev);
  99 }
 100
 101 static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data)
 102 {
 103         dev_set_drvdata(&port->dev, data);
 104 }
 105
 106 /**
 107  * usb_serial - structure used by the usb-serial core for a device
 108  * @dev: pointer to the struct usb_device for this device
 109  * @type: pointer to the struct usb_serial_driver for this device
 110  * @interface: pointer to the struct usb_interface for this device
 111  * @minor: the starting minor number for this device
 112  * @num_ports: the number of ports this device has
 113  * @num_interrupt_in: number of interrupt in endpoints we have
 114  * @num_interrupt_out: number of interrupt out endpoints we have
 115  * @num_bulk_in: number of bulk in endpoints we have
 116  * @num_bulk_out: number of bulk out endpoints we have
 117  * @port: array of struct usb_serial_port structures for the different ports.
 118  * @private: place to put any driver specific information that is needed.  The
 119  *      usb-serial driver is required to manage this data, the usb-serial core
 120  *      will not touch this.  Use usb_get_serial_data() and
 121  *      usb_set_serial_data() to access this.
 122  */
 123 struct usb_serial {
 124         struct usb_device *             dev;
 125         struct usb_serial_driver *      type;
 126         struct usb_interface *          interface;
 127         unsigned char                   minor;
 128         unsigned char                   num_ports;
 129         unsigned char                   num_port_pointers;
 130         char                            num_interrupt_in;
 131         char                            num_interrupt_out;
 132         char                            num_bulk_in;
 133         char                            num_bulk_out;
 134         struct usb_serial_port *        port[MAX_NUM_PORTS];
 135         struct kref                     kref;
 136         void *                          private;
 137 };
 138 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
 139
 140 #define NUM_DONT_CARE   (-1)
 141
 142 /* get and set the serial private data pointer helper functions */
 143 static inline void *usb_get_serial_data (struct usb_serial *serial)
 144 {
 145         return serial->private;
 146 }
 147
 148 static inline void usb_set_serial_data (struct usb_serial *serial, void *data)
 149 {
 150         serial->private = data;
 151 }
 152
 153 /**
 154  * usb_serial_driver - describes a usb serial driver
 155  * @description: pointer to a string that describes this driver.  This string used
 156  *      in the syslog messages when a device is inserted or removed.
 157  * @id_table: pointer to a list of usb_device_id structures that define all
 158  *      of the devices this structure can support.
 159  * @num_interrupt_in: the number of interrupt in endpoints this device will
 160  *      have.
 161  * @num_interrupt_out: the number of interrupt out endpoints this device will
 162  *      have.
 163  * @num_bulk_in: the number of bulk in endpoints this device will have.
 164  * @num_bulk_out: the number of bulk out endpoints this device will have.
 165  * @num_ports: the number of different ports this device will have.
 166  * @calc_num_ports: pointer to a function to determine how many ports this
 167  *      device has dynamically.  It will be called after the probe()
 168  *      callback is called, but before attach()
 169  * @probe: pointer to the driver's probe function.
 170  *      This will be called when the device is inserted into the system,
 171  *      but before the device has been fully initialized by the usb_serial
 172  *      subsystem.  Use this function to download any firmware to the device,
 173  *      or any other early initialization that might be needed.
 174  *      Return 0 to continue on with the initialization sequence.  Anything
 175  *      else will abort it.
 176  * @attach: pointer to the driver's attach function.
 177  *      This will be called when the struct usb_serial structure is fully set
 178  *      set up.  Do any local initialization of the device, or any private
 179  *      memory structure allocation at this point in time.
 180  * @shutdown: pointer to the driver's shutdown function.  This will be
 181  *      called when the device is removed from the system.
 182  *
 183  * This structure is defines a USB Serial driver.  It provides all of
 184  * the information that the USB serial core code needs.  If the function
 185  * pointers are defined, then the USB serial core code will call them when
 186  * the corresponding tty port functions are called.  If they are not
 187  * called, the generic serial function will be used instead.
 188  *
 189  * The driver.owner field should be set to the module owner of this driver.
 190  * The driver.name field should be set to the name of this driver (remember
 191  * it will show up in sysfs, so it needs to be short and to the point.
 192  * Useing the module name is a good idea.)
 193  */
 194 struct usb_serial_driver {
 195         const char *description;
 196         const struct usb_device_id *id_table;
 197         char    num_interrupt_in;
 198         char    num_interrupt_out;
 199         char    num_bulk_in;
 200         char    num_bulk_out;
 201         char    num_ports;
 202
 203         struct list_head        driver_list;
 204         struct device_driver    driver;
 205
 206         int (*probe) (struct usb_serial *serial, const struct usb_device_id *id);
 207         int (*attach) (struct usb_serial *serial);
 208         int (*calc_num_ports) (struct usb_serial *serial);
 209
 210         void (*shutdown) (struct usb_serial *serial);
 211
 212         int (*port_probe) (struct usb_serial_port *port);
 213         int (*port_remove) (struct usb_serial_port *port);
 214
 215         /* serial function calls */
 216         int  (*open)            (struct usb_serial_port *port, struct file * filp);
 217         void (*close)           (struct usb_serial_port *port, struct file * filp);
 218         int  (*write)           (struct usb_serial_port *port, const unsigned char *buf, int count);
 219         int  (*write_room)      (struct usb_serial_port *port);
 220         int  (*ioctl)           (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
 221         void (*set_termios)     (struct usb_serial_port *port, struct ktermios * old);
 222         void (*break_ctl)       (struct usb_serial_port *port, int break_state);
 223         int  (*chars_in_buffer) (struct usb_serial_port *port);
 224         void (*throttle)        (struct usb_serial_port *port);
 225         void (*unthrottle)      (struct usb_serial_port *port);
 226         int  (*tiocmget)        (struct usb_serial_port *port, struct file *file);
 227         int  (*tiocmset)        (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
 228
 229         void (*read_int_callback)(struct urb *urb);
 230         void (*write_int_callback)(struct urb *urb);
 231         void (*read_bulk_callback)(struct urb *urb);
 232         void (*write_bulk_callback)(struct urb *urb);
 233 };
 234 #define to_usb_serial_driver(d) container_of(d, struct usb_serial_driver, driver)
 235
 236 extern int  usb_serial_register(struct usb_serial_driver *driver);
 237 extern void usb_serial_deregister(struct usb_serial_driver *driver);
 238 extern void usb_serial_port_softint(struct usb_serial_port *port);
 239
 240 extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id);
 241 extern void usb_serial_disconnect(struct usb_interface *iface);
 242
 243 extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest);
 244 extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit);
 245
 246 /* USB Serial console functions */
 247 #ifdef CONFIG_USB_SERIAL_CONSOLE
 248 extern void usb_serial_console_init (int debug, int minor);
 249 extern void usb_serial_console_exit (void);
 250 extern void usb_serial_console_disconnect(struct usb_serial *serial);
 251 #else
 252 static inline void usb_serial_console_init (int debug, int minor) { }
 253 static inline void usb_serial_console_exit (void) { }
 254 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
 255 #endif
 256
 257 /* Functions needed by other parts of the usbserial core */
 258 extern struct usb_serial *usb_serial_get_by_index (unsigned int minor);
 259 extern void usb_serial_put(struct usb_serial *serial);
 260 extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp);
 261 extern int usb_serial_generic_write (struct usb_serial_port *port, const unsigned char *buf, int count);
 262 extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp);
 263 extern int usb_serial_generic_write_room (struct usb_serial_port *port);
 264 extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port);
 265 extern void usb_serial_generic_read_bulk_callback (struct urb *urb);
 266 extern void usb_serial_generic_write_bulk_callback (struct urb *urb);
 267 extern void usb_serial_generic_shutdown (struct usb_serial *serial);
 268 extern int usb_serial_generic_register (int debug);
 269 extern void usb_serial_generic_deregister (void);
 270
 271 extern int usb_serial_bus_register (struct usb_serial_driver *device);
 272 extern void usb_serial_bus_deregister (struct usb_serial_driver *device);
 273
 274 extern struct usb_serial_driver usb_serial_generic_device;
 275 extern struct bus_type usb_serial_bus_type;
 276 extern struct tty_driver *usb_serial_tty_driver;
 277
 278 static inline void usb_serial_debug_data(int debug,
 279                                          struct device *dev,
 280                                          const char *function, int size,
 281                                          const unsigned char *data)
 282 {
 283         int i;
 284
 285         if (debug) {
 286                 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", function, size);
 287                 for (i = 0; i < size; ++i)
 288                         printk ("%.2x ", data[i]);
 289                 printk ("\n");
 290         }
 291 }
 292
 293 /* Use our own dbg macro */
 294 #undef dbg
 295 #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0)
 296
 297
 298
 299 #endif  /* ifdef __LINUX_USB_SERIAL_H */
 300