Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'sof_timer' not described in 'octeon_hcd'

Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'sof_timer' not described in 'octeon_hcd'

[kernel test robot]

Hi Orgad,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   0fcb05b72344f40806cbe810de8872f1698bf053
commit: aebbc7d63407f843a1c74806041792db65d69a51 usb: octeon-hcd: sleep on an hrtimer for far-off periodic transfers
date:   5 weeks ago
config: mips-randconfig-r2105-20261015 (https://download.01.org/0day-ci/archive/20261015/202610151637.5srThc2q-lkp@intel.com/config)
compiler: clang version 24.0.0git (https://github.com/llvm/llvm-project 8a679464f19c426ef76aad9f4587b703dd3e584d)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20261015/202610151637.5srThc2q-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| 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/

All warnings (new ones prefixed by >>):

   Warning: drivers/usb/host/octeon-hcd.c:159 struct member 'reserved' not described in 'cvmx_usb_port_status'
   Warning: drivers/usb/host/octeon-hcd.c:235 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Logical transactions may take numerous low level
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'xfersize' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'pktcnt' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'retries' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 Excess struct member 'flags' description in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:335 Excess struct member 'next' description in 'cvmx_usb_pipe' (did you mean one of: 'next_tx_frame')
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'lock' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'init_flags' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'index' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'idle_hardware_channels' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'usbcx_hprt' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'pipe_for_channel' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'indent' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'port_status' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'idle_pipes' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'active_pipes' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'frame_number' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'active_split' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'periodic' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'nonperiodic' not described in 'octeon_hcd'
>> Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'sof_timer' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:528 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Read a USB 32bit CSR. It performs the necessary address swizzle
   Warning: drivers/usb/host/octeon-hcd.c:543 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Write a USB 32bit CSR. It performs the necessary address
   Warning: drivers/usb/host/octeon-hcd.c:559 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Return non zero if this pipe connects to a non HIGH speed
   Warning: drivers/usb/host/octeon-hcd.c:575 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Trivial utility function to return the correct PID for a pipe
   Warning: drivers/usb/host/octeon-hcd.c:663 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Shutdown a USB port after a call to cvmx_usb_initialize().
   Warning: drivers/usb/host/octeon-hcd.c:695 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Initialize a USB port for use. This must be called before any
   Warning: drivers/usb/host/octeon-hcd.c:974 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Reset a USB port. After this call succeeds, the USB port is
   Warning: drivers/usb/host/octeon-hcd.c:1007 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Disable a USB port. After this call the USB port will not
   Warning: drivers/usb/host/octeon-hcd.c:1025 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Get the current state of the USB port. Use this call to
   Warning: drivers/usb/host/octeon-hcd.c:1055 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Open a virtual pipe between the host and a USB device. A pipe
   Warning: drivers/usb/host/octeon-hcd.c:1168 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Poll the RX FIFOs and remove data as needed. This function is only used
   Warning: drivers/usb/host/octeon-hcd.c:1214 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Fill the TX hardware fifo with data out of the software
   Warning: drivers/usb/host/octeon-hcd.c:1274 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Check the hardware FIFOs and fill them as needed
   Warning: drivers/usb/host/octeon-hcd.c:1310 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Fill the TX FIFO with an outgoing packet
   Warning: drivers/usb/host/octeon-hcd.c:1362 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Perform channel specific setup for Control transactions. All
   Warning: drivers/usb/host/octeon-hcd.c:1511 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Start a channel to perform the pipe's head transaction
   Warning: drivers/usb/host/octeon-hcd.c:1855 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Find a pipe that is ready to be scheduled to hardware.
   Warning: drivers/usb/host/octeon-hcd.c:1913 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Called whenever a pipe might need to be scheduled to the
   Warning: drivers/usb/host/octeon-hcd.c:2086 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Signal the completion of a transaction and free it. The
   Warning: drivers/usb/host/octeon-hcd.c:2143 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Submit a usb transaction to a pipe. Called for all types
   Warning: drivers/usb/host/octeon-hcd.c:2217 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Call to submit a USB Bulk transfer to a pipe.
   Warning: drivers/usb/host/octeon-hcd.c:2241 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Call to submit a USB Interrupt transfer to a pipe.
   Warning: drivers/usb/host/octeon-hcd.c:2266 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Call to submit a USB Control transfer to a pipe.
   Warning: drivers/usb/host/octeon-hcd.c:2297 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Call to submit a USB Isochronous transfer to a pipe.
   Warning: drivers/usb/host/octeon-hcd.c:2324 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Cancel one outstanding request in a pipe. Canceling a request
   Warning: drivers/usb/host/octeon-hcd.c:2373 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Cancel all outstanding requests in a pipe. Logically all this
   Warning: drivers/usb/host/octeon-hcd.c:2397 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Close a pipe created with cvmx_usb_open_pipe().
   Warning: drivers/usb/host/octeon-hcd.c:2419 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Get the current USB protocol level frame number. The frame
   Warning: drivers/usb/host/octeon-hcd.c:2628 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Poll a channel for status
   Warning: drivers/usb/host/octeon-hcd.c:2970 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
    * Poll the USB block for status and call all needed callback
   Warning: drivers/usb/host/octeon-hcd.c:159 struct member 'reserved' not described in 'cvmx_usb_port_status'
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'xfersize' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'pktcnt' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 struct member 'retries' not described in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:288 Excess struct member 'flags' description in 'cvmx_usb_transaction'
   Warning: drivers/usb/host/octeon-hcd.c:335 Excess struct member 'next' description in 'cvmx_usb_pipe' (did you mean one of: 'next_tx_frame')
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'lock' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'init_flags' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'index' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'idle_hardware_channels' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'usbcx_hprt' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'pipe_for_channel' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'indent' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'port_status' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'idle_pipes' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'active_pipes' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'frame_number' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'active_split' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'periodic' not described in 'octeon_hcd'
   Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'nonperiodic' not described in 'octeon_hcd'
>> Warning: drivers/usb/host/octeon-hcd.c:381 struct member 'sof_timer' not described in 'octeon_hcd'

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

[PATCH] usb: octeon-hcd: fix the kernel-doc of struct octeon_hcd

[Orgad Shaneh]

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

Re: [PATCH] usb: octeon-hcd: fix the kernel-doc of struct octeon_hcd

[sashiko-bot]

> 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>

Sashiko has reviewed this patch and found no issues. It looks great!

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261015194043.1597422-1-orgads@gmail.com?part=1