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 #ifndef __LINUX_USB_SERIAL_H
  14 #define __LINUX_USB_SERIAL_H
  15
  16 #include <linux/kref.h>
  17 #include <linux/mutex.h>
  18 #include <linux/sysrq.h>
  19 #include <linux/kfifo.h>
  20
  21 #define SERIAL_TTY_MAJOR        188     /* Nice legal number now */
  22 #define SERIAL_TTY_MINORS       254     /* loads of devices :) */
  23 #define SERIAL_TTY_NO_MINOR     255     /* No minor was assigned */
  24
  25 /* The maximum number of ports one device can grab at once */
  26 #define MAX_NUM_PORTS           8
  27
  28 /* parity check flag */
  29 #define RELEVANT_IFLAG(iflag)   (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
  30
  31 enum port_dev_state {
  32         PORT_UNREGISTERED,
  33         PORT_REGISTERING,
  34         PORT_REGISTERED,
  35         PORT_UNREGISTERING,
  36 };
  37
  38 /* USB serial flags */
  39 #define USB_SERIAL_WRITE_BUSY   0
  40
  41 /**
  42  * usb_serial_port: structure for the specific ports of a device.
  43  * @serial: pointer back to the struct usb_serial owner of this port.
  44  * @port: pointer to the corresponding tty_port for this port.
  45  * @lock: spinlock to grab when updating portions of this structure.
  46  * @number: the number of the port (the minor number).
  47  * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
  48  * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
  49  * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
  50  *      for this port.
  51  * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
  52  * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
  53  * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
  54  * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
  55  *      for this port.
  56  * @bulk_in_buffer: pointer to the bulk in buffer for this port.
  57  * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
  58  * @read_urb: pointer to the bulk in struct urb for this port.
  59  * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
  60  *      port.
  61  * @bulk_in_buffers: pointers to the bulk in buffers for this port
  62  * @read_urbs: pointers to the bulk in urbs for this port
  63  * @read_urbs_free: status bitmap the for bulk in urbs
  64  * @bulk_out_buffer: pointer to the bulk out buffer for this port.
  65  * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
  66  * @write_urb: pointer to the bulk out struct urb for this port.
  67  * @write_fifo: kfifo used to buffer outgoing data
  68  * @bulk_out_buffers: pointers to the bulk out buffers for this port
  69  * @write_urbs: pointers to the bulk out urbs for this port
  70  * @write_urbs_free: status bitmap the for bulk out urbs
  71  * @tx_bytes: number of bytes currently in host stack queues
  72  * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
  73  *      port.
  74  * @flags: usb serial port flags
  75  * @write_wait: a wait_queue_head_t used by the port.
  76  * @work: work queue entry for the line discipline waking up.
  77  * @throttled: nonzero if the read urb is inactive to throttle the device
  78  * @throttle_req: nonzero if the tty wants to throttle us
  79  * @dev: pointer to the serial device
  80  *
  81  * This structure is used by the usb-serial core and drivers for the specific
  82  * ports of a device.
  83  */
  84 struct usb_serial_port {
  85         struct usb_serial       *serial;
  86         struct tty_port         port;
  87         spinlock_t              lock;
  88         unsigned char           number;
  89
  90         unsigned char           *interrupt_in_buffer;
  91         struct urb              *interrupt_in_urb;
  92         __u8                    interrupt_in_endpointAddress;
  93
  94         unsigned char           *interrupt_out_buffer;
  95         int                     interrupt_out_size;
  96         struct urb              *interrupt_out_urb;
  97         __u8                    interrupt_out_endpointAddress;
  98
  99         unsigned char           *bulk_in_buffer;
 100         int                     bulk_in_size;
 101         struct urb              *read_urb;
 102         __u8                    bulk_in_endpointAddress;
 103
 104         unsigned char           *bulk_in_buffers[2];
 105         struct urb              *read_urbs[2];
 106         unsigned long           read_urbs_free;
 107
 108         unsigned char           *bulk_out_buffer;
 109         int                     bulk_out_size;
 110         struct urb              *write_urb;
 111         struct kfifo            write_fifo;
 112
 113         unsigned char           *bulk_out_buffers[2];
 114         struct urb              *write_urbs[2];
 115         unsigned long           write_urbs_free;
 116         __u8                    bulk_out_endpointAddress;
 117
 118         int                     tx_bytes;
 119
 120         unsigned long           flags;
 121         wait_queue_head_t       write_wait;
 122         struct work_struct      work;
 123         char                    throttled;
 124         char                    throttle_req;
 125         unsigned long           sysrq; /* sysrq timeout */
 126         struct device           dev;
 127         enum port_dev_state     dev_state;
 128 };
 129 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
 130
 131 /* get and set the port private data pointer helper functions */
 132 static inline void *usb_get_serial_port_data(struct usb_serial_port *port)
 133 {
 134         return dev_get_drvdata(&port->dev);
 135 }
 136
 137 static inline void usb_set_serial_port_data(struct usb_serial_port *port,
 138                                             void *data)
 139 {
 140         dev_set_drvdata(&port->dev, data);
 141 }
 142
 143 /**
 144  * usb_serial - structure used by the usb-serial core for a device
 145  * @dev: pointer to the struct usb_device for this device
 146  * @type: pointer to the struct usb_serial_driver for this device
 147  * @interface: pointer to the struct usb_interface for this device
 148  * @minor: the starting minor number for this device
 149  * @num_ports: the number of ports this device has
 150  * @num_interrupt_in: number of interrupt in endpoints we have
 151  * @num_interrupt_out: number of interrupt out endpoints we have
 152  * @num_bulk_in: number of bulk in endpoints we have
 153  * @num_bulk_out: number of bulk out endpoints we have
 154  * @port: array of struct usb_serial_port structures for the different ports.
 155  * @private: place to put any driver specific information that is needed.  The
 156  *      usb-serial driver is required to manage this data, the usb-serial core
 157  *      will not touch this.  Use usb_get_serial_data() and
 158  *      usb_set_serial_data() to access this.
 159  */
 160 struct usb_serial {
 161         struct usb_device               *dev;
 162         struct usb_serial_driver        *type;
 163         struct usb_interface            *interface;
 164         unsigned char                   disconnected:1;
 165         unsigned char                   suspending:1;
 166         unsigned char                   attached:1;
 167         unsigned char                   minor;
 168         unsigned char                   num_ports;
 169         unsigned char                   num_port_pointers;
 170         char                            num_interrupt_in;
 171         char                            num_interrupt_out;
 172         char                            num_bulk_in;
 173         char                            num_bulk_out;
 174         struct usb_serial_port          *port[MAX_NUM_PORTS];
 175         struct kref                     kref;
 176         struct mutex                    disc_mutex;
 177         void                            *private;
 178 };
 179 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
 180
 181 /* get and set the serial private data pointer helper functions */
 182 static inline void *usb_get_serial_data(struct usb_serial *serial)
 183 {
 184         return serial->private;
 185 }
 186
 187 static inline void usb_set_serial_data(struct usb_serial *serial, void *data)
 188 {
 189         serial->private = data;
 190 }
 191
 192 /**
 193  * usb_serial_driver - describes a usb serial driver
 194  * @description: pointer to a string that describes this driver.  This string
 195  *      used in the syslog messages when a device is inserted or removed.
 196  * @id_table: pointer to a list of usb_device_id structures that define all
 197  *      of the devices this structure can support.
 198  * @num_ports: the number of different ports this device will have.
 199  * @bulk_in_size: minimum number of bytes to allocate for bulk-in buffer
 200  *      (0 = end-point size)
 201  * @bulk_out_size: bytes to allocate for bulk-out buffer (0 = end-point size)
 202  * @calc_num_ports: pointer to a function to determine how many ports this
 203  *      device has dynamically.  It will be called after the probe()
 204  *      callback is called, but before attach()
 205  * @probe: pointer to the driver's probe function.
 206  *      This will be called when the device is inserted into the system,
 207  *      but before the device has been fully initialized by the usb_serial
 208  *      subsystem.  Use this function to download any firmware to the device,
 209  *      or any other early initialization that might be needed.
 210  *      Return 0 to continue on with the initialization sequence.  Anything
 211  *      else will abort it.
 212  * @attach: pointer to the driver's attach function.
 213  *      This will be called when the struct usb_serial structure is fully set
 214  *      set up.  Do any local initialization of the device, or any private
 215  *      memory structure allocation at this point in time.
 216  * @disconnect: pointer to the driver's disconnect function.  This will be
 217  *      called when the device is unplugged or unbound from the driver.
 218  * @release: pointer to the driver's release function.  This will be called
 219  *      when the usb_serial data structure is about to be destroyed.
 220  * @usb_driver: pointer to the struct usb_driver that controls this
 221  *      device.  This is necessary to allow dynamic ids to be added to
 222  *      the driver from sysfs.
 223  *
 224  * This structure is defines a USB Serial driver.  It provides all of
 225  * the information that the USB serial core code needs.  If the function
 226  * pointers are defined, then the USB serial core code will call them when
 227  * the corresponding tty port functions are called.  If they are not
 228  * called, the generic serial function will be used instead.
 229  *
 230  * The driver.owner field should be set to the module owner of this driver.
 231  * The driver.name field should be set to the name of this driver (remember
 232  * it will show up in sysfs, so it needs to be short and to the point.
 233  * Using the module name is a good idea.)
 234  */
 235 struct usb_serial_driver {
 236         const char *description;
 237         const struct usb_device_id *id_table;
 238         char    num_ports;
 239
 240         struct list_head        driver_list;
 241         struct device_driver    driver;
 242         struct usb_driver       *usb_driver;
 243         struct usb_dynids       dynids;
 244
 245         size_t                  bulk_in_size;
 246         size_t                  bulk_out_size;
 247
 248         int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
 249         int (*attach)(struct usb_serial *serial);
 250         int (*calc_num_ports) (struct usb_serial *serial);
 251
 252         void (*disconnect)(struct usb_serial *serial);
 253         void (*release)(struct usb_serial *serial);
 254
 255         int (*port_probe)(struct usb_serial_port *port);
 256         int (*port_remove)(struct usb_serial_port *port);
 257
 258         int (*suspend)(struct usb_serial *serial, pm_message_t message);
 259         int (*resume)(struct usb_serial *serial);
 260
 261         /* serial function calls */
 262         /* Called by console and by the tty layer */
 263         int  (*open)(struct tty_struct *tty, struct usb_serial_port *port);
 264         void (*close)(struct usb_serial_port *port);
 265         int  (*write)(struct tty_struct *tty, struct usb_serial_port *port,
 266                         const unsigned char *buf, int count);
 267         /* Called only by the tty layer */
 268         int  (*write_room)(struct tty_struct *tty);
 269         int  (*ioctl)(struct tty_struct *tty,
 270                       unsigned int cmd, unsigned long arg);
 271         void (*set_termios)(struct tty_struct *tty,
 272                         struct usb_serial_port *port, struct ktermios *old);
 273         void (*break_ctl)(struct tty_struct *tty, int break_state);
 274         int  (*chars_in_buffer)(struct tty_struct *tty);
 275         void (*throttle)(struct tty_struct *tty);
 276         void (*unthrottle)(struct tty_struct *tty);
 277         int  (*tiocmget)(struct tty_struct *tty);
 278         int  (*tiocmset)(struct tty_struct *tty,
 279                          unsigned int set, unsigned int clear);
 280         int  (*get_icount)(struct tty_struct *tty,
 281                         struct serial_icounter_struct *icount);
 282         /* Called by the tty layer for port level work. There may or may not
 283            be an attached tty at this point */
 284         void (*dtr_rts)(struct usb_serial_port *port, int on);
 285         int  (*carrier_raised)(struct usb_serial_port *port);
 286         /* Called by the usb serial hooks to allow the user to rework the
 287            termios state */
 288         void (*init_termios)(struct tty_struct *tty);
 289         /* USB events */
 290         void (*read_int_callback)(struct urb *urb);
 291         void (*write_int_callback)(struct urb *urb);
 292         void (*read_bulk_callback)(struct urb *urb);
 293         void (*write_bulk_callback)(struct urb *urb);
 294         /* Called by the generic read bulk callback */
 295         void (*process_read_urb)(struct urb *urb);
 296         /* Called by the generic write implementation */
 297         int (*prepare_write_buffer)(struct usb_serial_port *port,
 298                                                 void *dest, size_t size);
 299 };
 300 #define to_usb_serial_driver(d) \
 301         container_of(d, struct usb_serial_driver, driver)
 302
 303 extern int usb_serial_register_drivers(struct usb_driver *udriver,
 304                 struct usb_serial_driver * const serial_drivers[]);
 305 extern void usb_serial_deregister_drivers(struct usb_driver *udriver,
 306                 struct usb_serial_driver * const serial_drivers[]);
 307 extern void usb_serial_port_softint(struct usb_serial_port *port);
 308
 309 extern int usb_serial_probe(struct usb_interface *iface,
 310                             const struct usb_device_id *id);
 311 extern void usb_serial_disconnect(struct usb_interface *iface);
 312
 313 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
 314 extern int usb_serial_resume(struct usb_interface *intf);
 315
 316 extern int ezusb_writememory(struct usb_serial *serial, int address,
 317                              unsigned char *data, int length, __u8 bRequest);
 318 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
 319
 320 /* USB Serial console functions */
 321 #ifdef CONFIG_USB_SERIAL_CONSOLE
 322 extern void usb_serial_console_init(int debug, int minor);
 323 extern void usb_serial_console_exit(void);
 324 extern void usb_serial_console_disconnect(struct usb_serial *serial);
 325 #else
 326 static inline void usb_serial_console_init(int debug, int minor) { }
 327 static inline void usb_serial_console_exit(void) { }
 328 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
 329 #endif
 330
 331 /* Functions needed by other parts of the usbserial core */
 332 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
 333 extern void usb_serial_put(struct usb_serial *serial);
 334 extern int usb_serial_generic_open(struct tty_struct *tty,
 335         struct usb_serial_port *port);
 336 extern int usb_serial_generic_write(struct tty_struct *tty,
 337         struct usb_serial_port *port, const unsigned char *buf, int count);
 338 extern void usb_serial_generic_close(struct usb_serial_port *port);
 339 extern int usb_serial_generic_resume(struct usb_serial *serial);
 340 extern int usb_serial_generic_write_room(struct tty_struct *tty);
 341 extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
 342 extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
 343 extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
 344 extern void usb_serial_generic_throttle(struct tty_struct *tty);
 345 extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
 346 extern void usb_serial_generic_disconnect(struct usb_serial *serial);
 347 extern void usb_serial_generic_release(struct usb_serial *serial);
 348 extern int usb_serial_generic_register(int debug);
 349 extern void usb_serial_generic_deregister(void);
 350 extern int usb_serial_generic_submit_read_urbs(struct usb_serial_port *port,
 351                                                  gfp_t mem_flags);
 352 extern void usb_serial_generic_process_read_urb(struct urb *urb);
 353 extern int usb_serial_generic_prepare_write_buffer(struct usb_serial_port *port,
 354                                                 void *dest, size_t size);
 355 extern int usb_serial_handle_sysrq_char(struct usb_serial_port *port,
 356                                         unsigned int ch);
 357 extern int usb_serial_handle_break(struct usb_serial_port *port);
 358 extern void usb_serial_handle_dcd_change(struct usb_serial_port *usb_port,
 359                                          struct tty_struct *tty,
 360                                          unsigned int status);
 361
 362
 363 extern int usb_serial_bus_register(struct usb_serial_driver *device);
 364 extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
 365
 366 extern struct usb_serial_driver usb_serial_generic_device;
 367 extern struct bus_type usb_serial_bus_type;
 368 extern struct tty_driver *usb_serial_tty_driver;
 369
 370 static inline void usb_serial_debug_data(int debug,
 371                                          struct device *dev,
 372                                          const char *function, int size,
 373                                          const unsigned char *data)
 374 {
 375         int i;
 376
 377         if (debug) {
 378                 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
 379                            function, size);
 380                 for (i = 0; i < size; ++i)
 381                         printk("%.2x ", data[i]);
 382                 printk("\n");
 383         }
 384 }
 385
 386 /* Use our own dbg macro */
 387 #undef dbg
 388 #define dbg(format, arg...)                                             \
 389 do {                                                                    \
 390         if (debug)                                                      \
 391                 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
 392 } while (0)
 393
 394 /*
 395  * Macro for reporting errors in write path to avoid inifinite loop
 396  * when port is used as a console.
 397  */
 398 #define dev_err_console(usport, fmt, ...)                               \
 399 do {                                                                    \
 400         static bool __print_once;                                       \
 401         struct usb_serial_port *__port = (usport);                      \
 402                                                                         \
 403         if (!__port->port.console || !__print_once) {                   \
 404                 __print_once = true;                                    \
 405                 dev_err(&__port->dev, fmt, ##__VA_ARGS__);              \
 406         }                                                               \
 407 } while (0)
 408
 409 /*
 410  * module_usb_serial_driver() - Helper macro for registering a USB Serial driver
 411  * @__usb_driver: usb_driver struct to register
 412  * @__serial_drivers: list of usb_serial drivers to register
 413  *
 414  * Helper macro for USB serial drivers which do not do anything special
 415  * in module init/exit. This eliminates a lot of boilerplate. Each
 416  * module may only use this macro once, and calling it replaces
 417  * module_init() and module_exit()
 418  *
 419  */
 420 #define module_usb_serial_driver(__usb_driver, __serial_drivers)        \
 421         module_driver(__usb_driver, usb_serial_register_drivers,        \
 422                        usb_serial_deregister_drivers, __serial_drivers)
 423
 424 #endif /* __LINUX_USB_SERIAL_H */
 425