summaryrefslogtreecommitdiffstats
path: root/wifi
diff options
context:
space:
mode:
authorAhmed ElArabawy <arabawy@google.com>2019-03-21 17:04:23 -0700
committerAhmed ElArabawy <arabawy@google.com>2019-03-21 18:58:32 -0700
commit58d1b2a036aed20aad035671d2d0d234f06ff7c6 (patch)
treef6a8cae5496c33b85e481d4870f4fbdafb95a5a5 /wifi
parent9b3504c31754a8b4ba8436534f9571181ba5ffce (diff)
downloadandroid_hardware_interfaces-58d1b2a036aed20aad035671d2d0d234f06ff7c6.tar.gz
android_hardware_interfaces-58d1b2a036aed20aad035671d2d0d234f06ff7c6.tar.bz2
android_hardware_interfaces-58d1b2a036aed20aad035671d2d0d234f06ff7c6.zip
Wifi: Update the Latency mode API documentation
This commit updates the documentation for the HAL API setLatencyMode(). It also updates the current.txt with the IWifiChip new hash. Bug: 124459516 Test: None Change-Id: I018e0237807aab70f7587d5fd7517d64352140f7
Diffstat (limited to 'wifi')
-rw-r--r--wifi/1.3/IWifiChip.hal12
1 files changed, 8 insertions, 4 deletions
diff --git a/wifi/1.3/IWifiChip.hal b/wifi/1.3/IWifiChip.hal
index fc6dbac40..72cee899b 100644
--- a/wifi/1.3/IWifiChip.hal
+++ b/wifi/1.3/IWifiChip.hal
@@ -65,10 +65,14 @@ interface IWifiChip extends @1.2::IWifiChip {
/**
* API to set the wifi latency mode
*
- * Latency mode determines whether or not to optimize for reducing wifi
- * latency as a tradeoff with other wifi functionality such as scanning,
- * roaming, etc. This optimization is suitable for some applications such
- * as gaming and virtual reality applications.
+ * The latency mode is a hint to the HAL to enable or disable Wi-Fi latency
+ * optimization. The optimization should be enabled if the mode is set to |LOW|
+ * and should be disabled if the mode is set to |NORMAL|.
+ * Wi-Fi latency optimization may trade-off latency against other Wi-Fi
+ * functionality such as scanning, roaming, etc. but it should not result in
+ * completely halting this functionality.
+ *
+ * The low latency mode targets applications such as gaming and virtual reality.
*/
setLatencyMode(LatencyMode mode) generates (WifiStatus status);