Peter Barrett
Bluetooth support for MBED with $2 Bluetooth dongles. Includes a USB host and built in support for bluetooth HID devices such as mice, keyboards and wii controllers.
USBHost.h@0:606b230e5b4a, 2010-04-10 (annotated)
- Committer:
- peterbarrett1967
- Date:
- Sat Apr 10 00:30:24 2010 +0000
- Revision:
- 0:606b230e5b4a
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| peterbarrett1967 | 0:606b230e5b4a | 1 | |
| peterbarrett1967 | 0:606b230e5b4a | 2 | /* |
| peterbarrett1967 | 0:606b230e5b4a | 3 | Copyright (c) 2010 Peter Barrett |
| peterbarrett1967 | 0:606b230e5b4a | 4 | |
| peterbarrett1967 | 0:606b230e5b4a | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| peterbarrett1967 | 0:606b230e5b4a | 6 | of this software and associated documentation files (the "Software"), to deal |
| peterbarrett1967 | 0:606b230e5b4a | 7 | in the Software without restriction, including without limitation the rights |
| peterbarrett1967 | 0:606b230e5b4a | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| peterbarrett1967 | 0:606b230e5b4a | 9 | copies of the Software, and to permit persons to whom the Software is |
| peterbarrett1967 | 0:606b230e5b4a | 10 | furnished to do so, subject to the following conditions: |
| peterbarrett1967 | 0:606b230e5b4a | 11 | |
| peterbarrett1967 | 0:606b230e5b4a | 12 | The above copyright notice and this permission notice shall be included in |
| peterbarrett1967 | 0:606b230e5b4a | 13 | all copies or substantial portions of the Software. |
| peterbarrett1967 | 0:606b230e5b4a | 14 | |
| peterbarrett1967 | 0:606b230e5b4a | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| peterbarrett1967 | 0:606b230e5b4a | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| peterbarrett1967 | 0:606b230e5b4a | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| peterbarrett1967 | 0:606b230e5b4a | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| peterbarrett1967 | 0:606b230e5b4a | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| peterbarrett1967 | 0:606b230e5b4a | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| peterbarrett1967 | 0:606b230e5b4a | 21 | THE SOFTWARE. |
| peterbarrett1967 | 0:606b230e5b4a | 22 | */ |
| peterbarrett1967 | 0:606b230e5b4a | 23 | |
| peterbarrett1967 | 0:606b230e5b4a | 24 | #ifndef USBHOST_H |
| peterbarrett1967 | 0:606b230e5b4a | 25 | #define USBHOST_H |
| peterbarrett1967 | 0:606b230e5b4a | 26 | |
| peterbarrett1967 | 0:606b230e5b4a | 27 | #ifndef u8 |
| peterbarrett1967 | 0:606b230e5b4a | 28 | typedef unsigned char u8; |
| peterbarrett1967 | 0:606b230e5b4a | 29 | typedef unsigned short u16; |
| peterbarrett1967 | 0:606b230e5b4a | 30 | typedef unsigned long u32; |
| peterbarrett1967 | 0:606b230e5b4a | 31 | |
| peterbarrett1967 | 0:606b230e5b4a | 32 | typedef char s8; |
| peterbarrett1967 | 0:606b230e5b4a | 33 | typedef short s16; |
| peterbarrett1967 | 0:606b230e5b4a | 34 | typedef char s32; |
| peterbarrett1967 | 0:606b230e5b4a | 35 | #endif |
| peterbarrett1967 | 0:606b230e5b4a | 36 | |
| peterbarrett1967 | 0:606b230e5b4a | 37 | #define ENDPOINT_CONTROL 0 |
| peterbarrett1967 | 0:606b230e5b4a | 38 | #define ENDPOINT_ISOCRONOUS 1 |
| peterbarrett1967 | 0:606b230e5b4a | 39 | #define ENDPOINT_BULK 2 |
| peterbarrett1967 | 0:606b230e5b4a | 40 | #define ENDPOINT_INTERRUPT 3 |
| peterbarrett1967 | 0:606b230e5b4a | 41 | |
| peterbarrett1967 | 0:606b230e5b4a | 42 | #define DESCRIPTOR_TYPE_DEVICE 1 |
| peterbarrett1967 | 0:606b230e5b4a | 43 | #define DESCRIPTOR_TYPE_CONFIGURATION 2 |
| peterbarrett1967 | 0:606b230e5b4a | 44 | #define DESCRIPTOR_TYPE_STRING 3 |
| peterbarrett1967 | 0:606b230e5b4a | 45 | #define DESCRIPTOR_TYPE_INTERFACE 4 |
| peterbarrett1967 | 0:606b230e5b4a | 46 | #define DESCRIPTOR_TYPE_ENDPOINT 5 |
| peterbarrett1967 | 0:606b230e5b4a | 47 | |
| peterbarrett1967 | 0:606b230e5b4a | 48 | #define DESCRIPTOR_TYPE_HID 0x21 |
| peterbarrett1967 | 0:606b230e5b4a | 49 | #define DESCRIPTOR_TYPE_REPORT 0x22 |
| peterbarrett1967 | 0:606b230e5b4a | 50 | #define DESCRIPTOR_TYPE_PHYSICAL 0x23 |
| peterbarrett1967 | 0:606b230e5b4a | 51 | #define DESCRIPTOR_TYPE_HUB 0x29 |
| peterbarrett1967 | 0:606b230e5b4a | 52 | |
| peterbarrett1967 | 0:606b230e5b4a | 53 | enum USB_CLASS_CODE |
| peterbarrett1967 | 0:606b230e5b4a | 54 | { |
| peterbarrett1967 | 0:606b230e5b4a | 55 | CLASS_DEVICE, |
| peterbarrett1967 | 0:606b230e5b4a | 56 | CLASS_AUDIO, |
| peterbarrett1967 | 0:606b230e5b4a | 57 | CLASS_COMM_AND_CDC_CONTROL, |
| peterbarrett1967 | 0:606b230e5b4a | 58 | CLASS_HID, |
| peterbarrett1967 | 0:606b230e5b4a | 59 | CLASS_PHYSICAL = 0x05, |
| peterbarrett1967 | 0:606b230e5b4a | 60 | CLASS_STILL_IMAGING, |
| peterbarrett1967 | 0:606b230e5b4a | 61 | CLASS_PRINTER, |
| peterbarrett1967 | 0:606b230e5b4a | 62 | CLASS_MASS_STORAGE, |
| peterbarrett1967 | 0:606b230e5b4a | 63 | CLASS_HUB, |
| peterbarrett1967 | 0:606b230e5b4a | 64 | CLASS_CDC_DATA, |
| peterbarrett1967 | 0:606b230e5b4a | 65 | CLASS_SMART_CARD, |
| peterbarrett1967 | 0:606b230e5b4a | 66 | CLASS_CONTENT_SECURITY = 0x0D, |
| peterbarrett1967 | 0:606b230e5b4a | 67 | CLASS_VIDEO = 0x0E, |
| peterbarrett1967 | 0:606b230e5b4a | 68 | CLASS_DIAGNOSTIC_DEVICE = 0xDC, |
| peterbarrett1967 | 0:606b230e5b4a | 69 | CLASS_WIRELESS_CONTROLLER = 0xE0, |
| peterbarrett1967 | 0:606b230e5b4a | 70 | CLASS_MISCELLANEOUS = 0xEF, |
| peterbarrett1967 | 0:606b230e5b4a | 71 | CLASS_APP_SPECIFIC = 0xFE, |
| peterbarrett1967 | 0:606b230e5b4a | 72 | CLASS_VENDOR_SPECIFIC = 0xFF |
| peterbarrett1967 | 0:606b230e5b4a | 73 | }; |
| peterbarrett1967 | 0:606b230e5b4a | 74 | |
| peterbarrett1967 | 0:606b230e5b4a | 75 | #define DEVICE_TO_HOST 0x80 |
| peterbarrett1967 | 0:606b230e5b4a | 76 | #define HOST_TO_DEVICE 0x00 |
| peterbarrett1967 | 0:606b230e5b4a | 77 | #define REQUEST_TYPE_CLASS 0x20 |
| peterbarrett1967 | 0:606b230e5b4a | 78 | #define RECIPIENT_DEVICE 0x00 |
| peterbarrett1967 | 0:606b230e5b4a | 79 | #define RECIPIENT_INTERFACE 0x01 |
| peterbarrett1967 | 0:606b230e5b4a | 80 | #define RECIPIENT_ENDPOINT 0x02 |
| peterbarrett1967 | 0:606b230e5b4a | 81 | #define RECIPIENT_OTHER 0x03 |
| peterbarrett1967 | 0:606b230e5b4a | 82 | |
| peterbarrett1967 | 0:606b230e5b4a | 83 | #define GET_STATUS 0 |
| peterbarrett1967 | 0:606b230e5b4a | 84 | #define CLEAR_FEATURE 1 |
| peterbarrett1967 | 0:606b230e5b4a | 85 | #define SET_FEATURE 3 |
| peterbarrett1967 | 0:606b230e5b4a | 86 | #define SET_ADDRESS 5 |
| peterbarrett1967 | 0:606b230e5b4a | 87 | #define GET_DESCRIPTOR 6 |
| peterbarrett1967 | 0:606b230e5b4a | 88 | #define SET_DESCRIPTOR 7 |
| peterbarrett1967 | 0:606b230e5b4a | 89 | #define GET_CONFIGURATION 8 |
| peterbarrett1967 | 0:606b230e5b4a | 90 | #define SET_CONFIGURATION 9 |
| peterbarrett1967 | 0:606b230e5b4a | 91 | #define GET_INTERFACE 10 |
| peterbarrett1967 | 0:606b230e5b4a | 92 | #define SET_INTERFACE 11 |
| peterbarrett1967 | 0:606b230e5b4a | 93 | #define SYNCH_FRAME 11 |
| peterbarrett1967 | 0:606b230e5b4a | 94 | |
| peterbarrett1967 | 0:606b230e5b4a | 95 | // -5 is nak |
| peterbarrett1967 | 0:606b230e5b4a | 96 | /* |
| peterbarrett1967 | 0:606b230e5b4a | 97 | 0010 ACK Handshake |
| peterbarrett1967 | 0:606b230e5b4a | 98 | 1010 NAK Handshake |
| peterbarrett1967 | 0:606b230e5b4a | 99 | 1110 STALL Handshake |
| peterbarrett1967 | 0:606b230e5b4a | 100 | 0110 NYET (No Response Yet) |
| peterbarrett1967 | 0:606b230e5b4a | 101 | */ |
| peterbarrett1967 | 0:606b230e5b4a | 102 | |
| peterbarrett1967 | 0:606b230e5b4a | 103 | #define IO_PENDING -100 |
| peterbarrett1967 | 0:606b230e5b4a | 104 | #define ERR_ENDPOINT_NONE_LEFT -101 |
| peterbarrett1967 | 0:606b230e5b4a | 105 | #define ERR_ENDPOINT_NOT_FOUND -102 |
| peterbarrett1967 | 0:606b230e5b4a | 106 | #define ERR_DEVICE_NOT_FOUND -103 |
| peterbarrett1967 | 0:606b230e5b4a | 107 | #define ERR_DEVICE_NONE_LEFT -104 |
| peterbarrett1967 | 0:606b230e5b4a | 108 | #define ERR_HUB_INIT_FAILED -105 |
| peterbarrett1967 | 0:606b230e5b4a | 109 | #define ERR_INTERFACE_NOT_FOUND -106 |
| peterbarrett1967 | 0:606b230e5b4a | 110 | |
| peterbarrett1967 | 0:606b230e5b4a | 111 | typedef struct |
| peterbarrett1967 | 0:606b230e5b4a | 112 | { |
| peterbarrett1967 | 0:606b230e5b4a | 113 | u8 bLength; |
| peterbarrett1967 | 0:606b230e5b4a | 114 | u8 bDescriptorType; |
| peterbarrett1967 | 0:606b230e5b4a | 115 | u16 bcdUSB; |
| peterbarrett1967 | 0:606b230e5b4a | 116 | u8 bDeviceClass; |
| peterbarrett1967 | 0:606b230e5b4a | 117 | u8 bDeviceSubClass; |
| peterbarrett1967 | 0:606b230e5b4a | 118 | u8 bDeviceProtocol; |
| peterbarrett1967 | 0:606b230e5b4a | 119 | u8 bMaxPacketSize; |
| peterbarrett1967 | 0:606b230e5b4a | 120 | u16 idVendor; |
| peterbarrett1967 | 0:606b230e5b4a | 121 | u16 idProduct; |
| peterbarrett1967 | 0:606b230e5b4a | 122 | u16 bcdDevice; // version |
| peterbarrett1967 | 0:606b230e5b4a | 123 | u8 iManufacturer; |
| peterbarrett1967 | 0:606b230e5b4a | 124 | u8 iProduct; |
| peterbarrett1967 | 0:606b230e5b4a | 125 | u8 iSerialNumber; |
| peterbarrett1967 | 0:606b230e5b4a | 126 | u8 bNumConfigurations; |
| peterbarrett1967 | 0:606b230e5b4a | 127 | } DeviceDescriptor; // 16 bytes |
| peterbarrett1967 | 0:606b230e5b4a | 128 | |
| peterbarrett1967 | 0:606b230e5b4a | 129 | typedef struct |
| peterbarrett1967 | 0:606b230e5b4a | 130 | { |
| peterbarrett1967 | 0:606b230e5b4a | 131 | u8 bLength; |
| peterbarrett1967 | 0:606b230e5b4a | 132 | u8 bDescriptorType; |
| peterbarrett1967 | 0:606b230e5b4a | 133 | u16 wTotalLength; |
| peterbarrett1967 | 0:606b230e5b4a | 134 | u8 bNumInterfaces; |
| peterbarrett1967 | 0:606b230e5b4a | 135 | u8 bConfigurationValue; // Value to use as an argument to select this configuration |
| peterbarrett1967 | 0:606b230e5b4a | 136 | u8 iConfiguration; // Index of String Descriptor describing this configuration |
| peterbarrett1967 | 0:606b230e5b4a | 137 | u8 bmAttributes; // Bitmap D7 Reserved, set to 1. (USB 1.0 Bus Powered),D6 Self Powered,D5 Remote Wakeup,D4..0 = 0 |
| peterbarrett1967 | 0:606b230e5b4a | 138 | u8 bMaxPower; // Maximum Power Consumption in 2mA units |
| peterbarrett1967 | 0:606b230e5b4a | 139 | } ConfigurationDescriptor; |
| peterbarrett1967 | 0:606b230e5b4a | 140 | |
| peterbarrett1967 | 0:606b230e5b4a | 141 | typedef struct |
| peterbarrett1967 | 0:606b230e5b4a | 142 | { |
| peterbarrett1967 | 0:606b230e5b4a | 143 | u8 bLength; |
| peterbarrett1967 | 0:606b230e5b4a | 144 | u8 bDescriptorType; |
| peterbarrett1967 | 0:606b230e5b4a | 145 | u8 bInterfaceNumber; |
| peterbarrett1967 | 0:606b230e5b4a | 146 | u8 bAlternateSetting; |
| peterbarrett1967 | 0:606b230e5b4a | 147 | u8 bNumEndpoints; |
| peterbarrett1967 | 0:606b230e5b4a | 148 | u8 bInterfaceClass; |
| peterbarrett1967 | 0:606b230e5b4a | 149 | u8 bInterfaceSubClass; |
| peterbarrett1967 | 0:606b230e5b4a | 150 | u8 bInterfaceProtocol; |
| peterbarrett1967 | 0:606b230e5b4a | 151 | u8 iInterface; // Index of String Descriptor Describing this interface |
| peterbarrett1967 | 0:606b230e5b4a | 152 | } InterfaceDescriptor; |
| peterbarrett1967 | 0:606b230e5b4a | 153 | |
| peterbarrett1967 | 0:606b230e5b4a | 154 | typedef struct |
| peterbarrett1967 | 0:606b230e5b4a | 155 | { |
| peterbarrett1967 | 0:606b230e5b4a | 156 | u8 bLength; |
| peterbarrett1967 | 0:606b230e5b4a | 157 | u8 bDescriptorType; |
| peterbarrett1967 | 0:606b230e5b4a | 158 | u8 bEndpointAddress; // Bits 0:3 endpoint, Bits 7 Direction 0 = Out, 1 = In (Ignored for Control Endpoints) |
| peterbarrett1967 | 0:606b230e5b4a | 159 | u8 bmAttributes; // Bits 0:1 00 = Control, 01 = Isochronous, 10 = Bulk, 11 = Interrupt |
| peterbarrett1967 | 0:606b230e5b4a | 160 | u16 wMaxPacketSize; |
| peterbarrett1967 | 0:606b230e5b4a | 161 | u8 bInterval; // Interval for polling endpoint data transfers. |
| peterbarrett1967 | 0:606b230e5b4a | 162 | } EndpointDescriptor; |
| peterbarrett1967 | 0:606b230e5b4a | 163 | |
| peterbarrett1967 | 0:606b230e5b4a | 164 | typedef struct { |
| peterbarrett1967 | 0:606b230e5b4a | 165 | u8 bLength; |
| peterbarrett1967 | 0:606b230e5b4a | 166 | u8 bDescriptorType; |
| peterbarrett1967 | 0:606b230e5b4a | 167 | u16 bcdHID; |
| peterbarrett1967 | 0:606b230e5b4a | 168 | u8 bCountryCode; |
| peterbarrett1967 | 0:606b230e5b4a | 169 | u8 bNumDescriptors; |
| peterbarrett1967 | 0:606b230e5b4a | 170 | u8 bDescriptorType2; |
| peterbarrett1967 | 0:606b230e5b4a | 171 | u16 wDescriptorLength; |
| peterbarrett1967 | 0:606b230e5b4a | 172 | } HIDDescriptor; |
| peterbarrett1967 | 0:606b230e5b4a | 173 | |
| peterbarrett1967 | 0:606b230e5b4a | 174 | //============================================================================ |
| peterbarrett1967 | 0:606b230e5b4a | 175 | //============================================================================ |
| peterbarrett1967 | 0:606b230e5b4a | 176 | |
| peterbarrett1967 | 0:606b230e5b4a | 177 | |
| peterbarrett1967 | 0:606b230e5b4a | 178 | void USBInit(); |
| peterbarrett1967 | 0:606b230e5b4a | 179 | void USBLoop(); |
| peterbarrett1967 | 0:606b230e5b4a | 180 | u8* USBGetBuffer(u32* len); |
| peterbarrett1967 | 0:606b230e5b4a | 181 | |
| peterbarrett1967 | 0:606b230e5b4a | 182 | // Optional callback for transfers, called at interrupt time |
| peterbarrett1967 | 0:606b230e5b4a | 183 | typedef void (*USBCallback)(int device, int endpoint, int status, u8* data, int len, void* userData); |
| peterbarrett1967 | 0:606b230e5b4a | 184 | |
| peterbarrett1967 | 0:606b230e5b4a | 185 | // Transfers |
| peterbarrett1967 | 0:606b230e5b4a | 186 | int USBControlTransfer(int device, int request_type, int request, int value, int index, u8* data, int length, USBCallback callback = 0, void* userData = 0); |
| peterbarrett1967 | 0:606b230e5b4a | 187 | int USBInterruptTransfer(int device, int ep, u8* data, int length, USBCallback callback = 0, void* userData = 0); |
| peterbarrett1967 | 0:606b230e5b4a | 188 | int USBBulkTransfer(int device, int ep, u8* data, int length, USBCallback callback = 0, void* userData = 0); |
| peterbarrett1967 | 0:606b230e5b4a | 189 | |
| peterbarrett1967 | 0:606b230e5b4a | 190 | // Standard Device methods |
| peterbarrett1967 | 0:606b230e5b4a | 191 | int GetDescriptor(int device, int descType, int descIndex, u8* data, int length); |
| peterbarrett1967 | 0:606b230e5b4a | 192 | int GetString(int device, int index, char* dst, int length); |
| peterbarrett1967 | 0:606b230e5b4a | 193 | int SetAddress(int device, int new_addr); |
| peterbarrett1967 | 0:606b230e5b4a | 194 | int SetConfiguration(int device, int configNum); |
| peterbarrett1967 | 0:606b230e5b4a | 195 | int SetInterface(int device, int ifNum, int altNum); |
| peterbarrett1967 | 0:606b230e5b4a | 196 | |
| peterbarrett1967 | 0:606b230e5b4a | 197 | // Implemented to notify app of the arrival of a device |
| peterbarrett1967 | 0:606b230e5b4a | 198 | void OnLoadDevice(int device, DeviceDescriptor* deviceDesc, InterfaceDescriptor* interfaceDesc); |
| peterbarrett1967 | 0:606b230e5b4a | 199 | |
| peterbarrett1967 | 0:606b230e5b4a | 200 | #endif |