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

Commit c8c0064e authored by Sunil Ravi's avatar Sunil Ravi
Browse files

wifi: Improve documentation of hidl APIs. 

Added changes as per ANAPIC review to improve
documentation of few hidl APIs.

Bug: 148617258
Test: Not tested as there is no code change.
Change-Id: I3f91c6b8aad3f34807534a3fbc3cf5a3c3233cd7
parent 89763d71

current.txt

+3 −3
Original line number Diff line number Diff line
@@ -678,9 +678,9 @@ a3eddd9bbdc87e8c22764070037dd1154f1cf006e6fba93364c4f85d4c134a19 android.hardwar 
c67aaf26a7a40d14ea61e70e20afacbd0bb906df1704d585ac8599fbb69dd44b android.hardware.wifi.hostapd@1.2::IHostapd

2b5a7ea572b736030c64a3b4043af244425477c4672301780fe15aba5ed393d9 android.hardware.wifi.hostapd@1.2::types

a64467bae843569f0d465c5be7f0c7a5b987985b55a3ef4794dd5afc68538650 android.hardware.wifi.supplicant@1.3::ISupplicant

8aed0a8e03e7a67bfdfb78ad7529a9ae95bea36e6060473b204c89d772522126 android.hardware.wifi.supplicant@1.3::ISupplicantStaIface

def77c7db95d374f11a111bfc4ed60f92451303642a43276c4e291988fcee625 android.hardware.wifi.supplicant@1.3::ISupplicantStaIfaceCallback

62cf050c593c1ec34b49178b5bdde72dd9b80d9bad3eb184e4f0cd564d28678c android.hardware.wifi.supplicant@1.3::ISupplicantStaNetwork

159d48c9efb881f44d5deda8917b89fb4da26837f019446d6d73b73ea5010eca android.hardware.wifi.supplicant@1.3::ISupplicantStaIface

2ce1f7fb52e49f80b13a9b153d491bce530552f02357ea729acae922a8659f93 android.hardware.wifi.supplicant@1.3::ISupplicantStaIfaceCallback

77531c8d048f8f8ae532babd0ca86332a865ec9aace1b051226ef2b21123e645 android.hardware.wifi.supplicant@1.3::ISupplicantStaNetwork

98592d193a717066facf91428426e5abe211e3bd718bc372e29fb944ddbe6e7c android.hardware.wifi.supplicant@1.3::types

e1d34b83188a8ef3c507ec53c0ebcf714863c746da7f4a05460453f7c4c09389 android.hardware.radio@1.5::types

8062d0a1a03594dd8b448adcf6f08856b5720f7e33f9b785a21d3ef74a4f211d android.hardware.radio@1.5::IRadio

wifi/supplicant/1.3/ISupplicantStaIface.hal

+9 −6
Original line number Diff line number Diff line
@@ -69,7 +69,7 @@ interface ISupplicantStaIface extends @1.2::ISupplicantStaIface { 
        bitfield<WpaDriverCapabilitiesMask> driverCapabilitiesMask);



    /**

     * Set MBO cellular data status.

     * Set Wi-Fi Alliance Agile Multiband (MBO) cellular data status.

     *

     * @param available true means cellular data available, false otherwise.

     * @return status Status of the operation.
@@ -93,8 +93,10 @@ interface ISupplicantStaIface extends @1.2::ISupplicantStaIface { 
        generates (SupplicantStatus status, bitfield<KeyMgmtMask> keyMgmtMask);



    /**

     * Flush FILS HLP IEs

     * Use this to flush all the HLP IEs in wpa_supplicant

     * Flush fast initial link setup (IEEE 802.11ai FILS) HLP packets.

     * Use this to flush all the higher layer protocol (HLP) packets added in

     * wpa_supplicant to send in FILS (Re)Association Request frame

     * (Eg: DHCP discover packet).

     *

     * @return status Status of the operation.

     *         Possible status codes:
@@ -106,11 +108,12 @@ interface ISupplicantStaIface extends @1.2::ISupplicantStaIface { 
    filsHlpFlushRequest() generates (SupplicantStatus status);



    /**

     * Add FILS HLP IEs

     * Use this to add a HLP IE to wpa_supplicant

     * Add fast initial link setup (IEEE 802.11ai FILS) HLP packets.

     * Use this to add higher layer protocol (HLP) packet in FILS (Re)Association Request frame

     * (Eg: DHCP discover packet).

     *

     * @param dst_mac MAC address of the destination

     * @param pkt The contents of the HLP IE starting from ethertype

     * @param pkt The contents of the HLP packet starting from ethertype

     * @return status Status of the operation.

     *         Possible status codes:

     *         |SupplicantStatusCode.SUCCESS|,

wifi/supplicant/1.3/ISupplicantStaIfaceCallback.hal

+4 −1
Original line number Diff line number Diff line
@@ -147,7 +147,7 @@ interface ISupplicantStaIfaceCallback extends @1.2::ISupplicantStaIfaceCallback 
    };



    /**

     * Indicates PMK cache added event.

     * Indicates pairwise master key (PMK) cache added event.

     *

     * @param expirationTimeInSec expiration time in seconds

     * @param serializedEntry is serialized PMK cache entry, the content is
@@ -192,6 +192,9 @@ interface ISupplicantStaIfaceCallback extends @1.2::ISupplicantStaIfaceCallback 


    /**

     * Indicates an EAP authentication failure.

     * @param errorCode Error code for EAP authentication failure.

     *        Either standard error code (enum EapErrorCode) or

     *        private error code defined by network provider.

     */

    oneway onEapFailure_1_3(uint32_t errorCode);

wifi/supplicant/1.3/ISupplicantStaNetwork.hal

+4 −4
Original line number Diff line number Diff line
@@ -214,7 +214,7 @@ interface ISupplicantStaNetwork extends @1.2::ISupplicantStaNetwork { 
        generates (SupplicantStatus status, bitfield<GroupCipherMask> groupCipherMask);



    /**

     * Set WAPI certificate suite for this network.

     * Set WAPI certificate suite name for this network.

     *

     * @param suite value to set.

     * @return status Status of the operation.
@@ -227,7 +227,7 @@ interface ISupplicantStaNetwork extends @1.2::ISupplicantStaNetwork { 
    setWapiCertSuite(string suite) generates (SupplicantStatus status);



    /**

     * Get WAPI certificate suite set for this network.

     * Get WAPI certificate suite name set for this network.

     *

     * @return status Status of the operation.

     *         Possible status codes:
@@ -239,7 +239,7 @@ interface ISupplicantStaNetwork extends @1.2::ISupplicantStaNetwork { 
    getWapiCertSuite() generates (SupplicantStatus status, string suite);



    /**

     * Add a PMK into supplicant PMK cache.

     * Add a pairwise master key (PMK) into supplicant PMK cache.

     *

     * @param serializedEntry is serialized PMK cache entry, the content is

     *              opaque for the framework and depends on the native implementation.
@@ -278,7 +278,7 @@ interface ISupplicantStaNetwork extends @1.2::ISupplicantStaNetwork { 
    getAuthAlg_1_3() generates (SupplicantStatus status, bitfield<AuthAlgMask> authAlgMask);



    /**

     * Enable EAP ERP for this network.

     * Enable Extensible Authentication (EAP) - Re-authentication Protocol (ERP) for this network.

     *

     * @param enable true to set, false otherwise.

     * @return status Status of the operation.