Retention Register

Collaboration diagram for Retention Register:

Functions
zpal_status_t	ZAF_retention_register_read (uint32_t index, uint32_t *data)
	Reads a 32-bit value from the specified retention register.
zpal_status_t	ZAF_retention_register_write (uint32_t index, uint32_t value)
	Write a 32-bit value to the specified retention register.
size_t	ZAF_retention_register_count (void)
	Get number of retention registers available for application.

Detailed Description

Function Documentation

ZAF_retention_register_count()

size_t ZAF_retention_register_count

(

void

)

Get number of retention registers available for application.

Returns

number of retention registers.

ZAF_retention_register_read()

zpal_status_t ZAF_retention_register_read	(	uint32_t	index,
		uint32_t *	data )

Reads a 32-bit value from the specified retention register.

Parameters

[in]	index	Retention register number (zero-based).
[out]	data	Pointer to a 32-bit variable where the value can be stored.

Returns

ZPAL_STATUS_OK on success, ZPAL_STATUS_INVALID_ARGUMENT on invalid index or data and ZPAL_STATUS_FAIL otherwise.

ZAF_retention_register_write()

zpal_status_t ZAF_retention_register_write	(	uint32_t	index,
		uint32_t	value )

Write a 32-bit value to the specified retention register.

Parameters

[in]	index	Retention register number (zero-based).
[in]	value	32-bit value to save in retention register.

Returns

ZPAL_STATUS_OK on success, ZPAL_STATUS_INVALID_ARGUMENT on invalid index and ZPAL_STATUS_FAIL otherwise.