Piotr Woźniak / Mbed 2 deprecated KL46Z-Lab2_fullll

blablabla

Dependencies:   MAG3110 MMA8451Q SLCD- TSI USBDevice mbed

USBDevice/USBHID/USBHID.cpp@0:339b7abfa147, 2014-04-16 (annotated)

Committer:
Osator
Date:
Wed Apr 16 12:20:00 2014 +0000
Revision:
0:339b7abfa147
blablabla

Who changed what in which revision?

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