mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-05 02:19:51 +00:00
Code Issues Releases Wiki Activity

scsi: bnx2i: Fix a whole host of kerneldoc issues

Browse source 
Mainly renames and docrot issues.

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

 drivers/scsi/bnx2i/bnx2i_hwi.c:194: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_get_rq_buf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:194: warning: Excess function parameter 'conn' description in 'bnx2i_get_rq_buf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:232: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_put_rq_buf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:232: warning: Excess function parameter 'conn' description in 'bnx2i_put_rq_buf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:269: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_ring_sq_dbell'
 drivers/scsi/bnx2i/bnx2i_hwi.c:269: warning: Excess function parameter 'conn' description in 'bnx2i_ring_sq_dbell'
 drivers/scsi/bnx2i/bnx2i_hwi.c:293: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_ring_dbell_update_sq_params'
 drivers/scsi/bnx2i/bnx2i_hwi.c:293: warning: Excess function parameter 'conn' description in 'bnx2i_ring_dbell_update_sq_params'
 drivers/scsi/bnx2i/bnx2i_hwi.c:331: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_login'
 drivers/scsi/bnx2i/bnx2i_hwi.c:331: warning: Function parameter or member 'task' not described in 'bnx2i_send_iscsi_login'
 drivers/scsi/bnx2i/bnx2i_hwi.c:331: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_login'
 drivers/scsi/bnx2i/bnx2i_hwi.c:331: warning: Excess function parameter 'cmd' description in 'bnx2i_send_iscsi_login'
 drivers/scsi/bnx2i/bnx2i_hwi.c:384: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_tmf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:384: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_tmf'
 drivers/scsi/bnx2i/bnx2i_hwi.c:458: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_text'
 drivers/scsi/bnx2i/bnx2i_hwi.c:458: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_text'
 drivers/scsi/bnx2i/bnx2i_hwi.c:506: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_scsicmd'
 drivers/scsi/bnx2i/bnx2i_hwi.c:506: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_scsicmd'
 drivers/scsi/bnx2i/bnx2i_hwi.c:533: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_nopout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:533: warning: Function parameter or member 'task' not described in 'bnx2i_send_iscsi_nopout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:533: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_nopout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:533: warning: Excess function parameter 'cmd' description in 'bnx2i_send_iscsi_nopout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:590: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_send_iscsi_logout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:590: warning: Function parameter or member 'task' not described in 'bnx2i_send_iscsi_logout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:590: warning: Excess function parameter 'conn' description in 'bnx2i_send_iscsi_logout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:590: warning: Excess function parameter 'cmd' description in 'bnx2i_send_iscsi_logout'
 drivers/scsi/bnx2i/bnx2i_hwi.c:686: warning: Function parameter or member 't' not described in 'bnx2i_ep_ofld_timer'
 drivers/scsi/bnx2i/bnx2i_hwi.c:686: warning: Excess function parameter 'data' description in 'bnx2i_ep_ofld_timer'
 drivers/scsi/bnx2i/bnx2i_hwi.c:1672: warning: Function parameter or member 'bnx2i_conn' not described in 'bnx2i_unsol_pdu_adjust_rq'
 drivers/scsi/bnx2i/bnx2i_hwi.c:1672: warning: Excess function parameter 'conn' description in 'bnx2i_unsol_pdu_adjust_rq'
 drivers/scsi/bnx2i/bnx2i_hwi.c:1900: warning: Function parameter or member 'session' not described in 'bnx2i_queue_scsi_cmd_resp'
 drivers/scsi/bnx2i/bnx2i_hwi.c:1900: warning: Function parameter or member 'cqe' not described in 'bnx2i_queue_scsi_cmd_resp'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2476: warning: Function parameter or member 'context' not described in 'bnx2i_indicate_kcqe'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2476: warning: Function parameter or member 'kcqe' not described in 'bnx2i_indicate_kcqe'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2476: warning: Function parameter or member 'num_cqe' not described in 'bnx2i_indicate_kcqe'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2476: warning: Excess function parameter 'hba' description in 'bnx2i_indicate_kcqe'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2476: warning: Excess function parameter 'update_kcqe' description in 'bnx2i_indicate_kcqe'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2624: warning: Function parameter or member 'cm_sk' not described in 'bnx2i_cm_remote_close'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2624: warning: Excess function parameter 'hba' description in 'bnx2i_cm_remote_close'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2624: warning: Excess function parameter 'update_kcqe' description in 'bnx2i_cm_remote_close'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2641: warning: Function parameter or member 'cm_sk' not described in 'bnx2i_cm_remote_abort'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2641: warning: Excess function parameter 'hba' description in 'bnx2i_cm_remote_abort'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2641: warning: Excess function parameter 'update_kcqe' description in 'bnx2i_cm_remote_abort'
 drivers/scsi/bnx2i/bnx2i_hwi.c:2677: warning: cannot understand function prototype: 'struct cnic_ulp_ops bnx2i_cnic_cb = '

Link: https://lore.kernel.org/r/20200723122446.1329773-29-lee.jones@linaro.org
Cc: QLogic-Storage-Upstream@qlogic.com
Cc: Anil Veerabhadrappa <anilgv@broadcom.com>
Cc: Eddie Wai <eddie.wai@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-23 13:24:34 +01:00 committed by Martin K. Petersen
parent e95fcb7792
commit dd3273c9b1
1 changed files with 27 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
drivers/scsi/bnx2i/bnx2i_hwi.c
View file

@ -181,7 +181,7 @@ int bnx2i_arm_cq_event_coalescing(struct bnx2i_endpoint *ep, u8 action)
/** /**
* bnx2i_get_rq_buf - copy RQ buffer contents to driver buffer * bnx2i_get_rq_buf - copy RQ buffer contents to driver buffer
* @conn: iscsi connection on which RQ event occurred * @bnx2i_conn: iscsi connection on which RQ event occurred
* @ptr: driver buffer to which RQ buffer contents is to * @ptr: driver buffer to which RQ buffer contents is to
* be copied * be copied
* @len: length of valid data inside RQ buf * @len: length of valid data inside RQ buf
@ -223,7 +223,7 @@ static void bnx2i_ring_577xx_doorbell(struct bnx2i_conn *conn)
/** /**
* bnx2i_put_rq_buf - Replenish RQ buffer, if required ring on chip doorbell * bnx2i_put_rq_buf - Replenish RQ buffer, if required ring on chip doorbell
* @conn: iscsi connection on which event to post * @bnx2i_conn: iscsi connection on which event to post
* @count: number of RQ buffer being posted to chip * @count: number of RQ buffer being posted to chip
* *
* No need to ring hardware doorbell for 57710 family of devices * No need to ring hardware doorbell for 57710 family of devices
@ -258,7 +258,7 @@ void bnx2i_put_rq_buf(struct bnx2i_conn *bnx2i_conn, int count)
/** /**
* bnx2i_ring_sq_dbell - Ring SQ doorbell to wake-up the processing engine * bnx2i_ring_sq_dbell - Ring SQ doorbell to wake-up the processing engine
* @conn: iscsi connection to which new SQ entries belong * @bnx2i_conn: iscsi connection to which new SQ entries belong
* @count: number of SQ WQEs to post * @count: number of SQ WQEs to post
* *
* SQ DB is updated in host memory and TX Doorbell is rung for 57710 family * SQ DB is updated in host memory and TX Doorbell is rung for 57710 family
@ -283,7 +283,7 @@ static void bnx2i_ring_sq_dbell(struct bnx2i_conn *bnx2i_conn, int count)
/** /**
* bnx2i_ring_dbell_update_sq_params - update SQ driver parameters * bnx2i_ring_dbell_update_sq_params - update SQ driver parameters
* @conn: iscsi connection to which new SQ entries belong * @bnx2i_conn: iscsi connection to which new SQ entries belong
* @count: number of SQ WQEs to post * @count: number of SQ WQEs to post
* *
* this routine will update SQ driver parameters and ring the doorbell * this routine will update SQ driver parameters and ring the doorbell
@ -320,9 +320,9 @@ static void bnx2i_ring_dbell_update_sq_params(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_login - post iSCSI login request MP WQE to hardware * bnx2i_send_iscsi_login - post iSCSI login request MP WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @cmd: driver command structure which is requesting * @task: transport layer's command structure pointer which is requesting
* a WQE to sent to chip for further processing * a WQE to sent to chip for further processing
* *
* prepare and post an iSCSI Login request WQE to CNIC firmware * prepare and post an iSCSI Login request WQE to CNIC firmware
*/ */
@ -373,7 +373,7 @@ int bnx2i_send_iscsi_login(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_tmf - post iSCSI task management request MP WQE to hardware * bnx2i_send_iscsi_tmf - post iSCSI task management request MP WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @mtask: driver command structure which is requesting * @mtask: driver command structure which is requesting
* a WQE to sent to chip for further processing * a WQE to sent to chip for further processing
* *
@ -447,7 +447,7 @@ int bnx2i_send_iscsi_tmf(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_text - post iSCSI text WQE to hardware * bnx2i_send_iscsi_text - post iSCSI text WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @mtask: driver command structure which is requesting * @mtask: driver command structure which is requesting
* a WQE to sent to chip for further processing * a WQE to sent to chip for further processing
* *
@ -495,7 +495,7 @@ int bnx2i_send_iscsi_text(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_scsicmd - post iSCSI scsicmd request WQE to hardware * bnx2i_send_iscsi_scsicmd - post iSCSI scsicmd request WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @cmd: driver command structure which is requesting * @cmd: driver command structure which is requesting
* a WQE to sent to chip for further processing * a WQE to sent to chip for further processing
* *
@ -517,9 +517,9 @@ int bnx2i_send_iscsi_scsicmd(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_nopout - post iSCSI NOPOUT request WQE to hardware * bnx2i_send_iscsi_nopout - post iSCSI NOPOUT request WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @cmd: driver command structure which is requesting * @task: transport layer's command structure pointer which is
* a WQE to sent to chip for further processing * requesting a WQE to sent to chip for further processing
* @datap: payload buffer pointer * @datap: payload buffer pointer
* @data_len: payload data length * @data_len: payload data length
* @unsol: indicated whether nopout pdu is unsolicited pdu or * @unsol: indicated whether nopout pdu is unsolicited pdu or
@ -579,9 +579,9 @@ int bnx2i_send_iscsi_nopout(struct bnx2i_conn *bnx2i_conn,
/** /**
* bnx2i_send_iscsi_logout - post iSCSI logout request WQE to hardware * bnx2i_send_iscsi_logout - post iSCSI logout request WQE to hardware
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* @cmd: driver command structure which is requesting * @task: transport layer's command structure pointer which is
* a WQE to sent to chip for further processing * requesting a WQE to sent to chip for further processing
* *
* prepare and post logout request WQE to CNIC firmware * prepare and post logout request WQE to CNIC firmware
*/ */
@ -678,7 +678,8 @@ void bnx2i_update_iscsi_conn(struct iscsi_conn *conn)
/** /**
* bnx2i_ep_ofld_timer - post iSCSI logout request WQE to hardware * bnx2i_ep_ofld_timer - post iSCSI logout request WQE to hardware
* @data: endpoint (transport handle) structure pointer * @t: timer context used to fetch the endpoint (transport
* handle) structure pointer
* *
* routine to handle connection offload/destroy request timeout * routine to handle connection offload/destroy request timeout
*/ */
@ -1662,7 +1663,7 @@ static void bnx2i_process_nopin_local_cmpl(struct iscsi_session *session,
/** /**
* bnx2i_unsol_pdu_adjust_rq - makes adjustments to RQ after unsol pdu is recvd * bnx2i_unsol_pdu_adjust_rq - makes adjustments to RQ after unsol pdu is recvd
* @conn: iscsi connection * @bnx2i_conn: iscsi connection
* *
* Firmware advances RQ producer index for every unsolicited PDU even if * Firmware advances RQ producer index for every unsolicited PDU even if
* payload data length is '0'. This function makes corresponding * payload data length is '0'. This function makes corresponding
@ -1885,7 +1886,9 @@ int bnx2i_percpu_io_thread(void *arg)
/** /**
* bnx2i_queue_scsi_cmd_resp - queue cmd completion to the percpu thread * bnx2i_queue_scsi_cmd_resp - queue cmd completion to the percpu thread
* @session: iscsi session
* @bnx2i_conn: bnx2i connection * @bnx2i_conn: bnx2i connection
* @cqe: pointer to newly DMA'ed CQE entry for processing
* *
* this function is called by generic KCQ handler to queue all pending cmd * this function is called by generic KCQ handler to queue all pending cmd
* completion CQEs * completion CQEs
@ -2466,8 +2469,9 @@ static void bnx2i_process_ofld_cmpl(struct bnx2i_hba *hba,
/** /**
* bnx2i_indicate_kcqe - process iscsi conn update completion KCQE * bnx2i_indicate_kcqe - process iscsi conn update completion KCQE
* @hba: adapter structure pointer * @context: adapter structure pointer
* @update_kcqe: kcqe pointer * @kcqe: kcqe pointer
* @num_cqe: number of kcqes to process
* *
* Generic KCQ event handler/dispatcher * Generic KCQ event handler/dispatcher
*/ */
@ -2614,8 +2618,7 @@ static void bnx2i_cm_abort_cmpl(struct cnic_sock *cm_sk)
/** /**
* bnx2i_cm_remote_close - process received TCP FIN * bnx2i_cm_remote_close - process received TCP FIN
* @hba: adapter structure pointer * @cm_sk: cnic sock structure pointer
* @update_kcqe: kcqe pointer
* *
* function callback exported via bnx2i - cnic driver interface to indicate * function callback exported via bnx2i - cnic driver interface to indicate
* async TCP events such as FIN * async TCP events such as FIN
@ -2631,8 +2634,7 @@ static void bnx2i_cm_remote_close(struct cnic_sock *cm_sk)
/** /**
* bnx2i_cm_remote_abort - process TCP RST and start conn cleanup * bnx2i_cm_remote_abort - process TCP RST and start conn cleanup
* @hba: adapter structure pointer * @cm_sk: cnic sock structure pointer
* @update_kcqe: kcqe pointer
* *
* function callback exported via bnx2i - cnic driver interface to * function callback exported via bnx2i - cnic driver interface to
* indicate async TCP events (RST) sent by the peer. * indicate async TCP events (RST) sent by the peer.
@ -2669,10 +2671,9 @@ static int bnx2i_send_nl_mesg(void *context, u32 msg_type,
} }
/** /*
* bnx2i_cnic_cb - global template of bnx2i - cnic driver interface structure * bnx2i_cnic_cb - global template of bnx2i - cnic driver interface structure
* carrying callback function pointers * carrying callback function pointers
*
*/ */
struct cnic_ulp_ops bnx2i_cnic_cb = { struct cnic_ulp_ops bnx2i_cnic_cb = {
.cnic_init = bnx2i_ulp_init, .cnic_init = bnx2i_ulp_init,