Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/USBCDC.cpp@1:80ab0d068708, 2012-07-17 (annotated)

Committer:
samux
Date:
Tue Jul 17 14:30:29 2012 +0000
Revision:
1:80ab0d068708
Child:
6:d0945750af57
Update USBDevice lib

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