Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * USB Serial Converter stuff
3 *
4 * Copyright (C) 1999 - 2005
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
9 * the Free Software Foundation; version 2 of the License.
10 *
11 */
12
13#ifndef __LINUX_USB_SERIAL_H
14#define __LINUX_USB_SERIAL_H
15
16#include <linux/kref.h>
17#include <linux/mutex.h>
18#include <linux/sysrq.h>
19
20#define SERIAL_TTY_MAJOR 188 /* Nice legal number now */
21#define SERIAL_TTY_MINORS 254 /* loads of devices :) */
22#define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */
23
24/* The maximum number of ports one device can grab at once */
25#define MAX_NUM_PORTS 8
26
27/* parity check flag */
28#define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
29
30enum port_dev_state {
31 PORT_UNREGISTERED,
32 PORT_REGISTERING,
33 PORT_REGISTERED,
34 PORT_UNREGISTERING,
35};
36
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.
40 * @port: pointer to the corresponding tty_port for this port.
41 * @lock: spinlock to grab when updating portions of this structure.
42 * @mutex: mutex used to synchronize serial_open() and serial_close()
43 * access for this port.
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.
55 * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
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.
62 * @write_urb_busy: port`s writing status
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.
67 * @throttled: nonzero if the read urb is inactive to throttle the device
68 * @throttle_req: nonzero if the tty wants to throttle us
69 * @console: attached usb serial console
70 * @dev: pointer to the serial device
71 *
72 * This structure is used by the usb-serial core and drivers for the specific
73 * ports of a device.
74 */
75struct usb_serial_port {
76 struct usb_serial *serial;
77 struct tty_port port;
78 spinlock_t lock;
79 struct mutex mutex;
80 unsigned char number;
81
82 unsigned char *interrupt_in_buffer;
83 struct urb *interrupt_in_urb;
84 __u8 interrupt_in_endpointAddress;
85
86 unsigned char *interrupt_out_buffer;
87 int interrupt_out_size;
88 struct urb *interrupt_out_urb;
89 __u8 interrupt_out_endpointAddress;
90
91 unsigned char *bulk_in_buffer;
92 int bulk_in_size;
93 struct urb *read_urb;
94 __u8 bulk_in_endpointAddress;
95
96 unsigned char *bulk_out_buffer;
97 int bulk_out_size;
98 struct urb *write_urb;
99 int write_urb_busy;
100 __u8 bulk_out_endpointAddress;
101
102 int tx_bytes_flight;
103 int urbs_in_flight;
104
105 wait_queue_head_t write_wait;
106 struct work_struct work;
107 char throttled;
108 char throttle_req;
109 char console;
110 unsigned long sysrq; /* sysrq timeout */
111 struct device dev;
112 enum port_dev_state dev_state;
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 */
117static inline void *usb_get_serial_port_data(struct usb_serial_port *port)
118{
119 return dev_get_drvdata(&port->dev);
120}
121
122static inline void usb_set_serial_port_data(struct usb_serial_port *port,
123 void *data)
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
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.
144 */
145struct usb_serial {
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 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;
158 struct usb_serial_port *port[MAX_NUM_PORTS];
159 struct kref kref;
160 struct mutex disc_mutex;
161 void *private;
162};
163#define to_usb_serial(d) container_of(d, struct usb_serial, kref)
164
165/* get and set the serial private data pointer helper functions */
166static inline void *usb_get_serial_data(struct usb_serial *serial)
167{
168 return serial->private;
169}
170
171static inline void usb_set_serial_data(struct usb_serial *serial, void *data)
172{
173 serial->private = data;
174}
175
176/**
177 * usb_serial_driver - describes a usb serial driver
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.
180 * @id_table: pointer to a list of usb_device_id structures that define all
181 * of the devices this structure can support.
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.
191 * Return 0 to continue on with the initialization sequence. Anything
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.
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.
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.
204 *
205 * This structure is defines a USB Serial driver. It provides all of
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.
210 *
211 * The driver.owner field should be set to the module owner of this driver.
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.
214 * Using the module name is a good idea.)
215 */
216struct usb_serial_driver {
217 const char *description;
218 const struct usb_device_id *id_table;
219 char num_ports;
220
221 struct list_head driver_list;
222 struct device_driver driver;
223 struct usb_driver *usb_driver;
224 struct usb_dynids dynids;
225 int max_in_flight_urbs;
226
227 int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
228 int (*attach)(struct usb_serial *serial);
229 int (*calc_num_ports) (struct usb_serial *serial);
230
231 void (*disconnect)(struct usb_serial *serial);
232 void (*release)(struct usb_serial *serial);
233
234 int (*port_probe)(struct usb_serial_port *port);
235 int (*port_remove)(struct usb_serial_port *port);
236
237 int (*suspend)(struct usb_serial *serial, pm_message_t message);
238 int (*resume)(struct usb_serial *serial);
239
240 /* serial function calls */
241 /* Called by console with tty = NULL and by tty */
242 int (*open)(struct tty_struct *tty,
243 struct usb_serial_port *port, struct file *filp);
244 void (*close)(struct usb_serial_port *port);
245 int (*write)(struct tty_struct *tty, struct usb_serial_port *port,
246 const unsigned char *buf, int count);
247 /* Called only by the tty layer */
248 int (*write_room)(struct tty_struct *tty);
249 int (*ioctl)(struct tty_struct *tty, struct file *file,
250 unsigned int cmd, unsigned long arg);
251 void (*set_termios)(struct tty_struct *tty,
252 struct usb_serial_port *port, struct ktermios *old);
253 void (*break_ctl)(struct tty_struct *tty, int break_state);
254 int (*chars_in_buffer)(struct tty_struct *tty);
255 void (*throttle)(struct tty_struct *tty);
256 void (*unthrottle)(struct tty_struct *tty);
257 int (*tiocmget)(struct tty_struct *tty, struct file *file);
258 int (*tiocmset)(struct tty_struct *tty, struct file *file,
259 unsigned int set, unsigned int clear);
260 /* Called by the tty layer for port level work. There may or may not
261 be an attached tty at this point */
262 void (*dtr_rts)(struct usb_serial_port *port, int on);
263 int (*carrier_raised)(struct usb_serial_port *port);
264 /* USB events */
265 void (*read_int_callback)(struct urb *urb);
266 void (*write_int_callback)(struct urb *urb);
267 void (*read_bulk_callback)(struct urb *urb);
268 void (*write_bulk_callback)(struct urb *urb);
269};
270#define to_usb_serial_driver(d) \
271 container_of(d, struct usb_serial_driver, driver)
272
273extern int usb_serial_register(struct usb_serial_driver *driver);
274extern void usb_serial_deregister(struct usb_serial_driver *driver);
275extern void usb_serial_port_softint(struct usb_serial_port *port);
276
277extern int usb_serial_probe(struct usb_interface *iface,
278 const struct usb_device_id *id);
279extern void usb_serial_disconnect(struct usb_interface *iface);
280
281extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
282extern int usb_serial_resume(struct usb_interface *intf);
283
284extern int ezusb_writememory(struct usb_serial *serial, int address,
285 unsigned char *data, int length, __u8 bRequest);
286extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
287
288/* USB Serial console functions */
289#ifdef CONFIG_USB_SERIAL_CONSOLE
290extern void usb_serial_console_init(int debug, int minor);
291extern void usb_serial_console_exit(void);
292extern void usb_serial_console_disconnect(struct usb_serial *serial);
293#else
294static inline void usb_serial_console_init(int debug, int minor) { }
295static inline void usb_serial_console_exit(void) { }
296static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
297#endif
298
299/* Functions needed by other parts of the usbserial core */
300extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
301extern void usb_serial_put(struct usb_serial *serial);
302extern int usb_serial_generic_open(struct tty_struct *tty,
303 struct usb_serial_port *port, struct file *filp);
304extern int usb_serial_generic_write(struct tty_struct *tty,
305 struct usb_serial_port *port, const unsigned char *buf, int count);
306extern void usb_serial_generic_close(struct usb_serial_port *port);
307extern int usb_serial_generic_resume(struct usb_serial *serial);
308extern int usb_serial_generic_write_room(struct tty_struct *tty);
309extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
310extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
311extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
312extern void usb_serial_generic_throttle(struct tty_struct *tty);
313extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
314extern void usb_serial_generic_disconnect(struct usb_serial *serial);
315extern void usb_serial_generic_release(struct usb_serial *serial);
316extern int usb_serial_generic_register(int debug);
317extern void usb_serial_generic_deregister(void);
318extern void usb_serial_generic_resubmit_read_urb(struct usb_serial_port *port,
319 gfp_t mem_flags);
320extern int usb_serial_handle_sysrq_char(struct tty_struct *tty,
321 struct usb_serial_port *port,
322 unsigned int ch);
323extern int usb_serial_handle_break(struct usb_serial_port *port);
324
325
326extern int usb_serial_bus_register(struct usb_serial_driver *device);
327extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
328
329extern struct usb_serial_driver usb_serial_generic_device;
330extern struct bus_type usb_serial_bus_type;
331extern struct tty_driver *usb_serial_tty_driver;
332
333static inline void usb_serial_debug_data(int debug,
334 struct device *dev,
335 const char *function, int size,
336 const unsigned char *data)
337{
338 int i;
339
340 if (debug) {
341 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
342 function, size);
343 for (i = 0; i < size; ++i)
344 printk("%.2x ", data[i]);
345 printk("\n");
346 }
347}
348
349/* Use our own dbg macro */
350#undef dbg
351#define dbg(format, arg...) \
352 do { \
353 if (debug) \
354 printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \
355 ## arg); \
356 } while (0)
357
358
359
360#endif /* __LINUX_USB_SERIAL_H */
361