wifi(interface): Add/Correct docstring params
Changes in the CL:
1. Add missing docstring params in the HIDL interface.
2. Reword some method docs. Occurences of "will" is replaced
by "must" (based on comments received on supplicant HIDL interface:
go/aog/275115).
3. Add onFailure callbacks for all the methods and added docstrings for
them.
Bug: 31352200
Test: mmma -j32 hardware/interfaces/wifi/1.0
Change-Id: Ib7152625851023d6244f742bb77a8fdc0829e00d
diff --git a/wifi/1.0/IWifiChip.hal b/wifi/1.0/IWifiChip.hal
index f5fe7a9..3e229e2 100644
--- a/wifi/1.0/IWifiChip.hal
+++ b/wifi/1.0/IWifiChip.hal
@@ -125,41 +125,55 @@
* Requests notifications of significant events on this chip. Multiple calls
* to this will register multiple callbacks each of which will receive all
* events.
+ *
+ * @param callback An instance of the |IWifiChipEventCallback| HIDL interface
+ * object.
*/
oneway registerEventCallback(IWifiChipEventCallback callback);
/**
* Get the set of operation modes that the chip supports.
+ *
+ * @return modes List of modes supported by the device.
*/
getAvailableModes() generates (vec<ChipMode> modes);
/**
- * Reconfigure the Chip. Will trigger onChipReconfigured.
+ * Reconfigure the Chip.
+ * Must trigger |IWifiChipEventCallback.onChipReconfigured| on sucess,
+ * or |IWifiChipEventCallback.onChipReconfigureFailure| on failure.
*
* @param modeId The mode that the chip should switch to, corresponding to the
- * id property of the target ChipMode.
+ * id property of the target ChipMode.
*/
oneway configureChip(ChipModeId modeId);
/**
* Get the current mode that the chip is in.
+ *
+ * @return modeId The mode that the chip is currently configured to,
+ * corresponding to the id property of the target ChipMode.
*/
getMode() generates (ChipModeId modeId);
/**
- * Request information about the chip. Will trigger onChipDebugInfoAvailable.
+ * Request information about the chip.
+ * Must trigger |IWifiChipEventCallback.onChipDebugInfoAvailable| on sucess,
+ * or |IWifiChipEventCallback.onChipDebugInfoFailure| on failure.
*/
oneway requestChipDebugInfo();
/**
- * Request vendor debug info from the driver. Will trigger
- * onDriverDebugDumpAvailable.
+ * Request vendor debug info from the driver.
+ * Must trigger |IWifiChipEventCallback.onDriverDebugDumpAvailable| on success,
+ * or |IWifiChipEventCallback.onDriverDebugDumpFailure| on failure.
*/
oneway requestDriverDebugDump();
/**
- * Request vendor debug info from the firmware. Will trigger
- * onFirmwareDebugDumpAvailable.
+ * Request vendor debug info from the firmware.
+ * Must trigger |IWifiChipEventCallback.onFirmwareDebugDumpAvailable| on
+ * success, or |IWifiChipEventCallback.onFirmwareDebugDumpFailure| on failure.
*/
oneway requestFirmwareDebugDump();
};