first release for keyboard
Fork of F401RE-USBHost by
USBHost/USBHostTypes.h@5:10bfc10afcc8, 2014-01-27 (annotated)
- Committer:
- va009039
- Date:
- Mon Jan 27 11:00:28 2014 +0000
- Revision:
- 5:10bfc10afcc8
- Child:
- 8:6463cd1964c0
add isochronous transfer
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
va009039 | 5:10bfc10afcc8 | 1 | /* mbed USBHost Library |
va009039 | 5:10bfc10afcc8 | 2 | * Copyright (c) 2006-2013 ARM Limited |
va009039 | 5:10bfc10afcc8 | 3 | * |
va009039 | 5:10bfc10afcc8 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
va009039 | 5:10bfc10afcc8 | 5 | * you may not use this file except in compliance with the License. |
va009039 | 5:10bfc10afcc8 | 6 | * You may obtain a copy of the License at |
va009039 | 5:10bfc10afcc8 | 7 | * |
va009039 | 5:10bfc10afcc8 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
va009039 | 5:10bfc10afcc8 | 9 | * |
va009039 | 5:10bfc10afcc8 | 10 | * Unless required by applicable law or agreed to in writing, software |
va009039 | 5:10bfc10afcc8 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
va009039 | 5:10bfc10afcc8 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
va009039 | 5:10bfc10afcc8 | 13 | * See the License for the specific language governing permissions and |
va009039 | 5:10bfc10afcc8 | 14 | * limitations under the License. |
va009039 | 5:10bfc10afcc8 | 15 | */ |
va009039 | 5:10bfc10afcc8 | 16 | |
va009039 | 5:10bfc10afcc8 | 17 | #ifndef USB_INC_H |
va009039 | 5:10bfc10afcc8 | 18 | #define USB_INC_H |
va009039 | 5:10bfc10afcc8 | 19 | |
va009039 | 5:10bfc10afcc8 | 20 | #include "mbed.h" |
va009039 | 5:10bfc10afcc8 | 21 | #include "toolchain.h" |
va009039 | 5:10bfc10afcc8 | 22 | |
va009039 | 5:10bfc10afcc8 | 23 | enum USB_TYPE { |
va009039 | 5:10bfc10afcc8 | 24 | USB_TYPE_OK = 0, |
va009039 | 5:10bfc10afcc8 | 25 | |
va009039 | 5:10bfc10afcc8 | 26 | // completion code |
va009039 | 5:10bfc10afcc8 | 27 | USB_TYPE_CRC_ERROR = 1, |
va009039 | 5:10bfc10afcc8 | 28 | USB_TYPE_BIT_STUFFING_ERROR = 2, |
va009039 | 5:10bfc10afcc8 | 29 | USB_TYPE_DATA_TOGGLE_MISMATCH_ERROR = 3, |
va009039 | 5:10bfc10afcc8 | 30 | USB_TYPE_STALL_ERROR = 4, |
va009039 | 5:10bfc10afcc8 | 31 | USB_TYPE_DEVICE_NOT_RESPONDING_ERROR = 5, |
va009039 | 5:10bfc10afcc8 | 32 | USB_TYPE_PID_CHECK_FAILURE_ERROR = 6, |
va009039 | 5:10bfc10afcc8 | 33 | USB_TYPE_UNEXPECTED_PID_ERROR = 7, |
va009039 | 5:10bfc10afcc8 | 34 | USB_TYPE_DATA_OVERRUN_ERROR = 8, |
va009039 | 5:10bfc10afcc8 | 35 | USB_TYPE_DATA_UNDERRUN_ERROR = 9, |
va009039 | 5:10bfc10afcc8 | 36 | USB_TYPE_RESERVED = 9, |
va009039 | 5:10bfc10afcc8 | 37 | USB_TYPE_RESERVED_ = 10, |
va009039 | 5:10bfc10afcc8 | 38 | USB_TYPE_BUFFER_OVERRUN_ERROR = 12, |
va009039 | 5:10bfc10afcc8 | 39 | USB_TYPE_BUFFER_UNDERRUN_ERROR = 13, |
va009039 | 5:10bfc10afcc8 | 40 | |
va009039 | 5:10bfc10afcc8 | 41 | // general usb state |
va009039 | 5:10bfc10afcc8 | 42 | USB_TYPE_DISCONNECTED = 14, |
va009039 | 5:10bfc10afcc8 | 43 | USB_TYPE_FREE = 15, |
va009039 | 5:10bfc10afcc8 | 44 | USB_TYPE_IDLE = 16, |
va009039 | 5:10bfc10afcc8 | 45 | USB_TYPE_PROCESSING = 17, |
va009039 | 5:10bfc10afcc8 | 46 | |
va009039 | 5:10bfc10afcc8 | 47 | USB_TYPE_ERROR = 18, |
va009039 | 5:10bfc10afcc8 | 48 | }; |
va009039 | 5:10bfc10afcc8 | 49 | |
va009039 | 5:10bfc10afcc8 | 50 | |
va009039 | 5:10bfc10afcc8 | 51 | enum ENDPOINT_DIRECTION { |
va009039 | 5:10bfc10afcc8 | 52 | OUT = 1, |
va009039 | 5:10bfc10afcc8 | 53 | IN |
va009039 | 5:10bfc10afcc8 | 54 | }; |
va009039 | 5:10bfc10afcc8 | 55 | |
va009039 | 5:10bfc10afcc8 | 56 | enum ENDPOINT_TYPE { |
va009039 | 5:10bfc10afcc8 | 57 | CONTROL_ENDPOINT = 0, |
va009039 | 5:10bfc10afcc8 | 58 | ISOCHRONOUS_ENDPOINT, |
va009039 | 5:10bfc10afcc8 | 59 | BULK_ENDPOINT, |
va009039 | 5:10bfc10afcc8 | 60 | INTERRUPT_ENDPOINT |
va009039 | 5:10bfc10afcc8 | 61 | }; |
va009039 | 5:10bfc10afcc8 | 62 | |
va009039 | 5:10bfc10afcc8 | 63 | #define AUDIO_CLASS 0x01 |
va009039 | 5:10bfc10afcc8 | 64 | #define CDC_CLASS 0x02 |
va009039 | 5:10bfc10afcc8 | 65 | #define HID_CLASS 0x03 |
va009039 | 5:10bfc10afcc8 | 66 | #define MSD_CLASS 0x08 |
va009039 | 5:10bfc10afcc8 | 67 | #define HUB_CLASS 0x09 |
va009039 | 5:10bfc10afcc8 | 68 | #define SERIAL_CLASS 0x0A |
va009039 | 5:10bfc10afcc8 | 69 | |
va009039 | 5:10bfc10afcc8 | 70 | #define DEVICE_DESCRIPTOR (1) |
va009039 | 5:10bfc10afcc8 | 71 | #define CONFIGURATION_DESCRIPTOR (2) |
va009039 | 5:10bfc10afcc8 | 72 | #define INTERFACE_DESCRIPTOR (4) |
va009039 | 5:10bfc10afcc8 | 73 | #define ENDPOINT_DESCRIPTOR (5) |
va009039 | 5:10bfc10afcc8 | 74 | #define HID_DESCRIPTOR (33) |
va009039 | 5:10bfc10afcc8 | 75 | |
va009039 | 5:10bfc10afcc8 | 76 | // ----------- Control RequestType Fields ----------- |
va009039 | 5:10bfc10afcc8 | 77 | #define USB_DEVICE_TO_HOST 0x80 |
va009039 | 5:10bfc10afcc8 | 78 | #define USB_HOST_TO_DEVICE 0x00 |
va009039 | 5:10bfc10afcc8 | 79 | #define USB_REQUEST_TYPE_CLASS 0x20 |
va009039 | 5:10bfc10afcc8 | 80 | #define USB_REQUEST_TYPE_STANDARD 0x00 |
va009039 | 5:10bfc10afcc8 | 81 | #define USB_RECIPIENT_DEVICE 0x00 |
va009039 | 5:10bfc10afcc8 | 82 | #define USB_RECIPIENT_INTERFACE 0x01 |
va009039 | 5:10bfc10afcc8 | 83 | #define USB_RECIPIENT_ENDPOINT 0x02 |
va009039 | 5:10bfc10afcc8 | 84 | |
va009039 | 5:10bfc10afcc8 | 85 | // -------------- USB Standard Requests -------------- |
va009039 | 5:10bfc10afcc8 | 86 | #define SET_ADDRESS 0x05 |
va009039 | 5:10bfc10afcc8 | 87 | #define GET_DESCRIPTOR 0x06 |
va009039 | 5:10bfc10afcc8 | 88 | #define SET_CONFIGURATION 0x09 |
va009039 | 5:10bfc10afcc8 | 89 | #define SET_INTERFACE 0x0b |
va009039 | 5:10bfc10afcc8 | 90 | #define CLEAR_FEATURE 0x01 |
va009039 | 5:10bfc10afcc8 | 91 | |
va009039 | 5:10bfc10afcc8 | 92 | // -------------- USB Descriptor Length -------------- |
va009039 | 5:10bfc10afcc8 | 93 | #define DEVICE_DESCRIPTOR_LENGTH 0x12 |
va009039 | 5:10bfc10afcc8 | 94 | #define CONFIGURATION_DESCRIPTOR_LENGTH 0x09 |
va009039 | 5:10bfc10afcc8 | 95 | |
va009039 | 5:10bfc10afcc8 | 96 | // PID |
va009039 | 5:10bfc10afcc8 | 97 | #define DATA0 0x03 |
va009039 | 5:10bfc10afcc8 | 98 | #define DATA1 0x0b |
va009039 | 5:10bfc10afcc8 | 99 | #define ACK 0x02 |
va009039 | 5:10bfc10afcc8 | 100 | #define STALL 0x0e |
va009039 | 5:10bfc10afcc8 | 101 | #define NAK 0x0a |
va009039 | 5:10bfc10afcc8 | 102 | |
va009039 | 5:10bfc10afcc8 | 103 | #pragma pack(push,1) |
va009039 | 5:10bfc10afcc8 | 104 | typedef struct { |
va009039 | 5:10bfc10afcc8 | 105 | uint8_t bLength; |
va009039 | 5:10bfc10afcc8 | 106 | uint8_t bDescriptorType; |
va009039 | 5:10bfc10afcc8 | 107 | uint16_t bcdUSB; |
va009039 | 5:10bfc10afcc8 | 108 | uint8_t bDeviceClass; |
va009039 | 5:10bfc10afcc8 | 109 | uint8_t bDeviceSubClass; |
va009039 | 5:10bfc10afcc8 | 110 | uint8_t bDeviceProtocol; |
va009039 | 5:10bfc10afcc8 | 111 | uint8_t bMaxPacketSize; |
va009039 | 5:10bfc10afcc8 | 112 | uint16_t idVendor; |
va009039 | 5:10bfc10afcc8 | 113 | uint16_t idProduct; |
va009039 | 5:10bfc10afcc8 | 114 | uint16_t bcdDevice; |
va009039 | 5:10bfc10afcc8 | 115 | uint8_t iManufacturer; |
va009039 | 5:10bfc10afcc8 | 116 | uint8_t iProduct; |
va009039 | 5:10bfc10afcc8 | 117 | uint8_t iSerialNumber; |
va009039 | 5:10bfc10afcc8 | 118 | uint8_t bNumConfigurations; |
va009039 | 5:10bfc10afcc8 | 119 | } PACKED DeviceDescriptor; |
va009039 | 5:10bfc10afcc8 | 120 | |
va009039 | 5:10bfc10afcc8 | 121 | typedef struct { |
va009039 | 5:10bfc10afcc8 | 122 | uint8_t bLength; |
va009039 | 5:10bfc10afcc8 | 123 | uint8_t bDescriptorType; |
va009039 | 5:10bfc10afcc8 | 124 | uint16_t wTotalLength; |
va009039 | 5:10bfc10afcc8 | 125 | uint8_t bNumInterfaces; |
va009039 | 5:10bfc10afcc8 | 126 | uint8_t bConfigurationValue; |
va009039 | 5:10bfc10afcc8 | 127 | uint8_t iConfiguration; |
va009039 | 5:10bfc10afcc8 | 128 | uint8_t bmAttributes; |
va009039 | 5:10bfc10afcc8 | 129 | uint8_t bMaxPower; |
va009039 | 5:10bfc10afcc8 | 130 | } PACKED ConfigurationDescriptor; |
va009039 | 5:10bfc10afcc8 | 131 | |
va009039 | 5:10bfc10afcc8 | 132 | typedef struct { |
va009039 | 5:10bfc10afcc8 | 133 | uint8_t bLength; |
va009039 | 5:10bfc10afcc8 | 134 | uint8_t bDescriptorType; |
va009039 | 5:10bfc10afcc8 | 135 | uint8_t bInterfaceNumber; |
va009039 | 5:10bfc10afcc8 | 136 | uint8_t bAlternateSetting; |
va009039 | 5:10bfc10afcc8 | 137 | uint8_t bNumEndpoints; |
va009039 | 5:10bfc10afcc8 | 138 | uint8_t bInterfaceClass; |
va009039 | 5:10bfc10afcc8 | 139 | uint8_t bInterfaceSubClass; |
va009039 | 5:10bfc10afcc8 | 140 | uint8_t bInterfaceProtocol; |
va009039 | 5:10bfc10afcc8 | 141 | uint8_t iInterface; |
va009039 | 5:10bfc10afcc8 | 142 | } InterfaceDescriptor; |
va009039 | 5:10bfc10afcc8 | 143 | |
va009039 | 5:10bfc10afcc8 | 144 | typedef struct { |
va009039 | 5:10bfc10afcc8 | 145 | uint8_t bLength; |
va009039 | 5:10bfc10afcc8 | 146 | uint8_t bDescriptorType; |
va009039 | 5:10bfc10afcc8 | 147 | uint8_t bEndpointAddress; |
va009039 | 5:10bfc10afcc8 | 148 | uint8_t bmAttributes; |
va009039 | 5:10bfc10afcc8 | 149 | uint16_t wMaxPacketSize; |
va009039 | 5:10bfc10afcc8 | 150 | uint8_t bInterval; |
va009039 | 5:10bfc10afcc8 | 151 | } EndpointDescriptor; |
va009039 | 5:10bfc10afcc8 | 152 | |
va009039 | 5:10bfc10afcc8 | 153 | typedef struct { |
va009039 | 5:10bfc10afcc8 | 154 | uint8_t bDescLength; |
va009039 | 5:10bfc10afcc8 | 155 | uint8_t bDescriptorType; |
va009039 | 5:10bfc10afcc8 | 156 | uint8_t bNbrPorts; |
va009039 | 5:10bfc10afcc8 | 157 | uint16_t wHubCharacteristics; |
va009039 | 5:10bfc10afcc8 | 158 | uint8_t bPwrOn2PwrGood; |
va009039 | 5:10bfc10afcc8 | 159 | uint8_t bHubContrCurrent; |
va009039 | 5:10bfc10afcc8 | 160 | uint8_t DeviceRemovable; |
va009039 | 5:10bfc10afcc8 | 161 | uint8_t PortPweCtrlMak; |
va009039 | 5:10bfc10afcc8 | 162 | } HubDescriptor; |
va009039 | 5:10bfc10afcc8 | 163 | #pragma pack(pop) |
va009039 | 5:10bfc10afcc8 | 164 | |
va009039 | 5:10bfc10afcc8 | 165 | #endif |