Tomas Cerskus / USBDevice

USB device stack with Nucleo F401RE support. NOTE: the default clock config needs to be changed to in order for USB to work.

Fork of USBDevice by Tomas Cerskus

Slightly modified original USBDevice library to support F401RE.

On F401RE the data pins of your USB connector should be attached to PA12 (D+) and PA11(D-). It is also required to connect the +5V USB line to PA9.

F401RE requires 48MHz clock for USB. Therefore in order for this to work you will need to change the default clock settings:

Clock settings for USB

#include "stm32f4xx_hal.h"

RCC_OscInitTypeDef RCC_OscInitStruct;
RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSI;
RCC_OscInitStruct.HSIState = RCC_HSI_ON;
RCC_OscInitStruct.HSICalibrationValue = 16;
RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSI;
RCC_OscInitStruct.PLL.PLLM = 16;
RCC_OscInitStruct.PLL.PLLN = 336;
RCC_OscInitStruct.PLL.PLLP = RCC_PLLP_DIV4;
RCC_OscInitStruct.PLL.PLLQ = 7;
if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
    error("RTC error: LSI clock initialization failed."); 
}

NOTE: Changing the clock frequency might affect the behavior of other libraries. I only tested the Serial library.

UPDATE: Clock settings should not to be changed anymore! Looks like the newer mbed library has the required clock enabled.

USBSerial/USBCDC.cpp@24:4ed3e25c3edc, 2014-03-30 (annotated)

Committer:
tolaipner
Date:
Sun Mar 30 07:30:18 2014 +0000
Revision:
24:4ed3e25c3edc
Parent:
19:fcb63a105965 
Added Nucleo F401RE support

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