nRF5 SDK for Thread and Zigbee v4.0.0
Functions
High Precision Timer for the 802.15.4 driver

Module that defines API of High Precision Timer for the 802.15.4 driver. More...

Functions

void nrf_802154_hp_timer_init (void)
 Initializes the timer.
 
void nrf_802154_hp_timer_deinit (void)
 Deinitializes the timer.
 
void nrf_802154_hp_timer_start (void)
 Starts the timer. More...
 
void nrf_802154_hp_timer_stop (void)
 Stops the timer. More...
 
uint32_t nrf_802154_hp_timer_current_time_get (void)
 Gets the value indicated by the timer right now. More...
 
uint32_t nrf_802154_hp_timer_sync_task_get (void)
 Gets the task used to synchronize the timer with the LP timer. More...
 
void nrf_802154_hp_timer_sync_prepare (void)
 Configures the timer to detect if the synchronization task was triggered.
 
bool nrf_802154_hp_timer_sync_time_get (uint32_t *p_timestamp)
 Gets the timestamp of the synchronization event. More...
 
uint32_t nrf_802154_hp_timer_timestamp_task_get (void)
 Gets the task used to make timestamp of an event. More...
 
uint32_t nrf_802154_hp_timer_timestamp_get (void)
 Gets the timestamp of the last event. More...
 

Detailed Description

Module that defines API of High Precision Timer for the 802.15.4 driver.

High Precision Timer for the 802.15.4 driver.

The High Precision Timer is used only when the radio is in use. It is not used when the radio is in the sleep mode or out of the RAAL timeslots. This timer is meant to provide at least 1-microsecond precision. It is intended to be used for precise frame timestamps or synchronous radio operations.

Note
The High Precision Timer is relative. To use it as an absolute timer, synchronize it with the Low Power Timer using the Timer Coordinator module.

Function Documentation

uint32_t nrf_802154_hp_timer_current_time_get ( void  )

Gets the value indicated by the timer right now.

Note
The returned value is relative to the nrf_802154_hp_timer_start call time. It is not synchronized with the LP timer.
Returns
Current timer value in microseconds.
void nrf_802154_hp_timer_start ( void  )

Starts the timer.

The timer starts counting when this command is called.

void nrf_802154_hp_timer_stop ( void  )

Stops the timer.

The timer stops counting and enters the low power mode.

uint32_t nrf_802154_hp_timer_sync_task_get ( void  )

Gets the task used to synchronize the timer with the LP timer.

Returns
Address of the task.
bool nrf_802154_hp_timer_sync_time_get ( uint32_t *  p_timestamp)

Gets the timestamp of the synchronization event.

Parameters
[out]p_timestampTimestamp of the synchronization event.
Return values
trueSynchronization was performed and p_timestamp is valid.
falseSynchronization was not performed. p_timestamp was not modified.
uint32_t nrf_802154_hp_timer_timestamp_get ( void  )

Gets the timestamp of the last event.

Returns
Timestamp of the last event that triggered the nrf_802154_hp_timer_timestamp_task_get task.
uint32_t nrf_802154_hp_timer_timestamp_task_get ( void  )

Gets the task used to make timestamp of an event.

This function is to be used to configure PPI. It configures the timer to detect if the returned task was triggered to return a valid value by nrf_802154_hp_timer_timestamp_get.

Returns
Address of the task.

Documentation feedback | Developer Zone | Subscribe | Updated