virtua pinnnn / USBDevice

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of USBDevice by mbed official

USBHID/USBHID.cpp@70:f60a9be29d9f, 2016-11-08 (annotated)

Committer:
joshvaldes
Date:
Tue Nov 08 03:32:20 2016 +0000
Revision:
70:f60a9be29d9f
Parent:
68:06fd9b306fb5 
virtuapin controller all in USBDevice.cpp

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[] = {
joshvaldes 66:756c60620bcf 182
joshvaldes 67:7083a93e2829 183 0x08, //bLength
joshvaldes 67:7083a93e2829 184 STRING_DESCRIPTOR, //bDescriptorType 0x03
joshvaldes 67:7083a93e2829 185 'H',0,'I',0,'D',0, //bString iInterface - HID
samux 1:80ab0d068708 186 };
samux 1:80ab0d068708 187 return stringIinterfaceDescriptor;
samux 1:80ab0d068708 188 }
samux 1:80ab0d068708 189
joshvaldes 64:2343ebf8ae3d 190 uint8_t * USBHID::stringIproductDesc() { // VirtuaPin Controller
samux 1:80ab0d068708 191 static uint8_t stringIproductDescriptor[] = {
joshvaldes 70:f60a9be29d9f 192 0x2A,
joshvaldes 70:f60a9be29d9f 193 STRING_DESCRIPTOR,
joshvaldes 70:f60a9be29d9f 194 'V',0,'i',0,'r',0,'t',0,'u',0,'a',0,'P',0,'i',0,'n',0,' ',0,'C',0,'o',0,'n',0,'t',0,'r',0,'o',0,'l',0,'l',0,'e',0,'r',0,
joshvaldes 70:f60a9be29d9f 195
joshvaldes 70:f60a9be29d9f 196
joshvaldes 70:f60a9be29d9f 197 //0x00,
joshvaldes 70:f60a9be29d9f 198 //STRING_DESCRIPTOR,
joshvaldes 70:f60a9be29d9f 199
joshvaldes 70:f60a9be29d9f 200 //0x16, //bLength
joshvaldes 70:f60a9be29d9f 201 //STRING_DESCRIPTOR, //bDescriptorType 0x03
joshvaldes 70:f60a9be29d9f 202 //'C',0,'o',0,'n',0,'t',0,'r',0,'o',0,'l',0,
joshvaldes 70:f60a9be29d9f 203 //'l',0,'e',0,'r',0 //bString iProduct - HID device
samux 1:80ab0d068708 204 };
samux 1:80ab0d068708 205 return stringIproductDescriptor;
samux 1:80ab0d068708 206 }
samux 1:80ab0d068708 207
samux 1:80ab0d068708 208
samux 1:80ab0d068708 209
samux 1:80ab0d068708 210 uint8_t * USBHID::reportDesc() {
samux 1:80ab0d068708 211 static uint8_t reportDescriptor[] = {
samux 1:80ab0d068708 212 0x06, LSB(0xFFAB), MSB(0xFFAB),
samux 1:80ab0d068708 213 0x0A, LSB(0x0200), MSB(0x0200),
samux 1:80ab0d068708 214 0xA1, 0x01, // Collection 0x01
samux 1:80ab0d068708 215 0x75, 0x08, // report size = 8 bits
samux 1:80ab0d068708 216 0x15, 0x00, // logical minimum = 0
samux 1:80ab0d068708 217 0x26, 0xFF, 0x00, // logical maximum = 255
emilmont 10:1e3d126a322b 218 0x95, input_length, // report count
samux 1:80ab0d068708 219 0x09, 0x01, // usage
samux 1:80ab0d068708 220 0x81, 0x02, // Input (array)
emilmont 10:1e3d126a322b 221 0x95, output_length,// report count
samux 1:80ab0d068708 222 0x09, 0x02, // usage
samux 1:80ab0d068708 223 0x91, 0x02, // Output (array)
samux 1:80ab0d068708 224 0xC0 // end collection
samux 1:80ab0d068708 225
samux 1:80ab0d068708 226 };
samux 1:80ab0d068708 227 reportLength = sizeof(reportDescriptor);
samux 1:80ab0d068708 228 return reportDescriptor;
samux 1:80ab0d068708 229 }
samux 1:80ab0d068708 230
samux 1:80ab0d068708 231 #define DEFAULT_CONFIGURATION (1)
samux 1:80ab0d068708 232 #define TOTAL_DESCRIPTOR_LENGTH ((1 * CONFIGURATION_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 233 + (1 * INTERFACE_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 234 + (1 * HID_DESCRIPTOR_LENGTH) \
samux 1:80ab0d068708 235 + (2 * ENDPOINT_DESCRIPTOR_LENGTH))
samux 1:80ab0d068708 236
samux 1:80ab0d068708 237 uint8_t * USBHID::configurationDesc() {
samux 1:80ab0d068708 238 static uint8_t configurationDescriptor[] = {
samux 1:80ab0d068708 239 CONFIGURATION_DESCRIPTOR_LENGTH,// bLength
samux 1:80ab0d068708 240 CONFIGURATION_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 241 LSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (LSB)
samux 1:80ab0d068708 242 MSB(TOTAL_DESCRIPTOR_LENGTH), // wTotalLength (MSB)
samux 1:80ab0d068708 243 0x01, // bNumInterfaces
samux 1:80ab0d068708 244 DEFAULT_CONFIGURATION, // bConfigurationValue
samux 1:80ab0d068708 245 0x00, // iConfiguration
samux 1:80ab0d068708 246 C_RESERVED | C_SELF_POWERED, // bmAttributes
samux 1:80ab0d068708 247 C_POWER(0), // bMaxPower
samux 1:80ab0d068708 248
samux 1:80ab0d068708 249 INTERFACE_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 250 INTERFACE_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 251 0x00, // bInterfaceNumber
samux 1:80ab0d068708 252 0x00, // bAlternateSetting
samux 1:80ab0d068708 253 0x02, // bNumEndpoints
samux 1:80ab0d068708 254 HID_CLASS, // bInterfaceClass
samux 1:80ab0d068708 255 HID_SUBCLASS_NONE, // bInterfaceSubClass
samux 1:80ab0d068708 256 HID_PROTOCOL_NONE, // bInterfaceProtocol
samux 1:80ab0d068708 257 0x00, // iInterface
samux 1:80ab0d068708 258
samux 1:80ab0d068708 259 HID_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 260 HID_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 261 LSB(HID_VERSION_1_11), // bcdHID (LSB)
samux 1:80ab0d068708 262 MSB(HID_VERSION_1_11), // bcdHID (MSB)
samux 1:80ab0d068708 263 0x00, // bCountryCode
samux 1:80ab0d068708 264 0x01, // bNumDescriptors
samux 1:80ab0d068708 265 REPORT_DESCRIPTOR, // bDescriptorType
bogdanm 11:eeb3cbbaa996 266 (uint8_t)(LSB(this->reportDescLength())), // wDescriptorLength (LSB)
bogdanm 11:eeb3cbbaa996 267 (uint8_t)(MSB(this->reportDescLength())), // wDescriptorLength (MSB)
samux 1:80ab0d068708 268
samux 1:80ab0d068708 269 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 270 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 271 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
samux 1:80ab0d068708 272 E_INTERRUPT, // bmAttributes
samux 1:80ab0d068708 273 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
samux 1:80ab0d068708 274 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
samux 1:80ab0d068708 275 1, // bInterval (milliseconds)
samux 1:80ab0d068708 276
samux 1:80ab0d068708 277 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 278 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 279 PHY_TO_DESC(EPINT_OUT), // bEndpointAddress
samux 1:80ab0d068708 280 E_INTERRUPT, // bmAttributes
samux 1:80ab0d068708 281 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
samux 1:80ab0d068708 282 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
samux 1:80ab0d068708 283 1, // bInterval (milliseconds)
samux 1:80ab0d068708 284 };
samux 1:80ab0d068708 285 return configurationDescriptor;
samux 1:80ab0d068708 286 }