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 14 #ifndef __LINUX_USB_SERIAL_H 15 #define __LINUX_USB_SERIAL_H 16 17 #include <linux/kref.h> 18 #include <linux/mutex.h> 19 20 #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ 21 #define SERIAL_TTY_MINORS 255 /* loads of devices :) */ 22 23 #define MAX_NUM_PORTS 8 /* The maximum number of ports one device can grab at once */ 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. 32 * @lock: spinlock to grab when updating portions of this structure. 33 * @mutex: mutex used to synchronize serial_open() and serial_close() 34 * access for this port. 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. 57 * @throttled: nonzero if the read urb is inactive to throttle the device 58 * @throttle_req: nonzero if the tty wants to throttle us 59 * 60 * This structure is used by the usb-serial core and drivers for the specific 61 * ports of a device. 62 */ 63 struct usb_serial_port { 64 struct usb_serial * serial; 65 struct tty_struct * tty; 66 spinlock_t lock; 67 struct mutex mutex; 68 unsigned char number; 69 70 unsigned char * interrupt_in_buffer; 71 struct urb * interrupt_in_urb; 72 __u8 interrupt_in_endpointAddress; 73 74 unsigned char * interrupt_out_buffer; 75 int interrupt_out_size; 76 struct urb * interrupt_out_urb; 77 __u8 interrupt_out_endpointAddress; 78 79 unsigned char * bulk_in_buffer; 80 int bulk_in_size; 81 struct urb * read_urb; 82 __u8 bulk_in_endpointAddress; 83 84 unsigned char * bulk_out_buffer; 85 int bulk_out_size; 86 struct urb * write_urb; 87 int write_urb_busy; 88 __u8 bulk_out_endpointAddress; 89 90 wait_queue_head_t write_wait; 91 struct work_struct work; 92 int open_count; 93 char throttled; 94 char throttle_req; 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 */ 100 static inline void *usb_get_serial_port_data (struct usb_serial_port *port) 101 { 102 return dev_get_drvdata(&port->dev); 103 } 104 105 static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data) 106 { 107 dev_set_drvdata(&port->dev, data); 108 } 109 110 /** 111 * usb_serial - structure used by the usb-serial core for a device 112 * @dev: pointer to the struct usb_device for this device 113 * @type: pointer to the struct usb_serial_driver for this device 114 * @interface: pointer to the struct usb_interface for this device 115 * @minor: the starting minor number for this device 116 * @num_ports: the number of ports this device has 117 * @num_interrupt_in: number of interrupt in endpoints we have 118 * @num_interrupt_out: number of interrupt out endpoints we have 119 * @num_bulk_in: number of bulk in endpoints we have 120 * @num_bulk_out: number of bulk out endpoints we have 121 * @port: array of struct usb_serial_port structures for the different ports. 122 * @private: place to put any driver specific information that is needed. The 123 * usb-serial driver is required to manage this data, the usb-serial core 124 * will not touch this. Use usb_get_serial_data() and 125 * usb_set_serial_data() to access this. 126 */ 127 struct usb_serial { 128 struct usb_device * dev; 129 struct usb_serial_driver * type; 130 struct usb_interface * interface; 131 unsigned char minor; 132 unsigned char num_ports; 133 unsigned char num_port_pointers; 134 char num_interrupt_in; 135 char num_interrupt_out; 136 char num_bulk_in; 137 char num_bulk_out; 138 struct usb_serial_port * port[MAX_NUM_PORTS]; 139 struct kref kref; 140 void * private; 141 }; 142 #define to_usb_serial(d) container_of(d, struct usb_serial, kref) 143 144 #define NUM_DONT_CARE (-1) 145 146 /* get and set the serial private data pointer helper functions */ 147 static inline void *usb_get_serial_data (struct usb_serial *serial) 148 { 149 return serial->private; 150 } 151 152 static inline void usb_set_serial_data (struct usb_serial *serial, void *data) 153 { 154 serial->private = data; 155 } 156 157 /** 158 * usb_serial_driver - describes a usb serial driver 159 * @description: pointer to a string that describes this driver. This string used 160 * in the syslog messages when a device is inserted or removed. 161 * @id_table: pointer to a list of usb_device_id structures that define all 162 * of the devices this structure can support. 163 * @num_interrupt_in: the number of interrupt in endpoints this device will 164 * have. 165 * @num_interrupt_out: the number of interrupt out endpoints this device will 166 * have. 167 * @num_bulk_in: the number of bulk in endpoints this device will have. 168 * @num_bulk_out: the number of bulk out endpoints this device will have. 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. 189 * 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. 195 * 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 * Useing the module name is a good idea.) 200 */ 201 struct usb_serial_driver { 202 const char *description; 203 const struct usb_device_id *id_table; 204 char num_interrupt_in; 205 char num_interrupt_out; 206 char num_bulk_in; 207 char num_bulk_out; 208 char num_ports; 209 210 struct list_head driver_list; 211 struct device_driver driver; 212 struct usb_driver *usb_driver; 213 struct usb_dynids dynids; 214 215 int (*probe) (struct usb_serial *serial, const struct usb_device_id *id); 216 int (*attach) (struct usb_serial *serial); 217 int (*calc_num_ports) (struct usb_serial *serial); 218 219 void (*shutdown) (struct usb_serial *serial); 220 221 int (*port_probe) (struct usb_serial_port *port); 222 int (*port_remove) (struct usb_serial_port *port); 223 224 /* serial function calls */ 225 int (*open) (struct usb_serial_port *port, struct file * filp); 226 void (*close) (struct usb_serial_port *port, struct file * filp); 227 int (*write) (struct usb_serial_port *port, const unsigned char *buf, int count); 228 int (*write_room) (struct usb_serial_port *port); 229 int (*ioctl) (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg); 230 void (*set_termios) (struct usb_serial_port *port, struct ktermios * old); 231 void (*break_ctl) (struct usb_serial_port *port, int break_state); 232 int (*chars_in_buffer) (struct usb_serial_port *port); 233 void (*throttle) (struct usb_serial_port *port); 234 void (*unthrottle) (struct usb_serial_port *port); 235 int (*tiocmget) (struct usb_serial_port *port, struct file *file); 236 int (*tiocmset) (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear); 237 238 void (*read_int_callback)(struct urb *urb); 239 void (*write_int_callback)(struct urb *urb); 240 void (*read_bulk_callback)(struct urb *urb); 241 void (*write_bulk_callback)(struct urb *urb); 242 }; 243 #define to_usb_serial_driver(d) container_of(d, struct usb_serial_driver, driver) 244 245 extern int usb_serial_register(struct usb_serial_driver *driver); 246 extern void usb_serial_deregister(struct usb_serial_driver *driver); 247 extern void usb_serial_port_softint(struct usb_serial_port *port); 248 249 extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id); 250 extern void usb_serial_disconnect(struct usb_interface *iface); 251 252 extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest); 253 extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit); 254 255 /* USB Serial console functions */ 256 #ifdef CONFIG_USB_SERIAL_CONSOLE 257 extern void usb_serial_console_init (int debug, int minor); 258 extern void usb_serial_console_exit (void); 259 extern void usb_serial_console_disconnect(struct usb_serial *serial); 260 #else 261 static inline void usb_serial_console_init (int debug, int minor) { } 262 static inline void usb_serial_console_exit (void) { } 263 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} 264 #endif 265 266 /* Functions needed by other parts of the usbserial core */ 267 extern struct usb_serial *usb_serial_get_by_index (unsigned int minor); 268 extern void usb_serial_put(struct usb_serial *serial); 269 extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp); 270 extern int usb_serial_generic_write (struct usb_serial_port *port, const unsigned char *buf, int count); 271 extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp); 272 extern int usb_serial_generic_write_room (struct usb_serial_port *port); 273 extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port); 274 extern void usb_serial_generic_read_bulk_callback (struct urb *urb); 275 extern void usb_serial_generic_write_bulk_callback (struct urb *urb); 276 extern void usb_serial_generic_throttle (struct usb_serial_port *port); 277 extern void usb_serial_generic_unthrottle (struct usb_serial_port *port); 278 extern void usb_serial_generic_shutdown (struct usb_serial *serial); 279 extern int usb_serial_generic_register (int debug); 280 extern void usb_serial_generic_deregister (void); 281 282 extern int usb_serial_bus_register (struct usb_serial_driver *device); 283 extern void usb_serial_bus_deregister (struct usb_serial_driver *device); 284 285 extern struct usb_serial_driver usb_serial_generic_device; 286 extern struct bus_type usb_serial_bus_type; 287 extern struct tty_driver *usb_serial_tty_driver; 288 289 static inline void usb_serial_debug_data(int debug, 290 struct device *dev, 291 const char *function, int size, 292 const unsigned char *data) 293 { 294 int i; 295 296 if (debug) { 297 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", function, size); 298 for (i = 0; i < size; ++i) 299 printk ("%.2x ", data[i]); 300 printk ("\n"); 301 } 302 } 303 304 /* Use our own dbg macro */ 305 #undef dbg 306 #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0) 307 308 309 310 #endif /* ifdef __LINUX_USB_SERIAL_H */ 311 312