Commit f8e9a970 authored by Lee Jones's avatar Lee Jones Committed by Jason Gunthorpe

RDMA/sw/rdmavt/qp: Fix a bunch of kernel-doc misdemeanours

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

 drivers/infiniband/sw/rdmavt/qp.c:165: warning: Function parameter or member 'rdi' not described in 'rvt_wss_init'
 drivers/infiniband/sw/rdmavt/qp.c:329: warning: Function parameter or member 'rdi' not described in 'init_qpn_table'
 drivers/infiniband/sw/rdmavt/qp.c:534: warning: Function parameter or member 'type' not described in 'alloc_qpn'
 drivers/infiniband/sw/rdmavt/qp.c:664: warning: Function parameter or member 'wqe' not described in 'rvt_swqe_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:664: warning: Function parameter or member 'lkey' not described in 'rvt_swqe_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:682: warning: Function parameter or member 'qp' not described in 'rvt_qp_sends_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:682: warning: Function parameter or member 'lkey' not described in 'rvt_qp_sends_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:706: warning: Function parameter or member 'qp' not described in 'rvt_qp_acks_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:706: warning: Function parameter or member 'lkey' not described in 'rvt_qp_acks_has_lkey'
 drivers/infiniband/sw/rdmavt/qp.c:866: warning: Function parameter or member 'rdi' not described in 'rvt_init_qp'
 drivers/infiniband/sw/rdmavt/qp.c:920: warning: Function parameter or member 'rdi' not described in '_rvt_reset_qp'
 drivers/infiniband/sw/rdmavt/qp.c:1736: warning: Function parameter or member 'udata' not described in 'rvt_destroy_qp'
 drivers/infiniband/sw/rdmavt/qp.c:1924: warning: Function parameter or member 'qp' not described in 'rvt_qp_valid_operation'
 drivers/infiniband/sw/rdmavt/qp.c:1924: warning: Function parameter or member 'post_parms' not described in 'rvt_qp_valid_operation'
 drivers/infiniband/sw/rdmavt/qp.c:1924: warning: Function parameter or member 'wr' not described in 'rvt_qp_valid_operation'
 drivers/infiniband/sw/rdmavt/qp.c:2020: warning: Function parameter or member 'call_send' not described in 'rvt_post_one_wr'
 drivers/infiniband/sw/rdmavt/qp.c:2621: warning: Function parameter or member 'qp' not described in 'rvt_stop_rnr_timer'

Link: https://lore.kernel.org/r/20210121094519.2044049-31-lee.jones@linaro.org
Cc: Dennis Dalessandro <dennis.dalessandro@cornelisnetworks.com>
Cc: Mike Marciniszyn <mike.marciniszyn@cornelisnetworks.com>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
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 71f964c3
...@@ -156,7 +156,7 @@ void rvt_wss_exit(struct rvt_dev_info *rdi) ...@@ -156,7 +156,7 @@ void rvt_wss_exit(struct rvt_dev_info *rdi)
rdi->wss = NULL; rdi->wss = NULL;
} }
/** /*
* rvt_wss_init - Init wss data structures * rvt_wss_init - Init wss data structures
* *
* Return: 0 on success * Return: 0 on success
...@@ -323,6 +323,7 @@ static void get_map_page(struct rvt_qpn_table *qpt, ...@@ -323,6 +323,7 @@ static void get_map_page(struct rvt_qpn_table *qpt,
/** /**
* init_qpn_table - initialize the QP number table for a device * init_qpn_table - initialize the QP number table for a device
* @rdi: rvt dev struct
* @qpt: the QPN table * @qpt: the QPN table
*/ */
static int init_qpn_table(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt) static int init_qpn_table(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt)
...@@ -524,6 +525,7 @@ static inline unsigned mk_qpn(struct rvt_qpn_table *qpt, ...@@ -524,6 +525,7 @@ static inline unsigned mk_qpn(struct rvt_qpn_table *qpt,
* IB_QPT_SMI/IB_QPT_GSI * IB_QPT_SMI/IB_QPT_GSI
* @rdi: rvt device info structure * @rdi: rvt device info structure
* @qpt: queue pair number table pointer * @qpt: queue pair number table pointer
* @type: the QP type
* @port_num: IB port number, 1 based, comes from core * @port_num: IB port number, 1 based, comes from core
* @exclude_prefix: prefix of special queue pair number being allocated * @exclude_prefix: prefix of special queue pair number being allocated
* *
...@@ -655,8 +657,8 @@ static void rvt_clear_mr_refs(struct rvt_qp *qp, int clr_sends) ...@@ -655,8 +657,8 @@ static void rvt_clear_mr_refs(struct rvt_qp *qp, int clr_sends)
/** /**
* rvt_swqe_has_lkey - return true if lkey is used by swqe * rvt_swqe_has_lkey - return true if lkey is used by swqe
* @wqe - the send wqe * @wqe: the send wqe
* @lkey - the lkey * @lkey: the lkey
* *
* Test the swqe for using lkey * Test the swqe for using lkey
*/ */
...@@ -675,8 +677,8 @@ static bool rvt_swqe_has_lkey(struct rvt_swqe *wqe, u32 lkey) ...@@ -675,8 +677,8 @@ static bool rvt_swqe_has_lkey(struct rvt_swqe *wqe, u32 lkey)
/** /**
* rvt_qp_sends_has_lkey - return true is qp sends use lkey * rvt_qp_sends_has_lkey - return true is qp sends use lkey
* @qp - the rvt_qp * @qp: the rvt_qp
* @lkey - the lkey * @lkey: the lkey
*/ */
static bool rvt_qp_sends_has_lkey(struct rvt_qp *qp, u32 lkey) static bool rvt_qp_sends_has_lkey(struct rvt_qp *qp, u32 lkey)
{ {
...@@ -699,8 +701,8 @@ static bool rvt_qp_sends_has_lkey(struct rvt_qp *qp, u32 lkey) ...@@ -699,8 +701,8 @@ static bool rvt_qp_sends_has_lkey(struct rvt_qp *qp, u32 lkey)
/** /**
* rvt_qp_acks_has_lkey - return true if acks have lkey * rvt_qp_acks_has_lkey - return true if acks have lkey
* @qp - the qp * @qp: the qp
* @lkey - the lkey * @lkey: the lkey
*/ */
static bool rvt_qp_acks_has_lkey(struct rvt_qp *qp, u32 lkey) static bool rvt_qp_acks_has_lkey(struct rvt_qp *qp, u32 lkey)
{ {
...@@ -716,10 +718,10 @@ static bool rvt_qp_acks_has_lkey(struct rvt_qp *qp, u32 lkey) ...@@ -716,10 +718,10 @@ static bool rvt_qp_acks_has_lkey(struct rvt_qp *qp, u32 lkey)
return false; return false;
} }
/* /**
* rvt_qp_mr_clean - clean up remote ops for lkey * rvt_qp_mr_clean - clean up remote ops for lkey
* @qp - the qp * @qp: the qp
* @lkey - the lkey that is being de-registered * @lkey: the lkey that is being de-registered
* *
* This routine checks if the lkey is being used by * This routine checks if the lkey is being used by
* the qp. * the qp.
...@@ -853,6 +855,7 @@ int rvt_alloc_rq(struct rvt_rq *rq, u32 size, int node, ...@@ -853,6 +855,7 @@ int rvt_alloc_rq(struct rvt_rq *rq, u32 size, int node,
/** /**
* rvt_init_qp - initialize the QP state to the reset state * rvt_init_qp - initialize the QP state to the reset state
* @rdi: rvt dev struct
* @qp: the QP to init or reinit * @qp: the QP to init or reinit
* @type: the QP type * @type: the QP type
* *
...@@ -907,6 +910,7 @@ static void rvt_init_qp(struct rvt_dev_info *rdi, struct rvt_qp *qp, ...@@ -907,6 +910,7 @@ static void rvt_init_qp(struct rvt_dev_info *rdi, struct rvt_qp *qp,
/** /**
* _rvt_reset_qp - initialize the QP state to the reset state * _rvt_reset_qp - initialize the QP state to the reset state
* @rdi: rvt dev struct
* @qp: the QP to reset * @qp: the QP to reset
* @type: the QP type * @type: the QP type
* *
...@@ -1726,6 +1730,7 @@ int rvt_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr, ...@@ -1726,6 +1730,7 @@ int rvt_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
/** /**
* rvt_destroy_qp - destroy a queue pair * rvt_destroy_qp - destroy a queue pair
* @ibqp: the queue pair to destroy * @ibqp: the queue pair to destroy
* @udata: unused by the driver
* *
* Note that this can be called while the QP is actively sending or * Note that this can be called while the QP is actively sending or
* receiving! * receiving!
...@@ -1901,9 +1906,9 @@ int rvt_post_recv(struct ib_qp *ibqp, const struct ib_recv_wr *wr, ...@@ -1901,9 +1906,9 @@ int rvt_post_recv(struct ib_qp *ibqp, const struct ib_recv_wr *wr,
/** /**
* rvt_qp_valid_operation - validate post send wr request * rvt_qp_valid_operation - validate post send wr request
* @qp - the qp * @qp: the qp
* @post-parms - the post send table for the driver * @post_parms_ the post send table for the driver
* @wr - the work request * @wr: the work request
* *
* The routine validates the operation based on the * The routine validates the operation based on the
* validation table an returns the length of the operation * validation table an returns the length of the operation
...@@ -2013,6 +2018,7 @@ static inline int rvt_qp_is_avail( ...@@ -2013,6 +2018,7 @@ static inline int rvt_qp_is_avail(
* rvt_post_one_wr - post one RC, UC, or UD send work request * rvt_post_one_wr - post one RC, UC, or UD send work request
* @qp: the QP to post on * @qp: the QP to post on
* @wr: the work request to send * @wr: the work request to send
* @call_send: kick the send engine into gear
*/ */
static int rvt_post_one_wr(struct rvt_qp *qp, static int rvt_post_one_wr(struct rvt_qp *qp,
const struct ib_send_wr *wr, const struct ib_send_wr *wr,
...@@ -2612,7 +2618,7 @@ EXPORT_SYMBOL(rvt_stop_rc_timers); ...@@ -2612,7 +2618,7 @@ EXPORT_SYMBOL(rvt_stop_rc_timers);
/** /**
* rvt_stop_rnr_timer - stop an rnr timer * rvt_stop_rnr_timer - stop an rnr timer
* @qp - the QP * @qp: the QP
* *
* stop an rnr timer and return if the timer * stop an rnr timer and return if the timer
* had been pending. * had been pending.
......
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