Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/USBCDC.cpp@64:c7639faed2eb, 2014-04-28 (annotated)

Committer:
alpov
Date:
Mon Apr 28 12:15:41 2014 +0000
Revision:
64:c7639faed2eb
Parent:
19:fcb63a105965 
fixed bus reset for KL25Z, added more terminal_connected checking stuff

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