drivers/usb/serial/usb-serial.h

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