Jonathan Tam / Mbed 2 deprecated BalancingRobot_NOINTERRUPTS_OOP_PS3

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.

BLUEUSB/USBHost.h@1:0fd5faa076e7, 2012-02-23 (annotated)

Committer:
jcytam
Date:
Thu Feb 23 23:01:36 2012 +0000
Revision:
1:0fd5faa076e7
Parent:
0:0309bb86b703 
Balancing Robot PS3

Who changed what in which revision?

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