All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Nícolas F. R. A. Prado" <nfraprado@protonmail.com>,
	"Andrey Shvetsov" <andrey.shvetsov@k2l.de>,
	linux-staging@lists.linux.dev
Subject: [PATCH 29/57] staging: most: dim2: Provide missing descriptions and fix doc-rot
Date: Wed, 14 Apr 2021 19:11:01 +0100	[thread overview]
Message-ID: <20210414181129.1628598-30-lee.jones@linaro.org> (raw)
In-Reply-To: <20210414181129.1628598-1-lee.jones@linaro.org>

Also demote merely half-complete header.

Fixes the following W=1 kernel build warning(s):

 drivers/staging/most/dim2/dim2.c:69: warning: Function parameter or member 'name' not described in 'hdm_channel'
 drivers/staging/most/dim2/dim2.c:69: warning: Function parameter or member 'reset_dbr_size' not described in 'hdm_channel'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'dev' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'name' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk_speed' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk_pll' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'bus' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'on_netinfo' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'disable_platform' not described in 'dim2_hdm'
 drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'most_iface' not described in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'ch_idx' not described in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'ccfg' not described in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'iface' description in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'channel' description in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'channel_config' description in 'configure_channel'
 drivers/staging/most/dim2/dim2.c:558: warning: Function parameter or member 'most_iface' not described in 'enqueue'
 drivers/staging/most/dim2/dim2.c:558: warning: Function parameter or member 'ch_idx' not described in 'enqueue'
 drivers/staging/most/dim2/dim2.c:558: warning: Excess function parameter 'iface' description in 'enqueue'
 drivers/staging/most/dim2/dim2.c:558: warning: Excess function parameter 'channel' description in 'enqueue'
 drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'most_iface' not described in 'request_netinfo'
 drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'ch_idx' not described in 'request_netinfo'
 drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'on_netinfo' not described in 'request_netinfo'
 drivers/staging/most/dim2/dim2.c:591: warning: Excess function parameter 'iface' description in 'request_netinfo'
 drivers/staging/most/dim2/dim2.c:591: warning: Excess function parameter 'channel_id' description in 'request_netinfo'
 drivers/staging/most/dim2/dim2.c:631: warning: Function parameter or member 'most_iface' not described in 'poison_channel'
 drivers/staging/most/dim2/dim2.c:631: warning: Function parameter or member 'ch_idx' not described in 'poison_channel'
 drivers/staging/most/dim2/dim2.c:631: warning: Excess function parameter 'iface' description in 'poison_channel'
 drivers/staging/most/dim2/dim2.c:631: warning: Excess function parameter 'channel_id' description in 'poison_channel'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Nícolas F. R. A. Prado" <nfraprado@protonmail.com>
Cc: Andrey Shvetsov <andrey.shvetsov@k2l.de>
Cc: linux-staging@lists.linux.dev
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/staging/most/dim2/dim2.c | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/drivers/staging/most/dim2/dim2.c b/drivers/staging/most/dim2/dim2.c
index b34e3c130f53f..093ef9a2b2919 100644
--- a/drivers/staging/most/dim2/dim2.c
+++ b/drivers/staging/most/dim2/dim2.c
@@ -50,8 +50,10 @@ static DECLARE_TASKLET_OLD(dim2_tasklet, dim2_tasklet_fn);
 
 /**
  * struct hdm_channel - private structure to keep channel specific data
+ * @name: channel name
  * @is_initialized: identifier to know whether the channel is initialized
  * @ch: HAL specific channel data
+ * @reset_dbr_size: reset DBR data buffer size
  * @pending_list: list to keep MBO's before starting transfer
  * @started_list: list to keep MBO's after starting transfer
  * @direction: channel direction (TX or RX)
@@ -68,7 +70,7 @@ struct hdm_channel {
 	enum most_channel_data_type data_type;
 };
 
-/**
+/*
  * struct dim2_hdm - private structure to keep interface specific data
  * @hch: an array of channel specific data
  * @most_iface: most interface structure
@@ -428,9 +430,9 @@ static void complete_all_mbos(struct list_head *head)
 
 /**
  * configure_channel - initialize a channel
- * @iface: interface the channel belongs to
- * @channel: channel to be configured
- * @channel_config: structure that holds the configuration information
+ * @most_iface: interface the channel belongs to
+ * @ch_idx: channel index to be configured
+ * @ccfg: structure that holds the configuration information
  *
  * Receives configuration information from mostcore and initialize
  * the corresponding channel. Return 0 on success, negative on failure.
@@ -546,8 +548,8 @@ static int configure_channel(struct most_interface *most_iface, int ch_idx,
 
 /**
  * enqueue - enqueue a buffer for data transfer
- * @iface: intended interface
- * @channel: ID of the channel the buffer is intended for
+ * @most_iface: intended interface
+ * @ch_idx: ID of the channel the buffer is intended for
  * @mbo: pointer to the buffer object
  *
  * Push the buffer into pending_list and try to transfer one buffer from
@@ -579,8 +581,9 @@ static int enqueue(struct most_interface *most_iface, int ch_idx,
 
 /**
  * request_netinfo - triggers retrieving of network info
- * @iface: pointer to the interface
- * @channel_id: corresponding channel ID
+ * @most_iface: pointer to the interface
+ * @ch_idx: corresponding channel ID
+ * @on_netinfo: call-back used to deliver network status to mostcore
  *
  * Send a command to INIC which triggers retrieving of network info by means of
  * "Message exchange over MDP/MEP". Return 0 on success, negative on failure.
@@ -621,8 +624,8 @@ static void request_netinfo(struct most_interface *most_iface, int ch_idx,
 
 /**
  * poison_channel - poison buffers of a channel
- * @iface: pointer to the interface the channel to be poisoned belongs to
- * @channel_id: corresponding channel ID
+ * @most_iface: pointer to the interface the channel to be poisoned belongs to
+ * @ch_idx: corresponding channel ID
  *
  * Destroy a channel and complete all the buffers in both started_list &
  * pending_list. Return 0 on success, negative on failure.
-- 
2.27.0


  parent reply	other threads:[~2021-04-14 18:13 UTC|newest]

Thread overview: 85+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-14 18:10 [PATCH 00/57] Rid W=1 warnings from Staging Lee Jones
2021-04-14 18:10 ` Lee Jones
2021-04-14 18:10 ` [PATCH 01/57] staging: r8192U_core: Remove unused variable 'ret' and demote kernel-doc abuse Lee Jones
2021-04-14 18:10 ` [PATCH 02/57] staging: android: ashmem: Supply description for 'new_range' Lee Jones
2021-04-15 16:30   ` Todd Kjos
2021-04-14 18:10 ` [PATCH 03/57] staging: comedi_8254: Fix descriptions for 'i8254' and 'iobase' Lee Jones
2021-04-14 18:10 ` [PATCH 04/57] staging: r8192U_core: Do not use kernel-doc formatting for !kernel-doc headers Lee Jones
2021-04-14 18:10 ` [PATCH 05/57] staging: r819xU_phy: Remove some local variables from the stack Lee Jones
2021-04-14 18:10 ` [PATCH 06/57] staging: r819xU_cmdpkt: Remove functionless method 'cmpk_handle_query_config_rx' Lee Jones
2021-04-14 18:10 ` [PATCH 07/57] staging: wlan-ng: cfg80211: Move large struct onto the heap Lee Jones
2021-04-14 18:10 ` [PATCH 08/57] staging: rtw_ioctl_set: Move 'channel_table' to the only place it's used Lee Jones
2021-04-14 18:10 ` [PATCH 09/57] staging: rtl8188eu: core: rtw_ieee80211: Fix incorrectly documented function Lee Jones
2021-04-14 18:10 ` [PATCH 10/57] staging: rtl8723bs: core: rtw_mlme: Remove a bunch of unused variables Lee Jones
2021-04-14 18:10 ` [PATCH 11/57] staging: rtl8723bs: core: rtw_mlme_ext: Deal with " Lee Jones
2021-04-14 18:10 ` [PATCH 12/57] staging: rtl8712: rtl871x_mp_ioctl: Remove a bunch of unused tables Lee Jones
2021-04-14 18:10 ` [PATCH 13/57] staging: rtl8723bs: core: rtw_recv: Mark debug variable as __maybe_unused Lee Jones
2021-04-14 18:10 ` [PATCH 14/57] staging: rtl8188eu: core: rtw_security: Fix some formatting and misdocumentation Lee Jones
2021-04-14 18:10 ` [PATCH 15/57] staging: rtl8723bs: core: rtw_security: Demote non-conformant kernel-doc header Lee Jones
2021-04-15  8:09   ` Fabio Aiuto
2021-04-15  8:31     ` Lee Jones
2021-04-15  8:38       ` Fabio Aiuto
2021-04-14 18:10 ` [PATCH 16/57] staging: rtl8723bs: core: rtw_sta_mgt: Remove unused variable 'psta' Lee Jones
2021-04-14 18:10 ` [PATCH 17/57] staging: rtl8723bs: core: rtw_sta_mgt: Return error value directly Lee Jones
2021-04-14 18:10 ` [PATCH 18/57] staging: octeon: ethernet-tx: Fix formatting issue in function header Lee Jones
2021-04-14 18:10 ` [PATCH 19/57] staging: rtl8723bs: core: rtw_wlan_util: Remove unused variable 'start_seq' Lee Jones
2021-04-14 18:10 ` [PATCH 20/57] staging: rtl8712: rtl871x_mp_ioctl: Move a large data struct onto the heap Lee Jones
2021-04-14 18:10 ` [PATCH 21/57] staging: iio: frequency: ad9834: Provide missing description for 'devid' Lee Jones
2021-04-16 17:29   ` Jonathan Cameron
2021-04-14 18:10 ` [PATCH 22/57] staging: nvec: Fix a bunch of kernel-doc issues Lee Jones
2021-04-14 18:10 ` [PATCH 23/57] staging: ks7010: ks_hostif: Remove a bunch of unused variables Lee Jones
2021-04-14 18:10 ` [PATCH 24/57] staging: fwserial: Demote a whole host of kernel-doc abuses Lee Jones
2021-04-14 18:10 ` [PATCH 25/57] staging: sm750fb: sm750_accel: Provide description for 'accel' and fix function naming Lee Jones
2021-04-14 18:10 ` [PATCH 26/57] staging: most: net: Fix some kernel-doc formatting issues Lee Jones
2021-04-14 18:10 ` [PATCH 27/57] staging: vt6655: upc: Suppress set but not used warning in macro Lee Jones
2021-04-14 18:11 ` [PATCH 28/57] staging: rtl8192u: ieee80211_softmac: Move a large data struct onto the heap Lee Jones
2021-04-14 18:11 ` Lee Jones [this message]
2021-04-14 18:11 ` [PATCH 30/57] staging: rtl8723bs: core: rtw_ieee80211: Remove seemingly pointless copy Lee Jones
2021-04-14 18:11 ` [PATCH 31/57] staging: rtl8723bs: core: rtw_mlme: 'retry' is only used if REJOIN is set Lee Jones
2021-04-14 18:11 ` [PATCH 32/57] staging: rtl8723bs: core: rtw_mlme_ext: 'evt_seq' is only used if CHECK_EVENT_SEQ " Lee Jones
2021-04-14 18:11 ` [PATCH 33/57] staging: most: i2c: Fix a little doc-rot Lee Jones
2021-04-14 18:11 ` [PATCH 34/57] staging: most: dim2: hal: Fix one kernel-doc header and demote two non-conforming ones Lee Jones
2021-04-14 18:11 ` [PATCH 35/57] staging: most: dim2: hal: Demote non-conformant kernel-doc headers Lee Jones
2021-04-14 18:11 ` [PATCH 36/57] staging: axis-fifo: axis-fifo: Fix some formatting issues Lee Jones
2021-04-14 18:11 ` [PATCH 37/57] staging: rtl8188eu: os_dep: ioctl_linux: Move 2 large data buffers into the heap Lee Jones
2021-04-15  5:20   ` Dan Carpenter
2021-04-15  5:25     ` Dan Carpenter
2021-04-15  5:25       ` Dan Carpenter
2021-04-19 14:05       ` Arnd Bergmann
2021-04-15  5:53     ` Dan Carpenter
2021-04-15  8:32       ` Lee Jones
2021-04-14 18:11 ` [PATCH 38/57] staging: fbtft: fb_ili9320: Remove unused variable 'ret' Lee Jones
2021-04-14 18:11   ` Lee Jones
2021-04-14 18:11 ` [PATCH 39/57] staging: rtl8723bs: core: rtw_ieee80211: Fix incorrectly named function Lee Jones
2021-04-14 18:11 ` [PATCH 40/57] staging: rtl8723bs: hal: odm_NoiseMonitor: Remove unused variable and dead code Lee Jones
2021-04-14 18:11 ` [PATCH 41/57] staging: rtl8188eu: os_dep: mon: Demote non-conforming kernel-doc headers Lee Jones
2021-04-14 18:11 ` [PATCH 42/57] staging: rtl8188eu: os_dep: rtw_android: Demote kernel-doc abuse Lee Jones
2021-04-14 18:11 ` [PATCH 43/57] staging: rtl8723bs: hal: rtl8723b_hal_init: Remove unused variable and dead code Lee Jones
2021-04-14 18:11 ` [PATCH 44/57] staging: rtl8723bs: hal: rtl8723b_phycfg: Fix a bunch of misnamed functions Lee Jones
2021-04-14 18:11 ` [PATCH 45/57] staging: rtl8723bs: hal: sdio_halinit: 'start' is only used if debug is enabled Lee Jones
2021-04-14 18:11 ` [PATCH 46/57] staging: rtl8723bs: hal: sdio_ops: Mark used 'err' as __maybe_unused and remove another Lee Jones
2021-04-14 18:11 ` [PATCH 47/57] staging: rtl8723bs: os_dep: ioctl_cfg80211: 'ack' is used when debug is enabled Lee Jones
2021-04-14 18:11 ` [PATCH 48/57] staging: comedi: drivers: jr3_pci: Remove set but unused variable 'min_full_scale' Lee Jones
2021-04-15  9:33   ` Ian Abbott
2021-04-15  9:52     ` Lee Jones
2021-04-14 18:11 ` [PATCH 49/57] staging: comedi: drivers: ni_tio: Fix slightly broken kernel-doc and demote others Lee Jones
2021-04-14 18:11 ` [PATCH 50/57] staging: comedi: drivers: ni_routes: Demote non-conforming kernel-doc headers Lee Jones
2021-04-14 18:11 ` [PATCH 51/57] staging: axis-fifo: axis-fifo: Fix function naming in the documentation Lee Jones
2021-04-14 18:11 ` [PATCH 52/57] staging: rtl8723bs: hal: odm_NoiseMonitor: Remove unused variable 'func_start' Lee Jones
2021-04-14 18:11 ` [PATCH 53/57] staging: rtl8723bs: core: rtw_mlme_ext: Move very large data buffer onto the heap Lee Jones
2021-04-14 18:11 ` [PATCH 54/57] staging: rtl8723bs: hal: rtl8723b_hal_init: Mark a bunch of debug variables as __maybe_unused Lee Jones
2021-04-14 18:11 ` [PATCH 55/57] staging: comedi: drivers: ni_mio_common: Move 'range_ni_E_ao_ext' to where it is used Lee Jones
2021-04-15  6:55   ` Uwe Kleine-König
2021-04-15  8:34     ` Lee Jones
2021-04-15  9:39   ` Ian Abbott
2021-04-15  9:54     ` Lee Jones
2021-04-14 18:11 ` [PATCH 56/57] staging: comedi: drivers: comedi_isadma: Fix misspelling of 'dma_chan1' Lee Jones
2021-04-14 18:11 ` [PATCH 57/57] staging: rtl8723bs: hal: sdio_halinit: Remove unused variable 'ret' Lee Jones
2021-04-15  9:16   ` Fabio Aiuto
2021-04-15  9:53     ` Lee Jones
2021-04-16  7:27 ` [PATCH 00/57] Rid W=1 warnings from Staging Fabio Aiuto
2021-04-16  7:27   ` Fabio Aiuto
2021-04-16  7:31   ` Greg Kroah-Hartman
2021-04-16  7:31     ` Greg Kroah-Hartman
2021-04-27  9:31 ` Greg Kroah-Hartman
2021-04-27  9:31   ` Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210414181129.1628598-30-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=andrey.shvetsov@k2l.de \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=nfraprado@protonmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.