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

infiniband: fix ulp/iser/iscsi_iser.h kernel-doc warnings 

Fix kernel-doc warnings and typos/spellos.

../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'dma_addr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'cqe' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'reg_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'send_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'inv_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:277: warning: Function parameter or member 'cqe' not described in 'iser_rx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:296: warning: Function parameter or member 'rsp' not described in 'iser_login_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:339: warning: Function parameter or member 'reg_mem' not described in 'iser_reg_ops'
../drivers/infiniband/ulp/iser/iscsi_iser.h:399: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:413: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'
../drivers/infiniband/ulp/iser/iscsi_iser.h:439: warning: Function parameter or member 'reg_cqe' not described in 'ib_conn'
../drivers/infiniband/ulp/iser/iscsi_iser.h:491: warning: Function parameter or member 'snd_w_inv' not described in 'iser_conn'

This leaves 2 "member not described" warnings that I don't know how to fix:

../drivers/infiniband/ulp/iser/iscsi_iser.h:401: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:415: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'

Link: https://lore.kernel.org/r/20191010035239.756365352@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 526f2c50

drivers/infiniband/ulp/iser/iscsi_iser.h

+11 −7
Original line number Diff line number Diff line
@@ -228,15 +228,16 @@ enum iser_desc_type { 
 * @iser_header:   iser header

 * @iscsi_header:  iscsi header

 * @type:          command/control/dataout

 * @dam_addr:      header buffer dma_address

 * @dma_addr:      header buffer dma_address

 * @tx_sg:         sg[0] points to iser/iscsi headers

 *                 sg[1] optionally points to either of immediate data

 *                 unsolicited data-out or control

 * @num_sge:       number sges used on this TX task

 * @cqe:           completion handler

 * @mapped:        Is the task header mapped

 * reg_wr:         registration WR

 * send_wr:        send WR

 * inv_wr:         invalidate WR

 * @reg_wr:        registration WR

 * @send_wr:       send WR

 * @inv_wr:        invalidate WR

 */

struct iser_tx_desc {

	struct iser_ctrl             iser_header;
@@ -263,6 +264,7 @@ struct iser_tx_desc { 
 * @data:          received data segment

 * @dma_addr:      receive buffer dma address

 * @rx_sg:         ib_sge of receive buffer

 * @cqe:           completion handler

 * @pad:           for sense data TODO: Modify to maximum sense length supported

 */

struct iser_rx_desc {
@@ -279,7 +281,7 @@ struct iser_rx_desc { 
 * struct iser_login_desc - iSER login descriptor

 *

 * @req:           pointer to login request buffer

 * @resp:          pointer to login response buffer

 * @rsp:           pointer to login response buffer

 * @req_dma:       DMA address of login request buffer

 * @rsp_dma:       DMA address of login response buffer

 * @sge:           IB sge for login post recv
@@ -316,7 +318,7 @@ struct iser_comp { 
 *

 * @alloc_reg_res:     Allocate registration resources

 * @free_reg_res:      Free registration resources

 * @fast_reg_mem:      Register memory buffers

 * @reg_mem:           Register memory buffers

 * @unreg_mem:         Un-register memory buffers

 * @reg_desc_get:      Get a registration descriptor for pool

 * @reg_desc_put:      Get a registration descriptor to pool
@@ -423,6 +425,7 @@ struct iser_fr_pool { 
 * @comp:                iser completion context

 * @fr_pool:             connection fast registration poool

 * @pi_support:          Indicate device T10-PI support

 * @reg_cqe:             completion handler

 */

struct ib_conn {

	struct rdma_cm_id           *cma_id;
@@ -463,6 +466,7 @@ struct ib_conn { 
 * @num_rx_descs:     number of rx descriptors

 * @scsi_sg_tablesize: scsi host sg_tablesize

 * @pages_per_mr:     maximum pages available for registration

 * @snd_w_inv:        connection uses remote invalidation

 */

struct iser_conn {

	struct ib_conn		     ib_conn;