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 /**
  39  * usb_serial_port: structure for the specific ports of a device.
  40  * @serial: pointer back to the struct usb_serial owner of this port.
  41  * @port: pointer to the corresponding tty_port for this port.
  42  * @lock: spinlock to grab when updating portions of this structure.
  43  * @number: the number of the port (the minor number).
  44  * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
  45  * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
  46  * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
  47  *      for this port.
  48  * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
  49  * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
  50  * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
  51  * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
  52  *      for this port.
  53  * @bulk_in_buffer: pointer to the bulk in buffer for this port.
  54  * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
  55  * @read_urb: pointer to the bulk in struct urb for this port.
  56  * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
  57  *      port.
  58  * @bulk_out_buffer: pointer to the bulk out buffer for this port.
  59  * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
  60  * @write_urb: pointer to the bulk out struct urb for this port.
  61  * @write_fifo: kfifo used to buffer outgoing data
  62  * @write_urb_busy: port`s writing status
  63  * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
  64  *      port.
  65  * @write_wait: a wait_queue_head_t used by the port.
  66  * @work: work queue entry for the line discipline waking up.
  67  * @throttled: nonzero if the read urb is inactive to throttle the device
  68  * @throttle_req: nonzero if the tty wants to throttle us
  69  * @dev: pointer to the serial device
  70  *
  71  * This structure is used by the usb-serial core and drivers for the specific
  72  * ports of a device.
  73  */
  74 struct usb_serial_port {
  75         struct usb_serial       *serial;
  76         struct tty_port         port;
  77         spinlock_t              lock;
  78         unsigned char           number;
  79
  80         unsigned char           *interrupt_in_buffer;
  81         struct urb              *interrupt_in_urb;
  82         __u8                    interrupt_in_endpointAddress;
  83
  84         unsigned char           *interrupt_out_buffer;
  85         int                     interrupt_out_size;
  86         struct urb              *interrupt_out_urb;
  87         __u8                    interrupt_out_endpointAddress;
  88
  89         unsigned char           *bulk_in_buffer;
  90         int                     bulk_in_size;
  91         struct urb              *read_urb;
  92         __u8                    bulk_in_endpointAddress;
  93
  94         unsigned char           *bulk_out_buffer;
  95         int                     bulk_out_size;
  96         struct urb              *write_urb;
  97         struct kfifo            write_fifo;
  98         int                     write_urb_busy;
  99         __u8                    bulk_out_endpointAddress;
 100
 101         int                     tx_bytes_flight;
 102         int                     urbs_in_flight;
 103
 104         wait_queue_head_t       write_wait;
 105         struct work_struct      work;
 106         char                    throttled;
 107         char                    throttle_req;
 108         unsigned long           sysrq; /* sysrq timeout */
 109         struct device           dev;
 110         enum port_dev_state     dev_state;
 111 };
 112 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
 113
 114 /* get and set the port private data pointer helper functions */
 115 static inline void *usb_get_serial_port_data(struct usb_serial_port *port)
 116 {
 117         return dev_get_drvdata(&port->dev);
 118 }
 119
 120 static inline void usb_set_serial_port_data(struct usb_serial_port *port,
 121                                             void *data)
 122 {
 123         dev_set_drvdata(&port->dev, data);
 124 }
 125
 126 /**
 127  * usb_serial - structure used by the usb-serial core for a device
 128  * @dev: pointer to the struct usb_device for this device
 129  * @type: pointer to the struct usb_serial_driver for this device
 130  * @interface: pointer to the struct usb_interface for this device
 131  * @minor: the starting minor number for this device
 132  * @num_ports: the number of ports this device has
 133  * @num_interrupt_in: number of interrupt in endpoints we have
 134  * @num_interrupt_out: number of interrupt out endpoints we have
 135  * @num_bulk_in: number of bulk in endpoints we have
 136  * @num_bulk_out: number of bulk out endpoints we have
 137  * @port: array of struct usb_serial_port structures for the different ports.
 138  * @private: place to put any driver specific information that is needed.  The
 139  *      usb-serial driver is required to manage this data, the usb-serial core
 140  *      will not touch this.  Use usb_get_serial_data() and
 141  *      usb_set_serial_data() to access this.
 142  */
 143 struct usb_serial {
 144         struct usb_device               *dev;
 145         struct usb_serial_driver        *type;
 146         struct usb_interface            *interface;
 147         unsigned char                   disconnected:1;
 148         unsigned char                   suspending:1;
 149         unsigned char                   attached:1;
 150         unsigned char                   minor;
 151         unsigned char                   num_ports;
 152         unsigned char                   num_port_pointers;
 153         char                            num_interrupt_in;
 154         char                            num_interrupt_out;
 155         char                            num_bulk_in;
 156         char                            num_bulk_out;
 157         struct usb_serial_port          *port[MAX_NUM_PORTS];
 158         struct kref                     kref;
 159         struct mutex                    disc_mutex;
 160         void                            *private;
 161 };
 162 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
 163
 164 /* get and set the serial private data pointer helper functions */
 165 static inline void *usb_get_serial_data(struct usb_serial *serial)
 166 {
 167         return serial->private;
 168 }
 169
 170 static inline void usb_set_serial_data(struct usb_serial *serial, void *data)
 171 {
 172         serial->private = data;
 173 }
 174
 175 /**
 176  * usb_serial_driver - describes a usb serial driver
 177  * @description: pointer to a string that describes this driver.  This string
 178  *      used in the syslog messages when a device is inserted or removed.
 179  * @id_table: pointer to a list of usb_device_id structures that define all
 180  *      of the devices this structure can support.
 181  * @num_ports: the number of different ports this device will have.
 182  * @calc_num_ports: pointer to a function to determine how many ports this
 183  *      device has dynamically.  It will be called after the probe()
 184  *      callback is called, but before attach()
 185  * @probe: pointer to the driver's probe function.
 186  *      This will be called when the device is inserted into the system,
 187  *      but before the device has been fully initialized by the usb_serial
 188  *      subsystem.  Use this function to download any firmware to the device,
 189  *      or any other early initialization that might be needed.
 190  *      Return 0 to continue on with the initialization sequence.  Anything
 191  *      else will abort it.
 192  * @attach: pointer to the driver's attach function.
 193  *      This will be called when the struct usb_serial structure is fully set
 194  *      set up.  Do any local initialization of the device, or any private
 195  *      memory structure allocation at this point in time.
 196  * @disconnect: pointer to the driver's disconnect function.  This will be
 197  *      called when the device is unplugged or unbound from the driver.
 198  * @release: pointer to the driver's release function.  This will be called
 199  *      when the usb_serial data structure is about to be destroyed.
 200  * @usb_driver: pointer to the struct usb_driver that controls this
 201  *      device.  This is necessary to allow dynamic ids to be added to
 202  *      the driver from sysfs.
 203  *
 204  * This structure is defines a USB Serial driver.  It provides all of
 205  * the information that the USB serial core code needs.  If the function
 206  * pointers are defined, then the USB serial core code will call them when
 207  * the corresponding tty port functions are called.  If they are not
 208  * called, the generic serial function will be used instead.
 209  *
 210  * The driver.owner field should be set to the module owner of this driver.
 211  * The driver.name field should be set to the name of this driver (remember
 212  * it will show up in sysfs, so it needs to be short and to the point.
 213  * Using the module name is a good idea.)
 214  */
 215 struct usb_serial_driver {
 216         const char *description;
 217         const struct usb_device_id *id_table;
 218         char    num_ports;
 219
 220         struct list_head        driver_list;
 221         struct device_driver    driver;
 222         struct usb_driver       *usb_driver;
 223         struct usb_dynids       dynids;
 224         int                     max_in_flight_urbs;
 225
 226         int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
 227         int (*attach)(struct usb_serial *serial);
 228         int (*calc_num_ports) (struct usb_serial *serial);
 229
 230         void (*disconnect)(struct usb_serial *serial);
 231         void (*release)(struct usb_serial *serial);
 232
 233         int (*port_probe)(struct usb_serial_port *port);
 234         int (*port_remove)(struct usb_serial_port *port);
 235
 236         int (*suspend)(struct usb_serial *serial, pm_message_t message);
 237         int (*resume)(struct usb_serial *serial);
 238
 239         /* serial function calls */
 240         /* Called by console and by the tty layer */
 241         int  (*open)(struct tty_struct *tty, struct usb_serial_port *port);
 242         void (*close)(struct usb_serial_port *port);
 243         int  (*write)(struct tty_struct *tty, struct usb_serial_port *port,
 244                         const unsigned char *buf, int count);
 245         /* Called only by the tty layer */
 246         int  (*write_room)(struct tty_struct *tty);
 247         int  (*ioctl)(struct tty_struct *tty, struct file *file,
 248                       unsigned int cmd, unsigned long arg);
 249         void (*set_termios)(struct tty_struct *tty,
 250                         struct usb_serial_port *port, struct ktermios *old);
 251         void (*break_ctl)(struct tty_struct *tty, int break_state);
 252         int  (*chars_in_buffer)(struct tty_struct *tty);
 253         void (*throttle)(struct tty_struct *tty);
 254         void (*unthrottle)(struct tty_struct *tty);
 255         int  (*tiocmget)(struct tty_struct *tty, struct file *file);
 256         int  (*tiocmset)(struct tty_struct *tty, struct file *file,
 257                          unsigned int set, unsigned int clear);
 258         /* Called by the tty layer for port level work. There may or may not
 259            be an attached tty at this point */
 260         void (*dtr_rts)(struct usb_serial_port *port, int on);
 261         int  (*carrier_raised)(struct usb_serial_port *port);
 262         /* Called by the usb serial hooks to allow the user to rework the
 263            termios state */
 264         void (*init_termios)(struct tty_struct *tty);
 265         /* USB events */
 266         void (*read_int_callback)(struct urb *urb);
 267         void (*write_int_callback)(struct urb *urb);
 268         void (*read_bulk_callback)(struct urb *urb);
 269         void (*write_bulk_callback)(struct urb *urb);
 270 };
 271 #define to_usb_serial_driver(d) \
 272         container_of(d, struct usb_serial_driver, driver)
 273
 274 extern int  usb_serial_register(struct usb_serial_driver *driver);
 275 extern void usb_serial_deregister(struct usb_serial_driver *driver);
 276 extern void usb_serial_port_softint(struct usb_serial_port *port);
 277
 278 extern int usb_serial_probe(struct usb_interface *iface,
 279                             const struct usb_device_id *id);
 280 extern void usb_serial_disconnect(struct usb_interface *iface);
 281
 282 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
 283 extern int usb_serial_resume(struct usb_interface *intf);
 284
 285 extern int ezusb_writememory(struct usb_serial *serial, int address,
 286                              unsigned char *data, int length, __u8 bRequest);
 287 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
 288
 289 /* USB Serial console functions */
 290 #ifdef CONFIG_USB_SERIAL_CONSOLE
 291 extern void usb_serial_console_init(int debug, int minor);
 292 extern void usb_serial_console_exit(void);
 293 extern void usb_serial_console_disconnect(struct usb_serial *serial);
 294 #else
 295 static inline void usb_serial_console_init(int debug, int minor) { }
 296 static inline void usb_serial_console_exit(void) { }
 297 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
 298 #endif
 299
 300 /* Functions needed by other parts of the usbserial core */
 301 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
 302 extern void usb_serial_put(struct usb_serial *serial);
 303 extern int usb_serial_generic_open(struct tty_struct *tty,
 304         struct usb_serial_port *port);
 305 extern int usb_serial_generic_write(struct tty_struct *tty,
 306         struct usb_serial_port *port, const unsigned char *buf, int count);
 307 extern void usb_serial_generic_close(struct usb_serial_port *port);
 308 extern int usb_serial_generic_resume(struct usb_serial *serial);
 309 extern int usb_serial_generic_write_room(struct tty_struct *tty);
 310 extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
 311 extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
 312 extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
 313 extern void usb_serial_generic_throttle(struct tty_struct *tty);
 314 extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
 315 extern void usb_serial_generic_disconnect(struct usb_serial *serial);
 316 extern void usb_serial_generic_release(struct usb_serial *serial);
 317 extern int usb_serial_generic_register(int debug);
 318 extern void usb_serial_generic_deregister(void);
 319 extern void usb_serial_generic_resubmit_read_urb(struct usb_serial_port *port,
 320                                                  gfp_t mem_flags);
 321 extern int usb_serial_handle_sysrq_char(struct tty_struct *tty,
 322                                         struct usb_serial_port *port,
 323                                         unsigned int ch);
 324 extern int usb_serial_handle_break(struct usb_serial_port *port);
 325
 326
 327 extern int usb_serial_bus_register(struct usb_serial_driver *device);
 328 extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
 329
 330 extern struct usb_serial_driver usb_serial_generic_device;
 331 extern struct bus_type usb_serial_bus_type;
 332 extern struct tty_driver *usb_serial_tty_driver;
 333
 334 static inline void usb_serial_debug_data(int debug,
 335                                          struct device *dev,
 336                                          const char *function, int size,
 337                                          const unsigned char *data)
 338 {
 339         int i;
 340
 341         if (debug) {
 342                 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
 343                            function, size);
 344                 for (i = 0; i < size; ++i)
 345                         printk("%.2x ", data[i]);
 346                 printk("\n");
 347         }
 348 }
 349
 350 /* Use our own dbg macro */
 351 #undef dbg
 352 #define dbg(format, arg...)                                             \
 353 do {                                                                    \
 354         if (debug)                                                      \
 355                 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
 356 } while (0)
 357
 358 #endif /* __LINUX_USB_SERIAL_H */
 359