Skip to content

Commit 539adfe

Browse files
hadessbentiss
authored andcommitted
USB: core: Fix docs warning caused by wireless_status feature
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: 0a4db18 ("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>
1 parent d9d5623 commit 539adfe

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

drivers/usb/core/message.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1926,7 +1926,7 @@ static void __usb_wireless_status_intf(struct work_struct *ws)
19261926

19271927
/**
19281928
* usb_set_wireless_status - sets the wireless_status struct member
1929-
* @dev: the device to modify
1929+
* @iface: the interface to modify
19301930
* @status: the new wireless status
19311931
*
19321932
* Set the wireless_status struct member to the new value, and emit

include/linux/usb.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,14 +203,16 @@ enum usb_wireless_status {
203203
* following a reset or suspend operation it doesn't support.
204204
* @authorized: This allows to (de)authorize individual interfaces instead
205205
* a whole device in contrast to the device authorization.
206+
* @wireless_status: if the USB device uses a receiver/emitter combo, whether
207+
* the emitter is connected.
208+
* @wireless_status_work: Used for scheduling wireless status changes
209+
* from atomic context.
206210
* @dev: driver model's view of this device
207211
* @usb_dev: if an interface is bound to the USB major, this will point
208212
* to the sysfs representation for that device.
209213
* @reset_ws: Used for scheduling resets from atomic context.
210214
* @resetting_device: USB core reset the device, so use alt setting 0 as
211215
* current; needs bandwidth alloc after reset.
212-
* @wireless_status: if the USB device uses a receiver/emitter combo, whether
213-
* the emitter is connected.
214216
*
215217
* USB device drivers attach to interfaces on a physical device. Each
216218
* interface encapsulates a single high level function, such as feeding

0 commit comments

Comments
 (0)