summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHa Thach <[email protected]>2020-04-11 13:20:31 +0700
committerGitHub <[email protected]>2020-04-11 13:20:31 +0700
commit07809d03a728abff4c77f04fdf293eb29a0c109c (patch)
tree2d180c7228b34bd1845729a1231b78e6f433af16 /docs
parent2ff3f765db7e62201d0491093111b0d649446046 (diff)
parent5bd9d14fc14d9130d7d879800bd46e4ca08e3d5f (diff)
Merge pull request #332 from pigrew/stm32fsdev-dcdconnect
stm32fsdev: Implement dcd_connect.
Diffstat (limited to 'docs')
-rw-r--r--docs/porting.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/porting.md b/docs/porting.md
index ccafa7999..7cc890bdc 100644
--- a/docs/porting.md
+++ b/docs/porting.md
@@ -62,6 +62,8 @@ 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.
+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
Enables or disables the USB device interrupt(s). May be used to prevent concurrency issues when mutating data structures shared between main code and the interrupt handler.
@@ -77,6 +79,10 @@ Called when the device received SET_CONFIG request, you can leave this empty if
##### dcd_remote_wakeup
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 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.