Skip to content

fix: invalid documentation of parameters of smtc_modem_hal_irq_config_radio_irq - #164

Open
rgnter wants to merge 2 commits into
Lora-net:masterfrom
rgnter:master
Open

fix: invalid documentation of parameters of smtc_modem_hal_irq_config_radio_irq#164
rgnter wants to merge 2 commits into
Lora-net:masterfrom
rgnter:master

Conversation

@rgnter

@rgnter rgnter commented Jul 26, 2026

Copy link
Copy Markdown

Hello, while implementing the modem for my own firmware I've noticed parameter description inconsistency and broken documentation for functions in smtc_modem_hal.h.

rgnter added 2 commits July 26, 2026 15:26
…g_radio_irq`

Amended the documentation in PORTING_GUIDE.md and fixed the comments in the header.
Remark mentioned a parameter which does not exist anymore. `xosc_cfg` should be set to `RAL_XOSC_CFG_XTAL` if no TXCO is available on the board.
@rgnter

rgnter commented Jul 30, 2026

Copy link
Copy Markdown
Author

I noticed another inconsitency, this time in a remark documentation of ral_sx126x_bsp_get_xosc_cfg. It was mentioning a parameter which does not exist. If no TXCO is available on board xosc_cfg should be set to RAL_XOSC_CFG_XTAL.

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