Token Manager#
Routines for working with tokens.
Introduction#
The token system stores such non-volatile information as the manufacturing ID, channel number, transmit power, and various pieces of information that the application needs to be persistent between device power cycles. The token system is design to abstract implementation details and simplify interacting with differing non-volatile systems. The majority of tokens are stored in NVM3 where they can be rewritten. Manufacturing tokens are stored in dedicated regions of flash and are not designed to be rewritten.
By default the Token Manager pulls in the NVM3 component for storage. The "Token Manager using NVM3" still requires the "Token Manager" component.
Functions#
Initialize the Token Manager.
Read the data stored in the specified data or manufacturing token.
Writes the data to the specified token.
Increments the value of a counter token.
Read the data associated with the specified manufacturing token.
Writes data to a manufacturing token.
Function Documentation#
sl_token_init#
Ecode_t sl_token_init (void )
Initialize the Token Manager.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Note
This function must be called before any other sl_token functions. If it does not return success, the other sl_token functions will not work.
Returns
0 if successful. Error code otherwise.
sl_token_get_data#
Ecode_t sl_token_get_data (uint32_t token, uint32_t index, void * data, uint32_t length)
Read the data stored in the specified data or manufacturing token.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | token | The NVM3KEY for the token. |
| uint32_t | N/A | index | The index to access in the indexed token. |
| void * | N/A | data | A pointer to where the token data should be placed. |
| uint32_t | N/A | length | The size of the token data in number of bytes. |
Returns
0 if successful. Error code otherwise.
sl_token_set_data#
Ecode_t sl_token_set_data (uint32_t token, uint32_t index, void * data, uint32_t length)
Writes the data to the specified token.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | token | The NVM3KEY for the token. |
| uint32_t | N/A | index | The index to access in the indexed token. |
| void * | N/A | data | A pointer to the data being written. |
| uint32_t | N/A | length | The size of the token data in number of bytes. |
Returns
0 if successful. Error code otherwise.
sl_token_increment_counter#
Ecode_t sl_token_increment_counter (uint32_t token)
Increments the value of a counter token.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | token | The NVM3KEY for the token. |
This call does not support manufacturing tokens.
Returns
0 if successful. Error code otherwise.
sl_token_get_manufacturing_data#
Ecode_t sl_token_get_manufacturing_data (uint32_t token, uint32_t index, void * data, uint32_t length)
Read the data associated with the specified manufacturing token.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | token | The NVM3KEY for the token. |
| uint32_t | N/A | index | The index to access in the indexed token. |
| void * | N/A | data | A pointer to where the token data should be placed. |
| uint32_t | N/A | length | The size of the token data in number of bytes. |
Returns
0 if successful. Error code otherwise.
sl_token_set_manufacturing_data#
Ecode_t sl_token_set_manufacturing_data (uint32_t token, void * data, uint32_t length)
Writes data to a manufacturing token.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | token | The NVM3KEY for the token. |
| void * | N/A | data | A pointer to the data being written. |
| uint32_t | N/A | length | The size of the token data in number of bytes. |
Note
Only manufacturing token values that have not been written since the last erase can be written. For areas of flash that cannot be erased by user code, those manufacturing tokens are effectively write-once.
Returns
0 if successful. Error code otherwise.