drivers/usb/serial/usb-serial.h

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