* [PATCH] usb: octeon-hcd: fix the kernel-doc of struct octeon_hcd
[not found] <202610151637.5srThc2q-lkp@intel.com>
@ 2026-10-15 19:40 ` Orgad Shaneh
2026-10-15 19:42 ` sashiko-bot
0 siblings, 1 reply; 2+ messages in thread
From: Orgad Shaneh @ 2026-10-15 19:40 UTC (permalink / raw)
To: gregkh; +Cc: linux-usb, linux-kernel, lkp, oe-kbuild-all
The struct octeon_hcd comment opens with /** but names its members
without the @ prefix, so kernel-doc sees none of them and warns about
every member. aebbc7d63407 added sof_timer without a line at all,
which the robot reports as a new W=1 warning.
Prefix the members with @, drop "pipe", which is no longer a member,
and describe the three that were missing: periodic, nonperiodic and
sof_timer. scripts/kernel-doc -Wall reports nothing for octeon_hcd
afterwards.
Fixes: aebbc7d63407 ("usb: octeon-hcd: sleep on an hrtimer for far-off periodic transfers")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202610151637.5srThc2q-lkp@intel.com/
Assisted-by: LLM
Signed-off-by: Orgad Shaneh <orgads@gmail.com>
---
drivers/usb/host/octeon-hcd.c | 31 +++++++++++++++++--------------
1 file changed, 17 insertions(+), 14 deletions(-)
diff --git a/drivers/usb/host/octeon-hcd.c b/drivers/usb/host/octeon-hcd.c
index 4929c6a..d6ba52b 100644
--- a/drivers/usb/host/octeon-hcd.c
+++ b/drivers/usb/host/octeon-hcd.c
@@ -348,20 +348,23 @@ struct cvmx_usb_tx_fifo {
/**
* struct octeon_hcd - the state of the USB block
*
- * lock: Serialization lock.
- * init_flags: Flags passed to initialize.
- * index: Which USB block this is for.
- * idle_hardware_channels: Bit set for every idle hardware channel.
- * usbcx_hprt: Stored port status so we don't need to read a CSR to
- * determine splits.
- * pipe_for_channel: Map channels to pipes.
- * pipe: Storage for pipes.
- * indent: Used by debug output to indent functions.
- * port_status: Last port status used for change notification.
- * idle_pipes: List of open pipes that have no transactions.
- * active_pipes: Active pipes indexed by transfer type.
- * frame_number: Increments every SOF interrupt for time keeping.
- * active_split: Points to the current active split, or NULL.
+ * @lock: Serialization lock.
+ * @init_flags: Flags passed to initialize.
+ * @index: Which USB block this is for.
+ * @idle_hardware_channels: Bit set for every idle hardware channel.
+ * @usbcx_hprt: Stored port status so we don't need to read a CSR to
+ * determine splits.
+ * @pipe_for_channel: Map channels to pipes.
+ * @indent: Used by debug output to indent functions.
+ * @port_status: Last port status used for change notification.
+ * @idle_pipes: List of open pipes that have no transactions.
+ * @active_pipes: Active pipes indexed by transfer type.
+ * @frame_number: Increments every SOF interrupt for time keeping.
+ * @active_split: Points to the current active split, or NULL.
+ * @periodic: Pending TX FIFO writes for periodic channels.
+ * @nonperiodic: Pending TX FIFO writes for non-periodic channels.
+ * @sof_timer: Polls the block when the next periodic transfer is
+ * due, so SOF interrupts can stay off until then.
*/
struct octeon_hcd {
spinlock_t lock; /* serialization lock */
--
2.53.0
^ permalink raw reply related [flat|nested] 2+ messages in thread