SPP_HALTime_t Struct Reference

Time struct that contains all the pointers to the Time functions. More...

#include <hal.h>

Data Fields
spp_uint32_t(*)	getTimeMs (void)
	Return the current hardware time in milliseconds.
spp_uint32_t(*)	getTimeUs (void)
	Return the current hardware time in microseconds.
void(*)	delayMs (spp_uint32_t ms)
	Block for the requested number of milliseconds.

Detailed Description

Time struct that contains all the pointers to the Time functions.

Definition at line 179 of file hal.h.

Field Documentation

getTimeMs

spp_uint32_t(*) SPP_HALTime_t::getTimeMs(void)

Return the current hardware time in milliseconds.

Used to timestamp packets. Must be monotonically non-decreasing.

Returns

Elapsed time in ms.

Definition at line 188 of file hal.h.

Referenced by SPP_HAL_TIME_getTimeMs().

getTimeUs

spp_uint32_t(*) SPP_HALTime_t::getTimeUs(void)

Return the current hardware time in microseconds.

Used to timestamp packets. Must be monotonically non-decreasing.

Returns

Elapsed time in us.

Definition at line 197 of file hal.h.

Referenced by SPP_HAL_TIME_getTimeUs().

delayMs

void(*) SPP_HALTime_t::delayMs(spp_uint32_t ms)

Block for the requested number of milliseconds.

Used during sensor initialisation sequences that require a fixed delay. On baremetal targets this is a busy-wait; on RTOS targets it may yield.

Parameters

[in]

ms

Number of milliseconds to delay.

Definition at line 207 of file hal.h.

Referenced by SPP_HAL_TIME_delayMs().

---

The documentation for this struct was generated from the following file:

• solaris-v2/spp/hal/hal.h