korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-15 16:24:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

USB: core: Fix docs warning caused by wireless_status feature

Browse Source 
Fix wrongly named 'dev' parameter in doc block, should have been iface:
drivers/usb/core/message.c:1939: warning: Function parameter or member 'iface' not described in 'usb_set_wireless_status'
drivers/usb/core/message.c:1939: warning: Excess function parameter 'dev' description in 'usb_set_wireless_status'

And fix missing struct member doc in kernel API, and reorder to
match struct:
include/linux/usb.h:270: warning: Function parameter or member 'wireless_status_work' not described in 'usb_interface'

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/linux-next/20230405114807.5a57bf46@canb.auug.org.au/T/#t
Fixes: 0a4db185f0 ("USB: core: Add API to change the wireless_status")
Signed-off-by: Bastien Nocera <hadess@hadess.net>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20230405092754.36579-1-hadess@hadess.net
[bentiss: fix checkpatch warning]
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
This commit is contained in:
Bastien Nocera 2023-04-05 11:27:54 +02:00 committed by Benjamin Tissoires
parent d9d5623f37
commit 539adfedbd
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/usb/core/message.c
View File

@ -1926,7 +1926,7 @@ static void __usb_wireless_status_intf(struct work_struct *ws)
/** /**
* usb_set_wireless_status - sets the wireless_status struct member * usb_set_wireless_status - sets the wireless_status struct member
* @dev: the device to modify * @iface: the interface to modify
* @status: the new wireless status * @status: the new wireless status
* *
* Set the wireless_status struct member to the new value, and emit * Set the wireless_status struct member to the new value, and emit

6
include/linux/usb.h
View File

@ -203,14 +203,16 @@ enum usb_wireless_status {
* following a reset or suspend operation it doesn't support. * following a reset or suspend operation it doesn't support.
* @authorized: This allows to (de)authorize individual interfaces instead * @authorized: This allows to (de)authorize individual interfaces instead
* a whole device in contrast to the device authorization. * a whole device in contrast to the device authorization.
* @wireless_status: if the USB device uses a receiver/emitter combo, whether
* the emitter is connected.
* @wireless_status_work: Used for scheduling wireless status changes
* from atomic context.
* @dev: driver model's view of this device * @dev: driver model's view of this device
* @usb_dev: if an interface is bound to the USB major, this will point * @usb_dev: if an interface is bound to the USB major, this will point
* to the sysfs representation for that device. * to the sysfs representation for that device.
* @reset_ws: Used for scheduling resets from atomic context. * @reset_ws: Used for scheduling resets from atomic context.
* @resetting_device: USB core reset the device, so use alt setting 0 as * @resetting_device: USB core reset the device, so use alt setting 0 as
* current; needs bandwidth alloc after reset. * current; needs bandwidth alloc after reset.
* @wireless_status: if the USB device uses a receiver/emitter combo, whether
* the emitter is connected.
* *
* USB device drivers attach to interfaces on a physical device. Each * USB device drivers attach to interfaces on a physical device. Each
* interface encapsulates a single high level function, such as feeding * interface encapsulates a single high level function, such as feeding