Mark van Raai / USBDevice

Library used for HID protocol communication with the PC.

Fork of USBDevice by mbed official

USBSerial/USBCDC.cpp@62:3bd2176d49f6, 2016-04-05 (annotated)

Committer:
zork
Date:
Tue Apr 05 16:19:29 2016 +0000
Revision:
62:3bd2176d49f6
Parent:
44:d2638fcd76d9 
mouse changed to absolute

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 "USBCDC.h"
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 static uint8_t cdc_line_coding[7]= {0x80, 0x25, 0x00, 0x00, 0x00, 0x00, 0x08};
samux 1:80ab0d068708 23
samux 1:80ab0d068708 24 #define DEFAULT_CONFIGURATION (1)
samux 1:80ab0d068708 25
samux 1:80ab0d068708 26 #define CDC_SET_LINE_CODING 0x20
samux 1:80ab0d068708 27 #define CDC_GET_LINE_CODING 0x21
samux 1:80ab0d068708 28 #define CDC_SET_CONTROL_LINE_STATE 0x22
samux 1:80ab0d068708 29
mbed_official 44:d2638fcd76d9 30 // Control Line State bits
mbed_official 44:d2638fcd76d9 31 #define CLS_DTR (1 << 0)
mbed_official 44:d2638fcd76d9 32 #define CLS_RTS (1 << 1)
mbed_official 44:d2638fcd76d9 33
samux 1:80ab0d068708 34 #define MAX_CDC_REPORT_SIZE MAX_PACKET_SIZE_EPBULK
samux 1:80ab0d068708 35
mbed_official 19:fcb63a105965 36 USBCDC::USBCDC(uint16_t vendor_id, uint16_t product_id, uint16_t product_release, bool connect_blocking): USBDevice(vendor_id, product_id, product_release) {
samux 6:d0945750af57 37 terminal_connected = false;
mbed_official 19:fcb63a105965 38 USBDevice::connect(connect_blocking);
samux 1:80ab0d068708 39 }
samux 1:80ab0d068708 40
samux 1:80ab0d068708 41 bool USBCDC::USBCallback_request(void) {
samux 1:80ab0d068708 42 /* Called in ISR context */
samux 1:80ab0d068708 43
samux 1:80ab0d068708 44 bool success = false;
samux 1:80ab0d068708 45 CONTROL_TRANSFER * transfer = getTransferPtr();
samux 1:80ab0d068708 46
samux 1:80ab0d068708 47 /* Process class-specific requests */
samux 1:80ab0d068708 48
samux 1:80ab0d068708 49 if (transfer->setup.bmRequestType.Type == CLASS_TYPE) {
samux 1:80ab0d068708 50 switch (transfer->setup.bRequest) {
samux 1:80ab0d068708 51 case CDC_GET_LINE_CODING:
samux 1:80ab0d068708 52 transfer->remaining = 7;
samux 1:80ab0d068708 53 transfer->ptr = cdc_line_coding;
samux 1:80ab0d068708 54 transfer->direction = DEVICE_TO_HOST;
samux 1:80ab0d068708 55 success = true;
samux 1:80ab0d068708 56 break;
samux 1:80ab0d068708 57 case CDC_SET_LINE_CODING:
samux 1:80ab0d068708 58 transfer->remaining = 7;
mbed_official 15:849c0c0f2769 59 transfer->notify = true;
samux 1:80ab0d068708 60 success = true;
samux 1:80ab0d068708 61 break;
samux 1:80ab0d068708 62 case CDC_SET_CONTROL_LINE_STATE:
mbed_official 44:d2638fcd76d9 63 if (transfer->setup.wValue & CLS_DTR) {
mbed_official 44:d2638fcd76d9 64 terminal_connected = true;
mbed_official 44:d2638fcd76d9 65 } else {
mbed_official 44:d2638fcd76d9 66 terminal_connected = false;
mbed_official 44:d2638fcd76d9 67 }
samux 1:80ab0d068708 68 success = true;
samux 1:80ab0d068708 69 break;
samux 1:80ab0d068708 70 default:
samux 1:80ab0d068708 71 break;
samux 1:80ab0d068708 72 }
samux 1:80ab0d068708 73 }
samux 1:80ab0d068708 74
samux 1:80ab0d068708 75 return success;
samux 1:80ab0d068708 76 }
samux 1:80ab0d068708 77
mbed_official 15:849c0c0f2769 78 void USBCDC::USBCallback_requestCompleted(uint8_t *buf, uint32_t length) {
mbed_official 15:849c0c0f2769 79 // Request of setting line coding has 7 bytes
mbed_official 15:849c0c0f2769 80 if (length != 7) {
mbed_official 15:849c0c0f2769 81 return;
mbed_official 15:849c0c0f2769 82 }
mbed_official 25:7c72828865f3 83
mbed_official 15:849c0c0f2769 84 CONTROL_TRANSFER * transfer = getTransferPtr();
mbed_official 25:7c72828865f3 85
mbed_official 15:849c0c0f2769 86 /* Process class-specific requests */
mbed_official 15:849c0c0f2769 87 if (transfer->setup.bmRequestType.Type == CLASS_TYPE) {
mbed_official 15:849c0c0f2769 88 if (transfer->setup.bRequest == CDC_SET_LINE_CODING) {
mbed_official 15:849c0c0f2769 89 if (memcmp(cdc_line_coding, buf, 7)) {
mbed_official 25:7c72828865f3 90 memcpy(cdc_line_coding, buf, 7);
mbed_official 25:7c72828865f3 91
mbed_official 15:849c0c0f2769 92 int baud = buf[0] + (buf[1] << 8)
mbed_official 15:849c0c0f2769 93 + (buf[2] << 16) + (buf[3] << 24);
mbed_official 15:849c0c0f2769 94 int stop = buf[4];
mbed_official 15:849c0c0f2769 95 int bits = buf[6];
mbed_official 15:849c0c0f2769 96 int parity = buf[5];
mbed_official 15:849c0c0f2769 97
mbed_official 15:849c0c0f2769 98 lineCodingChanged(baud, bits, parity, stop);
mbed_official 15:849c0c0f2769 99 }
mbed_official 15:849c0c0f2769 100 }
mbed_official 15:849c0c0f2769 101 }
mbed_official 15:849c0c0f2769 102 }
samux 1:80ab0d068708 103
samux 1:80ab0d068708 104 // Called in ISR context
samux 1:80ab0d068708 105 // Set configuration. Return false if the
samux 1:80ab0d068708 106 // configuration is not supported.
samux 1:80ab0d068708 107 bool USBCDC::USBCallback_setConfiguration(uint8_t configuration) {
samux 1:80ab0d068708 108 if (configuration != DEFAULT_CONFIGURATION) {
samux 1:80ab0d068708 109 return false;
samux 1:80ab0d068708 110 }
samux 1:80ab0d068708 111
samux 1:80ab0d068708 112 // Configure endpoints > 0
samux 1:80ab0d068708 113 addEndpoint(EPINT_IN, MAX_PACKET_SIZE_EPINT);
samux 1:80ab0d068708 114 addEndpoint(EPBULK_IN, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 115 addEndpoint(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 116
samux 1:80ab0d068708 117 // We activate the endpoint to be able to recceive data
samux 1:80ab0d068708 118 readStart(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 119 return true;
samux 1:80ab0d068708 120 }
samux 1:80ab0d068708 121
samux 1:80ab0d068708 122 bool USBCDC::send(uint8_t * buffer, uint32_t size) {
samux 1:80ab0d068708 123 return USBDevice::write(EPBULK_IN, buffer, size, MAX_CDC_REPORT_SIZE);
samux 1:80ab0d068708 124 }
samux 1:80ab0d068708 125
samux 1:80ab0d068708 126 bool USBCDC::readEP(uint8_t * buffer, uint32_t * size) {
samux 1:80ab0d068708 127 if (!USBDevice::readEP(EPBULK_OUT, buffer, size, MAX_CDC_REPORT_SIZE))
samux 1:80ab0d068708 128 return false;
samux 1:80ab0d068708 129 if (!readStart(EPBULK_OUT, MAX_CDC_REPORT_SIZE))
samux 1:80ab0d068708 130 return false;
samux 1:80ab0d068708 131 return true;
samux 1:80ab0d068708 132 }
samux 1:80ab0d068708 133
samux 1:80ab0d068708 134 bool USBCDC::readEP_NB(uint8_t * buffer, uint32_t * size) {
samux 1:80ab0d068708 135 if (!USBDevice::readEP_NB(EPBULK_OUT, buffer, size, MAX_CDC_REPORT_SIZE))
samux 1:80ab0d068708 136 return false;
samux 1:80ab0d068708 137 if (!readStart(EPBULK_OUT, MAX_CDC_REPORT_SIZE))
samux 1:80ab0d068708 138 return false;
samux 1:80ab0d068708 139 return true;
samux 1:80ab0d068708 140 }
samux 1:80ab0d068708 141
samux 1:80ab0d068708 142
samux 1:80ab0d068708 143 uint8_t * USBCDC::deviceDesc() {
samux 1:80ab0d068708 144 static uint8_t deviceDescriptor[] = {
samux 1:80ab0d068708 145 18, // bLength
samux 1:80ab0d068708 146 1, // bDescriptorType
samux 1:80ab0d068708 147 0x10, 0x01, // bcdUSB
samux 1:80ab0d068708 148 2, // bDeviceClass
samux 1:80ab0d068708 149 0, // bDeviceSubClass
samux 1:80ab0d068708 150 0, // bDeviceProtocol
samux 1:80ab0d068708 151 MAX_PACKET_SIZE_EP0, // bMaxPacketSize0
bogdanm 11:eeb3cbbaa996 152 (uint8_t)(LSB(VENDOR_ID)), (uint8_t)(MSB(VENDOR_ID)), // idVendor
bogdanm 11:eeb3cbbaa996 153 (uint8_t)(LSB(PRODUCT_ID)), (uint8_t)(MSB(PRODUCT_ID)),// idProduct
samux 1:80ab0d068708 154 0x00, 0x01, // bcdDevice
samux 1:80ab0d068708 155 1, // iManufacturer
samux 1:80ab0d068708 156 2, // iProduct
samux 1:80ab0d068708 157 3, // iSerialNumber
samux 1:80ab0d068708 158 1 // bNumConfigurations
samux 1:80ab0d068708 159 };
samux 1:80ab0d068708 160 return deviceDescriptor;
samux 1:80ab0d068708 161 }
samux 1:80ab0d068708 162
samux 1:80ab0d068708 163 uint8_t * USBCDC::stringIinterfaceDesc() {
samux 1:80ab0d068708 164 static uint8_t stringIinterfaceDescriptor[] = {
samux 1:80ab0d068708 165 0x08,
samux 1:80ab0d068708 166 STRING_DESCRIPTOR,
samux 1:80ab0d068708 167 'C',0,'D',0,'C',0,
samux 1:80ab0d068708 168 };
samux 1:80ab0d068708 169 return stringIinterfaceDescriptor;
samux 1:80ab0d068708 170 }
samux 1:80ab0d068708 171
samux 1:80ab0d068708 172 uint8_t * USBCDC::stringIproductDesc() {
samux 1:80ab0d068708 173 static uint8_t stringIproductDescriptor[] = {
samux 1:80ab0d068708 174 0x16,
samux 1:80ab0d068708 175 STRING_DESCRIPTOR,
samux 1:80ab0d068708 176 'C',0,'D',0,'C',0,' ',0,'D',0,'E',0,'V',0,'I',0,'C',0,'E',0
samux 1:80ab0d068708 177 };
samux 1:80ab0d068708 178 return stringIproductDescriptor;
samux 1:80ab0d068708 179 }
samux 1:80ab0d068708 180
samux 1:80ab0d068708 181
samux 8:335f2506f422 182 #define CONFIG1_DESC_SIZE (9+8+9+5+5+4+5+7+9+7+7)
samux 1:80ab0d068708 183
samux 1:80ab0d068708 184 uint8_t * USBCDC::configurationDesc() {
samux 1:80ab0d068708 185 static uint8_t configDescriptor[] = {
samux 8:335f2506f422 186 // configuration descriptor
samux 8:335f2506f422 187 9, // bLength
samux 8:335f2506f422 188 2, // bDescriptorType
samux 1:80ab0d068708 189 LSB(CONFIG1_DESC_SIZE), // wTotalLength
samux 1:80ab0d068708 190 MSB(CONFIG1_DESC_SIZE),
samux 1:80ab0d068708 191 2, // bNumInterfaces
samux 1:80ab0d068708 192 1, // bConfigurationValue
samux 1:80ab0d068708 193 0, // iConfiguration
samux 1:80ab0d068708 194 0x80, // bmAttributes
samux 1:80ab0d068708 195 50, // bMaxPower
mbed_official 25:7c72828865f3 196
samux 8:335f2506f422 197 // IAD to associate the two CDC interfaces
samux 8:335f2506f422 198 0x08, // bLength
samux 8:335f2506f422 199 0x0b, // bDescriptorType
samux 8:335f2506f422 200 0x00, // bFirstInterface
samux 8:335f2506f422 201 0x02, // bInterfaceCount
samux 8:335f2506f422 202 0x02, // bFunctionClass
samux 8:335f2506f422 203 0x02, // bFunctionSubClass
samux 8:335f2506f422 204 0, // bFunctionProtocol
samux 8:335f2506f422 205 0, // iFunction
samux 1:80ab0d068708 206
samux 1:80ab0d068708 207 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
samux 1:80ab0d068708 208 9, // bLength
samux 1:80ab0d068708 209 4, // bDescriptorType
samux 1:80ab0d068708 210 0, // bInterfaceNumber
samux 1:80ab0d068708 211 0, // bAlternateSetting
samux 1:80ab0d068708 212 1, // bNumEndpoints
samux 1:80ab0d068708 213 0x02, // bInterfaceClass
samux 1:80ab0d068708 214 0x02, // bInterfaceSubClass
samux 1:80ab0d068708 215 0x01, // bInterfaceProtocol
samux 1:80ab0d068708 216 0, // iInterface
samux 1:80ab0d068708 217
samux 1:80ab0d068708 218 // CDC Header Functional Descriptor, CDC Spec 5.2.3.1, Table 26
samux 1:80ab0d068708 219 5, // bFunctionLength
samux 1:80ab0d068708 220 0x24, // bDescriptorType
samux 1:80ab0d068708 221 0x00, // bDescriptorSubtype
samux 1:80ab0d068708 222 0x10, 0x01, // bcdCDC
samux 1:80ab0d068708 223
samux 1:80ab0d068708 224 // Call Management Functional Descriptor, CDC Spec 5.2.3.2, Table 27
samux 1:80ab0d068708 225 5, // bFunctionLength
samux 1:80ab0d068708 226 0x24, // bDescriptorType
samux 1:80ab0d068708 227 0x01, // bDescriptorSubtype
samux 1:80ab0d068708 228 0x03, // bmCapabilities
samux 1:80ab0d068708 229 1, // bDataInterface
samux 1:80ab0d068708 230
samux 1:80ab0d068708 231 // Abstract Control Management Functional Descriptor, CDC Spec 5.2.3.3, Table 28
samux 1:80ab0d068708 232 4, // bFunctionLength
samux 1:80ab0d068708 233 0x24, // bDescriptorType
samux 1:80ab0d068708 234 0x02, // bDescriptorSubtype
samux 1:80ab0d068708 235 0x06, // bmCapabilities
samux 1:80ab0d068708 236
samux 1:80ab0d068708 237 // Union Functional Descriptor, CDC Spec 5.2.3.8, Table 33
samux 1:80ab0d068708 238 5, // bFunctionLength
samux 1:80ab0d068708 239 0x24, // bDescriptorType
samux 1:80ab0d068708 240 0x06, // bDescriptorSubtype
samux 1:80ab0d068708 241 0, // bMasterInterface
samux 1:80ab0d068708 242 1, // bSlaveInterface0
samux 1:80ab0d068708 243
samux 1:80ab0d068708 244 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
samux 1:80ab0d068708 245 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 1:80ab0d068708 246 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 1:80ab0d068708 247 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
samux 1:80ab0d068708 248 E_INTERRUPT, // bmAttributes (0x03=intr)
samux 1:80ab0d068708 249 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
samux 1:80ab0d068708 250 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
samux 1:80ab0d068708 251 16, // bInterval
samux 1:80ab0d068708 252
samux 1:80ab0d068708 253
samux 1:80ab0d068708 254
samux 1:80ab0d068708 255
samux 1:80ab0d068708 256 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
samux 8:335f2506f422 257 9, // bLength
samux 8:335f2506f422 258 4, // bDescriptorType
samux 8:335f2506f422 259 1, // bInterfaceNumber
samux 8:335f2506f422 260 0, // bAlternateSetting
samux 8:335f2506f422 261 2, // bNumEndpoints
samux 8:335f2506f422 262 0x0A, // bInterfaceClass
samux 8:335f2506f422 263 0x00, // bInterfaceSubClass
samux 8:335f2506f422 264 0x00, // bInterfaceProtocol
samux 8:335f2506f422 265 0, // iInterface
samux 1:80ab0d068708 266
samux 1:80ab0d068708 267 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
samux 8:335f2506f422 268 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 8:335f2506f422 269 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 8:335f2506f422 270 PHY_TO_DESC(EPBULK_IN), // bEndpointAddress
samux 8:335f2506f422 271 E_BULK, // bmAttributes (0x02=bulk)
samux 8:335f2506f422 272 LSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (LSB)
samux 8:335f2506f422 273 MSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (MSB)
samux 8:335f2506f422 274 0, // bInterval
samux 1:80ab0d068708 275
samux 1:80ab0d068708 276 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
samux 8:335f2506f422 277 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
samux 8:335f2506f422 278 ENDPOINT_DESCRIPTOR, // bDescriptorType
samux 8:335f2506f422 279 PHY_TO_DESC(EPBULK_OUT), // bEndpointAddress
samux 8:335f2506f422 280 E_BULK, // bmAttributes (0x02=bulk)
samux 8:335f2506f422 281 LSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (LSB)
samux 8:335f2506f422 282 MSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (MSB)
samux 8:335f2506f422 283 0 // bInterval
samux 1:80ab0d068708 284 };
samux 1:80ab0d068708 285 return configDescriptor;
samux 1:80ab0d068708 286 }