Norimasa Okamoto / USBDAP

USB HID device for CMSIS-DAP

Dependents:   lpcterm2 Simple-CMSIS-DAP

USBDAP.cpp@0:6b9154ed73c6, 2013-09-14 (annotated)

Committer:
va009039
Date:
Sat Sep 14 11:19:17 2013 +0000
Revision:
0:6b9154ed73c6
Child:
1:366f6f649a7d
first commit

Who changed what in which revision?

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