Commit 7c21072d authored by rd.dunlab@gmail.com's avatar rd.dunlab@gmail.com Committed by Jason Gunthorpe
Browse files

infiniband: fix sw/rdmavt/ kernel-doc notation 

Add kernel-doc for missing function parameters.
Remove excess kernel-doc descriptions.
Fix expected kernel-doc formatting (use ':' instead of '-' after @funcarg).

../drivers/infiniband/sw/rdmavt/ah.c:138: warning: Excess function parameter 'udata' description in 'rvt_destroy_ah'
../drivers/infiniband/sw/rdmavt/vt.c:698: warning: Function parameter or member 'pkey_table' not described in 'rvt_init_port'
../drivers/infiniband/sw/rdmavt/cq.c:561: warning: Excess function parameter 'rdi' description in 'rvt_driver_cq_init'
../drivers/infiniband/sw/rdmavt/cq.c:575: warning: Excess function parameter 'rdi' description in 'rvt_cq_exit'
../drivers/infiniband/sw/rdmavt/qp.c:2573: warning: Function parameter or member 'qp' not described in 'rvt_add_rnr_timer'
../drivers/infiniband/sw/rdmavt/qp.c:2573: warning: Function parameter or member 'aeth' not described in 'rvt_add_rnr_timer'
../drivers/infiniband/sw/rdmavt/qp.c:2591: warning: Function parameter or member 'qp' not described in 'rvt_stop_rc_timers'
../drivers/infiniband/sw/rdmavt/qp.c:2624: warning: Function parameter or member 'qp' not described in 'rvt_del_timers_sync'
../drivers/infiniband/sw/rdmavt/qp.c:2697: warning: Function parameter or member 'cb' not described in 'rvt_qp_iter_init'
../drivers/infiniband/sw/rdmavt/qp.c:2728: warning: Function parameter or member 'iter' not described in 'rvt_qp_iter_next'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'rdi' not described in 'rvt_qp_iter'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'v' not described in 'rvt_qp_iter'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'cb' not described in 'rvt_qp_iter'

Link: https://lore.kernel.org/r/20191010035240.251184229@gmail.com


Signed-off-by: default avatarRandy Dunlap <rd.dunlab@gmail.com>
Reviewed-by: default avatarJason Gunthorpe <jgg@mellanox.com>
Signed-off-by: default avatarJason Gunthorpe <jgg@mellanox.com>
parent d6537c1a

drivers/infiniband/sw/rdmavt/ah.c

+0 −1
Original line number Diff line number Diff line
@@ -129,7 +129,6 @@ int rvt_create_ah(struct ib_ah *ibah, struct rdma_ah_attr *ah_attr, 
 * rvt_destory_ah - Destory an address handle

 * @ibah: address handle

 * @destroy_flags: destroy address handle flags (see enum rdma_destroy_ah_flags)

 * @udata: user data or NULL for kernel object

 *

 * Return: 0 on success

 */

drivers/infiniband/sw/rdmavt/cq.c

+0 −2
Original line number Diff line number Diff line
@@ -552,7 +552,6 @@ int rvt_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *entry) 


/**

 * rvt_driver_cq_init - Init cq resources on behalf of driver

 * @rdi: rvt dev structure

 *

 * Return: 0 on success

 */
@@ -568,7 +567,6 @@ int rvt_driver_cq_init(void) 


/**

 * rvt_cq_exit - tear down cq reources

 * @rdi: rvt dev structure

 */

void rvt_cq_exit(void)

{

drivers/infiniband/sw/rdmavt/qp.c

+15 −15
Original line number Diff line number Diff line
@@ -2563,10 +2563,9 @@ void rvt_add_retry_timer_ext(struct rvt_qp *qp, u8 shift) 
EXPORT_SYMBOL(rvt_add_retry_timer_ext);



/**

 * rvt_add_rnr_timer - add/start an rnr timer

 * @qp - the QP

 * @aeth - aeth of RNR timeout, simulated aeth for loopback

 * add an rnr timer on the QP

 * rvt_add_rnr_timer - add/start an rnr timer on the QP

 * @qp: the QP

 * @aeth: aeth of RNR timeout, simulated aeth for loopback

 */

void rvt_add_rnr_timer(struct rvt_qp *qp, u32 aeth)

{
@@ -2583,7 +2582,7 @@ EXPORT_SYMBOL(rvt_add_rnr_timer); 


/**

 * rvt_stop_rc_timers - stop all timers

 * @qp - the QP

 * @qp: the QP

 * stop any pending timers

 */

void rvt_stop_rc_timers(struct rvt_qp *qp)
@@ -2617,7 +2616,7 @@ static void rvt_stop_rnr_timer(struct rvt_qp *qp) 


/**

 * rvt_del_timers_sync - wait for any timeout routines to exit

 * @qp - the QP

 * @qp: the QP

 */

void rvt_del_timers_sync(struct rvt_qp *qp)

{
@@ -2626,7 +2625,7 @@ void rvt_del_timers_sync(struct rvt_qp *qp) 
}

EXPORT_SYMBOL(rvt_del_timers_sync);



/**

/*

 * This is called from s_timer for missing responses.

 */

static void rvt_rc_timeout(struct timer_list *t)
@@ -2676,12 +2675,13 @@ EXPORT_SYMBOL(rvt_rc_rnr_retry); 
 * rvt_qp_iter_init - initial for QP iteration

 * @rdi: rvt devinfo

 * @v: u64 value

 * @cb: user-defined callback

 *

 * This returns an iterator suitable for iterating QPs

 * in the system.

 *

 * The @cb is a user defined callback and @v is a 64

 * bit value passed to and relevant for processing in the

 * The @cb is a user-defined callback and @v is a 64-bit

 * value passed to and relevant for processing in the

 * @cb.  An example use case would be to alter QP processing

 * based on criteria not part of the rvt_qp.

 *
@@ -2712,7 +2712,7 @@ EXPORT_SYMBOL(rvt_qp_iter_init); 


/**

 * rvt_qp_iter_next - return the next QP in iter

 * @iter - the iterator

 * @iter: the iterator

 *

 * Fine grained QP iterator suitable for use

 * with debugfs seq_file mechanisms.
@@ -2775,14 +2775,14 @@ EXPORT_SYMBOL(rvt_qp_iter_next); 


/**

 * rvt_qp_iter - iterate all QPs

 * @rdi - rvt devinfo

 * @v - a 64 bit value

 * @cb - a callback

 * @rdi: rvt devinfo

 * @v: a 64-bit value

 * @cb: a callback

 *

 * This provides a way for iterating all QPs.

 *

 * The @cb is a user defined callback and @v is a 64

 * bit value passed to and relevant for processing in the

 * The @cb is a user-defined callback and @v is a 64-bit

 * value passed to and relevant for processing in the

 * cb.  An example use case would be to alter QP processing

 * based on criteria not part of the rvt_qp.

 *

drivers/infiniband/sw/rdmavt/vt.c

+2 −1
Original line number Diff line number Diff line
@@ -683,9 +683,10 @@ EXPORT_SYMBOL(rvt_unregister_device); 


/**

 * rvt_init_port - init internal data for driver port

 * @rdi: rvt dev strut

 * @rdi: rvt_dev_info struct

 * @port: rvt port

 * @port_index: 0 based index of ports, different from IB core port num

 * @pkey_table: pkey_table for @port

 *

 * Keep track of a list of ports. No need to have a detach port.

 * They persist until the driver goes away.