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.

USBHID/USBHID_Types.h@24:4ed3e25c3edc, 2014-03-30 (annotated)

Committer:
tolaipner
Date:
Sun Mar 30 07:30:18 2014 +0000
Revision:
24:4ed3e25c3edc
Parent:
1:80ab0d068708 
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 USBCLASS_HID_TYPES
samux 1:80ab0d068708 20 #define USBCLASS_HID_TYPES
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include <stdint.h>
samux 1:80ab0d068708 23
samux 1:80ab0d068708 24 /* */
samux 1:80ab0d068708 25 #define HID_VERSION_1_11 (0x0111)
samux 1:80ab0d068708 26
samux 1:80ab0d068708 27 /* HID Class */
samux 1:80ab0d068708 28 #define HID_CLASS (3)
samux 1:80ab0d068708 29 #define HID_SUBCLASS_NONE (0)
samux 1:80ab0d068708 30 #define HID_PROTOCOL_NONE (0)
samux 1:80ab0d068708 31
samux 1:80ab0d068708 32 /* Descriptors */
samux 1:80ab0d068708 33 #define HID_DESCRIPTOR (33)
samux 1:80ab0d068708 34 #define HID_DESCRIPTOR_LENGTH (0x09)
samux 1:80ab0d068708 35 #define REPORT_DESCRIPTOR (34)
samux 1:80ab0d068708 36
samux 1:80ab0d068708 37 /* Class requests */
samux 1:80ab0d068708 38 #define GET_REPORT (0x1)
samux 1:80ab0d068708 39 #define GET_IDLE (0x2)
samux 1:80ab0d068708 40 #define SET_REPORT (0x9)
samux 1:80ab0d068708 41 #define SET_IDLE (0xa)
samux 1:80ab0d068708 42
samux 1:80ab0d068708 43 /* HID Class Report Descriptor */
samux 1:80ab0d068708 44 /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */
samux 1:80ab0d068708 45 /* of data as per HID Class standard */
samux 1:80ab0d068708 46
samux 1:80ab0d068708 47 /* Main items */
samux 1:80ab0d068708 48 #define INPUT(size) (0x80 | size)
samux 1:80ab0d068708 49 #define OUTPUT(size) (0x90 | size)
samux 1:80ab0d068708 50 #define FEATURE(size) (0xb0 | size)
samux 1:80ab0d068708 51 #define COLLECTION(size) (0xa0 | size)
samux 1:80ab0d068708 52 #define END_COLLECTION(size) (0xc0 | size)
samux 1:80ab0d068708 53
samux 1:80ab0d068708 54 /* Global items */
samux 1:80ab0d068708 55 #define USAGE_PAGE(size) (0x04 | size)
samux 1:80ab0d068708 56 #define LOGICAL_MINIMUM(size) (0x14 | size)
samux 1:80ab0d068708 57 #define LOGICAL_MAXIMUM(size) (0x24 | size)
samux 1:80ab0d068708 58 #define PHYSICAL_MINIMUM(size) (0x34 | size)
samux 1:80ab0d068708 59 #define PHYSICAL_MAXIMUM(size) (0x44 | size)
samux 1:80ab0d068708 60 #define UNIT_EXPONENT(size) (0x54 | size)
samux 1:80ab0d068708 61 #define UNIT(size) (0x64 | size)
samux 1:80ab0d068708 62 #define REPORT_SIZE(size) (0x74 | size)
samux 1:80ab0d068708 63 #define REPORT_ID(size) (0x84 | size)
samux 1:80ab0d068708 64 #define REPORT_COUNT(size) (0x94 | size)
samux 1:80ab0d068708 65 #define PUSH(size) (0xa4 | size)
samux 1:80ab0d068708 66 #define POP(size) (0xb4 | size)
samux 1:80ab0d068708 67
samux 1:80ab0d068708 68 /* Local items */
samux 1:80ab0d068708 69 #define USAGE(size) (0x08 | size)
samux 1:80ab0d068708 70 #define USAGE_MINIMUM(size) (0x18 | size)
samux 1:80ab0d068708 71 #define USAGE_MAXIMUM(size) (0x28 | size)
samux 1:80ab0d068708 72 #define DESIGNATOR_INDEX(size) (0x38 | size)
samux 1:80ab0d068708 73 #define DESIGNATOR_MINIMUM(size) (0x48 | size)
samux 1:80ab0d068708 74 #define DESIGNATOR_MAXIMUM(size) (0x58 | size)
samux 1:80ab0d068708 75 #define STRING_INDEX(size) (0x78 | size)
samux 1:80ab0d068708 76 #define STRING_MINIMUM(size) (0x88 | size)
samux 1:80ab0d068708 77 #define STRING_MAXIMUM(size) (0x98 | size)
samux 1:80ab0d068708 78 #define DELIMITER(size) (0xa8 | size)
samux 1:80ab0d068708 79
samux 1:80ab0d068708 80 /* HID Report */
samux 1:80ab0d068708 81 /* Where report IDs are used the first byte of 'data' will be the */
samux 1:80ab0d068708 82 /* report ID and 'length' will include this report ID byte. */
samux 1:80ab0d068708 83
samux 1:80ab0d068708 84 #define MAX_HID_REPORT_SIZE (64)
samux 1:80ab0d068708 85
samux 1:80ab0d068708 86 typedef struct {
samux 1:80ab0d068708 87 uint32_t length;
samux 1:80ab0d068708 88 uint8_t data[MAX_HID_REPORT_SIZE];
samux 1:80ab0d068708 89 } HID_REPORT;
samux 1:80ab0d068708 90
samux 1:80ab0d068708 91 #endif