Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2db6228d authored by Bart Van Assche's avatar Bart Van Assche Committed by Martin K. Petersen
Browse files

scsi: qla2xxx: Fix function argument descriptions 



Bring the kernel-doc headers in sync with the function argument lists.

Signed-off-by: default avatarBart Van Assche <bart.vanassche@wdc.com>
Cc: Himanshu Madhani <himanshu.madhani@cavium.com>
Acked-by: default avatarHimanshu Madhani <himanshu.madhani@cavium.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent bb83e59d

drivers/scsi/qla2xxx/qla_dbg.c

+2 −2
Original line number Diff line number Diff line
@@ -717,7 +717,7 @@ qla2xxx_dump_post_process(scsi_qla_host_t *vha, int rval) 


/**

 * qla2300_fw_dump() - Dumps binary data from the 2300 firmware.

 * @ha: HA context

 * @vha: HA context

 * @hardware_locked: Called with the hardware_lock

 */

void
@@ -887,7 +887,7 @@ qla2300_fw_dump(scsi_qla_host_t *vha, int hardware_locked) 


/**

 * qla2100_fw_dump() - Dumps binary data from the 2100/2200 firmware.

 * @ha: HA context

 * @vha: HA context

 * @hardware_locked: Called with the hardware_lock

 */

void

drivers/scsi/qla2xxx/qla_gs.c

+38 −40
Original line number Diff line number Diff line
@@ -21,11 +21,10 @@ static int qla_async_rsnn_nn(scsi_qla_host_t *); 


/**

 * qla2x00_prep_ms_iocb() - Prepare common MS/CT IOCB fields for SNS CT query.

 * @ha: HA context

 * @req_size: request size in bytes

 * @rsp_size: response size in bytes

 * @vha: HA context

 * @arg: CT arguments

 *

 * Returns a pointer to the @ha's ms_iocb.

 * Returns a pointer to the @vha's ms_iocb.

 */

void *

qla2x00_prep_ms_iocb(scsi_qla_host_t *vha, struct ct_arg *arg)
@@ -61,9 +60,8 @@ qla2x00_prep_ms_iocb(scsi_qla_host_t *vha, struct ct_arg *arg) 


/**

 * qla24xx_prep_ms_iocb() - Prepare common CT IOCB fields for SNS CT query.

 * @ha: HA context

 * @req_size: request size in bytes

 * @rsp_size: response size in bytes

 * @vha: HA context

 * @arg: CT arguments

 *

 * Returns a pointer to the @ha's ms_iocb.

 */
@@ -101,7 +99,7 @@ qla24xx_prep_ms_iocb(scsi_qla_host_t *vha, struct ct_arg *arg) 


/**

 * qla2x00_prep_ct_req() - Prepare common CT request fields for SNS query.

 * @ct_req: CT request buffer

 * @p: CT request buffer

 * @cmd: GS command

 * @rsp_size: response size in bytes

 *
@@ -196,7 +194,7 @@ qla2x00_chk_ms_status(scsi_qla_host_t *vha, ms_iocb_entry_t *ms_pkt, 


/**

 * qla2x00_ga_nxt() - SNS scan for fabric devices via GA_NXT command.

 * @ha: HA context

 * @vha: HA context

 * @fcport: fcport entry to updated

 *

 * Returns 0 on success.
@@ -283,7 +281,7 @@ qla2x00_gid_pt_rsp_size(scsi_qla_host_t *vha) 


/**

 * qla2x00_gid_pt() - SNS scan for fabric devices via GID_PT command.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * NOTE: Non-Nx_Ports are not requested.
@@ -371,7 +369,7 @@ qla2x00_gid_pt(scsi_qla_host_t *vha, sw_info_t *list) 


/**

 * qla2x00_gpn_id() - SNS Get Port Name (GPN_ID) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * Returns 0 on success.
@@ -441,7 +439,7 @@ qla2x00_gpn_id(scsi_qla_host_t *vha, sw_info_t *list) 


/**

 * qla2x00_gnn_id() - SNS Get Node Name (GNN_ID) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * Returns 0 on success.
@@ -583,7 +581,7 @@ static void qla2x00_async_sns_sp_done(void *s, int rc) 


/**

 * qla2x00_rft_id() - SNS Register FC-4 TYPEs (RFT_ID) supported by the HBA.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -675,7 +673,8 @@ static int qla_async_rftid(scsi_qla_host_t *vha, port_id_t *d_id) 


/**

 * qla2x00_rff_id() - SNS Register FC-4 Features (RFF_ID) supported by the HBA.

 * @ha: HA context

 * @vha: HA context

 * @type: not used

 *

 * Returns 0 on success.

 */
@@ -769,7 +768,7 @@ static int qla_async_rffid(scsi_qla_host_t *vha, port_id_t *d_id, 


/**

 * qla2x00_rnn_id() - SNS Register Node Name (RNN_ID) of the HBA.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -874,7 +873,7 @@ qla2x00_get_sym_node_name(scsi_qla_host_t *vha, uint8_t *snn, size_t size) 


/**

 * qla2x00_rsnn_nn() - SNS Register Symbolic Node Name (RSNN_NN) of the HBA.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -970,7 +969,7 @@ static int qla_async_rsnn_nn(scsi_qla_host_t *vha) 


/**

 * qla2x00_prep_sns_cmd() - Prepare common SNS command request fields for query.

 * @ha: HA context

 * @vha: HA context

 * @cmd: GS command

 * @scmd_len: Subcommand length

 * @data_size: response size in bytes
@@ -1003,7 +1002,7 @@ qla2x00_prep_sns_cmd(scsi_qla_host_t *vha, uint16_t cmd, uint16_t scmd_len, 


/**

 * qla2x00_sns_ga_nxt() - SNS scan for fabric devices via GA_NXT command.

 * @ha: HA context

 * @vha: HA context

 * @fcport: fcport entry to updated

 *

 * This command uses the old Exectute SNS Command mailbox routine.
@@ -1067,7 +1066,7 @@ qla2x00_sns_ga_nxt(scsi_qla_host_t *vha, fc_port_t *fcport) 


/**

 * qla2x00_sns_gid_pt() - SNS scan for fabric devices via GID_PT command.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * This command uses the old Exectute SNS Command mailbox routine.
@@ -1140,7 +1139,7 @@ qla2x00_sns_gid_pt(scsi_qla_host_t *vha, sw_info_t *list) 


/**

 * qla2x00_sns_gpn_id() - SNS Get Port Name (GPN_ID) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * This command uses the old Exectute SNS Command mailbox routine.
@@ -1196,7 +1195,7 @@ qla2x00_sns_gpn_id(scsi_qla_host_t *vha, sw_info_t *list) 


/**

 * qla2x00_sns_gnn_id() - SNS Get Node Name (GNN_ID) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * This command uses the old Exectute SNS Command mailbox routine.
@@ -1259,7 +1258,7 @@ qla2x00_sns_gnn_id(scsi_qla_host_t *vha, sw_info_t *list) 


/**

 * qla2x00_snd_rft_id() - SNS Register FC-4 TYPEs (RFT_ID) supported by the HBA.

 * @ha: HA context

 * @vha: HA context

 *

 * This command uses the old Exectute SNS Command mailbox routine.

 *
@@ -1308,8 +1307,7 @@ qla2x00_sns_rft_id(scsi_qla_host_t *vha) 


/**

 * qla2x00_sns_rnn_id() - SNS Register Node Name (RNN_ID) of the HBA.

 * HBA.

 * @ha: HA context

 * @vha: HA context

 *

 * This command uses the old Exectute SNS Command mailbox routine.

 *
@@ -1365,7 +1363,7 @@ qla2x00_sns_rnn_id(scsi_qla_host_t *vha) 


/**

 * qla2x00_mgmt_svr_login() - Login to fabric Management Service.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -1401,7 +1399,7 @@ qla2x00_mgmt_svr_login(scsi_qla_host_t *vha) 


/**

 * qla2x00_prep_ms_fdmi_iocb() - Prepare common MS IOCB fields for FDMI query.

 * @ha: HA context

 * @vha: HA context

 * @req_size: request size in bytes

 * @rsp_size: response size in bytes

 *
@@ -1439,7 +1437,7 @@ qla2x00_prep_ms_fdmi_iocb(scsi_qla_host_t *vha, uint32_t req_size, 


/**

 * qla24xx_prep_ms_fdmi_iocb() - Prepare common MS IOCB fields for FDMI query.

 * @ha: HA context

 * @vha: HA context

 * @req_size: request size in bytes

 * @rsp_size: response size in bytes

 *
@@ -1496,7 +1494,7 @@ qla2x00_update_ms_fdmi_iocb(scsi_qla_host_t *vha, uint32_t req_size) 


/**

 * qla2x00_prep_ct_req() - Prepare common CT request fields for SNS query.

 * @ct_req: CT request buffer

 * @p: CT request buffer

 * @cmd: GS command

 * @rsp_size: response size in bytes

 *
@@ -1518,8 +1516,8 @@ qla2x00_prep_ct_fdmi_req(struct ct_sns_pkt *p, uint16_t cmd, 
}



/**

 * qla2x00_fdmi_rhba() -

 * @ha: HA context

 * qla2x00_fdmi_rhba() - perform RHBA FDMI registration

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -1728,8 +1726,8 @@ qla2x00_fdmi_rhba(scsi_qla_host_t *vha) 
}



/**

 * qla2x00_fdmi_rpa() -

 * @ha: HA context

 * qla2x00_fdmi_rpa() - perform RPA registration

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -1940,8 +1938,8 @@ qla2x00_fdmi_rpa(scsi_qla_host_t *vha) 
}



/**

 * qla2x00_fdmiv2_rhba() -

 * @ha: HA context

 * qla2x00_fdmiv2_rhba() - perform RHBA FDMI v2 registration

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2257,7 +2255,7 @@ qla2x00_fdmiv2_rhba(scsi_qla_host_t *vha) 


/**

 * qla2x00_fdmi_dhba() -

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2305,7 +2303,7 @@ qla2x00_fdmi_dhba(scsi_qla_host_t *vha) 


/**

 * qla2x00_fdmiv2_rpa() -

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2635,7 +2633,7 @@ qla2x00_fdmiv2_rpa(scsi_qla_host_t *vha) 


/**

 * qla2x00_fdmi_register() -

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2693,7 +2691,7 @@ qla2x00_fdmi_register(scsi_qla_host_t *vha) 


/**

 * qla2x00_gfpn_id() - SNS Get Fabric Port Name (GFPN_ID) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * Returns 0 on success.
@@ -2778,7 +2776,7 @@ qla24xx_prep_ct_fm_req(struct ct_sns_pkt *p, uint16_t cmd, 


/**

 * qla2x00_gpsc() - FCS Get Port Speed Capabilities (GPSC) query.

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 * Returns 0 on success.
@@ -2892,7 +2890,7 @@ qla2x00_gpsc(scsi_qla_host_t *vha, sw_info_t *list) 
/**

 * qla2x00_gff_id() - SNS Get FC-4 Features (GFF_ID) query.

 *

 * @ha: HA context

 * @vha: HA context

 * @list: switch info entries to populate

 *

 */

drivers/scsi/qla2xxx/qla_init.c

+17 −16
Original line number Diff line number Diff line
@@ -2046,7 +2046,7 @@ qla2x00_initialize_adapter(scsi_qla_host_t *vha) 


/**

 * qla2100_pci_config() - Setup ISP21xx PCI configuration registers.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2077,7 +2077,7 @@ qla2100_pci_config(scsi_qla_host_t *vha) 


/**

 * qla2300_pci_config() - Setup ISP23xx PCI configuration registers.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2159,7 +2159,7 @@ qla2300_pci_config(scsi_qla_host_t *vha) 


/**

 * qla24xx_pci_config() - Setup ISP24xx PCI configuration registers.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2203,7 +2203,7 @@ qla24xx_pci_config(scsi_qla_host_t *vha) 


/**

 * qla25xx_pci_config() - Setup ISP25xx PCI configuration registers.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2234,7 +2234,7 @@ qla25xx_pci_config(scsi_qla_host_t *vha) 


/**

 * qla2x00_isp_firmware() - Choose firmware image.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2270,7 +2270,7 @@ qla2x00_isp_firmware(scsi_qla_host_t *vha) 


/**

 * qla2x00_reset_chip() - Reset ISP chip.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2414,6 +2414,7 @@ qla2x00_reset_chip(scsi_qla_host_t *vha) 


/**

 * qla81xx_reset_mpi() - Reset's MPI FW via Write MPI Register MBC.

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2430,7 +2431,7 @@ qla81xx_reset_mpi(scsi_qla_host_t *vha) 


/**

 * qla24xx_reset_risc() - Perform full reset of ISP24xx RISC.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2645,7 +2646,7 @@ qla25xx_manipulate_risc_semaphore(scsi_qla_host_t *vha) 


/**

 * qla24xx_reset_chip() - Reset ISP24xx chip.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2669,7 +2670,7 @@ qla24xx_reset_chip(scsi_qla_host_t *vha) 


/**

 * qla2x00_chip_diag() - Test chip for proper operation.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -2793,7 +2794,7 @@ qla2x00_chip_diag(scsi_qla_host_t *vha) 


/**

 * qla24xx_chip_diag() - Test ISP24xx for proper operation.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -3261,7 +3262,7 @@ qla24xx_detect_sfp(scsi_qla_host_t *vha) 


/**

 * qla2x00_setup_chip() - Load and start RISC firmware.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -3416,7 +3417,7 @@ qla2x00_setup_chip(scsi_qla_host_t *vha) 


/**

 * qla2x00_init_response_q_entries() - Initializes response queue entries.

 * @ha: HA context

 * @rsp: response queue

 *

 * Beginning of request ring has initialization control block already built

 * by nvram config routine.
@@ -3441,7 +3442,7 @@ qla2x00_init_response_q_entries(struct rsp_que *rsp) 


/**

 * qla2x00_update_fw_options() - Read and process firmware options.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -3704,7 +3705,7 @@ qla24xx_config_rings(struct scsi_qla_host *vha) 


/**

 * qla2x00_init_rings() - Initializes firmware.

 * @ha: HA context

 * @vha: HA context

 *

 * Beginning of request ring has initialization control block already built

 * by nvram config routine.
@@ -3812,7 +3813,7 @@ qla2x00_init_rings(scsi_qla_host_t *vha) 


/**

 * qla2x00_fw_ready() - Waits for firmware ready.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns 0 on success.

 */
@@ -4480,7 +4481,7 @@ qla2x00_rport_del(void *data) 


/**

 * qla2x00_alloc_fcport() - Allocate a generic fcport.

 * @ha: HA context

 * @vha: HA context

 * @flags: allocation flags

 *

 * Returns a pointer to the allocated fcport, or NULL, if none available.

drivers/scsi/qla2xxx/qla_inline.h

+1 −0
Original line number Diff line number Diff line
@@ -10,6 +10,7 @@ 
 * qla24xx_calc_iocbs() - Determine number of Command Type 3 and

 * Continuation Type 1 IOCBs to allocate.

 *

 * @vha: HA context

 * @dsds: number of data segment decriptors needed

 *

 * Returns the number of IOCB entries needed to store @dsds.

drivers/scsi/qla2xxx/qla_iocb.c

+11 −4
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ 


/**

 * qla2x00_get_cmd_direction() - Determine control_flag data direction.

 * @cmd: SCSI command

 * @sp: SCSI command

 *

 * Returns the proper CF_* direction based on CDB.

 */
@@ -86,7 +86,7 @@ qla2x00_calc_iocbs_64(uint16_t dsds) 


/**

 * qla2x00_prep_cont_type0_iocb() - Initialize a Continuation Type 0 IOCB.

 * @ha: HA context

 * @vha: HA context

 *

 * Returns a pointer to the Continuation Type 0 IOCB packet.

 */
@@ -114,7 +114,8 @@ qla2x00_prep_cont_type0_iocb(struct scsi_qla_host *vha) 


/**

 * qla2x00_prep_cont_type1_iocb() - Initialize a Continuation Type 1 IOCB.

 * @ha: HA context

 * @vha: HA context

 * @req: request queue

 *

 * Returns a pointer to the continuation type 1 IOCB packet.

 */
@@ -445,6 +446,8 @@ qla2x00_start_scsi(srb_t *sp) 


/**

 * qla2x00_start_iocbs() - Execute the IOCB command

 * @vha: HA context

 * @req: request queue

 */

void

qla2x00_start_iocbs(struct scsi_qla_host *vha, struct req_que *req)
@@ -486,7 +489,9 @@ qla2x00_start_iocbs(struct scsi_qla_host *vha, struct req_que *req) 


/**

 * qla2x00_marker() - Send a marker IOCB to the firmware.

 * @ha: HA context

 * @vha: HA context

 * @req: request queue

 * @rsp: response queue

 * @loop_id: loop ID

 * @lun: LUN

 * @type: marker modifier
@@ -1190,6 +1195,8 @@ qla24xx_walk_and_build_prot_sglist(struct qla_hw_data *ha, srb_t *sp, 
 * @sp: SRB command to process

 * @cmd_pkt: Command type 3 IOCB

 * @tot_dsds: Total number of segments to transfer

 * @tot_prot_dsds:

 * @fw_prot_opts:

 */

inline int

qla24xx_build_scsi_crc_2_iocbs(srb_t *sp, struct cmd_type_crc_2 *cmd_pkt,