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