Skip to content

fix: invalid documentation of parameters of smtc_modem_hal_irq_config_radio_irq #164

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.

Sign up for GitHub

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
rgnter wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: invalid documentation of parameters of smtc_modem_hal_irq_config_radio_irq #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ab68b1
fix: invalid documentation of parameters of `smtc_modem_hal_irq_confi…
rgnter Jul 26, 2026
559c066
fix: invalid documentation of `ral_sx126x_bsp_get_xosc_cfg`
rgnter Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lbm_lib/PORTING_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Store the callback and context argument that must be executed when a radio event
| | | |
|--- |--- |--- |
|[in]|callback|Callback that is executed upon radio interrupt service request|
|[in]|context|Argument that is provided to callback|
|[in]|context|Context that is provided to the callback|

#### `void smtc_modem_hal_start_radio_tcxo( void )`

Expand Down
2 changes: 1 addition & 1 deletion lbm_lib/smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ void ral_sx126x_bsp_get_tx_cfg( const void* context, const ral_sx126x_bsp_tx_cfg
/**
* Get the XOSC configuration
*
* @remark If no TCXO is present, this function should set tcxo_is_radio_controlled to false, and return.
* @remark If no TCXO is present, this function should set xosc_cfg to RAL_XOSC_CFG_XTAL, and return.
*
* @param [in] context Chip implementation context
* @param [out] xosc_cfg Let the caller know what kind of XOSC is used
Expand Down
11 changes: 6 additions & 5 deletions lbm_lib/smtc_modem_hal/smtc_modem_hal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,22 +259,23 @@ uint32_t smtc_modem_hal_get_random_nb_in_range( const uint32_t val_1, const uint
/**
* @brief Config the radio interruption callback
*
* @param [in] callback Callback that will be called in case of timer irq
* @param [in] context Context that will be passed on callback argument
* @param [in] callback Callback that is executed upon radio interrupt service request
* @param [in] context Context that is provided to the callback
*
*/
void smtc_modem_hal_irq_config_radio_irq( void ( *callback )( void* context ), void* context );

/* ------------ Radio management ------------ */


/* ------------ Radio management ------------
*@brief Check if the radio is free
/**
* @brief Check if the radio is free
* @remark except a very specific application, this function should always return false
* @remark This function is used to check if the radio is use by an external stack
*
* @return bool False if the radio is free, false otherwise
*/
bool smtc_modem_external_stack_currently_use_radio( void );

/**
* @brief Start radio tcxo
*
Expand Down