Joe Nagata / Mbed 2 deprecated BlueUSB

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

USBHost.h@0:e5197e77ab57, 2011-02-26 (annotated)

Committer:
joenagata
Date:
Sat Feb 26 07:24:32 2011 +0000
Revision:
0:e5197e77ab57
rev.1

Who changed what in which revision?

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