Commit 5f442fe4 authored by Lee Jones's avatar Lee Jones Committed by Kalle Valo

ipw2200: Demote lots of nonconformant kerneldoc comments

Lots of these are either completely wrong or do not even attempt to
document any of the parameters.  Others use an incorrect/dated format
which is not recognised by the kernel (... and are also wrong and
suffering from docrot).

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

 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3011: warning: Function parameter or member 'priv' not described in 'ipw_alive'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3693: warning: Incorrect use of kernel-doc format:  * Driver allocates buffers of this size for Rx
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3697: warning: Incorrect use of kernel-doc format:  * ipw_rx_queue_space - Return number of free slots available in queue.
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3700: warning: Function parameter or member 'q' not described in 'ipw_rx_queue_space'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'priv' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'q' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'count' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'read' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'write' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'base' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3743: warning: Function parameter or member 'size' not described in 'ipw_queue_init'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3800: warning: Function parameter or member 'priv' not described in 'ipw_queue_tx_free_tfd'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3800: warning: Function parameter or member 'txq' not described in 'ipw_queue_tx_free_tfd'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3841: warning: Function parameter or member 'priv' not described in 'ipw_queue_tx_free'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3841: warning: Function parameter or member 'txq' not described in 'ipw_queue_tx_free'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:3869: warning: Function parameter or member 'priv' not described in 'ipw_tx_queue_free'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:4474: warning: Function parameter or member 'priv' not described in 'ipw_rx_notification'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:4474: warning: Function parameter or member 'notif' not described in 'ipw_rx_notification'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:4935: warning: Function parameter or member 'priv' not described in 'ipw_queue_reset'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:5008: warning: Function parameter or member 'priv' not described in 'ipw_queue_tx_reclaim'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:5008: warning: Function parameter or member 'txq' not described in 'ipw_queue_tx_reclaim'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:5008: warning: Function parameter or member 'qindex' not described in 'ipw_queue_tx_reclaim'
 drivers/net/wireless/intel/ipw2x00/ipw2200.c:8456: warning: Function parameter or member 'priv' not described in 'ipw_sw_reset'

Cc: Stanislav Yakovlev <stas.yakovlev@gmail.com>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Gerald Combs <gerald@ethereal.com>
Cc: Linux Wireless <ilw@linux.intel.com>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarKalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200814113933.1903438-26-lee.jones@linaro.org
parent 7eae8c73
...@@ -2998,7 +2998,7 @@ static void ipw_remove_current_network(struct ipw_priv *priv) ...@@ -2998,7 +2998,7 @@ static void ipw_remove_current_network(struct ipw_priv *priv)
spin_unlock_irqrestore(&priv->ieee->lock, flags); spin_unlock_irqrestore(&priv->ieee->lock, flags);
} }
/** /*
* Check that card is still alive. * Check that card is still alive.
* Reads debug register from domain0. * Reads debug register from domain0.
* If card is present, pre-defined value should * If card is present, pre-defined value should
...@@ -3113,7 +3113,7 @@ static int ipw_load_ucode(struct ipw_priv *priv, u8 * data, size_t len) ...@@ -3113,7 +3113,7 @@ static int ipw_load_ucode(struct ipw_priv *priv, u8 * data, size_t len)
mdelay(1); mdelay(1);
/* write ucode */ /* write ucode */
/** /*
* @bug * @bug
* Do NOT set indirect address register once and then * Do NOT set indirect address register once and then
* store data to indirect data register in the loop. * store data to indirect data register in the loop.
...@@ -3666,7 +3666,7 @@ static int ipw_load(struct ipw_priv *priv) ...@@ -3666,7 +3666,7 @@ static int ipw_load(struct ipw_priv *priv)
return rc; return rc;
} }
/** /*
* DMA services * DMA services
* *
* Theory of operation * Theory of operation
...@@ -3689,11 +3689,11 @@ static int ipw_load(struct ipw_priv *priv) ...@@ -3689,11 +3689,11 @@ static int ipw_load(struct ipw_priv *priv)
* we only utilize the first data transmit queue (queue1). * we only utilize the first data transmit queue (queue1).
*/ */
/** /*
* Driver allocates buffers of this size for Rx * Driver allocates buffers of this size for Rx
*/ */
/** /*
* ipw_rx_queue_space - Return number of free slots available in queue. * ipw_rx_queue_space - Return number of free slots available in queue.
*/ */
static int ipw_rx_queue_space(const struct ipw_rx_queue *q) static int ipw_rx_queue_space(const struct ipw_rx_queue *q)
...@@ -3724,7 +3724,7 @@ static inline int ipw_queue_inc_wrap(int index, int n_bd) ...@@ -3724,7 +3724,7 @@ static inline int ipw_queue_inc_wrap(int index, int n_bd)
return (++index == n_bd) ? 0 : index; return (++index == n_bd) ? 0 : index;
} }
/** /*
* Initialize common DMA queue structure * Initialize common DMA queue structure
* *
* @param q queue to init * @param q queue to init
...@@ -3788,7 +3788,7 @@ static int ipw_queue_tx_init(struct ipw_priv *priv, ...@@ -3788,7 +3788,7 @@ static int ipw_queue_tx_init(struct ipw_priv *priv,
return 0; return 0;
} }
/** /*
* Free one TFD, those at index [txq->q.last_used]. * Free one TFD, those at index [txq->q.last_used].
* Do NOT advance any indexes * Do NOT advance any indexes
* *
...@@ -3811,7 +3811,7 @@ static void ipw_queue_tx_free_tfd(struct ipw_priv *priv, ...@@ -3811,7 +3811,7 @@ static void ipw_queue_tx_free_tfd(struct ipw_priv *priv,
if (le32_to_cpu(bd->u.data.num_chunks) > NUM_TFD_CHUNKS) { if (le32_to_cpu(bd->u.data.num_chunks) > NUM_TFD_CHUNKS) {
IPW_ERROR("Too many chunks: %i\n", IPW_ERROR("Too many chunks: %i\n",
le32_to_cpu(bd->u.data.num_chunks)); le32_to_cpu(bd->u.data.num_chunks));
/** @todo issue fatal error, it is quite serious situation */ /* @todo issue fatal error, it is quite serious situation */
return; return;
} }
...@@ -3828,7 +3828,7 @@ static void ipw_queue_tx_free_tfd(struct ipw_priv *priv, ...@@ -3828,7 +3828,7 @@ static void ipw_queue_tx_free_tfd(struct ipw_priv *priv,
} }
} }
/** /*
* Deallocate DMA queue. * Deallocate DMA queue.
* *
* Empty queue by removing and destroying all BD's. * Empty queue by removing and destroying all BD's.
...@@ -3860,7 +3860,7 @@ static void ipw_queue_tx_free(struct ipw_priv *priv, struct clx2_tx_queue *txq) ...@@ -3860,7 +3860,7 @@ static void ipw_queue_tx_free(struct ipw_priv *priv, struct clx2_tx_queue *txq)
memset(txq, 0, sizeof(*txq)); memset(txq, 0, sizeof(*txq));
} }
/** /*
* Destroy all DMA queues and structures * Destroy all DMA queues and structures
* *
* @param priv * @param priv
...@@ -4465,7 +4465,7 @@ static void handle_scan_event(struct ipw_priv *priv) ...@@ -4465,7 +4465,7 @@ static void handle_scan_event(struct ipw_priv *priv)
} }
} }
/** /*
* Handle host notification packet. * Handle host notification packet.
* Called from interrupt routine * Called from interrupt routine
*/ */
...@@ -4925,7 +4925,7 @@ static void ipw_rx_notification(struct ipw_priv *priv, ...@@ -4925,7 +4925,7 @@ static void ipw_rx_notification(struct ipw_priv *priv,
} }
} }
/** /*
* Destroys all DMA structures and initialise them again * Destroys all DMA structures and initialise them again
* *
* @param priv * @param priv
...@@ -4934,7 +4934,7 @@ static void ipw_rx_notification(struct ipw_priv *priv, ...@@ -4934,7 +4934,7 @@ static void ipw_rx_notification(struct ipw_priv *priv,
static int ipw_queue_reset(struct ipw_priv *priv) static int ipw_queue_reset(struct ipw_priv *priv)
{ {
int rc = 0; int rc = 0;
/** @todo customize queue sizes */ /* @todo customize queue sizes */
int nTx = 64, nTxCmd = 8; int nTx = 64, nTxCmd = 8;
ipw_tx_queue_free(priv); ipw_tx_queue_free(priv);
/* Tx CMD queue */ /* Tx CMD queue */
...@@ -4990,7 +4990,7 @@ static int ipw_queue_reset(struct ipw_priv *priv) ...@@ -4990,7 +4990,7 @@ static int ipw_queue_reset(struct ipw_priv *priv)
return rc; return rc;
} }
/** /*
* Reclaim Tx queue entries no more used by NIC. * Reclaim Tx queue entries no more used by NIC.
* *
* When FW advances 'R' index, all entries between old and * When FW advances 'R' index, all entries between old and
...@@ -8445,7 +8445,7 @@ static void ipw_rx(struct ipw_priv *priv) ...@@ -8445,7 +8445,7 @@ static void ipw_rx(struct ipw_priv *priv)
#define DEFAULT_SHORT_RETRY_LIMIT 7U #define DEFAULT_SHORT_RETRY_LIMIT 7U
#define DEFAULT_LONG_RETRY_LIMIT 4U #define DEFAULT_LONG_RETRY_LIMIT 4U
/** /*
* ipw_sw_reset * ipw_sw_reset
* @option: options to control different reset behaviour * @option: options to control different reset behaviour
* 0 = reset everything except the 'disable' module_param * 0 = reset everything except the 'disable' module_param
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment