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