Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * USB Serial Converter driver | |
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 | |
502b95c1 | 9 | * the Free Software Foundation; either version 2 of the License. |
1da177e4 | 10 | * |
1da177e4 LT |
11 | */ |
12 | ||
13 | ||
14 | #ifndef __LINUX_USB_SERIAL_H | |
15 | #define __LINUX_USB_SERIAL_H | |
16 | ||
17 | #include <linux/config.h> | |
18 | #include <linux/kref.h> | |
1ce7dd26 | 19 | #include <linux/mutex.h> |
1da177e4 LT |
20 | |
21 | #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ | |
22 | #define SERIAL_TTY_MINORS 255 /* loads of devices :) */ | |
23 | ||
24 | #define MAX_NUM_PORTS 8 /* The maximum number of ports one device can grab at once */ | |
25 | ||
26 | /* parity check flag */ | |
27 | #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK)) | |
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 | * @tty: pointer to the corresponding tty for this port. | |
507ca9bc | 33 | * @lock: spinlock to grab when updating portions of this structure. |
1ce7dd26 | 34 | * @mutex: mutex used to synchronize serial_open() and serial_close() |
8a4613f0 | 35 | * access for this port. |
1da177e4 LT |
36 | * @number: the number of the port (the minor number). |
37 | * @interrupt_in_buffer: pointer to the interrupt in buffer for this port. | |
38 | * @interrupt_in_urb: pointer to the interrupt in struct urb for this port. | |
39 | * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe | |
40 | * for this port. | |
41 | * @interrupt_out_buffer: pointer to the interrupt out buffer for this port. | |
42 | * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes. | |
43 | * @interrupt_out_urb: pointer to the interrupt out struct urb for this port. | |
44 | * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe | |
45 | * for this port. | |
46 | * @bulk_in_buffer: pointer to the bulk in buffer for this port. | |
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_out_buffer: pointer to the bulk out buffer for this port. | |
51 | * @bulk_out_size: the size of the bulk_out_buffer, in bytes. | |
52 | * @write_urb: pointer to the bulk out struct urb for this port. | |
53 | * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this | |
54 | * port. | |
55 | * @write_wait: a wait_queue_head_t used by the port. | |
56 | * @work: work queue entry for the line discipline waking up. | |
57 | * @open_count: number of times this port has been opened. | |
58 | * | |
59 | * This structure is used by the usb-serial core and drivers for the specific | |
60 | * ports of a device. | |
61 | */ | |
62 | struct usb_serial_port { | |
63 | struct usb_serial * serial; | |
64 | struct tty_struct * tty; | |
507ca9bc | 65 | spinlock_t lock; |
1ce7dd26 | 66 | struct mutex mutex; |
1da177e4 LT |
67 | unsigned char number; |
68 | ||
69 | unsigned char * interrupt_in_buffer; | |
70 | struct urb * interrupt_in_urb; | |
71 | __u8 interrupt_in_endpointAddress; | |
72 | ||
73 | unsigned char * interrupt_out_buffer; | |
74 | int interrupt_out_size; | |
75 | struct urb * interrupt_out_urb; | |
76 | __u8 interrupt_out_endpointAddress; | |
77 | ||
78 | unsigned char * bulk_in_buffer; | |
79 | int bulk_in_size; | |
80 | struct urb * read_urb; | |
81 | __u8 bulk_in_endpointAddress; | |
82 | ||
83 | unsigned char * bulk_out_buffer; | |
84 | int bulk_out_size; | |
85 | struct urb * write_urb; | |
507ca9bc | 86 | int write_urb_busy; |
1da177e4 LT |
87 | __u8 bulk_out_endpointAddress; |
88 | ||
89 | wait_queue_head_t write_wait; | |
90 | struct work_struct work; | |
91 | int open_count; | |
92 | struct device dev; | |
93 | }; | |
94 | #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev) | |
95 | ||
96 | /* get and set the port private data pointer helper functions */ | |
97 | static inline void *usb_get_serial_port_data (struct usb_serial_port *port) | |
98 | { | |
99 | return dev_get_drvdata(&port->dev); | |
100 | } | |
101 | ||
102 | static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data) | |
103 | { | |
104 | dev_set_drvdata(&port->dev, data); | |
105 | } | |
106 | ||
107 | /** | |
108 | * usb_serial - structure used by the usb-serial core for a device | |
109 | * @dev: pointer to the struct usb_device for this device | |
ea65370d | 110 | * @type: pointer to the struct usb_serial_driver for this device |
1da177e4 LT |
111 | * @interface: pointer to the struct usb_interface for this device |
112 | * @minor: the starting minor number for this device | |
113 | * @num_ports: the number of ports this device has | |
114 | * @num_interrupt_in: number of interrupt in endpoints we have | |
115 | * @num_interrupt_out: number of interrupt out endpoints we have | |
116 | * @num_bulk_in: number of bulk in endpoints we have | |
117 | * @num_bulk_out: number of bulk out endpoints we have | |
118 | * @port: array of struct usb_serial_port structures for the different ports. | |
119 | * @private: place to put any driver specific information that is needed. The | |
120 | * usb-serial driver is required to manage this data, the usb-serial core | |
121 | * will not touch this. Use usb_get_serial_data() and | |
122 | * usb_set_serial_data() to access this. | |
123 | */ | |
124 | struct usb_serial { | |
125 | struct usb_device * dev; | |
ea65370d | 126 | struct usb_serial_driver * type; |
1da177e4 LT |
127 | struct usb_interface * interface; |
128 | unsigned char minor; | |
129 | unsigned char num_ports; | |
130 | unsigned char num_port_pointers; | |
131 | char num_interrupt_in; | |
132 | char num_interrupt_out; | |
133 | char num_bulk_in; | |
134 | char num_bulk_out; | |
135 | struct usb_serial_port * port[MAX_NUM_PORTS]; | |
136 | struct kref kref; | |
137 | void * private; | |
138 | }; | |
139 | #define to_usb_serial(d) container_of(d, struct usb_serial, kref) | |
140 | ||
141 | #define NUM_DONT_CARE (-1) | |
142 | ||
143 | /* get and set the serial private data pointer helper functions */ | |
144 | static inline void *usb_get_serial_data (struct usb_serial *serial) | |
145 | { | |
146 | return serial->private; | |
147 | } | |
148 | ||
149 | static inline void usb_set_serial_data (struct usb_serial *serial, void *data) | |
150 | { | |
151 | serial->private = data; | |
152 | } | |
153 | ||
154 | /** | |
ea65370d | 155 | * usb_serial_driver - describes a usb serial driver |
269bda1c | 156 | * @description: pointer to a string that describes this driver. This string used |
1da177e4 | 157 | * in the syslog messages when a device is inserted or removed. |
1da177e4 LT |
158 | * @id_table: pointer to a list of usb_device_id structures that define all |
159 | * of the devices this structure can support. | |
160 | * @num_interrupt_in: the number of interrupt in endpoints this device will | |
161 | * have. | |
162 | * @num_interrupt_out: the number of interrupt out endpoints this device will | |
163 | * have. | |
164 | * @num_bulk_in: the number of bulk in endpoints this device will have. | |
165 | * @num_bulk_out: the number of bulk out endpoints this device will have. | |
166 | * @num_ports: the number of different ports this device will have. | |
167 | * @calc_num_ports: pointer to a function to determine how many ports this | |
168 | * device has dynamically. It will be called after the probe() | |
169 | * callback is called, but before attach() | |
170 | * @probe: pointer to the driver's probe function. | |
171 | * This will be called when the device is inserted into the system, | |
172 | * but before the device has been fully initialized by the usb_serial | |
173 | * subsystem. Use this function to download any firmware to the device, | |
174 | * or any other early initialization that might be needed. | |
175 | * Return 0 to continue on with the initialization sequence. Anything | |
176 | * else will abort it. | |
177 | * @attach: pointer to the driver's attach function. | |
178 | * This will be called when the struct usb_serial structure is fully set | |
179 | * set up. Do any local initialization of the device, or any private | |
180 | * memory structure allocation at this point in time. | |
181 | * @shutdown: pointer to the driver's shutdown function. This will be | |
182 | * called when the device is removed from the system. | |
183 | * | |
ea65370d | 184 | * This structure is defines a USB Serial driver. It provides all of |
1da177e4 LT |
185 | * the information that the USB serial core code needs. If the function |
186 | * pointers are defined, then the USB serial core code will call them when | |
187 | * the corresponding tty port functions are called. If they are not | |
188 | * called, the generic serial function will be used instead. | |
18fcac35 GKH |
189 | * |
190 | * The driver.owner field should be set to the module owner of this driver. | |
269bda1c GKH |
191 | * The driver.name field should be set to the name of this driver (remember |
192 | * it will show up in sysfs, so it needs to be short and to the point. | |
193 | * Useing the module name is a good idea.) | |
1da177e4 | 194 | */ |
ea65370d | 195 | struct usb_serial_driver { |
269bda1c | 196 | const char *description; |
1da177e4 LT |
197 | const struct usb_device_id *id_table; |
198 | char num_interrupt_in; | |
199 | char num_interrupt_out; | |
200 | char num_bulk_in; | |
201 | char num_bulk_out; | |
202 | char num_ports; | |
203 | ||
204 | struct list_head driver_list; | |
205 | struct device_driver driver; | |
206 | ||
207 | int (*probe) (struct usb_serial *serial, const struct usb_device_id *id); | |
208 | int (*attach) (struct usb_serial *serial); | |
209 | int (*calc_num_ports) (struct usb_serial *serial); | |
210 | ||
211 | void (*shutdown) (struct usb_serial *serial); | |
212 | ||
213 | int (*port_probe) (struct usb_serial_port *port); | |
214 | int (*port_remove) (struct usb_serial_port *port); | |
215 | ||
216 | /* serial function calls */ | |
217 | int (*open) (struct usb_serial_port *port, struct file * filp); | |
218 | void (*close) (struct usb_serial_port *port, struct file * filp); | |
219 | int (*write) (struct usb_serial_port *port, const unsigned char *buf, int count); | |
220 | int (*write_room) (struct usb_serial_port *port); | |
221 | int (*ioctl) (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg); | |
222 | void (*set_termios) (struct usb_serial_port *port, struct termios * old); | |
223 | void (*break_ctl) (struct usb_serial_port *port, int break_state); | |
224 | int (*chars_in_buffer) (struct usb_serial_port *port); | |
225 | void (*throttle) (struct usb_serial_port *port); | |
226 | void (*unthrottle) (struct usb_serial_port *port); | |
227 | int (*tiocmget) (struct usb_serial_port *port, struct file *file); | |
228 | int (*tiocmset) (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear); | |
229 | ||
230 | void (*read_int_callback)(struct urb *urb, struct pt_regs *regs); | |
231 | void (*write_int_callback)(struct urb *urb, struct pt_regs *regs); | |
232 | void (*read_bulk_callback)(struct urb *urb, struct pt_regs *regs); | |
233 | void (*write_bulk_callback)(struct urb *urb, struct pt_regs *regs); | |
234 | }; | |
ea65370d | 235 | #define to_usb_serial_driver(d) container_of(d, struct usb_serial_driver, driver) |
1da177e4 | 236 | |
ea65370d GKH |
237 | extern int usb_serial_register(struct usb_serial_driver *driver); |
238 | extern void usb_serial_deregister(struct usb_serial_driver *driver); | |
1da177e4 LT |
239 | extern void usb_serial_port_softint(void *private); |
240 | ||
241 | extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id); | |
242 | extern void usb_serial_disconnect(struct usb_interface *iface); | |
243 | ||
244 | extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest); | |
245 | extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit); | |
246 | ||
247 | /* USB Serial console functions */ | |
248 | #ifdef CONFIG_USB_SERIAL_CONSOLE | |
249 | extern void usb_serial_console_init (int debug, int minor); | |
250 | extern void usb_serial_console_exit (void); | |
251 | #else | |
252 | static inline void usb_serial_console_init (int debug, int minor) { } | |
253 | static inline void usb_serial_console_exit (void) { } | |
254 | #endif | |
255 | ||
256 | /* Functions needed by other parts of the usbserial core */ | |
257 | extern struct usb_serial *usb_serial_get_by_index (unsigned int minor); | |
258 | extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp); | |
259 | extern int usb_serial_generic_write (struct usb_serial_port *port, const unsigned char *buf, int count); | |
260 | extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp); | |
261 | extern int usb_serial_generic_write_room (struct usb_serial_port *port); | |
262 | extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port); | |
263 | extern void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs); | |
264 | extern void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs); | |
265 | extern void usb_serial_generic_shutdown (struct usb_serial *serial); | |
266 | extern int usb_serial_generic_register (int debug); | |
267 | extern void usb_serial_generic_deregister (void); | |
268 | ||
ea65370d GKH |
269 | extern int usb_serial_bus_register (struct usb_serial_driver *device); |
270 | extern void usb_serial_bus_deregister (struct usb_serial_driver *device); | |
1da177e4 | 271 | |
ea65370d | 272 | extern struct usb_serial_driver usb_serial_generic_device; |
1da177e4 LT |
273 | extern struct bus_type usb_serial_bus_type; |
274 | extern struct tty_driver *usb_serial_tty_driver; | |
275 | ||
276 | static inline void usb_serial_debug_data(int debug, | |
277 | struct device *dev, | |
278 | const char *function, int size, | |
279 | const unsigned char *data) | |
280 | { | |
281 | int i; | |
282 | ||
283 | if (debug) { | |
284 | dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", function, size); | |
285 | for (i = 0; i < size; ++i) | |
286 | printk ("%.2x ", data[i]); | |
287 | printk ("\n"); | |
288 | } | |
289 | } | |
290 | ||
291 | /* Use our own dbg macro */ | |
292 | #undef dbg | |
293 | #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0) | |
294 | ||
295 | ||
296 | ||
297 | #endif /* ifdef __LINUX_USB_SERIAL_H */ | |
298 |