hokuto Abe / Mbed 2 deprecated nisiBlutooth

USBHost.h@0:db1ba09e8bfa, 2012-07-10 (annotated)

Committer:
hosei2
Date:
Tue Jul 10 11:36:47 2012 +0000
Revision:
0:db1ba09e8bfa
zzz

Who changed what in which revision?

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