Student project by David Berlin and Boris Dogadov made for the Embedded Systems Workshop course given in Tel-Aviv University on 2010 by Sivan Toledo. Visit the project website for more details: http://davidberlin.co.il/sadna/ .

Dependencies:   EthernetNetIf NTPClient_NetServices mbed HTTPServer HTTPClient CyaSSL

Committer:
sivan_toledo
Date:
Mon Apr 25 12:31:46 2011 +0000
Revision:
1:b05231650f32
Parent:
0:3e7d6f496a67

        

Who changed what in which revision?

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