Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / drivers / scsi / qla2xxx / qla_fw.h
blob9337e138ed639ada65f29762140c9ef8f4ea4def
1 /*
2 * QLogic Fibre Channel HBA Driver
3 * Copyright (c) 2003-2005 QLogic Corporation
5 * See LICENSE.qla2xxx for copyright and licensing details.
6 */
7 #ifndef __QLA_FW_H
8 #define __QLA_FW_H
10 #define MBS_CHECKSUM_ERROR 0x4010
11 #define MBS_INVALID_PRODUCT_KEY 0x4020
14 * Firmware Options.
16 #define FO1_ENABLE_PUREX BIT_10
17 #define FO1_DISABLE_LED_CTRL BIT_6
18 #define FO1_ENABLE_8016 BIT_0
19 #define FO2_ENABLE_SEL_CLASS2 BIT_5
20 #define FO3_NO_ABTS_ON_LINKDOWN BIT_14
21 #define FO3_HOLD_STS_IOCB BIT_12
24 * Port Database structure definition for ISP 24xx.
26 #define PDO_FORCE_ADISC BIT_1
27 #define PDO_FORCE_PLOGI BIT_0
30 #define PORT_DATABASE_24XX_SIZE 64
31 struct port_database_24xx {
32 uint16_t flags;
33 #define PDF_TASK_RETRY_ID BIT_14
34 #define PDF_FC_TAPE BIT_7
35 #define PDF_ACK0_CAPABLE BIT_6
36 #define PDF_FCP2_CONF BIT_5
37 #define PDF_CLASS_2 BIT_4
38 #define PDF_HARD_ADDR BIT_1
40 uint8_t current_login_state;
41 uint8_t last_login_state;
42 #define PDS_PLOGI_PENDING 0x03
43 #define PDS_PLOGI_COMPLETE 0x04
44 #define PDS_PRLI_PENDING 0x05
45 #define PDS_PRLI_COMPLETE 0x06
46 #define PDS_PORT_UNAVAILABLE 0x07
47 #define PDS_PRLO_PENDING 0x09
48 #define PDS_LOGO_PENDING 0x11
49 #define PDS_PRLI2_PENDING 0x12
51 uint8_t hard_address[3];
52 uint8_t reserved_1;
54 uint8_t port_id[3];
55 uint8_t sequence_id;
57 uint16_t port_timer;
59 uint16_t nport_handle; /* N_PORT handle. */
61 uint16_t receive_data_size;
62 uint16_t reserved_2;
64 uint8_t prli_svc_param_word_0[2]; /* Big endian */
65 /* Bits 15-0 of word 0 */
66 uint8_t prli_svc_param_word_3[2]; /* Big endian */
67 /* Bits 15-0 of word 3 */
69 uint8_t port_name[WWN_SIZE];
70 uint8_t node_name[WWN_SIZE];
72 uint8_t reserved_3[24];
75 struct vp_database_24xx {
76 uint16_t vp_status;
77 uint8_t options;
78 uint8_t id;
79 uint8_t port_name[WWN_SIZE];
80 uint8_t node_name[WWN_SIZE];
81 uint16_t port_id_low;
82 uint16_t port_id_high;
85 struct nvram_24xx {
86 /* NVRAM header. */
87 uint8_t id[4];
88 uint16_t nvram_version;
89 uint16_t reserved_0;
91 /* Firmware Initialization Control Block. */
92 uint16_t version;
93 uint16_t reserved_1;
94 uint16_t frame_payload_size;
95 uint16_t execution_throttle;
96 uint16_t exchange_count;
97 uint16_t hard_address;
99 uint8_t port_name[WWN_SIZE];
100 uint8_t node_name[WWN_SIZE];
102 uint16_t login_retry_count;
103 uint16_t link_down_on_nos;
104 uint16_t interrupt_delay_timer;
105 uint16_t login_timeout;
107 uint32_t firmware_options_1;
108 uint32_t firmware_options_2;
109 uint32_t firmware_options_3;
111 /* Offset 56. */
114 * BIT 0 = Control Enable
115 * BIT 1-15 =
117 * BIT 0-7 = Reserved
118 * BIT 8-10 = Output Swing 1G
119 * BIT 11-13 = Output Emphasis 1G
120 * BIT 14-15 = Reserved
122 * BIT 0-7 = Reserved
123 * BIT 8-10 = Output Swing 2G
124 * BIT 11-13 = Output Emphasis 2G
125 * BIT 14-15 = Reserved
127 * BIT 0-7 = Reserved
128 * BIT 8-10 = Output Swing 4G
129 * BIT 11-13 = Output Emphasis 4G
130 * BIT 14-15 = Reserved
132 uint16_t seriallink_options[4];
134 uint16_t reserved_2[16];
136 /* Offset 96. */
137 uint16_t reserved_3[16];
139 /* PCIe table entries. */
140 uint16_t reserved_4[16];
142 /* Offset 160. */
143 uint16_t reserved_5[16];
145 /* Offset 192. */
146 uint16_t reserved_6[16];
148 /* Offset 224. */
149 uint16_t reserved_7[16];
152 * BIT 0 = Enable spinup delay
153 * BIT 1 = Disable BIOS
154 * BIT 2 = Enable Memory Map BIOS
155 * BIT 3 = Enable Selectable Boot
156 * BIT 4 = Disable RISC code load
157 * BIT 5 = Disable Serdes
158 * BIT 6 =
159 * BIT 7 =
161 * BIT 8 =
162 * BIT 9 =
163 * BIT 10 = Enable lip full login
164 * BIT 11 = Enable target reset
165 * BIT 12 =
166 * BIT 13 =
167 * BIT 14 =
168 * BIT 15 = Enable alternate WWN
170 * BIT 16-31 =
172 uint32_t host_p;
174 uint8_t alternate_port_name[WWN_SIZE];
175 uint8_t alternate_node_name[WWN_SIZE];
177 uint8_t boot_port_name[WWN_SIZE];
178 uint16_t boot_lun_number;
179 uint16_t reserved_8;
181 uint8_t alt1_boot_port_name[WWN_SIZE];
182 uint16_t alt1_boot_lun_number;
183 uint16_t reserved_9;
185 uint8_t alt2_boot_port_name[WWN_SIZE];
186 uint16_t alt2_boot_lun_number;
187 uint16_t reserved_10;
189 uint8_t alt3_boot_port_name[WWN_SIZE];
190 uint16_t alt3_boot_lun_number;
191 uint16_t reserved_11;
194 * BIT 0 = Selective Login
195 * BIT 1 = Alt-Boot Enable
196 * BIT 2 = Reserved
197 * BIT 3 = Boot Order List
198 * BIT 4 = Reserved
199 * BIT 5 = Selective LUN
200 * BIT 6 = Reserved
201 * BIT 7-31 =
203 uint32_t efi_parameters;
205 uint8_t reset_delay;
206 uint8_t reserved_12;
207 uint16_t reserved_13;
209 uint16_t boot_id_number;
210 uint16_t reserved_14;
212 uint16_t max_luns_per_target;
213 uint16_t reserved_15;
215 uint16_t port_down_retry_count;
216 uint16_t link_down_timeout;
218 /* FCode parameters. */
219 uint16_t fcode_parameter;
221 uint16_t reserved_16[3];
223 /* Offset 352. */
224 uint8_t prev_drv_ver_major;
225 uint8_t prev_drv_ver_submajob;
226 uint8_t prev_drv_ver_minor;
227 uint8_t prev_drv_ver_subminor;
229 uint16_t prev_bios_ver_major;
230 uint16_t prev_bios_ver_minor;
232 uint16_t prev_efi_ver_major;
233 uint16_t prev_efi_ver_minor;
235 uint16_t prev_fw_ver_major;
236 uint8_t prev_fw_ver_minor;
237 uint8_t prev_fw_ver_subminor;
239 uint16_t reserved_17[8];
241 /* Offset 384. */
242 uint16_t reserved_18[16];
244 /* Offset 416. */
245 uint16_t reserved_19[16];
247 /* Offset 448. */
248 uint16_t reserved_20[16];
250 /* Offset 480. */
251 uint8_t model_name[16];
253 uint16_t reserved_21[2];
255 /* Offset 500. */
256 /* HW Parameter Block. */
257 uint16_t pcie_table_sig;
258 uint16_t pcie_table_offset;
260 uint16_t subsystem_vendor_id;
261 uint16_t subsystem_device_id;
263 uint32_t checksum;
267 * ISP Initialization Control Block.
268 * Little endian except where noted.
270 #define ICB_VERSION 1
271 struct init_cb_24xx {
272 uint16_t version;
273 uint16_t reserved_1;
275 uint16_t frame_payload_size;
276 uint16_t execution_throttle;
277 uint16_t exchange_count;
279 uint16_t hard_address;
281 uint8_t port_name[WWN_SIZE]; /* Big endian. */
282 uint8_t node_name[WWN_SIZE]; /* Big endian. */
284 uint16_t response_q_inpointer;
285 uint16_t request_q_outpointer;
287 uint16_t login_retry_count;
289 uint16_t prio_request_q_outpointer;
291 uint16_t response_q_length;
292 uint16_t request_q_length;
294 uint16_t link_down_on_nos; /* Milliseconds. */
296 uint16_t prio_request_q_length;
298 uint32_t request_q_address[2];
299 uint32_t response_q_address[2];
300 uint32_t prio_request_q_address[2];
302 uint8_t reserved_2[8];
304 uint16_t atio_q_inpointer;
305 uint16_t atio_q_length;
306 uint32_t atio_q_address[2];
308 uint16_t interrupt_delay_timer; /* 100us increments. */
309 uint16_t login_timeout;
312 * BIT 0 = Enable Hard Loop Id
313 * BIT 1 = Enable Fairness
314 * BIT 2 = Enable Full-Duplex
315 * BIT 3 = Reserved
316 * BIT 4 = Enable Target Mode
317 * BIT 5 = Disable Initiator Mode
318 * BIT 6 = Reserved
319 * BIT 7 = Reserved
321 * BIT 8 = Reserved
322 * BIT 9 = Non Participating LIP
323 * BIT 10 = Descending Loop ID Search
324 * BIT 11 = Acquire Loop ID in LIPA
325 * BIT 12 = Reserved
326 * BIT 13 = Full Login after LIP
327 * BIT 14 = Node Name Option
328 * BIT 15-31 = Reserved
330 uint32_t firmware_options_1;
333 * BIT 0 = Operation Mode bit 0
334 * BIT 1 = Operation Mode bit 1
335 * BIT 2 = Operation Mode bit 2
336 * BIT 3 = Operation Mode bit 3
337 * BIT 4 = Connection Options bit 0
338 * BIT 5 = Connection Options bit 1
339 * BIT 6 = Connection Options bit 2
340 * BIT 7 = Enable Non part on LIHA failure
342 * BIT 8 = Enable Class 2
343 * BIT 9 = Enable ACK0
344 * BIT 10 = Reserved
345 * BIT 11 = Enable FC-SP Security
346 * BIT 12 = FC Tape Enable
347 * BIT 13 = Reserved
348 * BIT 14 = Enable Target PRLI Control
349 * BIT 15-31 = Reserved
351 uint32_t firmware_options_2;
354 * BIT 0 = Reserved
355 * BIT 1 = Soft ID only
356 * BIT 2 = Reserved
357 * BIT 3 = Reserved
358 * BIT 4 = FCP RSP Payload bit 0
359 * BIT 5 = FCP RSP Payload bit 1
360 * BIT 6 = Enable Receive Out-of-Order data frame handling
361 * BIT 7 = Disable Automatic PLOGI on Local Loop
363 * BIT 8 = Reserved
364 * BIT 9 = Enable Out-of-Order FCP_XFER_RDY relative offset handling
365 * BIT 10 = Reserved
366 * BIT 11 = Reserved
367 * BIT 12 = Reserved
368 * BIT 13 = Data Rate bit 0
369 * BIT 14 = Data Rate bit 1
370 * BIT 15 = Data Rate bit 2
371 * BIT 16 = Enable 75 ohm Termination Select
372 * BIT 17-31 = Reserved
374 uint32_t firmware_options_3;
376 uint8_t reserved_3[24];
380 * ISP queue - command entry structure definition.
382 #define COMMAND_TYPE_6 0x48 /* Command Type 6 entry */
383 struct cmd_type_6 {
384 uint8_t entry_type; /* Entry type. */
385 uint8_t entry_count; /* Entry count. */
386 uint8_t sys_define; /* System defined. */
387 uint8_t entry_status; /* Entry Status. */
389 uint32_t handle; /* System handle. */
391 uint16_t nport_handle; /* N_PORT handle. */
392 uint16_t timeout; /* Command timeout. */
394 uint16_t dseg_count; /* Data segment count. */
396 uint16_t fcp_rsp_dsd_len; /* FCP_RSP DSD length. */
398 struct scsi_lun lun; /* FCP LUN (BE). */
400 uint16_t control_flags; /* Control flags. */
401 #define CF_DATA_SEG_DESCR_ENABLE BIT_2
402 #define CF_READ_DATA BIT_1
403 #define CF_WRITE_DATA BIT_0
405 uint16_t fcp_cmnd_dseg_len; /* Data segment length. */
406 uint32_t fcp_cmnd_dseg_address[2]; /* Data segment address. */
408 uint32_t fcp_rsp_dseg_address[2]; /* Data segment address. */
410 uint32_t byte_count; /* Total byte count. */
412 uint8_t port_id[3]; /* PortID of destination port. */
413 uint8_t vp_index;
415 uint32_t fcp_data_dseg_address[2]; /* Data segment address. */
416 uint16_t fcp_data_dseg_len; /* Data segment length. */
417 uint16_t reserved_1; /* MUST be set to 0. */
420 #define COMMAND_TYPE_7 0x18 /* Command Type 7 entry */
421 struct cmd_type_7 {
422 uint8_t entry_type; /* Entry type. */
423 uint8_t entry_count; /* Entry count. */
424 uint8_t sys_define; /* System defined. */
425 uint8_t entry_status; /* Entry Status. */
427 uint32_t handle; /* System handle. */
429 uint16_t nport_handle; /* N_PORT handle. */
430 uint16_t timeout; /* Command timeout. */
431 #define FW_MAX_TIMEOUT 0x1999
433 uint16_t dseg_count; /* Data segment count. */
434 uint16_t reserved_1;
436 struct scsi_lun lun; /* FCP LUN (BE). */
438 uint16_t task_mgmt_flags; /* Task management flags. */
439 #define TMF_CLEAR_ACA BIT_14
440 #define TMF_TARGET_RESET BIT_13
441 #define TMF_LUN_RESET BIT_12
442 #define TMF_CLEAR_TASK_SET BIT_10
443 #define TMF_ABORT_TASK_SET BIT_9
444 #define TMF_DSD_LIST_ENABLE BIT_2
445 #define TMF_READ_DATA BIT_1
446 #define TMF_WRITE_DATA BIT_0
448 uint8_t task;
449 #define TSK_SIMPLE 0
450 #define TSK_HEAD_OF_QUEUE 1
451 #define TSK_ORDERED 2
452 #define TSK_ACA 4
453 #define TSK_UNTAGGED 5
455 uint8_t crn;
457 uint8_t fcp_cdb[MAX_CMDSZ]; /* SCSI command words. */
458 uint32_t byte_count; /* Total byte count. */
460 uint8_t port_id[3]; /* PortID of destination port. */
461 uint8_t vp_index;
463 uint32_t dseg_0_address[2]; /* Data segment 0 address. */
464 uint32_t dseg_0_len; /* Data segment 0 length. */
468 * ISP queue - status entry structure definition.
470 #define STATUS_TYPE 0x03 /* Status entry. */
471 struct sts_entry_24xx {
472 uint8_t entry_type; /* Entry type. */
473 uint8_t entry_count; /* Entry count. */
474 uint8_t sys_define; /* System defined. */
475 uint8_t entry_status; /* Entry Status. */
477 uint32_t handle; /* System handle. */
479 uint16_t comp_status; /* Completion status. */
480 uint16_t ox_id; /* OX_ID used by the firmware. */
482 uint32_t residual_len; /* FW calc residual transfer length. */
484 uint16_t reserved_1;
485 uint16_t state_flags; /* State flags. */
486 #define SF_TRANSFERRED_DATA BIT_11
487 #define SF_FCP_RSP_DMA BIT_0
489 uint16_t reserved_2;
490 uint16_t scsi_status; /* SCSI status. */
491 #define SS_CONFIRMATION_REQ BIT_12
493 uint32_t rsp_residual_count; /* FCP RSP residual count. */
495 uint32_t sense_len; /* FCP SENSE length. */
496 uint32_t rsp_data_len; /* FCP response data length. */
498 uint8_t data[28]; /* FCP response/sense information. */
502 * Status entry completion status
504 #define CS_DATA_REASSEMBLY_ERROR 0x11 /* Data Reassembly Error.. */
505 #define CS_ABTS_BY_TARGET 0x13 /* Target send ABTS to abort IOCB. */
506 #define CS_FW_RESOURCE 0x2C /* Firmware Resource Unavailable. */
507 #define CS_TASK_MGMT_OVERRUN 0x30 /* Task management overrun (8+). */
508 #define CS_ABORT_BY_TARGET 0x47 /* Abort By Target. */
511 * ISP queue - marker entry structure definition.
513 #define MARKER_TYPE 0x04 /* Marker entry. */
514 struct mrk_entry_24xx {
515 uint8_t entry_type; /* Entry type. */
516 uint8_t entry_count; /* Entry count. */
517 uint8_t handle_count; /* Handle count. */
518 uint8_t entry_status; /* Entry Status. */
520 uint32_t handle; /* System handle. */
522 uint16_t nport_handle; /* N_PORT handle. */
524 uint8_t modifier; /* Modifier (7-0). */
525 #define MK_SYNC_ID_LUN 0 /* Synchronize ID/LUN */
526 #define MK_SYNC_ID 1 /* Synchronize ID */
527 #define MK_SYNC_ALL 2 /* Synchronize all ID/LUN */
528 uint8_t reserved_1;
530 uint8_t reserved_2;
531 uint8_t vp_index;
533 uint16_t reserved_3;
535 uint8_t lun[8]; /* FCP LUN (BE). */
536 uint8_t reserved_4[40];
540 * ISP queue - CT Pass-Through entry structure definition.
542 #define CT_IOCB_TYPE 0x29 /* CT Pass-Through IOCB entry */
543 struct ct_entry_24xx {
544 uint8_t entry_type; /* Entry type. */
545 uint8_t entry_count; /* Entry count. */
546 uint8_t sys_define; /* System Defined. */
547 uint8_t entry_status; /* Entry Status. */
549 uint32_t handle; /* System handle. */
551 uint16_t comp_status; /* Completion status. */
553 uint16_t nport_handle; /* N_PORT handle. */
555 uint16_t cmd_dsd_count;
557 uint8_t vp_index;
558 uint8_t reserved_1;
560 uint16_t timeout; /* Command timeout. */
561 uint16_t reserved_2;
563 uint16_t rsp_dsd_count;
565 uint8_t reserved_3[10];
567 uint32_t rsp_byte_count;
568 uint32_t cmd_byte_count;
570 uint32_t dseg_0_address[2]; /* Data segment 0 address. */
571 uint32_t dseg_0_len; /* Data segment 0 length. */
572 uint32_t dseg_1_address[2]; /* Data segment 1 address. */
573 uint32_t dseg_1_len; /* Data segment 1 length. */
577 * ISP queue - ELS Pass-Through entry structure definition.
579 #define ELS_IOCB_TYPE 0x53 /* ELS Pass-Through IOCB entry */
580 struct els_entry_24xx {
581 uint8_t entry_type; /* Entry type. */
582 uint8_t entry_count; /* Entry count. */
583 uint8_t sys_define; /* System Defined. */
584 uint8_t entry_status; /* Entry Status. */
586 uint32_t handle; /* System handle. */
588 uint16_t reserved_1;
590 uint16_t nport_handle; /* N_PORT handle. */
592 uint16_t tx_dsd_count;
594 uint8_t vp_index;
595 uint8_t sof_type;
596 #define EST_SOFI3 (1 << 4)
597 #define EST_SOFI2 (3 << 4)
599 uint32_t rx_xchg_address; /* Receive exchange address. */
600 uint16_t rx_dsd_count;
602 uint8_t opcode;
603 uint8_t reserved_2;
605 uint8_t port_id[3];
606 uint8_t reserved_3;
608 uint16_t reserved_4;
610 uint16_t control_flags; /* Control flags. */
611 #define ECF_PAYLOAD_DESCR_MASK (BIT_15|BIT_14|BIT_13)
612 #define EPD_ELS_COMMAND (0 << 13)
613 #define EPD_ELS_ACC (1 << 13)
614 #define EPD_ELS_RJT (2 << 13)
615 #define EPD_RX_XCHG (3 << 13)
616 #define ECF_CLR_PASSTHRU_PEND BIT_12
617 #define ECF_INCL_FRAME_HDR BIT_11
619 uint32_t rx_byte_count;
620 uint32_t tx_byte_count;
622 uint32_t tx_address[2]; /* Data segment 0 address. */
623 uint32_t tx_len; /* Data segment 0 length. */
624 uint32_t rx_address[2]; /* Data segment 1 address. */
625 uint32_t rx_len; /* Data segment 1 length. */
629 * ISP queue - Mailbox Command entry structure definition.
631 #define MBX_IOCB_TYPE 0x39
632 struct mbx_entry_24xx {
633 uint8_t entry_type; /* Entry type. */
634 uint8_t entry_count; /* Entry count. */
635 uint8_t handle_count; /* Handle count. */
636 uint8_t entry_status; /* Entry Status. */
638 uint32_t handle; /* System handle. */
640 uint16_t mbx[28];
644 #define LOGINOUT_PORT_IOCB_TYPE 0x52 /* Login/Logout Port entry. */
645 struct logio_entry_24xx {
646 uint8_t entry_type; /* Entry type. */
647 uint8_t entry_count; /* Entry count. */
648 uint8_t sys_define; /* System defined. */
649 uint8_t entry_status; /* Entry Status. */
651 uint32_t handle; /* System handle. */
653 uint16_t comp_status; /* Completion status. */
654 #define CS_LOGIO_ERROR 0x31 /* Login/Logout IOCB error. */
656 uint16_t nport_handle; /* N_PORT handle. */
658 uint16_t control_flags; /* Control flags. */
659 /* Modifiers. */
660 #define LCF_INCLUDE_SNS BIT_10 /* Include SNS (FFFFFC) during LOGO. */
661 #define LCF_FCP2_OVERRIDE BIT_9 /* Set/Reset word 3 of PRLI. */
662 #define LCF_CLASS_2 BIT_8 /* Enable class 2 during PLOGI. */
663 #define LCF_FREE_NPORT BIT_7 /* Release NPORT handle after LOGO. */
664 #define LCF_EXPL_LOGO BIT_6 /* Perform an explicit LOGO. */
665 #define LCF_SKIP_PRLI BIT_5 /* Skip PRLI after PLOGI. */
666 #define LCF_IMPL_LOGO_ALL BIT_5 /* Implicit LOGO to all ports. */
667 #define LCF_COND_PLOGI BIT_4 /* PLOGI only if not logged-in. */
668 #define LCF_IMPL_LOGO BIT_4 /* Perform an implicit LOGO. */
669 #define LCF_IMPL_PRLO BIT_4 /* Perform an implicit PRLO. */
670 /* Commands. */
671 #define LCF_COMMAND_PLOGI 0x00 /* PLOGI. */
672 #define LCF_COMMAND_PRLI 0x01 /* PRLI. */
673 #define LCF_COMMAND_PDISC 0x02 /* PDISC. */
674 #define LCF_COMMAND_ADISC 0x03 /* ADISC. */
675 #define LCF_COMMAND_LOGO 0x08 /* LOGO. */
676 #define LCF_COMMAND_PRLO 0x09 /* PRLO. */
677 #define LCF_COMMAND_TPRLO 0x0A /* TPRLO. */
679 uint8_t vp_index;
680 uint8_t reserved_1;
682 uint8_t port_id[3]; /* PortID of destination port. */
684 uint8_t rsp_size; /* Response size in 32bit words. */
686 uint32_t io_parameter[11]; /* General I/O parameters. */
687 #define LSC_SCODE_NOLINK 0x01
688 #define LSC_SCODE_NOIOCB 0x02
689 #define LSC_SCODE_NOXCB 0x03
690 #define LSC_SCODE_CMD_FAILED 0x04
691 #define LSC_SCODE_NOFABRIC 0x05
692 #define LSC_SCODE_FW_NOT_READY 0x07
693 #define LSC_SCODE_NOT_LOGGED_IN 0x09
694 #define LSC_SCODE_NOPCB 0x0A
696 #define LSC_SCODE_ELS_REJECT 0x18
697 #define LSC_SCODE_CMD_PARAM_ERR 0x19
698 #define LSC_SCODE_PORTID_USED 0x1A
699 #define LSC_SCODE_NPORT_USED 0x1B
700 #define LSC_SCODE_NONPORT 0x1C
701 #define LSC_SCODE_LOGGED_IN 0x1D
702 #define LSC_SCODE_NOFLOGI_ACC 0x1F
705 #define TSK_MGMT_IOCB_TYPE 0x14
706 struct tsk_mgmt_entry {
707 uint8_t entry_type; /* Entry type. */
708 uint8_t entry_count; /* Entry count. */
709 uint8_t handle_count; /* Handle count. */
710 uint8_t entry_status; /* Entry Status. */
712 uint32_t handle; /* System handle. */
714 uint16_t nport_handle; /* N_PORT handle. */
716 uint16_t reserved_1;
718 uint16_t delay; /* Activity delay in seconds. */
720 uint16_t timeout; /* Command timeout. */
722 uint8_t lun[8]; /* FCP LUN (BE). */
724 uint32_t control_flags; /* Control Flags. */
725 #define TCF_NOTMCMD_TO_TARGET BIT_31
726 #define TCF_LUN_RESET BIT_4
727 #define TCF_ABORT_TASK_SET BIT_3
728 #define TCF_CLEAR_TASK_SET BIT_2
729 #define TCF_TARGET_RESET BIT_1
730 #define TCF_CLEAR_ACA BIT_0
732 uint8_t reserved_2[20];
734 uint8_t port_id[3]; /* PortID of destination port. */
735 uint8_t vp_index;
737 uint8_t reserved_3[12];
740 #define ABORT_IOCB_TYPE 0x33
741 struct abort_entry_24xx {
742 uint8_t entry_type; /* Entry type. */
743 uint8_t entry_count; /* Entry count. */
744 uint8_t handle_count; /* Handle count. */
745 uint8_t entry_status; /* Entry Status. */
747 uint32_t handle; /* System handle. */
749 uint16_t nport_handle; /* N_PORT handle. */
750 /* or Completion status. */
752 uint16_t options; /* Options. */
753 #define AOF_NO_ABTS BIT_0 /* Do not send any ABTS. */
755 uint32_t handle_to_abort; /* System handle to abort. */
757 uint8_t reserved_1[32];
759 uint8_t port_id[3]; /* PortID of destination port. */
760 uint8_t vp_index;
762 uint8_t reserved_2[12];
766 * ISP I/O Register Set structure definitions.
768 struct device_reg_24xx {
769 uint32_t flash_addr; /* Flash/NVRAM BIOS address. */
770 #define FARX_DATA_FLAG BIT_31
771 #define FARX_ACCESS_FLASH_CONF 0x7FFD0000
772 #define FARX_ACCESS_FLASH_DATA 0x7FF00000
773 #define FARX_ACCESS_NVRAM_CONF 0x7FFF0000
774 #define FARX_ACCESS_NVRAM_DATA 0x7FFE0000
776 #define FA_NVRAM_FUNC0_ADDR 0x80
777 #define FA_NVRAM_FUNC1_ADDR 0x180
779 #define FA_NVRAM_VPD_SIZE 0x200
780 #define FA_NVRAM_VPD0_ADDR 0x00
781 #define FA_NVRAM_VPD1_ADDR 0x100
783 #define FA_BOOT_CODE_ADDR 0x00000
785 * RISC code begins at offset 512KB
786 * within flash. Consisting of two
787 * contiguous RISC code segments.
789 #define FA_RISC_CODE_ADDR 0x20000
790 #define FA_RISC_CODE_SEGMENTS 2
792 #define FA_FW_AREA_ADDR 0x40000
793 #define FA_VPD_NVRAM_ADDR 0x48000
794 #define FA_FEATURE_ADDR 0x4C000
795 #define FA_FLASH_DESCR_ADDR 0x50000
796 #define FA_HW_EVENT_ADDR 0x54000
797 #define FA_BOOT_LOG_ADDR 0x58000
798 #define FA_FW_DUMP0_ADDR 0x60000
799 #define FA_FW_DUMP1_ADDR 0x70000
801 uint32_t flash_data; /* Flash/NVRAM BIOS data. */
803 uint32_t ctrl_status; /* Control/Status. */
804 #define CSRX_FLASH_ACCESS_ERROR BIT_18 /* Flash/NVRAM Access Error. */
805 #define CSRX_DMA_ACTIVE BIT_17 /* DMA Active status. */
806 #define CSRX_DMA_SHUTDOWN BIT_16 /* DMA Shutdown control status. */
807 #define CSRX_FUNCTION BIT_15 /* Function number. */
808 /* PCI-X Bus Mode. */
809 #define CSRX_PCIX_BUS_MODE_MASK (BIT_11|BIT_10|BIT_9|BIT_8)
810 #define PBM_PCI_33MHZ (0 << 8)
811 #define PBM_PCIX_M1_66MHZ (1 << 8)
812 #define PBM_PCIX_M1_100MHZ (2 << 8)
813 #define PBM_PCIX_M1_133MHZ (3 << 8)
814 #define PBM_PCIX_M2_66MHZ (5 << 8)
815 #define PBM_PCIX_M2_100MHZ (6 << 8)
816 #define PBM_PCIX_M2_133MHZ (7 << 8)
817 #define PBM_PCI_66MHZ (8 << 8)
818 /* Max Write Burst byte count. */
819 #define CSRX_MAX_WRT_BURST_MASK (BIT_5|BIT_4)
820 #define MWB_512_BYTES (0 << 4)
821 #define MWB_1024_BYTES (1 << 4)
822 #define MWB_2048_BYTES (2 << 4)
823 #define MWB_4096_BYTES (3 << 4)
825 #define CSRX_64BIT_SLOT BIT_2 /* PCI 64-Bit Bus Slot. */
826 #define CSRX_FLASH_ENABLE BIT_1 /* Flash BIOS Read/Write enable. */
827 #define CSRX_ISP_SOFT_RESET BIT_0 /* ISP soft reset. */
829 uint32_t ictrl; /* Interrupt control. */
830 #define ICRX_EN_RISC_INT BIT_3 /* Enable RISC interrupts on PCI. */
832 uint32_t istatus; /* Interrupt status. */
833 #define ISRX_RISC_INT BIT_3 /* RISC interrupt. */
835 uint32_t unused_1[2]; /* Gap. */
837 /* Request Queue. */
838 uint32_t req_q_in; /* In-Pointer. */
839 uint32_t req_q_out; /* Out-Pointer. */
840 /* Response Queue. */
841 uint32_t rsp_q_in; /* In-Pointer. */
842 uint32_t rsp_q_out; /* Out-Pointer. */
843 /* Priority Request Queue. */
844 uint32_t preq_q_in; /* In-Pointer. */
845 uint32_t preq_q_out; /* Out-Pointer. */
847 uint32_t unused_2[2]; /* Gap. */
849 /* ATIO Queue. */
850 uint32_t atio_q_in; /* In-Pointer. */
851 uint32_t atio_q_out; /* Out-Pointer. */
853 uint32_t host_status;
854 #define HSRX_RISC_INT BIT_15 /* RISC to Host interrupt. */
855 #define HSRX_RISC_PAUSED BIT_8 /* RISC Paused. */
857 uint32_t hccr; /* Host command & control register. */
858 /* HCCR statuses. */
859 #define HCCRX_HOST_INT BIT_6 /* Host to RISC interrupt bit. */
860 #define HCCRX_RISC_RESET BIT_5 /* RISC Reset mode bit. */
861 #define HCCRX_RISC_PAUSE BIT_4 /* RISC Pause mode bit. */
862 /* HCCR commands. */
863 /* NOOP. */
864 #define HCCRX_NOOP 0x00000000
865 /* Set RISC Reset. */
866 #define HCCRX_SET_RISC_RESET 0x10000000
867 /* Clear RISC Reset. */
868 #define HCCRX_CLR_RISC_RESET 0x20000000
869 /* Set RISC Pause. */
870 #define HCCRX_SET_RISC_PAUSE 0x30000000
871 /* Releases RISC Pause. */
872 #define HCCRX_REL_RISC_PAUSE 0x40000000
873 /* Set HOST to RISC interrupt. */
874 #define HCCRX_SET_HOST_INT 0x50000000
875 /* Clear HOST to RISC interrupt. */
876 #define HCCRX_CLR_HOST_INT 0x60000000
877 /* Clear RISC to PCI interrupt. */
878 #define HCCRX_CLR_RISC_INT 0xA0000000
880 uint32_t gpiod; /* GPIO Data register. */
882 /* LED update mask. */
883 #define GPDX_LED_UPDATE_MASK (BIT_20|BIT_19|BIT_18)
884 /* Data update mask. */
885 #define GPDX_DATA_UPDATE_MASK (BIT_17|BIT_16)
886 /* Data update mask. */
887 #define GPDX_DATA_UPDATE_2_MASK (BIT_28|BIT_27|BIT_26|BIT_17|BIT_16)
888 /* LED control mask. */
889 #define GPDX_LED_COLOR_MASK (BIT_4|BIT_3|BIT_2)
890 /* LED bit values. Color names as
891 * referenced in fw spec.
893 #define GPDX_LED_YELLOW_ON BIT_2
894 #define GPDX_LED_GREEN_ON BIT_3
895 #define GPDX_LED_AMBER_ON BIT_4
896 /* Data in/out. */
897 #define GPDX_DATA_INOUT (BIT_1|BIT_0)
899 uint32_t gpioe; /* GPIO Enable register. */
900 /* Enable update mask. */
901 #define GPEX_ENABLE_UPDATE_MASK (BIT_17|BIT_16)
902 /* Enable update mask. */
903 #define GPEX_ENABLE_UPDATE_2_MASK (BIT_28|BIT_27|BIT_26|BIT_17|BIT_16)
904 /* Enable. */
905 #define GPEX_ENABLE (BIT_1|BIT_0)
907 uint32_t iobase_addr; /* I/O Bus Base Address register. */
909 uint32_t unused_3[10]; /* Gap. */
911 uint16_t mailbox0;
912 uint16_t mailbox1;
913 uint16_t mailbox2;
914 uint16_t mailbox3;
915 uint16_t mailbox4;
916 uint16_t mailbox5;
917 uint16_t mailbox6;
918 uint16_t mailbox7;
919 uint16_t mailbox8;
920 uint16_t mailbox9;
921 uint16_t mailbox10;
922 uint16_t mailbox11;
923 uint16_t mailbox12;
924 uint16_t mailbox13;
925 uint16_t mailbox14;
926 uint16_t mailbox15;
927 uint16_t mailbox16;
928 uint16_t mailbox17;
929 uint16_t mailbox18;
930 uint16_t mailbox19;
931 uint16_t mailbox20;
932 uint16_t mailbox21;
933 uint16_t mailbox22;
934 uint16_t mailbox23;
935 uint16_t mailbox24;
936 uint16_t mailbox25;
937 uint16_t mailbox26;
938 uint16_t mailbox27;
939 uint16_t mailbox28;
940 uint16_t mailbox29;
941 uint16_t mailbox30;
942 uint16_t mailbox31;
944 uint32_t iobase_window;
945 uint32_t iobase_c4;
946 uint32_t iobase_c8;
947 uint32_t unused_4_1[6]; /* Gap. */
948 uint32_t iobase_q;
949 uint32_t unused_5[2]; /* Gap. */
950 uint32_t iobase_select;
951 uint32_t unused_6[2]; /* Gap. */
952 uint32_t iobase_sdata;
955 /* Trace Control *************************************************************/
957 #define TC_AEN_DISABLE 0
959 #define TC_EFT_ENABLE 4
960 #define TC_EFT_DISABLE 5
962 #define TC_FCE_ENABLE 8
963 #define TC_FCE_OPTIONS 0
964 #define TC_FCE_DEFAULT_RX_SIZE 2112
965 #define TC_FCE_DEFAULT_TX_SIZE 2112
966 #define TC_FCE_DISABLE 9
967 #define TC_FCE_DISABLE_TRACE BIT_0
969 /* MID Support ***************************************************************/
971 #define MIN_MULTI_ID_FABRIC 64 /* Must be power-of-2. */
972 #define MAX_MULTI_ID_FABRIC 256 /* ... */
974 #define for_each_mapped_vp_idx(_ha, _idx) \
975 for (_idx = find_next_bit((_ha)->vp_idx_map, \
976 (_ha)->max_npiv_vports + 1, 1); \
977 _idx <= (_ha)->max_npiv_vports; \
978 _idx = find_next_bit((_ha)->vp_idx_map, \
979 (_ha)->max_npiv_vports + 1, _idx + 1)) \
981 struct mid_conf_entry_24xx {
982 uint16_t reserved_1;
985 * BIT 0 = Enable Hard Loop Id
986 * BIT 1 = Acquire Loop ID in LIPA
987 * BIT 2 = ID not Acquired
988 * BIT 3 = Enable VP
989 * BIT 4 = Enable Initiator Mode
990 * BIT 5 = Disable Target Mode
991 * BIT 6-7 = Reserved
993 uint8_t options;
995 uint8_t hard_address;
997 uint8_t port_name[WWN_SIZE];
998 uint8_t node_name[WWN_SIZE];
1001 struct mid_init_cb_24xx {
1002 struct init_cb_24xx init_cb;
1004 uint16_t count;
1005 uint16_t options;
1007 struct mid_conf_entry_24xx entries[MAX_MULTI_ID_FABRIC];
1011 struct mid_db_entry_24xx {
1012 uint16_t status;
1013 #define MDBS_NON_PARTIC BIT_3
1014 #define MDBS_ID_ACQUIRED BIT_1
1015 #define MDBS_ENABLED BIT_0
1017 uint8_t options;
1018 uint8_t hard_address;
1020 uint8_t port_name[WWN_SIZE];
1021 uint8_t node_name[WWN_SIZE];
1023 uint8_t port_id[3];
1024 uint8_t reserved_1;
1028 * Virtual Fabric ID type definition.
1030 typedef struct vf_id {
1031 uint16_t id : 12;
1032 uint16_t priority : 4;
1033 } vf_id_t;
1036 * Virtual Fabric HopCt type definition.
1038 typedef struct vf_hopct {
1039 uint16_t reserved : 8;
1040 uint16_t hopct : 8;
1041 } vf_hopct_t;
1044 * Virtual Port Control IOCB
1046 #define VP_CTRL_IOCB_TYPE 0x30 /* Vitual Port Control entry. */
1047 struct vp_ctrl_entry_24xx {
1048 uint8_t entry_type; /* Entry type. */
1049 uint8_t entry_count; /* Entry count. */
1050 uint8_t sys_define; /* System defined. */
1051 uint8_t entry_status; /* Entry Status. */
1053 uint32_t handle; /* System handle. */
1055 uint16_t vp_idx_failed;
1057 uint16_t comp_status; /* Completion status. */
1058 #define CS_VCE_IOCB_ERROR 0x01 /* Error processing IOCB */
1059 #define CS_VCE_ACQ_ID_ERROR 0x02 /* Error while acquireing ID. */
1060 #define CS_VCE_BUSY 0x05 /* Firmware not ready to accept cmd. */
1062 uint16_t command;
1063 #define VCE_COMMAND_ENABLE_VPS 0x00 /* Enable VPs. */
1064 #define VCE_COMMAND_DISABLE_VPS 0x08 /* Disable VPs. */
1065 #define VCE_COMMAND_DISABLE_VPS_REINIT 0x09 /* Disable VPs and reinit link. */
1066 #define VCE_COMMAND_DISABLE_VPS_LOGO 0x0a /* Disable VPs and LOGO ports. */
1067 #define VCE_COMMAND_DISABLE_VPS_LOGO_ALL 0x0b /* Disable VPs and LOGO ports. */
1069 uint16_t vp_count;
1071 uint8_t vp_idx_map[16];
1072 uint16_t flags;
1073 struct vf_id id;
1074 uint16_t reserved_4;
1075 struct vf_hopct hopct;
1076 uint8_t reserved_5[8];
1080 * Modify Virtual Port Configuration IOCB
1082 #define VP_CONFIG_IOCB_TYPE 0x31 /* Vitual Port Config entry. */
1083 struct vp_config_entry_24xx {
1084 uint8_t entry_type; /* Entry type. */
1085 uint8_t entry_count; /* Entry count. */
1086 uint8_t handle_count;
1087 uint8_t entry_status; /* Entry Status. */
1089 uint32_t handle; /* System handle. */
1091 uint16_t flags;
1092 #define CS_VF_BIND_VPORTS_TO_VF BIT_0
1093 #define CS_VF_SET_QOS_OF_VPORTS BIT_1
1094 #define CS_VF_SET_HOPS_OF_VPORTS BIT_2
1096 uint16_t comp_status; /* Completion status. */
1097 #define CS_VCT_STS_ERROR 0x01 /* Specified VPs were not disabled. */
1098 #define CS_VCT_CNT_ERROR 0x02 /* Invalid VP count. */
1099 #define CS_VCT_ERROR 0x03 /* Unknown error. */
1100 #define CS_VCT_IDX_ERROR 0x02 /* Invalid VP index. */
1101 #define CS_VCT_BUSY 0x05 /* Firmware not ready to accept cmd. */
1103 uint8_t command;
1104 #define VCT_COMMAND_MOD_VPS 0x00 /* Modify VP configurations. */
1105 #define VCT_COMMAND_MOD_ENABLE_VPS 0x01 /* Modify configuration & enable VPs. */
1107 uint8_t vp_count;
1109 uint8_t vp_index1;
1110 uint8_t vp_index2;
1112 uint8_t options_idx1;
1113 uint8_t hard_address_idx1;
1114 uint16_t reserved_vp1;
1115 uint8_t port_name_idx1[WWN_SIZE];
1116 uint8_t node_name_idx1[WWN_SIZE];
1118 uint8_t options_idx2;
1119 uint8_t hard_address_idx2;
1120 uint16_t reserved_vp2;
1121 uint8_t port_name_idx2[WWN_SIZE];
1122 uint8_t node_name_idx2[WWN_SIZE];
1123 struct vf_id id;
1124 uint16_t reserved_4;
1125 struct vf_hopct hopct;
1126 uint8_t reserved_5;
1129 #define VP_RPT_ID_IOCB_TYPE 0x32 /* Report ID Acquisition entry. */
1130 struct vp_rpt_id_entry_24xx {
1131 uint8_t entry_type; /* Entry type. */
1132 uint8_t entry_count; /* Entry count. */
1133 uint8_t sys_define; /* System defined. */
1134 uint8_t entry_status; /* Entry Status. */
1136 uint32_t handle; /* System handle. */
1138 uint16_t vp_count; /* Format 0 -- | VP setup | VP acq |. */
1139 /* Format 1 -- | VP count |. */
1140 uint16_t vp_idx; /* Format 0 -- Reserved. */
1141 /* Format 1 -- VP status and index. */
1143 uint8_t port_id[3];
1144 uint8_t format;
1146 uint8_t vp_idx_map[16];
1148 uint8_t reserved_4[32];
1151 #define VF_EVFP_IOCB_TYPE 0x26 /* Exchange Virtual Fabric Parameters entry. */
1152 struct vf_evfp_entry_24xx {
1153 uint8_t entry_type; /* Entry type. */
1154 uint8_t entry_count; /* Entry count. */
1155 uint8_t sys_define; /* System defined. */
1156 uint8_t entry_status; /* Entry Status. */
1158 uint32_t handle; /* System handle. */
1159 uint16_t comp_status; /* Completion status. */
1160 uint16_t timeout; /* timeout */
1161 uint16_t adim_tagging_mode;
1163 uint16_t vfport_id;
1164 uint32_t exch_addr;
1166 uint16_t nport_handle; /* N_PORT handle. */
1167 uint16_t control_flags;
1168 uint32_t io_parameter_0;
1169 uint32_t io_parameter_1;
1170 uint32_t tx_address[2]; /* Data segment 0 address. */
1171 uint32_t tx_len; /* Data segment 0 length. */
1172 uint32_t rx_address[2]; /* Data segment 1 address. */
1173 uint32_t rx_len; /* Data segment 1 length. */
1176 /* END MID Support ***********************************************************/
1177 #endif