diff options
Diffstat (limited to 'include/linux/usb')
| -rw-r--r-- | include/linux/usb/audio.h | 53 | ||||
| -rw-r--r-- | include/linux/usb/midi.h | 112 | ||||
| -rw-r--r-- | include/linux/usb/otg.h | 131 | ||||
| -rw-r--r-- | include/linux/usb/serial.h | 300 |
4 files changed, 596 insertions, 0 deletions
diff --git a/include/linux/usb/audio.h b/include/linux/usb/audio.h new file mode 100644 index 000000000000..6bd235994dc2 --- /dev/null +++ b/include/linux/usb/audio.h | |||
| @@ -0,0 +1,53 @@ | |||
| 1 | /* | ||
| 2 | * <linux/usb/audio.h> -- USB Audio definitions. | ||
| 3 | * | ||
| 4 | * Copyright (C) 2006 Thumtronics Pty Ltd. | ||
| 5 | * Developed for Thumtronics by Grey Innovation | ||
| 6 | * Ben Williamson <ben.williamson@greyinnovation.com> | ||
| 7 | * | ||
| 8 | * This software is distributed under the terms of the GNU General Public | ||
| 9 | * License ("GPL") version 2, as published by the Free Software Foundation. | ||
| 10 | * | ||
| 11 | * This file holds USB constants and structures defined | ||
| 12 | * by the USB Device Class Definition for Audio Devices. | ||
| 13 | * Comments below reference relevant sections of that document: | ||
| 14 | * | ||
| 15 | * http://www.usb.org/developers/devclass_docs/audio10.pdf | ||
| 16 | */ | ||
| 17 | |||
| 18 | #ifndef __LINUX_USB_AUDIO_H | ||
| 19 | #define __LINUX_USB_AUDIO_H | ||
| 20 | |||
| 21 | #include <linux/types.h> | ||
| 22 | |||
| 23 | /* A.2 Audio Interface Subclass Codes */ | ||
| 24 | #define USB_SUBCLASS_AUDIOCONTROL 0x01 | ||
| 25 | #define USB_SUBCLASS_AUDIOSTREAMING 0x02 | ||
| 26 | #define USB_SUBCLASS_MIDISTREAMING 0x03 | ||
| 27 | |||
| 28 | /* 4.3.2 Class-Specific AC Interface Descriptor */ | ||
| 29 | struct usb_ac_header_descriptor { | ||
| 30 | __u8 bLength; // 8+n | ||
| 31 | __u8 bDescriptorType; // USB_DT_CS_INTERFACE | ||
| 32 | __u8 bDescriptorSubtype; // USB_MS_HEADER | ||
| 33 | __le16 bcdADC; // 0x0100 | ||
| 34 | __le16 wTotalLength; // includes Unit and Terminal desc. | ||
| 35 | __u8 bInCollection; // n | ||
| 36 | __u8 baInterfaceNr[]; // [n] | ||
| 37 | } __attribute__ ((packed)); | ||
| 38 | |||
| 39 | #define USB_DT_AC_HEADER_SIZE(n) (8+(n)) | ||
| 40 | |||
| 41 | /* As above, but more useful for defining your own descriptors: */ | ||
| 42 | #define DECLARE_USB_AC_HEADER_DESCRIPTOR(n) \ | ||
| 43 | struct usb_ac_header_descriptor_##n { \ | ||
| 44 | __u8 bLength; \ | ||
| 45 | __u8 bDescriptorType; \ | ||
| 46 | __u8 bDescriptorSubtype; \ | ||
| 47 | __le16 bcdADC; \ | ||
| 48 | __le16 wTotalLength; \ | ||
| 49 | __u8 bInCollection; \ | ||
| 50 | __u8 baInterfaceNr[n]; \ | ||
| 51 | } __attribute__ ((packed)) | ||
| 52 | |||
| 53 | #endif | ||
diff --git a/include/linux/usb/midi.h b/include/linux/usb/midi.h new file mode 100644 index 000000000000..11a97d5ffd34 --- /dev/null +++ b/include/linux/usb/midi.h | |||
| @@ -0,0 +1,112 @@ | |||
| 1 | /* | ||
| 2 | * <linux/usb/midi.h> -- USB MIDI definitions. | ||
| 3 | * | ||
| 4 | * Copyright (C) 2006 Thumtronics Pty Ltd. | ||
| 5 | * Developed for Thumtronics by Grey Innovation | ||
| 6 | * Ben Williamson <ben.williamson@greyinnovation.com> | ||
| 7 | * | ||
| 8 | * This software is distributed under the terms of the GNU General Public | ||
| 9 | * License ("GPL") version 2, as published by the Free Software Foundation. | ||
| 10 | * | ||
| 11 | * This file holds USB constants and structures defined | ||
| 12 | * by the USB Device Class Definition for MIDI Devices. | ||
| 13 | * Comments below reference relevant sections of that document: | ||
| 14 | * | ||
| 15 | * http://www.usb.org/developers/devclass_docs/midi10.pdf | ||
| 16 | */ | ||
| 17 | |||
| 18 | #ifndef __LINUX_USB_MIDI_H | ||
| 19 | #define __LINUX_USB_MIDI_H | ||
| 20 | |||
| 21 | #include <linux/types.h> | ||
| 22 | |||
| 23 | /* A.1 MS Class-Specific Interface Descriptor Subtypes */ | ||
| 24 | #define USB_MS_HEADER 0x01 | ||
| 25 | #define USB_MS_MIDI_IN_JACK 0x02 | ||
| 26 | #define USB_MS_MIDI_OUT_JACK 0x03 | ||
| 27 | #define USB_MS_ELEMENT 0x04 | ||
| 28 | |||
| 29 | /* A.2 MS Class-Specific Endpoint Descriptor Subtypes */ | ||
| 30 | #define USB_MS_GENERAL 0x01 | ||
| 31 | |||
| 32 | /* A.3 MS MIDI IN and OUT Jack Types */ | ||
| 33 | #define USB_MS_EMBEDDED 0x01 | ||
| 34 | #define USB_MS_EXTERNAL 0x02 | ||
| 35 | |||
| 36 | /* 6.1.2.1 Class-Specific MS Interface Header Descriptor */ | ||
| 37 | struct usb_ms_header_descriptor { | ||
| 38 | __u8 bLength; | ||
| 39 | __u8 bDescriptorType; | ||
| 40 | __u8 bDescriptorSubtype; | ||
| 41 | __le16 bcdMSC; | ||
| 42 | __le16 wTotalLength; | ||
| 43 | } __attribute__ ((packed)); | ||
| 44 | |||
| 45 | #define USB_DT_MS_HEADER_SIZE 7 | ||
| 46 | |||
| 47 | /* 6.1.2.2 MIDI IN Jack Descriptor */ | ||
| 48 | struct usb_midi_in_jack_descriptor { | ||
| 49 | __u8 bLength; | ||
| 50 | __u8 bDescriptorType; // USB_DT_CS_INTERFACE | ||
| 51 | __u8 bDescriptorSubtype; // USB_MS_MIDI_IN_JACK | ||
| 52 | __u8 bJackType; // USB_MS_EMBEDDED/EXTERNAL | ||
| 53 | __u8 bJackID; | ||
| 54 | __u8 iJack; | ||
| 55 | } __attribute__ ((packed)); | ||
| 56 | |||
| 57 | #define USB_DT_MIDI_IN_SIZE 6 | ||
| 58 | |||
| 59 | struct usb_midi_source_pin { | ||
| 60 | __u8 baSourceID; | ||
| 61 | __u8 baSourcePin; | ||
| 62 | } __attribute__ ((packed)); | ||
| 63 | |||
| 64 | /* 6.1.2.3 MIDI OUT Jack Descriptor */ | ||
| 65 | struct usb_midi_out_jack_descriptor { | ||
| 66 | __u8 bLength; | ||
| 67 | __u8 bDescriptorType; // USB_DT_CS_INTERFACE | ||
| 68 | __u8 bDescriptorSubtype; // USB_MS_MIDI_OUT_JACK | ||
| 69 | __u8 bJackType; // USB_MS_EMBEDDED/EXTERNAL | ||
| 70 | __u8 bJackID; | ||
| 71 | __u8 bNrInputPins; // p | ||
| 72 | struct usb_midi_source_pin pins[]; // [p] | ||
| 73 | /*__u8 iJack; -- ommitted due to variable-sized pins[] */ | ||
| 74 | } __attribute__ ((packed)); | ||
| 75 | |||
| 76 | #define USB_DT_MIDI_OUT_SIZE(p) (7 + 2 * (p)) | ||
| 77 | |||
| 78 | /* As above, but more useful for defining your own descriptors: */ | ||
| 79 | #define DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(p) \ | ||
| 80 | struct usb_midi_out_jack_descriptor_##p { \ | ||
| 81 | __u8 bLength; \ | ||
| 82 | __u8 bDescriptorType; \ | ||
| 83 | __u8 bDescriptorSubtype; \ | ||
| 84 | __u8 bJackType; \ | ||
| 85 | __u8 bJackID; \ | ||
| 86 | __u8 bNrInputPins; \ | ||
| 87 | struct usb_midi_source_pin pins[p]; \ | ||
| 88 | __u8 iJack; \ | ||
| 89 | } __attribute__ ((packed)) | ||
| 90 | |||
| 91 | /* 6.2.2 Class-Specific MS Bulk Data Endpoint Descriptor */ | ||
| 92 | struct usb_ms_endpoint_descriptor { | ||
| 93 | __u8 bLength; // 4+n | ||
| 94 | __u8 bDescriptorType; // USB_DT_CS_ENDPOINT | ||
| 95 | __u8 bDescriptorSubtype; // USB_MS_GENERAL | ||
| 96 | __u8 bNumEmbMIDIJack; // n | ||
| 97 | __u8 baAssocJackID[]; // [n] | ||
| 98 | } __attribute__ ((packed)); | ||
| 99 | |||
| 100 | #define USB_DT_MS_ENDPOINT_SIZE(n) (4 + (n)) | ||
| 101 | |||
| 102 | /* As above, but more useful for defining your own descriptors: */ | ||
| 103 | #define DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(n) \ | ||
| 104 | struct usb_ms_endpoint_descriptor_##n { \ | ||
| 105 | __u8 bLength; \ | ||
| 106 | __u8 bDescriptorType; \ | ||
| 107 | __u8 bDescriptorSubtype; \ | ||
| 108 | __u8 bNumEmbMIDIJack; \ | ||
| 109 | __u8 baAssocJackID[n]; \ | ||
| 110 | } __attribute__ ((packed)) | ||
| 111 | |||
| 112 | #endif | ||
diff --git a/include/linux/usb/otg.h b/include/linux/usb/otg.h new file mode 100644 index 000000000000..9897f7a818c5 --- /dev/null +++ b/include/linux/usb/otg.h | |||
| @@ -0,0 +1,131 @@ | |||
| 1 | // include/linux/usb/otg.h | ||
| 2 | |||
| 3 | /* | ||
| 4 | * These APIs may be used between USB controllers. USB device drivers | ||
| 5 | * (for either host or peripheral roles) don't use these calls; they | ||
| 6 | * continue to use just usb_device and usb_gadget. | ||
| 7 | */ | ||
| 8 | |||
| 9 | |||
| 10 | /* OTG defines lots of enumeration states before device reset */ | ||
| 11 | enum usb_otg_state { | ||
| 12 | OTG_STATE_UNDEFINED = 0, | ||
| 13 | |||
| 14 | /* single-role peripheral, and dual-role default-b */ | ||
| 15 | OTG_STATE_B_IDLE, | ||
| 16 | OTG_STATE_B_SRP_INIT, | ||
| 17 | OTG_STATE_B_PERIPHERAL, | ||
| 18 | |||
| 19 | /* extra dual-role default-b states */ | ||
| 20 | OTG_STATE_B_WAIT_ACON, | ||
| 21 | OTG_STATE_B_HOST, | ||
| 22 | |||
| 23 | /* dual-role default-a */ | ||
| 24 | OTG_STATE_A_IDLE, | ||
| 25 | OTG_STATE_A_WAIT_VRISE, | ||
| 26 | OTG_STATE_A_WAIT_BCON, | ||
| 27 | OTG_STATE_A_HOST, | ||
| 28 | OTG_STATE_A_SUSPEND, | ||
| 29 | OTG_STATE_A_PERIPHERAL, | ||
| 30 | OTG_STATE_A_WAIT_VFALL, | ||
| 31 | OTG_STATE_A_VBUS_ERR, | ||
| 32 | }; | ||
| 33 | |||
| 34 | /* | ||
| 35 | * the otg driver needs to interact with both device side and host side | ||
| 36 | * usb controllers. it decides which controller is active at a given | ||
| 37 | * moment, using the transceiver, ID signal, HNP and sometimes static | ||
| 38 | * configuration information (including "board isn't wired for otg"). | ||
| 39 | */ | ||
| 40 | struct otg_transceiver { | ||
| 41 | struct device *dev; | ||
| 42 | const char *label; | ||
| 43 | |||
| 44 | u8 default_a; | ||
| 45 | enum usb_otg_state state; | ||
| 46 | |||
| 47 | struct usb_bus *host; | ||
| 48 | struct usb_gadget *gadget; | ||
| 49 | |||
| 50 | /* to pass extra port status to the root hub */ | ||
| 51 | u16 port_status; | ||
| 52 | u16 port_change; | ||
| 53 | |||
| 54 | /* bind/unbind the host controller */ | ||
| 55 | int (*set_host)(struct otg_transceiver *otg, | ||
| 56 | struct usb_bus *host); | ||
| 57 | |||
| 58 | /* bind/unbind the peripheral controller */ | ||
| 59 | int (*set_peripheral)(struct otg_transceiver *otg, | ||
| 60 | struct usb_gadget *gadget); | ||
| 61 | |||
| 62 | /* effective for B devices, ignored for A-peripheral */ | ||
| 63 | int (*set_power)(struct otg_transceiver *otg, | ||
| 64 | unsigned mA); | ||
| 65 | |||
| 66 | /* for non-OTG B devices: set transceiver into suspend mode */ | ||
| 67 | int (*set_suspend)(struct otg_transceiver *otg, | ||
| 68 | int suspend); | ||
| 69 | |||
| 70 | /* for B devices only: start session with A-Host */ | ||
| 71 | int (*start_srp)(struct otg_transceiver *otg); | ||
| 72 | |||
| 73 | /* start or continue HNP role switch */ | ||
| 74 | int (*start_hnp)(struct otg_transceiver *otg); | ||
| 75 | |||
| 76 | }; | ||
| 77 | |||
| 78 | |||
| 79 | /* for board-specific init logic */ | ||
| 80 | extern int otg_set_transceiver(struct otg_transceiver *); | ||
| 81 | |||
| 82 | |||
| 83 | /* for usb host and peripheral controller drivers */ | ||
| 84 | extern struct otg_transceiver *otg_get_transceiver(void); | ||
| 85 | |||
| 86 | static inline int | ||
| 87 | otg_start_hnp(struct otg_transceiver *otg) | ||
| 88 | { | ||
| 89 | return otg->start_hnp(otg); | ||
| 90 | } | ||
| 91 | |||
| 92 | |||
| 93 | /* for HCDs */ | ||
| 94 | static inline int | ||
| 95 | otg_set_host(struct otg_transceiver *otg, struct usb_bus *host) | ||
| 96 | { | ||
| 97 | return otg->set_host(otg, host); | ||
| 98 | } | ||
| 99 | |||
| 100 | |||
| 101 | /* for usb peripheral controller drivers */ | ||
| 102 | static inline int | ||
| 103 | otg_set_peripheral(struct otg_transceiver *otg, struct usb_gadget *periph) | ||
| 104 | { | ||
| 105 | return otg->set_peripheral(otg, periph); | ||
| 106 | } | ||
| 107 | |||
| 108 | static inline int | ||
| 109 | otg_set_power(struct otg_transceiver *otg, unsigned mA) | ||
| 110 | { | ||
| 111 | return otg->set_power(otg, mA); | ||
| 112 | } | ||
| 113 | |||
| 114 | static inline int | ||
| 115 | otg_set_suspend(struct otg_transceiver *otg, int suspend) | ||
| 116 | { | ||
| 117 | if (otg->set_suspend != NULL) | ||
| 118 | return otg->set_suspend(otg, suspend); | ||
| 119 | else | ||
| 120 | return 0; | ||
| 121 | } | ||
| 122 | |||
| 123 | static inline int | ||
| 124 | otg_start_srp(struct otg_transceiver *otg) | ||
| 125 | { | ||
| 126 | return otg->start_srp(otg); | ||
| 127 | } | ||
| 128 | |||
| 129 | |||
| 130 | /* for OTG controller drivers (and maybe other stuff) */ | ||
| 131 | extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num); | ||
diff --git a/include/linux/usb/serial.h b/include/linux/usb/serial.h new file mode 100644 index 000000000000..91c983eef899 --- /dev/null +++ b/include/linux/usb/serial.h | |||
| @@ -0,0 +1,300 @@ | |||
| 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 | #define MAX_NUM_PORTS 8 /* The maximum number of ports one device can grab at once */ | ||
| 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 | * | ||
| 58 | * This structure is used by the usb-serial core and drivers for the specific | ||
| 59 | * ports of a device. | ||
| 60 | */ | ||
| 61 | struct usb_serial_port { | ||
| 62 | struct usb_serial * serial; | ||
| 63 | struct tty_struct * tty; | ||
| 64 | spinlock_t lock; | ||
| 65 | struct mutex mutex; | ||
| 66 | unsigned char number; | ||
| 67 | |||
| 68 | unsigned char * interrupt_in_buffer; | ||
| 69 | struct urb * interrupt_in_urb; | ||
| 70 | __u8 interrupt_in_endpointAddress; | ||
| 71 | |||
| 72 | unsigned char * interrupt_out_buffer; | ||
| 73 | int interrupt_out_size; | ||
| 74 | struct urb * interrupt_out_urb; | ||
| 75 | __u8 interrupt_out_endpointAddress; | ||
| 76 | |||
| 77 | unsigned char * bulk_in_buffer; | ||
| 78 | int bulk_in_size; | ||
| 79 | struct urb * read_urb; | ||
| 80 | __u8 bulk_in_endpointAddress; | ||
| 81 | |||
| 82 | unsigned char * bulk_out_buffer; | ||
| 83 | int bulk_out_size; | ||
| 84 | struct urb * write_urb; | ||
| 85 | int write_urb_busy; | ||
| 86 | __u8 bulk_out_endpointAddress; | ||
| 87 | |||
| 88 | wait_queue_head_t write_wait; | ||
| 89 | struct work_struct work; | ||
| 90 | int open_count; | ||
| 91 | struct device dev; | ||
| 92 | }; | ||
| 93 | #define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev) | ||
| 94 | |||
| 95 | /* get and set the port private data pointer helper functions */ | ||
| 96 | static inline void *usb_get_serial_port_data (struct usb_serial_port *port) | ||
| 97 | { | ||
| 98 | return dev_get_drvdata(&port->dev); | ||
| 99 | } | ||
| 100 | |||
| 101 | static inline void usb_set_serial_port_data (struct usb_serial_port *port, void *data) | ||
| 102 | { | ||
| 103 | dev_set_drvdata(&port->dev, data); | ||
| 104 | } | ||
| 105 | |||
| 106 | /** | ||
| 107 | * usb_serial - structure used by the usb-serial core for a device | ||
| 108 | * @dev: pointer to the struct usb_device for this device | ||
| 109 | * @type: pointer to the struct usb_serial_driver for this device | ||
| 110 | * @interface: pointer to the struct usb_interface for this device | ||
| 111 | * @minor: the starting minor number for this device | ||
| 112 | * @num_ports: the number of ports this device has | ||
| 113 | * @num_interrupt_in: number of interrupt in endpoints we have | ||
| 114 | * @num_interrupt_out: number of interrupt out endpoints we have | ||
| 115 | * @num_bulk_in: number of bulk in endpoints we have | ||
| 116 | * @num_bulk_out: number of bulk out endpoints we have | ||
| 117 | * @port: array of struct usb_serial_port structures for the different ports. | ||
| 118 | * @private: place to put any driver specific information that is needed. The | ||
| 119 | * usb-serial driver is required to manage this data, the usb-serial core | ||
| 120 | * will not touch this. Use usb_get_serial_data() and | ||
| 121 | * usb_set_serial_data() to access this. | ||
| 122 | */ | ||
| 123 | struct usb_serial { | ||
| 124 | struct usb_device * dev; | ||
| 125 | struct usb_serial_driver * type; | ||
| 126 | struct usb_interface * interface; | ||
| 127 | unsigned char minor; | ||
| 128 | unsigned char num_ports; | ||
| 129 | unsigned char num_port_pointers; | ||
| 130 | char num_interrupt_in; | ||
| 131 | char num_interrupt_out; | ||
| 132 | char num_bulk_in; | ||
| 133 | char num_bulk_out; | ||
| 134 | struct usb_serial_port * port[MAX_NUM_PORTS]; | ||
| 135 | struct kref kref; | ||
| 136 | void * private; | ||
| 137 | }; | ||
| 138 | #define to_usb_serial(d) container_of(d, struct usb_serial, kref) | ||
| 139 | |||
| 140 | #define NUM_DONT_CARE (-1) | ||
| 141 | |||
| 142 | /* get and set the serial private data pointer helper functions */ | ||
| 143 | static inline void *usb_get_serial_data (struct usb_serial *serial) | ||
| 144 | { | ||
| 145 | return serial->private; | ||
| 146 | } | ||
| 147 | |||
| 148 | static inline void usb_set_serial_data (struct usb_serial *serial, void *data) | ||
| 149 | { | ||
| 150 | serial->private = data; | ||
| 151 | } | ||
| 152 | |||
| 153 | /** | ||
| 154 | * usb_serial_driver - describes a usb serial driver | ||
| 155 | * @description: pointer to a string that describes this driver. This string used | ||
| 156 | * in the syslog messages when a device is inserted or removed. | ||
| 157 | * @id_table: pointer to a list of usb_device_id structures that define all | ||
| 158 | * of the devices this structure can support. | ||
| 159 | * @num_interrupt_in: the number of interrupt in endpoints this device will | ||
| 160 | * have. | ||
| 161 | * @num_interrupt_out: the number of interrupt out endpoints this device will | ||
| 162 | * have. | ||
| 163 | * @num_bulk_in: the number of bulk in endpoints this device will have. | ||
| 164 | * @num_bulk_out: the number of bulk out endpoints this device will have. | ||
| 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 | * | ||
| 183 | * This structure is defines a USB Serial driver. It provides all of | ||
| 184 | * the information that the USB serial core code needs. If the function | ||
| 185 | * pointers are defined, then the USB serial core code will call them when | ||
| 186 | * the corresponding tty port functions are called. If they are not | ||
| 187 | * called, the generic serial function will be used instead. | ||
| 188 | * | ||
| 189 | * The driver.owner field should be set to the module owner of this driver. | ||
| 190 | * The driver.name field should be set to the name of this driver (remember | ||
| 191 | * it will show up in sysfs, so it needs to be short and to the point. | ||
| 192 | * Useing the module name is a good idea.) | ||
| 193 | */ | ||
| 194 | struct usb_serial_driver { | ||
| 195 | const char *description; | ||
| 196 | const struct usb_device_id *id_table; | ||
| 197 | char num_interrupt_in; | ||
| 198 | char num_interrupt_out; | ||
| 199 | char num_bulk_in; | ||
| 200 | char num_bulk_out; | ||
| 201 | char num_ports; | ||
| 202 | |||
| 203 | struct list_head driver_list; | ||
| 204 | struct device_driver driver; | ||
| 205 | |||
| 206 | int (*probe) (struct usb_serial *serial, const struct usb_device_id *id); | ||
| 207 | int (*attach) (struct usb_serial *serial); | ||
| 208 | int (*calc_num_ports) (struct usb_serial *serial); | ||
| 209 | |||
| 210 | void (*shutdown) (struct usb_serial *serial); | ||
| 211 | |||
| 212 | int (*port_probe) (struct usb_serial_port *port); | ||
| 213 | int (*port_remove) (struct usb_serial_port *port); | ||
| 214 | |||
| 215 | /* serial function calls */ | ||
| 216 | int (*open) (struct usb_serial_port *port, struct file * filp); | ||
| 217 | void (*close) (struct usb_serial_port *port, struct file * filp); | ||
| 218 | int (*write) (struct usb_serial_port *port, const unsigned char *buf, int count); | ||
| 219 | int (*write_room) (struct usb_serial_port *port); | ||
| 220 | int (*ioctl) (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg); | ||
| 221 | void (*set_termios) (struct usb_serial_port *port, struct termios * old); | ||
| 222 | void (*break_ctl) (struct usb_serial_port *port, int break_state); | ||
| 223 | int (*chars_in_buffer) (struct usb_serial_port *port); | ||
| 224 | void (*throttle) (struct usb_serial_port *port); | ||
| 225 | void (*unthrottle) (struct usb_serial_port *port); | ||
| 226 | int (*tiocmget) (struct usb_serial_port *port, struct file *file); | ||
| 227 | int (*tiocmset) (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear); | ||
| 228 | |||
| 229 | void (*read_int_callback)(struct urb *urb, struct pt_regs *regs); | ||
| 230 | void (*write_int_callback)(struct urb *urb, struct pt_regs *regs); | ||
| 231 | void (*read_bulk_callback)(struct urb *urb, struct pt_regs *regs); | ||
| 232 | void (*write_bulk_callback)(struct urb *urb, struct pt_regs *regs); | ||
| 233 | }; | ||
| 234 | #define to_usb_serial_driver(d) container_of(d, struct usb_serial_driver, driver) | ||
| 235 | |||
| 236 | extern int usb_serial_register(struct usb_serial_driver *driver); | ||
| 237 | extern void usb_serial_deregister(struct usb_serial_driver *driver); | ||
| 238 | extern void usb_serial_port_softint(struct usb_serial_port *port); | ||
| 239 | |||
| 240 | extern int usb_serial_probe(struct usb_interface *iface, const struct usb_device_id *id); | ||
| 241 | extern void usb_serial_disconnect(struct usb_interface *iface); | ||
| 242 | |||
| 243 | extern int ezusb_writememory (struct usb_serial *serial, int address, unsigned char *data, int length, __u8 bRequest); | ||
| 244 | extern int ezusb_set_reset (struct usb_serial *serial, unsigned char reset_bit); | ||
| 245 | |||
| 246 | /* USB Serial console functions */ | ||
| 247 | #ifdef CONFIG_USB_SERIAL_CONSOLE | ||
| 248 | extern void usb_serial_console_init (int debug, int minor); | ||
| 249 | extern void usb_serial_console_exit (void); | ||
| 250 | extern void usb_serial_console_disconnect(struct usb_serial *serial); | ||
| 251 | #else | ||
| 252 | static inline void usb_serial_console_init (int debug, int minor) { } | ||
| 253 | static inline void usb_serial_console_exit (void) { } | ||
| 254 | static inline void usb_serial_console_disconnect(struct usb_serial *serial) {} | ||
| 255 | #endif | ||
| 256 | |||
| 257 | /* Functions needed by other parts of the usbserial core */ | ||
| 258 | extern struct usb_serial *usb_serial_get_by_index (unsigned int minor); | ||
| 259 | extern void usb_serial_put(struct usb_serial *serial); | ||
| 260 | extern int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp); | ||
| 261 | extern int usb_serial_generic_write (struct usb_serial_port *port, const unsigned char *buf, int count); | ||
| 262 | extern void usb_serial_generic_close (struct usb_serial_port *port, struct file *filp); | ||
| 263 | extern int usb_serial_generic_write_room (struct usb_serial_port *port); | ||
| 264 | extern int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port); | ||
| 265 | extern void usb_serial_generic_read_bulk_callback (struct urb *urb, struct pt_regs *regs); | ||
| 266 | extern void usb_serial_generic_write_bulk_callback (struct urb *urb, struct pt_regs *regs); | ||
| 267 | extern void usb_serial_generic_shutdown (struct usb_serial *serial); | ||
| 268 | extern int usb_serial_generic_register (int debug); | ||
| 269 | extern void usb_serial_generic_deregister (void); | ||
| 270 | |||
| 271 | extern int usb_serial_bus_register (struct usb_serial_driver *device); | ||
| 272 | extern void usb_serial_bus_deregister (struct usb_serial_driver *device); | ||
| 273 | |||
| 274 | extern struct usb_serial_driver usb_serial_generic_device; | ||
| 275 | extern struct bus_type usb_serial_bus_type; | ||
| 276 | extern struct tty_driver *usb_serial_tty_driver; | ||
| 277 | |||
| 278 | static inline void usb_serial_debug_data(int debug, | ||
| 279 | struct device *dev, | ||
| 280 | const char *function, int size, | ||
| 281 | const unsigned char *data) | ||
| 282 | { | ||
| 283 | int i; | ||
| 284 | |||
| 285 | if (debug) { | ||
| 286 | dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ", function, size); | ||
| 287 | for (i = 0; i < size; ++i) | ||
| 288 | printk ("%.2x ", data[i]); | ||
| 289 | printk ("\n"); | ||
| 290 | } | ||
| 291 | } | ||
| 292 | |||
| 293 | /* Use our own dbg macro */ | ||
| 294 | #undef dbg | ||
| 295 | #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg); } while (0) | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | #endif /* ifdef __LINUX_USB_SERIAL_H */ | ||
| 300 | |||
