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/USBSerial.h@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 #ifndef USBSERIAL_H
samux 1:80ab0d068708 20 #define USBSERIAL_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "USBCDC.h"
samux 1:80ab0d068708 23 #include "Stream.h"
samux 1:80ab0d068708 24 #include "CircBuffer.h"
samux 1:80ab0d068708 25
samux 1:80ab0d068708 26
samux 1:80ab0d068708 27 /**
samux 1:80ab0d068708 28 * USBSerial example
samux 1:80ab0d068708 29 *
samux 1:80ab0d068708 30 * @code
samux 1:80ab0d068708 31 * #include "mbed.h"
samux 1:80ab0d068708 32 * #include "USBSerial.h"
samux 1:80ab0d068708 33 *
samux 1:80ab0d068708 34 * //Virtual serial port over USB
samux 1:80ab0d068708 35 * USBSerial serial;
samux 1:80ab0d068708 36 *
samux 1:80ab0d068708 37 * int main(void) {
samux 1:80ab0d068708 38 *
samux 1:80ab0d068708 39 * while(1)
samux 1:80ab0d068708 40 * {
samux 1:80ab0d068708 41 * serial.printf("I am a virtual serial port\n");
samux 1:80ab0d068708 42 * wait(1);
samux 1:80ab0d068708 43 * }
samux 1:80ab0d068708 44 * }
samux 1:80ab0d068708 45 * @endcode
samux 1:80ab0d068708 46 */
samux 1:80ab0d068708 47 class USBSerial: public USBCDC, public Stream {
samux 1:80ab0d068708 48 public:
samux 1:80ab0d068708 49
samux 1:80ab0d068708 50 /**
samux 1:80ab0d068708 51 * Constructor
samux 1:80ab0d068708 52 *
samux 1:80ab0d068708 53 * @param vendor_id Your vendor_id (default: 0x1f00)
samux 1:80ab0d068708 54 * @param product_id Your product_id (default: 0x2012)
samux 1:80ab0d068708 55 * @param product_release Your preoduct_release (default: 0x0001)
mbed_official 19:fcb63a105965 56 * @param connect_blocking define if the connection must be blocked if USB not plugged in
samux 1:80ab0d068708 57 *
samux 1:80ab0d068708 58 */
mbed_official 19:fcb63a105965 59 USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001, bool connect_blocking = true): USBCDC(vendor_id, product_id, product_release, connect_blocking), buf(128){
mbed_official 15:849c0c0f2769 60 settingsChangedCallback = 0;
mbed_official 15:849c0c0f2769 61 };
samux 1:80ab0d068708 62
samux 1:80ab0d068708 63
samux 1:80ab0d068708 64 /**
samux 1:80ab0d068708 65 * Send a character. You can use puts, printf.
samux 1:80ab0d068708 66 *
samux 1:80ab0d068708 67 * @param c character to be sent
samux 1:80ab0d068708 68 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 69 */
samux 1:80ab0d068708 70 virtual int _putc(int c);
samux 1:80ab0d068708 71
samux 1:80ab0d068708 72 /**
samux 1:80ab0d068708 73 * Read a character: blocking
samux 1:80ab0d068708 74 *
samux 1:80ab0d068708 75 * @returns character read
samux 1:80ab0d068708 76 */
samux 1:80ab0d068708 77 virtual int _getc();
samux 1:80ab0d068708 78
samux 1:80ab0d068708 79 /**
samux 1:80ab0d068708 80 * Check the number of bytes available.
samux 1:80ab0d068708 81 *
samux 1:80ab0d068708 82 * @returns the number of bytes available
samux 1:80ab0d068708 83 */
samux 1:80ab0d068708 84 uint8_t available();
mbed_official 15:849c0c0f2769 85
mbed_official 15:849c0c0f2769 86 /** Determine if there is a character available to read
mbed_official 15:849c0c0f2769 87 *
mbed_official 15:849c0c0f2769 88 * @returns
mbed_official 15:849c0c0f2769 89 * 1 if there is a character available to read,
mbed_official 15:849c0c0f2769 90 * 0 otherwise
mbed_official 15:849c0c0f2769 91 */
mbed_official 15:849c0c0f2769 92 int readable() { return available() ? 1 : 0; }
mbed_official 15:849c0c0f2769 93
mbed_official 15:849c0c0f2769 94 /** Determine if there is space available to write a character
mbed_official 15:849c0c0f2769 95 *
mbed_official 15:849c0c0f2769 96 * @returns
mbed_official 15:849c0c0f2769 97 * 1 if there is space to write a character,
mbed_official 15:849c0c0f2769 98 * 0 otherwise
mbed_official 15:849c0c0f2769 99 */
mbed_official 15:849c0c0f2769 100 int writeable() { return 1; } // always return 1, for write operation is blocking
samux 1:80ab0d068708 101
samux 1:80ab0d068708 102 /**
samux 1:80ab0d068708 103 * Write a block of data.
samux 1:80ab0d068708 104 *
samux 1:80ab0d068708 105 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
samux 1:80ab0d068708 106 *
samux 1:80ab0d068708 107 * @param buf pointer on data which will be written
samux 1:80ab0d068708 108 * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
samux 1:80ab0d068708 109 *
samux 1:80ab0d068708 110 * @returns true if successfull
samux 1:80ab0d068708 111 */
samux 1:80ab0d068708 112 bool writeBlock(uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 113
samux 1:80ab0d068708 114 /**
samux 1:80ab0d068708 115 * Attach a member function to call when a packet is received.
samux 1:80ab0d068708 116 *
samux 1:80ab0d068708 117 * @param tptr pointer to the object to call the member function on
samux 1:80ab0d068708 118 * @param mptr pointer to the member function to be called
samux 1:80ab0d068708 119 */
samux 1:80ab0d068708 120 template<typename T>
samux 1:80ab0d068708 121 void attach(T* tptr, void (T::*mptr)(void)) {
samux 1:80ab0d068708 122 if((mptr != NULL) && (tptr != NULL)) {
samux 1:80ab0d068708 123 rx.attach(tptr, mptr);
samux 1:80ab0d068708 124 }
samux 1:80ab0d068708 125 }
samux 1:80ab0d068708 126
samux 1:80ab0d068708 127 /**
samux 1:80ab0d068708 128 * Attach a callback called when a packet is received
samux 1:80ab0d068708 129 *
samux 1:80ab0d068708 130 * @param fptr function pointer
samux 1:80ab0d068708 131 */
mbed_official 15:849c0c0f2769 132 void attach(void (*fptr)(void)) {
mbed_official 15:849c0c0f2769 133 if(fptr != NULL) {
mbed_official 15:849c0c0f2769 134 rx.attach(fptr);
samux 1:80ab0d068708 135 }
samux 1:80ab0d068708 136 }
samux 1:80ab0d068708 137
mbed_official 15:849c0c0f2769 138 /**
mbed_official 15:849c0c0f2769 139 * Attach a callback to call when serial's settings are changed.
mbed_official 15:849c0c0f2769 140 *
mbed_official 15:849c0c0f2769 141 * @param fptr function pointer
mbed_official 15:849c0c0f2769 142 */
mbed_official 15:849c0c0f2769 143 void attach(void (*fptr)(int baud, int bits, int parity, int stop)) {
mbed_official 15:849c0c0f2769 144 settingsChangedCallback = fptr;
mbed_official 15:849c0c0f2769 145 }
samux 1:80ab0d068708 146
samux 1:80ab0d068708 147 protected:
samux 1:80ab0d068708 148 virtual bool EP2_OUT_callback();
mbed_official 15:849c0c0f2769 149 virtual void lineCodingChanged(int baud, int bits, int parity, int stop){
mbed_official 15:849c0c0f2769 150 if (settingsChangedCallback) {
mbed_official 15:849c0c0f2769 151 settingsChangedCallback(baud, bits, parity, stop);
mbed_official 15:849c0c0f2769 152 }
mbed_official 15:849c0c0f2769 153 }
samux 1:80ab0d068708 154
samux 1:80ab0d068708 155 private:
samux 1:80ab0d068708 156 FunctionPointer rx;
samux 1:80ab0d068708 157 CircBuffer<uint8_t> buf;
mbed_official 15:849c0c0f2769 158 void (*settingsChangedCallback)(int baud, int bits, int parity, int stop);
samux 1:80ab0d068708 159 };
samux 1:80ab0d068708 160
samux 1:80ab0d068708 161 #endif