Generic System Tick Driver. More...

Detailed Description

Generic System Tick Driver.

This module implements a system tick timer in order to support the underlying operating system.

Collaboration diagram for ST Driver:

Macros
#define	ST_LLD_NUM_ALARMS 1

Typedefs
typedef void(*	st_callback_t) (unsigned alarm)

Functions
void	stInit (void)
	ST Driver initialization.
void	stBind (void)
	Enables an alarm interrupt on the invoking core.
systime_t	stGetCounter (void)
	Returns the time counter value.
void	stStartAlarm (systime_t abstime)
	Starts the alarm zero.
void	stStopAlarm (void)
	Stops the alarm zero interrupt.
void	stSetAlarm (systime_t abstime)
	Sets the alarm zero time.
systime_t	stGetAlarm (void)
	Returns the alarm zero current time.
bool	stIsAlarmActive (void)
	Determines if the alarm zero is active.
void	stSetCallback (unsigned alarm, st_callback_t cb)
	Associates a callback to an alarm.
void	stBindAlarmN (unsigned alarm)
	Enables an alarm interrupt on the invoking core.
void	stStartAlarmN (unsigned alarm, systime_t abstime)
	Starts an additional alarm.
void	stStopAlarmN (unsigned alarm)
	Stops an additional alarm.
void	stSetAlarmN (unsigned alarm, systime_t abstime)
	Sets an additional alarm time.
systime_t	stGetAlarmN (unsigned alarm)
	Returns an additional alarm current time.
bool	stIsAlarmActiveN (unsigned alarm)
	Determines if the specified alarm is active.
void	st_lld_init (void)
	Low level ST driver initialization.
static systime_t	st_lld_get_counter (void)
	Returns the time counter value.
static void	st_lld_start_alarm (systime_t abstime)
	Starts the alarm.
static void	st_lld_stop_alarm (void)
	Stops the alarm interrupt.
static void	st_lld_set_alarm (systime_t abstime)
	Sets the alarm time.
static systime_t	st_lld_get_alarm (void)
	Returns the current alarm time.
static bool	st_lld_is_alarm_active (void)
	Determines if the alarm is active.

Variables
st_callback_t	st_callbacks [ST_LLD_NUM_ALARMS]
	Callback pointers for each alarm.

Macro Definition Documentation

◆ ST_LLD_NUM_ALARMS

#define ST_LLD_NUM_ALARMS 1

Definition at line 46 of file hal_st.h.

Referenced by stBindAlarmN(), stGetAlarmN(), stInit(), stIsAlarmActiveN(), stSetAlarmN(), stSetCallback(), stStartAlarmN(), and stStopAlarmN().

Typedef Documentation

◆ st_callback_t

typedef void(* st_callback_t) (unsigned alarm)

Definition at line 53 of file hal_st.h.

Function Documentation

◆ stInit()

void stInit ( void )

ST Driver initialization.

Note: This function is implicitly invoked by halInit(), there is no need to explicitly initialize the driver.

Function Class:: Object or module nitializer function.

Definition at line 69 of file hal_st.c.

References st_callbacks, st_lld_init(), and ST_LLD_NUM_ALARMS.

Referenced by halInit().

Here is the call graph for this function:

◆ stBind()

void stBind ( void )

Enables an alarm interrupt on the invoking core.

Note: Must be called before any other alarm-related function.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 87 of file hal_st.c.

◆ stGetCounter()

systime_t stGetCounter ( void )

Returns the time counter value.

Note: This functionality is only available in free running mode, the behaviour in periodic mode is undefined.

Returns: The counter value.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 103 of file hal_st.c.

References st_lld_get_counter().

Here is the call graph for this function:

◆ stStartAlarm()

void stStartAlarm ( systime_t abstime )

Starts the alarm zero.

Note: Makes sure that no spurious alarms are triggered after this call.; This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in] abstime the time to be set for the first alarm

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 119 of file hal_st.c.

References osalDbgAssert, st_lld_start_alarm(), and stIsAlarmActive().

Here is the call graph for this function:

◆ stStopAlarm()

void stStopAlarm ( void )

Stops the alarm zero interrupt.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 133 of file hal_st.c.

References st_lld_stop_alarm().

Here is the call graph for this function:

◆ stSetAlarm()

void stSetAlarm ( systime_t abstime )

Sets the alarm zero time.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in] abstime the time to be set for the next alarm

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 147 of file hal_st.c.

References osalDbgAssert, st_lld_set_alarm(), and stIsAlarmActive().

Here is the call graph for this function:

◆ stGetAlarm()

systime_t stGetAlarm ( void )

Returns the alarm zero current time.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Returns: The currently set alarm time.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 163 of file hal_st.c.

References osalDbgAssert, st_lld_get_alarm(), and stIsAlarmActive().

Here is the call graph for this function:

◆ stIsAlarmActive()

bool stIsAlarmActive ( void )

Determines if the alarm zero is active.

Returns: The alarm status.

Return values

false	if the alarm is not active.
true	is the alarm is active

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 179 of file hal_st.c.

References st_lld_is_alarm_active().

Referenced by stBindAlarmN(), stGetAlarm(), stSetAlarm(), and stStartAlarm().

Here is the call graph for this function:

◆ stSetCallback()

void stSetCallback	(	unsigned	alarm,
		st_callback_t	cb )

Associates a callback to an alarm.

Note: Makes sure that no spurious alarms are triggered after this call.; This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in]	alarm	alarm channel number (0..ST_LLD_NUM_ALARMS-1)
[in]	cb	alarm callback or `NULL`

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 197 of file hal_st.c.

References osalDbgCheck, st_callbacks, and ST_LLD_NUM_ALARMS.

◆ stBindAlarmN()

void stBindAlarmN ( unsigned alarm )

Enables an alarm interrupt on the invoking core.

Note: Must be called before any other alarm-related function.

Parameters

[in] alarm alarm channel number (0..ST_LLD_NUM_ALARMS-1)

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 213 of file hal_st.c.

References osalDbgAssert, osalDbgCheck, ST_LLD_NUM_ALARMS, and stIsAlarmActive().

Here is the call graph for this function:

◆ stStartAlarmN()

void stStartAlarmN	(	unsigned	alarm,
		systime_t	abstime )

Starts an additional alarm.

Note: Makes sure that no spurious alarms are triggered after this call.; This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in]	alarm	alarm channel number (0..ST_LLD_NUM_ALARMS-1)
[in]	abstime	the time to be set for the first alarm

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 234 of file hal_st.c.

References osalDbgAssert, osalDbgCheck, ST_LLD_NUM_ALARMS, and stIsAlarmActiveN().

Here is the call graph for this function:

◆ stStopAlarmN()

void stStopAlarmN ( unsigned alarm )

Stops an additional alarm.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in] alarm alarm channel number (0..ST_LLD_NUM_ALARMS-1)

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 251 of file hal_st.c.

References osalDbgCheck, and ST_LLD_NUM_ALARMS.

◆ stSetAlarmN()

void stSetAlarmN	(	unsigned	alarm,
		systime_t	abstime )

Sets an additional alarm time.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in]	alarm	alarm channel number (0..ST_LLD_NUM_ALARMS-1)
[in]	abstime	the time to be set for the next alarm

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 268 of file hal_st.c.

References osalDbgAssert, osalDbgCheck, ST_LLD_NUM_ALARMS, and stIsAlarmActiveN().

Here is the call graph for this function:

◆ stGetAlarmN()

systime_t stGetAlarmN ( unsigned alarm )

Returns an additional alarm current time.

Note: This functionality is only available in free running mode, the behavior in periodic mode is undefined.

Parameters

[in] alarm alarm channel number (0..ST_LLD_NUM_ALARMS-1)

Returns: The currently set alarm time.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 286 of file hal_st.c.

References osalDbgAssert, osalDbgCheck, ST_LLD_NUM_ALARMS, and stIsAlarmActiveN().

Here is the call graph for this function:

◆ stIsAlarmActiveN()

bool stIsAlarmActiveN ( unsigned alarm )

Determines if the specified alarm is active.

Parameters

[in] alarm alarm channel number (0..ST_LLD_NUM_ALARMS-1)

Returns: The alarm status.

Return values

false	if the alarm is not active.
true	is the alarm is active

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 304 of file hal_st.c.

References osalDbgCheck, and ST_LLD_NUM_ALARMS.

Referenced by stGetAlarmN(), stSetAlarmN(), and stStartAlarmN().

◆ st_lld_init()

void st_lld_init ( void )

Low level ST driver initialization.

Function Class:: Not an API, this function is for internal use only.

Definition at line 62 of file hal_st_lld.c.

Referenced by stInit().

◆ st_lld_get_counter()

systime_t st_lld_get_counter ( void )

inlinestatic

Returns the time counter value.

Returns: The counter value.

Function Class:: Not an API, this function is for internal use only.

Definition at line 73 of file hal_st_lld.h.

Referenced by stGetCounter().

◆ st_lld_start_alarm()

void st_lld_start_alarm ( systime_t abstime )

inlinestatic

Starts the alarm.

Note: Makes sure that no spurious alarms are triggered after this call.

Parameters

[in] abstime the time to be set for the first alarm

Function Class:: Not an API, this function is for internal use only.

Definition at line 87 of file hal_st_lld.h.

Referenced by stStartAlarm().

◆ st_lld_stop_alarm()

void st_lld_stop_alarm ( void )

inlinestatic

Stops the alarm interrupt.

Function Class:: Not an API, this function is for internal use only.

Definition at line 97 of file hal_st_lld.h.

Referenced by stStopAlarm().

◆ st_lld_set_alarm()

void st_lld_set_alarm ( systime_t abstime )

inlinestatic

Sets the alarm time.

Parameters

[in] abstime the time to be set for the next alarm

Function Class:: Not an API, this function is for internal use only.

Definition at line 108 of file hal_st_lld.h.

Referenced by stSetAlarm().

◆ st_lld_get_alarm()

systime_t st_lld_get_alarm ( void )

inlinestatic

Returns the current alarm time.

Returns: The currently set alarm time.

Function Class:: Not an API, this function is for internal use only.

Definition at line 120 of file hal_st_lld.h.

Referenced by stGetAlarm().

◆ st_lld_is_alarm_active()

bool st_lld_is_alarm_active ( void )

inlinestatic

Determines if the alarm is active.

Returns: The alarm status.

Return values

false	if the alarm is not active.
true	is the alarm is active

Function Class:: Not an API, this function is for internal use only.

Definition at line 134 of file hal_st_lld.h.

Referenced by stIsAlarmActive().

Variable Documentation

◆ st_callbacks

st_callback_t st_callbacks[ST_LLD_NUM_ALARMS]

Callback pointers for each alarm.

Note: If some alarms have static callbacks defined in the LLD then some of the pointers might be unused (never called through).

Definition at line 51 of file hal_st.c.

Referenced by stInit(), and stSetCallback().

Detailed Description

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ ST_LLD_NUM_ALARMS

Typedef Documentation

◆ st_callback_t

Function Documentation

◆ stInit()

◆ stBind()

◆ stGetCounter()

◆ stStartAlarm()

◆ stStopAlarm()

◆ stSetAlarm()

◆ stGetAlarm()

◆ stIsAlarmActive()

◆ stSetCallback()

◆ stBindAlarmN()

◆ stStartAlarmN()

◆ stStopAlarmN()

◆ stSetAlarmN()

◆ stGetAlarmN()

◆ stIsAlarmActiveN()

◆ st_lld_init()

◆ st_lld_get_counter()

◆ st_lld_start_alarm()

◆ st_lld_stop_alarm()

◆ st_lld_set_alarm()

◆ st_lld_get_alarm()

◆ st_lld_is_alarm_active()

Variable Documentation

◆ st_callbacks