mirror/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-04-18 11:42:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update header comments.

Browse Source
This commit is contained in:
Nathan Conrad 2019-09-11 09:44:25 -04:00
parent 4cf2b30759
commit 784dc52b62
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/portable/st/stm32_fsdev/dcd_stm32_fsdev.c
View File

@ -36,7 +36,7 @@
* *
* *
* It also should work with minimal changes for any ST MCU with an "USB A"/"PCD"/"HCD" peripheral. This * It also should work with minimal changes for any ST MCU with an "USB A"/"PCD"/"HCD" peripheral. This
* covers: * covers:
* *
* F04x, F072, F078, 070x6/B 1024 byte buffer * F04x, F072, F078, 070x6/B 1024 byte buffer
* F102, F103 512 byte buffer; no internal D+ pull-up (maybe many more changes?) * F102, F103 512 byte buffer; no internal D+ pull-up (maybe many more changes?)
@ -46,9 +46,13 @@
* L1 512 byte buffer * L1 512 byte buffer
* L4x2, L4x3 1024 byte buffer * L4x2, L4x3 1024 byte buffer
* *
* To use this driver, you must:
* - Enable USB clock; Perhaps use __HAL_RCC_USB_CLK_ENABLE();
* - (Optionally configure GPIO HAL to tell it the USB driver is using the USB pins)
* - call tusb_init();
* - periodically call tusb_task();
*
* Assumptions of the driver: * Assumptions of the driver:
* - dcd_fs_irqHandler() is called by the USB interrupt handler
* - USB clock enabled before usb_init() is called; Perhaps use __HAL_RCC_USB_CLK_ENABLE();
* - You are not using CAN (it must share the packet buffer) * - You are not using CAN (it must share the packet buffer)
* - APB clock is >= 10 MHz * - APB clock is >= 10 MHz
* - On some boards, series resistors are required, but not on others. * - On some boards, series resistors are required, but not on others.
@ -59,7 +63,6 @@
* Current driver limitations (i.e., a list of features for you to add): * Current driver limitations (i.e., a list of features for you to add):
* - STALL handled, but not tested. * - STALL handled, but not tested.
* - Does it work? No clue. * - Does it work? No clue.
* - Only tested on F070RB; other models will have an #error during compilation
* - All EP BTABLE buffers are created as max 64 bytes. * - All EP BTABLE buffers are created as max 64 bytes.
* - Smaller can be requested, but it has to be an even number. * - Smaller can be requested, but it has to be an even number.
* - No isochronous endpoints * - No isochronous endpoints
@ -74,7 +77,7 @@
* - No DMA * - No DMA
* - No provision to control the D+ pull-up using GPIO on devices without an internal pull-up. * - No provision to control the D+ pull-up using GPIO on devices without an internal pull-up.
* - Minimal error handling * - Minimal error handling
* - Perhaps error interrupts sholud be reported to the stack, or cause a device reset? * - Perhaps error interrupts should be reported to the stack, or cause a device reset?
* - Assumes a single USB peripheral; I think that no hardware has multiple so this is fine. * - Assumes a single USB peripheral; I think that no hardware has multiple so this is fine.
* - Add a callback for enabling/disabling the D+ PU on devices without an internal PU. * - Add a callback for enabling/disabling the D+ PU on devices without an internal PU.
* - F3 models use three separate interrupts. I think we could only use the LP interrupt for * - F3 models use three separate interrupts. I think we could only use the LP interrupt for