Retention Register#
Functions#
Reads a 32-bit value from the specified retention register.
Write a 32-bit value to the specified retention register.
Get number of retention registers available for application.
Function Documentation#
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | [in] | index | Retention register number (zero-based). |
| uint32_t * | [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
indexordataand 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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | [in] | index | Retention register number (zero-based). |
| uint32_t | [in] | value | 32-bit value to save in retention register. |
Returns
ZPAL_STATUS_OK on success, ZPAL_STATUS_INVALID_ARGUMENT on invalid
indexand ZPAL_STATUS_FAIL otherwise.
ZAF_retention_register_count#
size_t ZAF_retention_register_count (void )
Get number of retention registers available for application.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
number of retention registers.