[PATCH] cfg80211: remove obselete comment for .sched_scan_stop() callback

[PATCH] cfg80211: remove obselete comment for .sched_scan_stop() callback

[Arend van Spriel]

The kerneldoc comment for .sched_scan_stop() callback describes a
driver_initiated flag, but the interface does not hold such a flag.

Reviewed-by: Franky (Zhenhui) Lin <frankyl@broadcom.com>
Reviewed-by: Hante Meuleman <meuleman@broadcom.com>
Signed-off-by: Arend van Spriel <arend@broadcom.com>
---
Hi Johannes,

Was working on scheduled scan support for brcmfmac and got a little
confused about .sched_scan_stop() documentation. Not sure if this
was stale documentation.

The patch applies to master branch in mac80211-next repository.

Gr. AvS
---
 include/net/cfg80211.h |    4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 903683b1..1a3fe9a 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -1580,9 +1580,7 @@ struct cfg80211_gtk_rekey_data {
  * @set_cqm_txe_config: Configure connection quality monitor TX error
  *	thresholds.
  * @sched_scan_start: Tell the driver to start a scheduled scan.
- * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
- *	scan.  The driver_initiated flag specifies whether the driver
- *	itself has informed that the scan has stopped.
+ * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
  *
  * @mgmt_frame_register: Notify driver that a management frame type was
  *	registered. Note that this callback may not sleep, and cannot run
-- 
1.7.9.5

Re: [PATCH] cfg80211: remove obselete comment for .sched_scan_stop() callback

[Johannes Berg]

On Tue, 2012-09-18 at 10:59 +0200, Arend van Spriel wrote:
> The kerneldoc comment for .sched_scan_stop() callback describes a
> driver_initiated flag, but the interface does not hold such a flag.
> 
> Reviewed-by: Franky (Zhenhui) Lin <frankyl@broadcom.com>
> Reviewed-by: Hante Meuleman <meuleman@broadcom.com>
> Signed-off-by: Arend van Spriel <arend@broadcom.com>
> ---
> Hi Johannes,
> 
> Was working on scheduled scan support for brcmfmac and got a little
> confused about .sched_scan_stop() documentation. Not sure if this
> was stale documentation.

Yes I believe this was some sort of circular call that we removed
(driver calls stop, cfg80211 tells driver it itself stopped??)

I'll apply this (and fix the typo ("obsolete") in the subject)

johannes

Re: [PATCH] cfg80211: remove obselete comment for .sched_scan_stop() callback

[Arend van Spriel]

On 09/18/2012 12:37 PM, Johannes Berg wrote:
> On Tue, 2012-09-18 at 10:59 +0200, Arend van Spriel wrote:
>> The kerneldoc comment for .sched_scan_stop() callback describes a
>> driver_initiated flag, but the interface does not hold such a flag.
>>
>> Reviewed-by: Franky (Zhenhui) Lin <frankyl@broadcom.com>
>> Reviewed-by: Hante Meuleman <meuleman@broadcom.com>
>> Signed-off-by: Arend van Spriel <arend@broadcom.com>
>> ---
>> Hi Johannes,
>>
>> Was working on scheduled scan support for brcmfmac and got a little
>> confused about .sched_scan_stop() documentation. Not sure if this
>> was stale documentation.
>
> Yes I believe this was some sort of circular call that we removed
> (driver calls stop, cfg80211 tells driver it itself stopped??)

I can come up with a scenario, where scheduled scan related cleanup is 
done in sched_scan_stop and needs different behaviour when initiated by 
driver as opposed to user-space initiated. However, it feels awkward so 
good riddance.

> I'll apply this (and fix the typo ("obsolete") in the subject)
>
> johannes

Thanks (and thanks for fixing the subject ;-) ).

Gr. AvS