Commit 69b8eff2 authored by James Smart's avatar James Smart Committed by Martin K. Petersen
Browse files

scsi: lpfc: Correct function header comments related to ndlp reference counting 

Code inspection revealed stale comments in function headers for functions
that call lpfc_prep_els_iocb(). Changes in ndlp reference counting were not
reflected in function headers.

Update the stale comments in function headers to more accurately indicate
ndlp reference counting.

Link: https://lore.kernel.org/r/20210301171821.3427-21-jsmart2021@gmail.com


Co-developed-by: default avatarDick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: default avatarDick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: default avatarJames Smart <jsmart2021@gmail.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent cdf81160

drivers/scsi/lpfc/lpfc_els.c

+71 −88
Original line number Diff line number Diff line
@@ -1251,10 +1251,9 @@ lpfc_cmpl_els_link_down(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * function field. The lpfc_issue_fabric_iocb routine is invoked to send

 * out FLOGI ELS command with one outstanding fabric IOCB at a time.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the FLOGI ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the FLOGI ELS command.

 *

 * Return code

 *   0 - successfully issued flogi iocb for @vport
@@ -2281,10 +2280,9 @@ lpfc_cmpl_els_prli(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * is put to the IOCB completion callback func field before invoking the

 * routine lpfc_sli_issue_iocb() to send out PRLI command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the PRLI ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the PRLI ELS command.

 *

 * Return code

 *   0 - successfully issued prli iocb command for @vport
@@ -2710,10 +2708,9 @@ lpfc_cmpl_els_adisc(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * and states of the ndlp, and invokes the lpfc_sli_issue_iocb() routine

 * to issue the ADISC ELS command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the ADISC ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the ADISC ELS command.

 *

 * Return code

 *   0 - successfully issued adisc
@@ -2788,8 +2785,7 @@ lpfc_issue_els_adisc(struct lpfc_vport *vport, struct lpfc_nodelist *ndlp, 
 * This routine is the completion function for issuing the ELS Logout (LOGO)

 * command. If no error status was reported from the LOGO response, the

 * state machine of the associated ndlp shall be invoked for transition with

 * respect to NLP_EVT_CMPL_LOGO event. Otherwise, if error status was reported,

 * the lpfc_els_retry() routine will be invoked to retry the LOGO command.

 * respect to NLP_EVT_CMPL_LOGO event.

 **/

static void

lpfc_cmpl_els_logo(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb,
@@ -2926,10 +2922,9 @@ lpfc_cmpl_els_logo(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * payload of the IOCB, properly sets up the @ndlp state, and invokes the

 * lpfc_sli_issue_iocb() routine to send out the LOGO ELS command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the LOGO ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the LOGO ELS command.

 *

 * Callers of this routine are expected to unregister the RPI first

 *
@@ -3165,10 +3160,9 @@ lpfc_cmpl_els_disc_cmd(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * IOCB is allocated, payload prepared, and the lpfc_sli_issue_iocb()

 * routine is invoked to send the SCR IOCB.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the SCR ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the SCR ELS command.

 *

 * Return code

 *   0 - Successfully issued scr command
@@ -3247,10 +3241,9 @@ lpfc_issue_els_scr(struct lpfc_vport *vport, uint8_t retry) 
 *  in point-to-point mode. When sent to the Fabric Controller, it will

 *  replay the RSCN to registered recipients.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the RSCN ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the RSCN ELS command.

 *

 * Return code

 *   0 - Successfully issued RSCN command
@@ -3352,10 +3345,9 @@ lpfc_issue_els_rscn(struct lpfc_vport *vport, uint8_t retry) 
 * for this (FARPR) purpose. An IOCB is allocated, payload prepared, and the

 * lpfc_sli_issue_iocb() routine is invoked to send the FARPR ELS command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the PARPR ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the FARPR ELS command.

 *

 * Return code

 *   0 - Successfully issued farpr command
@@ -3450,10 +3442,9 @@ lpfc_issue_els_farpr(struct lpfc_vport *vport, uint32_t nportid, uint8_t retry) 
 * This routine issues an ELS RDF to the Fabric Controller to register

 * for diagnostic functions.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the RDF ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the RDF ELS command.

 *

 * Return code

 *   0 - Successfully issued rdf command
@@ -3764,7 +3755,7 @@ lpfc_link_reset(struct lpfc_vport *vport) 
 * This routine makes a retry decision on an ELS command IOCB, which has

 * failed. The following ELS IOCBs use this function for retrying the command

 * when previously issued command responsed with error status: FLOGI, PLOGI,

 * PRLI, ADISC, LOGO, and FDISC. Based on the ELS command type and the

 * PRLI, ADISC and FDISC. Based on the ELS command type and the

 * returned error status, it makes the decision whether a retry shall be

 * issued for the command, and whether a retry shall be made immediately or

 * delayed. In the former case, the corresponding ELS command issuing-function
@@ -4664,10 +4655,10 @@ lpfc_cmpl_els_rsp(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * field of the IOCB for the completion callback function to issue the

 * mailbox command to the HBA later when callback is invoked.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the corresponding response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the corresponding

 * response ELS IOCB command.

 *

 * Return code

 *   0 - Successfully issued acc response
@@ -4850,10 +4841,10 @@ lpfc_els_rsp_acc(struct lpfc_vport *vport, uint32_t flag, 
 * context_un.mbox field of the IOCB for the completion callback function

 * to issue to the HBA later.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the reject response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the reject response

 * ELS IOCB command.

 *

 * Return code

 *   0 - Successfully issued reject response
@@ -4931,10 +4922,10 @@ lpfc_els_rsp_reject(struct lpfc_vport *vport, uint32_t rejectError, 
 * Discover (ADISC) ELS command. It simply prepares the payload of the IOCB

 * and invokes the lpfc_sli_issue_iocb() routine to send out the command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the ADISC Accept response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the ADISC Accept response

 * ELS IOCB command.

 *

 * Return code

 *   0 - Successfully issued acc adisc response
@@ -5021,10 +5012,10 @@ lpfc_els_rsp_adisc_acc(struct lpfc_vport *vport, struct lpfc_iocbq *oldiocb, 
 * Login (PRLI) ELS command. It simply prepares the payload of the IOCB

 * and invokes the lpfc_sli_issue_iocb() routine to send out the command.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the PRLI Accept response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the PRLI Accept response

 * ELS IOCB command.

 *

 * Return code

 *   0 - Successfully issued acc prli response
@@ -5187,17 +5178,11 @@ lpfc_els_rsp_prli_acc(struct lpfc_vport *vport, struct lpfc_iocbq *oldiocb, 
 * This routine issues a Request Node Identification Data (RNID) Accept

 * (ACC) response. It constructs the RNID ACC response command according to

 * the proper @format and then calls the lpfc_sli_issue_iocb() routine to

 * issue the response. Note that this command does not need to hold the ndlp

 * reference count for the callback. So, the ndlp reference count taken by

 * the lpfc_prep_els_iocb() routine is put back and the context1 field of

 * IOCB is set to NULL to indicate to the lpfc_els_free_iocb() routine that

 * there is no ndlp reference available.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function. However, for the RNID Accept Response ELS command,

 * this is undone later by this routine after the IOCB is allocated.

 * issue the response.

 *

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function.

 *

 * Return code

 *   0 - Successfully issued acc rnid response
@@ -7318,16 +7303,16 @@ lpfc_els_rcv_rrq(struct lpfc_vport *vport, struct lpfc_iocbq *cmdiocb, 
 *

 * This routine is the completion callback function for the MBX_READ_LNK_STAT

 * mailbox command. This callback function is to actually send the Accept

 * (ACC) response to a Read Port Status (RPS) unsolicited IOCB event. It

 * (ACC) response to a Read Link Status (RLS) unsolicited IOCB event. It

 * collects the link statistics from the completion of the MBX_READ_LNK_STAT

 * mailbox command, constructs the RPS response with the link statistics

 * mailbox command, constructs the RLS response with the link statistics

 * collected, and then invokes the lpfc_sli_issue_iocb() routine to send ACC

 * response to the RPS.

 * response to the RLS.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the RPS Accept Response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the RLS Accept Response

 * ELS IOCB command.

 *

 **/

static void
@@ -7485,10 +7470,10 @@ lpfc_els_rcv_rls(struct lpfc_vport *vport, struct lpfc_iocbq *cmdiocb, 
 * response. Otherwise, it sends the Accept(ACC) response to a Read Timeout

 * Value (RTV) unsolicited IOCB event.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the RTV Accept Response ELS IOCB command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the RTV Accept Response

 * ELS IOCB command.

 *

 * Return codes

 *   0 - Successfully processed rtv iocb (currently always return 0)
@@ -7675,10 +7660,10 @@ lpfc_send_rrq(struct lpfc_hba *phba, struct lpfc_node_rrq *rrq) 
 * This routine issuees an Accept (ACC) Read Port List (RPL) ELS command.

 * It is to be called by the lpfc_els_rcv_rpl() routine to accept the RPL.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the RPL Accept Response ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the RPL Accept Response

 * ELS command.

 *

 * Return code

 *   0 - Successfully issued ACC RPL ELS command
@@ -9569,10 +9554,9 @@ lpfc_cmpl_els_fdisc(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 * routine to issue the IOCB, which makes sure only one outstanding fabric

 * IOCB will be sent off HBA at any given time.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the FDISC ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the FDISC ELS command.

 *

 * Return code

 *   0 - Successfully issued fdisc iocb command
@@ -9730,10 +9714,9 @@ lpfc_cmpl_els_npiv_logo(struct lpfc_hba *phba, struct lpfc_iocbq *cmdiocb, 
 *

 * This routine issues a LOGO ELS command to an @ndlp off a @vport.

 *

 * Note that, in lpfc_prep_els_iocb() routine, the reference count of ndlp

 * will be incremented by 1 for holding the ndlp and the reference to ndlp

 * will be stored into the context1 field of the IOCB for the completion

 * callback function to the LOGO ELS command.

 * Note that the ndlp reference count will be incremented by 1 for holding the

 * ndlp and the reference to ndlp will be stored into the context1 field of

 * the IOCB for the completion callback function to the LOGO ELS command.

 *

 * Return codes

 *   0 - Successfully issued logo off the @vport
@@ -10050,7 +10033,7 @@ lpfc_issue_fabric_iocb(struct lpfc_hba *phba, struct lpfc_iocbq *iocb) 
 * driver internal fabric IOCB list. The list contains fabric IOCBs to be

 * issued to the ELS IOCB ring. This abort function walks the fabric IOCB

 * list, removes each IOCB associated with the @vport off the list, set the

 * status feild to IOSTAT_LOCAL_REJECT, and invokes the callback function

 * status field to IOSTAT_LOCAL_REJECT, and invokes the callback function

 * associated with the IOCB.

 **/

static void lpfc_fabric_abort_vport(struct lpfc_vport *vport)
@@ -10083,7 +10066,7 @@ static void lpfc_fabric_abort_vport(struct lpfc_vport *vport) 
 * driver internal fabric IOCB list. The list contains fabric IOCBs to be

 * issued to the ELS IOCB ring. This abort function walks the fabric IOCB

 * list, removes each IOCB associated with the @ndlp off the list, set the

 * status feild to IOSTAT_LOCAL_REJECT, and invokes the callback function

 * status field to IOSTAT_LOCAL_REJECT, and invokes the callback function

 * associated with the IOCB.

 **/

void lpfc_fabric_abort_nport(struct lpfc_nodelist *ndlp)
@@ -10120,7 +10103,7 @@ void lpfc_fabric_abort_nport(struct lpfc_nodelist *ndlp) 
 * This routine aborts all the IOCBs currently on the driver internal

 * fabric IOCB list. The list contains fabric IOCBs to be issued to the ELS

 * IOCB ring. This function takes the entire IOCB list off the fabric IOCB

 * list, removes IOCBs off the list, set the status feild to

 * list, removes IOCBs off the list, set the status field to

 * IOSTAT_LOCAL_REJECT, and invokes the callback function associated with

 * the IOCB.

 **/