Detailed Description

Stellaris LM4 TimestampProvider.

Stellaris LM4 TimestampProvider delegate.

A timer managed by the "Stellaris LM4 Timer" module is used as the timestamp source.

Calling Context

Function	Hwi	Swi	Task	Main**	Startup***
get32	Y	Y	Y	Y	N
get64	Y	Y	Y	Y	N
getFreq	Y	Y	Y	Y	N
Definitions: Hwi: API is callable from a Hwi thread. Swi: API is callable from a Swi thread. Task: API is callable from a Task thread. Main: API is callable during any of these phases: In your module startup after this module is started (e.g. TimestampProvider_Module_startupDone() returns true). During xdc.runtime.Startup.lastFxns. During main(). During BIOS.startupFxns. Startup: API is callable during any of these phases: During xdc.runtime.Startup.firstFxns. In your module startup before this module is started (e.g. TimestampProvider_Module_startupDone() returns false).

#include <xdc/std.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ti/sysbios/runtime/Types.h>
#include <ti/sysbios/family/arm/lm4/Timer.h>
#include "TimestampProvider_defs.h"

Include dependency graph for TimestampProvider.h:

Go to the source code of this file.

Functions
uint32_t	TimestampProvider_get32 (void)
	Return a 32-bit timestamp. More...

void	TimestampProvider_get64 (Types_Timestamp64 *timestamp64)
	Return a 64-bit timestamp. More...

void	TimestampProvider_getFreq (Types_FreqHz *freq)
	Get the timestamp timer's frequency (in Hz) More...

Function Documentation

§ TimestampProvider_get32()

uint32_t TimestampProvider_get32 ( void )

Return a 32-bit timestamp.

Returns a 32-bit timestamp value. Use TimestampProvider_getFreq to convert this value into units of real time.

Return values

32-bit timestamp

§ TimestampProvider_get64()

void TimestampProvider_get64 ( Types_Timestamp64 * timestamp64 )

Return a 64-bit timestamp.

This parameter is a pointer to a structure representing a 64-bit wide timestamp value where the current timestamp is written.

If the underlying hardware does not support 64-bit resolution, the hi field of result is always set to 0. So, it is possible for the lo field to wrap around without any change to the hi field. Use TimestampProvider_getFreq to convert this value into units of real time.

Parameters

timestamp64 pointer to 64-bit result

§ TimestampProvider_getFreq()

void TimestampProvider_getFreq ( Types_FreqHz * freq )

Get the timestamp timer's frequency (in Hz)

This parameter is a pointer to a structure representing a 64-bit wide frequency value where the timer's frequency (in Hz) is written. This function provides a way of converting timestamp values into units of real time.