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 254 /* loads of devices :) */ 21 #define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */ 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 * @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 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 * @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 50 * port. 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 56 * port. 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 63 * 64 * This structure is used by the usb-serial core and drivers for the specific 65 * ports of a device. 66 */ 67 struct usb_serial_port { 68 struct usb_serial *serial; 69 struct tty_port port; 70 spinlock_t lock; 71 struct mutex mutex; 72 unsigned char number; 73 74 unsigned char *interrupt_in_buffer; 75 struct urb *interrupt_in_urb; 76 __u8 interrupt_in_endpointAddress; 77 78 unsigned char *interrupt_out_buffer; 79 int interrupt_out_size; 80 struct urb *interrupt_out_urb; 81 __u8 interrupt_out_endpointAddress; 82 83 unsigned char *bulk_in_buffer; 84 int bulk_in_size; 85 struct urb *read_urb; 86 __u8 bulk_in_endpointAddress; 87 88 unsigned char *bulk_out_buffer; 89 int bulk_out_size; 90 struct urb *write_urb; 91 int write_urb_busy; 92 __u8 bulk_out_endpointAddress; 93 94 wait_queue_head_t write_wait; 95 struct work_struct work; 96 char throttled; 97 char throttle_req; 98 char console; 99 struct device dev; 100 }; 101 #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev) 102 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) 105 { 106 return dev_get_drvdata(&port->dev); 107 } 108 109 static inline void usb_set_serial_port_data(struct usb_serial_port *port, 110 void *data) 111 { 112 dev_set_drvdata(&port->dev, data); 113 } 114 115 /** 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. 131 */ 132 struct usb_serial { 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; 138 unsigned char minor; 139 unsigned char num_ports; 140 unsigned char num_port_pointers; 141 char num_interrupt_in; 142 char num_interrupt_out; 143 char num_bulk_in; 144 char num_bulk_out; 145 struct usb_serial_port *port[MAX_NUM_PORTS]; 146 struct kref kref; 147 struct mutex disc_mutex; 148 void *private; 149 }; 150 #define to_usb_serial(d) container_of(d, struct usb_serial, kref) 151 152 /* get and set the serial private data pointer helper functions */ 153 static inline void *usb_get_serial_data(struct usb_serial *serial) 154 { 155 return serial->private; 156 } 157 158 static inline void usb_set_serial_data(struct usb_serial *serial, void *data) 159 { 160 serial->private = data; 161 } 162 163 /** 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. 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 * Using 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_ports; 205 206 struct list_head driver_list; 207 struct device_driver driver; 208 struct usb_driver *usb_driver; 209 struct usb_dynids dynids; 210 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); 214 215 void (*shutdown)(struct usb_serial *serial); 216 217 int (*port_probe)(struct usb_serial_port *port); 218 int (*port_remove)(struct usb_serial_port *port); 219 220 int (*suspend)(struct usb_serial *serial, pm_message_t message); 221 int (*resume)(struct usb_serial *serial); 222 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 tty_struct *tty, 228 struct usb_serial_port *port, struct file *filp); 229 int (*write)(struct tty_struct *tty, struct usb_serial_port *port, 230 const unsigned char *buf, int count); 231 /* Called only by the tty layer */ 232 int (*write_room)(struct tty_struct *tty); 233 int (*ioctl)(struct tty_struct *tty, struct file *file, 234 unsigned int cmd, unsigned long arg); 235 void (*set_termios)(struct tty_struct *tty, 236 struct usb_serial_port *port, struct ktermios *old); 237 void (*break_ctl)(struct tty_struct *tty, int break_state); 238 int (*chars_in_buffer)(struct tty_struct *tty); 239 void (*throttle)(struct tty_struct *tty); 240 void (*unthrottle)(struct tty_struct *tty); 241 int (*tiocmget)(struct tty_struct *tty, struct file *file); 242 int (*tiocmset)(struct tty_struct *tty, struct file *file, 243 unsigned int set, unsigned int clear); 244 /* USB events */ 245 void (*read_int_callback)(struct urb *urb); 246 void (*write_int_callback)(struct urb *urb); 247 void (*read_bulk_callback)(struct urb *urb); 248 void (*write_bulk_callback)(struct urb *urb); 249 }; 250 #define to_usb_serial_driver(d) \ 251 container_of(d, struct usb_serial_driver, driver) 252 253 extern int usb_serial_register(struct usb_serial_driver *driver); 254 extern void usb_serial_deregister(struct usb_serial_driver *driver); 255 extern void usb_serial_port_softint(struct usb_serial_port *port); 256 257 extern int usb_serial_probe(struct usb_interface *iface, 258 const struct usb_device_id *id); 259 extern void usb_serial_disconnect(struct usb_interface *iface); 260 261 extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message); 262 extern int usb_serial_resume(struct usb_interface *intf); 263 264 extern int ezusb_writememory(struct usb_serial *serial, int address, 265 unsigned char *data, int length, __u8 bRequest); 266 extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit); 267 268 /* USB Serial console functions */ 269 #ifdef CONFIG_USB_SERIAL_CONSOLE 270 extern void usb_serial_console_init(int debug, int minor); 271 extern void usb_serial_console_exit(void); 272 extern void usb_serial_console_disconnect(struct usb_serial *serial); 273 #else 274 static inline void usb_serial_console_init(int debug, int minor) { } 275 static inline void usb_serial_console_exit(void) { } 276 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} 277 #endif 278 279 /* Functions needed by other parts of the usbserial core */ 280 extern struct usb_serial *usb_serial_get_by_index(unsigned int minor); 281 extern void usb_serial_put(struct usb_serial *serial); 282 extern int usb_serial_generic_open(struct tty_struct *tty, 283 struct usb_serial_port *port, struct file *filp); 284 extern int usb_serial_generic_write(struct tty_struct *tty, 285 struct usb_serial_port *port, const unsigned char *buf, int count); 286 extern void usb_serial_generic_close(struct tty_struct *tty, 287 struct usb_serial_port *port, struct file *filp); 288 extern int usb_serial_generic_resume(struct usb_serial *serial); 289 extern int usb_serial_generic_write_room(struct tty_struct *tty); 290 extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty); 291 extern void usb_serial_generic_read_bulk_callback(struct urb *urb); 292 extern void usb_serial_generic_write_bulk_callback(struct urb *urb); 293 extern void usb_serial_generic_throttle(struct tty_struct *tty); 294 extern void usb_serial_generic_unthrottle(struct tty_struct *tty); 295 extern void usb_serial_generic_shutdown(struct usb_serial *serial); 296 extern int usb_serial_generic_register(int debug); 297 extern void usb_serial_generic_deregister(void); 298 299 extern int usb_serial_bus_register(struct usb_serial_driver *device); 300 extern void usb_serial_bus_deregister(struct usb_serial_driver *device); 301 302 extern struct usb_serial_driver usb_serial_generic_device; 303 extern struct bus_type usb_serial_bus_type; 304 extern struct tty_driver *usb_serial_tty_driver; 305 306 static inline void usb_serial_debug_data(int debug, 307 struct device *dev, 308 const char *function, int size, 309 const unsigned char *data) 310 { 311 int i; 312 313 if (debug) { 314 dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", 315 function, size); 316 for (i = 0; i < size; ++i) 317 printk("%.2x ", data[i]); 318 printk("\n"); 319 } 320 } 321 322 /* Use our own dbg macro */ 323 #undef dbg 324 #define dbg(format, arg...) \ 325 do { \ 326 if (debug) \ 327 printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \ 328 ## arg); \ 329 } while (0) 330 331 332 333 #endif /* __LINUX_USB_SERIAL_H */ 334 335