1 /* 2 * USB Serial Converter stuff 3 * 4 * Copyright (C) 1999 - 2005 5 * Greg Kroah-Hartman ([email protected]) 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 19 #define SERIAL_TTY_MAJOR 188 /* Nice legal number now */ 20 #define SERIAL_TTY_MINORS 255 /* loads of devices :) */ 21 22 /* The maximum number of ports one device can grab at once */ 23 #define MAX_NUM_PORTS 8 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 char console; 96 struct device dev; 97 }; 98 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev) 99 100 /* get and set the port private data pointer helper functions */ 101 static inline void *usb_get_serial_port_data(struct usb_serial_port *port) 102 { 103 return dev_get_drvdata(&port->dev); 104 } 105 106 static inline void usb_set_serial_port_data(struct usb_serial_port *port, 107 void *data) 108 { 109 dev_set_drvdata(&port->dev, data); 110 } 111 112 /** 113 * usb_serial - structure used by the usb-serial core for a device 114 * @dev: pointer to the struct usb_device for this device 115 * @type: pointer to the struct usb_serial_driver for this device 116 * @interface: pointer to the struct usb_interface for this device 117 * @minor: the starting minor number for this device 118 * @num_ports: the number of ports this device has 119 * @num_interrupt_in: number of interrupt in endpoints we have 120 * @num_interrupt_out: number of interrupt out endpoints we have 121 * @num_bulk_in: number of bulk in endpoints we have 122 * @num_bulk_out: number of bulk out endpoints we have 123 * @port: array of struct usb_serial_port structures for the different ports. 124 * @private: place to put any driver specific information that is needed. The 125 * usb-serial driver is required to manage this data, the usb-serial core 126 * will not touch this. Use usb_get_serial_data() and 127 * usb_set_serial_data() to access this. 128 */ 129 struct usb_serial { 130 struct usb_device *dev; 131 struct usb_serial_driver *type; 132 struct usb_interface *interface; 133 unsigned char disconnected; 134 unsigned char minor; 135 unsigned char num_ports; 136 unsigned char num_port_pointers; 137 char num_interrupt_in; 138 char num_interrupt_out; 139 char num_bulk_in; 140 char num_bulk_out; 141 struct usb_serial_port *port[MAX_NUM_PORTS]; 142 struct kref kref; 143 struct mutex disc_mutex; 144 void *private; 145 }; 146 #define to_usb_serial(d) container_of(d, struct usb_serial, kref) 147 148 /* get and set the serial private data pointer helper functions */ 149 static inline void *usb_get_serial_data(struct usb_serial *serial) 150 { 151 return serial->private; 152 } 153 154 static inline void usb_set_serial_data(struct usb_serial *serial, void *data) 155 { 156 serial->private = data; 157 } 158 159 /** 160 * usb_serial_driver - describes a usb serial driver 161 * @description: pointer to a string that describes this driver. This string 162 * used in the syslog messages when a device is inserted or removed. 163 * @id_table: pointer to a list of usb_device_id structures that define all 164 * of the devices this structure can support. 165 * @num_ports: the number of different ports this device will have. 166 * @calc_num_ports: pointer to a function to determine how many ports this 167 * device has dynamically. It will be called after the probe() 168 * callback is called, but before attach() 169 * @probe: pointer to the driver's probe function. 170 * This will be called when the device is inserted into the system, 171 * but before the device has been fully initialized by the usb_serial 172 * subsystem. Use this function to download any firmware to the device, 173 * or any other early initialization that might be needed. 174 * Return 0 to continue on with the initialization sequence. Anything 175 * else will abort it. 176 * @attach: pointer to the driver's attach function. 177 * This will be called when the struct usb_serial structure is fully set 178 * set up. Do any local initialization of the device, or any private 179 * memory structure allocation at this point in time. 180 * @shutdown: pointer to the driver's shutdown function. This will be 181 * called when the device is removed from the system. 182 * @usb_driver: pointer to the struct usb_driver that controls this 183 * device. This is necessary to allow dynamic ids to be added to 184 * the driver from sysfs. 185 * 186 * This structure is defines a USB Serial driver. It provides all of 187 * the information that the USB serial core code needs. If the function 188 * pointers are defined, then the USB serial core code will call them when 189 * the corresponding tty port functions are called. If they are not 190 * called, the generic serial function will be used instead. 191 * 192 * The driver.owner field should be set to the module owner of this driver. 193 * The driver.name field should be set to the name of this driver (remember 194 * it will show up in sysfs, so it needs to be short and to the point. 195 * Useing the module name is a good idea.) 196 */ 197 struct usb_serial_driver { 198 const char *description; 199 const struct usb_device_id *id_table; 200 char num_ports; 201 202 struct list_head driver_list; 203 struct device_driver driver; 204 struct usb_driver *usb_driver; 205 struct usb_dynids dynids; 206 207 int (*probe)(struct usb_serial *serial, const struct usb_device_id *id); 208 int (*attach)(struct usb_serial *serial); 209 int (*calc_num_ports) (struct usb_serial *serial); 210 211 void (*shutdown)(struct usb_serial *serial); 212 213 int (*port_probe)(struct usb_serial_port *port); 214 int (*port_remove)(struct usb_serial_port *port); 215 216 int (*suspend)(struct usb_serial *serial, pm_message_t message); 217 int (*resume)(struct usb_serial *serial); 218 219 /* serial function calls */ 220 int (*open)(struct usb_serial_port *port, struct file *filp); 221 void (*close)(struct usb_serial_port *port, struct file *filp); 222 int (*write)(struct usb_serial_port *port, const unsigned char *buf, 223 int count); 224 int (*write_room)(struct usb_serial_port *port); 225 int (*ioctl)(struct usb_serial_port *port, struct file *file, 226 unsigned int cmd, unsigned long arg); 227 void (*set_termios)(struct usb_serial_port *port, struct ktermios *old); 228 void (*break_ctl)(struct usb_serial_port *port, int break_state); 229 int (*chars_in_buffer)(struct usb_serial_port *port); 230 void (*throttle)(struct usb_serial_port *port); 231 void (*unthrottle)(struct usb_serial_port *port); 232 int (*tiocmget)(struct usb_serial_port *port, struct file *file); 233 int (*tiocmset)(struct usb_serial_port *port, struct file *file, 234 unsigned int set, unsigned int clear); 235 236 void (*read_int_callback)(struct urb *urb); 237 void (*write_int_callback)(struct urb *urb); 238 void (*read_bulk_callback)(struct urb *urb); 239 void (*write_bulk_callback)(struct urb *urb); 240 }; 241 #define to_usb_serial_driver(d) \ 242 container_of(d, struct usb_serial_driver, driver) 243 244 extern int usb_serial_register(struct usb_serial_driver *driver); 245 extern void usb_serial_deregister(struct usb_serial_driver *driver); 246 extern void usb_serial_port_softint(struct usb_serial_port *port); 247 248 extern int usb_serial_probe(struct usb_interface *iface, 249 const struct usb_device_id *id); 250 extern void usb_serial_disconnect(struct usb_interface *iface); 251 252 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message); 253 extern int usb_serial_resume(struct usb_interface *intf); 254 255 extern int ezusb_writememory(struct usb_serial *serial, int address, 256 unsigned char *data, int length, __u8 bRequest); 257 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit); 258 259 /* USB Serial console functions */ 260 #ifdef CONFIG_USB_SERIAL_CONSOLE 261 extern void usb_serial_console_init(int debug, int minor); 262 extern void usb_serial_console_exit(void); 263 extern void usb_serial_console_disconnect(struct usb_serial *serial); 264 #else 265 static inline void usb_serial_console_init(int debug, int minor) { } 266 static inline void usb_serial_console_exit(void) { } 267 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} 268 #endif 269 270 /* Functions needed by other parts of the usbserial core */ 271 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor); 272 extern void usb_serial_put(struct usb_serial *serial); 273 extern int usb_serial_generic_open(struct usb_serial_port *port, 274 struct file *filp); 275 extern int usb_serial_generic_write(struct usb_serial_port *port, 276 const unsigned char *buf, int count); 277 extern void usb_serial_generic_close(struct usb_serial_port *port, 278 struct file *filp); 279 extern int usb_serial_generic_resume(struct usb_serial *serial); 280 extern int usb_serial_generic_write_room(struct usb_serial_port *port); 281 extern int usb_serial_generic_chars_in_buffer(struct usb_serial_port *port); 282 extern void usb_serial_generic_read_bulk_callback(struct urb *urb); 283 extern void usb_serial_generic_write_bulk_callback(struct urb *urb); 284 extern void usb_serial_generic_throttle(struct usb_serial_port *port); 285 extern void usb_serial_generic_unthrottle(struct usb_serial_port *port); 286 extern void usb_serial_generic_shutdown(struct usb_serial *serial); 287 extern int usb_serial_generic_register(int debug); 288 extern void usb_serial_generic_deregister(void); 289 290 extern int usb_serial_bus_register(struct usb_serial_driver *device); 291 extern void usb_serial_bus_deregister(struct usb_serial_driver *device); 292 293 extern struct usb_serial_driver usb_serial_generic_device; 294 extern struct bus_type usb_serial_bus_type; 295 extern struct tty_driver *usb_serial_tty_driver; 296 297 static inline void usb_serial_debug_data(int debug, 298 struct device *dev, 299 const char *function, int size, 300 const unsigned char *data) 301 { 302 int i; 303 304 if (debug) { 305 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", 306 function, size); 307 for (i = 0; i < size; ++i) 308 printk("%.2x ", data[i]); 309 printk("\n"); 310 } 311 } 312 313 /* Use our own dbg macro */ 314 #undef dbg 315 #define dbg(format, arg...) \ 316 do { \ 317 if (debug) \ 318 printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \ 319 ## arg); \ 320 } while (0) 321 322 323 324 #endif /* __LINUX_USB_SERIAL_H */ 325 326