Received-SPF: pass (google.com: domain of linux-kernel+bounces-168864-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
From: Jeff Johnson <quic_jjohnson@quicinc.com>
Date: Sat, 4 May 2024 18:25:07 -0700
Subject: [PATCH] most: fix current kernel-doc warnings
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-ID: <20240504-most-kdoc-v1-1-378c468ccd85@quicinc.com>
To: Parthiban Veerasooran <parthiban.veerasooran@microchip.com>,
        "Christian
 Gromm" <christian.gromm@microchip.com>,
        Randy Dunlap <rdunlap@infradead.org>
CC: <linux-kernel@vger.kernel.org>, Jeff Johnson <quic_jjohnson@quicinc.com>

Follow up on the prior work [1] from Randy Dunlap and fix the current
set of W=1 kernel-doc warnings in drivers/most/:

drivers/most/most_snd.c:58: warning: Excess struct member 'opened' description in 'channel'
drivers/most/most_usb.c:69: warning: Function parameter or struct member 'dev' not described in 'most_dci_obj'
drivers/most/most_usb.c:69: warning: Excess struct member 'kobj' description in 'most_dci_obj'
drivers/most/most_usb.c:122: warning: Function parameter or struct member 'dev' not described in 'most_dev'
drivers/most/most_usb.c:122: warning: Function parameter or struct member 'clear_work' not described in 'most_dev'
drivers/most/most_usb.c:122: warning: Function parameter or struct member 'on_netinfo' not described in 'most_dev'
drivers/most/most_usb.c:650: warning: Function parameter or struct member 'on_netinfo' not described in 'hdm_request_netinfo'

Link: https://lore.kernel.org/r/20230113063947.23174-1-rdunlap@infradead.org [1]
Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/most/most_snd.c | 1 -
 drivers/most/most_usb.c | 6 +++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/drivers/most/most_snd.c b/drivers/most/most_snd.c
index 45d762804c5e..3b19fa835206 100644
--- a/drivers/most/most_snd.c
+++ b/drivers/most/most_snd.c
@@ -36,7 +36,6 @@ static struct most_component comp;
  * @period_pos: current period position (ring buffer)
  * @buffer_pos: current buffer position (ring buffer)
  * @is_stream_running: identifies whether a stream is running or not
- * @opened: set when the stream is opened
  * @playback_task: playback thread
  * @playback_waitq: waitq used by playback thread
  * @copy_fn: copy function for PCM-specific format and width
diff --git a/drivers/most/most_usb.c b/drivers/most/most_usb.c
index 485d5ca39951..3e5bab68fa47 100644
--- a/drivers/most/most_usb.c
+++ b/drivers/most/most_usb.c
@@ -58,7 +58,7 @@
 
 /**
  * struct most_dci_obj - Direct Communication Interface
- * @kobj:position in sysfs
+ * @dev: device structure
  * @usb_device: pointer to the usb device
  * @reg_addr: register address for arbitrary DCI access
  */
@@ -83,6 +83,7 @@ struct clear_hold_work {
 
 /**
  * struct most_dev - holds all usb interface specific stuff
+ * @dev: device structure
  * @usb_device: pointer to usb device
  * @iface: hardware interface
  * @cap: channel capabilities
@@ -94,10 +95,12 @@ struct clear_hold_work {
  * @channel_lock: synchronize channel access
  * @padding_active: indicates channel uses padding
  * @is_channel_healthy: health status table of each channel
+ * @clear_work: list of work items to send clear_halt to USB pipes
  * @busy_urbs: list of anchored items
  * @io_mutex: synchronize I/O with disconnect
  * @link_stat_timer: timer for link status reports
  * @poll_work_obj: work for polling link status
+ * @on_netinfo: call-back used to deliver network status to mostcore
  */
 struct most_dev {
 	struct device dev;
@@ -638,6 +641,7 @@ static int hdm_configure_channel(struct most_interface *iface, int channel,
  * hdm_request_netinfo - request network information
  * @iface: pointer to interface
  * @channel: channel ID
+ * @on_netinfo: call-back used to deliver network status to mostcore
  *
  * This is used as trigger to set up the link status timer that
  * polls for the NI state of the INIC every 2 seconds.

---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240504-most-kdoc-1b813475c63b