Evolution-x/hardware_interfaces
1
0
Fork 0
mirror of https://github.com/Evolution-X/hardware_interfaces synced 2026-02-01 16:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs for Weaver HAL.

Browse Source 
Test: None, only changed docs
Change-Id: Icd0c20986b1ec885a400960f7fad262b7a2e869b
This commit is contained in:
Andrew Scull
2017-04-10 21:17:38 +01:00
parent 7633347563
commit fb3d795cd2
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
weaver/1.0/IWeaver.hal
View File

@@ -16,7 +16,7 @@
package android.hardware.weaver@1.0;
/**
* Weaver provides secure storage of secret values that can only be read if the
* Weaver provides secure storage of secret values that may only be read if the
* corresponding key has been presented.
*
* The storage must be secure as the device's user authentication and encryption
@@ -58,20 +58,21 @@ interface IWeaver {
* The value is only returned if the provided key matches the key stored in
* the slot. The value is never returned if the wrong key is provided.
*
* Throttling is used to limit the frequency of failed read attempts. The
* value is only returned when throttling is not active, even if the correct
* key is provided. If called when throttling is active, the time until the
* next attempt can be made is returned.
* Throttling must be used to limit the frequency of failed read attempts.
* The value is only returned when throttling is not active, even if the
* correct key is provided. If called when throttling is active, the time
* until the next attempt can be made is returned.
*
* @param slotId of the slot to read from.
* @param key that is stored in the slot.
* @return status is OK if the value was successfully read, INCORRECT_KEY if
* the key does not match the key in the slot or THROTTLE if
* throttling is active.
* the key does not match the key in the slot, THROTTLE if
* throttling is active or FAILED if the read was unsuccessful for
* another reason.
* @return readResponse contains the value read and the timeout to wait
* before making the next request. The value is undefined if the
* status is not OK and the timeout is undefined if the status is
* FAILED.
* before making the next request. If the status is OK, value is set
* to the value in the slot and timeout is 0. Otherwise, value is
* empty and timeout is set accordingly.
*/
read(uint32_t slotId, vec<uint8_t> key)
generates (WeaverReadStatus status,