Skip to content

Commit eeb8f8a

Browse files
MarcusJGStreetsathoelke
authored andcommitted
Realised I had forgotten to update filter_length
Signed-off-by: Marcus Streets <[email protected]>
1 parent d56ecd5 commit eeb8f8a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/storage/api/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -765,13 +765,13 @@ These definitions must be defined in the header file :file:`psa/protected_storag
765765
Initialises an iterator that can be used to return a list of uids in the Protected Storage .
766766

767767
.. param:: psa_storage_iterator_t* context
768-
A pointer to a context for this iterator. This is set to a new value on success and is undefined on error. The content of the iterator is implementation defined. The pointer MUST be valid and MUST point to a block of memory of the size given by the ``PSA_STORAGE_ITERATOR_CTX__SIZE`` macro to which the caller has write access.
768+
A pointer to a context for this iterator. The pointer may be NULL. This is set to a new value on success and is undefined on error. The content of the iterator is implementation defined.
769769

770770
.. param:: psa_storage_uid_t filter
771771
A value used to filter the results included in this iteration.
772772

773773
.. param:: int_t filter_length
774-
A length of the filter to use, this must be a value `-63 < filter_lemngth < 63`.
774+
A length of the filter to use, this must be a value `0 < filter_lemngth < 63`.
775775

776776
.. param:: psa_storage_uid_t *result
777777
A pointer to the location in which to store ``uid``. On success the contents of this location will be updated with the first matching ``uid``. On error, the contents are undefined.
@@ -788,7 +788,7 @@ These definitions must be defined in the header file :file:`psa/protected_storag
788788
.. retval:: PSA_ERROR_STORAGE_FAILURE
789789
The operation failed because the physical storage has failed (Fatal error).
790790

791-
The iterator returns those values where the ``filter_length`` bits of the `uid` matches the bits in ``filter``. If the value of ``filter_length`` is positive, it matches left most bits, if it i nagative, it matches the right most bits.
791+
The iterator returns those values where the ``filter_length`` bits of the `uid` matches the left most bits in ``filter``.
792792

793793
The iterator will only returns those ``uid`` that were created by the caller. It MUST not return any ``uid`` created by a different user.
794794

0 commit comments

Comments
 (0)