]>
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> |
1da177e4 LT |
19 | |
20 | #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ | |
0282b7f2 AS |
21 | #define SERIAL_TTY_MINORS 254 /* loads of devices :) */ |
22 | #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */ | |
1da177e4 | 23 | |
41dceed5 GKH |
24 | /* The maximum number of ports one device can grab at once */ |
25 | #define MAX_NUM_PORTS 8 | |
1da177e4 LT |
26 | |
27 | /* parity check flag */ | |
28 | #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK)) | |
29 | ||
c706ebdf AS |
30 | enum port_dev_state { |
31 | PORT_UNREGISTERED, | |
32 | PORT_REGISTERING, | |
33 | PORT_REGISTERED, | |
34 | PORT_UNREGISTERING, | |
35 | }; | |
36 | ||
1da177e4 LT |
37 | /** |
38 | * usb_serial_port: structure for the specific ports of a device. | |
39 | * @serial: pointer back to the struct usb_serial owner of this port. | |
78c5b82e | 40 | * @port: pointer to the corresponding tty_port for this port. |
507ca9bc | 41 | * @lock: spinlock to grab when updating portions of this structure. |
1ce7dd26 | 42 | * @mutex: mutex used to synchronize serial_open() and serial_close() |
8a4613f0 | 43 | * access for this port. |
1da177e4 LT |
44 | * @number: the number of the port (the minor number). |
45 | * @interrupt_in_buffer: pointer to the interrupt in buffer for this port. | |
46 | * @interrupt_in_urb: pointer to the interrupt in struct urb for this port. | |
47 | * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe | |
48 | * for this port. | |
49 | * @interrupt_out_buffer: pointer to the interrupt out buffer for this port. | |
50 | * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes. | |
51 | * @interrupt_out_urb: pointer to the interrupt out struct urb for this port. | |
52 | * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe | |
53 | * for this port. | |
54 | * @bulk_in_buffer: pointer to the bulk in buffer for this port. | |
78c5b82e | 55 | * @bulk_in_size: the size of the bulk_in_buffer, in bytes. |
1da177e4 LT |
56 | * @read_urb: pointer to the bulk in struct urb for this port. |
57 | * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this | |
58 | * port. | |
59 | * @bulk_out_buffer: pointer to the bulk out buffer for this port. | |
60 | * @bulk_out_size: the size of the bulk_out_buffer, in bytes. | |
61 | * @write_urb: pointer to the bulk out struct urb for this port. | |
78c5b82e | 62 | * @write_urb_busy: port`s writing status |
1da177e4 LT |
63 | * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this |
64 | * port. | |
65 | * @write_wait: a wait_queue_head_t used by the port. | |
66 | * @work: work queue entry for the line discipline waking up. | |
253ca923 JR |
67 | * @throttled: nonzero if the read urb is inactive to throttle the device |
68 | * @throttle_req: nonzero if the tty wants to throttle us | |
78c5b82e LD |
69 | * @console: attached usb serial console |
70 | * @dev: pointer to the serial device | |
1da177e4 LT |
71 | * |
72 | * This structure is used by the usb-serial core and drivers for the specific | |
73 | * ports of a device. | |
74 | */ | |
75 | struct usb_serial_port { | |
41dceed5 | 76 | struct usb_serial *serial; |
95da310e | 77 | struct tty_port port; |
507ca9bc | 78 | spinlock_t lock; |
1ce7dd26 | 79 | struct mutex mutex; |
1da177e4 LT |
80 | unsigned char number; |
81 | ||
41dceed5 GKH |
82 | unsigned char *interrupt_in_buffer; |
83 | struct urb *interrupt_in_urb; | |
1da177e4 LT |
84 | __u8 interrupt_in_endpointAddress; |
85 | ||
41dceed5 | 86 | unsigned char *interrupt_out_buffer; |
1da177e4 | 87 | int interrupt_out_size; |
41dceed5 | 88 | struct urb *interrupt_out_urb; |
1da177e4 LT |
89 | __u8 interrupt_out_endpointAddress; |
90 | ||
41dceed5 | 91 | unsigned char *bulk_in_buffer; |
1da177e4 | 92 | int bulk_in_size; |
41dceed5 | 93 | struct urb *read_urb; |
1da177e4 LT |
94 | __u8 bulk_in_endpointAddress; |
95 | ||
41dceed5 | 96 | unsigned char *bulk_out_buffer; |
1da177e4 | 97 | int bulk_out_size; |
41dceed5 | 98 | struct urb *write_urb; |
507ca9bc | 99 | int write_urb_busy; |
1da177e4 LT |
100 | __u8 bulk_out_endpointAddress; |
101 | ||
715b1dc0 JW |
102 | int tx_bytes_flight; |
103 | int urbs_in_flight; | |
104 | ||
1da177e4 LT |
105 | wait_queue_head_t write_wait; |
106 | struct work_struct work; | |
253ca923 JR |
107 | char throttled; |
108 | char throttle_req; | |
9a6b1efa | 109 | char console; |
98fcb5f7 | 110 | unsigned long sysrq; /* sysrq timeout */ |
1da177e4 | 111 | struct device dev; |
c706ebdf | 112 | enum port_dev_state dev_state; |
1da177e4 LT |
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 */ | |
41dceed5 | 117 | static inline void *usb_get_serial_port_data(struct usb_serial_port *port) |
1da177e4 LT |
118 | { |
119 | return dev_get_drvdata(&port->dev); | |
120 | } | |
121 | ||
41dceed5 GKH |
122 | static inline void usb_set_serial_port_data(struct usb_serial_port *port, |
123 | void *data) | |
1da177e4 LT |
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 | |
ea65370d | 131 | * @type: pointer to the struct usb_serial_driver for this device |
1da177e4 LT |
132 | * @interface: pointer to the struct usb_interface for this device |
133 | * @minor: the starting minor number for this device | |
134 | * @num_ports: the number of ports this device has | |
135 | * @num_interrupt_in: number of interrupt in endpoints we have | |
136 | * @num_interrupt_out: number of interrupt out endpoints we have | |
137 | * @num_bulk_in: number of bulk in endpoints we have | |
138 | * @num_bulk_out: number of bulk out endpoints we have | |
139 | * @port: array of struct usb_serial_port structures for the different ports. | |
140 | * @private: place to put any driver specific information that is needed. The | |
141 | * usb-serial driver is required to manage this data, the usb-serial core | |
142 | * will not touch this. Use usb_get_serial_data() and | |
143 | * usb_set_serial_data() to access this. | |
144 | */ | |
145 | struct usb_serial { | |
41dceed5 GKH |
146 | struct usb_device *dev; |
147 | struct usb_serial_driver *type; | |
148 | struct usb_interface *interface; | |
f8bece8d ON |
149 | unsigned char disconnected:1; |
150 | unsigned char suspending:1; | |
1da177e4 LT |
151 | unsigned char minor; |
152 | unsigned char num_ports; | |
153 | unsigned char num_port_pointers; | |
154 | char num_interrupt_in; | |
155 | char num_interrupt_out; | |
156 | char num_bulk_in; | |
157 | char num_bulk_out; | |
41dceed5 | 158 | struct usb_serial_port *port[MAX_NUM_PORTS]; |
1da177e4 | 159 | struct kref kref; |
a1cd7e99 | 160 | struct mutex disc_mutex; |
41dceed5 | 161 | void *private; |
1da177e4 LT |
162 | }; |
163 | #define to_usb_serial(d) container_of(d, struct usb_serial, kref) | |
164 | ||
1da177e4 | 165 | /* get and set the serial private data pointer helper functions */ |
41dceed5 | 166 | static inline void *usb_get_serial_data(struct usb_serial *serial) |
1da177e4 LT |
167 | { |
168 | return serial->private; | |
169 | } | |
170 | ||
41dceed5 | 171 | static inline void usb_set_serial_data(struct usb_serial *serial, void *data) |
1da177e4 LT |
172 | { |
173 | serial->private = data; | |
174 | } | |
175 | ||
176 | /** | |
ea65370d | 177 | * usb_serial_driver - describes a usb serial driver |
41dceed5 GKH |
178 | * @description: pointer to a string that describes this driver. This string |
179 | * used in the syslog messages when a device is inserted or removed. | |
1da177e4 LT |
180 | * @id_table: pointer to a list of usb_device_id structures that define all |
181 | * of the devices this structure can support. | |
1da177e4 LT |
182 | * @num_ports: the number of different ports this device will have. |
183 | * @calc_num_ports: pointer to a function to determine how many ports this | |
184 | * device has dynamically. It will be called after the probe() | |
185 | * callback is called, but before attach() | |
186 | * @probe: pointer to the driver's probe function. | |
187 | * This will be called when the device is inserted into the system, | |
188 | * but before the device has been fully initialized by the usb_serial | |
189 | * subsystem. Use this function to download any firmware to the device, | |
190 | * or any other early initialization that might be needed. | |
a969888c | 191 | * Return 0 to continue on with the initialization sequence. Anything |
1da177e4 LT |
192 | * else will abort it. |
193 | * @attach: pointer to the driver's attach function. | |
194 | * This will be called when the struct usb_serial structure is fully set | |
195 | * set up. Do any local initialization of the device, or any private | |
196 | * memory structure allocation at this point in time. | |
f9c99bb8 AS |
197 | * @disconnect: pointer to the driver's disconnect function. This will be |
198 | * called when the device is unplugged or unbound from the driver. | |
199 | * @release: pointer to the driver's release function. This will be called | |
200 | * when the usb_serial data structure is about to be destroyed. | |
93bacefc GKH |
201 | * @usb_driver: pointer to the struct usb_driver that controls this |
202 | * device. This is necessary to allow dynamic ids to be added to | |
203 | * the driver from sysfs. | |
1da177e4 | 204 | * |
ea65370d | 205 | * This structure is defines a USB Serial driver. It provides all of |
1da177e4 LT |
206 | * the information that the USB serial core code needs. If the function |
207 | * pointers are defined, then the USB serial core code will call them when | |
208 | * the corresponding tty port functions are called. If they are not | |
209 | * called, the generic serial function will be used instead. | |
18fcac35 GKH |
210 | * |
211 | * The driver.owner field should be set to the module owner of this driver. | |
269bda1c GKH |
212 | * The driver.name field should be set to the name of this driver (remember |
213 | * it will show up in sysfs, so it needs to be short and to the point. | |
0b14c388 | 214 | * Using the module name is a good idea.) |
1da177e4 | 215 | */ |
ea65370d | 216 | struct usb_serial_driver { |
269bda1c | 217 | const char *description; |
1da177e4 | 218 | const struct usb_device_id *id_table; |
1da177e4 LT |
219 | char num_ports; |
220 | ||
221 | struct list_head driver_list; | |
222 | struct device_driver driver; | |
93bacefc GKH |
223 | struct usb_driver *usb_driver; |
224 | struct usb_dynids dynids; | |
715b1dc0 | 225 | int max_in_flight_urbs; |
1da177e4 | 226 | |
41dceed5 GKH |
227 | int (*probe)(struct usb_serial *serial, const struct usb_device_id *id); |
228 | int (*attach)(struct usb_serial *serial); | |
1da177e4 LT |
229 | int (*calc_num_ports) (struct usb_serial *serial); |
230 | ||
f9c99bb8 AS |
231 | void (*disconnect)(struct usb_serial *serial); |
232 | void (*release)(struct usb_serial *serial); | |
1da177e4 | 233 | |
41dceed5 GKH |
234 | int (*port_probe)(struct usb_serial_port *port); |
235 | int (*port_remove)(struct usb_serial_port *port); | |
1da177e4 | 236 | |
41dceed5 GKH |
237 | int (*suspend)(struct usb_serial *serial, pm_message_t message); |
238 | int (*resume)(struct usb_serial *serial); | |
ec22559e | 239 | |
1da177e4 | 240 | /* serial function calls */ |
a509a7e4 AC |
241 | /* Called by console and by the tty layer */ |
242 | int (*open)(struct tty_struct *tty, struct usb_serial_port *port); | |
335f8514 | 243 | void (*close)(struct usb_serial_port *port); |
95da310e AC |
244 | int (*write)(struct tty_struct *tty, struct usb_serial_port *port, |
245 | const unsigned char *buf, int count); | |
246 | /* Called only by the tty layer */ | |
247 | int (*write_room)(struct tty_struct *tty); | |
248 | int (*ioctl)(struct tty_struct *tty, struct file *file, | |
41dceed5 | 249 | unsigned int cmd, unsigned long arg); |
95da310e AC |
250 | void (*set_termios)(struct tty_struct *tty, |
251 | struct usb_serial_port *port, struct ktermios *old); | |
252 | void (*break_ctl)(struct tty_struct *tty, int break_state); | |
253 | int (*chars_in_buffer)(struct tty_struct *tty); | |
254 | void (*throttle)(struct tty_struct *tty); | |
255 | void (*unthrottle)(struct tty_struct *tty); | |
256 | int (*tiocmget)(struct tty_struct *tty, struct file *file); | |
257 | int (*tiocmset)(struct tty_struct *tty, struct file *file, | |
41dceed5 | 258 | unsigned int set, unsigned int clear); |
335f8514 AC |
259 | /* Called by the tty layer for port level work. There may or may not |
260 | be an attached tty at this point */ | |
261 | void (*dtr_rts)(struct usb_serial_port *port, int on); | |
262 | int (*carrier_raised)(struct usb_serial_port *port); | |
fe1ae7fd AC |
263 | /* Called by the usb serial hooks to allow the user to rework the |
264 | termios state */ | |
265 | void (*init_termios)(struct tty_struct *tty); | |
95da310e | 266 | /* USB events */ |
7d12e780 DH |
267 | void (*read_int_callback)(struct urb *urb); |
268 | void (*write_int_callback)(struct urb *urb); | |
269 | void (*read_bulk_callback)(struct urb *urb); | |
270 | void (*write_bulk_callback)(struct urb *urb); | |
1da177e4 | 271 | }; |
41dceed5 GKH |
272 | #define to_usb_serial_driver(d) \ |
273 | container_of(d, struct usb_serial_driver, driver) | |
1da177e4 | 274 | |
ea65370d GKH |
275 | extern int usb_serial_register(struct usb_serial_driver *driver); |
276 | extern void usb_serial_deregister(struct usb_serial_driver *driver); | |
cf2c7481 | 277 | extern void usb_serial_port_softint(struct usb_serial_port *port); |
1da177e4 | 278 | |
41dceed5 GKH |
279 | extern int usb_serial_probe(struct usb_interface *iface, |
280 | const struct usb_device_id *id); | |
1da177e4 LT |
281 | extern void usb_serial_disconnect(struct usb_interface *iface); |
282 | ||
ec22559e ON |
283 | extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message); |
284 | extern int usb_serial_resume(struct usb_interface *intf); | |
285 | ||
41dceed5 GKH |
286 | extern int ezusb_writememory(struct usb_serial *serial, int address, |
287 | unsigned char *data, int length, __u8 bRequest); | |
288 | extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit); | |
1da177e4 LT |
289 | |
290 | /* USB Serial console functions */ | |
291 | #ifdef CONFIG_USB_SERIAL_CONSOLE | |
41dceed5 GKH |
292 | extern void usb_serial_console_init(int debug, int minor); |
293 | extern void usb_serial_console_exit(void); | |
73e487fd | 294 | extern void usb_serial_console_disconnect(struct usb_serial *serial); |
1da177e4 | 295 | #else |
41dceed5 GKH |
296 | static inline void usb_serial_console_init(int debug, int minor) { } |
297 | static inline void usb_serial_console_exit(void) { } | |
73e487fd | 298 | static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} |
1da177e4 LT |
299 | #endif |
300 | ||
301 | /* Functions needed by other parts of the usbserial core */ | |
41dceed5 | 302 | extern struct usb_serial *usb_serial_get_by_index(unsigned int minor); |
73e487fd | 303 | extern void usb_serial_put(struct usb_serial *serial); |
95da310e | 304 | extern int usb_serial_generic_open(struct tty_struct *tty, |
a509a7e4 | 305 | struct usb_serial_port *port); |
95da310e AC |
306 | extern int usb_serial_generic_write(struct tty_struct *tty, |
307 | struct usb_serial_port *port, const unsigned char *buf, int count); | |
335f8514 | 308 | extern void usb_serial_generic_close(struct usb_serial_port *port); |
41dceed5 | 309 | extern int usb_serial_generic_resume(struct usb_serial *serial); |
95da310e AC |
310 | extern int usb_serial_generic_write_room(struct tty_struct *tty); |
311 | extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty); | |
41dceed5 GKH |
312 | extern void usb_serial_generic_read_bulk_callback(struct urb *urb); |
313 | extern void usb_serial_generic_write_bulk_callback(struct urb *urb); | |
95da310e AC |
314 | extern void usb_serial_generic_throttle(struct tty_struct *tty); |
315 | extern void usb_serial_generic_unthrottle(struct tty_struct *tty); | |
f9c99bb8 AS |
316 | extern void usb_serial_generic_disconnect(struct usb_serial *serial); |
317 | extern void usb_serial_generic_release(struct usb_serial *serial); | |
41dceed5 GKH |
318 | extern int usb_serial_generic_register(int debug); |
319 | extern void usb_serial_generic_deregister(void); | |
98fcb5f7 JW |
320 | extern void usb_serial_generic_resubmit_read_urb(struct usb_serial_port *port, |
321 | gfp_t mem_flags); | |
24a15a62 AC |
322 | extern int usb_serial_handle_sysrq_char(struct tty_struct *tty, |
323 | struct usb_serial_port *port, | |
98fcb5f7 JW |
324 | unsigned int ch); |
325 | extern int usb_serial_handle_break(struct usb_serial_port *port); | |
326 | ||
41dceed5 GKH |
327 | |
328 | extern int usb_serial_bus_register(struct usb_serial_driver *device); | |
329 | extern void usb_serial_bus_deregister(struct usb_serial_driver *device); | |
1da177e4 | 330 | |
ea65370d | 331 | extern struct usb_serial_driver usb_serial_generic_device; |
1da177e4 LT |
332 | extern struct bus_type usb_serial_bus_type; |
333 | extern struct tty_driver *usb_serial_tty_driver; | |
334 | ||
335 | static inline void usb_serial_debug_data(int debug, | |
336 | struct device *dev, | |
337 | const char *function, int size, | |
338 | const unsigned char *data) | |
339 | { | |
340 | int i; | |
341 | ||
342 | if (debug) { | |
41dceed5 GKH |
343 | dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", |
344 | function, size); | |
1da177e4 | 345 | for (i = 0; i < size; ++i) |
41dceed5 GKH |
346 | printk("%.2x ", data[i]); |
347 | printk("\n"); | |
1da177e4 LT |
348 | } |
349 | } | |
350 | ||
351 | /* Use our own dbg macro */ | |
352 | #undef dbg | |
41dceed5 GKH |
353 | #define dbg(format, arg...) \ |
354 | do { \ | |
355 | if (debug) \ | |
356 | printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \ | |
357 | ## arg); \ | |
358 | } while (0) | |
1da177e4 LT |
359 | |
360 | ||
361 | ||
dda43a0e | 362 | #endif /* __LINUX_USB_SERIAL_H */ |
1da177e4 | 363 |