Skip to content

Commit 03a3496

Browse files
tomi-fonthenrikbrixandersen
authored andcommitted
secure_storage: its: small language improvements to function comments
Minor tweaks for clarity. Signed-off-by: Tomi Fontanilles <[email protected]>
1 parent d38fb88 commit 03a3496

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

subsys/secure_storage/include/psa/internal_trusted_storage.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
* @retval PSA_ERROR_NOT_PERMITTED An entry associated with the provided `uid` already
3939
* exists and was created with `PSA_STORAGE_FLAG_WRITE_ONCE`.
4040
* @retval PSA_ERROR_NOT_SUPPORTED One or more of the flags provided in `create_flags`
41-
* are not supported or invalid.
41+
* are not supported or not valid.
4242
* @retval PSA_ERROR_INVALID_ARGUMENT One or more arguments other than `create_flags` are
4343
* invalid.
4444
* @retval PSA_ERROR_INSUFFICIENT_STORAGE There is insufficient space on the storage medium.
@@ -65,8 +65,8 @@ psa_status_t psa_its_set(psa_storage_uid_t uid, size_t data_length,
6565
*
6666
* @retval PSA_SUCCESS The operation completed successfully.
6767
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
68-
* @retval PSA_ERROR_INVALID_ARGUMENT One or more of the arguments are invalid. This can also
69-
* happen if `data_offset` is larger than the size of the data
68+
* @retval PSA_ERROR_INVALID_ARGUMENT One or more arguments are invalid. This can also happen
69+
* if `data_offset` is larger than the size of the data
7070
* associated with `uid`.
7171
* @retval PSA_ERROR_DOES_NOT_EXIST The provided `uid` was not found in the storage.
7272
* @retval PSA_ERROR_STORAGE_FAILURE The physical storage has failed (fatal error).
@@ -90,7 +90,7 @@ psa_status_t psa_its_get(psa_storage_uid_t uid, size_t data_offset,
9090
*
9191
* @retval PSA_SUCCESS The operation completed successfully.
9292
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
93-
* @retval PSA_ERROR_INVALID_ARGUMENT One or more of the arguments are invalid.
93+
* @retval PSA_ERROR_INVALID_ARGUMENT `uid` is invalid.
9494
* @retval PSA_ERROR_DOES_NOT_EXIST The provided `uid` was not found in the storage.
9595
* @retval PSA_ERROR_STORAGE_FAILURE The physical storage has failed (fatal error).
9696
*/

subsys/secure_storage/include/psa/protected_storage.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* @retval PSA_ERROR_NOT_PERMITTED An entry associated with the provided `uid` already
3737
* exists and was created with `PSA_STORAGE_FLAG_WRITE_ONCE`.
3838
* @retval PSA_ERROR_NOT_SUPPORTED One or more of the flags provided in `create_flags`
39-
* are not supported or invalid.
39+
* are not supported or not valid.
4040
* @retval PSA_ERROR_INVALID_ARGUMENT One or more arguments other than `create_flags` are
4141
* invalid.
4242
* @retval PSA_ERROR_INSUFFICIENT_STORAGE There is insufficient space on the storage medium.
@@ -67,8 +67,8 @@ psa_status_t psa_ps_set(psa_storage_uid_t uid, size_t data_length,
6767
*
6868
* @retval PSA_SUCCESS The operation completed successfully.
6969
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
70-
* @retval PSA_ERROR_INVALID_ARGUMENT One or more of the arguments are invalid. This can also
71-
* happen if `data_offset` is larger than the size of the data
70+
* @retval PSA_ERROR_INVALID_ARGUMENT One or more arguments are invalid. This can also happen
71+
* if `data_offset` is larger than the size of the data
7272
* associated with `uid`.
7373
* @retval PSA_ERROR_DOES_NOT_EXIST The provided `uid` was not found in the storage.
7474
* @retval PSA_ERROR_STORAGE_FAILURE The physical storage has failed (fatal error).
@@ -98,7 +98,7 @@ psa_status_t psa_ps_get(psa_storage_uid_t uid, size_t data_offset,
9898
*
9999
* @retval PSA_SUCCESS The operation completed successfully.
100100
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
101-
* @retval PSA_ERROR_INVALID_ARGUMENT One or more of the arguments are invalid.
101+
* @retval PSA_ERROR_INVALID_ARGUMENT `uid` is invalid.
102102
* @retval PSA_ERROR_DOES_NOT_EXIST The provided `uid` was not found in the storage.
103103
* @retval PSA_ERROR_STORAGE_FAILURE The physical storage has failed (fatal error).
104104
* @retval PSA_ERROR_INVALID_SIGNATURE The data associated with `uid` failed authentication.
@@ -159,8 +159,8 @@ psa_status_t psa_ps_remove(psa_storage_uid_t uid)
159159
* @retval PSA_SUCCESS The operation completed successfully.
160160
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
161161
* @retval PSA_ERROR_NOT_SUPPORTED The implementation doesn't support this function or one
162-
* or more of the flags provided in `create_flags` are not
163-
* supported or invalid.
162+
* or more of the flags provided in `create_flags`
163+
* are not supported or not valid.
164164
* @retval PSA_ERROR_INVALID_ARGUMENT `uid` is invalid.
165165
* @retval PSA_ERROR_ALREADY_EXISTS An entry with the provided `uid` already exists.
166166
* @retval PSA_ERROR_INSUFFICIENT_STORAGE There is insufficient space on the storage medium.
@@ -198,7 +198,7 @@ psa_status_t psa_ps_create(psa_storage_uid_t uid, size_t capacity,
198198
* @retval PSA_ERROR_GENERIC_ERROR An unspecified internal failure happened.
199199
* @retval PSA_ERROR_NOT_PERMITTED The entry was created with `PSA_STORAGE_FLAG_WRITE_ONCE`.
200200
* @retval PSA_ERROR_NOT_SUPPORTED The implementation doesn't support this function.
201-
* @retval PSA_ERROR_INVALID_ARGUMENT One or more of the arguments are invalid.
201+
* @retval PSA_ERROR_INVALID_ARGUMENT One or more arguments are invalid.
202202
* @retval PSA_ERROR_DOES_NOT_EXIST The provided `uid` was not found in the storage.
203203
* @retval PSA_ERROR_STORAGE_FAILURE The physical storage has failed (fatal error).
204204
* @retval PSA_ERROR_INVALID_SIGNATURE The data associated with `uid` failed authentication.

0 commit comments

Comments
 (0)