2 * USB Serial Converter driver
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; either version 2 of the License.
14 #ifndef __LINUX_USB_SERIAL_H
15 #define __LINUX_USB_SERIAL_H
17 #include <linux/config.h>
18 #include <linux/kref.h>
20 #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */
21 #define SERIAL_TTY_MINORS 255 /* loads of devices :) */
23 #define MAX_NUM_PORTS 8 /* The maximum number of ports one device can grab at once */
25 /* parity check flag */
26 #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
29 * usb_serial_port: structure for the specific ports of a device.
30 * @serial: pointer back to the struct usb_serial owner of this port.
31 * @tty: pointer to the corresponding tty for this port.
32 * @lock: spinlock to grab when updating portions of this structure.
33 * @number: the number of the port (the minor number).
34 * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
35 * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
36 * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
38 * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
39 * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
40 * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
41 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
43 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
44 * @read_urb: pointer to the bulk in struct urb for this port.
45 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
47 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
48 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
49 * @write_urb: pointer to the bulk out struct urb for this port.
50 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
52 * @write_wait: a wait_queue_head_t used by the port.
53 * @work: work queue entry for the line discipline waking up.
54 * @open_count: number of times this port has been opened.
56 * This structure is used by the usb-serial core and drivers for the specific
59 struct usb_serial_port {
60 struct usb_serial * serial;
61 struct tty_struct * tty;
65 unsigned char * interrupt_in_buffer;
66 struct urb * interrupt_in_urb;
67 __u8 interrupt_in_endpointAddress;
69 unsigned char * interrupt_out_buffer;
70 int interrupt_out_size;
71 struct urb * interrupt_out_urb;
72 __u8 interrupt_out_endpointAddress;
74 unsigned char * bulk_in_buffer;
76 struct urb * read_urb;
77 __u8 bulk_in_endpointAddress;
79 unsigned char * bulk_out_buffer;
81 struct urb * write_urb;
83 __u8 bulk_out_endpointAddress;
85 wait_queue_head_t write_wait;
86 struct work_struct work;
90 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
92 /* get and set the port private data pointer helper functions */
93 static inline void *usb_get_serial_port_data (struct usb_serial_port *port)
95 return dev_get_drvdata(&port->dev);
98 static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data)
100 dev_set_drvdata(&port->dev, data);
104 * usb_serial - structure used by the usb-serial core for a device
105 * @dev: pointer to the struct usb_device for this device
106 * @type: pointer to the struct usb_serial_driver for this device
107 * @interface: pointer to the struct usb_interface for this device
108 * @minor: the starting minor number for this device
109 * @num_ports: the number of ports this device has
110 * @num_interrupt_in: number of interrupt in endpoints we have
111 * @num_interrupt_out: number of interrupt out endpoints we have
112 * @num_bulk_in: number of bulk in endpoints we have
113 * @num_bulk_out: number of bulk out endpoints we have
114 * @port: array of struct usb_serial_port structures for the different ports.
115 * @private: place to put any driver specific information that is needed. The
116 * usb-serial driver is required to manage this data, the usb-serial core
117 * will not touch this. Use usb_get_serial_data() and
118 * usb_set_serial_data() to access this.
121 struct usb_device * dev;
122 struct usb_serial_driver * type;
123 struct usb_interface * interface;
125 unsigned char num_ports;
126 unsigned char num_port_pointers;
127 char num_interrupt_in;
128 char num_interrupt_out;
131 struct usb_serial_port * port[MAX_NUM_PORTS];
135 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
137 #define NUM_DONT_CARE (-1)
139 /* get and set the serial private data pointer helper functions */
140 static inline void *usb_get_serial_data (struct usb_serial *serial)
142 return serial->private;
145 static inline void usb_set_serial_data (struct usb_serial *serial, void *data)
147 serial->private = data;
151 * usb_serial_driver - describes a usb serial driver
152 * @name: pointer to a string that describes this driver. This string used
153 * in the syslog messages when a device is inserted or removed.
154 * @short_name: a pointer to a string that describes this driver in
155 * KOBJ_NAME_LEN characters or less. This is used for the sysfs interface
156 * to describe the driver.
157 * @id_table: pointer to a list of usb_device_id structures that define all
158 * of the devices this structure can support.
159 * @num_interrupt_in: the number of interrupt in endpoints this device will
161 * @num_interrupt_out: the number of interrupt out endpoints this device will
163 * @num_bulk_in: the number of bulk in endpoints this device will have.
164 * @num_bulk_out: the number of bulk out endpoints this device will have.
165 * @num_ports: the number of different ports this device will have.
166 * @calc_num_ports: pointer to a function to determine how many ports this
167 * device has dynamically. It will be called after the probe()
168 * callback is called, but before attach()
169 * @probe: pointer to the driver's probe function.
170 * This will be called when the device is inserted into the system,
171 * but before the device has been fully initialized by the usb_serial
172 * subsystem. Use this function to download any firmware to the device,
173 * or any other early initialization that might be needed.
174 * Return 0 to continue on with the initialization sequence. Anything
175 * else will abort it.
176 * @attach: pointer to the driver's attach function.
177 * This will be called when the struct usb_serial structure is fully set
178 * set up. Do any local initialization of the device, or any private
179 * memory structure allocation at this point in time.
180 * @shutdown: pointer to the driver's shutdown function. This will be
181 * called when the device is removed from the system.
183 * This structure is defines a USB Serial driver. It provides all of
184 * the information that the USB serial core code needs. If the function
185 * pointers are defined, then the USB serial core code will call them when
186 * the corresponding tty port functions are called. If they are not
187 * called, the generic serial function will be used instead.
189 * The driver.owner field should be set to the module owner of this driver.
192 struct usb_serial_driver {
195 const struct usb_device_id *id_table;
196 char num_interrupt_in;
197 char num_interrupt_out;
202 struct list_head driver_list;
203 struct device_driver driver;
205 int (*probe) (struct usb_serial *serial, const struct usb_device_id *id);
206 int (*attach) (struct usb_serial *serial);
207 int (*calc_num_ports) (struct usb_serial *serial);
209 void (*shutdown) (struct usb_serial *serial);
211 int (*port_probe) (struct usb_serial_port *port);
212 int (*port_remove) (struct usb_serial_port *port);
214 /* serial function calls */
215 int (*open) (struct usb_serial_port *port, struct file * filp);
216 void (*close) (struct usb_serial_port *port, struct file * filp);
217 int (*write) (struct usb_serial_port *port, const unsigned char *buf, int count);
218 int (*write_room) (struct usb_serial_port *port);
219 int (*ioctl) (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
220 void (*set_termios) (struct usb_serial_port *port, struct termios * old);
221 void (*break_ctl) (struct usb_serial_port *port, int break_state);
222 int (*chars_in_buffer) (struct usb_serial_port *port);
223 void (*throttle) (struct usb_serial_port *port);
224 void (*unthrottle) (struct usb_serial_port *port);
225 int (*tiocmget) (struct usb_serial_port *port, struct file *file);
226 int (*tiocmset) (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
228 void (*read_int_callback)(struct urb *urb, struct pt_regs *regs);
229 void (*write_int_callback)(struct urb *urb, struct pt_regs *regs);
230 void (*read_bulk_callback)(struct urb *urb, struct pt_regs *regs);
231 void (*write_bulk_callback)(struct urb *urb, struct pt_regs *regs);
233 #define to_usb_serial_driver(d) container_of(d, struct usb_serial_driver, driver)
235 extern int usb_serial_register(struct usb_serial_driver *driver);
236 extern void usb_serial_deregister(struct usb_serial_driver *driver);
237 extern void usb_serial_port_softint(void *private);
239 extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id);
240 extern void usb_serial_disconnect(struct usb_interface *iface);
242 extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest);
243 extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit);
245 /* USB Serial console functions */
246 #ifdef CONFIG_USB_SERIAL_CONSOLE
247 extern void usb_serial_console_init (int debug, int minor);
248 extern void usb_serial_console_exit (void);
250 static inline void usb_serial_console_init (int debug, int minor) { }
251 static inline void usb_serial_console_exit (void) { }
254 /* Functions needed by other parts of the usbserial core */
255 extern struct usb_serial *usb_serial_get_by_index (unsigned int minor);
256 extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp);
257 extern int usb_serial_generic_write (struct usb_serial_port *port, const unsigned char *buf, int count);
258 extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp);
259 extern int usb_serial_generic_write_room (struct usb_serial_port *port);
260 extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port);
261 extern void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
262 extern void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
263 extern void usb_serial_generic_shutdown (struct usb_serial *serial);
264 extern int usb_serial_generic_register (int debug);
265 extern void usb_serial_generic_deregister (void);
267 extern int usb_serial_bus_register (struct usb_serial_driver *device);
268 extern void usb_serial_bus_deregister (struct usb_serial_driver *device);
270 extern struct usb_serial_driver usb_serial_generic_device;
271 extern struct bus_type usb_serial_bus_type;
272 extern struct tty_driver *usb_serial_tty_driver;
274 static inline void usb_serial_debug_data(int debug,
276 const char *function, int size,
277 const unsigned char *data)
282 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", function, size);
283 for (i = 0; i < size; ++i)
284 printk ("%.2x ", data[i]);
289 /* Use our own dbg macro */
291 #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0)
295 #endif /* ifdef __LINUX_USB_SERIAL_H */