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  * @bulk_in_buffer: pointer to the bulk in buffer for this port.
  78  * @read_urb: pointer to the bulk in struct urb for this port.
  79  * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
  80  *      port.
  81  * @bulk_out_buffer: pointer to the bulk out buffer for this port.
  82  * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
  83  * @write_urb: pointer to the bulk out struct urb for this port.
  84  * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
  85  *      port.
  86  * @write_wait: a wait_queue_head_t used by the port.
  87  * @work: work queue entry for the line discipline waking up.
  88  * @open_count: number of times this port has been opened.
  89  *
  90  * This structure is used by the usb-serial core and drivers for the specific
  91  * ports of a device.
  92  */
  93 struct usb_serial_port {
  94         struct usb_serial *     serial;
  95         struct tty_struct *     tty;
  96         unsigned char           number;
  97
  98         unsigned char *         interrupt_in_buffer;
  99         struct urb *            interrupt_in_urb;
 100         __u8                    interrupt_in_endpointAddress;
 101
 102         unsigned char *         bulk_in_buffer;
 103         struct urb *            read_urb;
 104         __u8                    bulk_in_endpointAddress;
 105
 106         unsigned char *         bulk_out_buffer;
 107         int                     bulk_out_size;
 108         struct urb *            write_urb;
 109         __u8                    bulk_out_endpointAddress;
 110
 111         wait_queue_head_t       write_wait;
 112         struct work_struct      work;
 113         int                     open_count;
 114         struct device           dev;
 115 };
 116 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
 117
 118 /* get and set the port private data pointer helper functions */
 119 static inline void *usb_get_serial_port_data (struct usb_serial_port *port)
 120 {
 121         return dev_get_drvdata(&port->dev);
 122 }
 123
 124 static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data)
 125 {
 126         dev_set_drvdata(&port->dev, data);
 127 }
 128
 129 /**
 130  * usb_serial - structure used by the usb-serial core for a device
 131  * @dev: pointer to the struct usb_device for this device
 132  * @type: pointer to the struct usb_serial_device_type for this device
 133  * @interface: pointer to the struct usb_interface for this device
 134  * @minor: the starting minor number for this device
 135  * @num_ports: the number of ports this device has
 136  * @num_interrupt_in: number of interrupt in endpoints we have
 137  * @num_bulk_in: number of bulk in endpoints we have
 138  * @num_bulk_out: number of bulk out endpoints we have
 139  * @vendor: vendor id of this device
 140  * @product: product id of this device
 141  * @port: array of struct usb_serial_port structures for the different ports.
 142  * @private: place to put any driver specific information that is needed.  The
 143  *      usb-serial driver is required to manage this data, the usb-serial core
 144  *      will not touch this.  Use usb_get_serial_data() and
 145  *      usb_set_serial_data() to access this.
 146  */
 147 struct usb_serial {
 148         struct usb_device *             dev;
 149         struct usb_serial_device_type * type;
 150         struct usb_interface *          interface;
 151         unsigned char                   minor;
 152         unsigned char                   num_ports;
 153         unsigned char                   num_port_pointers;
 154         char                            num_interrupt_in;
 155         char                            num_bulk_in;
 156         char                            num_bulk_out;
 157         __u16                           vendor;
 158         __u16                           product;
 159         struct usb_serial_port *        port[MAX_NUM_PORTS];
 160         struct kref                     kref;
 161         void *                          private;
 162 };
 163 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
 164
 165 #define NUM_DONT_CARE   (-1)
 166
 167 /* get and set the serial private data pointer helper functions */
 168 static inline void *usb_get_serial_data (struct usb_serial *serial)
 169 {
 170         return serial->private;
 171 }
 172
 173 static inline void usb_set_serial_data (struct usb_serial *serial, void *data)
 174 {
 175         serial->private = data;
 176 }
 177
 178 /**
 179  * usb_serial_device_type - a structure that defines a usb serial device
 180  * @owner: pointer to the module that owns this device.
 181  * @name: pointer to a string that describes this device.  This string used
 182  *      in the syslog messages when a device is inserted or removed.
 183  * @short_name: a pointer to a string that describes this device in
 184  *      KOBJ_NAME_LEN characters or less.  This is used for the sysfs interface
 185  *      to describe the driver.
 186  * @id_table: pointer to a list of usb_device_id structures that define all
 187  *      of the devices this structure can support.
 188  * @num_interrupt_in: the number of interrupt in endpoints this device will
 189  *      have.
 190  * @num_bulk_in: the number of bulk in endpoints this device will have.
 191  * @num_bulk_out: the number of bulk out endpoints this device will have.
 192  * @num_ports: the number of different ports this device will have.
 193  * @calc_num_ports: pointer to a function to determine how many ports this
 194  *      device has dynamically.  It will be called after the probe()
 195  *      callback is called, but before attach()
 196  * @probe: pointer to the driver's probe function.
 197  *      This will be called when the device is inserted into the system,
 198  *      but before the device has been fully initialized by the usb_serial
 199  *      subsystem.  Use this function to download any firmware to the device,
 200  *      or any other early initialization that might be needed.
 201  *      Return 0 to continue on with the initialization sequence.  Anything
 202  *      else will abort it.
 203  * @attach: pointer to the driver's attach function.
 204  *      This will be called when the struct usb_serial structure is fully set
 205  *      set up.  Do any local initialization of the device, or any private
 206  *      memory structure allocation at this point in time.
 207  * @shutdown: pointer to the driver's shutdown function.  This will be
 208  *      called when the device is removed from the system.
 209  *
 210  * This structure is defines a USB Serial device.  It provides all of
 211  * the information that the USB serial core code needs.  If the function
 212  * pointers are defined, then the USB serial core code will call them when
 213  * the corresponding tty port functions are called.  If they are not
 214  * called, the generic serial function will be used instead.
 215  */
 216 struct usb_serial_device_type {
 217         struct module *owner;
 218         char    *name;
 219         char    *short_name;
 220         const struct usb_device_id *id_table;
 221         char    num_interrupt_in;
 222         char    num_bulk_in;
 223         char    num_bulk_out;
 224         char    num_ports;
 225
 226         struct list_head        driver_list;
 227         struct device_driver    driver;
 228
 229         int (*probe) (struct usb_serial *serial, const struct usb_device_id *id);
 230         int (*attach) (struct usb_serial *serial);
 231         int (*calc_num_ports) (struct usb_serial *serial);
 232
 233         void (*shutdown) (struct usb_serial *serial);
 234
 235         int (*port_probe) (struct usb_serial_port *port);
 236         int (*port_remove) (struct usb_serial_port *port);
 237
 238         /* serial function calls */
 239         int  (*open)            (struct usb_serial_port *port, struct file * filp);
 240         void (*close)           (struct usb_serial_port *port, struct file * filp);
 241         int  (*write)           (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
 242         int  (*write_room)      (struct usb_serial_port *port);
 243         int  (*ioctl)           (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
 244         void (*set_termios)     (struct usb_serial_port *port, struct termios * old);
 245         void (*break_ctl)       (struct usb_serial_port *port, int break_state);
 246         int  (*chars_in_buffer) (struct usb_serial_port *port);
 247         void (*throttle)        (struct usb_serial_port *port);
 248         void (*unthrottle)      (struct usb_serial_port *port);
 249         int  (*tiocmget)        (struct usb_serial_port *port, struct file *file);
 250         int  (*tiocmset)        (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
 251
 252         void (*read_int_callback)(struct urb *urb, struct pt_regs *regs);
 253         void (*read_bulk_callback)(struct urb *urb, struct pt_regs *regs);
 254         void (*write_bulk_callback)(struct urb *urb, struct pt_regs *regs);
 255 };
 256 #define to_usb_serial_driver(d) container_of(d, struct usb_serial_device_type, driver)
 257
 258 extern int  usb_serial_register(struct usb_serial_device_type *new_device);
 259 extern void usb_serial_deregister(struct usb_serial_device_type *device);
 260 extern void usb_serial_port_softint(void *private);
 261
 262 extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id);
 263 extern void usb_serial_disconnect(struct usb_interface *iface);
 264
 265 extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest);
 266 extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit);
 267
 268 /* USB Serial console functions */
 269 #ifdef CONFIG_USB_SERIAL_CONSOLE
 270 extern void usb_serial_console_init (int debug, int minor);
 271 extern void usb_serial_console_exit (void);
 272 #else
 273 static inline void usb_serial_console_init (int debug, int minor) { }
 274 static inline void usb_serial_console_exit (void) { }
 275 #endif
 276
 277 /* Functions needed by other parts of the usbserial core */
 278 extern struct usb_serial *usb_serial_get_by_index (unsigned int minor);
 279 extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp);
 280 extern int usb_serial_generic_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
 281 extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp);
 282 extern int usb_serial_generic_write_room (struct usb_serial_port *port);
 283 extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port);
 284 extern void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
 285 extern void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
 286 extern void usb_serial_generic_shutdown (struct usb_serial *serial);
 287 extern int usb_serial_generic_register (int debug);
 288 extern void usb_serial_generic_deregister (void);
 289
 290 extern int usb_serial_bus_register (struct usb_serial_device_type *device);
 291 extern void usb_serial_bus_deregister (struct usb_serial_device_type *device);
 292
 293 extern struct usb_serial_device_type usb_serial_generic_device;
 294 extern struct bus_type usb_serial_bus_type;
 295 extern struct tty_driver *usb_serial_tty_driver;
 296
 297 static inline void usb_serial_debug_data (const char *file, const char *function, int size, const unsigned char *data)
 298 {
 299         int i;
 300
 301         if (!debug)
 302                 return;
 303
 304         printk (KERN_DEBUG "%s: %s - length = %d, data = ", file, function, size);
 305         for (i = 0; i < size; ++i) {
 306                 printk ("%.2x ", data[i]);
 307         }
 308         printk ("\n");
 309 }
 310
 311
 312 /* Use our own dbg macro */
 313 #undef dbg
 314 #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0)
 315
 316
 317
 318 #endif  /* ifdef __LINUX_USB_SERIAL_H */
 319