Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Greg Kroah-Hartman | a969888 | 2006-07-11 21:22:58 -0700 | [diff] [blame] | 2 | * USB Serial Converter stuff |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | * |
Greg Kroah-Hartman | 502b95c | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 4 | * Copyright (C) 1999 - 2005 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Greg Kroah-Hartman | a969888 | 2006-07-11 21:22:58 -0700 | [diff] [blame] | 9 | * the Free Software Foundation; version 2 of the License. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | */ |
| 12 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | #ifndef __LINUX_USB_SERIAL_H |
| 14 | #define __LINUX_USB_SERIAL_H |
| 15 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <linux/kref.h> |
Luiz Fernando Capitulino | 1ce7dd2 | 2006-03-24 17:12:31 -0300 | [diff] [blame] | 17 | #include <linux/mutex.h> |
Jason Wessel | 98fcb5f | 2009-05-11 15:24:09 -0500 | [diff] [blame] | 18 | #include <linux/sysrq.h> |
Stefani Seibold | 119eecc | 2009-12-23 09:10:48 +0100 | [diff] [blame] | 19 | #include <linux/kfifo.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
| 21 | #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ |
Alan Stern | 0282b7f | 2008-07-29 12:01:04 -0400 | [diff] [blame] | 22 | #define SERIAL_TTY_MINORS 254 /* loads of devices :) */ |
| 23 | #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 25 | /* The maximum number of ports one device can grab at once */ |
| 26 | #define MAX_NUM_PORTS 8 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | |
| 28 | /* parity check flag */ |
| 29 | #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK)) |
| 30 | |
Alan Stern | c706ebd | 2009-06-02 11:54:11 -0400 | [diff] [blame] | 31 | enum port_dev_state { |
| 32 | PORT_UNREGISTERED, |
| 33 | PORT_REGISTERING, |
| 34 | PORT_REGISTERED, |
| 35 | PORT_UNREGISTERING, |
| 36 | }; |
| 37 | |
Johan Hovold | 27c7acf | 2010-05-05 23:57:37 +0200 | [diff] [blame] | 38 | /* USB serial flags */ |
| 39 | #define USB_SERIAL_WRITE_BUSY 0 |
| 40 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. |
Leandro Dorileo | 78c5b82 | 2009-04-14 14:59:51 +0100 | [diff] [blame] | 44 | * @port: pointer to the corresponding tty_port for this port. |
Greg Kroah-Hartman | 507ca9b | 2005-04-23 12:49:16 -0700 | [diff] [blame] | 45 | * @lock: spinlock to grab when updating portions of this structure. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 55 | * for this port. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | * @bulk_in_buffer: pointer to the bulk in buffer for this port. |
Leandro Dorileo | 78c5b82 | 2009-04-14 14:59:51 +0100 | [diff] [blame] | 57 | * @bulk_in_size: the size of the bulk_in_buffer, in bytes. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. |
David VomLehn | 8e8dce0 | 2009-08-28 12:54:27 -0700 | [diff] [blame] | 64 | * @write_fifo: kfifo used to buffer outgoing data |
Leandro Dorileo | 78c5b82 | 2009-04-14 14:59:51 +0100 | [diff] [blame] | 65 | * @write_urb_busy: port`s writing status |
Johan Hovold | 27c7acf | 2010-05-05 23:57:37 +0200 | [diff] [blame] | 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 |
Johan Hovold | 25d514c | 2010-03-17 23:06:07 +0100 | [diff] [blame] | 69 | * @tx_bytes: number of bytes currently in host stack queues |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 70 | * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this |
| 71 | * port. |
Johan Hovold | 27c7acf | 2010-05-05 23:57:37 +0200 | [diff] [blame] | 72 | * @flags: usb serial port flags |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | * @write_wait: a wait_queue_head_t used by the port. |
| 74 | * @work: work queue entry for the line discipline waking up. |
Joris van Rantwijk | 253ca92 | 2007-02-01 20:08:18 +0100 | [diff] [blame] | 75 | * @throttled: nonzero if the read urb is inactive to throttle the device |
| 76 | * @throttle_req: nonzero if the tty wants to throttle us |
Leandro Dorileo | 78c5b82 | 2009-04-14 14:59:51 +0100 | [diff] [blame] | 77 | * @dev: pointer to the serial device |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 78 | * |
| 79 | * This structure is used by the usb-serial core and drivers for the specific |
| 80 | * ports of a device. |
| 81 | */ |
| 82 | struct usb_serial_port { |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 83 | struct usb_serial *serial; |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 84 | struct tty_port port; |
Greg Kroah-Hartman | 507ca9b | 2005-04-23 12:49:16 -0700 | [diff] [blame] | 85 | spinlock_t lock; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | unsigned char number; |
| 87 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 88 | unsigned char *interrupt_in_buffer; |
| 89 | struct urb *interrupt_in_urb; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | __u8 interrupt_in_endpointAddress; |
| 91 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 92 | unsigned char *interrupt_out_buffer; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | int interrupt_out_size; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 94 | struct urb *interrupt_out_urb; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | __u8 interrupt_out_endpointAddress; |
| 96 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 97 | unsigned char *bulk_in_buffer; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | int bulk_in_size; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 99 | struct urb *read_urb; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | __u8 bulk_in_endpointAddress; |
| 101 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 102 | unsigned char *bulk_out_buffer; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | int bulk_out_size; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 104 | struct urb *write_urb; |
Stefani Seibold | 119eecc | 2009-12-23 09:10:48 +0100 | [diff] [blame] | 105 | struct kfifo write_fifo; |
Greg Kroah-Hartman | 507ca9b | 2005-04-23 12:49:16 -0700 | [diff] [blame] | 106 | int write_urb_busy; |
Johan Hovold | 27c7acf | 2010-05-05 23:57:37 +0200 | [diff] [blame] | 107 | |
| 108 | unsigned char *bulk_out_buffers[2]; |
| 109 | struct urb *write_urbs[2]; |
| 110 | unsigned long write_urbs_free; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | __u8 bulk_out_endpointAddress; |
| 112 | |
Johan Hovold | 25d514c | 2010-03-17 23:06:07 +0100 | [diff] [blame] | 113 | int tx_bytes; |
Jason Wessel | 715b1dc | 2009-05-11 15:24:07 -0500 | [diff] [blame] | 114 | |
Johan Hovold | 27c7acf | 2010-05-05 23:57:37 +0200 | [diff] [blame] | 115 | unsigned long flags; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | wait_queue_head_t write_wait; |
| 117 | struct work_struct work; |
Joris van Rantwijk | 253ca92 | 2007-02-01 20:08:18 +0100 | [diff] [blame] | 118 | char throttled; |
| 119 | char throttle_req; |
Jason Wessel | 98fcb5f | 2009-05-11 15:24:09 -0500 | [diff] [blame] | 120 | unsigned long sysrq; /* sysrq timeout */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | struct device dev; |
Alan Stern | c706ebd | 2009-06-02 11:54:11 -0400 | [diff] [blame] | 122 | enum port_dev_state dev_state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 */ |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 127 | static inline void *usb_get_serial_port_data(struct usb_serial_port *port) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | { |
| 129 | return dev_get_drvdata(&port->dev); |
| 130 | } |
| 131 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 132 | static inline void usb_set_serial_port_data(struct usb_serial_port *port, |
| 133 | void *data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 141 | * @type: pointer to the struct usb_serial_driver for this device |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 { |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 156 | struct usb_device *dev; |
| 157 | struct usb_serial_driver *type; |
| 158 | struct usb_interface *interface; |
Oliver Neukum | f8bece8 | 2009-02-05 16:54:25 +0100 | [diff] [blame] | 159 | unsigned char disconnected:1; |
| 160 | unsigned char suspending:1; |
Alan Stern | a4720c6 | 2009-10-09 12:43:12 -0400 | [diff] [blame] | 161 | unsigned char attached:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 169 | struct usb_serial_port *port[MAX_NUM_PORTS]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | struct kref kref; |
Oliver Neukum | a1cd7e9 | 2008-01-16 17:18:52 +0100 | [diff] [blame] | 171 | struct mutex disc_mutex; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 172 | void *private; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | }; |
| 174 | #define to_usb_serial(d) container_of(d, struct usb_serial, kref) |
| 175 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | /* get and set the serial private data pointer helper functions */ |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 177 | static inline void *usb_get_serial_data(struct usb_serial *serial) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | { |
| 179 | return serial->private; |
| 180 | } |
| 181 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 182 | static inline void usb_set_serial_data(struct usb_serial *serial, void *data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | { |
| 184 | serial->private = data; |
| 185 | } |
| 186 | |
| 187 | /** |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 188 | * usb_serial_driver - describes a usb serial driver |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 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. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | * @id_table: pointer to a list of usb_device_id structures that define all |
| 192 | * of the devices this structure can support. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | * @num_ports: the number of different ports this device will have. |
Johan Hovold | bbcb2b9 | 2010-03-17 23:00:37 +0100 | [diff] [blame] | 194 | * @bulk_in_size: bytes to allocate for bulk-in buffer (0 = end-point size) |
| 195 | * @bulk_out_size: bytes to allocate for bulk-out buffer (0 = end-point size) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | * @calc_num_ports: pointer to a function to determine how many ports this |
| 197 | * device has dynamically. It will be called after the probe() |
| 198 | * callback is called, but before attach() |
| 199 | * @probe: pointer to the driver's probe function. |
| 200 | * This will be called when the device is inserted into the system, |
| 201 | * but before the device has been fully initialized by the usb_serial |
| 202 | * subsystem. Use this function to download any firmware to the device, |
| 203 | * or any other early initialization that might be needed. |
Greg Kroah-Hartman | a969888 | 2006-07-11 21:22:58 -0700 | [diff] [blame] | 204 | * Return 0 to continue on with the initialization sequence. Anything |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 205 | * else will abort it. |
| 206 | * @attach: pointer to the driver's attach function. |
| 207 | * This will be called when the struct usb_serial structure is fully set |
| 208 | * set up. Do any local initialization of the device, or any private |
| 209 | * memory structure allocation at this point in time. |
Alan Stern | f9c99bb | 2009-06-02 11:53:55 -0400 | [diff] [blame] | 210 | * @disconnect: pointer to the driver's disconnect function. This will be |
| 211 | * called when the device is unplugged or unbound from the driver. |
| 212 | * @release: pointer to the driver's release function. This will be called |
| 213 | * when the usb_serial data structure is about to be destroyed. |
Greg Kroah-Hartman | 93bacef | 2006-12-17 21:50:23 +0100 | [diff] [blame] | 214 | * @usb_driver: pointer to the struct usb_driver that controls this |
| 215 | * device. This is necessary to allow dynamic ids to be added to |
| 216 | * the driver from sysfs. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | * |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 218 | * This structure is defines a USB Serial driver. It provides all of |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | * the information that the USB serial core code needs. If the function |
| 220 | * pointers are defined, then the USB serial core code will call them when |
| 221 | * the corresponding tty port functions are called. If they are not |
| 222 | * called, the generic serial function will be used instead. |
Greg Kroah-Hartman | 18fcac3 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 223 | * |
| 224 | * The driver.owner field should be set to the module owner of this driver. |
Greg Kroah-Hartman | 269bda1 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 225 | * The driver.name field should be set to the name of this driver (remember |
| 226 | * it will show up in sysfs, so it needs to be short and to the point. |
Geoff Levand | 0b14c38 | 2008-09-20 14:41:47 -0700 | [diff] [blame] | 227 | * Using the module name is a good idea.) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | */ |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 229 | struct usb_serial_driver { |
Greg Kroah-Hartman | 269bda1 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 230 | const char *description; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 231 | const struct usb_device_id *id_table; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | char num_ports; |
| 233 | |
| 234 | struct list_head driver_list; |
| 235 | struct device_driver driver; |
Greg Kroah-Hartman | 93bacef | 2006-12-17 21:50:23 +0100 | [diff] [blame] | 236 | struct usb_driver *usb_driver; |
| 237 | struct usb_dynids dynids; |
Johan Hovold | 25d514c | 2010-03-17 23:06:07 +0100 | [diff] [blame] | 238 | |
Johan Hovold | bbcb2b9 | 2010-03-17 23:00:37 +0100 | [diff] [blame] | 239 | size_t bulk_in_size; |
| 240 | size_t bulk_out_size; |
| 241 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 242 | int (*probe)(struct usb_serial *serial, const struct usb_device_id *id); |
| 243 | int (*attach)(struct usb_serial *serial); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | int (*calc_num_ports) (struct usb_serial *serial); |
| 245 | |
Alan Stern | f9c99bb | 2009-06-02 11:53:55 -0400 | [diff] [blame] | 246 | void (*disconnect)(struct usb_serial *serial); |
| 247 | void (*release)(struct usb_serial *serial); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 248 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 249 | int (*port_probe)(struct usb_serial_port *port); |
| 250 | int (*port_remove)(struct usb_serial_port *port); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 251 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 252 | int (*suspend)(struct usb_serial *serial, pm_message_t message); |
| 253 | int (*resume)(struct usb_serial *serial); |
Oliver Neukum | ec22559 | 2007-04-27 20:54:57 +0200 | [diff] [blame] | 254 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 255 | /* serial function calls */ |
Alan Cox | a509a7e | 2009-09-19 13:13:26 -0700 | [diff] [blame] | 256 | /* Called by console and by the tty layer */ |
| 257 | int (*open)(struct tty_struct *tty, struct usb_serial_port *port); |
Alan Cox | 335f851 | 2009-06-11 12:26:29 +0100 | [diff] [blame] | 258 | void (*close)(struct usb_serial_port *port); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 259 | int (*write)(struct tty_struct *tty, struct usb_serial_port *port, |
| 260 | const unsigned char *buf, int count); |
| 261 | /* Called only by the tty layer */ |
| 262 | int (*write_room)(struct tty_struct *tty); |
| 263 | int (*ioctl)(struct tty_struct *tty, struct file *file, |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 264 | unsigned int cmd, unsigned long arg); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 265 | void (*set_termios)(struct tty_struct *tty, |
| 266 | struct usb_serial_port *port, struct ktermios *old); |
| 267 | void (*break_ctl)(struct tty_struct *tty, int break_state); |
| 268 | int (*chars_in_buffer)(struct tty_struct *tty); |
| 269 | void (*throttle)(struct tty_struct *tty); |
| 270 | void (*unthrottle)(struct tty_struct *tty); |
| 271 | int (*tiocmget)(struct tty_struct *tty, struct file *file); |
| 272 | int (*tiocmset)(struct tty_struct *tty, struct file *file, |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 273 | unsigned int set, unsigned int clear); |
Alan Cox | 335f851 | 2009-06-11 12:26:29 +0100 | [diff] [blame] | 274 | /* Called by the tty layer for port level work. There may or may not |
| 275 | be an attached tty at this point */ |
| 276 | void (*dtr_rts)(struct usb_serial_port *port, int on); |
| 277 | int (*carrier_raised)(struct usb_serial_port *port); |
Alan Cox | fe1ae7f | 2009-09-19 13:13:33 -0700 | [diff] [blame] | 278 | /* Called by the usb serial hooks to allow the user to rework the |
| 279 | termios state */ |
| 280 | void (*init_termios)(struct tty_struct *tty); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 281 | /* USB events */ |
David Howells | 7d12e78 | 2006-10-05 14:55:46 +0100 | [diff] [blame] | 282 | void (*read_int_callback)(struct urb *urb); |
| 283 | void (*write_int_callback)(struct urb *urb); |
| 284 | void (*read_bulk_callback)(struct urb *urb); |
| 285 | void (*write_bulk_callback)(struct urb *urb); |
Johan Hovold | 2315432 | 2010-03-17 23:05:57 +0100 | [diff] [blame] | 286 | /* Called by the generic read bulk callback */ |
| 287 | void (*process_read_urb)(struct urb *urb); |
Johan Hovold | eaa3bcb | 2010-03-17 23:06:08 +0100 | [diff] [blame] | 288 | /* Called by the generic write implementation */ |
| 289 | int (*prepare_write_buffer)(struct usb_serial_port *port, |
Johan Hovold | c23e5fc | 2010-05-05 23:58:13 +0200 | [diff] [blame] | 290 | void *dest, size_t size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | }; |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 292 | #define to_usb_serial_driver(d) \ |
| 293 | container_of(d, struct usb_serial_driver, driver) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 294 | |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 295 | extern int usb_serial_register(struct usb_serial_driver *driver); |
| 296 | extern void usb_serial_deregister(struct usb_serial_driver *driver); |
Pete Zaitcev | cf2c748 | 2006-05-22 21:58:49 -0700 | [diff] [blame] | 297 | extern void usb_serial_port_softint(struct usb_serial_port *port); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 298 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 299 | extern int usb_serial_probe(struct usb_interface *iface, |
| 300 | const struct usb_device_id *id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 301 | extern void usb_serial_disconnect(struct usb_interface *iface); |
| 302 | |
Oliver Neukum | ec22559 | 2007-04-27 20:54:57 +0200 | [diff] [blame] | 303 | extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message); |
| 304 | extern int usb_serial_resume(struct usb_interface *intf); |
| 305 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 306 | extern int ezusb_writememory(struct usb_serial *serial, int address, |
| 307 | unsigned char *data, int length, __u8 bRequest); |
| 308 | extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 309 | |
| 310 | /* USB Serial console functions */ |
| 311 | #ifdef CONFIG_USB_SERIAL_CONSOLE |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 312 | extern void usb_serial_console_init(int debug, int minor); |
| 313 | extern void usb_serial_console_exit(void); |
Guennadi Liakhovetski | 73e487f | 2006-04-25 07:46:17 +0200 | [diff] [blame] | 314 | extern void usb_serial_console_disconnect(struct usb_serial *serial); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 315 | #else |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 316 | static inline void usb_serial_console_init(int debug, int minor) { } |
| 317 | static inline void usb_serial_console_exit(void) { } |
Guennadi Liakhovetski | 73e487f | 2006-04-25 07:46:17 +0200 | [diff] [blame] | 318 | static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 319 | #endif |
| 320 | |
| 321 | /* Functions needed by other parts of the usbserial core */ |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 322 | extern struct usb_serial *usb_serial_get_by_index(unsigned int minor); |
Guennadi Liakhovetski | 73e487f | 2006-04-25 07:46:17 +0200 | [diff] [blame] | 323 | extern void usb_serial_put(struct usb_serial *serial); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 324 | extern int usb_serial_generic_open(struct tty_struct *tty, |
Alan Cox | a509a7e | 2009-09-19 13:13:26 -0700 | [diff] [blame] | 325 | struct usb_serial_port *port); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 326 | extern int usb_serial_generic_write(struct tty_struct *tty, |
| 327 | struct usb_serial_port *port, const unsigned char *buf, int count); |
Alan Cox | 335f851 | 2009-06-11 12:26:29 +0100 | [diff] [blame] | 328 | extern void usb_serial_generic_close(struct usb_serial_port *port); |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 329 | extern int usb_serial_generic_resume(struct usb_serial *serial); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 330 | extern int usb_serial_generic_write_room(struct tty_struct *tty); |
| 331 | extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty); |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 332 | extern void usb_serial_generic_read_bulk_callback(struct urb *urb); |
| 333 | extern void usb_serial_generic_write_bulk_callback(struct urb *urb); |
Alan Cox | 95da310 | 2008-07-22 11:09:07 +0100 | [diff] [blame] | 334 | extern void usb_serial_generic_throttle(struct tty_struct *tty); |
| 335 | extern void usb_serial_generic_unthrottle(struct tty_struct *tty); |
Alan Stern | f9c99bb | 2009-06-02 11:53:55 -0400 | [diff] [blame] | 336 | extern void usb_serial_generic_disconnect(struct usb_serial *serial); |
| 337 | extern void usb_serial_generic_release(struct usb_serial *serial); |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 338 | extern int usb_serial_generic_register(int debug); |
| 339 | extern void usb_serial_generic_deregister(void); |
Johan Hovold | 41bd72f | 2010-03-17 23:05:53 +0100 | [diff] [blame] | 340 | extern int usb_serial_generic_submit_read_urb(struct usb_serial_port *port, |
Jason Wessel | 98fcb5f | 2009-05-11 15:24:09 -0500 | [diff] [blame] | 341 | gfp_t mem_flags); |
Johan Hovold | 2315432 | 2010-03-17 23:05:57 +0100 | [diff] [blame] | 342 | extern void usb_serial_generic_process_read_urb(struct urb *urb); |
Johan Hovold | eaa3bcb | 2010-03-17 23:06:08 +0100 | [diff] [blame] | 343 | extern int usb_serial_generic_prepare_write_buffer(struct usb_serial_port *port, |
Johan Hovold | c23e5fc | 2010-05-05 23:58:13 +0200 | [diff] [blame] | 344 | void *dest, size_t size); |
Alan Cox | 24a15a6 | 2009-07-09 13:36:22 +0100 | [diff] [blame] | 345 | extern int usb_serial_handle_sysrq_char(struct tty_struct *tty, |
| 346 | struct usb_serial_port *port, |
Jason Wessel | 98fcb5f | 2009-05-11 15:24:09 -0500 | [diff] [blame] | 347 | unsigned int ch); |
| 348 | extern int usb_serial_handle_break(struct usb_serial_port *port); |
| 349 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 350 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 351 | extern int usb_serial_bus_register(struct usb_serial_driver *device); |
| 352 | extern void usb_serial_bus_deregister(struct usb_serial_driver *device); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 353 | |
Greg Kroah-Hartman | ea65370 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 354 | extern struct usb_serial_driver usb_serial_generic_device; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 355 | extern struct bus_type usb_serial_bus_type; |
| 356 | extern struct tty_driver *usb_serial_tty_driver; |
| 357 | |
| 358 | static inline void usb_serial_debug_data(int debug, |
| 359 | struct device *dev, |
| 360 | const char *function, int size, |
| 361 | const unsigned char *data) |
| 362 | { |
| 363 | int i; |
| 364 | |
| 365 | if (debug) { |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 366 | dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", |
| 367 | function, size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | for (i = 0; i < size; ++i) |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 369 | printk("%.2x ", data[i]); |
| 370 | printk("\n"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 371 | } |
| 372 | } |
| 373 | |
| 374 | /* Use our own dbg macro */ |
| 375 | #undef dbg |
Joe Perches | efcbd3d | 2010-02-05 18:09:49 -0800 | [diff] [blame] | 376 | #define dbg(format, arg...) \ |
| 377 | do { \ |
| 378 | if (debug) \ |
| 379 | printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \ |
| 380 | } while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 381 | |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 382 | #endif /* __LINUX_USB_SERIAL_H */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 383 | |