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