acf6e457c04b17c695b701febae74415812c5671
[pandora-kernel.git] / include / linux / usb / serial.h
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
30 enum 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  * @number: the number of the port (the minor number).
43  * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
44  * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
45  * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
46  *      for this port.
47  * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
48  * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
49  * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
50  * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
51  *      for this port.
52  * @bulk_in_buffer: pointer to the bulk in buffer for this port.
53  * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
54  * @read_urb: pointer to the bulk in struct urb for this port.
55  * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
56  *      port.
57  * @bulk_out_buffer: pointer to the bulk out buffer for this port.
58  * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
59  * @write_urb: pointer to the bulk out struct urb for this port.
60  * @write_fifo: kfifo used to buffer outgoing data
61  * @write_urb_busy: port`s writing status
62  * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
63  *      port.
64  * @write_wait: a wait_queue_head_t used by the port.
65  * @work: work queue entry for the line discipline waking up.
66  * @throttled: nonzero if the read urb is inactive to throttle the device
67  * @throttle_req: nonzero if the tty wants to throttle us
68  * @console: attached usb serial console
69  * @dev: pointer to the serial device
70  *
71  * This structure is used by the usb-serial core and drivers for the specific
72  * ports of a device.
73  */
74 struct usb_serial_port {
75         struct usb_serial       *serial;
76         struct tty_port         port;
77         spinlock_t              lock;
78         unsigned char           number;
79
80         unsigned char           *interrupt_in_buffer;
81         struct urb              *interrupt_in_urb;
82         __u8                    interrupt_in_endpointAddress;
83
84         unsigned char           *interrupt_out_buffer;
85         int                     interrupt_out_size;
86         struct urb              *interrupt_out_urb;
87         __u8                    interrupt_out_endpointAddress;
88
89         unsigned char           *bulk_in_buffer;
90         int                     bulk_in_size;
91         struct urb              *read_urb;
92         __u8                    bulk_in_endpointAddress;
93
94         unsigned char           *bulk_out_buffer;
95         int                     bulk_out_size;
96         struct urb              *write_urb;
97         struct kfifo            *write_fifo;
98         int                     write_urb_busy;
99         __u8                    bulk_out_endpointAddress;
100
101         int                     tx_bytes_flight;
102         int                     urbs_in_flight;
103
104         wait_queue_head_t       write_wait;
105         struct work_struct      work;
106         char                    throttled;
107         char                    throttle_req;
108         char                    console;
109         unsigned long           sysrq; /* sysrq timeout */
110         struct device           dev;
111         enum port_dev_state     dev_state;
112 };
113 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
114
115 /* get and set the port private data pointer helper functions */
116 static inline void *usb_get_serial_port_data(struct usb_serial_port *port)
117 {
118         return dev_get_drvdata(&port->dev);
119 }
120
121 static inline void usb_set_serial_port_data(struct usb_serial_port *port,
122                                             void *data)
123 {
124         dev_set_drvdata(&port->dev, data);
125 }
126
127 /**
128  * usb_serial - structure used by the usb-serial core for a device
129  * @dev: pointer to the struct usb_device for this device
130  * @type: pointer to the struct usb_serial_driver for this device
131  * @interface: pointer to the struct usb_interface for this device
132  * @minor: the starting minor number for this device
133  * @num_ports: the number of ports this device has
134  * @num_interrupt_in: number of interrupt in endpoints we have
135  * @num_interrupt_out: number of interrupt out endpoints we have
136  * @num_bulk_in: number of bulk in endpoints we have
137  * @num_bulk_out: number of bulk out endpoints we have
138  * @port: array of struct usb_serial_port structures for the different ports.
139  * @private: place to put any driver specific information that is needed.  The
140  *      usb-serial driver is required to manage this data, the usb-serial core
141  *      will not touch this.  Use usb_get_serial_data() and
142  *      usb_set_serial_data() to access this.
143  */
144 struct usb_serial {
145         struct usb_device               *dev;
146         struct usb_serial_driver        *type;
147         struct usb_interface            *interface;
148         unsigned char                   disconnected:1;
149         unsigned char                   suspending:1;
150         unsigned char                   attached: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 */
166 static inline void *usb_get_serial_data(struct usb_serial *serial)
167 {
168         return serial->private;
169 }
170
171 static 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  */
216 struct 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 and by the tty layer */
242         int  (*open)(struct tty_struct *tty, struct usb_serial_port *port);
243         void (*close)(struct usb_serial_port *port);
244         int  (*write)(struct tty_struct *tty, struct usb_serial_port *port,
245                         const unsigned char *buf, int count);
246         /* Called only by the tty layer */
247         int  (*write_room)(struct tty_struct *tty);
248         int  (*ioctl)(struct tty_struct *tty, struct file *file,
249                       unsigned int cmd, unsigned long arg);
250         void (*set_termios)(struct tty_struct *tty,
251                         struct usb_serial_port *port, struct ktermios *old);
252         void (*break_ctl)(struct tty_struct *tty, int break_state);
253         int  (*chars_in_buffer)(struct tty_struct *tty);
254         void (*throttle)(struct tty_struct *tty);
255         void (*unthrottle)(struct tty_struct *tty);
256         int  (*tiocmget)(struct tty_struct *tty, struct file *file);
257         int  (*tiocmset)(struct tty_struct *tty, struct file *file,
258                          unsigned int set, unsigned int clear);
259         /* Called by the tty layer for port level work. There may or may not
260            be an attached tty at this point */
261         void (*dtr_rts)(struct usb_serial_port *port, int on);
262         int  (*carrier_raised)(struct usb_serial_port *port);
263         /* Called by the usb serial hooks to allow the user to rework the
264            termios state */
265         void (*init_termios)(struct tty_struct *tty);
266         /* USB events */
267         void (*read_int_callback)(struct urb *urb);
268         void (*write_int_callback)(struct urb *urb);
269         void (*read_bulk_callback)(struct urb *urb);
270         void (*write_bulk_callback)(struct urb *urb);
271 };
272 #define to_usb_serial_driver(d) \
273         container_of(d, struct usb_serial_driver, driver)
274
275 extern int  usb_serial_register(struct usb_serial_driver *driver);
276 extern void usb_serial_deregister(struct usb_serial_driver *driver);
277 extern void usb_serial_port_softint(struct usb_serial_port *port);
278
279 extern int usb_serial_probe(struct usb_interface *iface,
280                             const struct usb_device_id *id);
281 extern void usb_serial_disconnect(struct usb_interface *iface);
282
283 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
284 extern int usb_serial_resume(struct usb_interface *intf);
285
286 extern int ezusb_writememory(struct usb_serial *serial, int address,
287                              unsigned char *data, int length, __u8 bRequest);
288 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
289
290 /* USB Serial console functions */
291 #ifdef CONFIG_USB_SERIAL_CONSOLE
292 extern void usb_serial_console_init(int debug, int minor);
293 extern void usb_serial_console_exit(void);
294 extern void usb_serial_console_disconnect(struct usb_serial *serial);
295 #else
296 static inline void usb_serial_console_init(int debug, int minor) { }
297 static inline void usb_serial_console_exit(void) { }
298 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
299 #endif
300
301 /* Functions needed by other parts of the usbserial core */
302 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
303 extern void usb_serial_put(struct usb_serial *serial);
304 extern int usb_serial_generic_open(struct tty_struct *tty,
305         struct usb_serial_port *port);
306 extern int usb_serial_generic_write(struct tty_struct *tty,
307         struct usb_serial_port *port, const unsigned char *buf, int count);
308 extern void usb_serial_generic_close(struct usb_serial_port *port);
309 extern int usb_serial_generic_resume(struct usb_serial *serial);
310 extern int usb_serial_generic_write_room(struct tty_struct *tty);
311 extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
312 extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
313 extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
314 extern void usb_serial_generic_throttle(struct tty_struct *tty);
315 extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
316 extern void usb_serial_generic_disconnect(struct usb_serial *serial);
317 extern void usb_serial_generic_release(struct usb_serial *serial);
318 extern int usb_serial_generic_register(int debug);
319 extern void usb_serial_generic_deregister(void);
320 extern void usb_serial_generic_resubmit_read_urb(struct usb_serial_port *port,
321                                                  gfp_t mem_flags);
322 extern int usb_serial_handle_sysrq_char(struct tty_struct *tty,
323                                         struct usb_serial_port *port,
324                                         unsigned int ch);
325 extern int usb_serial_handle_break(struct usb_serial_port *port);
326
327
328 extern int usb_serial_bus_register(struct usb_serial_driver *device);
329 extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
330
331 extern struct usb_serial_driver usb_serial_generic_device;
332 extern struct bus_type usb_serial_bus_type;
333 extern struct tty_driver *usb_serial_tty_driver;
334
335 static inline void usb_serial_debug_data(int debug,
336                                          struct device *dev,
337                                          const char *function, int size,
338                                          const unsigned char *data)
339 {
340         int i;
341
342         if (debug) {
343                 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
344                            function, size);
345                 for (i = 0; i < size; ++i)
346                         printk("%.2x ", data[i]);
347                 printk("\n");
348         }
349 }
350
351 /* Use our own dbg macro */
352 #undef dbg
353 #define dbg(format, arg...) \
354         do { \
355                 if (debug) \
356                         printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \
357                                 ## arg); \
358         } while (0)
359
360
361
362 #endif /* __LINUX_USB_SERIAL_H */
363