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