From 3b685a8ac86511a308cd00ede88d2c041fd5ed3a Mon Sep 17 00:00:00 2001 From: Nathan Harold Date: Thu, 26 Sep 2019 13:20:21 -0700 Subject: [PATCH] Clarify the start and end of scan intervals Update the documentation of NetworkScanRequest to clarify that the interval between scans is from the completion of one scan to the start of another. This is the only possible definition that doesn't possibly result in back-to-back scans which never complete. In the initial design of this API, the stated use case was for scans where "interval" >> "scan duration". For that use case, this clarification doesn't make a meaningful difference; however, for the use case of long-duration scans, the distinction prevents the issue stated above. Bug: 139935383 Test: compilation (docstring-only change) Change-Id: Ib8393110bfd3ea883045648ee7dac9c6e6a32d44 --- current.txt | 1 + radio/1.2/types.hal | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/current.txt b/current.txt index 3fabd7c5b1..6f9f4d4c81 100644 --- a/current.txt +++ b/current.txt @@ -576,5 +576,6 @@ b69a7615c508acf5c5201efd1bfa3262167874fc3594e2db5a3ff93addd8ac75 android.hardwar eb2fa0c883c2185d514be0b84c179b283753ef0c1b77b45b4f359bd23bba8b75 android.hardware.neuralnetworks@1.0::IPreparedModel fb382e986c10b8fbb797a8546e8f9ea6d1107bfe6f3fb7e57f6bbbf1f807a906 android.hardware.neuralnetworks@1.2::IDevice 40e71cd693de5b832325c5d8f081f2ff20a7ba2b89d401cee5b4b3eb0e241681 android.hardware.neuralnetworks@1.2::IPreparedModel +a785a57447a81e9c130eef6904c3a5c256076c6a04588c40620ebd6fa2660d77 android.hardware.radio@1.2::types 1a6e2bd289f22931c526b21916910f1d4c436b7acb9556e4243de4ce8e6cc2e4 android.hardware.soundtrigger@2.0::ISoundTriggerHwCallback fd65298e1e09e0e3c781ab18305920d757dbe55a3b459ce17814ec5cf6dfee99 android.hardware.wifi@1.0::IWifiP2pIface diff --git a/radio/1.2/types.hal b/radio/1.2/types.hal index dffebd3e42..f10d753cb9 100644 --- a/radio/1.2/types.hal +++ b/radio/1.2/types.hal @@ -161,7 +161,8 @@ struct NetworkScanRequest { ScanType type; /** - * Time interval in seconds between periodic scans, only valid when type = PERIODIC + * Time interval in seconds between the completion of one scan and the start of a subsequent scan. + * This field is only valid when 'type' is 'PERIODIC'. * Range: ScanIntervalRange:MIN to ScanIntervalRange:MAX */ int32_t interval;