summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNathan Conrad <[email protected]>2020-04-10 10:23:56 -0400
committerNathan Conrad <[email protected]>2020-04-10 10:26:41 -0400
commit5bd9d14fc14d9130d7d879800bd46e4ca08e3d5f (patch)
tree377e0401716f492b5dd29de016ed274f12790655 /docs
parent715c4dbbf8fe7c6bb83013df626a201928704b30 (diff)
stm32fsdev: set dcd_connect API definitions to strong, Modify documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/porting.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/porting.md b/docs/porting.md
index 7d7d4cdb1..d3408aebd 100644
--- a/docs/porting.md
+++ b/docs/porting.md
@@ -62,7 +62,7 @@ All of the code for the low-level device API is in `src/portable/<vendor>/<chip
##### dcd_init
Initializes the USB peripheral for device mode and enables it.
-If the MCU has an internal pull-up, this function should leave it disabled.
+This function should leave an internal D+/D- pull-up in its default power-on state. `dcd_connect` will be called by the USBD core following `dcd_init`.
#### dcd_int_enable / dcd_int_disable
@@ -81,7 +81,7 @@ Called to remote wake up host when suspended (e.g hid keyboard)
##### dcd_connect / dcd_disconnect
-Connect or disconnect the data-line pull-up resistor. Define as a weak function if the MCU has an internal pull-up, otherwise do not define.
+Connect or disconnect the data-line pull-up resistor. Define only if MCU has an internal pull-up. (BSP may define for MCU without internal pull-up.)
#### Special events
You must let TinyUSB know when certain events occur so that it can continue its work. There are a few methods you can call to queue events for TinyUSB to process.