Fork of the USBDevice library by mbed.
Dependents: mouse1 ECE2035_Agar_Shell_ECE2035_Prana usb_device
Fork of USBDevice by
USBHID/USBHID.cpp@10:1e3d126a322b, 2013-05-30 (annotated)
- Committer:
- emilmont
- Date:
- Thu May 30 17:16:57 2013 +0100
- Revision:
- 10:1e3d126a322b
- Parent:
- 1:80ab0d068708
- Child:
- 11:eeb3cbbaa996
Add LPC4088 target
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
samux | 1:80ab0d068708 | 1 | /* Copyright (c) 2010-2011 mbed.org, MIT License |
samux | 1:80ab0d068708 | 2 | * |
samux | 1:80ab0d068708 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
samux | 1:80ab0d068708 | 4 | * and associated documentation files (the "Software"), to deal in the Software without |
samux | 1:80ab0d068708 | 5 | * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
samux | 1:80ab0d068708 | 6 | * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the |
samux | 1:80ab0d068708 | 7 | * Software is furnished to do so, subject to the following conditions: |
samux | 1:80ab0d068708 | 8 | * |
samux | 1:80ab0d068708 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
samux | 1:80ab0d068708 | 10 | * substantial portions of the Software. |
samux | 1:80ab0d068708 | 11 | * |
samux | 1:80ab0d068708 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
samux | 1:80ab0d068708 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
samux | 1:80ab0d068708 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
samux | 1:80ab0d068708 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
samux | 1:80ab0d068708 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
samux | 1:80ab0d068708 | 17 | */ |
samux | 1:80ab0d068708 | 18 | |
samux | 1:80ab0d068708 | 19 | #include "stdint.h" |
samux | 1:80ab0d068708 | 20 | #include "USBHAL.h" |
samux | 1:80ab0d068708 | 21 | #include "USBHID.h" |
samux | 1:80ab0d068708 | 22 | |
samux | 1:80ab0d068708 | 23 | |
samux | 1:80ab0d068708 | 24 | USBHID::USBHID(uint8_t output_report_length, uint8_t input_report_length, uint16_t vendor_id, uint16_t product_id, uint16_t product_release, bool connect): USBDevice(vendor_id, product_id, product_release) |
samux | 1:80ab0d068708 | 25 | { |
samux | 1:80ab0d068708 | 26 | output_length = output_report_length; |
samux | 1:80ab0d068708 | 27 | input_length = input_report_length; |
samux | 1:80ab0d068708 | 28 | if(connect) { |
samux | 1:80ab0d068708 | 29 | USBDevice::connect(); |
samux | 1:80ab0d068708 | 30 | } |
samux | 1:80ab0d068708 | 31 | } |
samux | 1:80ab0d068708 | 32 | |
samux | 1:80ab0d068708 | 33 | |
samux | 1:80ab0d068708 | 34 | bool USBHID::send(HID_REPORT *report) |
samux | 1:80ab0d068708 | 35 | { |
samux | 1:80ab0d068708 | 36 | return write(EPINT_IN, report->data, report->length, MAX_HID_REPORT_SIZE); |
samux | 1:80ab0d068708 | 37 | } |
samux | 1:80ab0d068708 | 38 | |
samux | 1:80ab0d068708 | 39 | bool USBHID::sendNB(HID_REPORT *report) |
samux | 1:80ab0d068708 | 40 | { |
samux | 1:80ab0d068708 | 41 | return writeNB(EPINT_IN, report->data, report->length, MAX_HID_REPORT_SIZE); |
samux | 1:80ab0d068708 | 42 | } |
samux | 1:80ab0d068708 | 43 | |
samux | 1:80ab0d068708 | 44 | |
samux | 1:80ab0d068708 | 45 | bool USBHID::read(HID_REPORT *report) |
samux | 1:80ab0d068708 | 46 | { |
samux | 1:80ab0d068708 | 47 | uint32_t bytesRead = 0; |
samux | 1:80ab0d068708 | 48 | bool result; |
samux | 1:80ab0d068708 | 49 | result = USBDevice::readEP(EPINT_OUT, report->data, &bytesRead, MAX_HID_REPORT_SIZE); |
samux | 1:80ab0d068708 | 50 | if(!readStart(EPINT_OUT, MAX_HID_REPORT_SIZE)) |
samux | 1:80ab0d068708 | 51 | return false; |
samux | 1:80ab0d068708 | 52 | report->length = bytesRead; |
samux | 1:80ab0d068708 | 53 | return result; |
samux | 1:80ab0d068708 | 54 | } |
samux | 1:80ab0d068708 | 55 | |
samux | 1:80ab0d068708 | 56 | |
samux | 1:80ab0d068708 | 57 | bool USBHID::readNB(HID_REPORT *report) |
samux | 1:80ab0d068708 | 58 | { |
samux | 1:80ab0d068708 | 59 | uint32_t bytesRead = 0; |
samux | 1:80ab0d068708 | 60 | bool result; |
samux | 1:80ab0d068708 | 61 | result = USBDevice::readEP_NB(EPINT_OUT, report->data, &bytesRead, MAX_HID_REPORT_SIZE); |
samux | 1:80ab0d068708 | 62 | report->length = bytesRead; |
samux | 1:80ab0d068708 | 63 | if(!readStart(EPINT_OUT, MAX_HID_REPORT_SIZE)) |
samux | 1:80ab0d068708 | 64 | return false; |
samux | 1:80ab0d068708 | 65 | return result; |
samux | 1:80ab0d068708 | 66 | } |
samux | 1:80ab0d068708 | 67 | |
samux | 1:80ab0d068708 | 68 | |
samux | 1:80ab0d068708 | 69 | uint16_t USBHID::reportDescLength() { |
samux | 1:80ab0d068708 | 70 | reportDesc(); |
samux | 1:80ab0d068708 | 71 | return reportLength; |
samux | 1:80ab0d068708 | 72 | } |
samux | 1:80ab0d068708 | 73 | |
samux | 1:80ab0d068708 | 74 | |
samux | 1:80ab0d068708 | 75 | |
samux | 1:80ab0d068708 | 76 | // |
samux | 1:80ab0d068708 | 77 | // Route callbacks from lower layers to class(es) |
samux | 1:80ab0d068708 | 78 | // |
samux | 1:80ab0d068708 | 79 | |
samux | 1:80ab0d068708 | 80 | |
samux | 1:80ab0d068708 | 81 | // Called in ISR context |
samux | 1:80ab0d068708 | 82 | // Called by USBDevice on Endpoint0 request |
samux | 1:80ab0d068708 | 83 | // This is used to handle extensions to standard requests |
samux | 1:80ab0d068708 | 84 | // and class specific requests |
samux | 1:80ab0d068708 | 85 | // Return true if class handles this request |
samux | 1:80ab0d068708 | 86 | bool USBHID::USBCallback_request() { |
samux | 1:80ab0d068708 | 87 | bool success = false; |
samux | 1:80ab0d068708 | 88 | CONTROL_TRANSFER * transfer = getTransferPtr(); |
samux | 1:80ab0d068708 | 89 | uint8_t *hidDescriptor; |
samux | 1:80ab0d068708 | 90 | |
samux | 1:80ab0d068708 | 91 | // Process additional standard requests |
samux | 1:80ab0d068708 | 92 | |
samux | 1:80ab0d068708 | 93 | if ((transfer->setup.bmRequestType.Type == STANDARD_TYPE)) |
samux | 1:80ab0d068708 | 94 | { |
samux | 1:80ab0d068708 | 95 | switch (transfer->setup.bRequest) |
samux | 1:80ab0d068708 | 96 | { |
samux | 1:80ab0d068708 | 97 | case GET_DESCRIPTOR: |
samux | 1:80ab0d068708 | 98 | switch (DESCRIPTOR_TYPE(transfer->setup.wValue)) |
samux | 1:80ab0d068708 | 99 | { |
samux | 1:80ab0d068708 | 100 | case REPORT_DESCRIPTOR: |
samux | 1:80ab0d068708 | 101 | if ((reportDesc() != NULL) \ |
samux | 1:80ab0d068708 | 102 | && (reportDescLength() != 0)) |
samux | 1:80ab0d068708 | 103 | { |
samux | 1:80ab0d068708 | 104 | transfer->remaining = reportDescLength(); |
samux | 1:80ab0d068708 | 105 | transfer->ptr = reportDesc(); |
samux | 1:80ab0d068708 | 106 | transfer->direction = DEVICE_TO_HOST; |
samux | 1:80ab0d068708 | 107 | success = true; |
samux | 1:80ab0d068708 | 108 | } |
samux | 1:80ab0d068708 | 109 | break; |
samux | 1:80ab0d068708 | 110 | case HID_DESCRIPTOR: |
samux | 1:80ab0d068708 | 111 | // Find the HID descriptor, after the configuration descriptor |
samux | 1:80ab0d068708 | 112 | hidDescriptor = findDescriptor(HID_DESCRIPTOR); |
samux | 1:80ab0d068708 | 113 | if (hidDescriptor != NULL) |
samux | 1:80ab0d068708 | 114 | { |
samux | 1:80ab0d068708 | 115 | transfer->remaining = HID_DESCRIPTOR_LENGTH; |
samux | 1:80ab0d068708 | 116 | transfer->ptr = hidDescriptor; |
samux | 1:80ab0d068708 | 117 | transfer->direction = DEVICE_TO_HOST; |
samux | 1:80ab0d068708 | 118 | success = true; |
samux | 1:80ab0d068708 | 119 | } |
samux | 1:80ab0d068708 | 120 | break; |
samux | 1:80ab0d068708 | 121 | |
samux | 1:80ab0d068708 | 122 | default: |
samux | 1:80ab0d068708 | 123 | break; |
samux | 1:80ab0d068708 | 124 | } |
samux | 1:80ab0d068708 | 125 | break; |
samux | 1:80ab0d068708 | 126 | default: |
samux | 1:80ab0d068708 | 127 | break; |
samux | 1:80ab0d068708 | 128 | } |
samux | 1:80ab0d068708 | 129 | } |
samux | 1:80ab0d068708 | 130 | |
samux | 1:80ab0d068708 | 131 | // Process class-specific requests |
samux | 1:80ab0d068708 | 132 | |
samux | 1:80ab0d068708 | 133 | if (transfer->setup.bmRequestType.Type == CLASS_TYPE) |
samux | 1:80ab0d068708 | 134 | { |
samux | 1:80ab0d068708 | 135 | switch (transfer->setup.bRequest) |
samux | 1:80ab0d068708 | 136 | { |
samux | 1:80ab0d068708 | 137 | case SET_REPORT: |
samux | 1:80ab0d068708 | 138 | // First byte will be used for report ID |
samux | 1:80ab0d068708 | 139 | outputReport.data[0] = transfer->setup.wValue & 0xff; |
samux | 1:80ab0d068708 | 140 | outputReport.length = transfer->setup.wLength + 1; |
samux | 1:80ab0d068708 | 141 | |
samux | 1:80ab0d068708 | 142 | transfer->remaining = sizeof(outputReport.data) - 1; |
samux | 1:80ab0d068708 | 143 | transfer->ptr = &outputReport.data[1]; |
samux | 1:80ab0d068708 | 144 | transfer->direction = HOST_TO_DEVICE; |
samux | 1:80ab0d068708 | 145 | transfer->notify = true; |
samux | 1:80ab0d068708 | 146 | success = true; |
samux | 1:80ab0d068708 | 147 | default: |
samux | 1:80ab0d068708 | 148 | break; |
samux | 1:80ab0d068708 | 149 | } |
samux | 1:80ab0d068708 | 150 | } |
samux | 1:80ab0d068708 | 151 | |
samux | 1:80ab0d068708 | 152 | return success; |
samux | 1:80ab0d068708 | 153 | } |
samux | 1:80ab0d068708 | 154 | |
samux | 1:80ab0d068708 | 155 | |
samux | 1:80ab0d068708 | 156 | #define DEFAULT_CONFIGURATION (1) |
samux | 1:80ab0d068708 | 157 | |
samux | 1:80ab0d068708 | 158 | |
samux | 1:80ab0d068708 | 159 | // Called in ISR context |
samux | 1:80ab0d068708 | 160 | // Set configuration. Return false if the |
samux | 1:80ab0d068708 | 161 | // configuration is not supported |
samux | 1:80ab0d068708 | 162 | bool USBHID::USBCallback_setConfiguration(uint8_t configuration) { |
samux | 1:80ab0d068708 | 163 | if (configuration != DEFAULT_CONFIGURATION) { |
samux | 1:80ab0d068708 | 164 | return false; |
samux | 1:80ab0d068708 | 165 | } |
samux | 1:80ab0d068708 | 166 | |
samux | 1:80ab0d068708 | 167 | // Configure endpoints > 0 |
samux | 1:80ab0d068708 | 168 | addEndpoint(EPINT_IN, MAX_PACKET_SIZE_EPINT); |
samux | 1:80ab0d068708 | 169 | addEndpoint(EPINT_OUT, MAX_PACKET_SIZE_EPINT); |
samux | 1:80ab0d068708 | 170 | |
samux | 1:80ab0d068708 | 171 | // We activate the endpoint to be able to recceive data |
samux | 1:80ab0d068708 | 172 | readStart(EPINT_OUT, MAX_PACKET_SIZE_EPINT); |
samux | 1:80ab0d068708 | 173 | return true; |
samux | 1:80ab0d068708 | 174 | } |
samux | 1:80ab0d068708 | 175 | |
samux | 1:80ab0d068708 | 176 | |
samux | 1:80ab0d068708 | 177 | uint8_t * USBHID::stringIinterfaceDesc() { |
samux | 1:80ab0d068708 | 178 | static uint8_t stringIinterfaceDescriptor[] = { |
samux | 1:80ab0d068708 | 179 | 0x08, //bLength |
samux | 1:80ab0d068708 | 180 | STRING_DESCRIPTOR, //bDescriptorType 0x03 |
samux | 1:80ab0d068708 | 181 | 'H',0,'I',0,'D',0, //bString iInterface - HID |
samux | 1:80ab0d068708 | 182 | }; |
samux | 1:80ab0d068708 | 183 | return stringIinterfaceDescriptor; |
samux | 1:80ab0d068708 | 184 | } |
samux | 1:80ab0d068708 | 185 | |
samux | 1:80ab0d068708 | 186 | uint8_t * USBHID::stringIproductDesc() { |
samux | 1:80ab0d068708 | 187 | static uint8_t stringIproductDescriptor[] = { |
samux | 1:80ab0d068708 | 188 | 0x16, //bLength |
samux | 1:80ab0d068708 | 189 | STRING_DESCRIPTOR, //bDescriptorType 0x03 |
samux | 1:80ab0d068708 | 190 | 'H',0,'I',0,'D',0,' ',0,'D',0,'E',0,'V',0,'I',0,'C',0,'E',0 //bString iProduct - HID device |
samux | 1:80ab0d068708 | 191 | }; |
samux | 1:80ab0d068708 | 192 | return stringIproductDescriptor; |
samux | 1:80ab0d068708 | 193 | } |
samux | 1:80ab0d068708 | 194 | |
samux | 1:80ab0d068708 | 195 | |
samux | 1:80ab0d068708 | 196 | |
samux | 1:80ab0d068708 | 197 | uint8_t * USBHID::reportDesc() { |
samux | 1:80ab0d068708 | 198 | static uint8_t reportDescriptor[] = { |
samux | 1:80ab0d068708 | 199 | 0x06, LSB(0xFFAB), MSB(0xFFAB), |
samux | 1:80ab0d068708 | 200 | 0x0A, LSB(0x0200), MSB(0x0200), |
samux | 1:80ab0d068708 | 201 | 0xA1, 0x01, // Collection 0x01 |
samux | 1:80ab0d068708 | 202 | 0x75, 0x08, // report size = 8 bits |
samux | 1:80ab0d068708 | 203 | 0x15, 0x00, // logical minimum = 0 |
samux | 1:80ab0d068708 | 204 | 0x26, 0xFF, 0x00, // logical maximum = 255 |
emilmont | 10:1e3d126a322b | 205 | 0x95, input_length, // report count |
samux | 1:80ab0d068708 | 206 | 0x09, 0x01, // usage |
samux | 1:80ab0d068708 | 207 | 0x81, 0x02, // Input (array) |
emilmont | 10:1e3d126a322b | 208 | 0x95, output_length,// report count |
samux | 1:80ab0d068708 | 209 | 0x09, 0x02, // usage |
samux | 1:80ab0d068708 | 210 | 0x91, 0x02, // Output (array) |
samux | 1:80ab0d068708 | 211 | 0xC0 // end collection |
samux | 1:80ab0d068708 | 212 | |
samux | 1:80ab0d068708 | 213 | }; |
samux | 1:80ab0d068708 | 214 | reportLength = sizeof(reportDescriptor); |
samux | 1:80ab0d068708 | 215 | return reportDescriptor; |
samux | 1:80ab0d068708 | 216 | } |
samux | 1:80ab0d068708 | 217 | |
samux | 1:80ab0d068708 | 218 | #define DEFAULT_CONFIGURATION (1) |
samux | 1:80ab0d068708 | 219 | #define TOTAL_DESCRIPTOR_LENGTH ((1 * CONFIGURATION_DESCRIPTOR_LENGTH) \ |
samux | 1:80ab0d068708 | 220 | + (1 * INTERFACE_DESCRIPTOR_LENGTH) \ |
samux | 1:80ab0d068708 | 221 | + (1 * HID_DESCRIPTOR_LENGTH) \ |
samux | 1:80ab0d068708 | 222 | + (2 * ENDPOINT_DESCRIPTOR_LENGTH)) |
samux | 1:80ab0d068708 | 223 | |
samux | 1:80ab0d068708 | 224 | uint8_t * USBHID::configurationDesc() { |
samux | 1:80ab0d068708 | 225 | static uint8_t configurationDescriptor[] = { |
samux | 1:80ab0d068708 | 226 | CONFIGURATION_DESCRIPTOR_LENGTH,// bLength |
samux | 1:80ab0d068708 | 227 | CONFIGURATION_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 228 | LSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (LSB) |
samux | 1:80ab0d068708 | 229 | MSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (MSB) |
samux | 1:80ab0d068708 | 230 | 0x01, // bNumInterfaces |
samux | 1:80ab0d068708 | 231 | DEFAULT_CONFIGURATION, // bConfigurationValue |
samux | 1:80ab0d068708 | 232 | 0x00, // iConfiguration |
samux | 1:80ab0d068708 | 233 | C_RESERVED | C_SELF_POWERED, // bmAttributes |
samux | 1:80ab0d068708 | 234 | C_POWER(0), // bMaxPower |
samux | 1:80ab0d068708 | 235 | |
samux | 1:80ab0d068708 | 236 | INTERFACE_DESCRIPTOR_LENGTH, // bLength |
samux | 1:80ab0d068708 | 237 | INTERFACE_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 238 | 0x00, // bInterfaceNumber |
samux | 1:80ab0d068708 | 239 | 0x00, // bAlternateSetting |
samux | 1:80ab0d068708 | 240 | 0x02, // bNumEndpoints |
samux | 1:80ab0d068708 | 241 | HID_CLASS, // bInterfaceClass |
samux | 1:80ab0d068708 | 242 | HID_SUBCLASS_NONE, // bInterfaceSubClass |
samux | 1:80ab0d068708 | 243 | HID_PROTOCOL_NONE, // bInterfaceProtocol |
samux | 1:80ab0d068708 | 244 | 0x00, // iInterface |
samux | 1:80ab0d068708 | 245 | |
samux | 1:80ab0d068708 | 246 | HID_DESCRIPTOR_LENGTH, // bLength |
samux | 1:80ab0d068708 | 247 | HID_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 248 | LSB(HID_VERSION_1_11), // bcdHID (LSB) |
samux | 1:80ab0d068708 | 249 | MSB(HID_VERSION_1_11), // bcdHID (MSB) |
samux | 1:80ab0d068708 | 250 | 0x00, // bCountryCode |
samux | 1:80ab0d068708 | 251 | 0x01, // bNumDescriptors |
samux | 1:80ab0d068708 | 252 | REPORT_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 253 | LSB(this->reportDescLength()), // wDescriptorLength (LSB) |
samux | 1:80ab0d068708 | 254 | MSB(this->reportDescLength()), // wDescriptorLength (MSB) |
samux | 1:80ab0d068708 | 255 | |
samux | 1:80ab0d068708 | 256 | ENDPOINT_DESCRIPTOR_LENGTH, // bLength |
samux | 1:80ab0d068708 | 257 | ENDPOINT_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 258 | PHY_TO_DESC(EPINT_IN), // bEndpointAddress |
samux | 1:80ab0d068708 | 259 | E_INTERRUPT, // bmAttributes |
samux | 1:80ab0d068708 | 260 | LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB) |
samux | 1:80ab0d068708 | 261 | MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB) |
samux | 1:80ab0d068708 | 262 | 1, // bInterval (milliseconds) |
samux | 1:80ab0d068708 | 263 | |
samux | 1:80ab0d068708 | 264 | ENDPOINT_DESCRIPTOR_LENGTH, // bLength |
samux | 1:80ab0d068708 | 265 | ENDPOINT_DESCRIPTOR, // bDescriptorType |
samux | 1:80ab0d068708 | 266 | PHY_TO_DESC(EPINT_OUT), // bEndpointAddress |
samux | 1:80ab0d068708 | 267 | E_INTERRUPT, // bmAttributes |
samux | 1:80ab0d068708 | 268 | LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB) |
samux | 1:80ab0d068708 | 269 | MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB) |
samux | 1:80ab0d068708 | 270 | 1, // bInterval (milliseconds) |
samux | 1:80ab0d068708 | 271 | }; |
samux | 1:80ab0d068708 | 272 | return configurationDescriptor; |
samux | 1:80ab0d068708 | 273 | } |