drivers/scsi/qla4xxx/ql4_fw.h

   1 /*
   2  * QLogic iSCSI HBA Driver
   3  * Copyright (c)  2003-2012 QLogic Corporation
   4  *
   5  * See LICENSE.qla4xxx for copyright and licensing details.
   6  */
   7
   8 #ifndef _QLA4X_FW_H
   9 #define _QLA4X_FW_H
  10
  11
  12 #define MAX_PRST_DEV_DB_ENTRIES         64
  13 #define MIN_DISC_DEV_DB_ENTRY           MAX_PRST_DEV_DB_ENTRIES
  14 #define MAX_DEV_DB_ENTRIES              512
  15 #define MAX_DEV_DB_ENTRIES_40XX         256
  16
  17 /*************************************************************************
  18  *
  19  *              ISP 4010 I/O Register Set Structure and Definitions
  20  *
  21  *************************************************************************/
  22
  23 struct port_ctrl_stat_regs {
  24         __le32 ext_hw_conf;     /* 0x50  R/W */
  25         __le32 rsrvd0;          /* 0x54 */
  26         __le32 port_ctrl;       /* 0x58 */
  27         __le32 port_status;     /* 0x5c */
  28         __le32 rsrvd1[32];      /* 0x60-0xdf */
  29         __le32 gp_out;          /* 0xe0 */
  30         __le32 gp_in;           /* 0xe4 */
  31         __le32 rsrvd2[5];       /* 0xe8-0xfb */
  32         __le32 port_err_status; /* 0xfc */
  33 };
  34
  35 struct host_mem_cfg_regs {
  36         __le32 rsrvd0[12];      /* 0x50-0x79 */
  37         __le32 req_q_out;       /* 0x80 */
  38         __le32 rsrvd1[31];      /* 0x84-0xFF */
  39 };
  40
  41 /*
  42  * ISP 82xx I/O Register Set structure definitions.
  43  */
  44 struct device_reg_82xx {
  45         __le32 req_q_out;       /* 0x0000 (R): Request Queue out-Pointer. */
  46         __le32 reserve1[63];    /* Request Queue out-Pointer. (64 * 4) */
  47         __le32 rsp_q_in;        /* 0x0100 (R/W): Response Queue In-Pointer. */
  48         __le32 reserve2[63];    /* Response Queue In-Pointer. */
  49         __le32 rsp_q_out;       /* 0x0200 (R/W): Response Queue Out-Pointer. */
  50         __le32 reserve3[63];    /* Response Queue Out-Pointer. */
  51
  52         __le32 mailbox_in[8];   /* 0x0300 (R/W): Mail box In registers */
  53         __le32 reserve4[24];
  54         __le32 hint;            /* 0x0380 (R/W): Host interrupt register */
  55 #define HINT_MBX_INT_PENDING    BIT_0
  56         __le32 reserve5[31];
  57         __le32 mailbox_out[8];  /* 0x0400 (R): Mail box Out registers */
  58         __le32 reserve6[56];
  59
  60         __le32 host_status;     /* Offset 0x500 (R): host status */
  61 #define HSRX_RISC_MB_INT        BIT_0  /* RISC to Host Mailbox interrupt */
  62 #define HSRX_RISC_IOCB_INT      BIT_1  /* RISC to Host IOCB interrupt */
  63
  64         __le32 host_int;        /* Offset 0x0504 (R/W): Interrupt status. */
  65 #define ISRX_82XX_RISC_INT      BIT_0 /* RISC interrupt. */
  66 };
  67
  68 /* ISP 83xx I/O Register Set structure */
  69 struct device_reg_83xx {
  70         __le32 mailbox_in[16];  /* 0x0000 */
  71         __le32 reserve1[496];   /* 0x0040 */
  72         __le32 mailbox_out[16]; /* 0x0800 */
  73         __le32 reserve2[496];
  74         __le32 mbox_int;        /* 0x1000 */
  75         __le32 reserve3[63];
  76         __le32 req_q_out;       /* 0x1100 */
  77         __le32 reserve4[63];
  78
  79         __le32 rsp_q_in;        /* 0x1200 */
  80         __le32 reserve5[1919];
  81
  82         __le32 req_q_in;        /* 0x3000 */
  83         __le32 reserve6[3];
  84         __le32 iocb_int_mask;   /* 0x3010 */
  85         __le32 reserve7[3];
  86         __le32 rsp_q_out;       /* 0x3020 */
  87         __le32 reserve8[3];
  88         __le32 anonymousbuff;   /* 0x3030 */
  89         __le32 mb_int_mask;     /* 0x3034 */
  90
  91         __le32 host_intr;       /* 0x3038 - Host Interrupt Register */
  92         __le32 risc_intr;       /* 0x303C - RISC Interrupt Register */
  93         __le32 reserve9[544];
  94         __le32 leg_int_ptr;     /* 0x38C0 - Legacy Interrupt Pointer Register */
  95         __le32 leg_int_trig;    /* 0x38C4 - Legacy Interrupt Trigger Control */
  96         __le32 leg_int_mask;    /* 0x38C8 - Legacy Interrupt Mask Register */
  97 };
  98
  99 #define INT_ENABLE_FW_MB        (1 << 2)
 100 #define INT_MASK_FW_MB          (1 << 2)
 101
 102 /*  remote register set (access via PCI memory read/write) */
 103 struct isp_reg {
 104 #define MBOX_REG_COUNT 8
 105         __le32 mailbox[MBOX_REG_COUNT];
 106
 107         __le32 flash_address;   /* 0x20 */
 108         __le32 flash_data;
 109         __le32 ctrl_status;
 110
 111         union {
 112                 struct {
 113                         __le32 nvram;
 114                         __le32 reserved1[2]; /* 0x30 */
 115                 } __attribute__ ((packed)) isp4010;
 116                 struct {
 117                         __le32 intr_mask;
 118                         __le32 nvram; /* 0x30 */
 119                         __le32 semaphore;
 120                 } __attribute__ ((packed)) isp4022;
 121         } u1;
 122
 123         __le32 req_q_in;    /* SCSI Request Queue Producer Index */
 124         __le32 rsp_q_out;   /* SCSI Completion Queue Consumer Index */
 125
 126         __le32 reserved2[4];    /* 0x40 */
 127
 128         union {
 129                 struct {
 130                         __le32 ext_hw_conf; /* 0x50 */
 131                         __le32 flow_ctrl;
 132                         __le32 port_ctrl;
 133                         __le32 port_status;
 134
 135                         __le32 reserved3[8]; /* 0x60 */
 136
 137                         __le32 req_q_out; /* 0x80 */
 138
 139                         __le32 reserved4[23]; /* 0x84 */
 140
 141                         __le32 gp_out; /* 0xe0 */
 142                         __le32 gp_in;
 143
 144                         __le32 reserved5[5];
 145
 146                         __le32 port_err_status; /* 0xfc */
 147                 } __attribute__ ((packed)) isp4010;
 148                 struct {
 149                         union {
 150                                 struct port_ctrl_stat_regs p0;
 151                                 struct host_mem_cfg_regs p1;
 152                         };
 153                 } __attribute__ ((packed)) isp4022;
 154         } u2;
 155 };                              /* 256 x100 */
 156
 157
 158 /* Semaphore Defines for 4010 */
 159 #define QL4010_DRVR_SEM_BITS    0x00000030
 160 #define QL4010_GPIO_SEM_BITS    0x000000c0
 161 #define QL4010_SDRAM_SEM_BITS   0x00000300
 162 #define QL4010_PHY_SEM_BITS     0x00000c00
 163 #define QL4010_NVRAM_SEM_BITS   0x00003000
 164 #define QL4010_FLASH_SEM_BITS   0x0000c000
 165
 166 #define QL4010_DRVR_SEM_MASK    0x00300000
 167 #define QL4010_GPIO_SEM_MASK    0x00c00000
 168 #define QL4010_SDRAM_SEM_MASK   0x03000000
 169 #define QL4010_PHY_SEM_MASK     0x0c000000
 170 #define QL4010_NVRAM_SEM_MASK   0x30000000
 171 #define QL4010_FLASH_SEM_MASK   0xc0000000
 172
 173 /* Semaphore Defines for 4022 */
 174 #define QL4022_RESOURCE_MASK_BASE_CODE 0x7
 175 #define QL4022_RESOURCE_BITS_BASE_CODE 0x4
 176
 177
 178 #define QL4022_DRVR_SEM_MASK    (QL4022_RESOURCE_MASK_BASE_CODE << (1+16))
 179 #define QL4022_DDR_RAM_SEM_MASK (QL4022_RESOURCE_MASK_BASE_CODE << (4+16))
 180 #define QL4022_PHY_GIO_SEM_MASK (QL4022_RESOURCE_MASK_BASE_CODE << (7+16))
 181 #define QL4022_NVRAM_SEM_MASK   (QL4022_RESOURCE_MASK_BASE_CODE << (10+16))
 182 #define QL4022_FLASH_SEM_MASK   (QL4022_RESOURCE_MASK_BASE_CODE << (13+16))
 183
 184 /* nvram address for 4032 */
 185 #define NVRAM_PORT0_BOOT_MODE           0x03b1
 186 #define NVRAM_PORT0_BOOT_PRI_TGT        0x03b2
 187 #define NVRAM_PORT0_BOOT_SEC_TGT        0x03bb
 188 #define NVRAM_PORT1_BOOT_MODE           0x07b1
 189 #define NVRAM_PORT1_BOOT_PRI_TGT        0x07b2
 190 #define NVRAM_PORT1_BOOT_SEC_TGT        0x07bb
 191
 192
 193 /* Page # defines for 4022 */
 194 #define PORT_CTRL_STAT_PAGE                     0       /* 4022 */
 195 #define HOST_MEM_CFG_PAGE                       1       /* 4022 */
 196 #define LOCAL_RAM_CFG_PAGE                      2       /* 4022 */
 197 #define PROT_STAT_PAGE                          3       /* 4022 */
 198
 199 /* Register Mask - sets corresponding mask bits in the upper word */
 200 static inline uint32_t set_rmask(uint32_t val)
 201 {
 202         return (val & 0xffff) | (val << 16);
 203 }
 204
 205
 206 static inline uint32_t clr_rmask(uint32_t val)
 207 {
 208         return 0 | (val << 16);
 209 }
 210
 211 /*  ctrl_status definitions */
 212 #define CSR_SCSI_PAGE_SELECT                    0x00000003
 213 #define CSR_SCSI_INTR_ENABLE                    0x00000004      /* 4010 */
 214 #define CSR_SCSI_RESET_INTR                     0x00000008
 215 #define CSR_SCSI_COMPLETION_INTR                0x00000010
 216 #define CSR_SCSI_PROCESSOR_INTR                 0x00000020
 217 #define CSR_INTR_RISC                           0x00000040
 218 #define CSR_BOOT_ENABLE                         0x00000080
 219 #define CSR_NET_PAGE_SELECT                     0x00000300      /* 4010 */
 220 #define CSR_FUNC_NUM                            0x00000700      /* 4022 */
 221 #define CSR_NET_RESET_INTR                      0x00000800      /* 4010 */
 222 #define CSR_FORCE_SOFT_RESET                    0x00002000      /* 4022 */
 223 #define CSR_FATAL_ERROR                         0x00004000
 224 #define CSR_SOFT_RESET                          0x00008000
 225 #define ISP_CONTROL_FN_MASK                     CSR_FUNC_NUM
 226 #define ISP_CONTROL_FN0_SCSI                    0x0500
 227 #define ISP_CONTROL_FN1_SCSI                    0x0700
 228
 229 #define INTR_PENDING                            (CSR_SCSI_COMPLETION_INTR |\
 230                                                  CSR_SCSI_PROCESSOR_INTR |\
 231                                                  CSR_SCSI_RESET_INTR)
 232
 233 /* ISP InterruptMask definitions */
 234 #define IMR_SCSI_INTR_ENABLE                    0x00000004      /* 4022 */
 235
 236 /* ISP 4022 nvram definitions */
 237 #define NVR_WRITE_ENABLE                        0x00000010      /* 4022 */
 238
 239 #define QL4010_NVRAM_SIZE                       0x200
 240 #define QL40X2_NVRAM_SIZE                       0x800
 241
 242 /*  ISP port_status definitions */
 243
 244 /*  ISP Semaphore definitions */
 245
 246 /*  ISP General Purpose Output definitions */
 247 #define GPOR_TOPCAT_RESET                       0x00000004
 248
 249 /*  shadow registers (DMA'd from HA to system memory.  read only) */
 250 struct shadow_regs {
 251         /* SCSI Request Queue Consumer Index */
 252         __le32 req_q_out;       /*  0 x0   R */
 253
 254         /* SCSI Completion Queue Producer Index */
 255         __le32 rsp_q_in;        /*  4 x4   R */
 256 };                /*  8 x8 */
 257
 258
 259 /*  External hardware configuration register */
 260 union external_hw_config_reg {
 261         struct {
 262                 /* FIXME: Do we even need this?  All values are
 263                  * referred to by 16 bit quantities.  Platform and
 264                  * endianess issues. */
 265                 __le32 bReserved0:1;
 266                 __le32 bSDRAMProtectionMethod:2;
 267                 __le32 bSDRAMBanks:1;
 268                 __le32 bSDRAMChipWidth:1;
 269                 __le32 bSDRAMChipSize:2;
 270                 __le32 bParityDisable:1;
 271                 __le32 bExternalMemoryType:1;
 272                 __le32 bFlashBIOSWriteEnable:1;
 273                 __le32 bFlashUpperBankSelect:1;
 274                 __le32 bWriteBurst:2;
 275                 __le32 bReserved1:3;
 276                 __le32 bMask:16;
 277         };
 278         uint32_t Asuint32_t;
 279 };
 280
 281 /* 82XX Support  start */
 282 /* 82xx Default FLT Addresses */
 283 #define FA_FLASH_LAYOUT_ADDR_82         0xFC400
 284 #define FA_FLASH_DESCR_ADDR_82          0xFC000
 285 #define FA_BOOT_LOAD_ADDR_82            0x04000
 286 #define FA_BOOT_CODE_ADDR_82            0x20000
 287 #define FA_RISC_CODE_ADDR_82            0x40000
 288 #define FA_GOLD_RISC_CODE_ADDR_82       0x80000
 289 #define FA_FLASH_ISCSI_CHAP             0x540000
 290 #define FA_FLASH_CHAP_SIZE              0xC0000
 291
 292 /* Flash Description Table */
 293 struct qla_fdt_layout {
 294         uint8_t sig[4];
 295         uint16_t version;
 296         uint16_t len;
 297         uint16_t checksum;
 298         uint8_t unused1[2];
 299         uint8_t model[16];
 300         uint16_t man_id;
 301         uint16_t id;
 302         uint8_t flags;
 303         uint8_t erase_cmd;
 304         uint8_t alt_erase_cmd;
 305         uint8_t wrt_enable_cmd;
 306         uint8_t wrt_enable_bits;
 307         uint8_t wrt_sts_reg_cmd;
 308         uint8_t unprotect_sec_cmd;
 309         uint8_t read_man_id_cmd;
 310         uint32_t block_size;
 311         uint32_t alt_block_size;
 312         uint32_t flash_size;
 313         uint32_t wrt_enable_data;
 314         uint8_t read_id_addr_len;
 315         uint8_t wrt_disable_bits;
 316         uint8_t read_dev_id_len;
 317         uint8_t chip_erase_cmd;
 318         uint16_t read_timeout;
 319         uint8_t protect_sec_cmd;
 320         uint8_t unused2[65];
 321 };
 322
 323 /* Flash Layout Table */
 324
 325 struct qla_flt_location {
 326         uint8_t sig[4];
 327         uint16_t start_lo;
 328         uint16_t start_hi;
 329         uint8_t version;
 330         uint8_t unused[5];
 331         uint16_t checksum;
 332 };
 333
 334 struct qla_flt_header {
 335         uint16_t version;
 336         uint16_t length;
 337         uint16_t checksum;
 338         uint16_t unused;
 339 };
 340
 341 /* 82xx FLT Regions */
 342 #define FLT_REG_FDT             0x1a
 343 #define FLT_REG_FLT             0x1c
 344 #define FLT_REG_BOOTLOAD_82     0x72
 345 #define FLT_REG_FW_82           0x74
 346 #define FLT_REG_FW_82_1         0x97
 347 #define FLT_REG_GOLD_FW_82      0x75
 348 #define FLT_REG_BOOT_CODE_82    0x78
 349 #define FLT_REG_ISCSI_PARAM     0x65
 350 #define FLT_REG_ISCSI_CHAP      0x63
 351
 352 struct qla_flt_region {
 353         uint32_t code;
 354         uint32_t size;
 355         uint32_t start;
 356         uint32_t end;
 357 };
 358
 359 /*************************************************************************
 360  *
 361  *              Mailbox Commands Structures and Definitions
 362  *
 363  *************************************************************************/
 364
 365 /*  Mailbox command definitions */
 366 #define MBOX_CMD_ABOUT_FW                       0x0009
 367 #define MBOX_CMD_PING                           0x000B
 368 #define PING_IPV6_PROTOCOL_ENABLE               0x1
 369 #define PING_IPV6_LINKLOCAL_ADDR                0x4
 370 #define PING_IPV6_ADDR0                         0x8
 371 #define PING_IPV6_ADDR1                         0xC
 372 #define MBOX_CMD_ENABLE_INTRS                   0x0010
 373 #define INTR_DISABLE                            0
 374 #define INTR_ENABLE                             1
 375 #define MBOX_CMD_STOP_FW                        0x0014
 376 #define MBOX_CMD_ABORT_TASK                     0x0015
 377 #define MBOX_CMD_LUN_RESET                      0x0016
 378 #define MBOX_CMD_TARGET_WARM_RESET              0x0017
 379 #define MBOX_CMD_GET_MANAGEMENT_DATA            0x001E
 380 #define MBOX_CMD_GET_FW_STATUS                  0x001F
 381 #define MBOX_CMD_SET_ISNS_SERVICE               0x0021
 382 #define ISNS_DISABLE                            0
 383 #define ISNS_ENABLE                             1
 384 #define MBOX_CMD_COPY_FLASH                     0x0024
 385 #define MBOX_CMD_WRITE_FLASH                    0x0025
 386 #define MBOX_CMD_READ_FLASH                     0x0026
 387 #define MBOX_CMD_CLEAR_DATABASE_ENTRY           0x0031
 388 #define MBOX_CMD_CONN_OPEN                      0x0074
 389 #define MBOX_CMD_CONN_CLOSE_SESS_LOGOUT         0x0056
 390 #define LOGOUT_OPTION_CLOSE_SESSION             0x0002
 391 #define LOGOUT_OPTION_RELOGIN                   0x0004
 392 #define LOGOUT_OPTION_FREE_DDB                  0x0008
 393 #define MBOX_CMD_SET_PARAM                      0x0059
 394 #define SET_DRVR_VERSION                        0x200
 395 #define MAX_DRVR_VER_LEN                        24
 396 #define MBOX_CMD_EXECUTE_IOCB_A64               0x005A
 397 #define MBOX_CMD_INITIALIZE_FIRMWARE            0x0060
 398 #define MBOX_CMD_GET_INIT_FW_CTRL_BLOCK         0x0061
 399 #define MBOX_CMD_REQUEST_DATABASE_ENTRY         0x0062
 400 #define MBOX_CMD_SET_DATABASE_ENTRY             0x0063
 401 #define MBOX_CMD_GET_DATABASE_ENTRY             0x0064
 402 #define DDB_DS_UNASSIGNED                       0x00
 403 #define DDB_DS_NO_CONNECTION_ACTIVE             0x01
 404 #define DDB_DS_DISCOVERY                        0x02
 405 #define DDB_DS_SESSION_ACTIVE                   0x04
 406 #define DDB_DS_SESSION_FAILED                   0x06
 407 #define DDB_DS_LOGIN_IN_PROCESS                 0x07
 408 #define MBOX_CMD_GET_FW_STATE                   0x0069
 409 #define MBOX_CMD_GET_INIT_FW_CTRL_BLOCK_DEFAULTS 0x006A
 410 #define MBOX_CMD_GET_SYS_INFO                   0x0078
 411 #define MBOX_CMD_GET_NVRAM                      0x0078  /* For 40xx */
 412 #define MBOX_CMD_SET_NVRAM                      0x0079  /* For 40xx */
 413 #define MBOX_CMD_RESTORE_FACTORY_DEFAULTS       0x0087
 414 #define MBOX_CMD_SET_ACB                        0x0088
 415 #define MBOX_CMD_GET_ACB                        0x0089
 416 #define MBOX_CMD_DISABLE_ACB                    0x008A
 417 #define MBOX_CMD_GET_IPV6_NEIGHBOR_CACHE        0x008B
 418 #define MBOX_CMD_GET_IPV6_DEST_CACHE            0x008C
 419 #define MBOX_CMD_GET_IPV6_DEF_ROUTER_LIST       0x008D
 420 #define MBOX_CMD_GET_IPV6_LCL_PREFIX_LIST       0x008E
 421 #define MBOX_CMD_SET_IPV6_NEIGHBOR_CACHE        0x0090
 422 #define MBOX_CMD_GET_IP_ADDR_STATE              0x0091
 423 #define MBOX_CMD_SEND_IPV6_ROUTER_SOL           0x0092
 424 #define MBOX_CMD_GET_DB_ENTRY_CURRENT_IP_ADDR   0x0093
 425 #define MBOX_CMD_MINIDUMP                       0x0129
 426
 427 /* Minidump subcommand */
 428 #define MINIDUMP_GET_SIZE_SUBCOMMAND            0x00
 429 #define MINIDUMP_GET_TMPLT_SUBCOMMAND           0x01
 430
 431 /* Mailbox 1 */
 432 #define FW_STATE_READY                          0x0000
 433 #define FW_STATE_CONFIG_WAIT                    0x0001
 434 #define FW_STATE_WAIT_AUTOCONNECT               0x0002
 435 #define FW_STATE_ERROR                          0x0004
 436 #define FW_STATE_CONFIGURING_IP                 0x0008
 437
 438 /* Mailbox 3 */
 439 #define FW_ADDSTATE_OPTICAL_MEDIA               0x0001
 440 #define FW_ADDSTATE_DHCPv4_ENABLED              0x0002
 441 #define FW_ADDSTATE_DHCPv4_LEASE_ACQUIRED       0x0004
 442 #define FW_ADDSTATE_DHCPv4_LEASE_EXPIRED        0x0008
 443 #define FW_ADDSTATE_LINK_UP                     0x0010
 444 #define FW_ADDSTATE_ISNS_SVC_ENABLED            0x0020
 445 #define FW_ADDSTATE_LINK_SPEED_10MBPS           0x0100
 446 #define FW_ADDSTATE_LINK_SPEED_100MBPS          0x0200
 447 #define FW_ADDSTATE_LINK_SPEED_1GBPS            0x0400
 448 #define FW_ADDSTATE_LINK_SPEED_10GBPS           0x0800
 449
 450 #define MBOX_CMD_GET_DATABASE_ENTRY_DEFAULTS    0x006B
 451 #define IPV6_DEFAULT_DDB_ENTRY                  0x0001
 452
 453 #define MBOX_CMD_CONN_OPEN_SESS_LOGIN           0x0074
 454 #define MBOX_CMD_GET_CRASH_RECORD               0x0076  /* 4010 only */
 455 #define MBOX_CMD_GET_CONN_EVENT_LOG             0x0077
 456
 457 #define MBOX_CMD_IDC_ACK                        0x0101
 458 #define MBOX_CMD_PORT_RESET                     0x0120
 459 #define MBOX_CMD_SET_PORT_CONFIG                0x0122
 460
 461 /*  Mailbox status definitions */
 462 #define MBOX_COMPLETION_STATUS                  4
 463 #define MBOX_STS_BUSY                           0x0007
 464 #define MBOX_STS_INTERMEDIATE_COMPLETION        0x1000
 465 #define MBOX_STS_COMMAND_COMPLETE               0x4000
 466 #define MBOX_STS_COMMAND_ERROR                  0x4005
 467
 468 #define MBOX_ASYNC_EVENT_STATUS                 8
 469 #define MBOX_ASTS_SYSTEM_ERROR                  0x8002
 470 #define MBOX_ASTS_REQUEST_TRANSFER_ERROR        0x8003
 471 #define MBOX_ASTS_RESPONSE_TRANSFER_ERROR       0x8004
 472 #define MBOX_ASTS_PROTOCOL_STATISTIC_ALARM      0x8005
 473 #define MBOX_ASTS_SCSI_COMMAND_PDU_REJECTED     0x8006
 474 #define MBOX_ASTS_LINK_UP                       0x8010
 475 #define MBOX_ASTS_LINK_DOWN                     0x8011
 476 #define MBOX_ASTS_DATABASE_CHANGED              0x8014
 477 #define MBOX_ASTS_UNSOLICITED_PDU_RECEIVED      0x8015
 478 #define MBOX_ASTS_SELF_TEST_FAILED              0x8016
 479 #define MBOX_ASTS_LOGIN_FAILED                  0x8017
 480 #define MBOX_ASTS_DNS                           0x8018
 481 #define MBOX_ASTS_HEARTBEAT                     0x8019
 482 #define MBOX_ASTS_NVRAM_INVALID                 0x801A
 483 #define MBOX_ASTS_MAC_ADDRESS_CHANGED           0x801B
 484 #define MBOX_ASTS_IP_ADDRESS_CHANGED            0x801C
 485 #define MBOX_ASTS_DHCP_LEASE_EXPIRED            0x801D
 486 #define MBOX_ASTS_DHCP_LEASE_ACQUIRED           0x801F
 487 #define MBOX_ASTS_ISNS_UNSOLICITED_PDU_RECEIVED 0x8021
 488 #define MBOX_ASTS_DUPLICATE_IP                  0x8025
 489 #define MBOX_ASTS_ARP_COMPLETE                  0x8026
 490 #define MBOX_ASTS_SUBNET_STATE_CHANGE           0x8027
 491 #define MBOX_ASTS_RESPONSE_QUEUE_FULL           0x8028
 492 #define MBOX_ASTS_IP_ADDR_STATE_CHANGED         0x8029
 493 #define MBOX_ASTS_IPV6_PREFIX_EXPIRED           0x802B
 494 #define MBOX_ASTS_IPV6_ND_PREFIX_IGNORED        0x802C
 495 #define MBOX_ASTS_IPV6_LCL_PREFIX_IGNORED       0x802D
 496 #define MBOX_ASTS_ICMPV6_ERROR_MSG_RCVD         0x802E
 497 #define MBOX_ASTS_IDC_COMPLETE                  0x8100
 498 #define MBOX_ASTS_IDC_REQUEST_NOTIFICATION      0x8101
 499 #define MBOX_ASTS_TXSCVR_INSERTED               0x8130
 500 #define MBOX_ASTS_TXSCVR_REMOVED                0x8131
 501
 502 #define ISNS_EVENT_DATA_RECEIVED                0x0000
 503 #define ISNS_EVENT_CONNECTION_OPENED            0x0001
 504 #define ISNS_EVENT_CONNECTION_FAILED            0x0002
 505 #define MBOX_ASTS_IPSEC_SYSTEM_FATAL_ERROR      0x8022
 506 #define MBOX_ASTS_SUBNET_STATE_CHANGE           0x8027
 507
 508 /* ACB State Defines */
 509 #define ACB_STATE_UNCONFIGURED  0x00
 510 #define ACB_STATE_INVALID       0x01
 511 #define ACB_STATE_ACQUIRING     0x02
 512 #define ACB_STATE_TENTATIVE     0x03
 513 #define ACB_STATE_DEPRICATED    0x04
 514 #define ACB_STATE_VALID         0x05
 515 #define ACB_STATE_DISABLING     0x06
 516
 517 /* FLASH offsets */
 518 #define FLASH_SEGMENT_IFCB      0x04000000
 519
 520 #define FLASH_OPT_RMW_HOLD      0
 521 #define FLASH_OPT_RMW_INIT      1
 522 #define FLASH_OPT_COMMIT        2
 523 #define FLASH_OPT_RMW_COMMIT    3
 524
 525 /* Loopback type */
 526 #define ENABLE_INTERNAL_LOOPBACK        0x04
 527 #define ENABLE_EXTERNAL_LOOPBACK        0x08
 528
 529 /*************************************************************************/
 530
 531 /* Host Adapter Initialization Control Block (from host) */
 532 struct addr_ctrl_blk {
 533         uint8_t version;        /* 00 */
 534 #define  IFCB_VER_MIN                   0x01
 535 #define  IFCB_VER_MAX                   0x02
 536         uint8_t control;        /* 01 */
 537
 538         uint16_t fw_options;    /* 02-03 */
 539 #define  FWOPT_HEARTBEAT_ENABLE           0x1000
 540 #define  FWOPT_SESSION_MODE               0x0040
 541 #define  FWOPT_INITIATOR_MODE             0x0020
 542 #define  FWOPT_TARGET_MODE                0x0010
 543 #define  FWOPT_ENABLE_CRBDB               0x8000
 544
 545         uint16_t exec_throttle; /* 04-05 */
 546         uint8_t zio_count;      /* 06 */
 547         uint8_t res0;   /* 07 */
 548         uint16_t eth_mtu_size;  /* 08-09 */
 549         uint16_t add_fw_options;        /* 0A-0B */
 550 #define ADFWOPT_SERIALIZE_TASK_MGMT     0x0400
 551 #define ADFWOPT_AUTOCONN_DISABLE        0x0002
 552
 553         uint8_t hb_interval;    /* 0C */
 554         uint8_t inst_num; /* 0D */
 555         uint16_t res1;          /* 0E-0F */
 556         uint16_t rqq_consumer_idx;      /* 10-11 */
 557         uint16_t compq_producer_idx;    /* 12-13 */
 558         uint16_t rqq_len;       /* 14-15 */
 559         uint16_t compq_len;     /* 16-17 */
 560         uint32_t rqq_addr_lo;   /* 18-1B */
 561         uint32_t rqq_addr_hi;   /* 1C-1F */
 562         uint32_t compq_addr_lo; /* 20-23 */
 563         uint32_t compq_addr_hi; /* 24-27 */
 564         uint32_t shdwreg_addr_lo;       /* 28-2B */
 565         uint32_t shdwreg_addr_hi;       /* 2C-2F */
 566
 567         uint16_t iscsi_opts;    /* 30-31 */
 568         uint16_t ipv4_tcp_opts; /* 32-33 */
 569 #define TCPOPT_DHCP_ENABLE              0x0200
 570         uint16_t ipv4_ip_opts;  /* 34-35 */
 571 #define IPOPT_IPV4_PROTOCOL_ENABLE      0x8000
 572 #define IPOPT_VLAN_TAGGING_ENABLE       0x2000
 573
 574         uint16_t iscsi_max_pdu_size;    /* 36-37 */
 575         uint8_t ipv4_tos;       /* 38 */
 576         uint8_t ipv4_ttl;       /* 39 */
 577         uint8_t acb_version;    /* 3A */
 578 #define ACB_NOT_SUPPORTED               0x00
 579 #define ACB_SUPPORTED                   0x02 /* Capable of ACB Version 2
 580                                                 Features */
 581
 582         uint8_t res2;   /* 3B */
 583         uint16_t def_timeout;   /* 3C-3D */
 584         uint16_t iscsi_fburst_len;      /* 3E-3F */
 585         uint16_t iscsi_def_time2wait;   /* 40-41 */
 586         uint16_t iscsi_def_time2retain; /* 42-43 */
 587         uint16_t iscsi_max_outstnd_r2t; /* 44-45 */
 588         uint16_t conn_ka_timeout;       /* 46-47 */
 589         uint16_t ipv4_port;     /* 48-49 */
 590         uint16_t iscsi_max_burst_len;   /* 4A-4B */
 591         uint32_t res5;          /* 4C-4F */
 592         uint8_t ipv4_addr[4];   /* 50-53 */
 593         uint16_t ipv4_vlan_tag; /* 54-55 */
 594         uint8_t ipv4_addr_state;        /* 56 */
 595         uint8_t ipv4_cacheid;   /* 57 */
 596         uint8_t res6[8];        /* 58-5F */
 597         uint8_t ipv4_subnet[4]; /* 60-63 */
 598         uint8_t res7[12];       /* 64-6F */
 599         uint8_t ipv4_gw_addr[4];        /* 70-73 */
 600         uint8_t res8[0xc];      /* 74-7F */
 601         uint8_t pri_dns_srvr_ip[4];/* 80-83 */
 602         uint8_t sec_dns_srvr_ip[4];/* 84-87 */
 603         uint16_t min_eph_port;  /* 88-89 */
 604         uint16_t max_eph_port;  /* 8A-8B */
 605         uint8_t res9[4];        /* 8C-8F */
 606         uint8_t iscsi_alias[32];/* 90-AF */
 607         uint8_t res9_1[0x16];   /* B0-C5 */
 608         uint16_t tgt_portal_grp;/* C6-C7 */
 609         uint8_t abort_timer;    /* C8    */
 610         uint8_t ipv4_tcp_wsf;   /* C9    */
 611         uint8_t res10[6];       /* CA-CF */
 612         uint8_t ipv4_sec_ip_addr[4];    /* D0-D3 */
 613         uint8_t ipv4_dhcp_vid_len;      /* D4 */
 614         uint8_t ipv4_dhcp_vid[11];      /* D5-DF */
 615         uint8_t res11[20];      /* E0-F3 */
 616         uint8_t ipv4_dhcp_alt_cid_len;  /* F4 */
 617         uint8_t ipv4_dhcp_alt_cid[11];  /* F5-FF */
 618         uint8_t iscsi_name[224];        /* 100-1DF */
 619         uint8_t res12[32];      /* 1E0-1FF */
 620         uint32_t cookie;        /* 200-203 */
 621         uint16_t ipv6_port;     /* 204-205 */
 622         uint16_t ipv6_opts;     /* 206-207 */
 623 #define IPV6_OPT_IPV6_PROTOCOL_ENABLE   0x8000
 624 #define IPV6_OPT_VLAN_TAGGING_ENABLE    0x2000
 625
 626         uint16_t ipv6_addtl_opts;       /* 208-209 */
 627 #define IPV6_ADDOPT_NEIGHBOR_DISCOVERY_ADDR_ENABLE      0x0002 /* Pri ACB
 628                                                                   Only */
 629 #define IPV6_ADDOPT_AUTOCONFIG_LINK_LOCAL_ADDR          0x0001
 630
 631         uint16_t ipv6_tcp_opts; /* 20A-20B */
 632         uint8_t ipv6_tcp_wsf;   /* 20C */
 633         uint16_t ipv6_flow_lbl; /* 20D-20F */
 634         uint8_t ipv6_dflt_rtr_addr[16]; /* 210-21F */
 635         uint16_t ipv6_vlan_tag; /* 220-221 */
 636         uint8_t ipv6_lnk_lcl_addr_state;/* 222 */
 637         uint8_t ipv6_addr0_state;       /* 223 */
 638         uint8_t ipv6_addr1_state;       /* 224 */
 639 #define IP_ADDRSTATE_UNCONFIGURED       0
 640 #define IP_ADDRSTATE_INVALID            1
 641 #define IP_ADDRSTATE_ACQUIRING          2
 642 #define IP_ADDRSTATE_TENTATIVE          3
 643 #define IP_ADDRSTATE_DEPRICATED         4
 644 #define IP_ADDRSTATE_PREFERRED          5
 645 #define IP_ADDRSTATE_DISABLING          6
 646
 647         uint8_t ipv6_dflt_rtr_state;    /* 225 */
 648 #define IPV6_RTRSTATE_UNKNOWN                   0
 649 #define IPV6_RTRSTATE_MANUAL                    1
 650 #define IPV6_RTRSTATE_ADVERTISED                3
 651 #define IPV6_RTRSTATE_STALE                     4
 652
 653         uint8_t ipv6_traffic_class;     /* 226 */
 654         uint8_t ipv6_hop_limit; /* 227 */
 655         uint8_t ipv6_if_id[8];  /* 228-22F */
 656         uint8_t ipv6_addr0[16]; /* 230-23F */
 657         uint8_t ipv6_addr1[16]; /* 240-24F */
 658         uint32_t ipv6_nd_reach_time;    /* 250-253 */
 659         uint32_t ipv6_nd_rexmit_timer;  /* 254-257 */
 660         uint32_t ipv6_nd_stale_timeout; /* 258-25B */
 661         uint8_t ipv6_dup_addr_detect_count;     /* 25C */
 662         uint8_t ipv6_cache_id;  /* 25D */
 663         uint8_t res13[18];      /* 25E-26F */
 664         uint32_t ipv6_gw_advrt_mtu;     /* 270-273 */
 665         uint8_t res14[140];     /* 274-2FF */
 666 };
 667
 668 #define IP_ADDR_COUNT   4 /* Total 4 IP address supported in one interface
 669                            * One IPv4, one IPv6 link local and 2 IPv6
 670                            */
 671
 672 #define IP_STATE_MASK   0x0F000000
 673 #define IP_STATE_SHIFT  24
 674
 675 struct init_fw_ctrl_blk {
 676         struct addr_ctrl_blk pri;
 677 /*      struct addr_ctrl_blk sec;*/
 678 };
 679
 680 #define PRIMARI_ACB             0
 681 #define SECONDARY_ACB           1
 682
 683 struct addr_ctrl_blk_def {
 684         uint8_t reserved1[1];   /* 00 */
 685         uint8_t control;        /* 01 */
 686         uint8_t reserved2[11];  /* 02-0C */
 687         uint8_t inst_num;       /* 0D */
 688         uint8_t reserved3[34];  /* 0E-2F */
 689         uint16_t iscsi_opts;    /* 30-31 */
 690         uint16_t ipv4_tcp_opts; /* 32-33 */
 691         uint16_t ipv4_ip_opts;  /* 34-35 */
 692         uint16_t iscsi_max_pdu_size;    /* 36-37 */
 693         uint8_t ipv4_tos;       /* 38 */
 694         uint8_t ipv4_ttl;       /* 39 */
 695         uint8_t reserved4[2];   /* 3A-3B */
 696         uint16_t def_timeout;   /* 3C-3D */
 697         uint16_t iscsi_fburst_len;      /* 3E-3F */
 698         uint8_t reserved5[4];   /* 40-43 */
 699         uint16_t iscsi_max_outstnd_r2t; /* 44-45 */
 700         uint8_t reserved6[2];   /* 46-47 */
 701         uint16_t ipv4_port;     /* 48-49 */
 702         uint16_t iscsi_max_burst_len;   /* 4A-4B */
 703         uint8_t reserved7[4];   /* 4C-4F */
 704         uint8_t ipv4_addr[4];   /* 50-53 */
 705         uint16_t ipv4_vlan_tag; /* 54-55 */
 706         uint8_t ipv4_addr_state;        /* 56 */
 707         uint8_t ipv4_cacheid;   /* 57 */
 708         uint8_t reserved8[8];   /* 58-5F */
 709         uint8_t ipv4_subnet[4]; /* 60-63 */
 710         uint8_t reserved9[12];  /* 64-6F */
 711         uint8_t ipv4_gw_addr[4];        /* 70-73 */
 712         uint8_t reserved10[84]; /* 74-C7 */
 713         uint8_t abort_timer;    /* C8    */
 714         uint8_t ipv4_tcp_wsf;   /* C9    */
 715         uint8_t reserved11[10]; /* CA-D3 */
 716         uint8_t ipv4_dhcp_vid_len;      /* D4 */
 717         uint8_t ipv4_dhcp_vid[11];      /* D5-DF */
 718         uint8_t reserved12[20]; /* E0-F3 */
 719         uint8_t ipv4_dhcp_alt_cid_len;  /* F4 */
 720         uint8_t ipv4_dhcp_alt_cid[11];  /* F5-FF */
 721         uint8_t iscsi_name[224];        /* 100-1DF */
 722         uint8_t reserved13[32]; /* 1E0-1FF */
 723         uint32_t cookie;        /* 200-203 */
 724         uint16_t ipv6_port;     /* 204-205 */
 725         uint16_t ipv6_opts;     /* 206-207 */
 726         uint16_t ipv6_addtl_opts;       /* 208-209 */
 727         uint16_t ipv6_tcp_opts;         /* 20A-20B */
 728         uint8_t ipv6_tcp_wsf;           /* 20C */
 729         uint16_t ipv6_flow_lbl;         /* 20D-20F */
 730         uint8_t ipv6_dflt_rtr_addr[16]; /* 210-21F */
 731         uint16_t ipv6_vlan_tag;         /* 220-221 */
 732         uint8_t ipv6_lnk_lcl_addr_state;        /* 222 */
 733         uint8_t ipv6_addr0_state;       /* 223 */
 734         uint8_t ipv6_addr1_state;       /* 224 */
 735         uint8_t ipv6_dflt_rtr_state;    /* 225 */
 736         uint8_t ipv6_traffic_class;     /* 226 */
 737         uint8_t ipv6_hop_limit;         /* 227 */
 738         uint8_t ipv6_if_id[8];          /* 228-22F */
 739         uint8_t ipv6_addr0[16];         /* 230-23F */
 740         uint8_t ipv6_addr1[16];         /* 240-24F */
 741         uint32_t ipv6_nd_reach_time;    /* 250-253 */
 742         uint32_t ipv6_nd_rexmit_timer;  /* 254-257 */
 743         uint32_t ipv6_nd_stale_timeout; /* 258-25B */
 744         uint8_t ipv6_dup_addr_detect_count;     /* 25C */
 745         uint8_t ipv6_cache_id;          /* 25D */
 746         uint8_t reserved14[18];         /* 25E-26F */
 747         uint32_t ipv6_gw_advrt_mtu;     /* 270-273 */
 748         uint8_t reserved15[140];        /* 274-2FF */
 749 };
 750
 751 /*************************************************************************/
 752
 753 #define MAX_CHAP_ENTRIES_40XX   128
 754 #define MAX_CHAP_ENTRIES_82XX   1024
 755 #define MAX_RESRV_CHAP_IDX      3
 756 #define FLASH_CHAP_OFFSET       0x06000000
 757
 758 struct ql4_chap_table {
 759         uint16_t link;
 760         uint8_t flags;
 761         uint8_t secret_len;
 762 #define MIN_CHAP_SECRET_LEN     12
 763 #define MAX_CHAP_SECRET_LEN     100
 764         uint8_t secret[MAX_CHAP_SECRET_LEN];
 765 #define MAX_CHAP_NAME_LEN       256
 766         uint8_t name[MAX_CHAP_NAME_LEN];
 767         uint16_t reserved;
 768 #define CHAP_VALID_COOKIE       0x4092
 769 #define CHAP_INVALID_COOKIE     0xFFEE
 770         uint16_t cookie;
 771 };
 772
 773 struct dev_db_entry {
 774         uint16_t options;       /* 00-01 */
 775 #define DDB_OPT_DISC_SESSION  0x10
 776 #define DDB_OPT_TARGET        0x02 /* device is a target */
 777 #define DDB_OPT_IPV6_DEVICE     0x100
 778 #define DDB_OPT_AUTO_SENDTGTS_DISABLE           0x40
 779 #define DDB_OPT_IPV6_NULL_LINK_LOCAL            0x800 /* post connection */
 780 #define DDB_OPT_IPV6_FW_DEFINED_LINK_LOCAL      0x800 /* pre connection */
 781
 782         uint16_t exec_throttle; /* 02-03 */
 783         uint16_t exec_count;    /* 04-05 */
 784         uint16_t res0;  /* 06-07 */
 785         uint16_t iscsi_options; /* 08-09 */
 786         uint16_t tcp_options;   /* 0A-0B */
 787         uint16_t ip_options;    /* 0C-0D */
 788         uint16_t iscsi_max_rcv_data_seg_len;    /* 0E-0F */
 789 #define BYTE_UNITS      512
 790         uint32_t res1;  /* 10-13 */
 791         uint16_t iscsi_max_snd_data_seg_len;    /* 14-15 */
 792         uint16_t iscsi_first_burst_len; /* 16-17 */
 793         uint16_t iscsi_def_time2wait;   /* 18-19 */
 794         uint16_t iscsi_def_time2retain; /* 1A-1B */
 795         uint16_t iscsi_max_outsnd_r2t;  /* 1C-1D */
 796         uint16_t ka_timeout;    /* 1E-1F */
 797         uint8_t isid[6];        /* 20-25 big-endian, must be converted
 798                                  * to little-endian */
 799         uint16_t tsid;          /* 26-27 */
 800         uint16_t port;  /* 28-29 */
 801         uint16_t iscsi_max_burst_len;   /* 2A-2B */
 802         uint16_t def_timeout;   /* 2C-2D */
 803         uint16_t res2;  /* 2E-2F */
 804         uint8_t ip_addr[0x10];  /* 30-3F */
 805         uint8_t iscsi_alias[0x20];      /* 40-5F */
 806         uint8_t tgt_addr[0x20]; /* 60-7F */
 807         uint16_t mss;   /* 80-81 */
 808         uint16_t res3;  /* 82-83 */
 809         uint16_t lcl_port;      /* 84-85 */
 810         uint8_t ipv4_tos;       /* 86 */
 811         uint16_t ipv6_flow_lbl; /* 87-89 */
 812         uint8_t res4[0x36];     /* 8A-BF */
 813         uint8_t iscsi_name[0xE0];       /* C0-19F : xxzzy Make this a
 814                                          * pointer to a string so we
 815                                          * don't have to reserve so
 816                                          * much RAM */
 817         uint8_t link_local_ipv6_addr[0x10]; /* 1A0-1AF */
 818         uint8_t res5[0x10];     /* 1B0-1BF */
 819         uint16_t ddb_link;      /* 1C0-1C1 */
 820         uint16_t chap_tbl_idx;  /* 1C2-1C3 */
 821         uint16_t tgt_portal_grp; /* 1C4-1C5 */
 822         uint8_t tcp_xmt_wsf;    /* 1C6 */
 823         uint8_t tcp_rcv_wsf;    /* 1C7 */
 824         uint32_t stat_sn;       /* 1C8-1CB */
 825         uint32_t exp_stat_sn;   /* 1CC-1CF */
 826         uint8_t res6[0x2b];     /* 1D0-1FB */
 827 #define DDB_VALID_COOKIE        0x9034
 828         uint16_t cookie;        /* 1FC-1FD */
 829         uint16_t len;           /* 1FE-1FF */
 830 };
 831
 832 /*************************************************************************/
 833
 834 /* Flash definitions */
 835
 836 #define FLASH_OFFSET_SYS_INFO   0x02000000
 837 #define FLASH_DEFAULTBLOCKSIZE  0x20000
 838 #define FLASH_EOF_OFFSET        (FLASH_DEFAULTBLOCKSIZE-8) /* 4 bytes
 839                                                             * for EOF
 840                                                             * signature */
 841 #define FLASH_RAW_ACCESS_ADDR   0x8e000000
 842
 843 #define BOOT_PARAM_OFFSET_PORT0 0x3b0
 844 #define BOOT_PARAM_OFFSET_PORT1 0x7b0
 845
 846 #define FLASH_OFFSET_DB_INFO    0x05000000
 847 #define FLASH_OFFSET_DB_END     (FLASH_OFFSET_DB_INFO + 0x7fff)
 848
 849
 850 struct sys_info_phys_addr {
 851         uint8_t address[6];     /* 00-05 */
 852         uint8_t filler[2];      /* 06-07 */
 853 };
 854
 855 struct flash_sys_info {
 856         uint32_t cookie;        /* 00-03 */
 857         uint32_t physAddrCount; /* 04-07 */
 858         struct sys_info_phys_addr physAddr[4]; /* 08-27 */
 859         uint8_t vendorId[128];  /* 28-A7 */
 860         uint8_t productId[128]; /* A8-127 */
 861         uint32_t serialNumber;  /* 128-12B */
 862
 863         /*  PCI Configuration values */
 864         uint32_t pciDeviceVendor;       /* 12C-12F */
 865         uint32_t pciDeviceId;   /* 130-133 */
 866         uint32_t pciSubsysVendor;       /* 134-137 */
 867         uint32_t pciSubsysId;   /* 138-13B */
 868
 869         /*  This validates version 1. */
 870         uint32_t crumbs;        /* 13C-13F */
 871
 872         uint32_t enterpriseNumber;      /* 140-143 */
 873
 874         uint32_t mtu;           /* 144-147 */
 875         uint32_t reserved0;     /* 148-14b */
 876         uint32_t crumbs2;       /* 14c-14f */
 877         uint8_t acSerialNumber[16];     /* 150-15f */
 878         uint32_t crumbs3;       /* 160-16f */
 879
 880         /* Leave this last in the struct so it is declared invalid if
 881          * any new items are added.
 882          */
 883         uint32_t reserved1[39]; /* 170-1ff */
 884 };      /* 200 */
 885
 886 struct mbx_sys_info {
 887         uint8_t board_id_str[16];   /*  0-f  Keep board ID string first */
 888                                 /* in this structure for GUI. */
 889         uint16_t board_id;      /* 10-11 board ID code */
 890         uint16_t phys_port_cnt; /* 12-13 number of physical network ports */
 891         uint16_t port_num;      /* 14-15 network port for this PCI function */
 892                                 /* (port 0 is first port) */
 893         uint8_t mac_addr[6];    /* 16-1b MAC address for this PCI function */
 894         uint32_t iscsi_pci_func_cnt;  /* 1c-1f number of iSCSI PCI functions */
 895         uint32_t pci_func;            /* 20-23 this PCI function */
 896         unsigned char serial_number[16];  /* 24-33 serial number string */
 897         uint8_t reserved[12];             /* 34-3f */
 898 };
 899
 900 struct about_fw_info {
 901         uint16_t fw_major;              /* 00 - 01 */
 902         uint16_t fw_minor;              /* 02 - 03 */
 903         uint16_t fw_patch;              /* 04 - 05 */
 904         uint16_t fw_build;              /* 06 - 07 */
 905         uint8_t fw_build_date[16];      /* 08 - 17 ASCII String */
 906         uint8_t fw_build_time[16];      /* 18 - 27 ASCII String */
 907         uint8_t fw_build_user[16];      /* 28 - 37 ASCII String */
 908         uint16_t fw_load_source;        /* 38 - 39 */
 909                                         /* 1 = Flash Primary,
 910                                            2 = Flash Secondary,
 911                                            3 = Host Download
 912                                         */
 913         uint8_t reserved1[6];           /* 3A - 3F */
 914         uint16_t iscsi_major;           /* 40 - 41 */
 915         uint16_t iscsi_minor;           /* 42 - 43 */
 916         uint16_t bootload_major;        /* 44 - 45 */
 917         uint16_t bootload_minor;        /* 46 - 47 */
 918         uint16_t bootload_patch;        /* 48 - 49 */
 919         uint16_t bootload_build;        /* 4A - 4B */
 920         uint8_t reserved2[180];         /* 4C - FF */
 921 };
 922
 923 struct crash_record {
 924         uint16_t fw_major_version;      /* 00 - 01 */
 925         uint16_t fw_minor_version;      /* 02 - 03 */
 926         uint16_t fw_patch_version;      /* 04 - 05 */
 927         uint16_t fw_build_version;      /* 06 - 07 */
 928
 929         uint8_t build_date[16]; /* 08 - 17 */
 930         uint8_t build_time[16]; /* 18 - 27 */
 931         uint8_t build_user[16]; /* 28 - 37 */
 932         uint8_t card_serial_num[16];    /* 38 - 47 */
 933
 934         uint32_t time_of_crash_in_secs; /* 48 - 4B */
 935         uint32_t time_of_crash_in_ms;   /* 4C - 4F */
 936
 937         uint16_t out_RISC_sd_num_frames;        /* 50 - 51 */
 938         uint16_t OAP_sd_num_words;      /* 52 - 53 */
 939         uint16_t IAP_sd_num_frames;     /* 54 - 55 */
 940         uint16_t in_RISC_sd_num_words;  /* 56 - 57 */
 941
 942         uint8_t reserved1[28];  /* 58 - 7F */
 943
 944         uint8_t out_RISC_reg_dump[256]; /* 80 -17F */
 945         uint8_t in_RISC_reg_dump[256];  /*180 -27F */
 946         uint8_t in_out_RISC_stack_dump[0];      /*280 - ??? */
 947 };
 948
 949 struct conn_event_log_entry {
 950 #define MAX_CONN_EVENT_LOG_ENTRIES      100
 951         uint32_t timestamp_sec; /* 00 - 03 seconds since boot */
 952         uint32_t timestamp_ms;  /* 04 - 07 milliseconds since boot */
 953         uint16_t device_index;  /* 08 - 09  */
 954         uint16_t fw_conn_state; /* 0A - 0B  */
 955         uint8_t event_type;     /* 0C - 0C  */
 956         uint8_t error_code;     /* 0D - 0D  */
 957         uint16_t error_code_detail;     /* 0E - 0F  */
 958         uint8_t num_consecutive_events; /* 10 - 10  */
 959         uint8_t rsvd[3];        /* 11 - 13  */
 960 };
 961
 962 /*************************************************************************
 963  *
 964  *                              IOCB Commands Structures and Definitions
 965  *
 966  *************************************************************************/
 967 #define IOCB_MAX_CDB_LEN            16  /* Bytes in a CBD */
 968 #define IOCB_MAX_SENSEDATA_LEN      32  /* Bytes of sense data */
 969 #define IOCB_MAX_EXT_SENSEDATA_LEN  60  /* Bytes of extended sense data */
 970
 971 /* IOCB header structure */
 972 struct qla4_header {
 973         uint8_t entryType;
 974 #define ET_STATUS                0x03
 975 #define ET_MARKER                0x04
 976 #define ET_CONT_T1               0x0A
 977 #define ET_STATUS_CONTINUATION   0x10
 978 #define ET_CMND_T3               0x19
 979 #define ET_PASSTHRU0             0x3A
 980 #define ET_PASSTHRU_STATUS       0x3C
 981 #define ET_MBOX_CMD             0x38
 982 #define ET_MBOX_STATUS          0x39
 983
 984         uint8_t entryStatus;
 985         uint8_t systemDefined;
 986 #define SD_ISCSI_PDU    0x01
 987         uint8_t entryCount;
 988
 989         /* SyetemDefined definition */
 990 };
 991
 992 /* Generic queue entry structure*/
 993 struct queue_entry {
 994         uint8_t data[60];
 995         uint32_t signature;
 996
 997 };
 998
 999 /* 64 bit addressing segment counts*/
1000
1001 #define COMMAND_SEG_A64   1
1002 #define CONTINUE_SEG_A64  5
1003
1004 /* 64 bit addressing segment definition*/
1005
1006 struct data_seg_a64 {
1007         struct {
1008                 uint32_t addrLow;
1009                 uint32_t addrHigh;
1010
1011         } base;
1012
1013         uint32_t count;
1014
1015 };
1016
1017 /* Command Type 3 entry structure*/
1018
1019 struct command_t3_entry {
1020         struct qla4_header hdr; /* 00-03 */
1021
1022         uint32_t handle;        /* 04-07 */
1023         uint16_t target;        /* 08-09 */
1024         uint16_t connection_id; /* 0A-0B */
1025
1026         uint8_t control_flags;  /* 0C */
1027
1028         /* data direction  (bits 5-6) */
1029 #define CF_WRITE                0x20
1030 #define CF_READ                 0x40
1031 #define CF_NO_DATA              0x00
1032
1033         /* task attributes (bits 2-0) */
1034 #define CF_HEAD_TAG             0x03
1035 #define CF_ORDERED_TAG          0x02
1036 #define CF_SIMPLE_TAG           0x01
1037
1038         /* STATE FLAGS FIELD IS A PLACE HOLDER. THE FW WILL SET BITS
1039          * IN THIS FIELD AS THE COMMAND IS PROCESSED. WHEN THE IOCB IS
1040          * CHANGED TO AN IOSB THIS FIELD WILL HAVE THE STATE FLAGS SET
1041          * PROPERLY.
1042          */
1043         uint8_t state_flags;    /* 0D */
1044         uint8_t cmdRefNum;      /* 0E */
1045         uint8_t reserved1;      /* 0F */
1046         uint8_t cdb[IOCB_MAX_CDB_LEN];  /* 10-1F */
1047         struct scsi_lun lun;    /* FCP LUN (BE). */
1048         uint32_t cmdSeqNum;     /* 28-2B */
1049         uint16_t timeout;       /* 2C-2D */
1050         uint16_t dataSegCnt;    /* 2E-2F */
1051         uint32_t ttlByteCnt;    /* 30-33 */
1052         struct data_seg_a64 dataseg[COMMAND_SEG_A64];   /* 34-3F */
1053
1054 };
1055
1056
1057 /* Continuation Type 1 entry structure*/
1058 struct continuation_t1_entry {
1059         struct qla4_header hdr;
1060
1061         struct data_seg_a64 dataseg[CONTINUE_SEG_A64];
1062
1063 };
1064
1065 /* Parameterize for 64 or 32 bits */
1066 #define COMMAND_SEG     COMMAND_SEG_A64
1067 #define CONTINUE_SEG    CONTINUE_SEG_A64
1068
1069 #define ET_COMMAND      ET_CMND_T3
1070 #define ET_CONTINUE     ET_CONT_T1
1071
1072 /* Marker entry structure*/
1073 struct qla4_marker_entry {
1074         struct qla4_header hdr; /* 00-03 */
1075
1076         uint32_t system_defined; /* 04-07 */
1077         uint16_t target;        /* 08-09 */
1078         uint16_t modifier;      /* 0A-0B */
1079 #define MM_LUN_RESET            0
1080 #define MM_TGT_WARM_RESET       1
1081
1082         uint16_t flags;         /* 0C-0D */
1083         uint16_t reserved1;     /* 0E-0F */
1084         struct scsi_lun lun;    /* FCP LUN (BE). */
1085         uint64_t reserved2;     /* 18-1F */
1086         uint64_t reserved3;     /* 20-27 */
1087         uint64_t reserved4;     /* 28-2F */
1088         uint64_t reserved5;     /* 30-37 */
1089         uint64_t reserved6;     /* 38-3F */
1090 };
1091
1092 /* Status entry structure*/
1093 struct status_entry {
1094         struct qla4_header hdr; /* 00-03 */
1095
1096         uint32_t handle;        /* 04-07 */
1097
1098         uint8_t scsiStatus;     /* 08 */
1099 #define SCSI_CHECK_CONDITION              0x02
1100
1101         uint8_t iscsiFlags;     /* 09 */
1102 #define ISCSI_FLAG_RESIDUAL_UNDER         0x02
1103 #define ISCSI_FLAG_RESIDUAL_OVER          0x04
1104
1105         uint8_t iscsiResponse;  /* 0A */
1106
1107         uint8_t completionStatus;       /* 0B */
1108 #define SCS_COMPLETE                      0x00
1109 #define SCS_INCOMPLETE                    0x01
1110 #define SCS_RESET_OCCURRED                0x04
1111 #define SCS_ABORTED                       0x05
1112 #define SCS_TIMEOUT                       0x06
1113 #define SCS_DATA_OVERRUN                  0x07
1114 #define SCS_DATA_UNDERRUN                 0x15
1115 #define SCS_QUEUE_FULL                    0x1C
1116 #define SCS_DEVICE_UNAVAILABLE            0x28
1117 #define SCS_DEVICE_LOGGED_OUT             0x29
1118
1119         uint8_t reserved1;      /* 0C */
1120
1121         /* state_flags MUST be at the same location as state_flags in
1122          * the Command_T3/4_Entry */
1123         uint8_t state_flags;    /* 0D */
1124
1125         uint16_t senseDataByteCnt;      /* 0E-0F */
1126         uint32_t residualByteCnt;       /* 10-13 */
1127         uint32_t bidiResidualByteCnt;   /* 14-17 */
1128         uint32_t expSeqNum;     /* 18-1B */
1129         uint32_t maxCmdSeqNum;  /* 1C-1F */
1130         uint8_t senseData[IOCB_MAX_SENSEDATA_LEN];      /* 20-3F */
1131
1132 };
1133
1134 /* Status Continuation entry */
1135 struct status_cont_entry {
1136        struct qla4_header hdr; /* 00-03 */
1137        uint8_t ext_sense_data[IOCB_MAX_EXT_SENSEDATA_LEN]; /* 04-63 */
1138 };
1139
1140 struct passthru0 {
1141         struct qla4_header hdr;                /* 00-03 */
1142         uint32_t handle;        /* 04-07 */
1143         uint16_t target;        /* 08-09 */
1144         uint16_t connection_id; /* 0A-0B */
1145 #define ISNS_DEFAULT_SERVER_CONN_ID     ((uint16_t)0x8000)
1146
1147         uint16_t control_flags; /* 0C-0D */
1148 #define PT_FLAG_ETHERNET_FRAME          0x8000
1149 #define PT_FLAG_ISNS_PDU                0x8000
1150 #define PT_FLAG_SEND_BUFFER             0x0200
1151 #define PT_FLAG_WAIT_4_RESPONSE         0x0100
1152 #define PT_FLAG_ISCSI_PDU               0x1000
1153
1154         uint16_t timeout;       /* 0E-0F */
1155 #define PT_DEFAULT_TIMEOUT              30 /* seconds */
1156
1157         struct data_seg_a64 out_dsd;    /* 10-1B */
1158         uint32_t res1;          /* 1C-1F */
1159         struct data_seg_a64 in_dsd;     /* 20-2B */
1160         uint8_t res2[20];       /* 2C-3F */
1161 };
1162
1163 struct passthru_status {
1164         struct qla4_header hdr;                /* 00-03 */
1165         uint32_t handle;        /* 04-07 */
1166         uint16_t target;        /* 08-09 */
1167         uint16_t connectionID;  /* 0A-0B */
1168
1169         uint8_t completionStatus;       /* 0C */
1170 #define PASSTHRU_STATUS_COMPLETE                0x01
1171
1172         uint8_t residualFlags;  /* 0D */
1173
1174         uint16_t timeout;       /* 0E-0F */
1175         uint16_t portNumber;    /* 10-11 */
1176         uint8_t res1[10];       /* 12-1B */
1177         uint32_t outResidual;   /* 1C-1F */
1178         uint8_t res2[12];       /* 20-2B */
1179         uint32_t inResidual;    /* 2C-2F */
1180         uint8_t res4[16];       /* 30-3F */
1181 };
1182
1183 struct mbox_cmd_iocb {
1184         struct qla4_header hdr; /* 00-03 */
1185         uint32_t handle;        /* 04-07 */
1186         uint32_t in_mbox[8];    /* 08-25 */
1187         uint32_t res1[6];       /* 26-3F */
1188 };
1189
1190 struct mbox_status_iocb {
1191         struct qla4_header hdr; /* 00-03 */
1192         uint32_t handle;        /* 04-07 */
1193         uint32_t out_mbox[8];   /* 08-25 */
1194         uint32_t res1[6];       /* 26-3F */
1195 };
1196
1197 /*
1198  * ISP queue - response queue entry definition.
1199  */
1200 struct response {
1201         uint8_t data[60];
1202         uint32_t signature;
1203 #define RESPONSE_PROCESSED      0xDEADDEAD      /* Signature */
1204 };
1205
1206 struct ql_iscsi_stats {
1207         uint8_t reserved1[656]; /* 0000-028F */
1208         uint32_t tx_cmd_pdu; /* 0290-0293 */
1209         uint32_t tx_resp_pdu; /* 0294-0297 */
1210         uint32_t rx_cmd_pdu; /* 0298-029B */
1211         uint32_t rx_resp_pdu; /* 029C-029F */
1212
1213         uint64_t tx_data_octets; /* 02A0-02A7 */
1214         uint64_t rx_data_octets; /* 02A8-02AF */
1215
1216         uint32_t hdr_digest_err; /* 02B0–02B3 */
1217         uint32_t data_digest_err; /* 02B4–02B7 */
1218         uint32_t conn_timeout_err; /* 02B8–02BB */
1219         uint32_t framing_err; /* 02BC–02BF */
1220
1221         uint32_t tx_nopout_pdus; /* 02C0–02C3 */
1222         uint32_t tx_scsi_cmd_pdus;  /* 02C4–02C7 */
1223         uint32_t tx_tmf_cmd_pdus; /* 02C8–02CB */
1224         uint32_t tx_login_cmd_pdus; /* 02CC–02CF */
1225         uint32_t tx_text_cmd_pdus; /* 02D0–02D3 */
1226         uint32_t tx_scsi_write_pdus; /* 02D4–02D7 */
1227         uint32_t tx_logout_cmd_pdus; /* 02D8–02DB */
1228         uint32_t tx_snack_req_pdus; /* 02DC–02DF */
1229
1230         uint32_t rx_nopin_pdus; /* 02E0–02E3 */
1231         uint32_t rx_scsi_resp_pdus; /* 02E4–02E7 */
1232         uint32_t rx_tmf_resp_pdus; /* 02E8–02EB */
1233         uint32_t rx_login_resp_pdus; /* 02EC–02EF */
1234         uint32_t rx_text_resp_pdus; /* 02F0–02F3 */
1235         uint32_t rx_scsi_read_pdus; /* 02F4–02F7 */
1236         uint32_t rx_logout_resp_pdus; /* 02F8–02FB */
1237
1238         uint32_t rx_r2t_pdus; /* 02FC–02FF */
1239         uint32_t rx_async_pdus; /* 0300–0303 */
1240         uint32_t rx_reject_pdus; /* 0304–0307 */
1241
1242         uint8_t reserved2[264]; /* 0x0308 - 0x040F */
1243 };
1244
1245 #define QLA8XXX_DBG_STATE_ARRAY_LEN             16
1246 #define QLA8XXX_DBG_CAP_SIZE_ARRAY_LEN          8
1247 #define QLA8XXX_DBG_RSVD_ARRAY_LEN              8
1248 #define QLA83XX_DBG_OCM_WNDREG_ARRAY_LEN        16
1249 #define QLA83XX_SS_OCM_WNDREG_INDEX             3
1250 #define QLA83XX_SS_PCI_INDEX                    0
1251
1252 struct qla4_8xxx_minidump_template_hdr {
1253         uint32_t entry_type;
1254         uint32_t first_entry_offset;
1255         uint32_t size_of_template;
1256         uint32_t capture_debug_level;
1257         uint32_t num_of_entries;
1258         uint32_t version;
1259         uint32_t driver_timestamp;
1260         uint32_t checksum;
1261
1262         uint32_t driver_capture_mask;
1263         uint32_t driver_info_word2;
1264         uint32_t driver_info_word3;
1265         uint32_t driver_info_word4;
1266
1267         uint32_t saved_state_array[QLA8XXX_DBG_STATE_ARRAY_LEN];
1268         uint32_t capture_size_array[QLA8XXX_DBG_CAP_SIZE_ARRAY_LEN];
1269         uint32_t ocm_window_reg[QLA83XX_DBG_OCM_WNDREG_ARRAY_LEN];
1270 };
1271
1272 #endif /*  _QLA4X_FW_H */