JIAWEI ZHANG / Mbed 2 deprecated ele350ku

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.

Dependencies:   mbed

Dependents:   Exercise8_1-2-3

Fork of ele350 by JIAWEI ZHANG

USBHID.cpp@65:9dbee72e3e6e, 2016-02-23 (annotated)

Committer:
GGHHHH
Date:
Tue Feb 23 16:16:34 2016 +0000
Revision:
65:9dbee72e3e6e
Parent:
59:a523a25ba735 
ok

Who changed what in which revision?

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