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