mbed official / USBDevice Featured

USB device stack

Dependents:   mbed-mX-USB-TEST1 USBMSD_SD_HID_HelloWorld HidTest MIDI_usb_bridge ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBSerial/USBCDC.cpp@71:53949e6131f6, 2017-07-27 (annotated)

Committer:
Kojto
Date:
Thu Jul 27 12:14:04 2017 +0100
Revision:
71:53949e6131f6
Parent:
70:2c525a50f1b6 
Update libraries



Fixes the previous commmit, as some devices were not copied. USBDevice contains

now targets directory with all targets implementations

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