Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

scsi: lpfc: Correct some pretty obvious misdocumentation

Either due to API slippage before the driver was mainlined or copy/paste
errors.

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

drivers/scsi/lpfc/lpfc_nvme.c:254: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_create_queue'
drivers/scsi/lpfc/lpfc_nvme.c:254: warning: Function parameter or member 'qsize' not described in 'lpfc_nvme_create_queue'
drivers/scsi/lpfc/lpfc_nvme.c:254: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_create_queue'
drivers/scsi/lpfc/lpfc_nvme.c:311: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_delete_queue'
drivers/scsi/lpfc/lpfc_nvme.c:311: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_delete_queue'
drivers/scsi/lpfc/lpfc_nvme.c:689: warning: Function parameter or member 'gen_req_cmp' not described in '__lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:801: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:801: warning: Function parameter or member 'pnvme_rport' not described in 'lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:801: warning: Function parameter or member 'pnvme_lsreq' not described in 'lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:801: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:801: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_ls_req'
drivers/scsi/lpfc/lpfc_nvme.c:937: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_ls_abort'
drivers/scsi/lpfc/lpfc_nvme.c:937: warning: Function parameter or member 'pnvme_rport' not described in 'lpfc_nvme_ls_abort'
drivers/scsi/lpfc/lpfc_nvme.c:937: warning: Function parameter or member 'pnvme_lsreq' not described in 'lpfc_nvme_ls_abort'
drivers/scsi/lpfc/lpfc_nvme.c:937: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_ls_abort'
drivers/scsi/lpfc/lpfc_nvme.c:937: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_ls_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Function parameter or member 'phba' not described in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Function parameter or member 'pwqeIn' not described in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Function parameter or member 'wcqe' not described in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1075: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_io_cmd_wqe_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Function parameter or member 'vport' not described in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Function parameter or member 'lpfc_ncmd' not described in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Function parameter or member 'pnode' not described in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Function parameter or member 'cstat' not described in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Excess function parameter 'lpfc_nvme_fcreq' description in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1313: warning: Excess function parameter 'hw_queue_handle' description in 'lpfc_nvme_prep_io_cmd'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Function parameter or member 'vport' not described in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Function parameter or member 'lpfc_ncmd' not described in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Excess function parameter 'lpfc_nvme_fcreq' description in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1420: warning: Excess function parameter 'hw_queue_handle' description in 'lpfc_nvme_prep_io_dma'
drivers/scsi/lpfc/lpfc_nvme.c:1598: warning: bad line: indicated in @lpfc_nvme_rport.
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Function parameter or member 'pnvme_rport' not described in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Function parameter or member 'pnvme_fcreq' not described in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1609: warning: Excess function parameter 'lpfc_nvme_fcreq' description in 'lpfc_nvme_fcp_io_submit'
drivers/scsi/lpfc/lpfc_nvme.c:1856: warning: Function parameter or member 'abts_cmpl' not described in 'lpfc_nvme_abort_fcreq_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1856: warning: Excess function parameter 'rspiocb' description in 'lpfc_nvme_abort_fcreq_cmpl'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Function parameter or member 'pnvme_lport' not described in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Function parameter or member 'pnvme_rport' not described in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Function parameter or member 'pnvme_fcreq' not described in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Excess function parameter 'lpfc_pnvme' description in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Excess function parameter 'lpfc_nvme_lport' description in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Excess function parameter 'lpfc_nvme_rport' description in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:1892: warning: Excess function parameter 'lpfc_nvme_fcreq' description in 'lpfc_nvme_fcp_abort'
drivers/scsi/lpfc/lpfc_nvme.c:2093: warning: Function parameter or member 'ndlp' not described in 'lpfc_get_nvme_buf'
drivers/scsi/lpfc/lpfc_nvme.c:2093: warning: Function parameter or member 'idx' not described in 'lpfc_get_nvme_buf'
drivers/scsi/lpfc/lpfc_nvme.c:2093: warning: Function parameter or member 'expedite' not described in 'lpfc_get_nvme_buf'
drivers/scsi/lpfc/lpfc_nvme.c:2197: warning: Function parameter or member 'vport' not described in 'lpfc_nvme_create_localport'
drivers/scsi/lpfc/lpfc_nvme.c:2330: warning: Function parameter or member 'vport' not described in 'lpfc_nvme_destroy_localport'
drivers/scsi/lpfc/lpfc_nvme.c:2330: warning: Excess function parameter 'pnvme' description in 'lpfc_nvme_destroy_localport'
drivers/scsi/lpfc/lpfc_nvme.c:2543: warning: Function parameter or member 'vport' not described in 'lpfc_nvme_rescan_port'
drivers/scsi/lpfc/lpfc_nvme.c:2543: warning: Function parameter or member 'ndlp' not described in 'lpfc_nvme_rescan_port'

Link: https://lore.kernel.org/r/20200713080001.128044-21-lee.jones@linaro.org
Cc: James Smart <james.smart@broadcom.com>
Cc: Dick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

authored by

Lee Jones and committed by
Martin K. Petersen
09d99705 7405edfd

+17 -21
+17 -21
drivers/scsi/lpfc/lpfc_nvme.c
··· 234 234 235 235 /** 236 236 * lpfc_nvme_create_queue - 237 + * @pnvme_lport: Transport localport that LS is to be issued from 237 238 * @lpfc_pnvme: Pointer to the driver's nvme instance data 238 239 * @qidx: An cpu index used to affinitize IO queues and MSIX vectors. 240 + * @qsize: Size of the queue in bytes 239 241 * @handle: An opaque driver handle used in follow-up calls. 240 242 * 241 243 * Driver registers this routine to preallocate and initialize any ··· 294 292 295 293 /** 296 294 * lpfc_nvme_delete_queue - 297 - * @lpfc_pnvme: Pointer to the driver's nvme instance data 295 + * @pnvme_lport: Transport localport that LS is to be issued from 298 296 * @qidx: An cpu index used to affinitize IO queues and MSIX vectors. 299 297 * @handle: An opaque driver handle from lpfc_nvme_create_queue 300 298 * ··· 674 672 * @vport: The local port issuing the LS 675 673 * @ndlp: The remote port to send the LS to 676 674 * @pnvme_lsreq: Pointer to LS request structure from the transport 675 + * @gen_req_cmp: Completion call-back 677 676 * 678 677 * Routine validates the ndlp, builds buffers and sends a GEN_REQUEST 679 678 * WQE to perform the LS operation. ··· 786 783 787 784 /** 788 785 * lpfc_nvme_ls_req - Issue an NVME Link Service request 789 - * @lpfc_nvme_lport: Transport localport that LS is to be issued from. 790 - * @lpfc_nvme_rport: Transport remoteport that LS is to be sent to. 791 - * @pnvme_lsreq - the transport nvme_ls_req structure for the LS 786 + * @pnvme_lport: Transport localport that LS is to be issued from. 787 + * @nvme_rport: Transport remoteport that LS is to be sent to. 788 + * @pnvme_lsreq: the transport nvme_ls_req structure for the LS 792 789 * 793 790 * Driver registers this routine to handle any link service request 794 791 * from the nvme_fc transport to a remote nvme-aware port. ··· 926 923 927 924 /** 928 925 * lpfc_nvme_ls_abort - Abort a prior NVME LS request 929 - * @lpfc_nvme_lport: Transport localport that LS is to be issued from. 930 - * @lpfc_nvme_rport: Transport remoteport that LS is to be sent to. 931 - * @pnvme_lsreq - the transport nvme_ls_req structure for the LS 926 + * @pnvme_lport: Transport localport that LS is to be issued from. 927 + * @pnvme_rport: Transport remoteport that LS is to be sent to. 928 + * @pnvme_lsreq: the transport nvme_ls_req structure for the LS 932 929 * 933 930 * Driver registers this routine to abort a NVME LS request that is 934 931 * in progress (from the transports perspective). ··· 1058 1055 } 1059 1056 1060 1057 1061 - /** 1058 + /* 1062 1059 * lpfc_nvme_io_cmd_wqe_cmpl - Complete an NVME-over-FCP IO 1063 - * @lpfc_pnvme: Pointer to the driver's nvme instance data 1064 - * @lpfc_nvme_lport: Pointer to the driver's local port data 1065 - * @lpfc_nvme_rport: Pointer to the rport getting the @lpfc_nvme_ereq 1066 1060 * 1067 1061 * Driver registers this routine as it io request handler. This 1068 1062 * routine issues an fcp WQE with data from the @lpfc_nvme_fcpreq ··· 1291 1291 1292 1292 /** 1293 1293 * lpfc_nvme_prep_io_cmd - Issue an NVME-over-FCP IO 1294 - * @lpfc_pnvme: Pointer to the driver's nvme instance data 1295 - * @lpfc_nvme_lport: Pointer to the driver's local port data 1296 - * @lpfc_nvme_rport: Pointer to the rport getting the @lpfc_nvme_ereq 1297 - * @lpfc_nvme_fcreq: IO request from nvme fc to driver. 1298 - * @hw_queue_handle: Driver-returned handle in lpfc_nvme_create_queue 1294 + * @vport: pointer to a host virtual N_Port data structure 1295 + * @lpfcn_cmd: Pointer to lpfc scsi command 1296 + * @pnode: pointer to a node-list data structure 1297 + * @cstat: pointer to the control status structure 1299 1298 * 1300 1299 * Driver registers this routine as it io request handler. This 1301 1300 * routine issues an fcp WQE with data from the @lpfc_nvme_fcpreq ··· 1399 1400 1400 1401 /** 1401 1402 * lpfc_nvme_prep_io_dma - Issue an NVME-over-FCP IO 1402 - * @lpfc_pnvme: Pointer to the driver's nvme instance data 1403 - * @lpfc_nvme_lport: Pointer to the driver's local port data 1404 - * @lpfc_nvme_rport: Pointer to the rport getting the @lpfc_nvme_ereq 1405 - * @lpfc_nvme_fcreq: IO request from nvme fc to driver. 1406 - * @hw_queue_handle: Driver-returned handle in lpfc_nvme_create_queue 1403 + * @vport: pointer to a host virtual N_Port data structure 1404 + * @lpfcn_cmd: Pointer to lpfc scsi command 1407 1405 * 1408 1406 * Driver registers this routine as it io request handler. This 1409 1407 * routine issues an fcp WQE with data from the @lpfc_nvme_fcpreq