Skip to content

Document MSPM0, HPM and the pin layout in the README - #29

Merged
Jiu-xiao merged 3 commits into
devfrom
docs/readme-mspm0-hpm-20261007
Oct 8, 2026
Merged

Jiu-xiao merged 3 commits into
devfrom
docs/readme-mspm0-hpm-20261007

Conversation

@Jiu-xiao

@Jiu-xiao Jiu-xiao commented Oct 8, 2026

Copy link
Copy Markdown
Member

Documents in the README what #25 added: the MSPM0 and HPM flows and libxr pins for the three platforms.

What changes

  • New section "从 .syscfg 到代码 / From .syscfg to Code": libxr mspm0 setup on the root .syscfg; when SysConfig runs (SYSCONFIG_TOOL + MSPM0_SDK_INSTALL_DIR) and when a newer build output is reused; the generated objects (GPIO after the pin label, UART/I2C/SPI after the lower-case peripheral name, PWM as pwm_<timer>_c<n>) and their settings in libxr_config.yaml.
  • New section "从 .hpmpc 到代码 / From .hpmpc to Code": libxr hpm setup on app.yaml + boards/*/*.hpmpc; pins from the pinmux functions main calls outside preprocessor conditions, init_bsp_pins() only when main calls none; GPIO renames; I2C and GPTMR PWM.
  • libxr pins: STM32, MSPM0 and HPM models and packages, the -d project overlay (project.assignments / project.peripherals, the whole-section GPIO rename of an HPM), and the pin data sources and licenses.
  • XRobot integration: the next XRobot step at the end of every platform's setup (the setup commands before Modules/modules.yaml exists, the xrobot gen reminder after).
  • Command table: libxr mspm0 setup, libxr hpm setup.

README only. It merges cleanly with #26/#28 (CDC interface) and #27 in either order.

Verification

  • The libxr mspm0 setup and libxr hpm setup outputs are line-for-line those of a fresh run of this dev line on bsp-mspm0g3507-mini and bsp-hpm5301evklite; excerpts are marked as such.
  • The statements were checked against generator_code_mspm0.py, generator_code_hpm.py, pin_project.py and cli.py on dev.

Parsing an MSPM0 project runs SysConfig only when SYSCONFIG_TOOL and
MSPM0_SDK_INSTALL_DIR are set and reuses a build output otherwise; the two
sections get headings in the README's style; UART, I2C and SPI objects take the
lower-case peripheral name; the HPM init_bsp_pins fallback applies only when
main calls no pinmux function; the package rules and the data license name HPM.
The setup of every platform reminds to run xrobot gen once Modules/modules.yaml
exists; the XRobot integration section named stm32 setup and the steps before
modules.yaml only, and the MSPM0 and HPM example outputs lacked the reminder.
@Jiu-xiao
Jiu-xiao merged commit 2435b38 into dev Oct 8, 2026
@Jiu-xiao
Jiu-xiao deleted the docs/readme-mspm0-hpm-20261007 branch October 11, 2026 02:33
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.

1 participant