qcacmn: Documentation enhancement for wake_lock_in_user_scan

Update kernel doc for wake_lock_in_user_scan to improve
code readability.

Change-Id: I5a7a0fd8cb18d97d293e9896ed58b40a52e06e0c
CRs-Fixed: 2520906
This commit is contained in:
Abhinav Kumar
2019-09-05 15:38:43 +05:30
gecommit door nshrivas
bovenliggende d45d248743
commit e288a93d22

Bestand weergeven

@@ -841,12 +841,19 @@
/*
* <ini>
* wake_lock_in_user_scan - use wake lock during user scan
* wake_lock_in_user_scan - use to acquire wake lock during user scan
* @Min: 0
* @Max: 1
* @Default: 0
*
* This ini is used to define if wake lock is held used during user scan req
* This INI is added for a specific OEM on their request, who dont want to
* use PNO offload scan (sched scans). This is useful only if PNO scan offload
* is disabled. If PNO scan is enabled this INI should be disabled and its
* by default disabled intentionally.
* This is used to acquire wake lock to handle the case where PNO scan offload
* is disabled so that wlan is not suspended during scan before connect and
* thus scan is not aborted in between. In case PNO scan is offloaded, the FW
* will take care of connect scans and will wake up host when candidate is found
*
* Related: Scan
*