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