openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

scsi: be2iscsi: Fix API/documentation slip 

And add descriptions for a couple of missing function parameters.

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

 drivers/scsi/be2iscsi/be_iscsi.c:38: warning: Function parameter or member 'ep' not described in 'beiscsi_session_create'
 drivers/scsi/be2iscsi/be_iscsi.c:173: warning: Function parameter or member 'is_leading' not described in 'beiscsi_conn_bind'
 drivers/scsi/be2iscsi/be_iscsi.c:998: warning: Function parameter or member 'beiscsi_ep' not described in 'beiscsi_free_ep'
 drivers/scsi/be2iscsi/be_iscsi.c:998: warning: Excess function parameter 'ep' description in 'beiscsi_free_ep'
 drivers/scsi/be2iscsi/be_iscsi.c:1039: warning: Function parameter or member 'non_blocking' not described in 'beiscsi_open_conn'
 drivers/scsi/be2iscsi/be_iscsi.c:1135: warning: Function parameter or member 'shost' not described in 'beiscsi_ep_connect'
 drivers/scsi/be2iscsi/be_iscsi.c:1135: warning: Excess function parameter 'scsi_host' description in 'beiscsi_ep_connect'
 drivers/scsi/be2iscsi/be_iscsi.c:1236: warning: Function parameter or member 'beiscsi_ep' not described in 'beiscsi_conn_close'
 drivers/scsi/be2iscsi/be_iscsi.c:1236: warning: Excess function parameter 'ep' description in 'beiscsi_conn_close'

Link: https://lore.kernel.org/r/20200713080001.128044-18-lee.jones@linaro.org
Cc: Subbu Seetharaman <subbu.seetharaman@broadcom.com>
Cc: Ketan Mukadam <ketan.mukadam@broadcom.com>
Cc: Jitendra Bhivare <jitendra.bhivare@broadcom.com>
Cc: linux-drivers@broadcom.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Lee Jones 2020-07-13 08:59:54 +01:00 committed by Martin K. Petersen
parent 8a692fdb1d
commit abad069ef0
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
drivers/scsi/be2iscsi/be_iscsi.c
View File

@ -27,6 +27,7 @@ extern struct iscsi_transport beiscsi_iscsi_transport;
/** /**
* beiscsi_session_create - creates a new iscsi session * beiscsi_session_create - creates a new iscsi session
* @ep: pointer to iscsi ep
* @cmds_max: max commands supported * @cmds_max: max commands supported
* @qdepth: max queue depth supported * @qdepth: max queue depth supported
* @initial_cmdsn: initial iscsi CMDSN * @initial_cmdsn: initial iscsi CMDSN
@ -164,6 +165,7 @@ beiscsi_conn_create(struct iscsi_cls_session *cls_session, u32 cid)
* @cls_session: pointer to iscsi cls session * @cls_session: pointer to iscsi cls session
* @cls_conn: pointer to iscsi cls conn * @cls_conn: pointer to iscsi cls conn
* @transport_fd: EP handle(64 bit) * @transport_fd: EP handle(64 bit)
* @is_leading: indicate if this is the session leading connection (MCS)
* *
* This function binds the TCP Conn with iSCSI Connection and Session. * This function binds the TCP Conn with iSCSI Connection and Session.
*/ */
@ -992,7 +994,7 @@ static void beiscsi_put_cid(struct beiscsi_hba *phba, unsigned short cid)
/** /**
* beiscsi_free_ep - free endpoint * beiscsi_free_ep - free endpoint
* @ep: pointer to iscsi endpoint structure * @beiscsi_ep: pointer to device endpoint struct
*/ */
static void beiscsi_free_ep(struct beiscsi_endpoint *beiscsi_ep) static void beiscsi_free_ep(struct beiscsi_endpoint *beiscsi_ep)
{ {
@ -1027,9 +1029,10 @@ static void beiscsi_free_ep(struct beiscsi_endpoint *beiscsi_ep)
/** /**
* beiscsi_open_conn - Ask FW to open a TCP connection * beiscsi_open_conn - Ask FW to open a TCP connection
* @ep: endpoint to be used * @beiscsi_ep: pointer to device endpoint struct
* @src_addr: The source IP address * @src_addr: The source IP address
* @dst_addr: The Destination IP address * @dst_addr: The Destination IP address
* @non_blocking: blocking or non-blocking call
* *
* Asks the FW to open a TCP connection * Asks the FW to open a TCP connection
*/ */
@ -1123,7 +1126,7 @@ static int beiscsi_open_conn(struct iscsi_endpoint *ep,
/** /**
* beiscsi_ep_connect - Ask chip to create TCP Conn * beiscsi_ep_connect - Ask chip to create TCP Conn
* @scsi_host: Pointer to scsi_host structure * @shost: Pointer to scsi_host structure
* @dst_addr: The IP address of Target * @dst_addr: The IP address of Target
* @non_blocking: blocking or non-blocking call * @non_blocking: blocking or non-blocking call
* *
@ -1228,7 +1231,7 @@ static void beiscsi_flush_cq(struct beiscsi_hba *phba)
/** /**
* beiscsi_conn_close - Invalidate and upload connection * beiscsi_conn_close - Invalidate and upload connection
* @ep: The iscsi endpoint * @beiscsi_ep: pointer to device endpoint struct
* *
* Returns 0 on success, -1 on failure. * Returns 0 on success, -1 on failure.
*/ */