Skip to content

doc on OTG_FS_* for STM32F4 with standalone OTG_FS_* section #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eZioPan
Copy link
Contributor

@eZioPan eZioPan commented Jun 13, 2023

Note:
renaming branch lead to accidently close #849.


not affect at all:
F410, which has no OTG peripheral.

doc on OTG_FS_GLOBAL, OTG_FS_DEVICE, OTG_FS_HOST and OTG_FS_PWRCLK(OTG_FS_PCGCCTL) peripherals for F4 device with a standalone OTG_FS section:
include 401, 411, 405, 407, 417(not in repo) , 427, 437(not in repo), 429, 439(not in repo)
not include 412, 413, 423(not in repo), 446, 469, 479(not in repo)

@github-actions
Copy link

Memory map comparison

@eZioPan eZioPan changed the title doc on OTG_FS_* doc on OTG_FS_* for STM32F4 with standalone OTG_FS_* section Jun 14, 2023
@github-actions
Copy link

Memory map comparison

@eZioPan eZioPan marked this pull request as ready for review June 14, 2023 14:38
@burrbull
Copy link
Member

burrbull commented Jul 6, 2025

@eZioPan Do you want to rebase these patches?

@eZioPan
Copy link
Contributor Author

eZioPan commented Jul 6, 2025

Hi, thank you for picking up this PR. I'd like to rebase it, but it's been a while since I last worked on it, and I've lost track of the new changes in the master branch. I'd greatly appreciate it if you could help rebase it. Thanks!

@burrbull
Copy link
Member

burrbull commented Jul 6, 2025

The main change is that recommended way is to use independent patch files for different peripherals and _include them under corresponding peripheral header in root yaml.

See https://github.com/stm32-rs/stm32-rs?tab=readme-ov-file#helping also.

…MSK`, matching with reference manual

extract `OTG_FS_GLOBAL` from patched svd

docs on `USB_OTG_FS_GLOBAL` peripherals

extract `OTG_FS_DEVICE` from patched svd

match registers name with reference manual

partially doc on `OTG_FS_DEVICE`

see description...

1. exclude patch file from f469 f446 f413 f412
2. move patch file just after fs_v1 definition
3. adjust patch files with the assistance of `svd2html`

`otg_fs_device` done

remove none exist registers

extract `OTG_FS_HOST` from patched svd

partically doc on `OTG_FS_HOST`

fill each field

quick doc on `OTG_FS_PCGCCTL` reg

Update CHANGELOG.md

Update CHANGELOG.md typo fix
@burrbull
Copy link
Member

@eZioPan I've rebased your PR. But it does not look complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants