Update the setDtimMultiplier aidl API documentation.
Update the aidl API documentation to describe how setDtimMultiplier API
is supposed to work, i.e. we can call this API to set a maximum DTIM
multiplier value to use in driver, any larger value must not be accepted
and meanwhile it allows to set a specific multiplier by OEMs. Try to
make the description clear and avoid the ambiguity.
Bug: 266256943
Test: m
Change-Id: Ic7d2284a25e32d1b0752cf2bc832c069f646fcea
diff --git a/wifi/aidl/android/hardware/wifi/IWifiStaIface.aidl b/wifi/aidl/android/hardware/wifi/IWifiStaIface.aidl
index 2c81984..6d6afaf 100644
--- a/wifi/aidl/android/hardware/wifi/IWifiStaIface.aidl
+++ b/wifi/aidl/android/hardware/wifi/IWifiStaIface.aidl
@@ -534,14 +534,18 @@
void stopSendingKeepAlivePackets(in int cmdId);
/**
- * Set DTIM multiplier used when the system is in the suspended mode.
+ * Set maximum acceptable DTIM multiplier to hardware driver.
+ * Any multiplier larger than this maximum value must not be accepted since it will cause
+ * packet loss higher than what the system can accept, which will cause unexpected behavior
+ * for apps, and may interrupt the network connection.
+ *
* When STA is in the power saving mode and system is suspended,
* the wake up interval will be set to:
* 1) multiplier * DTIM period if multiplier > 0.
* 2) the driver default value if multiplier <= 0.
* Some implementations may apply an additional cap to wake up interval in the case of 1).
*
- * @param multiplier integer DTIM multiplier value to set.
+ * @param multiplier integer maximum DTIM multiplier value to set.
* @throws ServiceSpecificException with one of the following values:
* |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|,
* |WifiStatusCode.ERROR_NOT_SUPPORTED|,