Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
a969888c | 2 | * USB Serial Converter stuff |
1da177e4 | 3 | * |
502b95c1 | 4 | * Copyright (C) 1999 - 2005 |
1da177e4 LT |
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 | |
a969888c | 9 | * the Free Software Foundation; version 2 of the License. |
1da177e4 | 10 | * |
1da177e4 LT |
11 | */ |
12 | ||
1da177e4 LT |
13 | #ifndef __LINUX_USB_SERIAL_H |
14 | #define __LINUX_USB_SERIAL_H | |
15 | ||
1da177e4 | 16 | #include <linux/kref.h> |
1ce7dd26 | 17 | #include <linux/mutex.h> |
98fcb5f7 | 18 | #include <linux/sysrq.h> |
119eecc8 | 19 | #include <linux/kfifo.h> |
1da177e4 LT |
20 | |
21 | #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ | |
0282b7f2 AS |
22 | #define SERIAL_TTY_MINORS 254 /* loads of devices :) */ |
23 | #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */ | |
1da177e4 | 24 | |
41dceed5 GKH |
25 | /* The maximum number of ports one device can grab at once */ |
26 | #define MAX_NUM_PORTS 8 | |
1da177e4 LT |
27 | |
28 | /* parity check flag */ | |
29 | #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK)) | |
30 | ||
c706ebdf AS |
31 | enum port_dev_state { |
32 | PORT_UNREGISTERED, | |
33 | PORT_REGISTERING, | |
34 | PORT_REGISTERED, | |
35 | PORT_UNREGISTERING, | |
36 | }; | |
37 | ||
27c7acf2 JH |
38 | /* USB serial flags */ |
39 | #define USB_SERIAL_WRITE_BUSY 0 | |
40 | ||
1da177e4 LT |
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. | |
78c5b82e | 44 | * @port: pointer to the corresponding tty_port for this port. |
507ca9bc | 45 | * @lock: spinlock to grab when updating portions of this structure. |
1da177e4 LT |
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 | |
0858a3a5 | 55 | * for this port. |
1da177e4 | 56 | * @bulk_in_buffer: pointer to the bulk in buffer for this port. |
78c5b82e | 57 | * @bulk_in_size: the size of the bulk_in_buffer, in bytes. |
1da177e4 LT |
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. | |
8e8dce06 | 64 | * @write_fifo: kfifo used to buffer outgoing data |
78c5b82e | 65 | * @write_urb_busy: port`s writing status |
27c7acf2 JH |
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 | |
25d514ca | 69 | * @tx_bytes: number of bytes currently in host stack queues |
1da177e4 LT |
70 | * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this |
71 | * port. | |
27c7acf2 | 72 | * @flags: usb serial port flags |
1da177e4 LT |
73 | * @write_wait: a wait_queue_head_t used by the port. |
74 | * @work: work queue entry for the line discipline waking up. | |
253ca923 JR |
75 | * @throttled: nonzero if the read urb is inactive to throttle the device |
76 | * @throttle_req: nonzero if the tty wants to throttle us | |
78c5b82e | 77 | * @dev: pointer to the serial device |
1da177e4 LT |
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 { | |
41dceed5 | 83 | struct usb_serial *serial; |
95da310e | 84 | struct tty_port port; |
507ca9bc | 85 | spinlock_t lock; |
1da177e4 LT |
86 | unsigned char number; |
87 | ||
41dceed5 GKH |
88 | unsigned char *interrupt_in_buffer; |
89 | struct urb *interrupt_in_urb; | |
1da177e4 LT |
90 | __u8 interrupt_in_endpointAddress; |
91 | ||
41dceed5 | 92 | unsigned char *interrupt_out_buffer; |
1da177e4 | 93 | int interrupt_out_size; |
41dceed5 | 94 | struct urb *interrupt_out_urb; |
1da177e4 LT |
95 | __u8 interrupt_out_endpointAddress; |
96 | ||
41dceed5 | 97 | unsigned char *bulk_in_buffer; |
1da177e4 | 98 | int bulk_in_size; |
41dceed5 | 99 | struct urb *read_urb; |
1da177e4 LT |
100 | __u8 bulk_in_endpointAddress; |
101 | ||
41dceed5 | 102 | unsigned char *bulk_out_buffer; |
1da177e4 | 103 | int bulk_out_size; |
41dceed5 | 104 | struct urb *write_urb; |
119eecc8 | 105 | struct kfifo write_fifo; |
507ca9bc | 106 | int write_urb_busy; |
27c7acf2 JH |
107 | |
108 | unsigned char *bulk_out_buffers[2]; | |
109 | struct urb *write_urbs[2]; | |
110 | unsigned long write_urbs_free; | |
1da177e4 LT |
111 | __u8 bulk_out_endpointAddress; |
112 | ||
25d514ca | 113 | int tx_bytes; |
715b1dc0 | 114 | |
27c7acf2 | 115 | unsigned long flags; |
1da177e4 LT |
116 | wait_queue_head_t write_wait; |
117 | struct work_struct work; | |
253ca923 JR |
118 | char throttled; |
119 | char throttle_req; | |
98fcb5f7 | 120 | unsigned long sysrq; /* sysrq timeout */ |
1da177e4 | 121 | struct device dev; |
c706ebdf | 122 | enum port_dev_state dev_state; |
1da177e4 LT |
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 */ | |
41dceed5 | 127 | static inline void *usb_get_serial_port_data(struct usb_serial_port *port) |
1da177e4 LT |
128 | { |
129 | return dev_get_drvdata(&port->dev); | |
130 | } | |
131 | ||
41dceed5 GKH |
132 | static inline void usb_set_serial_port_data(struct usb_serial_port *port, |
133 | void *data) | |
1da177e4 LT |
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 | |
ea65370d | 141 | * @type: pointer to the struct usb_serial_driver for this device |
1da177e4 LT |
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 { | |
41dceed5 GKH |
156 | struct usb_device *dev; |
157 | struct usb_serial_driver *type; | |
158 | struct usb_interface *interface; | |
f8bece8d ON |
159 | unsigned char disconnected:1; |
160 | unsigned char suspending:1; | |
a4720c65 | 161 | unsigned char attached:1; |
1da177e4 LT |
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; | |
41dceed5 | 169 | struct usb_serial_port *port[MAX_NUM_PORTS]; |
1da177e4 | 170 | struct kref kref; |
a1cd7e99 | 171 | struct mutex disc_mutex; |
41dceed5 | 172 | void *private; |
1da177e4 LT |
173 | }; |
174 | #define to_usb_serial(d) container_of(d, struct usb_serial, kref) | |
175 | ||
1da177e4 | 176 | /* get and set the serial private data pointer helper functions */ |
41dceed5 | 177 | static inline void *usb_get_serial_data(struct usb_serial *serial) |
1da177e4 LT |
178 | { |
179 | return serial->private; | |
180 | } | |
181 | ||
41dceed5 | 182 | static inline void usb_set_serial_data(struct usb_serial *serial, void *data) |
1da177e4 LT |
183 | { |
184 | serial->private = data; | |
185 | } | |
186 | ||
187 | /** | |
ea65370d | 188 | * usb_serial_driver - describes a usb serial driver |
41dceed5 GKH |
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. | |
1da177e4 LT |
191 | * @id_table: pointer to a list of usb_device_id structures that define all |
192 | * of the devices this structure can support. | |
1da177e4 | 193 | * @num_ports: the number of different ports this device will have. |
bbcb2b90 JH |
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) | |
1da177e4 LT |
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. | |
a969888c | 204 | * Return 0 to continue on with the initialization sequence. Anything |
1da177e4 LT |
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. | |
f9c99bb8 AS |
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. | |
93bacefc GKH |
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. | |
1da177e4 | 217 | * |
ea65370d | 218 | * This structure is defines a USB Serial driver. It provides all of |
1da177e4 LT |
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. | |
18fcac35 GKH |
223 | * |
224 | * The driver.owner field should be set to the module owner of this driver. | |
269bda1c GKH |
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. | |
0b14c388 | 227 | * Using the module name is a good idea.) |
1da177e4 | 228 | */ |
ea65370d | 229 | struct usb_serial_driver { |
269bda1c | 230 | const char *description; |
1da177e4 | 231 | const struct usb_device_id *id_table; |
1da177e4 LT |
232 | char num_ports; |
233 | ||
234 | struct list_head driver_list; | |
235 | struct device_driver driver; | |
93bacefc GKH |
236 | struct usb_driver *usb_driver; |
237 | struct usb_dynids dynids; | |
25d514ca | 238 | |
bbcb2b90 JH |
239 | size_t bulk_in_size; |
240 | size_t bulk_out_size; | |
241 | ||
41dceed5 GKH |
242 | int (*probe)(struct usb_serial *serial, const struct usb_device_id *id); |
243 | int (*attach)(struct usb_serial *serial); | |
1da177e4 LT |
244 | int (*calc_num_ports) (struct usb_serial *serial); |
245 | ||
f9c99bb8 AS |
246 | void (*disconnect)(struct usb_serial *serial); |
247 | void (*release)(struct usb_serial *serial); | |
1da177e4 | 248 | |
41dceed5 GKH |
249 | int (*port_probe)(struct usb_serial_port *port); |
250 | int (*port_remove)(struct usb_serial_port *port); | |
1da177e4 | 251 | |
41dceed5 GKH |
252 | int (*suspend)(struct usb_serial *serial, pm_message_t message); |
253 | int (*resume)(struct usb_serial *serial); | |
ec22559e | 254 | |
1da177e4 | 255 | /* serial function calls */ |
a509a7e4 AC |
256 | /* Called by console and by the tty layer */ |
257 | int (*open)(struct tty_struct *tty, struct usb_serial_port *port); | |
335f8514 | 258 | void (*close)(struct usb_serial_port *port); |
95da310e AC |
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, | |
41dceed5 | 264 | unsigned int cmd, unsigned long arg); |
95da310e AC |
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, | |
41dceed5 | 273 | unsigned int set, unsigned int clear); |
335f8514 AC |
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); | |
fe1ae7fd AC |
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); | |
95da310e | 281 | /* USB events */ |
7d12e780 DH |
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); | |
23154320 JH |
286 | /* Called by the generic read bulk callback */ |
287 | void (*process_read_urb)(struct urb *urb); | |
eaa3bcb0 JH |
288 | /* Called by the generic write implementation */ |
289 | int (*prepare_write_buffer)(struct usb_serial_port *port, | |
c23e5fc1 | 290 | void *dest, size_t size); |
1da177e4 | 291 | }; |
41dceed5 GKH |
292 | #define to_usb_serial_driver(d) \ |
293 | container_of(d, struct usb_serial_driver, driver) | |
1da177e4 | 294 | |
ea65370d GKH |
295 | extern int usb_serial_register(struct usb_serial_driver *driver); |
296 | extern void usb_serial_deregister(struct usb_serial_driver *driver); | |
cf2c7481 | 297 | extern void usb_serial_port_softint(struct usb_serial_port *port); |
1da177e4 | 298 | |
41dceed5 GKH |
299 | extern int usb_serial_probe(struct usb_interface *iface, |
300 | const struct usb_device_id *id); | |
1da177e4 LT |
301 | extern void usb_serial_disconnect(struct usb_interface *iface); |
302 | ||
ec22559e ON |
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 | ||
41dceed5 GKH |
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); | |
1da177e4 LT |
309 | |
310 | /* USB Serial console functions */ | |
311 | #ifdef CONFIG_USB_SERIAL_CONSOLE | |
41dceed5 GKH |
312 | extern void usb_serial_console_init(int debug, int minor); |
313 | extern void usb_serial_console_exit(void); | |
73e487fd | 314 | extern void usb_serial_console_disconnect(struct usb_serial *serial); |
1da177e4 | 315 | #else |
41dceed5 GKH |
316 | static inline void usb_serial_console_init(int debug, int minor) { } |
317 | static inline void usb_serial_console_exit(void) { } | |
73e487fd | 318 | static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} |
1da177e4 LT |
319 | #endif |
320 | ||
321 | /* Functions needed by other parts of the usbserial core */ | |
41dceed5 | 322 | extern struct usb_serial *usb_serial_get_by_index(unsigned int minor); |
73e487fd | 323 | extern void usb_serial_put(struct usb_serial *serial); |
95da310e | 324 | extern int usb_serial_generic_open(struct tty_struct *tty, |
a509a7e4 | 325 | struct usb_serial_port *port); |
95da310e AC |
326 | extern int usb_serial_generic_write(struct tty_struct *tty, |
327 | struct usb_serial_port *port, const unsigned char *buf, int count); | |
335f8514 | 328 | extern void usb_serial_generic_close(struct usb_serial_port *port); |
41dceed5 | 329 | extern int usb_serial_generic_resume(struct usb_serial *serial); |
95da310e AC |
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); | |
41dceed5 GKH |
332 | extern void usb_serial_generic_read_bulk_callback(struct urb *urb); |
333 | extern void usb_serial_generic_write_bulk_callback(struct urb *urb); | |
95da310e AC |
334 | extern void usb_serial_generic_throttle(struct tty_struct *tty); |
335 | extern void usb_serial_generic_unthrottle(struct tty_struct *tty); | |
f9c99bb8 AS |
336 | extern void usb_serial_generic_disconnect(struct usb_serial *serial); |
337 | extern void usb_serial_generic_release(struct usb_serial *serial); | |
41dceed5 GKH |
338 | extern int usb_serial_generic_register(int debug); |
339 | extern void usb_serial_generic_deregister(void); | |
41bd72f9 | 340 | extern int usb_serial_generic_submit_read_urb(struct usb_serial_port *port, |
98fcb5f7 | 341 | gfp_t mem_flags); |
23154320 | 342 | extern void usb_serial_generic_process_read_urb(struct urb *urb); |
eaa3bcb0 | 343 | extern int usb_serial_generic_prepare_write_buffer(struct usb_serial_port *port, |
c23e5fc1 | 344 | void *dest, size_t size); |
24a15a62 AC |
345 | extern int usb_serial_handle_sysrq_char(struct tty_struct *tty, |
346 | struct usb_serial_port *port, | |
98fcb5f7 JW |
347 | unsigned int ch); |
348 | extern int usb_serial_handle_break(struct usb_serial_port *port); | |
349 | ||
41dceed5 GKH |
350 | |
351 | extern int usb_serial_bus_register(struct usb_serial_driver *device); | |
352 | extern void usb_serial_bus_deregister(struct usb_serial_driver *device); | |
1da177e4 | 353 | |
ea65370d | 354 | extern struct usb_serial_driver usb_serial_generic_device; |
1da177e4 LT |
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) { | |
41dceed5 GKH |
366 | dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", |
367 | function, size); | |
1da177e4 | 368 | for (i = 0; i < size; ++i) |
41dceed5 GKH |
369 | printk("%.2x ", data[i]); |
370 | printk("\n"); | |
1da177e4 LT |
371 | } |
372 | } | |
373 | ||
374 | /* Use our own dbg macro */ | |
375 | #undef dbg | |
efcbd3df JP |
376 | #define dbg(format, arg...) \ |
377 | do { \ | |
378 | if (debug) \ | |
379 | printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \ | |
380 | } while (0) | |
1da177e4 | 381 | |
dda43a0e | 382 | #endif /* __LINUX_USB_SERIAL_H */ |
1da177e4 | 383 |