Radio Control Layer (RCL)
Timing Handler Functions

Detailed Description

These functions are meant mostly to be used by handlers and RCL itself.

Functions

RCL_CommandStatus RCL_Scheduler_setStartStopTime (const RCL_Command *cmd)
 Set start and stop time for LRF based on command. More...
 
RCL_CommandStatus RCL_Scheduler_setStartStopTimeEarliestStart (const RCL_Command *cmd, uint32_t earliestStartTime)
 Set start and stop time for LRF based on command with earliest start time. More...
 
RCL_CommandStatus RCL_Scheduler_setCmdStopTimeNoStartTrigger (const RCL_Command *cmd)
 Set stop time for LRF based on command when it does not need a start trigger. More...
 
RCL_CommandStatus RCL_Scheduler_setNewStartNow (void)
 Set new start time for LRF to now, after a previous start. More...
 
RCL_CommandStatus RCL_Scheduler_setNewStartAbsTime (uint32_t startTime)
 Set new start time for LRF to given absolute time, after a previous start. More...
 
RCL_CommandStatus RCL_Scheduler_setNewStartRelTime (uint32_t relStartTime)
 Set new start time for LRF to given time relative to previous LRF start. More...
 
RCL_StopType RCL_Scheduler_setStopTimes (void)
 Function to apply relevant stop times. More...
 

Function Documentation

◆ RCL_Scheduler_setStartStopTime()

RCL_CommandStatus RCL_Scheduler_setStartStopTime ( const RCL_Command *  cmd)

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set start and stop time for LRF based on command.

Sets start and stop times for LRF based on scheduled times

Note
This function is intended as internal to RCL and its handlers
Parameters
cmdPointer to running command
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References RCL_Debug_assert, RCL_Schedule_AbsTime, rclSchedulerProcessCmdStartStopTime(), SchedulerStartAbsTimeAllowDelay, SchedulerStartAbsTimeNoDelay, and SchedulerStartNow.

◆ RCL_Scheduler_setStartStopTimeEarliestStart()

RCL_CommandStatus RCL_Scheduler_setStartStopTimeEarliestStart ( const RCL_Command *  cmd,
uint32_t  earliestStartTime 
)

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set start and stop time for LRF based on command with earliest start time.

Sets start and stop times for LRF based on scheduled times, but delay start if needed due to hardware startup time

Note
This function is intended as internal to RCL and its handlers
Parameters
cmdPointer to running command
earliestStartTimeStart at earliest at this time, or fail if delay not allowed
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References RCL_CommandStatus_Error_StartTooLate, RCL_Debug_assert, RCL_Schedule_AbsTime, RCL_Scheduler_isLater(), rclSchedulerProcessCmdStartStopTime(), SchedulerStartAbsTimeAllowDelay, and SchedulerStartAbsTimeNoDelay.

Referenced by RCL_Handler_ADC_Noise_getNoise(), RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_conn(), RCL_Handler_BLE5_dtmTx(), RCL_Handler_BLE5_genericRx(), RCL_Handler_BLE5_genericTx(), RCL_Handler_BLE5_scan_init(), RCL_Handler_Ble5_txTest(), RCL_Handler_BLE_CS(), RCL_Handler_Generic_Fs(), RCL_Handler_Generic_Rx(), RCL_Handler_Generic_Tx(), RCL_Handler_Generic_TxRepeat(), RCL_Handler_Generic_TxTest(), RCL_Handler_Nesb_Prx(), and RCL_Handler_Nesb_Ptx().

◆ RCL_Scheduler_setCmdStopTimeNoStartTrigger()

RCL_CommandStatus RCL_Scheduler_setCmdStopTimeNoStartTrigger ( const RCL_Command *  cmd)

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set stop time for LRF based on command when it does not need a start trigger.

Sets stop times for LRF based on scheduled times, but do not program any start trigger

Note
This function is intended as internal to RCL and its handlers
Parameters
cmdPointer to running command
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References RCL_Debug_assert, rclSchedulerProcessCmdStartStopTime(), and SchedulerNoStart.

Referenced by RCL_Handler_Generic_FsOff(), and RCL_Handler_Generic_PbeOperation().

◆ RCL_Scheduler_setNewStartNow()

RCL_CommandStatus RCL_Scheduler_setNewStartNow ( void  )

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set new start time for LRF to now, after a previous start.

Note
This function is intended as internal to RCL and its handlers
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References rclSchedulerProcessCmdStartStopTime(), and SchedulerStartNow.

Referenced by RCL_Handler_BLE5_adv(), RCL_Handler_BLE5_scan_init(), RCL_Handler_Generic_TxRepeat(), and RCL_Handler_Nesb_Ptx().

◆ RCL_Scheduler_setNewStartAbsTime()

RCL_CommandStatus RCL_Scheduler_setNewStartAbsTime ( uint32_t  startTime)

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set new start time for LRF to given absolute time, after a previous start.

Note
This function is intended as internal to RCL and its handlers
Parameters
startTimeAbsloute start time
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References rclSchedulerProcessCmdStartStopTime(), and SchedulerStartAbsTimeAllowDelay.

Referenced by RCL_Handler_ADC_Noise_getNoise().

◆ RCL_Scheduler_setNewStartRelTime()

RCL_CommandStatus RCL_Scheduler_setNewStartRelTime ( uint32_t  relStartTime)

#include </home/developer/.conan/data/rcl/7.20.01.02/library-lprf/eng/package/b64f4a52bedd1ff8fbfa2101ba929a67456d11d1/source/ti/drivers/rcl/RCL_Scheduler.h>

Set new start time for LRF to given time relative to previous LRF start.

Note
This function is intended as internal to RCL and its handlers
Parameters
relStartTimeStart time relative to previous actual start time of LRF
Returns
Command status that should be produced if the command should end or RCL_CmdStatus_Active to go on

References RCL_SchedulerState::actualStartTime, rclSchedulerProcessCmdStartStopTime(), rclSchedulerState, and SchedulerStartAbsTimeAllowDelay.

Referenced by RCL_Handler_BLE5_adv(), RCL_Handler_Generic_TxRepeat(), and RCL_Handler_Nesb_Ptx().

◆ RCL_Scheduler_setStopTimes()