Ad van der Weiden / Mbed 2 deprecated ftusbClass

class library to access fischertechnik interfaces via USB

Dependencies:   FatFileSystem mbed myBlueUSB neigbourhood rfcomm sdp

myUSBHost/USBHost.h@1:4676e8b9b357, 2013-03-11 (annotated)

Committer:
networker
Date:
Mon Mar 11 08:04:37 2013 +0000
Revision:
1:4676e8b9b357
Parent:
0:7da612835693 
first publication of this experimental class, just for sharing wip

Who changed what in which revision?

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