ON Semiconductor / mbed-os

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.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/unsupported/USBDevice/USBSerial/USBCDC.cpp@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
group-onsemi 0:098463de4c5d 2 *
group-onsemi 0:098463de4c5d 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
group-onsemi 0:098463de4c5d 4 * and associated documentation files (the "Software"), to deal in the Software without
group-onsemi 0:098463de4c5d 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
group-onsemi 0:098463de4c5d 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
group-onsemi 0:098463de4c5d 7 * Software is furnished to do so, subject to the following conditions:
group-onsemi 0:098463de4c5d 8 *
group-onsemi 0:098463de4c5d 9 * The above copyright notice and this permission notice shall be included in all copies or
group-onsemi 0:098463de4c5d 10 * substantial portions of the Software.
group-onsemi 0:098463de4c5d 11 *
group-onsemi 0:098463de4c5d 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
group-onsemi 0:098463de4c5d 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
group-onsemi 0:098463de4c5d 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
group-onsemi 0:098463de4c5d 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
group-onsemi 0:098463de4c5d 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
group-onsemi 0:098463de4c5d 17 */
group-onsemi 0:098463de4c5d 18
group-onsemi 0:098463de4c5d 19 #include "stdint.h"
group-onsemi 0:098463de4c5d 20 #include "USBCDC.h"
group-onsemi 0:098463de4c5d 21
group-onsemi 0:098463de4c5d 22 static uint8_t cdc_line_coding[7]= {0x80, 0x25, 0x00, 0x00, 0x00, 0x00, 0x08};
group-onsemi 0:098463de4c5d 23
group-onsemi 0:098463de4c5d 24 #define DEFAULT_CONFIGURATION (1)
group-onsemi 0:098463de4c5d 25
group-onsemi 0:098463de4c5d 26 #define CDC_SET_LINE_CODING 0x20
group-onsemi 0:098463de4c5d 27 #define CDC_GET_LINE_CODING 0x21
group-onsemi 0:098463de4c5d 28 #define CDC_SET_CONTROL_LINE_STATE 0x22
group-onsemi 0:098463de4c5d 29
group-onsemi 0:098463de4c5d 30 // Control Line State bits
group-onsemi 0:098463de4c5d 31 #define CLS_DTR (1 << 0)
group-onsemi 0:098463de4c5d 32 #define CLS_RTS (1 << 1)
group-onsemi 0:098463de4c5d 33
group-onsemi 0:098463de4c5d 34 #define MAX_CDC_REPORT_SIZE MAX_PACKET_SIZE_EPBULK
group-onsemi 0:098463de4c5d 35
group-onsemi 0:098463de4c5d 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) {
group-onsemi 0:098463de4c5d 37 terminal_connected = false;
group-onsemi 0:098463de4c5d 38 USBDevice::connect(connect_blocking);
group-onsemi 0:098463de4c5d 39 }
group-onsemi 0:098463de4c5d 40
group-onsemi 0:098463de4c5d 41 bool USBCDC::USBCallback_request(void) {
group-onsemi 0:098463de4c5d 42 /* Called in ISR context */
group-onsemi 0:098463de4c5d 43
group-onsemi 0:098463de4c5d 44 bool success = false;
group-onsemi 0:098463de4c5d 45 CONTROL_TRANSFER * transfer = getTransferPtr();
group-onsemi 0:098463de4c5d 46
group-onsemi 0:098463de4c5d 47 /* Process class-specific requests */
group-onsemi 0:098463de4c5d 48
group-onsemi 0:098463de4c5d 49 if (transfer->setup.bmRequestType.Type == CLASS_TYPE) {
group-onsemi 0:098463de4c5d 50 switch (transfer->setup.bRequest) {
group-onsemi 0:098463de4c5d 51 case CDC_GET_LINE_CODING:
group-onsemi 0:098463de4c5d 52 transfer->remaining = 7;
group-onsemi 0:098463de4c5d 53 transfer->ptr = cdc_line_coding;
group-onsemi 0:098463de4c5d 54 transfer->direction = DEVICE_TO_HOST;
group-onsemi 0:098463de4c5d 55 success = true;
group-onsemi 0:098463de4c5d 56 break;
group-onsemi 0:098463de4c5d 57 case CDC_SET_LINE_CODING:
group-onsemi 0:098463de4c5d 58 transfer->remaining = 7;
group-onsemi 0:098463de4c5d 59 transfer->notify = true;
group-onsemi 0:098463de4c5d 60 success = true;
group-onsemi 0:098463de4c5d 61 break;
group-onsemi 0:098463de4c5d 62 case CDC_SET_CONTROL_LINE_STATE:
group-onsemi 0:098463de4c5d 63 if (transfer->setup.wValue & CLS_DTR) {
group-onsemi 0:098463de4c5d 64 terminal_connected = true;
group-onsemi 0:098463de4c5d 65 } else {
group-onsemi 0:098463de4c5d 66 terminal_connected = false;
group-onsemi 0:098463de4c5d 67 }
group-onsemi 0:098463de4c5d 68 success = true;
group-onsemi 0:098463de4c5d 69 break;
group-onsemi 0:098463de4c5d 70 default:
group-onsemi 0:098463de4c5d 71 break;
group-onsemi 0:098463de4c5d 72 }
group-onsemi 0:098463de4c5d 73 }
group-onsemi 0:098463de4c5d 74
group-onsemi 0:098463de4c5d 75 return success;
group-onsemi 0:098463de4c5d 76 }
group-onsemi 0:098463de4c5d 77
group-onsemi 0:098463de4c5d 78 void USBCDC::USBCallback_requestCompleted(uint8_t *buf, uint32_t length) {
group-onsemi 0:098463de4c5d 79 // Request of setting line coding has 7 bytes
group-onsemi 0:098463de4c5d 80 if (length != 7) {
group-onsemi 0:098463de4c5d 81 return;
group-onsemi 0:098463de4c5d 82 }
group-onsemi 0:098463de4c5d 83
group-onsemi 0:098463de4c5d 84 CONTROL_TRANSFER * transfer = getTransferPtr();
group-onsemi 0:098463de4c5d 85
group-onsemi 0:098463de4c5d 86 /* Process class-specific requests */
group-onsemi 0:098463de4c5d 87 if (transfer->setup.bmRequestType.Type == CLASS_TYPE) {
group-onsemi 0:098463de4c5d 88 if (transfer->setup.bRequest == CDC_SET_LINE_CODING) {
group-onsemi 0:098463de4c5d 89 if (memcmp(cdc_line_coding, buf, 7)) {
group-onsemi 0:098463de4c5d 90 memcpy(cdc_line_coding, buf, 7);
group-onsemi 0:098463de4c5d 91
group-onsemi 0:098463de4c5d 92 int baud = buf[0] + (buf[1] << 8)
group-onsemi 0:098463de4c5d 93 + (buf[2] << 16) + (buf[3] << 24);
group-onsemi 0:098463de4c5d 94 int stop = buf[4];
group-onsemi 0:098463de4c5d 95 int bits = buf[6];
group-onsemi 0:098463de4c5d 96 int parity = buf[5];
group-onsemi 0:098463de4c5d 97
group-onsemi 0:098463de4c5d 98 lineCodingChanged(baud, bits, parity, stop);
group-onsemi 0:098463de4c5d 99 }
group-onsemi 0:098463de4c5d 100 }
group-onsemi 0:098463de4c5d 101 }
group-onsemi 0:098463de4c5d 102 }
group-onsemi 0:098463de4c5d 103
group-onsemi 0:098463de4c5d 104 // Called in ISR context
group-onsemi 0:098463de4c5d 105 // Set configuration. Return false if the
group-onsemi 0:098463de4c5d 106 // configuration is not supported.
group-onsemi 0:098463de4c5d 107 bool USBCDC::USBCallback_setConfiguration(uint8_t configuration) {
group-onsemi 0:098463de4c5d 108 if (configuration != DEFAULT_CONFIGURATION) {
group-onsemi 0:098463de4c5d 109 return false;
group-onsemi 0:098463de4c5d 110 }
group-onsemi 0:098463de4c5d 111
group-onsemi 0:098463de4c5d 112 // Configure endpoints > 0
group-onsemi 0:098463de4c5d 113 addEndpoint(EPINT_IN, MAX_PACKET_SIZE_EPINT);
group-onsemi 0:098463de4c5d 114 addEndpoint(EPBULK_IN, MAX_PACKET_SIZE_EPBULK);
group-onsemi 0:098463de4c5d 115 addEndpoint(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
group-onsemi 0:098463de4c5d 116
group-onsemi 0:098463de4c5d 117 // We activate the endpoint to be able to recceive data
group-onsemi 0:098463de4c5d 118 readStart(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
group-onsemi 0:098463de4c5d 119 return true;
group-onsemi 0:098463de4c5d 120 }
group-onsemi 0:098463de4c5d 121
group-onsemi 0:098463de4c5d 122 bool USBCDC::send(uint8_t * buffer, uint32_t size) {
group-onsemi 0:098463de4c5d 123 return USBDevice::write(EPBULK_IN, buffer, size, MAX_CDC_REPORT_SIZE);
group-onsemi 0:098463de4c5d 124 }
group-onsemi 0:098463de4c5d 125
group-onsemi 0:098463de4c5d 126 bool USBCDC::readEP(uint8_t * buffer, uint32_t * size) {
group-onsemi 0:098463de4c5d 127 if (!USBDevice::readEP(EPBULK_OUT, buffer, size, MAX_CDC_REPORT_SIZE))
group-onsemi 0:098463de4c5d 128 return false;
group-onsemi 0:098463de4c5d 129 if (!readStart(EPBULK_OUT, MAX_CDC_REPORT_SIZE))
group-onsemi 0:098463de4c5d 130 return false;
group-onsemi 0:098463de4c5d 131 return true;
group-onsemi 0:098463de4c5d 132 }
group-onsemi 0:098463de4c5d 133
group-onsemi 0:098463de4c5d 134 bool USBCDC::readEP_NB(uint8_t * buffer, uint32_t * size) {
group-onsemi 0:098463de4c5d 135 if (!USBDevice::readEP_NB(EPBULK_OUT, buffer, size, MAX_CDC_REPORT_SIZE))
group-onsemi 0:098463de4c5d 136 return false;
group-onsemi 0:098463de4c5d 137 if (!readStart(EPBULK_OUT, MAX_CDC_REPORT_SIZE))
group-onsemi 0:098463de4c5d 138 return false;
group-onsemi 0:098463de4c5d 139 return true;
group-onsemi 0:098463de4c5d 140 }
group-onsemi 0:098463de4c5d 141
group-onsemi 0:098463de4c5d 142
group-onsemi 0:098463de4c5d 143 uint8_t * USBCDC::deviceDesc() {
group-onsemi 0:098463de4c5d 144 static uint8_t deviceDescriptor[] = {
group-onsemi 0:098463de4c5d 145 18, // bLength
group-onsemi 0:098463de4c5d 146 1, // bDescriptorType
group-onsemi 0:098463de4c5d 147 0x10, 0x01, // bcdUSB
group-onsemi 0:098463de4c5d 148 2, // bDeviceClass
group-onsemi 0:098463de4c5d 149 0, // bDeviceSubClass
group-onsemi 0:098463de4c5d 150 0, // bDeviceProtocol
group-onsemi 0:098463de4c5d 151 MAX_PACKET_SIZE_EP0, // bMaxPacketSize0
group-onsemi 0:098463de4c5d 152 (uint8_t)(LSB(VENDOR_ID)), (uint8_t)(MSB(VENDOR_ID)), // idVendor
group-onsemi 0:098463de4c5d 153 (uint8_t)(LSB(PRODUCT_ID)), (uint8_t)(MSB(PRODUCT_ID)),// idProduct
group-onsemi 0:098463de4c5d 154 0x00, 0x01, // bcdDevice
group-onsemi 0:098463de4c5d 155 1, // iManufacturer
group-onsemi 0:098463de4c5d 156 2, // iProduct
group-onsemi 0:098463de4c5d 157 3, // iSerialNumber
group-onsemi 0:098463de4c5d 158 1 // bNumConfigurations
group-onsemi 0:098463de4c5d 159 };
group-onsemi 0:098463de4c5d 160 return deviceDescriptor;
group-onsemi 0:098463de4c5d 161 }
group-onsemi 0:098463de4c5d 162
group-onsemi 0:098463de4c5d 163 uint8_t * USBCDC::stringIinterfaceDesc() {
group-onsemi 0:098463de4c5d 164 static uint8_t stringIinterfaceDescriptor[] = {
group-onsemi 0:098463de4c5d 165 0x08,
group-onsemi 0:098463de4c5d 166 STRING_DESCRIPTOR,
group-onsemi 0:098463de4c5d 167 'C',0,'D',0,'C',0,
group-onsemi 0:098463de4c5d 168 };
group-onsemi 0:098463de4c5d 169 return stringIinterfaceDescriptor;
group-onsemi 0:098463de4c5d 170 }
group-onsemi 0:098463de4c5d 171
group-onsemi 0:098463de4c5d 172 uint8_t * USBCDC::stringIproductDesc() {
group-onsemi 0:098463de4c5d 173 static uint8_t stringIproductDescriptor[] = {
group-onsemi 0:098463de4c5d 174 0x16,
group-onsemi 0:098463de4c5d 175 STRING_DESCRIPTOR,
group-onsemi 0:098463de4c5d 176 'C',0,'D',0,'C',0,' ',0,'D',0,'E',0,'V',0,'I',0,'C',0,'E',0
group-onsemi 0:098463de4c5d 177 };
group-onsemi 0:098463de4c5d 178 return stringIproductDescriptor;
group-onsemi 0:098463de4c5d 179 }
group-onsemi 0:098463de4c5d 180
group-onsemi 0:098463de4c5d 181
group-onsemi 0:098463de4c5d 182 #define CONFIG1_DESC_SIZE (9+8+9+5+5+4+5+7+9+7+7)
group-onsemi 0:098463de4c5d 183
group-onsemi 0:098463de4c5d 184 uint8_t * USBCDC::configurationDesc() {
group-onsemi 0:098463de4c5d 185 static uint8_t configDescriptor[] = {
group-onsemi 0:098463de4c5d 186 // configuration descriptor
group-onsemi 0:098463de4c5d 187 9, // bLength
group-onsemi 0:098463de4c5d 188 2, // bDescriptorType
group-onsemi 0:098463de4c5d 189 LSB(CONFIG1_DESC_SIZE), // wTotalLength
group-onsemi 0:098463de4c5d 190 MSB(CONFIG1_DESC_SIZE),
group-onsemi 0:098463de4c5d 191 2, // bNumInterfaces
group-onsemi 0:098463de4c5d 192 1, // bConfigurationValue
group-onsemi 0:098463de4c5d 193 0, // iConfiguration
group-onsemi 0:098463de4c5d 194 0x80, // bmAttributes
group-onsemi 0:098463de4c5d 195 50, // bMaxPower
group-onsemi 0:098463de4c5d 196
group-onsemi 0:098463de4c5d 197 // IAD to associate the two CDC interfaces
group-onsemi 0:098463de4c5d 198 0x08, // bLength
group-onsemi 0:098463de4c5d 199 0x0b, // bDescriptorType
group-onsemi 0:098463de4c5d 200 0x00, // bFirstInterface
group-onsemi 0:098463de4c5d 201 0x02, // bInterfaceCount
group-onsemi 0:098463de4c5d 202 0x02, // bFunctionClass
group-onsemi 0:098463de4c5d 203 0x02, // bFunctionSubClass
group-onsemi 0:098463de4c5d 204 0, // bFunctionProtocol
group-onsemi 0:098463de4c5d 205 0, // iFunction
group-onsemi 0:098463de4c5d 206
group-onsemi 0:098463de4c5d 207 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
group-onsemi 0:098463de4c5d 208 9, // bLength
group-onsemi 0:098463de4c5d 209 4, // bDescriptorType
group-onsemi 0:098463de4c5d 210 0, // bInterfaceNumber
group-onsemi 0:098463de4c5d 211 0, // bAlternateSetting
group-onsemi 0:098463de4c5d 212 1, // bNumEndpoints
group-onsemi 0:098463de4c5d 213 0x02, // bInterfaceClass
group-onsemi 0:098463de4c5d 214 0x02, // bInterfaceSubClass
group-onsemi 0:098463de4c5d 215 0x01, // bInterfaceProtocol
group-onsemi 0:098463de4c5d 216 0, // iInterface
group-onsemi 0:098463de4c5d 217
group-onsemi 0:098463de4c5d 218 // CDC Header Functional Descriptor, CDC Spec 5.2.3.1, Table 26
group-onsemi 0:098463de4c5d 219 5, // bFunctionLength
group-onsemi 0:098463de4c5d 220 0x24, // bDescriptorType
group-onsemi 0:098463de4c5d 221 0x00, // bDescriptorSubtype
group-onsemi 0:098463de4c5d 222 0x10, 0x01, // bcdCDC
group-onsemi 0:098463de4c5d 223
group-onsemi 0:098463de4c5d 224 // Call Management Functional Descriptor, CDC Spec 5.2.3.2, Table 27
group-onsemi 0:098463de4c5d 225 5, // bFunctionLength
group-onsemi 0:098463de4c5d 226 0x24, // bDescriptorType
group-onsemi 0:098463de4c5d 227 0x01, // bDescriptorSubtype
group-onsemi 0:098463de4c5d 228 0x03, // bmCapabilities
group-onsemi 0:098463de4c5d 229 1, // bDataInterface
group-onsemi 0:098463de4c5d 230
group-onsemi 0:098463de4c5d 231 // Abstract Control Management Functional Descriptor, CDC Spec 5.2.3.3, Table 28
group-onsemi 0:098463de4c5d 232 4, // bFunctionLength
group-onsemi 0:098463de4c5d 233 0x24, // bDescriptorType
group-onsemi 0:098463de4c5d 234 0x02, // bDescriptorSubtype
group-onsemi 0:098463de4c5d 235 0x06, // bmCapabilities
group-onsemi 0:098463de4c5d 236
group-onsemi 0:098463de4c5d 237 // Union Functional Descriptor, CDC Spec 5.2.3.8, Table 33
group-onsemi 0:098463de4c5d 238 5, // bFunctionLength
group-onsemi 0:098463de4c5d 239 0x24, // bDescriptorType
group-onsemi 0:098463de4c5d 240 0x06, // bDescriptorSubtype
group-onsemi 0:098463de4c5d 241 0, // bMasterInterface
group-onsemi 0:098463de4c5d 242 1, // bSlaveInterface0
group-onsemi 0:098463de4c5d 243
group-onsemi 0:098463de4c5d 244 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
group-onsemi 0:098463de4c5d 245 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
group-onsemi 0:098463de4c5d 246 ENDPOINT_DESCRIPTOR, // bDescriptorType
group-onsemi 0:098463de4c5d 247 PHY_TO_DESC(EPINT_IN), // bEndpointAddress
group-onsemi 0:098463de4c5d 248 E_INTERRUPT, // bmAttributes (0x03=intr)
group-onsemi 0:098463de4c5d 249 LSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (LSB)
group-onsemi 0:098463de4c5d 250 MSB(MAX_PACKET_SIZE_EPINT), // wMaxPacketSize (MSB)
group-onsemi 0:098463de4c5d 251 16, // bInterval
group-onsemi 0:098463de4c5d 252
group-onsemi 0:098463de4c5d 253
group-onsemi 0:098463de4c5d 254
group-onsemi 0:098463de4c5d 255
group-onsemi 0:098463de4c5d 256 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
group-onsemi 0:098463de4c5d 257 9, // bLength
group-onsemi 0:098463de4c5d 258 4, // bDescriptorType
group-onsemi 0:098463de4c5d 259 1, // bInterfaceNumber
group-onsemi 0:098463de4c5d 260 0, // bAlternateSetting
group-onsemi 0:098463de4c5d 261 2, // bNumEndpoints
group-onsemi 0:098463de4c5d 262 0x0A, // bInterfaceClass
group-onsemi 0:098463de4c5d 263 0x00, // bInterfaceSubClass
group-onsemi 0:098463de4c5d 264 0x00, // bInterfaceProtocol
group-onsemi 0:098463de4c5d 265 0, // iInterface
group-onsemi 0:098463de4c5d 266
group-onsemi 0:098463de4c5d 267 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
group-onsemi 0:098463de4c5d 268 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
group-onsemi 0:098463de4c5d 269 ENDPOINT_DESCRIPTOR, // bDescriptorType
group-onsemi 0:098463de4c5d 270 PHY_TO_DESC(EPBULK_IN), // bEndpointAddress
group-onsemi 0:098463de4c5d 271 E_BULK, // bmAttributes (0x02=bulk)
group-onsemi 0:098463de4c5d 272 LSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (LSB)
group-onsemi 0:098463de4c5d 273 MSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (MSB)
group-onsemi 0:098463de4c5d 274 0, // bInterval
group-onsemi 0:098463de4c5d 275
group-onsemi 0:098463de4c5d 276 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
group-onsemi 0:098463de4c5d 277 ENDPOINT_DESCRIPTOR_LENGTH, // bLength
group-onsemi 0:098463de4c5d 278 ENDPOINT_DESCRIPTOR, // bDescriptorType
group-onsemi 0:098463de4c5d 279 PHY_TO_DESC(EPBULK_OUT), // bEndpointAddress
group-onsemi 0:098463de4c5d 280 E_BULK, // bmAttributes (0x02=bulk)
group-onsemi 0:098463de4c5d 281 LSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (LSB)
group-onsemi 0:098463de4c5d 282 MSB(MAX_PACKET_SIZE_EPBULK),// wMaxPacketSize (MSB)
group-onsemi 0:098463de4c5d 283 0 // bInterval
group-onsemi 0:098463de4c5d 284 };
group-onsemi 0:098463de4c5d 285 return configDescriptor;
group-onsemi 0:098463de4c5d 286 }