Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ea8115d8 authored by Ilya Matyukhin's avatar Ilya Matyukhin
Browse files

IFingerprint: update comments 

Bug: 166824758
Test: N/A
Change-Id: Ie77034b88bea1c1317e8d057f19f57167d48d2c3
parent 8e869891

biometrics/fingerprint/aidl/android/hardware/biometrics/fingerprint/IFingerprint.aidl

+10 −10
Original line number Diff line number Diff line
@@ -25,31 +25,31 @@ interface IFingerprint { 
    /**

     * getSensorProps:

     *

     * @return A list of properties for all sensors that an instance of the HAL supports.

     * @return A list of properties for all of the fingerprint sensors supported by the HAL.

     */

    SensorProps[] getSensorProps();



    /**

     * createSession:

     *

     * Creates a instance of ISession which can be used by the framework to perform operations

     * such as ISession#enroll, ISession#authenticate, etc. for the given sensorId and userId.

     * Creates an instance of ISession that can be used by the framework to perform operations such

     * as ISession#enroll, ISession#authenticate, etc. for the given sensorId and userId.

     *

     * Calling this method while there is an active session is considered an error. If the framework

     * wants to create a new session when it already has an active session, it must first cancel the

     * current operation if it's cancellable, or wait until it completes. Then, the framework must

     * current operation if it's cancellable or wait until it completes. Then, the framework must

     * explicitly close the session with ISession#close. Once the framework receives

     * ISessionCallback#onSessionClosed, a new session can be created.

     *

     * Implementations must store user-specific state or metadata in /data/vendor_de/<user>/fpdata

     * as specified by the SeLinux policy. This directory is created/removed by vold (see

     * as specified by the SELinux policy. The directory /data/vendor_de is managed by vold (see

     * vold_prepare_subdirs.cpp). Implementations may store additional user-specific data, such as

     * embeddings or templates in StrongBox.

     * embeddings or templates, in StrongBox.

     *

     * @param sensorId The sensor with which this session is being created.

     * @param userId The userId with which this session is being created.

     * @param cb Used to notify the framework.

     * @return A new session

     * @param sensorId The sensorId for which this session is being created.

     * @param userId The userId for which this session is being created.

     * @param cb A callback to notify the framework about the session's events.

     * @return A new session.

     */

    ISession createSession(in int sensorId, in int userId, in ISessionCallback cb);

}

biometrics/fingerprint/aidl/android/hardware/biometrics/fingerprint/ISession.aidl

+138 −88

File changed.

Preview size limit exceeded, changes collapsed.

biometrics/fingerprint/aidl/android/hardware/biometrics/fingerprint/ISessionCallback.aidl

+14 −14
Original line number Diff line number Diff line
@@ -34,12 +34,12 @@ interface ISessionCallback { 


    /**

     * This method must only be used to notify the framework during the following operations:

     *   1) ISession#enroll

     *   2) ISession#authenticate

     *   3) ISession#detectInteraction

     *   - ISession#enroll

     *   - ISession#authenticate

     *   - ISession#detectInteraction

     *

     * These messages may be used to provide user guidance multiple times if necessary per

     * operation.

     * These messages may be used to provide user guidance multiple times per operation if

     * necessary.

     *

     * @param info See the AcquiredInfo enum.

     * @param vendorCode Only valid if info == AcquiredInfo::VENDOR. The vendorCode must be used to
@@ -51,18 +51,18 @@ interface ISessionCallback { 


    /**

     * This method must only be used to notify the framework during the following operations:

     *   1) ISession#enroll

     *   2) ISession#authenticate

     *   3) ISession#detectInteraction

     *   4) ISession#invalidateAuthenticatorId

     *   5) ISession#resetLockout

     *   - ISession#enroll

     *   - ISession#authenticate

     *   - ISession#detectInteraction

     *   - ISession#invalidateAuthenticatorId

     *   - ISession#resetLockout

     *

     * These messages may be used to notify the framework or user that a non-recoverable error

     * has occurred. The operation is finished, and the HAL can proceed with the next operation

     * or return to the idling state.

     *

     * Note that cancellation (see common::ICancellationSignal) and preemption must be followed with

     * an Error::CANCELED message.

     * Note that cancellation (see common::ICancellationSignal) must be followed with an

     * Error::CANCELED message.

     *

     * @param error See the Error enum.

     * @param vendorCode Only valid if error == Error::VENDOR. The vendorCode must be used to index
@@ -100,8 +100,8 @@ interface ISessionCallback { 
     * This method must only be used to notify the framework during ISession#authenticate.

     *

     * Used to notify the framework upon rejected attempts. Note that the authentication

     * lifecycle ends when either 1) a fingerprint is accepted, or 2) an occurred. The

     * authentication lifecycle does NOT end when a fingerprint is rejected.

     * lifecycle ends when either 1) a fingerprint is accepted, or 2) an error occurred.

     * The authentication lifecycle does NOT end when a fingerprint is rejected.

     */

    void onAuthenticationFailed();