Merged
Conversation
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of another USB related peripheral: USB_JTAG_SERIAL 2. correct related document
- This commit adds the API documentation for the USB Host Library. - Warnings about the beta API are also added. - usb_host_misc.h renamed to usb_helpers.h
This commit adds the USB Host Library documentation and fixes some nitpicks in the Host Stack types. Closes espressif/esp-idf#6408
USB: Host stack cleanup and QOL update Closes IDFGH-6120, IDF-2747, IDFGH-4592, and IDFGH-6402 See merge request espressif/esp-idf!16349
VBUS voltage monitoring is mandated by USB specification for self-powered devices. This implementation maps selected GPIO to bvalid signal of USB-OTG peripheral. Closes espressif/esp-idf#7747
updated USB_OTG in dfu.rst, usb_device.rst and secure-boot-v2.rst Closes DOC-3565 See merge request espressif/esp-idf!20144
This commit adds some parts of the USB Host Stack's maintainers notes (specifically "Introduction" and "DWC_OTG Controller" chapters).
…host as a USB Mass Storage Device
USB Dev: Integrate SD MMC Card as a storage media that is accessed by USB-host as a USB Mass Storage Device Closes IDF-6545 and IDFGH-9040 See merge request espressif/esp-idf!21679
This commit adds some parts of the USB Host Stack's maintainers notes (specifically "Design" and "Architecture").
…eration This commit updates some comments and documentation regarding changes made in PR espressif/esp-idf#11113.
Fix usb enumeration stage error for some device (GitHub PR) Closes IDFGH-9778 See merge request espressif/esp-idf!23233
Docs: update CN translation for esp_http_client.rst, external-ram.rst, bootloader.rst Closes DOC-4934 See merge request espressif/esp-idf!23136
usbd: add usb composite device example Closes IDFGH-9035 See merge request espressif/esp-idf!23135
tore-espressif
temporarily deployed
to
esp-docs preview
GitHub Actions
Inactive
tore-espressif
force-pushed
the
docs/sphinx
branch
from
8053cc9 to
0e6f3db
Compare
tore-espressif
had a problem deploying
to
esp-docs preview
GitHub Actions
Failure
tore-espressif
had a problem deploying
to
esp-docs preview
GitHub Actions
Failure
tore-espressif
force-pushed
the
docs/sphinx
branch
from
f7abd20 to
df949ed
Compare
tore-espressif
had a problem deploying
to
esp-docs preview
GitHub Actions
Failure
tore-espressif
temporarily deployed
to
esp-docs preview
GitHub Actions
Inactive
tore-espressif
force-pushed
the
docs/sphinx
branch
from
071f486 to
8a12a70
Compare
tore-espressif
changed the title
tore-espressif
temporarily deployed
to
esp-docs preview
GitHub Actions
Inactive
Collaborator
Author
|
@peter-marcisovsky @igi540 This is minimum viable PR that deploy USB documentation to docs.espressif.com. On pushes to master, the webpage is deployed, for PR it is deployed to preview server, eg here https://preview-docs.espressif.com/projects/esp-usb/en/318-merge/esp32p4/index.html
|
Collaborator
peter-marcisovsky
left a comment
peter-marcisovsky
left a comment
There was a problem hiding this comment.
Leaving some comment, nothing blocking. The documentation preview looks nice
tore-espressif
commented
Dec 3, 2025
Collaborator
Author
tore-espressif
left a comment
tore-espressif
left a comment
There was a problem hiding this comment.
@peter-marcisovsky Thank you for the review! Will follow-up ASAP
tore-espressif
force-pushed
the
docs/sphinx
branch
from
8a12a70 to
9c91ca4
Compare
tore-espressif
temporarily deployed
to
esp-docs preview
GitHub Actions
Inactive
Collaborator
Author
|
@peter-marcisovsky @igi540 Thank you very much for taking a look! I resolved all comments apart from missing git history, will do that soon. I also added doxygen generated API to the docs, so now everything should be ready. All changes kept in one commit for easy review 9c91ca4 |
Taken from esp-idf commit e2025fce69d2bee5b447be9c611cb73e81dde7c5
tore-espressif
force-pushed
the
docs/sphinx
branch
from
9c91ca4 to
57d9bb0
Compare
tore-espressif
temporarily deployed
to
esp-docs preview
GitHub Actions
Inactive
peter-marcisovsky
approved these changes
Dec 8, 2025
Collaborator
peter-marcisovsky
left a comment
peter-marcisovsky
left a comment
There was a problem hiding this comment.
One Q about CI: Did you try to fail the docs build on purpose? To test whether the falied command ./build_docs.sh, makes the CI to fail as well?
I remember that I needed to return 0 or 1 from an .sh script to make the CI pass/fail when I was using script to run host tests here
But maybe the build-docs already returns a value..
Otherwise LGTM.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
18 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.