2 * USB Serial Converter stuff
4 * Copyright (C) 1999 - 2005
5 * Greg Kroah-Hartman (greg@kroah.com)
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
9 * the Free Software Foundation; version 2 of the License.
13 #ifndef __LINUX_USB_SERIAL_H
14 #define __LINUX_USB_SERIAL_H
16 #include <linux/kref.h>
17 #include <linux/mutex.h>
18 #include <linux/sysrq.h>
19 #include <linux/kfifo.h>
21 #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */
22 #define SERIAL_TTY_MINORS 254 /* loads of devices :) */
23 #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */
25 /* The maximum number of ports one device can grab at once */
26 #define MAX_NUM_PORTS 8
28 /* parity check flag */
29 #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
39 * usb_serial_port: structure for the specific ports of a device.
40 * @serial: pointer back to the struct usb_serial owner of this port.
41 * @port: pointer to the corresponding tty_port for this port.
42 * @lock: spinlock to grab when updating portions of this structure.
43 * @number: the number of the port (the minor number).
44 * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
45 * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
46 * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
48 * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
49 * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
50 * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
51 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
53 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
54 * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
55 * @read_urb: pointer to the bulk in struct urb for this port.
56 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
58 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
59 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
60 * @write_urb: pointer to the bulk out struct urb for this port.
61 * @write_fifo: kfifo used to buffer outgoing data
62 * @write_urb_busy: port`s writing status
63 * @tx_bytes: number of bytes currently in host stack queues
64 * @tx_urbs: number of urbs currently in host stack queues
65 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
67 * @write_wait: a wait_queue_head_t used by the port.
68 * @work: work queue entry for the line discipline waking up.
69 * @throttled: nonzero if the read urb is inactive to throttle the device
70 * @throttle_req: nonzero if the tty wants to throttle us
71 * @dev: pointer to the serial device
73 * This structure is used by the usb-serial core and drivers for the specific
76 struct usb_serial_port {
77 struct usb_serial *serial;
82 unsigned char *interrupt_in_buffer;
83 struct urb *interrupt_in_urb;
84 __u8 interrupt_in_endpointAddress;
86 unsigned char *interrupt_out_buffer;
87 int interrupt_out_size;
88 struct urb *interrupt_out_urb;
89 __u8 interrupt_out_endpointAddress;
91 unsigned char *bulk_in_buffer;
94 __u8 bulk_in_endpointAddress;
96 unsigned char *bulk_out_buffer;
98 struct urb *write_urb;
99 struct kfifo write_fifo;
101 __u8 bulk_out_endpointAddress;
106 wait_queue_head_t write_wait;
107 struct work_struct work;
110 unsigned long sysrq; /* sysrq timeout */
112 enum port_dev_state dev_state;
114 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
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)
119 return dev_get_drvdata(&port->dev);
122 static inline void usb_set_serial_port_data(struct usb_serial_port *port,
125 dev_set_drvdata(&port->dev, data);
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 * @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.
146 struct usb_device *dev;
147 struct usb_serial_driver *type;
148 struct usb_interface *interface;
149 unsigned char disconnected:1;
150 unsigned char suspending:1;
151 unsigned char attached:1;
153 unsigned char num_ports;
154 unsigned char num_port_pointers;
155 char num_interrupt_in;
156 char num_interrupt_out;
159 struct usb_serial_port *port[MAX_NUM_PORTS];
161 struct mutex disc_mutex;
164 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
166 /* get and set the serial private data pointer helper functions */
167 static inline void *usb_get_serial_data(struct usb_serial *serial)
169 return serial->private;
172 static inline void usb_set_serial_data(struct usb_serial *serial, void *data)
174 serial->private = data;
178 * usb_serial_driver - describes a usb serial driver
179 * @description: pointer to a string that describes this driver. This string
180 * used in the syslog messages when a device is inserted or removed.
181 * @id_table: pointer to a list of usb_device_id structures that define all
182 * of the devices this structure can support.
183 * @num_ports: the number of different ports this device will have.
184 * @bulk_in_size: bytes to allocate for bulk-in buffer (0 = end-point size)
185 * @bulk_out_size: bytes to allocate for bulk-out buffer (0 = end-point size)
186 * @calc_num_ports: pointer to a function to determine how many ports this
187 * device has dynamically. It will be called after the probe()
188 * callback is called, but before attach()
189 * @probe: pointer to the driver's probe function.
190 * This will be called when the device is inserted into the system,
191 * but before the device has been fully initialized by the usb_serial
192 * subsystem. Use this function to download any firmware to the device,
193 * or any other early initialization that might be needed.
194 * Return 0 to continue on with the initialization sequence. Anything
195 * else will abort it.
196 * @attach: pointer to the driver's attach function.
197 * This will be called when the struct usb_serial structure is fully set
198 * set up. Do any local initialization of the device, or any private
199 * memory structure allocation at this point in time.
200 * @disconnect: pointer to the driver's disconnect function. This will be
201 * called when the device is unplugged or unbound from the driver.
202 * @release: pointer to the driver's release function. This will be called
203 * when the usb_serial data structure is about to be destroyed.
204 * @usb_driver: pointer to the struct usb_driver that controls this
205 * device. This is necessary to allow dynamic ids to be added to
206 * the driver from sysfs.
208 * This structure is defines a USB Serial driver. It provides all of
209 * the information that the USB serial core code needs. If the function
210 * pointers are defined, then the USB serial core code will call them when
211 * the corresponding tty port functions are called. If they are not
212 * called, the generic serial function will be used instead.
214 * The driver.owner field should be set to the module owner of this driver.
215 * The driver.name field should be set to the name of this driver (remember
216 * it will show up in sysfs, so it needs to be short and to the point.
217 * Using the module name is a good idea.)
219 struct usb_serial_driver {
220 const char *description;
221 const struct usb_device_id *id_table;
224 struct list_head driver_list;
225 struct device_driver driver;
226 struct usb_driver *usb_driver;
227 struct usb_dynids dynids;
229 unsigned char multi_urb_write:1;
232 size_t bulk_out_size;
234 int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
235 int (*attach)(struct usb_serial *serial);
236 int (*calc_num_ports) (struct usb_serial *serial);
238 void (*disconnect)(struct usb_serial *serial);
239 void (*release)(struct usb_serial *serial);
241 int (*port_probe)(struct usb_serial_port *port);
242 int (*port_remove)(struct usb_serial_port *port);
244 int (*suspend)(struct usb_serial *serial, pm_message_t message);
245 int (*resume)(struct usb_serial *serial);
247 /* serial function calls */
248 /* Called by console and by the tty layer */
249 int (*open)(struct tty_struct *tty, struct usb_serial_port *port);
250 void (*close)(struct usb_serial_port *port);
251 int (*write)(struct tty_struct *tty, struct usb_serial_port *port,
252 const unsigned char *buf, int count);
253 /* Called only by the tty layer */
254 int (*write_room)(struct tty_struct *tty);
255 int (*ioctl)(struct tty_struct *tty, struct file *file,
256 unsigned int cmd, unsigned long arg);
257 void (*set_termios)(struct tty_struct *tty,
258 struct usb_serial_port *port, struct ktermios *old);
259 void (*break_ctl)(struct tty_struct *tty, int break_state);
260 int (*chars_in_buffer)(struct tty_struct *tty);
261 void (*throttle)(struct tty_struct *tty);
262 void (*unthrottle)(struct tty_struct *tty);
263 int (*tiocmget)(struct tty_struct *tty, struct file *file);
264 int (*tiocmset)(struct tty_struct *tty, struct file *file,
265 unsigned int set, unsigned int clear);
266 /* Called by the tty layer for port level work. There may or may not
267 be an attached tty at this point */
268 void (*dtr_rts)(struct usb_serial_port *port, int on);
269 int (*carrier_raised)(struct usb_serial_port *port);
270 /* Called by the usb serial hooks to allow the user to rework the
272 void (*init_termios)(struct tty_struct *tty);
274 void (*read_int_callback)(struct urb *urb);
275 void (*write_int_callback)(struct urb *urb);
276 void (*read_bulk_callback)(struct urb *urb);
277 void (*write_bulk_callback)(struct urb *urb);
278 /* Called by the generic read bulk callback */
279 void (*process_read_urb)(struct urb *urb);
281 #define to_usb_serial_driver(d) \
282 container_of(d, struct usb_serial_driver, driver)
284 extern int usb_serial_register(struct usb_serial_driver *driver);
285 extern void usb_serial_deregister(struct usb_serial_driver *driver);
286 extern void usb_serial_port_softint(struct usb_serial_port *port);
288 extern int usb_serial_probe(struct usb_interface *iface,
289 const struct usb_device_id *id);
290 extern void usb_serial_disconnect(struct usb_interface *iface);
292 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
293 extern int usb_serial_resume(struct usb_interface *intf);
295 extern int ezusb_writememory(struct usb_serial *serial, int address,
296 unsigned char *data, int length, __u8 bRequest);
297 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
299 /* USB Serial console functions */
300 #ifdef CONFIG_USB_SERIAL_CONSOLE
301 extern void usb_serial_console_init(int debug, int minor);
302 extern void usb_serial_console_exit(void);
303 extern void usb_serial_console_disconnect(struct usb_serial *serial);
305 static inline void usb_serial_console_init(int debug, int minor) { }
306 static inline void usb_serial_console_exit(void) { }
307 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
310 /* Functions needed by other parts of the usbserial core */
311 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
312 extern void usb_serial_put(struct usb_serial *serial);
313 extern int usb_serial_generic_open(struct tty_struct *tty,
314 struct usb_serial_port *port);
315 extern int usb_serial_generic_write(struct tty_struct *tty,
316 struct usb_serial_port *port, const unsigned char *buf, int count);
317 extern void usb_serial_generic_close(struct usb_serial_port *port);
318 extern int usb_serial_generic_resume(struct usb_serial *serial);
319 extern int usb_serial_generic_write_room(struct tty_struct *tty);
320 extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
321 extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
322 extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
323 extern void usb_serial_generic_throttle(struct tty_struct *tty);
324 extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
325 extern void usb_serial_generic_disconnect(struct usb_serial *serial);
326 extern void usb_serial_generic_release(struct usb_serial *serial);
327 extern int usb_serial_generic_register(int debug);
328 extern void usb_serial_generic_deregister(void);
329 extern int usb_serial_generic_submit_read_urb(struct usb_serial_port *port,
331 extern void usb_serial_generic_process_read_urb(struct urb *urb);
332 extern int usb_serial_handle_sysrq_char(struct tty_struct *tty,
333 struct usb_serial_port *port,
335 extern int usb_serial_handle_break(struct usb_serial_port *port);
338 extern int usb_serial_bus_register(struct usb_serial_driver *device);
339 extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
341 extern struct usb_serial_driver usb_serial_generic_device;
342 extern struct bus_type usb_serial_bus_type;
343 extern struct tty_driver *usb_serial_tty_driver;
345 static inline void usb_serial_debug_data(int debug,
347 const char *function, int size,
348 const unsigned char *data)
353 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
355 for (i = 0; i < size; ++i)
356 printk("%.2x ", data[i]);
361 /* Use our own dbg macro */
363 #define dbg(format, arg...) \
366 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
369 #endif /* __LINUX_USB_SERIAL_H */