HAL Safety Module. More...

Detailed Description

HAL Safety Module.

Collaboration diagram for Safety Subsystem:

Function variants
#define	halRegSet8X(p, s, v)
	Sets bits into an 8 bits register.
#define	halRegSet16X(p, s, v)
	Sets bits into a 16 bits register.
#define	halRegSet32X(p, s, v)
	Sets bits into a 32 bits register.
#define	halRegClear8X(p, c, v)
	Clears bits into an 8 bits register.
#define	halRegClear16X(p, c, v)
	Clears bits into a 16 bits register.
#define	halRegClear32X(p, c, v)
	Clears bits into a 32 bits register.

Macros
#define	HAL_US2RTC(freq, usec)
#define	HAL_USE_SAFETY FALSE
	Enables the safety-related features in HAL.

Typedefs
typedef unsigned	halcnt_t

Functions
static uint32_t	get_frequency (void)
static halcnt_t	get_counter (void)
static bool	is_counter_within (halcnt_t start, halcnt_t end)
CC_NO_RETURN void	halSftFail (const char *message)
	Common safety fault handler.
bool	halRegWaitMatch8X (volatile uint8_t p, uint8_t mask, uint8_t match, uint32_t tmo, uint8_t valp)
	Waits for masked bits to match or a timeout.
bool	halRegWaitMatch16X (volatile uint16_t p, uint16_t mask, uint16_t match, uint32_t tmo, uint16_t valp)
	Waits for masked bits to match or a timeout.
bool	halRegWaitMatch32X (volatile uint32_t p, uint32_t mask, uint32_t match, uint32_t tmo, uint32_t valp)
	Waits for masked bits to match or a timeout.
bool	halRegWaitAllSet8X (volatile uint8_t p, uint8_t mask, uint32_t tmo, uint8_t valp)
	Waits for all specified bits to be set or a timeout.
bool	halRegWaitAllSet16X (volatile uint16_t p, uint16_t mask, uint32_t tmo, uint16_t valp)
	Waits for all specified bits to be set or a timeout.
bool	halRegWaitAllSet32X (volatile uint32_t p, uint32_t mask, uint32_t tmo, uint32_t valp)
	Waits for all specified bits to be set or a timeout.
bool	halRegWaitAnySet8X (volatile uint8_t p, uint8_t mask, uint32_t tmo, uint8_t valp)
	Waits for any of specified bits to be set or a timeout.
bool	halRegWaitAnySet16X (volatile uint16_t p, uint16_t mask, uint32_t tmo, uint16_t valp)
	Waits for any of specified bits to be set or a timeout.
bool	halRegWaitAnySet32X (volatile uint32_t p, uint32_t mask, uint32_t tmo, uint32_t valp)
	Waits for any of specified bits to be set or a timeout.
bool	halRegWaitAllClear8X (volatile uint8_t p, uint8_t mask, uint32_t tmo, uint8_t valp)
	Waits for all specified bits to be cleared or a timeout.
bool	halRegWaitAllClear16X (volatile uint16_t p, uint16_t mask, uint32_t tmo, uint16_t valp)
	Waits for all specified bits to be cleared or a timeout.
bool	halRegWaitAllClear32X (volatile uint32_t p, uint32_t mask, uint32_t tmo, uint32_t valp)
	Waits for all specified bits to be cleared or a timeout.
bool	halRegWaitAnyClear8X (volatile uint8_t p, uint8_t mask, uint32_t tmo, uint8_t valp)
	Waits for any of specified bits to be cleared or a timeout.
bool	halRegWaitAnyClear16X (volatile uint16_t p, uint16_t mask, uint32_t tmo, uint16_t valp)
	Waits for any of specified bits to be cleared or a timeout.
bool	halRegWaitAnyClear32X (volatile uint32_t p, uint32_t mask, uint32_t tmo, uint32_t valp)
	Waits for any of specified bits to be cleared or a timeout.
static void	halSftFailOnError (bool result, const char *message)
	Enters a common safety fault handler on error.
static void	halRegWrite8X (volatile uint8_t *p, uint8_t value, bool verify)
	Writes an 8 bits register.
static void	halRegWrite16X (volatile uint16_t *p, uint16_t value, bool verify)
	Writes a 16 bits register.
static void	halRegWrite32X (volatile uint32_t *p, uint32_t value, bool verify)
	Writes a 32 bits register.
static void	halRegModify8X (volatile uint8_t *p, uint8_t setmask, uint8_t clrmask, bool verify)
	Modifies a 8 bits register.
static void	halRegModify16X (volatile uint16_t *p, uint16_t setmask, uint16_t clrmask, bool verify)
	Modifies a 16 bits register.
static void	halRegModify32X (volatile uint32_t *p, uint32_t setmask, uint32_t clrmask, bool verify)
	Modifies a 32 bits register.
static void	halRegMaskedWrite8X (volatile uint8_t *p, uint8_t mask, uint8_t value, bool verify)
	Writes a field into an 8 bits register.
static void	halRegMaskedWrite16X (volatile uint16_t *p, uint16_t mask, uint16_t value, bool verify)
	Writes a field into a 16 bits register.
static void	halRegMaskedWrite32X (volatile uint32_t *p, uint32_t mask, uint32_t value, bool verify)
	Writes a field into a 32 bits register.

Macro Definition Documentation

◆ HAL_US2RTC

#define HAL_US2RTC	(		freq,
			usec )

Value:

(halcnt_t)((((freq) + 999999UL) / 1000000UL) * (usec))

halcnt_t

unsigned halcnt_t

Definition hal_safety.c:47

Definition at line 31 of file hal_safety.c.

Referenced by halRegWaitAllClear16X(), halRegWaitAllClear32X(), halRegWaitAllClear8X(), halRegWaitAllSet16X(), halRegWaitAllSet32X(), halRegWaitAllSet8X(), halRegWaitAnyClear16X(), halRegWaitAnyClear32X(), halRegWaitAnyClear8X(), halRegWaitAnySet16X(), halRegWaitAnySet32X(), halRegWaitAnySet8X(), halRegWaitMatch16X(), halRegWaitMatch32X(), and halRegWaitMatch8X().

◆ HAL_USE_SAFETY

#define HAL_USE_SAFETY FALSE

Enables the safety-related features in HAL.

Note: Disabling this option saves both code and data space.

Definition at line 41 of file hal_safety.h.

◆ halRegSet8X

#define halRegSet8X	(	p,
		s,
		v )

Value:

halRegModify8X(p, s, (uint8_t)0, v)

halRegModify8X

static void halRegModify8X(volatile uint8_t *p, uint8_t setmask, uint8_t clrmask, bool verify)

Modifies a 8 bits register.

Definition hal_safety.h:341

Sets bits into an 8 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	s	mask of bits to be set
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 74 of file hal_safety.h.

◆ halRegSet16X

#define halRegSet16X	(	p,
		s,
		v )

Value:

halRegModify16X(p, s, (uint16_t)0, v)

halRegModify16X

static void halRegModify16X(volatile uint16_t *p, uint16_t setmask, uint16_t clrmask, bool verify)

Modifies a 16 bits register.

Definition hal_safety.h:381

Sets bits into a 16 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	s	mask of bits to be set
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 90 of file hal_safety.h.

◆ halRegSet32X

#define halRegSet32X	(	p,
		s,
		v )

Value:

halRegModify32X(p, s, (uint32_t)0, v)

halRegModify32X

static void halRegModify32X(volatile uint32_t *p, uint32_t setmask, uint32_t clrmask, bool verify)

Modifies a 32 bits register.

Definition hal_safety.h:421

Sets bits into a 32 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	s	mask of bits to be set
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 106 of file hal_safety.h.

◆ halRegClear8X

#define halRegClear8X	(	p,
		c,
		v )

Value:

halRegModify8X(p, (uint8_t)0, c, v)

Clears bits into an 8 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	c	mask of bits to be cleared
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 122 of file hal_safety.h.

◆ halRegClear16X

#define halRegClear16X	(	p,
		c,
		v )

Value:

halRegModify16X(p, (uint16_t)0, c, v)

Clears bits into a 16 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	c	mask of bits to be cleared
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 138 of file hal_safety.h.

◆ halRegClear32X

#define halRegClear32X	(	p,
		c,
		v )

Value:

halRegModify32X(p, (uint32_t)0, c, v)

Clears bits into a 32 bits register.

Note: There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	c	mask of bits to be cleared
[in]	v	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 154 of file hal_safety.h.

Typedef Documentation

◆ halcnt_t

typedef unsigned halcnt_t

Definition at line 47 of file hal_safety.c.

Function Documentation

◆ get_frequency()

uint32_t get_frequency ( void )

inlinestatic

Definition at line 50 of file hal_safety.c.

Referenced by halRegWaitAllClear16X(), halRegWaitAllClear32X(), halRegWaitAllClear8X(), halRegWaitAllSet16X(), halRegWaitAllSet32X(), halRegWaitAllSet8X(), halRegWaitAnyClear16X(), halRegWaitAnyClear32X(), halRegWaitAnyClear8X(), halRegWaitAnySet16X(), halRegWaitAnySet32X(), halRegWaitAnySet8X(), halRegWaitMatch16X(), halRegWaitMatch32X(), and halRegWaitMatch8X().

◆ get_counter()

halcnt_t get_counter ( void )

inlinestatic

Definition at line 59 of file hal_safety.c.

Referenced by halRegWaitAllClear16X(), halRegWaitAllClear32X(), halRegWaitAllClear8X(), halRegWaitAllSet16X(), halRegWaitAllSet32X(), halRegWaitAllSet8X(), halRegWaitAnyClear16X(), halRegWaitAnyClear32X(), halRegWaitAnyClear8X(), halRegWaitAnySet16X(), halRegWaitAnySet32X(), halRegWaitAnySet8X(), halRegWaitMatch16X(), halRegWaitMatch32X(), halRegWaitMatch8X(), and is_counter_within().

◆ is_counter_within()

bool is_counter_within	(	halcnt_t	start,
		halcnt_t	end )

inlinestatic

Definition at line 68 of file hal_safety.c.

References get_counter().

Referenced by halRegWaitAllClear16X(), halRegWaitAllClear32X(), halRegWaitAllClear8X(), halRegWaitAllSet16X(), halRegWaitAllSet32X(), halRegWaitAllSet8X(), halRegWaitAnyClear16X(), halRegWaitAnyClear32X(), halRegWaitAnyClear8X(), halRegWaitAnySet16X(), halRegWaitAnySet32X(), halRegWaitAnySet8X(), halRegWaitMatch16X(), halRegWaitMatch32X(), and halRegWaitMatch8X().

Here is the call graph for this function:

◆ halSftFail()

void halSftFail ( const char * message )

Common safety fault handler.

This function does not return, any recovery strategy, at this level, is meant to be destructive.

Parameters

[in] message fault reason string

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

Definition at line 89 of file hal_safety.c.

References osalSysHalt().

Referenced by halRegMaskedWrite16X(), halRegMaskedWrite32X(), halRegMaskedWrite8X(), halRegModify16X(), halRegModify32X(), halRegModify8X(), halRegWrite16X(), halRegWrite32X(), halRegWrite8X(), and halSftFailOnError().

Here is the call graph for this function:

◆ halRegWaitMatch8X()

bool halRegWaitMatch8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint8_t	match,
		uint32_t	tmo,
		uint8_t *	valp )

Waits for masked bits to match or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	match	value to be matched
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 116 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitMatch16X()

bool halRegWaitMatch16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint16_t	match,
		uint32_t	tmo,
		uint16_t *	valp )

Waits for masked bits to match or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	match	value to be matched
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 159 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitMatch32X()

bool halRegWaitMatch32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	match,
		uint32_t	tmo,
		uint32_t *	valp )

Waits for masked bits to match or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	match	value to be matched
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 202 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllSet8X()

bool halRegWaitAllSet8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint32_t	tmo,
		uint8_t *	valp )

Waits for all specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 244 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllSet16X()

bool halRegWaitAllSet16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint32_t	tmo,
		uint16_t *	valp )

Waits for all specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 286 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllSet32X()

bool halRegWaitAllSet32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	tmo,
		uint32_t *	valp )

Waits for all specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 328 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnySet8X()

bool halRegWaitAnySet8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint32_t	tmo,
		uint8_t *	valp )

Waits for any of specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 370 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnySet16X()

bool halRegWaitAnySet16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint32_t	tmo,
		uint16_t *	valp )

Waits for any of specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 412 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnySet32X()

bool halRegWaitAnySet32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	tmo,
		uint32_t *	valp )

Waits for any of specified bits to be set or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 454 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllClear8X()

bool halRegWaitAllClear8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint32_t	tmo,
		uint8_t *	valp )

Waits for all specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 496 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllClear16X()

bool halRegWaitAllClear16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint32_t	tmo,
		uint16_t *	valp )

Waits for all specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 538 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAllClear32X()

bool halRegWaitAllClear32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	tmo,
		uint32_t *	valp )

Waits for all specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 580 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnyClear8X()

bool halRegWaitAnyClear8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint32_t	tmo,
		uint8_t *	valp )

Waits for any of specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 622 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnyClear16X()

bool halRegWaitAnyClear16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint32_t	tmo,
		uint16_t *	valp )

Waits for any of specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 664 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halRegWaitAnyClear32X()

bool halRegWaitAnyClear32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	tmo,
		uint32_t *	valp )

Waits for any of specified bits to be cleared or a timeout.

Note: The timeout feature only works if the HAL LLD implements the required counter functionality.

Parameters

[in]	p	address of the register
[in]	mask	mask of bits to be checked
[in]	tmo	timeout in microseconds
[in]	valp	pointer to where to store the last read value or `NULL`

Returns: The final result.

Return values

false	if the condition has been verified.
true	if a timeout occurred.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 706 of file hal_safety.c.

References get_counter(), get_frequency(), HAL_US2RTC, and is_counter_within().

Here is the call graph for this function:

◆ halSftFailOnError()

void halSftFailOnError	(	bool	result,
		const char *	message )

inlinestatic

Enters a common safety fault handler on error.

Note: IF a custom handler is not defined then the default action is to call osalSysHalt().; This function can potentially not return.

Parameters

[in]	result	the error status, `true` if an error occurred
[in]	message	an optional descriptive message

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

Definition at line 214 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegWrite8X()

void halRegWrite8X	(	volatile uint8_t *	p,
		uint8_t	value,
		bool	verify )

inlinestatic

Writes an 8 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	value	value to be written
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 238 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegWrite16X()

void halRegWrite16X	(	volatile uint16_t *	p,
		uint16_t	value,
		bool	verify )

inlinestatic

Writes a 16 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	value	value to be written
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 272 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegWrite32X()

void halRegWrite32X	(	volatile uint32_t *	p,
		uint32_t	value,
		bool	verify )

inlinestatic

Writes a 32 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	value	value to be written
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 306 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegModify8X()

void halRegModify8X	(	volatile uint8_t *	p,
		uint8_t	setmask,
		uint8_t	clrmask,
		bool	verify )

inlinestatic

Modifies a 8 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	setmask	mask of bits to be set
[in]	clrmask	mask of bits to be cleared
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 341 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegModify16X()

void halRegModify16X	(	volatile uint16_t *	p,
		uint16_t	setmask,
		uint16_t	clrmask,
		bool	verify )

inlinestatic

Modifies a 16 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	setmask	mask of bits to be set
[in]	clrmask	mask of bits to be cleared
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 381 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegModify32X()

void halRegModify32X	(	volatile uint32_t *	p,
		uint32_t	setmask,
		uint32_t	clrmask,
		bool	verify )

inlinestatic

Modifies a 32 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	setmask	mask of bits to be set
[in]	clrmask	mask of bits to be cleared
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 421 of file hal_safety.h.

References halSftFail().

Here is the call graph for this function:

◆ halRegMaskedWrite8X()

void halRegMaskedWrite8X	(	volatile uint8_t *	p,
		uint8_t	mask,
		uint8_t	value,
		bool	verify )

inlinestatic

Writes a field into an 8 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	mask	mask of bits field to be written
[in]	value	value to be written, must be pre-shifted to match the mask
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 462 of file hal_safety.h.

References halSftFail(), and osalDbgCheck.

Here is the call graph for this function:

◆ halRegMaskedWrite16X()

void halRegMaskedWrite16X	(	volatile uint16_t *	p,
		uint16_t	mask,
		uint16_t	value,
		bool	verify )

inlinestatic

Writes a field into a 16 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	mask	mask of bits field to be written
[in]	value	value to be written, must be pre-shifted to match the mask
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 507 of file hal_safety.h.

References halSftFail(), and osalDbgCheck.

Here is the call graph for this function:

◆ halRegMaskedWrite32X()

void halRegMaskedWrite32X	(	volatile uint32_t *	p,
		uint32_t	mask,
		uint32_t	value,
		bool	verify )

inlinestatic

Writes a field into a 32 bits register.

Note: This code relies on compiler optimizations, the constant operations that cause no change to the final value are optimized out.; There is a strong assumption for memory-mapped I/O, this is not necessarily true on all architectures.; Verification failure results in entering the fault handler.

Parameters

[in]	p	pointer to the register
[in]	mask	mask of bits field to be written
[in]	value	value to be written, must be pre-shifted to match the mask
[in]	verify	verification flag, register is read back if `true`, this flag only has effect if `HAL_USE_SAFETY` is set to `TRUE`

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 552 of file hal_safety.h.

References halSftFail(), and osalDbgCheck.

Here is the call graph for this function:

Detailed Description

Function variants

Macros

Typedefs

Functions

Macro Definition Documentation

◆ HAL_US2RTC

◆ HAL_USE_SAFETY

◆ halRegSet8X

◆ halRegSet16X

◆ halRegSet32X

◆ halRegClear8X

◆ halRegClear16X

◆ halRegClear32X

Typedef Documentation

◆ halcnt_t

Function Documentation

◆ get_frequency()

◆ get_counter()

◆ is_counter_within()

◆ halSftFail()

◆ halRegWaitMatch8X()

◆ halRegWaitMatch16X()

◆ halRegWaitMatch32X()

◆ halRegWaitAllSet8X()

◆ halRegWaitAllSet16X()

◆ halRegWaitAllSet32X()

◆ halRegWaitAnySet8X()

◆ halRegWaitAnySet16X()

◆ halRegWaitAnySet32X()

◆ halRegWaitAllClear8X()

◆ halRegWaitAllClear16X()

◆ halRegWaitAllClear32X()

◆ halRegWaitAnyClear8X()

◆ halRegWaitAnyClear16X()

◆ halRegWaitAnyClear32X()

◆ halSftFailOnError()

◆ halRegWrite8X()

◆ halRegWrite16X()

◆ halRegWrite32X()

◆ halRegModify8X()

◆ halRegModify16X()

◆ halRegModify32X()

◆ halRegMaskedWrite8X()

◆ halRegMaskedWrite16X()

◆ halRegMaskedWrite32X()