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