mbed official / USBDevice Featured

USB device stack

Dependents:   mbed-mX-USB-TEST1 USBMSD_SD_HID_HelloWorld HidTest MIDI_usb_bridge ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBHID/USBHID.cpp@70:2c525a50f1b6, 2017-07-20 (annotated)

Committer:
Kojto
Date:
Thu Jul 20 10:14:36 2017 +0100
Revision:
70:2c525a50f1b6
Parent:
25:7c72828865f3 
Update libraries (ed9d1da)

Who changed what in which revision?

UserRevisionLine numberNew 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);
mbed_official 21:ee9f2fa6bdbc 62 // if readEP_NB did not succeed, does not issue a readStart
mbed_official 21:ee9f2fa6bdbc 63 if (!result)
mbed_official 21:ee9f2fa6bdbc 64 return false;
samux 1:80ab0d068708 65 report->length = bytesRead;
samux 1:80ab0d068708 66 if(!readStart(EPINT_OUT, MAX_HID_REPORT_SIZE))
samux 1:80ab0d068708 67 return false;
samux 1:80ab0d068708 68 return result;
samux 1:80ab0d068708 69 }
samux 1:80ab0d068708 70
samux 1:80ab0d068708 71
samux 1:80ab0d068708 72 uint16_t USBHID::reportDescLength() {
samux 1:80ab0d068708 73 reportDesc();
samux 1:80ab0d068708 74 return reportLength;
samux 1:80ab0d068708 75 }
samux 1:80ab0d068708 76
samux 1:80ab0d068708 77
samux 1:80ab0d068708 78
samux 1:80ab0d068708 79 //
samux 1:80ab0d068708 80 // Route callbacks from lower layers to class(es)
samux 1:80ab0d068708 81 //
samux 1:80ab0d068708 82
samux 1:80ab0d068708 83
samux 1:80ab0d068708 84 // Called in ISR context
samux 1:80ab0d068708 85 // Called by USBDevice on Endpoint0 request
samux 1:80ab0d068708 86 // This is used to handle extensions to standard requests
samux 1:80ab0d068708 87 // and class specific requests
samux 1:80ab0d068708 88 // Return true if class handles this request
samux 1:80ab0d068708 89 bool USBHID::USBCallback_request() {
samux 1:80ab0d068708 90 bool success = false;
samux 1:80ab0d068708 91 CONTROL_TRANSFER * transfer = getTransferPtr();
samux 1:80ab0d068708 92 uint8_t *hidDescriptor;
samux 1:80ab0d068708 93
samux 1:80ab0d068708 94 // Process additional standard requests
samux 1:80ab0d068708 95
samux 1:80ab0d068708 96 if ((transfer->setup.bmRequestType.Type == STANDARD_TYPE))
samux 1:80ab0d068708 97 {
samux 1:80ab0d068708 98 switch (transfer->setup.bRequest)
samux 1:80ab0d068708 99 {
samux 1:80ab0d068708 100 case GET_DESCRIPTOR:
samux 1:80ab0d068708 101 switch (DESCRIPTOR_TYPE(transfer->setup.wValue))
samux 1:80ab0d068708 102 {
samux 1:80ab0d068708 103 case REPORT_DESCRIPTOR:
samux 1:80ab0d068708 104 if ((reportDesc() != NULL) \
samux 1:80ab0d068708 105 && (reportDescLength() != 0))
samux 1:80ab0d068708 106 {
samux 1:80ab0d068708 107 transfer->remaining = reportDescLength();
samux 1:80ab0d068708 108 transfer->ptr = reportDesc();
samux 1:80ab0d068708 109 transfer->direction = DEVICE_TO_HOST;
samux 1:80ab0d068708 110 success = true;
samux 1:80ab0d068708 111 }
samux 1:80ab0d068708 112 break;
samux 1:80ab0d068708 113 case HID_DESCRIPTOR:
samux 1:80ab0d068708 114 // Find the HID descriptor, after the configuration descriptor
samux 1:80ab0d068708 115 hidDescriptor = findDescriptor(HID_DESCRIPTOR);
samux 1:80ab0d068708 116 if (hidDescriptor != NULL)
samux 1:80ab0d068708 117 {
samux 1:80ab0d068708 118 transfer->remaining = HID_DESCRIPTOR_LENGTH;
samux 1:80ab0d068708 119 transfer->ptr = hidDescriptor;
samux 1:80ab0d068708 120 transfer->direction = DEVICE_TO_HOST;
samux 1:80ab0d068708 121 success = true;
samux 1:80ab0d068708 122 }
samux 1:80ab0d068708 123 break;
mbed_official 25:7c72828865f3 124
samux 1:80ab0d068708 125 default:
samux 1:80ab0d068708 126 break;
samux 1:80ab0d068708 127 }
samux 1:80ab0d068708 128 break;
samux 1:80ab0d068708 129 default:
samux 1:80ab0d068708 130 break;
samux 1:80ab0d068708 131 }
samux 1:80ab0d068708 132 }
samux 1:80ab0d068708 133
samux 1:80ab0d068708 134 // Process class-specific requests
samux 1:80ab0d068708 135
samux 1:80ab0d068708 136 if (transfer->setup.bmRequestType.Type == CLASS_TYPE)
samux 1:80ab0d068708 137 {
samux 1:80ab0d068708 138 switch (transfer->setup.bRequest)
samux 1:80ab0d068708 139 {
samux 1:80ab0d068708 140 case SET_REPORT:
samux 1:80ab0d068708 141 // First byte will be used for report ID
samux 1:80ab0d068708 142 outputReport.data[0] = transfer->setup.wValue & 0xff;
samux 1:80ab0d068708 143 outputReport.length = transfer->setup.wLength + 1;
samux 1:80ab0d068708 144
samux 1:80ab0d068708 145 transfer->remaining = sizeof(outputReport.data) - 1;
samux 1:80ab0d068708 146 transfer->ptr = &outputReport.data[1];
samux 1:80ab0d068708 147 transfer->direction = HOST_TO_DEVICE;
samux 1:80ab0d068708 148 transfer->notify = true;
samux 1:80ab0d068708 149 success = true;
samux 1:80ab0d068708 150 default:
samux 1:80ab0d068708 151 break;
samux 1:80ab0d068708 152 }
samux 1:80ab0d068708 153 }
samux 1:80ab0d068708 154
samux 1:80ab0d068708 155 return success;
samux 1:80ab0d068708 156 }
samux 1:80ab0d068708 157
samux 1:80ab0d068708 158
samux 1:80ab0d068708 159 #define DEFAULT_CONFIGURATION (1)
samux 1:80ab0d068708 160
samux 1:80ab0d068708 161
samux 1:80ab0d068708 162 // Called in ISR context
samux 1:80ab0d068708 163 // Set configuration. Return false if the
samux 1:80ab0d068708 164 // configuration is not supported
samux 1:80ab0d068708 165 bool USBHID::USBCallback_setConfiguration(uint8_t configuration) {
samux 1:80ab0d068708 166 if (configuration != DEFAULT_CONFIGURATION) {
samux 1:80ab0d068708 167 return false;
samux 1:80ab0d068708 168 }
samux 1:80ab0d068708 169
samux 1:80ab0d068708 170 // Configure endpoints > 0
samux 1:80ab0d068708 171 addEndpoint(EPINT_IN, MAX_PACKET_SIZE_EPINT);
samux 1:80ab0d068708 172 addEndpoint(EPINT_OUT, MAX_PACKET_SIZE_EPINT);
samux 1:80ab0d068708 173
samux 1:80ab0d068708 174 // We activate the endpoint to be able to recceive data
samux 1:80ab0d068708 175 readStart(EPINT_OUT, MAX_PACKET_SIZE_EPINT);
samux 1:80ab0d068708 176 return true;
samux 1:80ab0d068708 177 }
samux 1:80ab0d068708 178
samux 1:80ab0d068708 179
samux 1:80ab0d068708 180 uint8_t * USBHID::stringIinterfaceDesc() {
samux 1:80ab0d068708 181 static uint8_t stringIinterfaceDescriptor[] = {
samux 1:80ab0d068708 182 0x08, //bLength
samux 1:80ab0d068708 183 STRING_DESCRIPTOR, //bDescriptorType 0x03
samux 1:80ab0d068708 184 'H',0,'I',0,'D',0, //bString iInterface - HID
samux 1:80ab0d068708 185 };
samux 1:80ab0d068708 186 return stringIinterfaceDescriptor;
samux 1:80ab0d068708 187 }
samux 1:80ab0d068708 188
samux 1:80ab0d068708 189 uint8_t * USBHID::stringIproductDesc() {
samux 1:80ab0d068708 190 static uint8_t stringIproductDescriptor[] = {
samux 1:80ab0d068708 191 0x16, //bLength
samux 1:80ab0d068708 192 STRING_DESCRIPTOR, //bDescriptorType 0x03
samux 1:80ab0d068708 193 '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 194 };
samux 1:80ab0d068708 195 return stringIproductDescriptor;
samux 1:80ab0d068708 196 }
samux 1:80ab0d068708 197
samux 1:80ab0d068708 198
samux 1:80ab0d068708 199
samux 1:80ab0d068708 200 uint8_t * USBHID::reportDesc() {
samux 1:80ab0d068708 201 static uint8_t reportDescriptor[] = {
Kojto 70:2c525a50f1b6 202 USAGE_PAGE(2), LSB(0xFFAB), MSB(0xFFAB),
Kojto 70:2c525a50f1b6 203 USAGE(2), LSB(0x0200), MSB(0x0200),
Kojto 70:2c525a50f1b6 204 COLLECTION(1), 0x01, // Collection (Application)
Kojto 70:2c525a50f1b6 205
Kojto 70:2c525a50f1b6 206 REPORT_SIZE(1), 0x08, // 8 bits
Kojto 70:2c525a50f1b6 207 LOGICAL_MINIMUM(1), 0x00,
Kojto 70:2c525a50f1b6 208 LOGICAL_MAXIMUM(1), 0xFF,
samux 1:80ab0d068708 209
Kojto 70:2c525a50f1b6 210 REPORT_COUNT(1), input_length,
Kojto 70:2c525a50f1b6 211 USAGE(1), 0x01,
Kojto 70:2c525a50f1b6 212 INPUT(1), 0x02, // Data, Var, Abs
Kojto 70:2c525a50f1b6 213
Kojto 70:2c525a50f1b6 214 REPORT_COUNT(1), output_length,
Kojto 70:2c525a50f1b6 215 USAGE(1), 0x02,
Kojto 70:2c525a50f1b6 216 OUTPUT(1), 0x02, // Data, Var, Abs
Kojto 70:2c525a50f1b6 217
Kojto 70:2c525a50f1b6 218 END_COLLECTION(0),
samux 1:80ab0d068708 219 };
samux 1:80ab0d068708 220 reportLength = sizeof(reportDescriptor);
samux 1:80ab0d068708 221 return reportDescriptor;
samux 1:80ab0d068708 222 }
samux 1:80ab0d068708 223
samux 1:80ab0d068708 224 #define DEFAULT_CONFIGURATION (1)
samux 1:80ab0d068708 225 #define TOTAL_DESCRIPTOR_LENGTH ((1 * CONFIGURATION_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 226 + (1 * INTERFACE_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 227 + (1 * HID_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 228 + (2 * ENDPOINT_DESCRIPTOR_LENGTH))
samux 1:80ab0d068708 229
samux 1:80ab0d068708 230 uint8_t * USBHID::configurationDesc() {
samux 1:80ab0d068708 231 static uint8_t configurationDescriptor[] = {
Kojto 70:2c525a50f1b6 232 CONFIGURATION_DESCRIPTOR_LENGTH, // bLength
Kojto 70:2c525a50f1b6 233 CONFIGURATION_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 234 LSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (LSB)
Kojto 70:2c525a50f1b6 235 MSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (MSB)
Kojto 70:2c525a50f1b6 236 0x01, // bNumInterfaces
Kojto 70:2c525a50f1b6 237 DEFAULT_CONFIGURATION, // bConfigurationValue
Kojto 70:2c525a50f1b6 238 0x00, // iConfiguration
Kojto 70:2c525a50f1b6 239 C_RESERVED | C_SELF_POWERED, // bmAttributes
Kojto 70:2c525a50f1b6 240 C_POWER(0), // bMaxPower
samux 1:80ab0d068708 241
Kojto 70:2c525a50f1b6 242 INTERFACE_DESCRIPTOR_LENGTH, // bLength
Kojto 70:2c525a50f1b6 243 INTERFACE_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 244 0x00, // bInterfaceNumber
Kojto 70:2c525a50f1b6 245 0x00, // bAlternateSetting
Kojto 70:2c525a50f1b6 246 0x02, // bNumEndpoints
Kojto 70:2c525a50f1b6 247 HID_CLASS, // bInterfaceClass
Kojto 70:2c525a50f1b6 248 HID_SUBCLASS_NONE, // bInterfaceSubClass
Kojto 70:2c525a50f1b6 249 HID_PROTOCOL_NONE, // bInterfaceProtocol
Kojto 70:2c525a50f1b6 250 0x00, // iInterface
samux 1:80ab0d068708 251
Kojto 70:2c525a50f1b6 252 HID_DESCRIPTOR_LENGTH, // bLength
Kojto 70:2c525a50f1b6 253 HID_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 254 LSB(HID_VERSION_1_11), // bcdHID (LSB)
Kojto 70:2c525a50f1b6 255 MSB(HID_VERSION_1_11), // bcdHID (MSB)
Kojto 70:2c525a50f1b6 256 0x00, // bCountryCode
Kojto 70:2c525a50f1b6 257 0x01, // bNumDescriptors
Kojto 70:2c525a50f1b6 258 REPORT_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 259 (uint8_t)(LSB(reportDescLength())), // wDescriptorLength (LSB)
Kojto 70:2c525a50f1b6 260 (uint8_t)(MSB(reportDescLength())), // wDescriptorLength (MSB)
samux 1:80ab0d068708 261
Kojto 70:2c525a50f1b6 262 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
Kojto 70:2c525a50f1b6 263 ENDPOINT_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 264 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
Kojto 70:2c525a50f1b6 265 E_INTERRUPT, // bmAttributes
Kojto 70:2c525a50f1b6 266 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
Kojto 70:2c525a50f1b6 267 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
Kojto 70:2c525a50f1b6 268 1, // bInterval (milliseconds)
samux 1:80ab0d068708 269
Kojto 70:2c525a50f1b6 270 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
Kojto 70:2c525a50f1b6 271 ENDPOINT_DESCRIPTOR, // bDescriptorType
Kojto 70:2c525a50f1b6 272 PHY_TO_DESC(EPINT_OUT), // bEndpointAddress
Kojto 70:2c525a50f1b6 273 E_INTERRUPT, // bmAttributes
Kojto 70:2c525a50f1b6 274 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
Kojto 70:2c525a50f1b6 275 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
Kojto 70:2c525a50f1b6 276 1, // bInterval (milliseconds)
samux 1:80ab0d068708 277 };
samux 1:80ab0d068708 278 return configurationDescriptor;
samux 1:80ab0d068708 279 }