Skip to content
This repository has been archived by the owner on Nov 8, 2023. It is now read-only.

Commit

Permalink
[gatekeeper] document timeout requirements
Browse files Browse the repository at this point in the history
GateKeeper may throttle the user, document the return
value of calls in this case.

No code changes.

Bug:21118563
Change-Id: Idd6c392d01c22627f828d86dd219a4a1d6e81439
  • Loading branch information
Andres Morales committed May 19, 2015
1 parent ee50eb6 commit 624ae04
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions include/hardware/gatekeeper.h
Expand Up @@ -80,7 +80,12 @@ struct gatekeeper_device {
* - enrolled_password_handle_length: pointer to the length in bytes of the buffer allocated
* by this function and pointed to by *enrolled_password_handle_length.
*
* Returns: 0 on success or an error code less than 0 on error.
* Returns:
* - 0 on success
* - An error code < 0 on failure, or
* - A timeout value T > 0 if the call should not be re-attempted until T milliseconds
* have elapsed.
*
* On error, enrolled_password_handle will not be allocated.
*/
int (*enroll)(const struct gatekeeper_device *dev, uint32_t uid,
Expand Down Expand Up @@ -123,7 +128,11 @@ struct gatekeeper_device {
* - auth_token_length: on success, the length in bytes of the authentication
* token assigned to *auth_token will be assigned to *auth_token_length
*
* Returns: 0 on success or an error code less than 0 on error
* Returns:
* - 0 on success
* - An error code < 0 on failure, or
* - A timeout value T > 0 if the call should not be re-attempted until T milliseconds
* have elapsed.
* On error, auth token will not be allocated
*/
int (*verify)(const struct gatekeeper_device *dev, uint32_t uid, uint64_t challenge,
Expand Down

0 comments on commit 624ae04

Please sign in to comment.