include/linux/usb/serial.h

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