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