diff options
| author | Andres Morales <anmorales@google.com> | 2015-05-14 13:08:15 -0700 |
|---|---|---|
| committer | Andres Morales <anmorales@google.com> | 2015-05-14 13:08:15 -0700 |
| commit | cca930dd7c2516bf0a1bd5aa615510f1da30fe47 (patch) | |
| tree | 2f64f00858c5fcf3cc5763983f3e6b0cc218b024 /include | |
| parent | f0254aa0a0bcdcf54084efb91a324b386006d575 (diff) | |
| download | hardware_libhardware-cca930dd7c2516bf0a1bd5aa615510f1da30fe47.zip hardware_libhardware-cca930dd7c2516bf0a1bd5aa615510f1da30fe47.tar.gz hardware_libhardware-cca930dd7c2516bf0a1bd5aa615510f1da30fe47.tar.bz2 | |
[gatekeeper] document timeout requirements
GateKeeper may throttle the user, document the return
value of calls in this case.
No code changes.
Bug:21118563
Change-Id: Idd6c392d01c22627f828d86dd219a4a1d6e81439
Diffstat (limited to 'include')
| -rw-r--r-- | include/hardware/gatekeeper.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/include/hardware/gatekeeper.h b/include/hardware/gatekeeper.h index 89d96b1..ebe79b8 100644 --- a/include/hardware/gatekeeper.h +++ b/include/hardware/gatekeeper.h @@ -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, @@ -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, |