Radio Control Layer (RCL)
Enumerations | Functions
hal.h File Reference
#include <stdint.h>
+ Include dependency graph for hal.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  HalTimerEvent {
  HAL_TIMER_EVT_NONE = 0, HAL_TIMER_EVT_SETUP = 1, HAL_TIMER_EVT_START = 2, HAL_TIMER_EVT_GRACEFUL_STOP = 3,
  HAL_TIMER_EVT_HARD_STOP = 4, HAL_TIMER_EVT_PACKET_TIMEOUT = 5
}
 
enum  RCL_PowerEvent { RCL_POWER_STANDBY_AWAKE = 0, RCL_POWER_XTAL_AVAILABLE = 1, RCL_POWER_STANDBY_ENTER = 2 }
 

Functions

void hal_init_fsm (void(*setupFsmCb)(void), void(*schedFsmCb)(void), void(*commandFsmCb)(void))
 
void hal_trigger_command_fsm (void)
 
void hal_trigger_dispatch_fsm (void)
 
void hal_trigger_scheduler_fsm (void)
 
uint32_t hal_get_command_ifg_reg (void)
 
uint32_t hal_get_dispatch_ifg_reg (void)
 
uint32_t hal_get_current_time (void)
 
void hal_enable_setup_time_irq (void)
 
void hal_setup_setup_time (uint32_t setupTime)
 
void hal_setup_start_time (uint32_t startTime)
 
void hal_setup_packet_timeout (uint32_t stopTime)
 
void hal_setup_hard_stop_time (uint32_t stopTime)
 
void hal_enable_hard_stop_time_irq (void)
 
void hal_disable_hard_stop_time_irq (void)
 
void hal_setup_graceful_stop_time (uint32_t stopTime)
 
void hal_enable_graceful_stop_time_irq (void)
 
void hal_cancel_setup_time (void)
 
void hal_cancel_start_time (void)
 
void hal_cancel_packet_timeout (void)
 
void hal_cancel_hard_stop_time (void)
 
void hal_cancel_graceful_stop_time (void)
 
void hal_init_dispatch_radio_interrupts (uint32_t mask)
 
void hal_enable_command_radio_interrupt (uint32_t mask)
 
void hal_disable_command_radio_interrupt (uint32_t mask)
 
void hal_clear_command_radio_interrupt (uint32_t mask)
 
void hal_disable_all_command_radio_interrupts (void)
 
void hal_disable_all_dispatch_radio_interrupts (void)
 
void hal_temperature_init (void)
 
int16_t hal_get_temperature (void)
 
uint16_t hal_get_vdds_voltage (void)
 
uint32_t hal_get_hfxt_ratio (void)
 
uint32_t hal_get_hfxt_ratio_default (void)
 
HalTimerEvent hal_check_clear_timer_compare (void)
 
void hal_setup_cmd_start_cap (void)
 
void hal_arm_cmd_start_cap (void)
 
uint32_t hal_get_cmd_start_cap (void)
 
void hal_setup_sync_found_cap (void)
 
void hal_arm_sync_found_cap (void)
 
uint32_t hal_get_sync_found_cap (void)
 
void hal_setup_cmd_done_cap (void)
 
void hal_arm_cmd_done_cap (void)
 
uint32_t hal_get_cmd_done_cap (void)
 
void hal_set_rcl_clock_enable (uint16_t mask)
 
void hal_clear_rcl_clock_enable (uint16_t mask)
 
uint8_t hal_set_dcdc_ipeak_setting (uint8_t setting)
 
void hal_enable_clk_buffer (void)
 
void hal_power_set_standby_constraint (void)
 
void hal_power_release_standby_constraint (void)
 
void hal_power_set_swtcxo_update_constraint (void)
 
void hal_power_release_swtcxo_update_constraint (void)
 
void hal_power_open (void(*rclPowerNotifyFunction)(RCL_PowerEvent))
 
void hal_power_close (void)
 
void hal_set_temperature_notification (int16_t currentTemperature, uint16_t temperatureRange, void(*rclTemperatureNotify)(int16_t))
 
void hal_stop_temperature_notification (void)
 

Enumeration Type Documentation

§ HalTimerEvent

enum HalTimerEvent
Enumerator
HAL_TIMER_EVT_NONE 
HAL_TIMER_EVT_SETUP 
HAL_TIMER_EVT_START 
HAL_TIMER_EVT_GRACEFUL_STOP 
HAL_TIMER_EVT_HARD_STOP 
HAL_TIMER_EVT_PACKET_TIMEOUT 

§ RCL_PowerEvent

enum RCL_PowerEvent
Enumerator
RCL_POWER_STANDBY_AWAKE 
RCL_POWER_XTAL_AVAILABLE 
RCL_POWER_STANDBY_ENTER 

Function Documentation

§ hal_init_fsm()

void hal_init_fsm ( void(*)(void)  setupFsmCb,
void(*)(void)  schedFsmCb,
void(*)(void)  commandFsmCb 
)

References commandHwi, dispatchHwi, halCommandFsmCb, halDispatchFsmCb, halSchedFsmCb, RF_commandHwi(), RF_dispatchHwi(), RF_schedHwi(), and schedHwi.

Referenced by RCL_init().

§ hal_trigger_command_fsm()

void hal_trigger_command_fsm ( void  )

Referenced by RCL_Scheduler_postEvent().

§ hal_trigger_dispatch_fsm()

void hal_trigger_dispatch_fsm ( void  )

Referenced by rclCommandHwi().

§ hal_trigger_scheduler_fsm()

void hal_trigger_scheduler_fsm ( void  )

Referenced by RCL_Command_submit(), RCL_triggerScheduler(), and rclDispatchHwi().

§ hal_get_command_ifg_reg()

uint32_t hal_get_command_ifg_reg ( void  )

Referenced by RCL_Lite_CommandHwi(), and rclCommandHwi().

§ hal_get_dispatch_ifg_reg()

uint32_t hal_get_dispatch_ifg_reg ( void  )

Referenced by rclDispatchHwi().

§ hal_get_current_time()

uint32_t hal_get_current_time ( void  )

Referenced by rclSchedulerProcessCmdStartStopTime().

§ hal_enable_setup_time_irq()

void hal_enable_setup_time_irq ( void  )

Referenced by rclPowerNotify().

§ hal_setup_setup_time()

void hal_setup_setup_time ( uint32_t  setupTime)

References channel2usage, and SYSTIM_CH2_SETUP.

Referenced by RCL_Lite_Command_start(), and rclSchedulerHwi().

§ hal_setup_start_time()

void hal_setup_start_time ( uint32_t  startTime)

References channel2usage, and SYSTIM_CH2_START.

Referenced by rclSchedulerProcessCmdStartStopTime().

§ hal_setup_packet_timeout()

void hal_setup_packet_timeout ( uint32_t  stopTime)

§ hal_setup_hard_stop_time()

void hal_setup_hard_stop_time ( uint32_t  stopTime)

References channel2usage, and SYSTIM_CH2_STOP.

Referenced by RCL_Handler_Ieee_setCustomEventTime(), and RCL_Scheduler_setStopTimes().

§ hal_enable_hard_stop_time_irq()

void hal_enable_hard_stop_time_irq ( void  )

Referenced by RCL_Handler_Ieee_setCustomEventTime().

§ hal_disable_hard_stop_time_irq()

void hal_disable_hard_stop_time_irq ( void  )

§ hal_setup_graceful_stop_time()

void hal_setup_graceful_stop_time ( uint32_t  stopTime)

Referenced by RCL_Scheduler_setStopTimes().

§ hal_enable_graceful_stop_time_irq()

void hal_enable_graceful_stop_time_irq ( void  )

Referenced by RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_aux_adv(), RCL_Handler_BLE5_periodicAdv(), and RCL_Handler_Generic_TxRepeat().

§ hal_cancel_setup_time()

void hal_cancel_setup_time ( void  )

References hal_cancel_lrfd_systim0().

Referenced by RCL_Lite_Command_start(), and RCL_Lite_CommandHwi().

§ hal_cancel_start_time()

void hal_cancel_start_time ( void  )

References hal_cancel_lrfd_systim0().

Referenced by rclCommandHwi().

§ hal_cancel_packet_timeout()

void hal_cancel_packet_timeout ( void  )

§ hal_cancel_hard_stop_time()

void hal_cancel_hard_stop_time ( void  )

References hal_cancel_lrfd_systim0().

Referenced by RCL_Handler_Ieee_restoreStopTime(), RCL_Lite_CommandHwi(), RCL_Scheduler_setStopTimes(), rclCommandHwi(), and rclSchedulerCancelStopTime().

§ hal_cancel_graceful_stop_time()

void hal_cancel_graceful_stop_time ( void  )

Referenced by RCL_Lite_CommandHwi(), RCL_Scheduler_setStopTimes(), rclCommandHwi(), and rclSchedulerCancelStopTime().

§ hal_init_dispatch_radio_interrupts()

void hal_init_dispatch_radio_interrupts ( uint32_t  mask)

Referenced by rclPowerNotify(), and rclSchedulerHwi().

§ hal_enable_command_radio_interrupt()

void hal_enable_command_radio_interrupt ( uint32_t  mask)

Referenced by LRF_enableHwInterrupt(), and RCL_Lite_Command_start().

§ hal_disable_command_radio_interrupt()

void hal_disable_command_radio_interrupt ( uint32_t  mask)

Referenced by LRF_disableHwInterrupt().

§ hal_clear_command_radio_interrupt()

void hal_clear_command_radio_interrupt ( uint32_t  mask)

Referenced by LRF_clearHwInterrupt().

§ hal_disable_all_command_radio_interrupts()

void hal_disable_all_command_radio_interrupts ( void  )

Referenced by RCL_Lite_CommandHwi(), and rclCommandHwi().

§ hal_disable_all_dispatch_radio_interrupts()

void hal_disable_all_dispatch_radio_interrupts ( void  )

Referenced by rclDispatchHwi().

§ hal_temperature_init()

void hal_temperature_init ( void  )

Referenced by RCL_init().

§ hal_get_temperature()

int16_t hal_get_temperature ( void  )

Referenced by LRF_programTemperatureCompensatedTxPower(), LRF_programTxPower(), LRF_temperatureCompensateTrim(), and RCL_Handler_BLE_CS_Precal().

§ hal_get_vdds_voltage()

uint16_t hal_get_vdds_voltage ( void  )

Referenced by __attribute__(), LRF_applyAntennaSelection(), and LRF_programTxPower().

§ hal_get_hfxt_ratio()

uint32_t hal_get_hfxt_ratio ( void  )

References RCL_DEFAULT_HFTRACKCTL_RATIO.

Referenced by LRF_scaleFreqWithHFXTOffset().

§ hal_get_hfxt_ratio_default()

uint32_t hal_get_hfxt_ratio_default ( void  )

References RCL_DEFAULT_HFTRACKCTL_RATIO.

Referenced by LRF_scaleFreqWithHFXTOffset().

§ hal_check_clear_timer_compare()

HalTimerEvent hal_check_clear_timer_compare ( void  )

References channel2usage, HAL_TIMER_EVT_GRACEFUL_STOP, HAL_TIMER_EVT_HARD_STOP, HAL_TIMER_EVT_NONE, HAL_TIMER_EVT_SETUP, HAL_TIMER_EVT_START, SYSTIM_CH2_SETUP, SYSTIM_CH2_START, and SYSTIM_CH2_STOP.

Referenced by RCL_Lite_CommandHwi(), and rclCommandHwi().

§ hal_setup_cmd_start_cap()

void hal_setup_cmd_start_cap ( void  )

§ hal_arm_cmd_start_cap()

void hal_arm_cmd_start_cap ( void  )

§ hal_get_cmd_start_cap()

uint32_t hal_get_cmd_start_cap ( void  )

§ hal_setup_sync_found_cap()

void hal_setup_sync_found_cap ( void  )

Referenced by RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_aux_adv(), RCL_Handler_BLE5_conn(), RCL_Handler_BLE5_genericRx(), RCL_Handler_BLE5_periodicScan(), RCL_Handler_BLE5_scan_init(), RCL_Handler_Generic_Rx(), RCL_Handler_Ieee_RxTx(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

§ hal_arm_sync_found_cap()

void hal_arm_sync_found_cap ( void  )

§ hal_get_sync_found_cap()

uint32_t hal_get_sync_found_cap ( void  )

§ hal_setup_cmd_done_cap()

void hal_setup_cmd_done_cap ( void  )

§ hal_arm_cmd_done_cap()

void hal_arm_cmd_done_cap ( void  )

§ hal_get_cmd_done_cap()

uint32_t hal_get_cmd_done_cap ( void  )

§ hal_set_rcl_clock_enable()

void hal_set_rcl_clock_enable ( uint16_t  mask)

References CLK_DEP_RCL, and hal_set_clock_enable().

Referenced by LRF_setRclClockEnable().

§ hal_clear_rcl_clock_enable()

void hal_clear_rcl_clock_enable ( uint16_t  mask)

References CLK_DEP_RCL, and hal_clear_clock_enable().

Referenced by LRF_clearRclClockEnable().

§ hal_set_dcdc_ipeak_setting()

uint8_t hal_set_dcdc_ipeak_setting ( uint8_t  setting)

References LRF_DEFAULT_DCDC_IPEAK_SETTING.

Referenced by LRF_disable(), and LRF_enable().

§ hal_enable_clk_buffer()

void hal_enable_clk_buffer ( void  )

Referenced by RCL_open().

§ hal_power_set_standby_constraint()

void hal_power_set_standby_constraint ( void  )

Referenced by RCL_AdcNoise_get_samples_blocking(), RCL_AdcNoise_get_samples_callback(), RCL_Handler_Generic_Fs(), RCL_Handler_Generic_setSynthPowerState(), and rclCommandHwi().

§ hal_power_release_standby_constraint()

void hal_power_release_standby_constraint ( void  )

Referenced by adcNoiseCallback(), RCL_AdcNoise_get_samples_blocking(), RCL_Handler_Generic_setSynthPowerState(), and rclCommandHwi().

§ hal_power_set_swtcxo_update_constraint()

void hal_power_set_swtcxo_update_constraint ( void  )

Referenced by LRF_updateTemperatureCompensation(), RCL_Handler_ADC_Noise_getNoise(), RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_aux_adv(), RCL_Handler_BLE5_ChannelAssessment(), RCL_Handler_BLE5_conn(), RCL_Handler_BLE5_dtmTx(), RCL_Handler_BLE5_genericRx(), RCL_Handler_BLE5_genericTx(), RCL_Handler_BLE5_periodicAdv(), RCL_Handler_BLE5_periodicScan(), RCL_Handler_BLE5_scan_init(), RCL_Handler_Ble5_txTest(), RCL_Handler_BLE_CS(), RCL_Handler_BLE_CS_Precal(), RCL_Handler_Generic_prepareSynth(), RCL_Handler_Ieee_RxTx(), and RCL_Handler_Ieee_TxTest().

§ hal_power_release_swtcxo_update_constraint()

void hal_power_release_swtcxo_update_constraint ( void  )

Referenced by LRF_updateTemperatureCompensation(), RCL_Handler_ADC_Noise_getNoise(), RCL_Handler_Adc_Noise_powerDown(), RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_aux_adv(), RCL_Handler_BLE5_ChannelAssessment(), RCL_Handler_BLE5_conn(), RCL_Handler_BLE5_dtmTx(), RCL_Handler_BLE5_genericRx(), RCL_Handler_BLE5_genericTx(), RCL_Handler_BLE5_periodicAdv(), RCL_Handler_BLE5_periodicScan(), RCL_Handler_BLE5_scan_init(), RCL_Handler_Ble5_txTest(), RCL_Handler_BLE_CS(), RCL_Handler_BLE_CS_Precal(), RCL_Handler_Generic_setSynthPowerState(), RCL_Handler_Ieee_RxTx(), and RCL_Handler_Ieee_TxTest().

§ hal_power_open()

void hal_power_open ( void(*)(RCL_PowerEvent)  rclPowerNotifyFunction)

References hal_power_post_notify_fxn(), powerAwakeStandbyObj, and powerEnterStandbyObj.

Referenced by RCL_openPowerNotifications().

§ hal_power_close()

void hal_power_close ( void  )

References powerAwakeStandbyObj, and powerEnterStandbyObj.

Referenced by RCL_closePowerNotifications().

§ hal_set_temperature_notification()

void hal_set_temperature_notification ( int16_t  currentTemperature,
uint16_t  temperatureRange,
void(*)(int16_t)  rclTemperatureNotify 
)

References hal_temperature_post_notify_fxn(), and temperatureChangeNotifyObj.

Referenced by LRF_enableTemperatureMonitoring().

§ hal_stop_temperature_notification()

void hal_stop_temperature_notification ( void  )

References temperatureChangeNotifyObj.

Referenced by LRF_disableTemperatureMonitoring().