The PSA Internal Trusted Storage (ITS) API.
More...
Go to the source code of this file.
The PSA Internal Trusted Storage (ITS) API.
For more information on the ITS, see The Internal Trusted Storage API.
◆ PSA_ITS_API_VERSION_MAJOR
#define PSA_ITS_API_VERSION_MAJOR 1 |
◆ PSA_ITS_API_VERSION_MINOR
#define PSA_ITS_API_VERSION_MINOR 0 |
◆ psa_its_get()
Retrieves data associated with the provided uid
.
- Parameters
-
[in] | uid | The identifier of the data. |
[in] | data_offset | The offset, in bytes, from which to start reading the data. |
[in] | data_size | The number of bytes to read. |
[out] | p_data | The buffer where the data will be placed on success. Must be at least data_size bytes long. |
[out] | p_data_length | On success, the number of bytes placed in p_data . |
- Return values
-
PSA_SUCCESS | The operation completed successfully. |
PSA_ERROR_INVALID_ARGUMENT | One or more of the arguments are invalid. This can also happen if data_offset is larger than the size of the data associated with uid . |
PSA_ERROR_DOES_NOT_EXIST | The provided uid was not found in the storage. |
PSA_ERROR_STORAGE_FAILURE | The physical storage has failed (fatal error). |
◆ psa_its_get_info()
Retrieves the metadata of a given entry.
- Parameters
-
[in] | uid | The identifier of the entry. |
[out] | p_info | A pointer to a psa_storage_info_t struct that will be populated with the metadata on success. |
- Return values
-
PSA_SUCCESS | The operation completed successfully. |
PSA_ERROR_INVALID_ARGUMENT | One or more of the arguments are invalid. |
PSA_ERROR_DOES_NOT_EXIST | The provided uid was not found in the storage. |
PSA_ERROR_STORAGE_FAILURE | The physical storage has failed (fatal error). |
◆ psa_its_remove()
Removes the provided uid
and its associated data.
Deletes all the data associated with the entry from internal storage.
- Parameters
-
uid | The identifier of the entry to remove. |
- Return values
-
PSA_SUCCESS | The operation completed successfully. |
PSA_ERROR_NOT_PERMITTED | The entry was created with PSA_STORAGE_FLAG_WRITE_ONCE . |
PSA_ERROR_INVALID_ARGUMENT | uid is invalid. |
PSA_ERROR_DOES_NOT_EXIST | The provided uid was not found in the storage. |
PSA_ERROR_STORAGE_FAILURE | The physical storage has failed (fatal error). |
◆ psa_its_set()
Creates a new or modifies an existing entry.
Stores data in the internal storage.
- Parameters
-
uid | The identifier of the data. Must be nonzero. |
data_length | The size in bytes of the data in p_data to store. |
p_data | A buffer containing the data to store. |
create_flags | Flags indicating the properties of the entry. |
- Return values
-
PSA_SUCCESS | The operation completed successfully. |
PSA_ERROR_NOT_PERMITTED | An entry associated with the provided uid already exists and was created with PSA_STORAGE_FLAG_WRITE_ONCE . |
PSA_ERROR_NOT_SUPPORTED | One or more of the flags provided in create_flags are not supported or invalid. |
PSA_ERROR_INVALID_ARGUMENT | One or more arguments other than create_flags are invalid. |
PSA_ERROR_INSUFFICIENT_STORAGE | There is insufficient space on the storage medium. |
PSA_ERROR_STORAGE_FAILURE | The physical storage has failed (fatal error). |