GHI Electronics / Mbed 2 deprecated Official_mBot

The preloaded firmware shipped on the mBot.

Dependencies:   mbed

Fork of Official_mBot by Fred Parker

USBDevice/USBHID/USBHID.cpp@1:ffd9a51e7d35, 2014-11-25 (annotated)

Committer:
jeffknaggs
Date:
Tue Nov 25 14:49:40 2014 +0000
Revision:
1:ffd9a51e7d35
Parent:
0:865d42c46692 
Initial commit.

Who changed what in which revision?

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