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