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

infiniband: fix ulp/iser/iser_verbs.c kernel-doc notation 

Various kernel-doc fixes:

- fix typos
- don't use /** for internal structs or functions
- fix Return: kernel-doc formatting
- add kernel-doc notation for missing function parameters

../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or member 'ib_conn' not described in 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or member 'cmds_max' not described in 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or member 'size' not described in 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:221: warning: Function parameter or member 'ib_conn' not described in 'iser_free_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'ib_conn' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'cmds_max' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'size' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:338: warning: Function parameter or member 'ib_conn' not described in 'iser_free_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:568: warning: Function parameter or member 'iser_conn' not described in 'iser_conn_release'
../drivers/infiniband/ulp/iser/iser_verbs.c:603: warning: Function parameter or member 'iser_conn' not described in 'iser_conn_terminate'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'signal' not described in 'iser_post_send'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'ib_conn' not described in 'iser_post_send'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'tx_desc' not described in 'iser_post_send'

Link: https://lore.kernel.org/r/20191010035240.070520193@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 094c88f3

drivers/infiniband/ulp/iser/iser_verbs.c

+38 −22
Original line number Diff line number Diff line
@@ -58,12 +58,12 @@ static void iser_event_handler(struct ib_event_handler *handler, 
		dev_name(&event->device->dev), event->element.port_num);

}



/**

/*

 * iser_create_device_ib_res - creates Protection Domain (PD), Completion

 * Queue (CQ), DMA Memory Region (DMA MR) with the device associated with

 * the adapator.

 * the adaptor.

 *

 * returns 0 on success, -1 on failure

 * Return: 0 on success, -1 on failure

 */

static int iser_create_device_ib_res(struct iser_device *device)

{
@@ -124,9 +124,9 @@ static int iser_create_device_ib_res(struct iser_device *device) 
	return -1;

}



/**

/*

 * iser_free_device_ib_res - destroy/dealloc/dereg the DMA MR,

 * CQ and PD created with the device associated with the adapator.

 * CQ and PD created with the device associated with the adaptor.

 */

static void iser_free_device_ib_res(struct iser_device *device)

{
@@ -149,8 +149,11 @@ static void iser_free_device_ib_res(struct iser_device *device) 


/**

 * iser_alloc_fmr_pool - Creates FMR pool and page_vector

 * @ib_conn: connection RDMA resources

 * @cmds_max: max number of SCSI commands for this connection

 * @size: max number of pages per map request

 *

 * returns 0 on success, or errno code on failure

 * Return: 0 on success, or errno code on failure

 */

int iser_alloc_fmr_pool(struct ib_conn *ib_conn,

			unsigned cmds_max,
@@ -215,6 +218,7 @@ int iser_alloc_fmr_pool(struct ib_conn *ib_conn, 


/**

 * iser_free_fmr_pool - releases the FMR pool and page vec

 * @ib_conn: connection RDMA resources

 */

void iser_free_fmr_pool(struct ib_conn *ib_conn)

{
@@ -295,7 +299,11 @@ static void iser_destroy_fastreg_desc(struct iser_fr_desc *desc) 
/**

 * iser_alloc_fastreg_pool - Creates pool of fast_reg descriptors

 * for fast registration work requests.

 * returns 0 on success, or errno code on failure

 * @ib_conn: connection RDMA resources

 * @cmds_max: max number of SCSI commands for this connection

 * @size: max number of pages per map request

 *

 * Return: 0 on success, or errno code on failure

 */

int iser_alloc_fastreg_pool(struct ib_conn *ib_conn,

			    unsigned cmds_max,
@@ -332,6 +340,7 @@ int iser_alloc_fastreg_pool(struct ib_conn *ib_conn, 


/**

 * iser_free_fastreg_pool - releases the pool of fast_reg descriptors

 * @ib_conn: connection RDMA resources

 */

void iser_free_fastreg_pool(struct ib_conn *ib_conn)

{
@@ -355,10 +364,10 @@ void iser_free_fastreg_pool(struct ib_conn *ib_conn) 
			  fr_pool->size - i);

}



/**

/*

 * iser_create_ib_conn_res - Queue-Pair (QP)

 *

 * returns 0 on success, -1 on failure

 * Return: 0 on success, -1 on failure

 */

static int iser_create_ib_conn_res(struct ib_conn *ib_conn)

{
@@ -436,7 +445,7 @@ static int iser_create_ib_conn_res(struct ib_conn *ib_conn) 
	return ret;

}



/**

/*

 * based on the resolved device node GUID see if there already allocated

 * device for this device. If there's no such, create one.

 */
@@ -487,9 +496,9 @@ static void iser_device_try_release(struct iser_device *device) 
	mutex_unlock(&ig.device_list_mutex);

}



/**

/*

 * Called with state mutex held

 **/

 */

static int iser_conn_state_comp_exch(struct iser_conn *iser_conn,

				     enum iser_conn_state comp,

				     enum iser_conn_state exch)
@@ -561,7 +570,8 @@ static void iser_free_ib_conn_res(struct iser_conn *iser_conn, 
}



/**

 * Frees all conn objects and deallocs conn descriptor

 * iser_conn_release - Frees all conn objects and deallocs conn descriptor

 * @iser_conn: iSER connection context

 */

void iser_conn_release(struct iser_conn *iser_conn)

{
@@ -595,7 +605,10 @@ void iser_conn_release(struct iser_conn *iser_conn) 
}



/**

 * triggers start of the disconnect procedures and wait for them to be done

 * iser_conn_terminate - triggers start of the disconnect procedures and

 * waits for them to be done

 * @iser_conn: iSER connection context

 *

 * Called with state mutex held

 */

int iser_conn_terminate(struct iser_conn *iser_conn)
@@ -632,9 +645,9 @@ int iser_conn_terminate(struct iser_conn *iser_conn) 
	return 1;

}



/**

/*

 * Called with state mutex held

 **/

 */

static void iser_connect_error(struct rdma_cm_id *cma_id)

{

	struct iser_conn *iser_conn;
@@ -684,9 +697,9 @@ iser_calc_scsi_params(struct iser_conn *iser_conn, 
		iser_conn->scsi_sg_tablesize + reserved_mr_pages;

}



/**

/*

 * Called with state mutex held

 **/

 */

static void iser_addr_handler(struct rdma_cm_id *cma_id)

{

	struct iser_device *device;
@@ -732,9 +745,9 @@ static void iser_addr_handler(struct rdma_cm_id *cma_id) 
	}

}



/**

/*

 * Called with state mutex held

 **/

 */

static void iser_route_handler(struct rdma_cm_id *cma_id)

{

	struct rdma_conn_param conn_param;
@@ -1030,9 +1043,12 @@ int iser_post_recvm(struct iser_conn *iser_conn, int count) 




/**

 * iser_start_send - Initiate a Send DTO operation

 * iser_post_send - Initiate a Send DTO operation

 * @ib_conn: connection RDMA resources

 * @tx_desc: iSER TX descriptor

 * @signal: true to send work request as SIGNALED

 *

 * returns 0 on success, -1 on failure

 * Return: 0 on success, -1 on failure

 */

int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc,

		   bool signal)