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
diff --git a/wifi/supplicant/1.3/ISupplicantStaIface.hal b/wifi/supplicant/1.3/ISupplicantStaIface.hal
index b501a95..4506f37 100644
--- a/wifi/supplicant/1.3/ISupplicantStaIface.hal
+++ b/wifi/supplicant/1.3/ISupplicantStaIface.hal
@@ -69,7 +69,7 @@
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 @@
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 @@
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|,
diff --git a/wifi/supplicant/1.3/ISupplicantStaIfaceCallback.hal b/wifi/supplicant/1.3/ISupplicantStaIfaceCallback.hal
index 6828dcd..c5da29c 100644
--- a/wifi/supplicant/1.3/ISupplicantStaIfaceCallback.hal
+++ b/wifi/supplicant/1.3/ISupplicantStaIfaceCallback.hal
@@ -147,7 +147,7 @@
};
/**
- * 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 @@
/**
* 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);
diff --git a/wifi/supplicant/1.3/ISupplicantStaNetwork.hal b/wifi/supplicant/1.3/ISupplicantStaNetwork.hal
index 0566a21..2505912 100644
--- a/wifi/supplicant/1.3/ISupplicantStaNetwork.hal
+++ b/wifi/supplicant/1.3/ISupplicantStaNetwork.hal
@@ -214,7 +214,7 @@
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 @@
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 @@
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 @@
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.