Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/USBCDC.cpp@11:eeb3cbbaa996, 2013-08-05 (annotated)

Committer:
bogdanm
Date:
Mon Aug 05 14:13:36 2013 +0300
Revision:
11:eeb3cbbaa996
Parent:
8:335f2506f422
Child:
15:849c0c0f2769
Bug fixes, added suppor for LPC1347



Author: Samuel Mokrani

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