2 * USB Serial Converter stuff
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; version 2 of the License.
13 #ifndef __LINUX_USB_SERIAL_H
14 #define __LINUX_USB_SERIAL_H
16 #include <linux/kref.h>
17 #include <linux/mutex.h>
19 #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */
20 #define SERIAL_TTY_MINORS 254 /* loads of devices :) */
21 #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */
23 /* The maximum number of ports one device can grab at once */
24 #define MAX_NUM_PORTS 8
26 /* parity check flag */
27 #define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
30 * usb_serial_port: structure for the specific ports of a device.
31 * @serial: pointer back to the struct usb_serial owner of this port.
32 * @port: pointer to the corresponding tty_port for this port.
33 * @lock: spinlock to grab when updating portions of this structure.
34 * @mutex: mutex used to synchronize serial_open() and serial_close()
35 * access for this port.
36 * @number: the number of the port (the minor number).
37 * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
38 * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
39 * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
41 * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
42 * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
43 * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
44 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
46 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
47 * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
48 * @read_urb: pointer to the bulk in struct urb for this port.
49 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
51 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
52 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
53 * @write_urb: pointer to the bulk out struct urb for this port.
54 * @write_urb_busy: port`s writing status
55 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
57 * @write_wait: a wait_queue_head_t used by the port.
58 * @work: work queue entry for the line discipline waking up.
59 * @throttled: nonzero if the read urb is inactive to throttle the device
60 * @throttle_req: nonzero if the tty wants to throttle us
61 * @console: attached usb serial console
62 * @dev: pointer to the serial device
64 * This structure is used by the usb-serial core and drivers for the specific
67 struct usb_serial_port
{
68 struct usb_serial
*serial
;
74 unsigned char *interrupt_in_buffer
;
75 struct urb
*interrupt_in_urb
;
76 __u8 interrupt_in_endpointAddress
;
78 unsigned char *interrupt_out_buffer
;
79 int interrupt_out_size
;
80 struct urb
*interrupt_out_urb
;
81 __u8 interrupt_out_endpointAddress
;
83 unsigned char *bulk_in_buffer
;
86 __u8 bulk_in_endpointAddress
;
88 unsigned char *bulk_out_buffer
;
90 struct urb
*write_urb
;
92 __u8 bulk_out_endpointAddress
;
94 wait_queue_head_t write_wait
;
95 struct work_struct work
;
101 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
103 /* get and set the port private data pointer helper functions */
104 static inline void *usb_get_serial_port_data(struct usb_serial_port
*port
)
106 return dev_get_drvdata(&port
->dev
);
109 static inline void usb_set_serial_port_data(struct usb_serial_port
*port
,
112 dev_set_drvdata(&port
->dev
, data
);
116 * usb_serial - structure used by the usb-serial core for a device
117 * @dev: pointer to the struct usb_device for this device
118 * @type: pointer to the struct usb_serial_driver for this device
119 * @interface: pointer to the struct usb_interface for this device
120 * @minor: the starting minor number for this device
121 * @num_ports: the number of ports this device has
122 * @num_interrupt_in: number of interrupt in endpoints we have
123 * @num_interrupt_out: number of interrupt out endpoints we have
124 * @num_bulk_in: number of bulk in endpoints we have
125 * @num_bulk_out: number of bulk out endpoints we have
126 * @port: array of struct usb_serial_port structures for the different ports.
127 * @private: place to put any driver specific information that is needed. The
128 * usb-serial driver is required to manage this data, the usb-serial core
129 * will not touch this. Use usb_get_serial_data() and
130 * usb_set_serial_data() to access this.
133 struct usb_device
*dev
;
134 struct usb_serial_driver
*type
;
135 struct usb_interface
*interface
;
136 unsigned char disconnected
:1;
137 unsigned char suspending
:1;
139 unsigned char num_ports
;
140 unsigned char num_port_pointers
;
141 char num_interrupt_in
;
142 char num_interrupt_out
;
145 struct usb_serial_port
*port
[MAX_NUM_PORTS
];
147 struct mutex disc_mutex
;
150 #define to_usb_serial(d) container_of(d, struct usb_serial, kref)
152 /* get and set the serial private data pointer helper functions */
153 static inline void *usb_get_serial_data(struct usb_serial
*serial
)
155 return serial
->private;
158 static inline void usb_set_serial_data(struct usb_serial
*serial
, void *data
)
160 serial
->private = data
;
164 * usb_serial_driver - describes a usb serial driver
165 * @description: pointer to a string that describes this driver. This string
166 * used in the syslog messages when a device is inserted or removed.
167 * @id_table: pointer to a list of usb_device_id structures that define all
168 * of the devices this structure can support.
169 * @num_ports: the number of different ports this device will have.
170 * @calc_num_ports: pointer to a function to determine how many ports this
171 * device has dynamically. It will be called after the probe()
172 * callback is called, but before attach()
173 * @probe: pointer to the driver's probe function.
174 * This will be called when the device is inserted into the system,
175 * but before the device has been fully initialized by the usb_serial
176 * subsystem. Use this function to download any firmware to the device,
177 * or any other early initialization that might be needed.
178 * Return 0 to continue on with the initialization sequence. Anything
179 * else will abort it.
180 * @attach: pointer to the driver's attach function.
181 * This will be called when the struct usb_serial structure is fully set
182 * set up. Do any local initialization of the device, or any private
183 * memory structure allocation at this point in time.
184 * @shutdown: pointer to the driver's shutdown function. This will be
185 * called when the device is removed from the system.
186 * @usb_driver: pointer to the struct usb_driver that controls this
187 * device. This is necessary to allow dynamic ids to be added to
188 * the driver from sysfs.
190 * This structure is defines a USB Serial driver. It provides all of
191 * the information that the USB serial core code needs. If the function
192 * pointers are defined, then the USB serial core code will call them when
193 * the corresponding tty port functions are called. If they are not
194 * called, the generic serial function will be used instead.
196 * The driver.owner field should be set to the module owner of this driver.
197 * The driver.name field should be set to the name of this driver (remember
198 * it will show up in sysfs, so it needs to be short and to the point.
199 * Using the module name is a good idea.)
201 struct usb_serial_driver
{
202 const char *description
;
203 const struct usb_device_id
*id_table
;
206 struct list_head driver_list
;
207 struct device_driver driver
;
208 struct usb_driver
*usb_driver
;
209 struct usb_dynids dynids
;
211 int (*probe
)(struct usb_serial
*serial
, const struct usb_device_id
*id
);
212 int (*attach
)(struct usb_serial
*serial
);
213 int (*calc_num_ports
) (struct usb_serial
*serial
);
215 void (*shutdown
)(struct usb_serial
*serial
);
217 int (*port_probe
)(struct usb_serial_port
*port
);
218 int (*port_remove
)(struct usb_serial_port
*port
);
220 int (*suspend
)(struct usb_serial
*serial
, pm_message_t message
);
221 int (*resume
)(struct usb_serial
*serial
);
223 /* serial function calls */
224 /* Called by console with tty = NULL and by tty */
225 int (*open
)(struct tty_struct
*tty
,
226 struct usb_serial_port
*port
, struct file
*filp
);
227 void (*close
)(struct usb_serial_port
*port
);
228 int (*write
)(struct tty_struct
*tty
, struct usb_serial_port
*port
,
229 const unsigned char *buf
, int count
);
230 /* Called only by the tty layer */
231 int (*write_room
)(struct tty_struct
*tty
);
232 int (*ioctl
)(struct tty_struct
*tty
, struct file
*file
,
233 unsigned int cmd
, unsigned long arg
);
234 void (*set_termios
)(struct tty_struct
*tty
,
235 struct usb_serial_port
*port
, struct ktermios
*old
);
236 void (*break_ctl
)(struct tty_struct
*tty
, int break_state
);
237 int (*chars_in_buffer
)(struct tty_struct
*tty
);
238 void (*throttle
)(struct tty_struct
*tty
);
239 void (*unthrottle
)(struct tty_struct
*tty
);
240 int (*tiocmget
)(struct tty_struct
*tty
, struct file
*file
);
241 int (*tiocmset
)(struct tty_struct
*tty
, struct file
*file
,
242 unsigned int set
, unsigned int clear
);
243 /* Called by the tty layer for port level work. There may or may not
244 be an attached tty at this point */
245 void (*dtr_rts
)(struct usb_serial_port
*port
, int on
);
246 int (*carrier_raised
)(struct usb_serial_port
*port
);
248 void (*read_int_callback
)(struct urb
*urb
);
249 void (*write_int_callback
)(struct urb
*urb
);
250 void (*read_bulk_callback
)(struct urb
*urb
);
251 void (*write_bulk_callback
)(struct urb
*urb
);
253 #define to_usb_serial_driver(d) \
254 container_of(d, struct usb_serial_driver, driver)
256 extern int usb_serial_register(struct usb_serial_driver
*driver
);
257 extern void usb_serial_deregister(struct usb_serial_driver
*driver
);
258 extern void usb_serial_port_softint(struct usb_serial_port
*port
);
260 extern int usb_serial_probe(struct usb_interface
*iface
,
261 const struct usb_device_id
*id
);
262 extern void usb_serial_disconnect(struct usb_interface
*iface
);
264 extern int usb_serial_suspend(struct usb_interface
*intf
, pm_message_t message
);
265 extern int usb_serial_resume(struct usb_interface
*intf
);
267 extern int ezusb_writememory(struct usb_serial
*serial
, int address
,
268 unsigned char *data
, int length
, __u8 bRequest
);
269 extern int ezusb_set_reset(struct usb_serial
*serial
, unsigned char reset_bit
);
271 /* USB Serial console functions */
272 #ifdef CONFIG_USB_SERIAL_CONSOLE
273 extern void usb_serial_console_init(int debug
, int minor
);
274 extern void usb_serial_console_exit(void);
275 extern void usb_serial_console_disconnect(struct usb_serial
*serial
);
277 static inline void usb_serial_console_init(int debug
, int minor
) { }
278 static inline void usb_serial_console_exit(void) { }
279 static inline void usb_serial_console_disconnect(struct usb_serial
*serial
) {}
282 /* Functions needed by other parts of the usbserial core */
283 extern struct usb_serial
*usb_serial_get_by_index(unsigned int minor
);
284 extern void usb_serial_put(struct usb_serial
*serial
);
285 extern int usb_serial_generic_open(struct tty_struct
*tty
,
286 struct usb_serial_port
*port
, struct file
*filp
);
287 extern int usb_serial_generic_write(struct tty_struct
*tty
,
288 struct usb_serial_port
*port
, const unsigned char *buf
, int count
);
289 extern void usb_serial_generic_close(struct usb_serial_port
*port
);
290 extern int usb_serial_generic_resume(struct usb_serial
*serial
);
291 extern int usb_serial_generic_write_room(struct tty_struct
*tty
);
292 extern int usb_serial_generic_chars_in_buffer(struct tty_struct
*tty
);
293 extern void usb_serial_generic_read_bulk_callback(struct urb
*urb
);
294 extern void usb_serial_generic_write_bulk_callback(struct urb
*urb
);
295 extern void usb_serial_generic_throttle(struct tty_struct
*tty
);
296 extern void usb_serial_generic_unthrottle(struct tty_struct
*tty
);
297 extern void usb_serial_generic_shutdown(struct usb_serial
*serial
);
298 extern int usb_serial_generic_register(int debug
);
299 extern void usb_serial_generic_deregister(void);
301 extern int usb_serial_bus_register(struct usb_serial_driver
*device
);
302 extern void usb_serial_bus_deregister(struct usb_serial_driver
*device
);
304 extern struct usb_serial_driver usb_serial_generic_device
;
305 extern struct bus_type usb_serial_bus_type
;
306 extern struct tty_driver
*usb_serial_tty_driver
;
308 static inline void usb_serial_debug_data(int debug
,
310 const char *function
, int size
,
311 const unsigned char *data
)
316 dev_printk(KERN_DEBUG
, dev
, "%s - length = %d, data = ",
318 for (i
= 0; i
< size
; ++i
)
319 printk("%.2x ", data
[i
]);
324 /* Use our own dbg macro */
326 #define dbg(format, arg...) \
329 printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \
335 #endif /* __LINUX_USB_SERIAL_H */