diff --git a/lbm_lib/PORTING_GUIDE.md b/lbm_lib/PORTING_GUIDE.md index 0af711c3..35ce6864 100644 --- a/lbm_lib/PORTING_GUIDE.md +++ b/lbm_lib/PORTING_GUIDE.md @@ -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 )` diff --git a/lbm_lib/smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h b/lbm_lib/smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h index 9fe1f00d..1b63f274 100644 --- a/lbm_lib/smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h +++ b/lbm_lib/smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h @@ -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 diff --git a/lbm_lib/smtc_modem_hal/smtc_modem_hal.h b/lbm_lib/smtc_modem_hal/smtc_modem_hal.h index 4decdc70..c772b51f 100644 --- a/lbm_lib/smtc_modem_hal/smtc_modem_hal.h +++ b/lbm_lib/smtc_modem_hal/smtc_modem_hal.h @@ -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 *