Commit c5e2ee41 authored by Lee Jones's avatar Lee Jones Committed by Jason Gunthorpe
Browse files

RDMA/hw/i40iw/i40iw_main: Rectify some kernel-doc misdemeanours 

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

 drivers/infiniband/hw/i40iw/i40iw_main.c:192: warning: Function parameter or member 't' not described in 'i40iw_dpc'
 drivers/infiniband/hw/i40iw/i40iw_main.c:192: warning: Excess function parameter 'data' description in 'i40iw_dpc'
 drivers/infiniband/hw/i40iw/i40iw_main.c:206: warning: Function parameter or member 't' not described in 'i40iw_ceq_dpc'
 drivers/infiniband/hw/i40iw/i40iw_main.c:206: warning: Excess function parameter 'data' description in 'i40iw_ceq_dpc'
 drivers/infiniband/hw/i40iw/i40iw_main.c:236: warning: Function parameter or member 'free_hwcqp' not described in 'i40iw_destroy_cqp'
 drivers/infiniband/hw/i40iw/i40iw_main.c:236: warning: Excess function parameter 'create_done' description in 'i40iw_destroy_cqp'
 drivers/infiniband/hw/i40iw/i40iw_main.c:264: warning: Function parameter or member 'msix_vec' not described in 'i40iw_disable_irq'
 drivers/infiniband/hw/i40iw/i40iw_main.c:264: warning: Excess function parameter 'msic_vec' description in 'i40iw_disable_irq'
 drivers/infiniband/hw/i40iw/i40iw_main.c:407: warning: Function parameter or member 'dev' not described in 'i40iw_close_hmc_objects_type'
 drivers/infiniband/hw/i40iw/i40iw_main.c:407: warning: Function parameter or member 'hmc_info' not described in 'i40iw_close_hmc_objects_type'
 drivers/infiniband/hw/i40iw/i40iw_main.c:407: warning: Excess function parameter 'iwdev' description in 'i40iw_close_hmc_objects_type'
 drivers/infiniband/hw/i40iw/i40iw_main.c:443: warning: Function parameter or member 'irq' not described in 'i40iw_ceq_handler'
 drivers/infiniband/hw/i40iw/i40iw_main.c:1786: warning: Function parameter or member 'reset' not described in 'i40iw_close'

Link: https://lore.kernel.org/r/20210118223929.512175-8-lee.jones@linaro.org


Cc: Faisal Latif <faisal.latif@intel.com>
Cc: Shiraz Saleem <shiraz.saleem@intel.com>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: Intel Corporation <e1000-rdma@lists.sourceforge.net>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarJason Gunthorpe <jgg@nvidia.com>
parent 263520f2

drivers/infiniband/hw/i40iw/i40iw_main.c

+8 −5
Original line number Diff line number Diff line
@@ -186,7 +186,7 @@ static void i40iw_enable_intr(struct i40iw_sc_dev *dev, u32 msix_id) 


/**

 * i40iw_dpc - tasklet for aeq and ceq 0

 * @data: iwarp device

 * @t: Timer context to fetch pointer to iwarp device

 */

static void i40iw_dpc(struct tasklet_struct *t)

{
@@ -200,7 +200,7 @@ static void i40iw_dpc(struct tasklet_struct *t) 


/**

 * i40iw_ceq_dpc - dpc handler for CEQ

 * @data: data points to CEQ

 * @t: Timer context to fetch pointer to CEQ data

 */

static void i40iw_ceq_dpc(struct tasklet_struct *t)

{
@@ -227,7 +227,7 @@ static irqreturn_t i40iw_irq_handler(int irq, void *data) 
/**

 * i40iw_destroy_cqp  - destroy control qp

 * @iwdev: iwarp device

 * @create_done: 1 if cqp create poll was success

 * @free_hwcqp: 1 if CQP should be destroyed

 *

 * Issue destroy cqp request and

 * free the resources associated with the cqp
@@ -253,7 +253,7 @@ static void i40iw_destroy_cqp(struct i40iw_device *iwdev, bool free_hwcqp) 
/**

 * i40iw_disable_irqs - disable device interrupts

 * @dev: hardware control device structure

 * @msic_vec: msix vector to disable irq

 * @msix_vec: msix vector to disable irq

 * @dev_id: parameter to pass to free_irq (used during irq setup)

 *

 * The function is called when destroying aeq/ceq
@@ -394,8 +394,9 @@ static enum i40iw_hmc_rsrc_type iw_hmc_obj_types[] = { 


/**

 * i40iw_close_hmc_objects_type - delete hmc objects of a given type

 * @iwdev: iwarp device

 * @dev: iwarp device

 * @obj_type: the hmc object type to be deleted

 * @hmc_info: pointer to the HMC configuration information

 * @is_pf: true if the function is PF otherwise false

 * @reset: true if called before reset

 */
@@ -437,6 +438,7 @@ static void i40iw_del_hmc_objects(struct i40iw_sc_dev *dev, 


/**

 * i40iw_ceq_handler - interrupt handler for ceq

 * @irq: interrupt request number

 * @data: ceq pointer

 */

static irqreturn_t i40iw_ceq_handler(int irq, void *data)
@@ -1777,6 +1779,7 @@ static void i40iw_l2param_change(struct i40e_info *ldev, struct i40e_client *cli 
/**

 * i40iw_close - client interface operation close for iwarp/uda device

 * @ldev: lan device information

 * @reset: true if called before reset

 * @client: client to close

 *

 * Called by the lan driver during the processing of client unregister