From 993cf71424a263d0f71de76ccfda4087c3cdb2e8 Mon Sep 17 00:00:00 2001 From: Bart Van Assche Date: Sun, 4 Feb 2018 23:06:21 +0000 Subject: [PATCH] qla2x00t: Fix kernel-doc header inconsistencies git-svn-id: http://svn.code.sf.net/p/scst/svn/trunk@7357 d57e44dd-8a1f-0410-8b47-8ef2f437770f --- qla2x00t/qla_dbg.c | 4 ++-- qla2x00t/qla_gs.c | 58 ++++++++++++++++++++++----------------------- qla2x00t/qla_init.c | 33 +++++++++++++------------- qla2x00t/qla_iocb.c | 28 ++++++++++++---------- qla2x00t/qla_isr.c | 30 +++++++++++++---------- qla2x00t/qla_mbx.c | 6 ----- qla2x00t/qla_nx.c | 6 ++--- qla2x00t/qla_sup.c | 1 + 8 files changed, 83 insertions(+), 83 deletions(-) diff --git a/qla2x00t/qla_dbg.c b/qla2x00t/qla_dbg.c index 57b54e0be..588bf4bb6 100644 --- a/qla2x00t/qla_dbg.c +++ b/qla2x00t/qla_dbg.c @@ -500,7 +500,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 @@ -661,7 +661,7 @@ qla2300_fw_dump_failed: /** * 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 diff --git a/qla2x00t/qla_gs.c b/qla2x00t/qla_gs.c index b169d5581..bec33e319 100644 --- a/qla2x00t/qla_gs.c +++ b/qla2x00t/qla_gs.c @@ -16,7 +16,7 @@ static int qla2x00_sns_rnn_id(scsi_qla_host_t *); /** * qla2x00_prep_ms_iocb() - Prepare common MS/CT IOCB fields for SNS CT query. - * @ha: HA context + * @vha: HA context * @req_size: request size in bytes * @rsp_size: response size in bytes * @@ -54,7 +54,7 @@ qla2x00_prep_ms_iocb(scsi_qla_host_t *vha, uint32_t req_size, uint32_t rsp_size) /** * qla24xx_prep_ms_iocb() - Prepare common CT IOCB fields for SNS CT query. - * @ha: HA context + * @vha: HA context * @req_size: request size in bytes * @rsp_size: response size in bytes * @@ -166,7 +166,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. @@ -250,7 +250,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. @@ -330,7 +330,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. @@ -393,7 +393,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. @@ -470,7 +470,7 @@ qla2x00_gnn_id(scsi_qla_host_t *vha, sw_info_t *list) /** * qla2x00_rft_id() - SNS Register FC-4 TYPEs (RFT_ID) supported by the HBA. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -522,7 +522,7 @@ qla2x00_rft_id(scsi_qla_host_t *vha) /** * qla2x00_rff_id() - SNS Register FC-4 Features (RFF_ID) supported by the HBA. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -589,7 +589,7 @@ qla2x00_rff_id(scsi_qla_host_t *vha) /** * qla2x00_rnn_id() - SNS Register Node Name (RNN_ID) of the HBA. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -650,7 +650,7 @@ qla2x00_get_sym_node_name(scsi_qla_host_t *vha, uint8_t *snn) /** * qla2x00_rsnn_nn() - SNS Register Symbolic Node Name (RSNN_NN) of the HBA. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -713,7 +713,7 @@ qla2x00_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 @@ -744,7 +744,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. @@ -816,7 +816,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. @@ -889,7 +889,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. @@ -945,7 +945,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. @@ -1016,7 +1016,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. * @@ -1065,8 +1065,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. * @@ -1122,7 +1121,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. */ @@ -1158,7 +1157,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 * @@ -1196,7 +1195,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 * @@ -1253,7 +1252,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 * @@ -1276,7 +1275,7 @@ qla2x00_prep_ct_fdmi_req(struct ct_sns_pkt *p, uint16_t cmd, /** * qla2x00_fdmi_rhba() - - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1470,7 +1469,7 @@ qla2x00_fdmi_rhba(scsi_qla_host_t *vha) /** * qla2x00_fdmi_dhba() - - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1522,7 +1521,7 @@ qla2x00_fdmi_dhba(scsi_qla_host_t *vha) /** * qla2x00_fdmi_rpa() - - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1698,7 +1697,7 @@ qla2x00_fdmi_rpa(scsi_qla_host_t *vha) /** * qla2x00_fdmi_register() - - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1735,7 +1734,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. @@ -1842,7 +1841,7 @@ qla24xx_prep_ct_fm_req(struct ct_sns_pkt *p, uint16_t cmd, uint16_t rsp_size) /** * 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. @@ -1950,8 +1949,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 * */ diff --git a/qla2x00t/qla_init.c b/qla2x00t/qla_init.c index b6c41bb68..62da886da 100644 --- a/qla2x00t/qla_init.c +++ b/qla2x00t/qla_init.c @@ -551,7 +551,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. */ @@ -582,7 +582,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. */ @@ -664,7 +664,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. */ @@ -708,7 +708,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. */ @@ -739,7 +739,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. */ @@ -775,7 +775,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. */ @@ -919,6 +919,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. */ @@ -934,7 +935,7 @@ static int 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. */ @@ -1022,7 +1023,7 @@ qla24xx_reset_risc(scsi_qla_host_t *vha) /** * qla24xx_reset_chip() - Reset ISP24xx chip. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1044,7 +1045,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. */ @@ -1181,7 +1182,7 @@ chip_diag_failed: /** * qla24xx_chip_diag() - Test ISP24xx for proper operation. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1415,7 +1416,7 @@ done: /** * qla2x00_setup_chip() - Load and start RISC firmware. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1551,7 +1552,7 @@ failed: /** * 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. @@ -1602,7 +1603,7 @@ qla2x00_init_atio_q_entries(scsi_qla_host_t *vha) /** * qla2x00_update_fw_options() - Read and process firmware options. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ @@ -1821,7 +1822,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. @@ -1910,7 +1911,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. */ @@ -2666,7 +2667,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. diff --git a/qla2x00t/qla_iocb.c b/qla2x00t/qla_iocb.c index 0b63ef661..bd36834ce 100644 --- a/qla2x00t/qla_iocb.c +++ b/qla2x00t/qla_iocb.c @@ -13,9 +13,9 @@ #include "qla2x_tgt.h" static void qla25xx_set_que(srb_t *, struct rsp_que **); -/** + +/* * qla2x00_get_cmd_direction() - Determine control_flag data direction. - * @cmd: SCSI command * * Returns the proper CF_* direction based on CDB. */ @@ -85,7 +85,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. */ @@ -113,7 +113,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: Response queue. * * Returns a pointer to the continuation type 1 IOCB packet. */ @@ -466,7 +467,7 @@ queuing_error: return (QLA_FUNCTION_FAILED); } -/** +/* * qla2x00_start_iocbs() - Execute the IOCB command */ void @@ -504,7 +505,9 @@ EXPORT_SYMBOL(qla2x00_start_iocbs); /** * qla2x00_marker() - Send a marker IOCB to the firmware. - * @ha: HA context + * @vha: HA context + * @req: Request queue + * @rsp: ... * @loop_id: loop ID * @lun: LUN * @type: marker modifier @@ -575,7 +578,7 @@ qla2x00_marker(struct scsi_qla_host *vha, struct req_que *req, /** * qla2x00_req_pkt() - Retrieve a request packet from the request ring. - * @ha: HA context + * @vha: HA context * * Note: The caller must hold the hardware lock before calling this routine. * Might release it, then reacquire. @@ -650,9 +653,8 @@ qla2x00_req_pkt(scsi_qla_host_t *vha) EXPORT_SYMBOL(qla2x00_req_pkt); /** - * qla24xx_calc_iocbs() - Determine number of Command Type 3 and - * Continuation Type 1 IOCBs to allocate. - * + * qla24xx_calc_iocbs - determine number of IOCBs to allocate + * @vha: HA context * @dsds: number of data segment decriptors needed * * Returns the number of IOCB entries needed to store @dsds. @@ -1270,12 +1272,12 @@ qla24xx_walk_and_build_prot_sglist(struct qla_hw_data *ha, srb_t *sp, } /** - * qla24xx_build_scsi_crc_2_iocbs() - Build IOCB command utilizing Command - * Type 6 IOCB types. - * + * qla24xx_build_scsi_crc_2_iocbs - Build IOCB command * @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: ... */ static inline int qla24xx_build_scsi_crc_2_iocbs(srb_t *sp, struct cmd_type_crc_2 *cmd_pkt, diff --git a/qla2x00t/qla_isr.c b/qla2x00t/qla_isr.c index c07f3be7c..5b52727ca 100644 --- a/qla2x00t/qla_isr.c +++ b/qla2x00t/qla_isr.c @@ -25,7 +25,7 @@ static void qla2x00_error_entry(scsi_qla_host_t *, struct rsp_que *, /** * qla2100_intr_handler() - Process interrupts for the ISP2100 and ISP2200. - * @irq: + * @irq: ... * @dev_id: SCSI driver HA context * * Called by system whenever the host adapter generates an interrupt. @@ -121,7 +121,7 @@ qla2100_intr_handler(int irq, void *dev_id) /** * qla2300_intr_handler() - Process interrupts for the ISP23xx and ISP63xx. - * @irq: + * @irq: ... * @dev_id: SCSI driver HA context * * Called by system whenever the host adapter generates an interrupt. @@ -246,7 +246,7 @@ qla2300_intr_handler(int irq, void *dev_id) /** * qla2x00_mbx_completion() - Process mailbox command completions. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context * @mb0: Mailbox0 register */ static void @@ -344,7 +344,8 @@ qla2x00_get_link_speed_str(struct qla_hw_data *ha) /** * qla2x00_async_event() - Process aynchronous events. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context + * @rsp: Response queue * @mb: Mailbox registers (0 - 3) */ void @@ -903,7 +904,8 @@ skip_rio: /** * qla2x00_process_completed_request() - Process a Fast Post response. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context + * @req: Request queue * @index: SRB index */ static void @@ -1420,9 +1422,8 @@ qla24xx_tm_iocb_entry(scsi_qla_host_t *vha, struct req_que *req, sp->done(vha, sp, 0); } -/** +/* * qla2x00_process_response_queue() - Process response queue entries. - * @ha: SCSI driver HA context */ void qla2x00_process_response_queue(struct rsp_que *rsp) @@ -1708,7 +1709,8 @@ qla2x00_handle_dif_error(srb_t *sp, struct sts_entry_24xx *sts24) /** * qla2x00_status_entry() - Process a Status IOCB entry. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context + * @rsp: Response queue * @pkt: Entry pointer */ static void @@ -2017,7 +2019,7 @@ out: /** * qla2x00_status_cont_entry() - Process a Status Continuations entry. - * @ha: SCSI driver HA context + * @rsp: Response queue * @pkt: Entry pointer * * Extended sense data. @@ -2075,7 +2077,8 @@ qla2x00_status_cont_entry(struct rsp_que *rsp, sts_cont_entry_t *pkt) /** * qla2x00_error_entry() - Process an error entry. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context + * @rsp: Response queue * @pkt: Entry pointer */ static void @@ -2116,7 +2119,7 @@ fatal: /** * qla24xx_mbx_completion() - Process mailbox command completions. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context * @mb0: Mailbox0 register */ static void @@ -2197,7 +2200,8 @@ qla24xx_process_atio_queue(struct scsi_qla_host *vha) /** * qla24xx_process_response_queue() - Process response queue entries. - * @ha: SCSI driver HA context + * @vha: SCSI driver HA context + * @rsp: Response queue */ void qla24xx_process_response_queue(struct scsi_qla_host *vha, struct rsp_que *rsp) @@ -2355,7 +2359,7 @@ done: /** * qla24xx_intr_handler() - Process interrupts for the ISP23xx and ISP24xx. - * @irq: + * @irq: ... * @dev_id: SCSI driver HA context * * Called by system whenever the host adapter generates an interrupt. diff --git a/qla2x00t/qla_mbx.c b/qla2x00t/qla_mbx.c index a0b11c539..b5fe27db5 100644 --- a/qla2x00t/qla_mbx.c +++ b/qla2x00t/qla_mbx.c @@ -2845,12 +2845,6 @@ qla2x00_system_error(scsi_qla_host_t *vha) return rval; } -/** - * qla2x00_set_serdes_params() - - * @ha: HA context - * - * Returns - */ int qla2x00_set_serdes_params(scsi_qla_host_t *vha, uint16_t sw_em_1g, uint16_t sw_em_2g, uint16_t sw_em_4g) diff --git a/qla2x00t/qla_nx.c b/qla2x00t/qla_nx.c index 60e9d2431..a328100bf 100644 --- a/qla2x00t/qla_nx.c +++ b/qla2x00t/qla_nx.c @@ -1731,10 +1731,10 @@ iospace_error_exit: /** * qla82xx_pci_config() - Setup ISP82xx PCI configuration registers. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. -*/ + */ int qla82xx_pci_config(scsi_qla_host_t *vha) { @@ -1754,7 +1754,7 @@ qla82xx_pci_config(scsi_qla_host_t *vha) /** * qla82xx_reset_chip() - Setup ISP82xx PCI configuration registers. - * @ha: HA context + * @vha: HA context * * Returns 0 on success. */ diff --git a/qla2x00t/qla_sup.c b/qla2x00t/qla_sup.c index b8e954dfb..5a6b361d2 100644 --- a/qla2x00t/qla_sup.c +++ b/qla2x00t/qla_sup.c @@ -2135,6 +2135,7 @@ qla2x00_erase_flash_sector(struct qla_hw_data *ha, uint32_t addr, /** * qla2x00_get_flash_manufacturer() - Read manufacturer ID from flash chip. + * @ha: ... * @man_id: Flash manufacturer ID * @flash_id: Flash ID */