drivers/scsi/qla2xxx/qla_def.h

   1 /*
   2  * QLogic Fibre Channel HBA Driver
   3  * Copyright (c)  2003-2005 QLogic Corporation
   4  *
   5  * See LICENSE.qla2xxx for copyright and licensing details.
   6  */
   7 #ifndef __QLA_DEF_H
   8 #define __QLA_DEF_H
   9
  10 #include <linux/kernel.h>
  11 #include <linux/init.h>
  12 #include <linux/types.h>
  13 #include <linux/module.h>
  14 #include <linux/list.h>
  15 #include <linux/pci.h>
  16 #include <linux/dma-mapping.h>
  17 #include <linux/sched.h>
  18 #include <linux/slab.h>
  19 #include <linux/dmapool.h>
  20 #include <linux/mempool.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/completion.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/firmware.h>
  26 #include <linux/aer.h>
  27 #include <asm/semaphore.h>
  28
  29 #include <scsi/scsi.h>
  30 #include <scsi/scsi_host.h>
  31 #include <scsi/scsi_device.h>
  32 #include <scsi/scsi_cmnd.h>
  33 #include <scsi/scsi_transport_fc.h>
  34
  35 #define QLA2XXX_DRIVER_NAME  "qla2xxx"
  36
  37 /*
  38  * We have MAILBOX_REGISTER_COUNT sized arrays in a few places,
  39  * but that's fine as we don't look at the last 24 ones for
  40  * ISP2100 HBAs.
  41  */
  42 #define MAILBOX_REGISTER_COUNT_2100     8
  43 #define MAILBOX_REGISTER_COUNT          32
  44
  45 #define QLA2200A_RISC_ROM_VER   4
  46 #define FPM_2300                6
  47 #define FPM_2310                7
  48
  49 #include "qla_settings.h"
  50
  51 /*
  52  * Data bit definitions
  53  */
  54 #define BIT_0   0x1
  55 #define BIT_1   0x2
  56 #define BIT_2   0x4
  57 #define BIT_3   0x8
  58 #define BIT_4   0x10
  59 #define BIT_5   0x20
  60 #define BIT_6   0x40
  61 #define BIT_7   0x80
  62 #define BIT_8   0x100
  63 #define BIT_9   0x200
  64 #define BIT_10  0x400
  65 #define BIT_11  0x800
  66 #define BIT_12  0x1000
  67 #define BIT_13  0x2000
  68 #define BIT_14  0x4000
  69 #define BIT_15  0x8000
  70 #define BIT_16  0x10000
  71 #define BIT_17  0x20000
  72 #define BIT_18  0x40000
  73 #define BIT_19  0x80000
  74 #define BIT_20  0x100000
  75 #define BIT_21  0x200000
  76 #define BIT_22  0x400000
  77 #define BIT_23  0x800000
  78 #define BIT_24  0x1000000
  79 #define BIT_25  0x2000000
  80 #define BIT_26  0x4000000
  81 #define BIT_27  0x8000000
  82 #define BIT_28  0x10000000
  83 #define BIT_29  0x20000000
  84 #define BIT_30  0x40000000
  85 #define BIT_31  0x80000000
  86
  87 #define LSB(x)  ((uint8_t)(x))
  88 #define MSB(x)  ((uint8_t)((uint16_t)(x) >> 8))
  89
  90 #define LSW(x)  ((uint16_t)(x))
  91 #define MSW(x)  ((uint16_t)((uint32_t)(x) >> 16))
  92
  93 #define LSD(x)  ((uint32_t)((uint64_t)(x)))
  94 #define MSD(x)  ((uint32_t)((((uint64_t)(x)) >> 16) >> 16))
  95
  96
  97 /*
  98  * I/O register
  99 */
 100
 101 #define RD_REG_BYTE(addr)               readb(addr)
 102 #define RD_REG_WORD(addr)               readw(addr)
 103 #define RD_REG_DWORD(addr)              readl(addr)
 104 #define RD_REG_BYTE_RELAXED(addr)       readb_relaxed(addr)
 105 #define RD_REG_WORD_RELAXED(addr)       readw_relaxed(addr)
 106 #define RD_REG_DWORD_RELAXED(addr)      readl_relaxed(addr)
 107 #define WRT_REG_BYTE(addr, data)        writeb(data,addr)
 108 #define WRT_REG_WORD(addr, data)        writew(data,addr)
 109 #define WRT_REG_DWORD(addr, data)       writel(data,addr)
 110
 111 /*
 112  * The ISP2312 v2 chip cannot access the FLASH/GPIO registers via MMIO in an
 113  * 133Mhz slot.
 114  */
 115 #define RD_REG_WORD_PIO(addr)           (inw((unsigned long)addr))
 116 #define WRT_REG_WORD_PIO(addr, data)    (outw(data,(unsigned long)addr))
 117
 118 /*
 119  * Fibre Channel device definitions.
 120  */
 121 #define WWN_SIZE                8       /* Size of WWPN, WWN & WWNN */
 122 #define MAX_FIBRE_DEVICES       512
 123 #define MAX_FIBRE_LUNS          0xFFFF
 124 #define MAX_RSCN_COUNT          32
 125 #define MAX_HOST_COUNT          16
 126
 127 /*
 128  * Host adapter default definitions.
 129  */
 130 #define MAX_BUSES               1  /* We only have one bus today */
 131 #define MAX_TARGETS_2100        MAX_FIBRE_DEVICES
 132 #define MAX_TARGETS_2200        MAX_FIBRE_DEVICES
 133 #define MIN_LUNS                8
 134 #define MAX_LUNS                MAX_FIBRE_LUNS
 135 #define MAX_CMDS_PER_LUN        255
 136
 137 /*
 138  * Fibre Channel device definitions.
 139  */
 140 #define SNS_LAST_LOOP_ID_2100   0xfe
 141 #define SNS_LAST_LOOP_ID_2300   0x7ff
 142
 143 #define LAST_LOCAL_LOOP_ID      0x7d
 144 #define SNS_FL_PORT             0x7e
 145 #define FABRIC_CONTROLLER       0x7f
 146 #define SIMPLE_NAME_SERVER      0x80
 147 #define SNS_FIRST_LOOP_ID       0x81
 148 #define MANAGEMENT_SERVER       0xfe
 149 #define BROADCAST               0xff
 150
 151 /*
 152  * There is no correspondence between an N-PORT id and an AL_PA.  Therefore the
 153  * valid range of an N-PORT id is 0 through 0x7ef.
 154  */
 155 #define NPH_LAST_HANDLE         0x7ef
 156 #define NPH_MGMT_SERVER         0x7fa           /*  FFFFFA */
 157 #define NPH_SNS                 0x7fc           /*  FFFFFC */
 158 #define NPH_FABRIC_CONTROLLER   0x7fd           /*  FFFFFD */
 159 #define NPH_F_PORT              0x7fe           /*  FFFFFE */
 160 #define NPH_IP_BROADCAST        0x7ff           /*  FFFFFF */
 161
 162 #define MAX_CMDSZ       16              /* SCSI maximum CDB size. */
 163 #include "qla_fw.h"
 164
 165 /*
 166  * Timeout timer counts in seconds
 167  */
 168 #define PORT_RETRY_TIME                 1
 169 #define LOOP_DOWN_TIMEOUT               60
 170 #define LOOP_DOWN_TIME                  255     /* 240 */
 171 #define LOOP_DOWN_RESET                 (LOOP_DOWN_TIME - 30)
 172
 173 /* Maximum outstanding commands in ISP queues (1-65535) */
 174 #define MAX_OUTSTANDING_COMMANDS        1024
 175
 176 /* ISP request and response entry counts (37-65535) */
 177 #define REQUEST_ENTRY_CNT_2100          128     /* Number of request entries. */
 178 #define REQUEST_ENTRY_CNT_2200          2048    /* Number of request entries. */
 179 #define REQUEST_ENTRY_CNT_2XXX_EXT_MEM  4096    /* Number of request entries. */
 180 #define REQUEST_ENTRY_CNT_24XX          4096    /* Number of request entries. */
 181 #define RESPONSE_ENTRY_CNT_2100         64      /* Number of response entries.*/
 182 #define RESPONSE_ENTRY_CNT_2300         512     /* Number of response entries.*/
 183
 184 /*
 185  * SCSI Request Block
 186  */
 187 typedef struct srb {
 188         struct list_head list;
 189
 190         struct scsi_qla_host *ha;       /* HA the SP is queued on */
 191         struct fc_port *fcport;
 192
 193         struct scsi_cmnd *cmd;          /* Linux SCSI command pkt */
 194
 195         uint16_t flags;
 196
 197         /* Single transfer DMA context */
 198         dma_addr_t dma_handle;
 199
 200         uint32_t request_sense_length;
 201         uint8_t *request_sense_ptr;
 202 } srb_t;
 203
 204 /*
 205  * SRB flag definitions
 206  */
 207 #define SRB_TIMEOUT             BIT_0   /* Command timed out */
 208 #define SRB_DMA_VALID           BIT_1   /* Command sent to ISP */
 209 #define SRB_WATCHDOG            BIT_2   /* Command on watchdog list */
 210 #define SRB_ABORT_PENDING       BIT_3   /* Command abort sent to device */
 211
 212 #define SRB_ABORTED             BIT_4   /* Command aborted command already */
 213 #define SRB_RETRY               BIT_5   /* Command needs retrying */
 214 #define SRB_GOT_SENSE           BIT_6   /* Command has sense data */
 215 #define SRB_FAILOVER            BIT_7   /* Command in failover state */
 216
 217 #define SRB_BUSY                BIT_8   /* Command is in busy retry state */
 218 #define SRB_FO_CANCEL           BIT_9   /* Command don't need to do failover */
 219 #define SRB_IOCTL               BIT_10  /* IOCTL command. */
 220 #define SRB_TAPE                BIT_11  /* FCP2 (Tape) command. */
 221
 222 /*
 223  * ISP I/O Register Set structure definitions.
 224  */
 225 struct device_reg_2xxx {
 226         uint16_t flash_address;         /* Flash BIOS address */
 227         uint16_t flash_data;            /* Flash BIOS data */
 228         uint16_t unused_1[1];           /* Gap */
 229         uint16_t ctrl_status;           /* Control/Status */
 230 #define CSR_FLASH_64K_BANK      BIT_3   /* Flash upper 64K bank select */
 231 #define CSR_FLASH_ENABLE        BIT_1   /* Flash BIOS Read/Write enable */
 232 #define CSR_ISP_SOFT_RESET      BIT_0   /* ISP soft reset */
 233
 234         uint16_t ictrl;                 /* Interrupt control */
 235 #define ICR_EN_INT              BIT_15  /* ISP enable interrupts. */
 236 #define ICR_EN_RISC             BIT_3   /* ISP enable RISC interrupts. */
 237
 238         uint16_t istatus;               /* Interrupt status */
 239 #define ISR_RISC_INT            BIT_3   /* RISC interrupt */
 240
 241         uint16_t semaphore;             /* Semaphore */
 242         uint16_t nvram;                 /* NVRAM register. */
 243 #define NVR_DESELECT            0
 244 #define NVR_BUSY                BIT_15
 245 #define NVR_WRT_ENABLE          BIT_14  /* Write enable */
 246 #define NVR_PR_ENABLE           BIT_13  /* Protection register enable */
 247 #define NVR_DATA_IN             BIT_3
 248 #define NVR_DATA_OUT            BIT_2
 249 #define NVR_SELECT              BIT_1
 250 #define NVR_CLOCK               BIT_0
 251
 252 #define NVR_WAIT_CNT            20000
 253
 254         union {
 255                 struct {
 256                         uint16_t mailbox0;
 257                         uint16_t mailbox1;
 258                         uint16_t mailbox2;
 259                         uint16_t mailbox3;
 260                         uint16_t mailbox4;
 261                         uint16_t mailbox5;
 262                         uint16_t mailbox6;
 263                         uint16_t mailbox7;
 264                         uint16_t unused_2[59];  /* Gap */
 265                 } __attribute__((packed)) isp2100;
 266                 struct {
 267                                                 /* Request Queue */
 268                         uint16_t req_q_in;      /*  In-Pointer */
 269                         uint16_t req_q_out;     /*  Out-Pointer */
 270                                                 /* Response Queue */
 271                         uint16_t rsp_q_in;      /*  In-Pointer */
 272                         uint16_t rsp_q_out;     /*  Out-Pointer */
 273
 274                                                 /* RISC to Host Status */
 275                         uint32_t host_status;
 276 #define HSR_RISC_INT            BIT_15  /* RISC interrupt */
 277 #define HSR_RISC_PAUSED         BIT_8   /* RISC Paused */
 278
 279                                         /* Host to Host Semaphore */
 280                         uint16_t host_semaphore;
 281                         uint16_t unused_3[17];  /* Gap */
 282                         uint16_t mailbox0;
 283                         uint16_t mailbox1;
 284                         uint16_t mailbox2;
 285                         uint16_t mailbox3;
 286                         uint16_t mailbox4;
 287                         uint16_t mailbox5;
 288                         uint16_t mailbox6;
 289                         uint16_t mailbox7;
 290                         uint16_t mailbox8;
 291                         uint16_t mailbox9;
 292                         uint16_t mailbox10;
 293                         uint16_t mailbox11;
 294                         uint16_t mailbox12;
 295                         uint16_t mailbox13;
 296                         uint16_t mailbox14;
 297                         uint16_t mailbox15;
 298                         uint16_t mailbox16;
 299                         uint16_t mailbox17;
 300                         uint16_t mailbox18;
 301                         uint16_t mailbox19;
 302                         uint16_t mailbox20;
 303                         uint16_t mailbox21;
 304                         uint16_t mailbox22;
 305                         uint16_t mailbox23;
 306                         uint16_t mailbox24;
 307                         uint16_t mailbox25;
 308                         uint16_t mailbox26;
 309                         uint16_t mailbox27;
 310                         uint16_t mailbox28;
 311                         uint16_t mailbox29;
 312                         uint16_t mailbox30;
 313                         uint16_t mailbox31;
 314                         uint16_t fb_cmd;
 315                         uint16_t unused_4[10];  /* Gap */
 316                 } __attribute__((packed)) isp2300;
 317         } u;
 318
 319         uint16_t fpm_diag_config;
 320         uint16_t unused_5[0x4];         /* Gap */
 321         uint16_t risc_hw;
 322         uint16_t unused_5_1;            /* Gap */
 323         uint16_t pcr;                   /* Processor Control Register. */
 324         uint16_t unused_6[0x5];         /* Gap */
 325         uint16_t mctr;                  /* Memory Configuration and Timing. */
 326         uint16_t unused_7[0x3];         /* Gap */
 327         uint16_t fb_cmd_2100;           /* Unused on 23XX */
 328         uint16_t unused_8[0x3];         /* Gap */
 329         uint16_t hccr;                  /* Host command & control register. */
 330 #define HCCR_HOST_INT           BIT_7   /* Host interrupt bit */
 331 #define HCCR_RISC_PAUSE         BIT_5   /* Pause mode bit */
 332                                         /* HCCR commands */
 333 #define HCCR_RESET_RISC         0x1000  /* Reset RISC */
 334 #define HCCR_PAUSE_RISC         0x2000  /* Pause RISC */
 335 #define HCCR_RELEASE_RISC       0x3000  /* Release RISC from reset. */
 336 #define HCCR_SET_HOST_INT       0x5000  /* Set host interrupt */
 337 #define HCCR_CLR_HOST_INT       0x6000  /* Clear HOST interrupt */
 338 #define HCCR_CLR_RISC_INT       0x7000  /* Clear RISC interrupt */
 339 #define HCCR_DISABLE_PARITY_PAUSE 0x4001 /* Disable parity error RISC pause. */
 340 #define HCCR_ENABLE_PARITY      0xA000  /* Enable PARITY interrupt */
 341
 342         uint16_t unused_9[5];           /* Gap */
 343         uint16_t gpiod;                 /* GPIO Data register. */
 344         uint16_t gpioe;                 /* GPIO Enable register. */
 345 #define GPIO_LED_MASK                   0x00C0
 346 #define GPIO_LED_GREEN_OFF_AMBER_OFF    0x0000
 347 #define GPIO_LED_GREEN_ON_AMBER_OFF     0x0040
 348 #define GPIO_LED_GREEN_OFF_AMBER_ON     0x0080
 349 #define GPIO_LED_GREEN_ON_AMBER_ON      0x00C0
 350 #define GPIO_LED_ALL_OFF                0x0000
 351 #define GPIO_LED_RED_ON_OTHER_OFF       0x0001  /* isp2322 */
 352 #define GPIO_LED_RGA_ON                 0x00C1  /* isp2322: red green amber */
 353
 354         union {
 355                 struct {
 356                         uint16_t unused_10[8];  /* Gap */
 357                         uint16_t mailbox8;
 358                         uint16_t mailbox9;
 359                         uint16_t mailbox10;
 360                         uint16_t mailbox11;
 361                         uint16_t mailbox12;
 362                         uint16_t mailbox13;
 363                         uint16_t mailbox14;
 364                         uint16_t mailbox15;
 365                         uint16_t mailbox16;
 366                         uint16_t mailbox17;
 367                         uint16_t mailbox18;
 368                         uint16_t mailbox19;
 369                         uint16_t mailbox20;
 370                         uint16_t mailbox21;
 371                         uint16_t mailbox22;
 372                         uint16_t mailbox23;     /* Also probe reg. */
 373                 } __attribute__((packed)) isp2200;
 374         } u_end;
 375 };
 376
 377 typedef union {
 378                 struct device_reg_2xxx isp;
 379                 struct device_reg_24xx isp24;
 380 } device_reg_t;
 381
 382 #define ISP_REQ_Q_IN(ha, reg) \
 383         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 384          &(reg)->u.isp2100.mailbox4 : \
 385          &(reg)->u.isp2300.req_q_in)
 386 #define ISP_REQ_Q_OUT(ha, reg) \
 387         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 388          &(reg)->u.isp2100.mailbox4 : \
 389          &(reg)->u.isp2300.req_q_out)
 390 #define ISP_RSP_Q_IN(ha, reg) \
 391         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 392          &(reg)->u.isp2100.mailbox5 : \
 393          &(reg)->u.isp2300.rsp_q_in)
 394 #define ISP_RSP_Q_OUT(ha, reg) \
 395         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 396          &(reg)->u.isp2100.mailbox5 : \
 397          &(reg)->u.isp2300.rsp_q_out)
 398
 399 #define MAILBOX_REG(ha, reg, num) \
 400         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 401          (num < 8 ? \
 402           &(reg)->u.isp2100.mailbox0 + (num) : \
 403           &(reg)->u_end.isp2200.mailbox8 + (num) - 8) : \
 404          &(reg)->u.isp2300.mailbox0 + (num))
 405 #define RD_MAILBOX_REG(ha, reg, num) \
 406         RD_REG_WORD(MAILBOX_REG(ha, reg, num))
 407 #define WRT_MAILBOX_REG(ha, reg, num, data) \
 408         WRT_REG_WORD(MAILBOX_REG(ha, reg, num), data)
 409
 410 #define FB_CMD_REG(ha, reg) \
 411         (IS_QLA2100(ha) || IS_QLA2200(ha) ? \
 412          &(reg)->fb_cmd_2100 : \
 413          &(reg)->u.isp2300.fb_cmd)
 414 #define RD_FB_CMD_REG(ha, reg) \
 415         RD_REG_WORD(FB_CMD_REG(ha, reg))
 416 #define WRT_FB_CMD_REG(ha, reg, data) \
 417         WRT_REG_WORD(FB_CMD_REG(ha, reg), data)
 418
 419 typedef struct {
 420         uint32_t        out_mb;         /* outbound from driver */
 421         uint32_t        in_mb;                  /* Incoming from RISC */
 422         uint16_t        mb[MAILBOX_REGISTER_COUNT];
 423         long            buf_size;
 424         void            *bufp;
 425         uint32_t        tov;
 426         uint8_t         flags;
 427 #define MBX_DMA_IN      BIT_0
 428 #define MBX_DMA_OUT     BIT_1
 429 #define IOCTL_CMD       BIT_2
 430 } mbx_cmd_t;
 431
 432 #define MBX_TOV_SECONDS 30
 433
 434 /*
 435  *  ISP product identification definitions in mailboxes after reset.
 436  */
 437 #define PROD_ID_1               0x4953
 438 #define PROD_ID_2               0x0000
 439 #define PROD_ID_2a              0x5020
 440 #define PROD_ID_3               0x2020
 441
 442 /*
 443  * ISP mailbox Self-Test status codes
 444  */
 445 #define MBS_FRM_ALIVE           0       /* Firmware Alive. */
 446 #define MBS_CHKSUM_ERR          1       /* Checksum Error. */
 447 #define MBS_BUSY                4       /* Busy. */
 448
 449 /*
 450  * ISP mailbox command complete status codes
 451  */
 452 #define MBS_COMMAND_COMPLETE            0x4000
 453 #define MBS_INVALID_COMMAND             0x4001
 454 #define MBS_HOST_INTERFACE_ERROR        0x4002
 455 #define MBS_TEST_FAILED                 0x4003
 456 #define MBS_COMMAND_ERROR               0x4005
 457 #define MBS_COMMAND_PARAMETER_ERROR     0x4006
 458 #define MBS_PORT_ID_USED                0x4007
 459 #define MBS_LOOP_ID_USED                0x4008
 460 #define MBS_ALL_IDS_IN_USE              0x4009
 461 #define MBS_NOT_LOGGED_IN               0x400A
 462 #define MBS_LINK_DOWN_ERROR             0x400B
 463 #define MBS_DIAG_ECHO_TEST_ERROR        0x400C
 464
 465 /*
 466  * ISP mailbox asynchronous event status codes
 467  */
 468 #define MBA_ASYNC_EVENT         0x8000  /* Asynchronous event. */
 469 #define MBA_RESET               0x8001  /* Reset Detected. */
 470 #define MBA_SYSTEM_ERR          0x8002  /* System Error. */
 471 #define MBA_REQ_TRANSFER_ERR    0x8003  /* Request Transfer Error. */
 472 #define MBA_RSP_TRANSFER_ERR    0x8004  /* Response Transfer Error. */
 473 #define MBA_WAKEUP_THRES        0x8005  /* Request Queue Wake-up. */
 474 #define MBA_LIP_OCCURRED        0x8010  /* Loop Initialization Procedure */
 475                                         /* occurred. */
 476 #define MBA_LOOP_UP             0x8011  /* FC Loop UP. */
 477 #define MBA_LOOP_DOWN           0x8012  /* FC Loop Down. */
 478 #define MBA_LIP_RESET           0x8013  /* LIP reset occurred. */
 479 #define MBA_PORT_UPDATE         0x8014  /* Port Database update. */
 480 #define MBA_RSCN_UPDATE         0x8015  /* Register State Chg Notification. */
 481 #define MBA_LIP_F8              0x8016  /* Received a LIP F8. */
 482 #define MBA_LOOP_INIT_ERR       0x8017  /* Loop Initialization Error. */
 483 #define MBA_FABRIC_AUTH_REQ     0x801b  /* Fabric Authentication Required. */
 484 #define MBA_SCSI_COMPLETION     0x8020  /* SCSI Command Complete. */
 485 #define MBA_CTIO_COMPLETION     0x8021  /* CTIO Complete. */
 486 #define MBA_IP_COMPLETION       0x8022  /* IP Transmit Command Complete. */
 487 #define MBA_IP_RECEIVE          0x8023  /* IP Received. */
 488 #define MBA_IP_BROADCAST        0x8024  /* IP Broadcast Received. */
 489 #define MBA_IP_LOW_WATER_MARK   0x8025  /* IP Low Water Mark reached. */
 490 #define MBA_IP_RCV_BUFFER_EMPTY 0x8026  /* IP receive buffer queue empty. */
 491 #define MBA_IP_HDR_DATA_SPLIT   0x8027  /* IP header/data splitting feature */
 492                                         /* used. */
 493 #define MBA_TRACE_NOTIFICATION  0x8028  /* Trace/Diagnostic notification. */
 494 #define MBA_POINT_TO_POINT      0x8030  /* Point to point mode. */
 495 #define MBA_CMPLT_1_16BIT       0x8031  /* Completion 1 16bit IOSB. */
 496 #define MBA_CMPLT_2_16BIT       0x8032  /* Completion 2 16bit IOSB. */
 497 #define MBA_CMPLT_3_16BIT       0x8033  /* Completion 3 16bit IOSB. */
 498 #define MBA_CMPLT_4_16BIT       0x8034  /* Completion 4 16bit IOSB. */
 499 #define MBA_CMPLT_5_16BIT       0x8035  /* Completion 5 16bit IOSB. */
 500 #define MBA_CHG_IN_CONNECTION   0x8036  /* Change in connection mode. */
 501 #define MBA_RIO_RESPONSE        0x8040  /* RIO response queue update. */
 502 #define MBA_ZIO_RESPONSE        0x8040  /* ZIO response queue update. */
 503 #define MBA_CMPLT_2_32BIT       0x8042  /* Completion 2 32bit IOSB. */
 504 #define MBA_BYPASS_NOTIFICATION 0x8043  /* Auto bypass notification. */
 505 #define MBA_DISCARD_RND_FRAME   0x8048  /* discard RND frame due to error. */
 506 #define MBA_REJECTED_FCP_CMD    0x8049  /* rejected FCP_CMD. */
 507
 508 /*
 509  * Firmware options 1, 2, 3.
 510  */
 511 #define FO1_AE_ON_LIPF8                 BIT_0
 512 #define FO1_AE_ALL_LIP_RESET            BIT_1
 513 #define FO1_CTIO_RETRY                  BIT_3
 514 #define FO1_DISABLE_LIP_F7_SW           BIT_4
 515 #define FO1_DISABLE_100MS_LOS_WAIT      BIT_5
 516 #define FO1_DISABLE_GPIO6_7             BIT_6   /* LED bits */
 517 #define FO1_AE_ON_LOOP_INIT_ERR         BIT_7
 518 #define FO1_SET_EMPHASIS_SWING          BIT_8
 519 #define FO1_AE_AUTO_BYPASS              BIT_9
 520 #define FO1_ENABLE_PURE_IOCB            BIT_10
 521 #define FO1_AE_PLOGI_RJT                BIT_11
 522 #define FO1_ENABLE_ABORT_SEQUENCE       BIT_12
 523 #define FO1_AE_QUEUE_FULL               BIT_13
 524
 525 #define FO2_ENABLE_ATIO_TYPE_3          BIT_0
 526 #define FO2_REV_LOOPBACK                BIT_1
 527
 528 #define FO3_ENABLE_EMERG_IOCB           BIT_0
 529 #define FO3_AE_RND_ERROR                BIT_1
 530
 531 /* 24XX additional firmware options */
 532 #define ADD_FO_COUNT                    3
 533 #define ADD_FO1_DISABLE_GPIO_LED_CTRL   BIT_6   /* LED bits */
 534 #define ADD_FO1_ENABLE_PUREX_IOCB       BIT_10
 535
 536 #define ADD_FO2_ENABLE_SEL_CLS2         BIT_5
 537
 538 #define ADD_FO3_NO_ABT_ON_LINK_DOWN     BIT_14
 539
 540 /*
 541  * ISP mailbox commands
 542  */
 543 #define MBC_LOAD_RAM                    1       /* Load RAM. */
 544 #define MBC_EXECUTE_FIRMWARE            2       /* Execute firmware. */
 545 #define MBC_WRITE_RAM_WORD              4       /* Write RAM word. */
 546 #define MBC_READ_RAM_WORD               5       /* Read RAM word. */
 547 #define MBC_MAILBOX_REGISTER_TEST       6       /* Wrap incoming mailboxes */
 548 #define MBC_VERIFY_CHECKSUM             7       /* Verify checksum. */
 549 #define MBC_GET_FIRMWARE_VERSION        8       /* Get firmware revision. */
 550 #define MBC_LOAD_RISC_RAM               9       /* Load RAM command. */
 551 #define MBC_DUMP_RISC_RAM               0xa     /* Dump RAM command. */
 552 #define MBC_LOAD_RISC_RAM_EXTENDED      0xb     /* Load RAM extended. */
 553 #define MBC_DUMP_RISC_RAM_EXTENDED      0xc     /* Dump RAM extended. */
 554 #define MBC_WRITE_RAM_WORD_EXTENDED     0xd     /* Write RAM word extended */
 555 #define MBC_READ_RAM_EXTENDED           0xf     /* Read RAM extended. */
 556 #define MBC_IOCB_COMMAND                0x12    /* Execute IOCB command. */
 557 #define MBC_STOP_FIRMWARE               0x14    /* Stop firmware. */
 558 #define MBC_ABORT_COMMAND               0x15    /* Abort IOCB command. */
 559 #define MBC_ABORT_DEVICE                0x16    /* Abort device (ID/LUN). */
 560 #define MBC_ABORT_TARGET                0x17    /* Abort target (ID). */
 561 #define MBC_RESET                       0x18    /* Reset. */
 562 #define MBC_GET_ADAPTER_LOOP_ID         0x20    /* Get loop id of ISP2200. */
 563 #define MBC_GET_RETRY_COUNT             0x22    /* Get f/w retry cnt/delay. */
 564 #define MBC_DISABLE_VI                  0x24    /* Disable VI operation. */
 565 #define MBC_ENABLE_VI                   0x25    /* Enable VI operation. */
 566 #define MBC_GET_FIRMWARE_OPTION         0x28    /* Get Firmware Options. */
 567 #define MBC_SET_FIRMWARE_OPTION         0x38    /* Set Firmware Options. */
 568 #define MBC_LOOP_PORT_BYPASS            0x40    /* Loop Port Bypass. */
 569 #define MBC_LOOP_PORT_ENABLE            0x41    /* Loop Port Enable. */
 570 #define MBC_GET_RESOURCE_COUNTS         0x42    /* Get Resource Counts. */
 571 #define MBC_NON_PARTICIPATE             0x43    /* Non-Participating Mode. */
 572 #define MBC_DIAGNOSTIC_ECHO             0x44    /* Diagnostic echo. */
 573 #define MBC_DIAGNOSTIC_LOOP_BACK        0x45    /* Diagnostic loop back. */
 574 #define MBC_ONLINE_SELF_TEST            0x46    /* Online self-test. */
 575 #define MBC_ENHANCED_GET_PORT_DATABASE  0x47    /* Get port database + login */
 576 #define MBC_RESET_LINK_STATUS           0x52    /* Reset Link Error Status */
 577 #define MBC_IOCB_COMMAND_A64            0x54    /* Execute IOCB command (64) */
 578 #define MBC_SEND_RNID_ELS               0x57    /* Send RNID ELS request */
 579 #define MBC_SET_RNID_PARAMS             0x59    /* Set RNID parameters */
 580 #define MBC_GET_RNID_PARAMS             0x5a    /* Data Rate */
 581 #define MBC_DATA_RATE                   0x5d    /* Get RNID parameters */
 582 #define MBC_INITIALIZE_FIRMWARE         0x60    /* Initialize firmware */
 583 #define MBC_INITIATE_LIP                0x62    /* Initiate Loop */
 584                                                 /* Initialization Procedure */
 585 #define MBC_GET_FC_AL_POSITION_MAP      0x63    /* Get FC_AL Position Map. */
 586 #define MBC_GET_PORT_DATABASE           0x64    /* Get Port Database. */
 587 #define MBC_CLEAR_ACA                   0x65    /* Clear ACA. */
 588 #define MBC_TARGET_RESET                0x66    /* Target Reset. */
 589 #define MBC_CLEAR_TASK_SET              0x67    /* Clear Task Set. */
 590 #define MBC_ABORT_TASK_SET              0x68    /* Abort Task Set. */
 591 #define MBC_GET_FIRMWARE_STATE          0x69    /* Get firmware state. */
 592 #define MBC_GET_PORT_NAME               0x6a    /* Get port name. */
 593 #define MBC_GET_LINK_STATUS             0x6b    /* Get port link status. */
 594 #define MBC_LIP_RESET                   0x6c    /* LIP reset. */
 595 #define MBC_SEND_SNS_COMMAND            0x6e    /* Send Simple Name Server */
 596                                                 /* commandd. */
 597 #define MBC_LOGIN_FABRIC_PORT           0x6f    /* Login fabric port. */
 598 #define MBC_SEND_CHANGE_REQUEST         0x70    /* Send Change Request. */
 599 #define MBC_LOGOUT_FABRIC_PORT          0x71    /* Logout fabric port. */
 600 #define MBC_LIP_FULL_LOGIN              0x72    /* Full login LIP. */
 601 #define MBC_LOGIN_LOOP_PORT             0x74    /* Login Loop Port. */
 602 #define MBC_PORT_NODE_NAME_LIST         0x75    /* Get port/node name list. */
 603 #define MBC_INITIALIZE_RECEIVE_QUEUE    0x77    /* Initialize receive queue */
 604 #define MBC_UNLOAD_IP                   0x79    /* Shutdown IP */
 605 #define MBC_GET_ID_LIST                 0x7C    /* Get Port ID list. */
 606 #define MBC_SEND_LFA_COMMAND            0x7D    /* Send Loop Fabric Address */
 607 #define MBC_LUN_RESET                   0x7E    /* Send LUN reset */
 608
 609 /*
 610  * ISP24xx mailbox commands
 611  */
 612 #define MBC_SERDES_PARAMS               0x10    /* Serdes Tx Parameters. */
 613 #define MBC_GET_IOCB_STATUS             0x12    /* Get IOCB status command. */
 614 #define MBC_PORT_PARAMS                 0x1A    /* Port iDMA Parameters. */
 615 #define MBC_GET_TIMEOUT_PARAMS          0x22    /* Get FW timeouts. */
 616 #define MBC_TRACE_CONTROL               0x27    /* Trace control command. */
 617 #define MBC_GEN_SYSTEM_ERROR            0x2a    /* Generate System Error. */
 618 #define MBC_READ_SFP                    0x31    /* Read SFP Data. */
 619 #define MBC_SET_TIMEOUT_PARAMS          0x32    /* Set FW timeouts. */
 620 #define MBC_MID_INITIALIZE_FIRMWARE     0x48    /* MID Initialize firmware. */
 621 #define MBC_MID_GET_VP_DATABASE         0x49    /* MID Get VP Database. */
 622 #define MBC_MID_GET_VP_ENTRY            0x4a    /* MID Get VP Entry. */
 623 #define MBC_HOST_MEMORY_COPY            0x53    /* Host Memory Copy. */
 624 #define MBC_SEND_RNFT_ELS               0x5e    /* Send RNFT ELS request */
 625 #define MBC_GET_LINK_PRIV_STATS         0x6d    /* Get link & private data. */
 626 #define MBC_SET_VENDOR_ID               0x76    /* Set Vendor ID. */
 627
 628 #define TC_ENABLE                       4
 629 #define TC_DISABLE                      5
 630
 631 /* Firmware return data sizes */
 632 #define FCAL_MAP_SIZE   128
 633
 634 /* Mailbox bit definitions for out_mb and in_mb */
 635 #define MBX_31          BIT_31
 636 #define MBX_30          BIT_30
 637 #define MBX_29          BIT_29
 638 #define MBX_28          BIT_28
 639 #define MBX_27          BIT_27
 640 #define MBX_26          BIT_26
 641 #define MBX_25          BIT_25
 642 #define MBX_24          BIT_24
 643 #define MBX_23          BIT_23
 644 #define MBX_22          BIT_22
 645 #define MBX_21          BIT_21
 646 #define MBX_20          BIT_20
 647 #define MBX_19          BIT_19
 648 #define MBX_18          BIT_18
 649 #define MBX_17          BIT_17
 650 #define MBX_16          BIT_16
 651 #define MBX_15          BIT_15
 652 #define MBX_14          BIT_14
 653 #define MBX_13          BIT_13
 654 #define MBX_12          BIT_12
 655 #define MBX_11          BIT_11
 656 #define MBX_10          BIT_10
 657 #define MBX_9           BIT_9
 658 #define MBX_8           BIT_8
 659 #define MBX_7           BIT_7
 660 #define MBX_6           BIT_6
 661 #define MBX_5           BIT_5
 662 #define MBX_4           BIT_4
 663 #define MBX_3           BIT_3
 664 #define MBX_2           BIT_2
 665 #define MBX_1           BIT_1
 666 #define MBX_0           BIT_0
 667
 668 /*
 669  * Firmware state codes from get firmware state mailbox command
 670  */
 671 #define FSTATE_CONFIG_WAIT      0
 672 #define FSTATE_WAIT_AL_PA       1
 673 #define FSTATE_WAIT_LOGIN       2
 674 #define FSTATE_READY            3
 675 #define FSTATE_LOSS_OF_SYNC     4
 676 #define FSTATE_ERROR            5
 677 #define FSTATE_REINIT           6
 678 #define FSTATE_NON_PART         7
 679
 680 #define FSTATE_CONFIG_CORRECT      0
 681 #define FSTATE_P2P_RCV_LIP         1
 682 #define FSTATE_P2P_CHOOSE_LOOP     2
 683 #define FSTATE_P2P_RCV_UNIDEN_LIP  3
 684 #define FSTATE_FATAL_ERROR         4
 685 #define FSTATE_LOOP_BACK_CONN      5
 686
 687 /*
 688  * Port Database structure definition
 689  * Little endian except where noted.
 690  */
 691 #define PORT_DATABASE_SIZE      128     /* bytes */
 692 typedef struct {
 693         uint8_t options;
 694         uint8_t control;
 695         uint8_t master_state;
 696         uint8_t slave_state;
 697         uint8_t reserved[2];
 698         uint8_t hard_address;
 699         uint8_t reserved_1;
 700         uint8_t port_id[4];
 701         uint8_t node_name[WWN_SIZE];
 702         uint8_t port_name[WWN_SIZE];
 703         uint16_t execution_throttle;
 704         uint16_t execution_count;
 705         uint8_t reset_count;
 706         uint8_t reserved_2;
 707         uint16_t resource_allocation;
 708         uint16_t current_allocation;
 709         uint16_t queue_head;
 710         uint16_t queue_tail;
 711         uint16_t transmit_execution_list_next;
 712         uint16_t transmit_execution_list_previous;
 713         uint16_t common_features;
 714         uint16_t total_concurrent_sequences;
 715         uint16_t RO_by_information_category;
 716         uint8_t recipient;
 717         uint8_t initiator;
 718         uint16_t receive_data_size;
 719         uint16_t concurrent_sequences;
 720         uint16_t open_sequences_per_exchange;
 721         uint16_t lun_abort_flags;
 722         uint16_t lun_stop_flags;
 723         uint16_t stop_queue_head;
 724         uint16_t stop_queue_tail;
 725         uint16_t port_retry_timer;
 726         uint16_t next_sequence_id;
 727         uint16_t frame_count;
 728         uint16_t PRLI_payload_length;
 729         uint8_t prli_svc_param_word_0[2];       /* Big endian */
 730                                                 /* Bits 15-0 of word 0 */
 731         uint8_t prli_svc_param_word_3[2];       /* Big endian */
 732                                                 /* Bits 15-0 of word 3 */
 733         uint16_t loop_id;
 734         uint16_t extended_lun_info_list_pointer;
 735         uint16_t extended_lun_stop_list_pointer;
 736 } port_database_t;
 737
 738 /*
 739  * Port database slave/master states
 740  */
 741 #define PD_STATE_DISCOVERY                      0
 742 #define PD_STATE_WAIT_DISCOVERY_ACK             1
 743 #define PD_STATE_PORT_LOGIN                     2
 744 #define PD_STATE_WAIT_PORT_LOGIN_ACK            3
 745 #define PD_STATE_PROCESS_LOGIN                  4
 746 #define PD_STATE_WAIT_PROCESS_LOGIN_ACK         5
 747 #define PD_STATE_PORT_LOGGED_IN                 6
 748 #define PD_STATE_PORT_UNAVAILABLE               7
 749 #define PD_STATE_PROCESS_LOGOUT                 8
 750 #define PD_STATE_WAIT_PROCESS_LOGOUT_ACK        9
 751 #define PD_STATE_PORT_LOGOUT                    10
 752 #define PD_STATE_WAIT_PORT_LOGOUT_ACK           11
 753
 754
 755 #define QLA_ZIO_MODE_6          (BIT_2 | BIT_1)
 756 #define QLA_ZIO_DISABLED        0
 757 #define QLA_ZIO_DEFAULT_TIMER   2
 758
 759 /*
 760  * ISP Initialization Control Block.
 761  * Little endian except where noted.
 762  */
 763 #define ICB_VERSION 1
 764 typedef struct {
 765         uint8_t  version;
 766         uint8_t  reserved_1;
 767
 768         /*
 769          * LSB BIT 0  = Enable Hard Loop Id
 770          * LSB BIT 1  = Enable Fairness
 771          * LSB BIT 2  = Enable Full-Duplex
 772          * LSB BIT 3  = Enable Fast Posting
 773          * LSB BIT 4  = Enable Target Mode
 774          * LSB BIT 5  = Disable Initiator Mode
 775          * LSB BIT 6  = Enable ADISC
 776          * LSB BIT 7  = Enable Target Inquiry Data
 777          *
 778          * MSB BIT 0  = Enable PDBC Notify
 779          * MSB BIT 1  = Non Participating LIP
 780          * MSB BIT 2  = Descending Loop ID Search
 781          * MSB BIT 3  = Acquire Loop ID in LIPA
 782          * MSB BIT 4  = Stop PortQ on Full Status
 783          * MSB BIT 5  = Full Login after LIP
 784          * MSB BIT 6  = Node Name Option
 785          * MSB BIT 7  = Ext IFWCB enable bit
 786          */
 787         uint8_t  firmware_options[2];
 788
 789         uint16_t frame_payload_size;
 790         uint16_t max_iocb_allocation;
 791         uint16_t execution_throttle;
 792         uint8_t  retry_count;
 793         uint8_t  retry_delay;                   /* unused */
 794         uint8_t  port_name[WWN_SIZE];           /* Big endian. */
 795         uint16_t hard_address;
 796         uint8_t  inquiry_data;
 797         uint8_t  login_timeout;
 798         uint8_t  node_name[WWN_SIZE];           /* Big endian. */
 799
 800         uint16_t request_q_outpointer;
 801         uint16_t response_q_inpointer;
 802         uint16_t request_q_length;
 803         uint16_t response_q_length;
 804         uint32_t request_q_address[2];
 805         uint32_t response_q_address[2];
 806
 807         uint16_t lun_enables;
 808         uint8_t  command_resource_count;
 809         uint8_t  immediate_notify_resource_count;
 810         uint16_t timeout;
 811         uint8_t  reserved_2[2];
 812
 813         /*
 814          * LSB BIT 0 = Timer Operation mode bit 0
 815          * LSB BIT 1 = Timer Operation mode bit 1
 816          * LSB BIT 2 = Timer Operation mode bit 2
 817          * LSB BIT 3 = Timer Operation mode bit 3
 818          * LSB BIT 4 = Init Config Mode bit 0
 819          * LSB BIT 5 = Init Config Mode bit 1
 820          * LSB BIT 6 = Init Config Mode bit 2
 821          * LSB BIT 7 = Enable Non part on LIHA failure
 822          *
 823          * MSB BIT 0 = Enable class 2
 824          * MSB BIT 1 = Enable ACK0
 825          * MSB BIT 2 =
 826          * MSB BIT 3 =
 827          * MSB BIT 4 = FC Tape Enable
 828          * MSB BIT 5 = Enable FC Confirm
 829          * MSB BIT 6 = Enable command queuing in target mode
 830          * MSB BIT 7 = No Logo On Link Down
 831          */
 832         uint8_t  add_firmware_options[2];
 833
 834         uint8_t  response_accumulation_timer;
 835         uint8_t  interrupt_delay_timer;
 836
 837         /*
 838          * LSB BIT 0 = Enable Read xfr_rdy
 839          * LSB BIT 1 = Soft ID only
 840          * LSB BIT 2 =
 841          * LSB BIT 3 =
 842          * LSB BIT 4 = FCP RSP Payload [0]
 843          * LSB BIT 5 = FCP RSP Payload [1] / Sbus enable - 2200
 844          * LSB BIT 6 = Enable Out-of-Order frame handling
 845          * LSB BIT 7 = Disable Automatic PLOGI on Local Loop
 846          *
 847          * MSB BIT 0 = Sbus enable - 2300
 848          * MSB BIT 1 =
 849          * MSB BIT 2 =
 850          * MSB BIT 3 =
 851          * MSB BIT 4 = LED mode
 852          * MSB BIT 5 = enable 50 ohm termination
 853          * MSB BIT 6 = Data Rate (2300 only)
 854          * MSB BIT 7 = Data Rate (2300 only)
 855          */
 856         uint8_t  special_options[2];
 857
 858         uint8_t  reserved_3[26];
 859 } init_cb_t;
 860
 861 /*
 862  * Get Link Status mailbox command return buffer.
 863  */
 864 #define GLSO_SEND_RPS   BIT_0
 865 #define GLSO_USE_DID    BIT_3
 866
 867 typedef struct {
 868         uint32_t        link_fail_cnt;
 869         uint32_t        loss_sync_cnt;
 870         uint32_t        loss_sig_cnt;
 871         uint32_t        prim_seq_err_cnt;
 872         uint32_t        inval_xmit_word_cnt;
 873         uint32_t        inval_crc_cnt;
 874 } link_stat_t;
 875
 876 /*
 877  * NVRAM Command values.
 878  */
 879 #define NV_START_BIT            BIT_2
 880 #define NV_WRITE_OP             (BIT_26+BIT_24)
 881 #define NV_READ_OP              (BIT_26+BIT_25)
 882 #define NV_ERASE_OP             (BIT_26+BIT_25+BIT_24)
 883 #define NV_MASK_OP              (BIT_26+BIT_25+BIT_24)
 884 #define NV_DELAY_COUNT          10
 885
 886 /*
 887  * QLogic ISP2100, ISP2200 and ISP2300 NVRAM structure definition.
 888  */
 889 typedef struct {
 890         /*
 891          * NVRAM header
 892          */
 893         uint8_t id[4];
 894         uint8_t nvram_version;
 895         uint8_t reserved_0;
 896
 897         /*
 898          * NVRAM RISC parameter block
 899          */
 900         uint8_t parameter_block_version;
 901         uint8_t reserved_1;
 902
 903         /*
 904          * LSB BIT 0  = Enable Hard Loop Id
 905          * LSB BIT 1  = Enable Fairness
 906          * LSB BIT 2  = Enable Full-Duplex
 907          * LSB BIT 3  = Enable Fast Posting
 908          * LSB BIT 4  = Enable Target Mode
 909          * LSB BIT 5  = Disable Initiator Mode
 910          * LSB BIT 6  = Enable ADISC
 911          * LSB BIT 7  = Enable Target Inquiry Data
 912          *
 913          * MSB BIT 0  = Enable PDBC Notify
 914          * MSB BIT 1  = Non Participating LIP
 915          * MSB BIT 2  = Descending Loop ID Search
 916          * MSB BIT 3  = Acquire Loop ID in LIPA
 917          * MSB BIT 4  = Stop PortQ on Full Status
 918          * MSB BIT 5  = Full Login after LIP
 919          * MSB BIT 6  = Node Name Option
 920          * MSB BIT 7  = Ext IFWCB enable bit
 921          */
 922         uint8_t  firmware_options[2];
 923
 924         uint16_t frame_payload_size;
 925         uint16_t max_iocb_allocation;
 926         uint16_t execution_throttle;
 927         uint8_t  retry_count;
 928         uint8_t  retry_delay;                   /* unused */
 929         uint8_t  port_name[WWN_SIZE];           /* Big endian. */
 930         uint16_t hard_address;
 931         uint8_t  inquiry_data;
 932         uint8_t  login_timeout;
 933         uint8_t  node_name[WWN_SIZE];           /* Big endian. */
 934
 935         /*
 936          * LSB BIT 0 = Timer Operation mode bit 0
 937          * LSB BIT 1 = Timer Operation mode bit 1
 938          * LSB BIT 2 = Timer Operation mode bit 2
 939          * LSB BIT 3 = Timer Operation mode bit 3
 940          * LSB BIT 4 = Init Config Mode bit 0
 941          * LSB BIT 5 = Init Config Mode bit 1
 942          * LSB BIT 6 = Init Config Mode bit 2
 943          * LSB BIT 7 = Enable Non part on LIHA failure
 944          *
 945          * MSB BIT 0 = Enable class 2
 946          * MSB BIT 1 = Enable ACK0
 947          * MSB BIT 2 =
 948          * MSB BIT 3 =
 949          * MSB BIT 4 = FC Tape Enable
 950          * MSB BIT 5 = Enable FC Confirm
 951          * MSB BIT 6 = Enable command queuing in target mode
 952          * MSB BIT 7 = No Logo On Link Down
 953          */
 954         uint8_t  add_firmware_options[2];
 955
 956         uint8_t  response_accumulation_timer;
 957         uint8_t  interrupt_delay_timer;
 958
 959         /*
 960          * LSB BIT 0 = Enable Read xfr_rdy
 961          * LSB BIT 1 = Soft ID only
 962          * LSB BIT 2 =
 963          * LSB BIT 3 =
 964          * LSB BIT 4 = FCP RSP Payload [0]
 965          * LSB BIT 5 = FCP RSP Payload [1] / Sbus enable - 2200
 966          * LSB BIT 6 = Enable Out-of-Order frame handling
 967          * LSB BIT 7 = Disable Automatic PLOGI on Local Loop
 968          *
 969          * MSB BIT 0 = Sbus enable - 2300
 970          * MSB BIT 1 =
 971          * MSB BIT 2 =
 972          * MSB BIT 3 =
 973          * MSB BIT 4 = LED mode
 974          * MSB BIT 5 = enable 50 ohm termination
 975          * MSB BIT 6 = Data Rate (2300 only)
 976          * MSB BIT 7 = Data Rate (2300 only)
 977          */
 978         uint8_t  special_options[2];
 979
 980         /* Reserved for expanded RISC parameter block */
 981         uint8_t reserved_2[22];
 982
 983         /*
 984          * LSB BIT 0 = Tx Sensitivity 1G bit 0
 985          * LSB BIT 1 = Tx Sensitivity 1G bit 1
 986          * LSB BIT 2 = Tx Sensitivity 1G bit 2
 987          * LSB BIT 3 = Tx Sensitivity 1G bit 3
 988          * LSB BIT 4 = Rx Sensitivity 1G bit 0
 989          * LSB BIT 5 = Rx Sensitivity 1G bit 1
 990          * LSB BIT 6 = Rx Sensitivity 1G bit 2
 991          * LSB BIT 7 = Rx Sensitivity 1G bit 3
 992          *
 993          * MSB BIT 0 = Tx Sensitivity 2G bit 0
 994          * MSB BIT 1 = Tx Sensitivity 2G bit 1
 995          * MSB BIT 2 = Tx Sensitivity 2G bit 2
 996          * MSB BIT 3 = Tx Sensitivity 2G bit 3
 997          * MSB BIT 4 = Rx Sensitivity 2G bit 0
 998          * MSB BIT 5 = Rx Sensitivity 2G bit 1
 999          * MSB BIT 6 = Rx Sensitivity 2G bit 2
1000          * MSB BIT 7 = Rx Sensitivity 2G bit 3
1001          *
1002          * LSB BIT 0 = Output Swing 1G bit 0
1003          * LSB BIT 1 = Output Swing 1G bit 1
1004          * LSB BIT 2 = Output Swing 1G bit 2
1005          * LSB BIT 3 = Output Emphasis 1G bit 0
1006          * LSB BIT 4 = Output Emphasis 1G bit 1
1007          * LSB BIT 5 = Output Swing 2G bit 0
1008          * LSB BIT 6 = Output Swing 2G bit 1
1009          * LSB BIT 7 = Output Swing 2G bit 2
1010          *
1011          * MSB BIT 0 = Output Emphasis 2G bit 0
1012          * MSB BIT 1 = Output Emphasis 2G bit 1
1013          * MSB BIT 2 = Output Enable
1014          * MSB BIT 3 =
1015          * MSB BIT 4 =
1016          * MSB BIT 5 =
1017          * MSB BIT 6 =
1018          * MSB BIT 7 =
1019          */
1020         uint8_t seriallink_options[4];
1021
1022         /*
1023          * NVRAM host parameter block
1024          *
1025          * LSB BIT 0 = Enable spinup delay
1026          * LSB BIT 1 = Disable BIOS
1027          * LSB BIT 2 = Enable Memory Map BIOS
1028          * LSB BIT 3 = Enable Selectable Boot
1029          * LSB BIT 4 = Disable RISC code load
1030          * LSB BIT 5 = Set cache line size 1
1031          * LSB BIT 6 = PCI Parity Disable
1032          * LSB BIT 7 = Enable extended logging
1033          *
1034          * MSB BIT 0 = Enable 64bit addressing
1035          * MSB BIT 1 = Enable lip reset
1036          * MSB BIT 2 = Enable lip full login
1037          * MSB BIT 3 = Enable target reset
1038          * MSB BIT 4 = Enable database storage
1039          * MSB BIT 5 = Enable cache flush read
1040          * MSB BIT 6 = Enable database load
1041          * MSB BIT 7 = Enable alternate WWN
1042          */
1043         uint8_t host_p[2];
1044
1045         uint8_t boot_node_name[WWN_SIZE];
1046         uint8_t boot_lun_number;
1047         uint8_t reset_delay;
1048         uint8_t port_down_retry_count;
1049         uint8_t boot_id_number;
1050         uint16_t max_luns_per_target;
1051         uint8_t fcode_boot_port_name[WWN_SIZE];
1052         uint8_t alternate_port_name[WWN_SIZE];
1053         uint8_t alternate_node_name[WWN_SIZE];
1054
1055         /*
1056          * BIT 0 = Selective Login
1057          * BIT 1 = Alt-Boot Enable
1058          * BIT 2 =
1059          * BIT 3 = Boot Order List
1060          * BIT 4 =
1061          * BIT 5 = Selective LUN
1062          * BIT 6 =
1063          * BIT 7 = unused
1064          */
1065         uint8_t efi_parameters;
1066
1067         uint8_t link_down_timeout;
1068
1069         uint8_t adapter_id[16];
1070
1071         uint8_t alt1_boot_node_name[WWN_SIZE];
1072         uint16_t alt1_boot_lun_number;
1073         uint8_t alt2_boot_node_name[WWN_SIZE];
1074         uint16_t alt2_boot_lun_number;
1075         uint8_t alt3_boot_node_name[WWN_SIZE];
1076         uint16_t alt3_boot_lun_number;
1077         uint8_t alt4_boot_node_name[WWN_SIZE];
1078         uint16_t alt4_boot_lun_number;
1079         uint8_t alt5_boot_node_name[WWN_SIZE];
1080         uint16_t alt5_boot_lun_number;
1081         uint8_t alt6_boot_node_name[WWN_SIZE];
1082         uint16_t alt6_boot_lun_number;
1083         uint8_t alt7_boot_node_name[WWN_SIZE];
1084         uint16_t alt7_boot_lun_number;
1085
1086         uint8_t reserved_3[2];
1087
1088         /* Offset 200-215 : Model Number */
1089         uint8_t model_number[16];
1090
1091         /* OEM related items */
1092         uint8_t oem_specific[16];
1093
1094         /*
1095          * NVRAM Adapter Features offset 232-239
1096          *
1097          * LSB BIT 0 = External GBIC
1098          * LSB BIT 1 = Risc RAM parity
1099          * LSB BIT 2 = Buffer Plus Module
1100          * LSB BIT 3 = Multi Chip Adapter
1101          * LSB BIT 4 = Internal connector
1102          * LSB BIT 5 =
1103          * LSB BIT 6 =
1104          * LSB BIT 7 =
1105          *
1106          * MSB BIT 0 =
1107          * MSB BIT 1 =
1108          * MSB BIT 2 =
1109          * MSB BIT 3 =
1110          * MSB BIT 4 =
1111          * MSB BIT 5 =
1112          * MSB BIT 6 =
1113          * MSB BIT 7 =
1114          */
1115         uint8_t adapter_features[2];
1116
1117         uint8_t reserved_4[16];
1118
1119         /* Subsystem vendor ID for ISP2200 */
1120         uint16_t subsystem_vendor_id_2200;
1121
1122         /* Subsystem device ID for ISP2200 */
1123         uint16_t subsystem_device_id_2200;
1124
1125         uint8_t  reserved_5;
1126         uint8_t  checksum;
1127 } nvram_t;
1128
1129 /*
1130  * ISP queue - response queue entry definition.
1131  */
1132 typedef struct {
1133         uint8_t         data[60];
1134         uint32_t        signature;
1135 #define RESPONSE_PROCESSED      0xDEADDEAD      /* Signature */
1136 } response_t;
1137
1138 typedef union {
1139         uint16_t extended;
1140         struct {
1141                 uint8_t reserved;
1142                 uint8_t standard;
1143         } id;
1144 } target_id_t;
1145
1146 #define SET_TARGET_ID(ha, to, from)                     \
1147 do {                                                    \
1148         if (HAS_EXTENDED_IDS(ha))                       \
1149                 to.extended = cpu_to_le16(from);        \
1150         else                                            \
1151                 to.id.standard = (uint8_t)from;         \
1152 } while (0)
1153
1154 /*
1155  * ISP queue - command entry structure definition.
1156  */
1157 #define COMMAND_TYPE    0x11            /* Command entry */
1158 typedef struct {
1159         uint8_t entry_type;             /* Entry type. */
1160         uint8_t entry_count;            /* Entry count. */
1161         uint8_t sys_define;             /* System defined. */
1162         uint8_t entry_status;           /* Entry Status. */
1163         uint32_t handle;                /* System handle. */
1164         target_id_t target;             /* SCSI ID */
1165         uint16_t lun;                   /* SCSI LUN */
1166         uint16_t control_flags;         /* Control flags. */
1167 #define CF_WRITE        BIT_6
1168 #define CF_READ         BIT_5
1169 #define CF_SIMPLE_TAG   BIT_3
1170 #define CF_ORDERED_TAG  BIT_2
1171 #define CF_HEAD_TAG     BIT_1
1172         uint16_t reserved_1;
1173         uint16_t timeout;               /* Command timeout. */
1174         uint16_t dseg_count;            /* Data segment count. */
1175         uint8_t scsi_cdb[MAX_CMDSZ];    /* SCSI command words. */
1176         uint32_t byte_count;            /* Total byte count. */
1177         uint32_t dseg_0_address;        /* Data segment 0 address. */
1178         uint32_t dseg_0_length;         /* Data segment 0 length. */
1179         uint32_t dseg_1_address;        /* Data segment 1 address. */
1180         uint32_t dseg_1_length;         /* Data segment 1 length. */
1181         uint32_t dseg_2_address;        /* Data segment 2 address. */
1182         uint32_t dseg_2_length;         /* Data segment 2 length. */
1183 } cmd_entry_t;
1184
1185 /*
1186  * ISP queue - 64-Bit addressing, command entry structure definition.
1187  */
1188 #define COMMAND_A64_TYPE        0x19    /* Command A64 entry */
1189 typedef struct {
1190         uint8_t entry_type;             /* Entry type. */
1191         uint8_t entry_count;            /* Entry count. */
1192         uint8_t sys_define;             /* System defined. */
1193         uint8_t entry_status;           /* Entry Status. */
1194         uint32_t handle;                /* System handle. */
1195         target_id_t target;             /* SCSI ID */
1196         uint16_t lun;                   /* SCSI LUN */
1197         uint16_t control_flags;         /* Control flags. */
1198         uint16_t reserved_1;
1199         uint16_t timeout;               /* Command timeout. */
1200         uint16_t dseg_count;            /* Data segment count. */
1201         uint8_t scsi_cdb[MAX_CMDSZ];    /* SCSI command words. */
1202         uint32_t byte_count;            /* Total byte count. */
1203         uint32_t dseg_0_address[2];     /* Data segment 0 address. */
1204         uint32_t dseg_0_length;         /* Data segment 0 length. */
1205         uint32_t dseg_1_address[2];     /* Data segment 1 address. */
1206         uint32_t dseg_1_length;         /* Data segment 1 length. */
1207 } cmd_a64_entry_t, request_t;
1208
1209 /*
1210  * ISP queue - continuation entry structure definition.
1211  */
1212 #define CONTINUE_TYPE           0x02    /* Continuation entry. */
1213 typedef struct {
1214         uint8_t entry_type;             /* Entry type. */
1215         uint8_t entry_count;            /* Entry count. */
1216         uint8_t sys_define;             /* System defined. */
1217         uint8_t entry_status;           /* Entry Status. */
1218         uint32_t reserved;
1219         uint32_t dseg_0_address;        /* Data segment 0 address. */
1220         uint32_t dseg_0_length;         /* Data segment 0 length. */
1221         uint32_t dseg_1_address;        /* Data segment 1 address. */
1222         uint32_t dseg_1_length;         /* Data segment 1 length. */
1223         uint32_t dseg_2_address;        /* Data segment 2 address. */
1224         uint32_t dseg_2_length;         /* Data segment 2 length. */
1225         uint32_t dseg_3_address;        /* Data segment 3 address. */
1226         uint32_t dseg_3_length;         /* Data segment 3 length. */
1227         uint32_t dseg_4_address;        /* Data segment 4 address. */
1228         uint32_t dseg_4_length;         /* Data segment 4 length. */
1229         uint32_t dseg_5_address;        /* Data segment 5 address. */
1230         uint32_t dseg_5_length;         /* Data segment 5 length. */
1231         uint32_t dseg_6_address;        /* Data segment 6 address. */
1232         uint32_t dseg_6_length;         /* Data segment 6 length. */
1233 } cont_entry_t;
1234
1235 /*
1236  * ISP queue - 64-Bit addressing, continuation entry structure definition.
1237  */
1238 #define CONTINUE_A64_TYPE       0x0A    /* Continuation A64 entry. */
1239 typedef struct {
1240         uint8_t entry_type;             /* Entry type. */
1241         uint8_t entry_count;            /* Entry count. */
1242         uint8_t sys_define;             /* System defined. */
1243         uint8_t entry_status;           /* Entry Status. */
1244         uint32_t dseg_0_address[2];     /* Data segment 0 address. */
1245         uint32_t dseg_0_length;         /* Data segment 0 length. */
1246         uint32_t dseg_1_address[2];     /* Data segment 1 address. */
1247         uint32_t dseg_1_length;         /* Data segment 1 length. */
1248         uint32_t dseg_2_address [2];    /* Data segment 2 address. */
1249         uint32_t dseg_2_length;         /* Data segment 2 length. */
1250         uint32_t dseg_3_address[2];     /* Data segment 3 address. */
1251         uint32_t dseg_3_length;         /* Data segment 3 length. */
1252         uint32_t dseg_4_address[2];     /* Data segment 4 address. */
1253         uint32_t dseg_4_length;         /* Data segment 4 length. */
1254 } cont_a64_entry_t;
1255
1256 /*
1257  * ISP queue - status entry structure definition.
1258  */
1259 #define STATUS_TYPE     0x03            /* Status entry. */
1260 typedef struct {
1261         uint8_t entry_type;             /* Entry type. */
1262         uint8_t entry_count;            /* Entry count. */
1263         uint8_t sys_define;             /* System defined. */
1264         uint8_t entry_status;           /* Entry Status. */
1265         uint32_t handle;                /* System handle. */
1266         uint16_t scsi_status;           /* SCSI status. */
1267         uint16_t comp_status;           /* Completion status. */
1268         uint16_t state_flags;           /* State flags. */
1269         uint16_t status_flags;          /* Status flags. */
1270         uint16_t rsp_info_len;          /* Response Info Length. */
1271         uint16_t req_sense_length;      /* Request sense data length. */
1272         uint32_t residual_length;       /* Residual transfer length. */
1273         uint8_t rsp_info[8];            /* FCP response information. */
1274         uint8_t req_sense_data[32];     /* Request sense data. */
1275 } sts_entry_t;
1276
1277 /*
1278  * Status entry entry status
1279  */
1280 #define RF_RQ_DMA_ERROR BIT_6           /* Request Queue DMA error. */
1281 #define RF_INV_E_ORDER  BIT_5           /* Invalid entry order. */
1282 #define RF_INV_E_COUNT  BIT_4           /* Invalid entry count. */
1283 #define RF_INV_E_PARAM  BIT_3           /* Invalid entry parameter. */
1284 #define RF_INV_E_TYPE   BIT_2           /* Invalid entry type. */
1285 #define RF_BUSY         BIT_1           /* Busy */
1286 #define RF_MASK         (RF_RQ_DMA_ERROR | RF_INV_E_ORDER | RF_INV_E_COUNT | \
1287                          RF_INV_E_PARAM | RF_INV_E_TYPE | RF_BUSY)
1288 #define RF_MASK_24XX    (RF_INV_E_ORDER | RF_INV_E_COUNT | RF_INV_E_PARAM | \
1289                          RF_INV_E_TYPE)
1290
1291 /*
1292  * Status entry SCSI status bit definitions.
1293  */
1294 #define SS_MASK                         0xfff   /* Reserved bits BIT_12-BIT_15*/
1295 #define SS_RESIDUAL_UNDER               BIT_11
1296 #define SS_RESIDUAL_OVER                BIT_10
1297 #define SS_SENSE_LEN_VALID              BIT_9
1298 #define SS_RESPONSE_INFO_LEN_VALID      BIT_8
1299
1300 #define SS_RESERVE_CONFLICT             (BIT_4 | BIT_3)
1301 #define SS_BUSY_CONDITION               BIT_3
1302 #define SS_CONDITION_MET                BIT_2
1303 #define SS_CHECK_CONDITION              BIT_1
1304
1305 /*
1306  * Status entry completion status
1307  */
1308 #define CS_COMPLETE             0x0     /* No errors */
1309 #define CS_INCOMPLETE           0x1     /* Incomplete transfer of cmd. */
1310 #define CS_DMA                  0x2     /* A DMA direction error. */
1311 #define CS_TRANSPORT            0x3     /* Transport error. */
1312 #define CS_RESET                0x4     /* SCSI bus reset occurred */
1313 #define CS_ABORTED              0x5     /* System aborted command. */
1314 #define CS_TIMEOUT              0x6     /* Timeout error. */
1315 #define CS_DATA_OVERRUN         0x7     /* Data overrun. */
1316
1317 #define CS_DATA_UNDERRUN        0x15    /* Data Underrun. */
1318 #define CS_QUEUE_FULL           0x1C    /* Queue Full. */
1319 #define CS_PORT_UNAVAILABLE     0x28    /* Port unavailable */
1320                                         /* (selection timeout) */
1321 #define CS_PORT_LOGGED_OUT      0x29    /* Port Logged Out */
1322 #define CS_PORT_CONFIG_CHG      0x2A    /* Port Configuration Changed */
1323 #define CS_PORT_BUSY            0x2B    /* Port Busy */
1324 #define CS_COMPLETE_CHKCOND     0x30    /* Error? */
1325 #define CS_BAD_PAYLOAD          0x80    /* Driver defined */
1326 #define CS_UNKNOWN              0x81    /* Driver defined */
1327 #define CS_RETRY                0x82    /* Driver defined */
1328 #define CS_LOOP_DOWN_ABORT      0x83    /* Driver defined */
1329
1330 /*
1331  * Status entry status flags
1332  */
1333 #define SF_ABTS_TERMINATED      BIT_10
1334 #define SF_LOGOUT_SENT          BIT_13
1335
1336 /*
1337  * ISP queue - status continuation entry structure definition.
1338  */
1339 #define STATUS_CONT_TYPE        0x10    /* Status continuation entry. */
1340 typedef struct {
1341         uint8_t entry_type;             /* Entry type. */
1342         uint8_t entry_count;            /* Entry count. */
1343         uint8_t sys_define;             /* System defined. */
1344         uint8_t entry_status;           /* Entry Status. */
1345         uint8_t data[60];               /* data */
1346 } sts_cont_entry_t;
1347
1348 /*
1349  * ISP queue -  RIO Type 1 status entry (32 bit I/O entry handles)
1350  *              structure definition.
1351  */
1352 #define STATUS_TYPE_21 0x21             /* Status entry. */
1353 typedef struct {
1354         uint8_t entry_type;             /* Entry type. */
1355         uint8_t entry_count;            /* Entry count. */
1356         uint8_t handle_count;           /* Handle count. */
1357         uint8_t entry_status;           /* Entry Status. */
1358         uint32_t handle[15];            /* System handles. */
1359 } sts21_entry_t;
1360
1361 /*
1362  * ISP queue -  RIO Type 2 status entry (16 bit I/O entry handles)
1363  *              structure definition.
1364  */
1365 #define STATUS_TYPE_22  0x22            /* Status entry. */
1366 typedef struct {
1367         uint8_t entry_type;             /* Entry type. */
1368         uint8_t entry_count;            /* Entry count. */
1369         uint8_t handle_count;           /* Handle count. */
1370         uint8_t entry_status;           /* Entry Status. */
1371         uint16_t handle[30];            /* System handles. */
1372 } sts22_entry_t;
1373
1374 /*
1375  * ISP queue - marker entry structure definition.
1376  */
1377 #define MARKER_TYPE     0x04            /* Marker entry. */
1378 typedef struct {
1379         uint8_t entry_type;             /* Entry type. */
1380         uint8_t entry_count;            /* Entry count. */
1381         uint8_t handle_count;           /* Handle count. */
1382         uint8_t entry_status;           /* Entry Status. */
1383         uint32_t sys_define_2;          /* System defined. */
1384         target_id_t target;             /* SCSI ID */
1385         uint8_t modifier;               /* Modifier (7-0). */
1386 #define MK_SYNC_ID_LUN  0               /* Synchronize ID/LUN */
1387 #define MK_SYNC_ID      1               /* Synchronize ID */
1388 #define MK_SYNC_ALL     2               /* Synchronize all ID/LUN */
1389 #define MK_SYNC_LIP     3               /* Synchronize all ID/LUN, */
1390                                         /* clear port changed, */
1391                                         /* use sequence number. */
1392         uint8_t reserved_1;
1393         uint16_t sequence_number;       /* Sequence number of event */
1394         uint16_t lun;                   /* SCSI LUN */
1395         uint8_t reserved_2[48];
1396 } mrk_entry_t;
1397
1398 /*
1399  * ISP queue - Management Server entry structure definition.
1400  */
1401 #define MS_IOCB_TYPE            0x29    /* Management Server IOCB entry */
1402 typedef struct {
1403         uint8_t entry_type;             /* Entry type. */
1404         uint8_t entry_count;            /* Entry count. */
1405         uint8_t handle_count;           /* Handle count. */
1406         uint8_t entry_status;           /* Entry Status. */
1407         uint32_t handle1;               /* System handle. */
1408         target_id_t loop_id;
1409         uint16_t status;
1410         uint16_t control_flags;         /* Control flags. */
1411         uint16_t reserved2;
1412         uint16_t timeout;
1413         uint16_t cmd_dsd_count;
1414         uint16_t total_dsd_count;
1415         uint8_t type;
1416         uint8_t r_ctl;
1417         uint16_t rx_id;
1418         uint16_t reserved3;
1419         uint32_t handle2;
1420         uint32_t rsp_bytecount;
1421         uint32_t req_bytecount;
1422         uint32_t dseg_req_address[2];   /* Data segment 0 address. */
1423         uint32_t dseg_req_length;       /* Data segment 0 length. */
1424         uint32_t dseg_rsp_address[2];   /* Data segment 1 address. */
1425         uint32_t dseg_rsp_length;       /* Data segment 1 length. */
1426 } ms_iocb_entry_t;
1427
1428
1429 /*
1430  * ISP queue - Mailbox Command entry structure definition.
1431  */
1432 #define MBX_IOCB_TYPE   0x39
1433 struct mbx_entry {
1434         uint8_t entry_type;
1435         uint8_t entry_count;
1436         uint8_t sys_define1;
1437         /* Use sys_define1 for source type */
1438 #define SOURCE_SCSI     0x00
1439 #define SOURCE_IP       0x01
1440 #define SOURCE_VI       0x02
1441 #define SOURCE_SCTP     0x03
1442 #define SOURCE_MP       0x04
1443 #define SOURCE_MPIOCTL  0x05
1444 #define SOURCE_ASYNC_IOCB 0x07
1445
1446         uint8_t entry_status;
1447
1448         uint32_t handle;
1449         target_id_t loop_id;
1450
1451         uint16_t status;
1452         uint16_t state_flags;
1453         uint16_t status_flags;
1454
1455         uint32_t sys_define2[2];
1456
1457         uint16_t mb0;
1458         uint16_t mb1;
1459         uint16_t mb2;
1460         uint16_t mb3;
1461         uint16_t mb6;
1462         uint16_t mb7;
1463         uint16_t mb9;
1464         uint16_t mb10;
1465         uint32_t reserved_2[2];
1466         uint8_t node_name[WWN_SIZE];
1467         uint8_t port_name[WWN_SIZE];
1468 };
1469
1470 /*
1471  * ISP request and response queue entry sizes
1472  */
1473 #define RESPONSE_ENTRY_SIZE     (sizeof(response_t))
1474 #define REQUEST_ENTRY_SIZE      (sizeof(request_t))
1475
1476
1477 /*
1478  * 24 bit port ID type definition.
1479  */
1480 typedef union {
1481         uint32_t b24 : 24;
1482
1483         struct {
1484 #ifdef __BIG_ENDIAN
1485                 uint8_t domain;
1486                 uint8_t area;
1487                 uint8_t al_pa;
1488 #elif __LITTLE_ENDIAN
1489                 uint8_t al_pa;
1490                 uint8_t area;
1491                 uint8_t domain;
1492 #else
1493 #error "__BIG_ENDIAN or __LITTLE_ENDIAN must be defined!"
1494 #endif
1495                 uint8_t rsvd_1;
1496         } b;
1497 } port_id_t;
1498 #define INVALID_PORT_ID 0xFFFFFF
1499
1500 /*
1501  * Switch info gathering structure.
1502  */
1503 typedef struct {
1504         port_id_t d_id;
1505         uint8_t node_name[WWN_SIZE];
1506         uint8_t port_name[WWN_SIZE];
1507         uint8_t fabric_port_name[WWN_SIZE];
1508         uint16_t fp_speed;
1509 } sw_info_t;
1510
1511 /*
1512  * Fibre channel port type.
1513  */
1514  typedef enum {
1515         FCT_UNKNOWN,
1516         FCT_RSCN,
1517         FCT_SWITCH,
1518         FCT_BROADCAST,
1519         FCT_INITIATOR,
1520         FCT_TARGET
1521 } fc_port_type_t;
1522
1523 /*
1524  * Fibre channel port structure.
1525  */
1526 typedef struct fc_port {
1527         struct list_head list;
1528         struct scsi_qla_host *ha;
1529
1530         uint8_t node_name[WWN_SIZE];
1531         uint8_t port_name[WWN_SIZE];
1532         port_id_t d_id;
1533         uint16_t loop_id;
1534         uint16_t old_loop_id;
1535
1536         uint8_t fabric_port_name[WWN_SIZE];
1537         uint16_t fp_speed;
1538
1539         fc_port_type_t port_type;
1540
1541         atomic_t state;
1542         uint32_t flags;
1543
1544         unsigned int os_target_id;
1545
1546         int port_login_retry_count;
1547         int login_retry;
1548         atomic_t port_down_timer;
1549
1550         spinlock_t rport_lock;
1551         struct fc_rport *rport, *drport;
1552         u32 supported_classes;
1553
1554         unsigned long last_queue_full;
1555         unsigned long last_ramp_up;
1556
1557         struct list_head vp_fcport;
1558         uint16_t vp_idx;
1559 } fc_port_t;
1560
1561 /*
1562  * Fibre channel port/lun states.
1563  */
1564 #define FCS_UNCONFIGURED        1
1565 #define FCS_DEVICE_DEAD         2
1566 #define FCS_DEVICE_LOST         3
1567 #define FCS_ONLINE              4
1568 #define FCS_NOT_SUPPORTED       5
1569 #define FCS_FAILOVER            6
1570 #define FCS_FAILOVER_FAILED     7
1571
1572 /*
1573  * FC port flags.
1574  */
1575 #define FCF_FABRIC_DEVICE       BIT_0
1576 #define FCF_LOGIN_NEEDED        BIT_1
1577 #define FCF_FO_MASKED           BIT_2
1578 #define FCF_FAILOVER_NEEDED     BIT_3
1579 #define FCF_RESET_NEEDED        BIT_4
1580 #define FCF_PERSISTENT_BOUND    BIT_5
1581 #define FCF_TAPE_PRESENT        BIT_6
1582 #define FCF_FARP_DONE           BIT_7
1583 #define FCF_FARP_FAILED         BIT_8
1584 #define FCF_FARP_REPLY_NEEDED   BIT_9
1585 #define FCF_AUTH_REQ            BIT_10
1586 #define FCF_SEND_AUTH_REQ       BIT_11
1587 #define FCF_RECEIVE_AUTH_REQ    BIT_12
1588 #define FCF_AUTH_SUCCESS        BIT_13
1589 #define FCF_RLC_SUPPORT         BIT_14
1590 #define FCF_CONFIG              BIT_15  /* Needed? */
1591 #define FCF_RESCAN_NEEDED       BIT_16
1592 #define FCF_XP_DEVICE           BIT_17
1593 #define FCF_MSA_DEVICE          BIT_18
1594 #define FCF_EVA_DEVICE          BIT_19
1595 #define FCF_MSA_PORT_ACTIVE     BIT_20
1596 #define FCF_FAILBACK_DISABLE    BIT_21
1597 #define FCF_FAILOVER_DISABLE    BIT_22
1598 #define FCF_DSXXX_DEVICE        BIT_23
1599 #define FCF_AA_EVA_DEVICE       BIT_24
1600 #define FCF_AA_MSA_DEVICE       BIT_25
1601
1602 /* No loop ID flag. */
1603 #define FC_NO_LOOP_ID           0x1000
1604
1605 /*
1606  * FC-CT interface
1607  *
1608  * NOTE: All structures are big-endian in form.
1609  */
1610
1611 #define CT_REJECT_RESPONSE      0x8001
1612 #define CT_ACCEPT_RESPONSE      0x8002
1613 #define CT_REASON_INVALID_COMMAND_CODE  0x01
1614 #define CT_REASON_CANNOT_PERFORM        0x09
1615 #define CT_EXPL_ALREADY_REGISTERED      0x10
1616
1617 #define NS_N_PORT_TYPE  0x01
1618 #define NS_NL_PORT_TYPE 0x02
1619 #define NS_NX_PORT_TYPE 0x7F
1620
1621 #define GA_NXT_CMD      0x100
1622 #define GA_NXT_REQ_SIZE (16 + 4)
1623 #define GA_NXT_RSP_SIZE (16 + 620)
1624
1625 #define GID_PT_CMD      0x1A1
1626 #define GID_PT_REQ_SIZE (16 + 4)
1627 #define GID_PT_RSP_SIZE (16 + (MAX_FIBRE_DEVICES * 4))
1628
1629 #define GPN_ID_CMD      0x112
1630 #define GPN_ID_REQ_SIZE (16 + 4)
1631 #define GPN_ID_RSP_SIZE (16 + 8)
1632
1633 #define GNN_ID_CMD      0x113
1634 #define GNN_ID_REQ_SIZE (16 + 4)
1635 #define GNN_ID_RSP_SIZE (16 + 8)
1636
1637 #define GFT_ID_CMD      0x117
1638 #define GFT_ID_REQ_SIZE (16 + 4)
1639 #define GFT_ID_RSP_SIZE (16 + 32)
1640
1641 #define RFT_ID_CMD      0x217
1642 #define RFT_ID_REQ_SIZE (16 + 4 + 32)
1643 #define RFT_ID_RSP_SIZE 16
1644
1645 #define RFF_ID_CMD      0x21F
1646 #define RFF_ID_REQ_SIZE (16 + 4 + 2 + 1 + 1)
1647 #define RFF_ID_RSP_SIZE 16
1648
1649 #define RNN_ID_CMD      0x213
1650 #define RNN_ID_REQ_SIZE (16 + 4 + 8)
1651 #define RNN_ID_RSP_SIZE 16
1652
1653 #define RSNN_NN_CMD      0x239
1654 #define RSNN_NN_REQ_SIZE (16 + 8 + 1 + 255)
1655 #define RSNN_NN_RSP_SIZE 16
1656
1657 #define GFPN_ID_CMD     0x11C
1658 #define GFPN_ID_REQ_SIZE (16 + 4)
1659 #define GFPN_ID_RSP_SIZE (16 + 8)
1660
1661 #define GPSC_CMD        0x127
1662 #define GPSC_REQ_SIZE   (16 + 8)
1663 #define GPSC_RSP_SIZE   (16 + 2 + 2)
1664
1665
1666 /*
1667  * HBA attribute types.
1668  */
1669 #define FDMI_HBA_ATTR_COUNT                     9
1670 #define FDMI_HBA_NODE_NAME                      1
1671 #define FDMI_HBA_MANUFACTURER                   2
1672 #define FDMI_HBA_SERIAL_NUMBER                  3
1673 #define FDMI_HBA_MODEL                          4
1674 #define FDMI_HBA_MODEL_DESCRIPTION              5
1675 #define FDMI_HBA_HARDWARE_VERSION               6
1676 #define FDMI_HBA_DRIVER_VERSION                 7
1677 #define FDMI_HBA_OPTION_ROM_VERSION             8
1678 #define FDMI_HBA_FIRMWARE_VERSION               9
1679 #define FDMI_HBA_OS_NAME_AND_VERSION            0xa
1680 #define FDMI_HBA_MAXIMUM_CT_PAYLOAD_LENGTH      0xb
1681
1682 struct ct_fdmi_hba_attr {
1683         uint16_t type;
1684         uint16_t len;
1685         union {
1686                 uint8_t node_name[WWN_SIZE];
1687                 uint8_t manufacturer[32];
1688                 uint8_t serial_num[8];
1689                 uint8_t model[16];
1690                 uint8_t model_desc[80];
1691                 uint8_t hw_version[16];
1692                 uint8_t driver_version[32];
1693                 uint8_t orom_version[16];
1694                 uint8_t fw_version[16];
1695                 uint8_t os_version[128];
1696                 uint8_t max_ct_len[4];
1697         } a;
1698 };
1699
1700 struct ct_fdmi_hba_attributes {
1701         uint32_t count;
1702         struct ct_fdmi_hba_attr entry[FDMI_HBA_ATTR_COUNT];
1703 };
1704
1705 /*
1706  * Port attribute types.
1707  */
1708 #define FDMI_PORT_ATTR_COUNT            5
1709 #define FDMI_PORT_FC4_TYPES             1
1710 #define FDMI_PORT_SUPPORT_SPEED         2
1711 #define FDMI_PORT_CURRENT_SPEED         3
1712 #define FDMI_PORT_MAX_FRAME_SIZE        4
1713 #define FDMI_PORT_OS_DEVICE_NAME        5
1714 #define FDMI_PORT_HOST_NAME             6
1715
1716 #define FDMI_PORT_SPEED_1GB             0x1
1717 #define FDMI_PORT_SPEED_2GB             0x2
1718 #define FDMI_PORT_SPEED_10GB            0x4
1719 #define FDMI_PORT_SPEED_4GB             0x8
1720 #define FDMI_PORT_SPEED_8GB             0x10
1721 #define FDMI_PORT_SPEED_16GB            0x20
1722 #define FDMI_PORT_SPEED_UNKNOWN         0x8000
1723
1724 struct ct_fdmi_port_attr {
1725         uint16_t type;
1726         uint16_t len;
1727         union {
1728                 uint8_t fc4_types[32];
1729                 uint32_t sup_speed;
1730                 uint32_t cur_speed;
1731                 uint32_t max_frame_size;
1732                 uint8_t os_dev_name[32];
1733                 uint8_t host_name[32];
1734         } a;
1735 };
1736
1737 /*
1738  * Port Attribute Block.
1739  */
1740 struct ct_fdmi_port_attributes {
1741         uint32_t count;
1742         struct ct_fdmi_port_attr entry[FDMI_PORT_ATTR_COUNT];
1743 };
1744
1745 /* FDMI definitions. */
1746 #define GRHL_CMD        0x100
1747 #define GHAT_CMD        0x101
1748 #define GRPL_CMD        0x102
1749 #define GPAT_CMD        0x110
1750
1751 #define RHBA_CMD        0x200
1752 #define RHBA_RSP_SIZE   16
1753
1754 #define RHAT_CMD        0x201
1755 #define RPRT_CMD        0x210
1756
1757 #define RPA_CMD         0x211
1758 #define RPA_RSP_SIZE    16
1759
1760 #define DHBA_CMD        0x300
1761 #define DHBA_REQ_SIZE   (16 + 8)
1762 #define DHBA_RSP_SIZE   16
1763
1764 #define DHAT_CMD        0x301
1765 #define DPRT_CMD        0x310
1766 #define DPA_CMD         0x311
1767
1768 /* CT command header -- request/response common fields */
1769 struct ct_cmd_hdr {
1770         uint8_t revision;
1771         uint8_t in_id[3];
1772         uint8_t gs_type;
1773         uint8_t gs_subtype;
1774         uint8_t options;
1775         uint8_t reserved;
1776 };
1777
1778 /* CT command request */
1779 struct ct_sns_req {
1780         struct ct_cmd_hdr header;
1781         uint16_t command;
1782         uint16_t max_rsp_size;
1783         uint8_t fragment_id;
1784         uint8_t reserved[3];
1785
1786         union {
1787                 /* GA_NXT, GPN_ID, GNN_ID, GFT_ID, GFPN_ID */
1788                 struct {
1789                         uint8_t reserved;
1790                         uint8_t port_id[3];
1791                 } port_id;
1792
1793                 struct {
1794                         uint8_t port_type;
1795                         uint8_t domain;
1796                         uint8_t area;
1797                         uint8_t reserved;
1798                 } gid_pt;
1799
1800                 struct {
1801                         uint8_t reserved;
1802                         uint8_t port_id[3];
1803                         uint8_t fc4_types[32];
1804                 } rft_id;
1805
1806                 struct {
1807                         uint8_t reserved;
1808                         uint8_t port_id[3];
1809                         uint16_t reserved2;
1810                         uint8_t fc4_feature;
1811                         uint8_t fc4_type;
1812                 } rff_id;
1813
1814                 struct {
1815                         uint8_t reserved;
1816                         uint8_t port_id[3];
1817                         uint8_t node_name[8];
1818                 } rnn_id;
1819
1820                 struct {
1821                         uint8_t node_name[8];
1822                         uint8_t name_len;
1823                         uint8_t sym_node_name[255];
1824                 } rsnn_nn;
1825
1826                 struct {
1827                         uint8_t hba_indentifier[8];
1828                 } ghat;
1829
1830                 struct {
1831                         uint8_t hba_identifier[8];
1832                         uint32_t entry_count;
1833                         uint8_t port_name[8];
1834                         struct ct_fdmi_hba_attributes attrs;
1835                 } rhba;
1836
1837                 struct {
1838                         uint8_t hba_identifier[8];
1839                         struct ct_fdmi_hba_attributes attrs;
1840                 } rhat;
1841
1842                 struct {
1843                         uint8_t port_name[8];
1844                         struct ct_fdmi_port_attributes attrs;
1845                 } rpa;
1846
1847                 struct {
1848                         uint8_t port_name[8];
1849                 } dhba;
1850
1851                 struct {
1852                         uint8_t port_name[8];
1853                 } dhat;
1854
1855                 struct {
1856                         uint8_t port_name[8];
1857                 } dprt;
1858
1859                 struct {
1860                         uint8_t port_name[8];
1861                 } dpa;
1862
1863                 struct {
1864                         uint8_t port_name[8];
1865                 } gpsc;
1866         } req;
1867 };
1868
1869 /* CT command response header */
1870 struct ct_rsp_hdr {
1871         struct ct_cmd_hdr header;
1872         uint16_t response;
1873         uint16_t residual;
1874         uint8_t fragment_id;
1875         uint8_t reason_code;
1876         uint8_t explanation_code;
1877         uint8_t vendor_unique;
1878 };
1879
1880 struct ct_sns_gid_pt_data {
1881         uint8_t control_byte;
1882         uint8_t port_id[3];
1883 };
1884
1885 struct ct_sns_rsp {
1886         struct ct_rsp_hdr header;
1887
1888         union {
1889                 struct {
1890                         uint8_t port_type;
1891                         uint8_t port_id[3];
1892                         uint8_t port_name[8];
1893                         uint8_t sym_port_name_len;
1894                         uint8_t sym_port_name[255];
1895                         uint8_t node_name[8];
1896                         uint8_t sym_node_name_len;
1897                         uint8_t sym_node_name[255];
1898                         uint8_t init_proc_assoc[8];
1899                         uint8_t node_ip_addr[16];
1900                         uint8_t class_of_service[4];
1901                         uint8_t fc4_types[32];
1902                         uint8_t ip_address[16];
1903                         uint8_t fabric_port_name[8];
1904                         uint8_t reserved;
1905                         uint8_t hard_address[3];
1906                 } ga_nxt;
1907
1908                 struct {
1909                         struct ct_sns_gid_pt_data entries[MAX_FIBRE_DEVICES];
1910                 } gid_pt;
1911
1912                 struct {
1913                         uint8_t port_name[8];
1914                 } gpn_id;
1915
1916                 struct {
1917                         uint8_t node_name[8];
1918                 } gnn_id;
1919
1920                 struct {
1921                         uint8_t fc4_types[32];
1922                 } gft_id;
1923
1924                 struct {
1925                         uint32_t entry_count;
1926                         uint8_t port_name[8];
1927                         struct ct_fdmi_hba_attributes attrs;
1928                 } ghat;
1929
1930                 struct {
1931                         uint8_t port_name[8];
1932                 } gfpn_id;
1933
1934                 struct {
1935                         uint16_t speeds;
1936                         uint16_t speed;
1937                 } gpsc;
1938         } rsp;
1939 };
1940
1941 struct ct_sns_pkt {
1942         union {
1943                 struct ct_sns_req req;
1944                 struct ct_sns_rsp rsp;
1945         } p;
1946 };
1947
1948 /*
1949  * SNS command structures -- for 2200 compatability.
1950  */
1951 #define RFT_ID_SNS_SCMD_LEN     22
1952 #define RFT_ID_SNS_CMD_SIZE     60
1953 #define RFT_ID_SNS_DATA_SIZE    16
1954
1955 #define RNN_ID_SNS_SCMD_LEN     10
1956 #define RNN_ID_SNS_CMD_SIZE     36
1957 #define RNN_ID_SNS_DATA_SIZE    16
1958
1959 #define GA_NXT_SNS_SCMD_LEN     6
1960 #define GA_NXT_SNS_CMD_SIZE     28
1961 #define GA_NXT_SNS_DATA_SIZE    (620 + 16)
1962
1963 #define GID_PT_SNS_SCMD_LEN     6
1964 #define GID_PT_SNS_CMD_SIZE     28
1965 #define GID_PT_SNS_DATA_SIZE    (MAX_FIBRE_DEVICES * 4 + 16)
1966
1967 #define GPN_ID_SNS_SCMD_LEN     6
1968 #define GPN_ID_SNS_CMD_SIZE     28
1969 #define GPN_ID_SNS_DATA_SIZE    (8 + 16)
1970
1971 #define GNN_ID_SNS_SCMD_LEN     6
1972 #define GNN_ID_SNS_CMD_SIZE     28
1973 #define GNN_ID_SNS_DATA_SIZE    (8 + 16)
1974
1975 struct sns_cmd_pkt {
1976         union {
1977                 struct {
1978                         uint16_t buffer_length;
1979                         uint16_t reserved_1;
1980                         uint32_t buffer_address[2];
1981                         uint16_t subcommand_length;
1982                         uint16_t reserved_2;
1983                         uint16_t subcommand;
1984                         uint16_t size;
1985                         uint32_t reserved_3;
1986                         uint8_t param[36];
1987                 } cmd;
1988
1989                 uint8_t rft_data[RFT_ID_SNS_DATA_SIZE];
1990                 uint8_t rnn_data[RNN_ID_SNS_DATA_SIZE];
1991                 uint8_t gan_data[GA_NXT_SNS_DATA_SIZE];
1992                 uint8_t gid_data[GID_PT_SNS_DATA_SIZE];
1993                 uint8_t gpn_data[GPN_ID_SNS_DATA_SIZE];
1994                 uint8_t gnn_data[GNN_ID_SNS_DATA_SIZE];
1995         } p;
1996 };
1997
1998 struct fw_blob {
1999         char *name;
2000         uint32_t segs[4];
2001         const struct firmware *fw;
2002 };
2003
2004 /* Return data from MBC_GET_ID_LIST call. */
2005 struct gid_list_info {
2006         uint8_t al_pa;
2007         uint8_t area;
2008         uint8_t domain;
2009         uint8_t loop_id_2100;   /* ISP2100/ISP2200 -- 4 bytes. */
2010         uint16_t loop_id;       /* ISP23XX         -- 6 bytes. */
2011         uint16_t reserved_1;    /* ISP24XX         -- 8 bytes. */
2012 };
2013 #define GID_LIST_SIZE (sizeof(struct gid_list_info) * MAX_FIBRE_DEVICES)
2014
2015 /* NPIV */
2016 typedef struct vport_info {
2017         uint8_t         port_name[WWN_SIZE];
2018         uint8_t         node_name[WWN_SIZE];
2019         int             vp_id;
2020         uint16_t        loop_id;
2021         unsigned long   host_no;
2022         uint8_t         port_id[3];
2023         int             loop_state;
2024 } vport_info_t;
2025
2026 typedef struct vport_params {
2027         uint8_t         port_name[WWN_SIZE];
2028         uint8_t         node_name[WWN_SIZE];
2029         uint32_t        options;
2030 #define VP_OPTS_RETRY_ENABLE    BIT_0
2031 #define VP_OPTS_VP_DISABLE      BIT_1
2032 } vport_params_t;
2033
2034 /* NPIV - return codes of VP create and modify */
2035 #define VP_RET_CODE_OK                  0
2036 #define VP_RET_CODE_FATAL               1
2037 #define VP_RET_CODE_WRONG_ID            2
2038 #define VP_RET_CODE_WWPN                3
2039 #define VP_RET_CODE_RESOURCES           4
2040 #define VP_RET_CODE_NO_MEM              5
2041 #define VP_RET_CODE_NOT_FOUND           6
2042
2043 #define to_qla_parent(x) (((x)->parent) ? (x)->parent : (x))
2044
2045 /*
2046  * ISP operations
2047  */
2048 struct isp_operations {
2049
2050         int (*pci_config) (struct scsi_qla_host *);
2051         void (*reset_chip) (struct scsi_qla_host *);
2052         int (*chip_diag) (struct scsi_qla_host *);
2053         void (*config_rings) (struct scsi_qla_host *);
2054         void (*reset_adapter) (struct scsi_qla_host *);
2055         int (*nvram_config) (struct scsi_qla_host *);
2056         void (*update_fw_options) (struct scsi_qla_host *);
2057         int (*load_risc) (struct scsi_qla_host *, uint32_t *);
2058
2059         char * (*pci_info_str) (struct scsi_qla_host *, char *);
2060         char * (*fw_version_str) (struct scsi_qla_host *, char *);
2061
2062         irq_handler_t intr_handler;
2063         void (*enable_intrs) (struct scsi_qla_host *);
2064         void (*disable_intrs) (struct scsi_qla_host *);
2065
2066         int (*abort_command) (struct scsi_qla_host *, srb_t *);
2067         int (*abort_target) (struct fc_port *);
2068         int (*fabric_login) (struct scsi_qla_host *, uint16_t, uint8_t,
2069                 uint8_t, uint8_t, uint16_t *, uint8_t);
2070         int (*fabric_logout) (struct scsi_qla_host *, uint16_t, uint8_t,
2071             uint8_t, uint8_t);
2072
2073         uint16_t (*calc_req_entries) (uint16_t);
2074         void (*build_iocbs) (srb_t *, cmd_entry_t *, uint16_t);
2075         void * (*prep_ms_iocb) (struct scsi_qla_host *, uint32_t, uint32_t);
2076         void * (*prep_ms_fdmi_iocb) (struct scsi_qla_host *, uint32_t,
2077             uint32_t);
2078
2079         uint8_t * (*read_nvram) (struct scsi_qla_host *, uint8_t *,
2080                 uint32_t, uint32_t);
2081         int (*write_nvram) (struct scsi_qla_host *, uint8_t *, uint32_t,
2082                 uint32_t);
2083
2084         void (*fw_dump) (struct scsi_qla_host *, int);
2085
2086         int (*beacon_on) (struct scsi_qla_host *);
2087         int (*beacon_off) (struct scsi_qla_host *);
2088         void (*beacon_blink) (struct scsi_qla_host *);
2089
2090         uint8_t * (*read_optrom) (struct scsi_qla_host *, uint8_t *,
2091                 uint32_t, uint32_t);
2092         int (*write_optrom) (struct scsi_qla_host *, uint8_t *, uint32_t,
2093                 uint32_t);
2094
2095         int (*get_flash_version) (struct scsi_qla_host *, void *);
2096 };
2097
2098 /* MSI-X Support *************************************************************/
2099
2100 #define QLA_MSIX_CHIP_REV_24XX  3
2101 #define QLA_MSIX_FW_MODE(m)     (((m) & (BIT_7|BIT_8|BIT_9)) >> 7)
2102 #define QLA_MSIX_FW_MODE_1(m)   (QLA_MSIX_FW_MODE(m) == 1)
2103
2104 #define QLA_MSIX_DEFAULT        0x00
2105 #define QLA_MSIX_RSP_Q          0x01
2106
2107 #define QLA_MSIX_ENTRIES        2
2108 #define QLA_MIDX_DEFAULT        0
2109 #define QLA_MIDX_RSP_Q          1
2110
2111 struct scsi_qla_host;
2112
2113 struct qla_msix_entry {
2114         int have_irq;
2115         uint16_t msix_vector;
2116         uint16_t msix_entry;
2117 };
2118
2119 #define WATCH_INTERVAL          1       /* number of seconds */
2120
2121 /* NPIV */
2122 #define MAX_MULTI_ID_LOOP                     126
2123 #define MAX_MULTI_ID_FABRIC                    64
2124 #define MAX_NUM_VPORT_LOOP                      (MAX_MULTI_ID_LOOP - 1)
2125 #define MAX_NUM_VPORT_FABRIC                    (MAX_MULTI_ID_FABRIC - 1)
2126 #define MAX_NUM_VHBA_LOOP                       (MAX_MULTI_ID_LOOP - 1)
2127 #define MAX_NUM_VHBA_FABRIC                     (MAX_MULTI_ID_FABRIC - 1)
2128
2129 /*
2130  * Linux Host Adapter structure
2131  */
2132 typedef struct scsi_qla_host {
2133         struct list_head list;
2134
2135         /* Commonly used flags and state information. */
2136         struct Scsi_Host *host;
2137         struct pci_dev  *pdev;
2138
2139         unsigned long   host_no;
2140         unsigned long   instance;
2141
2142         volatile struct {
2143                 uint32_t        init_done               :1;
2144                 uint32_t        online                  :1;
2145                 uint32_t        mbox_int                :1;
2146                 uint32_t        mbox_busy               :1;
2147                 uint32_t        rscn_queue_overflow     :1;
2148                 uint32_t        reset_active            :1;
2149
2150                 uint32_t        management_server_logged_in :1;
2151                 uint32_t        process_response_queue  :1;
2152
2153                 uint32_t        disable_risc_code_load  :1;
2154                 uint32_t        enable_64bit_addressing :1;
2155                 uint32_t        enable_lip_reset        :1;
2156                 uint32_t        enable_lip_full_login   :1;
2157                 uint32_t        enable_target_reset     :1;
2158                 uint32_t        enable_led_scheme       :1;
2159                 uint32_t        inta_enabled            :1;
2160                 uint32_t        msi_enabled             :1;
2161                 uint32_t        msix_enabled            :1;
2162                 uint32_t        disable_serdes          :1;
2163                 uint32_t        gpsc_supported          :1;
2164                 uint32_t        vsan_enabled            :1;
2165                 uint32_t        npiv_supported          :1;
2166         } flags;
2167
2168         atomic_t        loop_state;
2169 #define LOOP_TIMEOUT    1
2170 #define LOOP_DOWN       2
2171 #define LOOP_UP         3
2172 #define LOOP_UPDATE     4
2173 #define LOOP_READY      5
2174 #define LOOP_DEAD       6
2175
2176         unsigned long   dpc_flags;
2177 #define RESET_MARKER_NEEDED     0       /* Send marker to ISP. */
2178 #define RESET_ACTIVE            1
2179 #define ISP_ABORT_NEEDED        2       /* Initiate ISP abort. */
2180 #define ABORT_ISP_ACTIVE        3       /* ISP abort in progress. */
2181 #define LOOP_RESYNC_NEEDED      4       /* Device Resync needed. */
2182 #define LOOP_RESYNC_ACTIVE      5
2183 #define LOCAL_LOOP_UPDATE       6       /* Perform a local loop update. */
2184 #define RSCN_UPDATE             7       /* Perform an RSCN update. */
2185 #define MAILBOX_RETRY           8
2186 #define ISP_RESET_NEEDED        9       /* Initiate a ISP reset. */
2187 #define FAILOVER_EVENT_NEEDED   10
2188 #define FAILOVER_EVENT          11
2189 #define FAILOVER_NEEDED         12
2190 #define SCSI_RESTART_NEEDED     13      /* Processes SCSI retry queue. */
2191 #define PORT_RESTART_NEEDED     14      /* Processes Retry queue. */
2192 #define RESTART_QUEUES_NEEDED   15      /* Restarts the Lun queue. */
2193 #define ABORT_QUEUES_NEEDED     16
2194 #define RELOGIN_NEEDED          17
2195 #define LOGIN_RETRY_NEEDED      18      /* Initiate required fabric logins. */
2196 #define REGISTER_FC4_NEEDED     19      /* SNS FC4 registration required. */
2197 #define ISP_ABORT_RETRY         20      /* ISP aborted. */
2198 #define FCPORT_RESCAN_NEEDED    21      /* IO descriptor processing needed */
2199 #define IODESC_PROCESS_NEEDED   22      /* IO descriptor processing needed */
2200 #define IOCTL_ERROR_RECOVERY    23
2201 #define LOOP_RESET_NEEDED       24
2202 #define BEACON_BLINK_NEEDED     25
2203 #define REGISTER_FDMI_NEEDED    26
2204 #define FCPORT_UPDATE_NEEDED    27
2205 #define VP_DPC_NEEDED           28      /* wake up for VP dpc handling */
2206
2207         uint32_t        device_flags;
2208 #define DFLG_LOCAL_DEVICES              BIT_0
2209 #define DFLG_RETRY_LOCAL_DEVICES        BIT_1
2210 #define DFLG_FABRIC_DEVICES             BIT_2
2211 #define SWITCH_FOUND                    BIT_3
2212 #define DFLG_NO_CABLE                   BIT_4
2213
2214 #define PCI_DEVICE_ID_QLOGIC_ISP2532    0x2532
2215         uint32_t        device_type;
2216 #define DT_ISP2100                      BIT_0
2217 #define DT_ISP2200                      BIT_1
2218 #define DT_ISP2300                      BIT_2
2219 #define DT_ISP2312                      BIT_3
2220 #define DT_ISP2322                      BIT_4
2221 #define DT_ISP6312                      BIT_5
2222 #define DT_ISP6322                      BIT_6
2223 #define DT_ISP2422                      BIT_7
2224 #define DT_ISP2432                      BIT_8
2225 #define DT_ISP5422                      BIT_9
2226 #define DT_ISP5432                      BIT_10
2227 #define DT_ISP2532                      BIT_11
2228 #define DT_ISP_LAST                     (DT_ISP2532 << 1)
2229
2230 #define DT_IIDMA                        BIT_26
2231 #define DT_FWI2                         BIT_27
2232 #define DT_ZIO_SUPPORTED                BIT_28
2233 #define DT_OEM_001                      BIT_29
2234 #define DT_ISP2200A                     BIT_30
2235 #define DT_EXTENDED_IDS                 BIT_31
2236
2237 #define DT_MASK(ha)     ((ha)->device_type & (DT_ISP_LAST - 1))
2238 #define IS_QLA2100(ha)  (DT_MASK(ha) & DT_ISP2100)
2239 #define IS_QLA2200(ha)  (DT_MASK(ha) & DT_ISP2200)
2240 #define IS_QLA2300(ha)  (DT_MASK(ha) & DT_ISP2300)
2241 #define IS_QLA2312(ha)  (DT_MASK(ha) & DT_ISP2312)
2242 #define IS_QLA2322(ha)  (DT_MASK(ha) & DT_ISP2322)
2243 #define IS_QLA6312(ha)  (DT_MASK(ha) & DT_ISP6312)
2244 #define IS_QLA6322(ha)  (DT_MASK(ha) & DT_ISP6322)
2245 #define IS_QLA2422(ha)  (DT_MASK(ha) & DT_ISP2422)
2246 #define IS_QLA2432(ha)  (DT_MASK(ha) & DT_ISP2432)
2247 #define IS_QLA5422(ha)  (DT_MASK(ha) & DT_ISP5422)
2248 #define IS_QLA5432(ha)  (DT_MASK(ha) & DT_ISP5432)
2249 #define IS_QLA2532(ha)  (DT_MASK(ha) & DT_ISP2532)
2250
2251 #define IS_QLA23XX(ha)  (IS_QLA2300(ha) || IS_QLA2312(ha) || IS_QLA2322(ha) || \
2252                          IS_QLA6312(ha) || IS_QLA6322(ha))
2253 #define IS_QLA24XX(ha)  (IS_QLA2422(ha) || IS_QLA2432(ha))
2254 #define IS_QLA54XX(ha)  (IS_QLA5422(ha) || IS_QLA5432(ha))
2255 #define IS_QLA25XX(ha)  (IS_QLA2532(ha))
2256
2257 #define IS_IIDMA_CAPABLE(ha)    ((ha)->device_type & DT_IIDMA)
2258 #define IS_FWI2_CAPABLE(ha)     ((ha)->device_type & DT_FWI2)
2259 #define IS_ZIO_SUPPORTED(ha)    ((ha)->device_type & DT_ZIO_SUPPORTED)
2260 #define IS_OEM_001(ha)          ((ha)->device_type & DT_OEM_001)
2261 #define HAS_EXTENDED_IDS(ha)    ((ha)->device_type & DT_EXTENDED_IDS)
2262
2263         /* SRB cache. */
2264 #define SRB_MIN_REQ     128
2265         mempool_t       *srb_mempool;
2266
2267         /* This spinlock is used to protect "io transactions", you must
2268          * acquire it before doing any IO to the card, eg with RD_REG*() and
2269          * WRT_REG*() for the duration of your entire commandtransaction.
2270          *
2271          * This spinlock is of lower priority than the io request lock.
2272          */
2273
2274         spinlock_t              hardware_lock ____cacheline_aligned;
2275
2276         device_reg_t __iomem *iobase;           /* Base I/O address */
2277         unsigned long   pio_address;
2278         unsigned long   pio_length;
2279 #define MIN_IOBASE_LEN          0x100
2280
2281         /* ISP ring lock, rings, and indexes */
2282         dma_addr_t      request_dma;        /* Physical address. */
2283         request_t       *request_ring;      /* Base virtual address */
2284         request_t       *request_ring_ptr;  /* Current address. */
2285         uint16_t        req_ring_index;     /* Current index. */
2286         uint16_t        req_q_cnt;          /* Number of available entries. */
2287         uint16_t        request_q_length;
2288
2289         dma_addr_t      response_dma;       /* Physical address. */
2290         response_t      *response_ring;     /* Base virtual address */
2291         response_t      *response_ring_ptr; /* Current address. */
2292         uint16_t        rsp_ring_index;     /* Current index. */
2293         uint16_t        response_q_length;
2294
2295         struct isp_operations *isp_ops;
2296
2297         /* Outstandings ISP commands. */
2298         srb_t           *outstanding_cmds[MAX_OUTSTANDING_COMMANDS];
2299         uint32_t        current_outstanding_cmd;
2300         srb_t           *status_srb;    /* Status continuation entry. */
2301
2302         /* ISP configuration data. */
2303         uint16_t        loop_id;                /* Host adapter loop id */
2304         uint16_t        switch_cap;
2305 #define FLOGI_SEQ_DEL           BIT_8
2306 #define FLOGI_MID_SUPPORT       BIT_10
2307 #define FLOGI_VSAN_SUPPORT      BIT_12
2308 #define FLOGI_SP_SUPPORT        BIT_13
2309         uint16_t        fb_rev;
2310
2311         port_id_t       d_id;                   /* Host adapter port id */
2312         uint16_t        max_public_loop_ids;
2313         uint16_t        min_external_loopid;    /* First external loop Id */
2314
2315 #define PORT_SPEED_UNKNOWN 0xFFFF
2316 #define PORT_SPEED_1GB  0x00
2317 #define PORT_SPEED_2GB  0x01
2318 #define PORT_SPEED_4GB  0x03
2319 #define PORT_SPEED_8GB  0x04
2320         uint16_t        link_data_rate;         /* F/W operating speed */
2321
2322         uint8_t         current_topology;
2323         uint8_t         prev_topology;
2324 #define ISP_CFG_NL      1
2325 #define ISP_CFG_N       2
2326 #define ISP_CFG_FL      4
2327 #define ISP_CFG_F       8
2328
2329         uint8_t         operating_mode;         /* F/W operating mode */
2330 #define LOOP      0
2331 #define P2P       1
2332 #define LOOP_P2P  2
2333 #define P2P_LOOP  3
2334
2335         uint8_t         marker_needed;
2336
2337         uint8_t         interrupts_on;
2338
2339         /* HBA serial number */
2340         uint8_t         serial0;
2341         uint8_t         serial1;
2342         uint8_t         serial2;
2343
2344         /* NVRAM configuration data */
2345 #define MAX_NVRAM_SIZE  4096
2346 #define VPD_OFFSET      MAX_NVRAM_SIZE / 2
2347         uint16_t        nvram_size;
2348         uint16_t        nvram_base;
2349         void            *nvram;
2350         uint16_t        vpd_size;
2351         uint16_t        vpd_base;
2352         void            *vpd;
2353
2354         uint16_t        loop_reset_delay;
2355         uint8_t         retry_count;
2356         uint8_t         login_timeout;
2357         uint16_t        r_a_tov;
2358         int             port_down_retry_count;
2359         uint8_t         mbx_count;
2360         uint16_t        last_loop_id;
2361         uint16_t        mgmt_svr_loop_id;
2362
2363         uint32_t        login_retry_count;
2364         int             max_q_depth;
2365
2366         /* Fibre Channel Device List. */
2367         struct list_head        fcports;
2368
2369         /* RSCN queue. */
2370         uint32_t rscn_queue[MAX_RSCN_COUNT];
2371         uint8_t rscn_in_ptr;
2372         uint8_t rscn_out_ptr;
2373
2374         /* SNS command interfaces. */
2375         ms_iocb_entry_t         *ms_iocb;
2376         dma_addr_t              ms_iocb_dma;
2377         struct ct_sns_pkt       *ct_sns;
2378         dma_addr_t              ct_sns_dma;
2379         /* SNS command interfaces for 2200. */
2380         struct sns_cmd_pkt      *sns_cmd;
2381         dma_addr_t              sns_cmd_dma;
2382
2383 #define SFP_DEV_SIZE    256
2384 #define SFP_BLOCK_SIZE  64
2385         void                    *sfp_data;
2386         dma_addr_t              sfp_data_dma;
2387
2388         struct task_struct      *dpc_thread;
2389         uint8_t dpc_active;                  /* DPC routine is active */
2390
2391         /* Timeout timers. */
2392         uint8_t         loop_down_abort_time;    /* port down timer */
2393         atomic_t        loop_down_timer;         /* loop down timer */
2394         uint8_t         link_down_timeout;       /* link down timeout */
2395
2396         uint32_t        timer_active;
2397         struct timer_list        timer;
2398
2399         dma_addr_t      gid_list_dma;
2400         struct gid_list_info *gid_list;
2401         int             gid_list_info_size;
2402
2403         /* Small DMA pool allocations -- maximum 256 bytes in length. */
2404 #define DMA_POOL_SIZE   256
2405         struct dma_pool *s_dma_pool;
2406
2407         dma_addr_t      init_cb_dma;
2408         init_cb_t       *init_cb;
2409         int             init_cb_size;
2410
2411         /* These are used by mailbox operations. */
2412         volatile uint16_t mailbox_out[MAILBOX_REGISTER_COUNT];
2413
2414         mbx_cmd_t       *mcp;
2415         unsigned long   mbx_cmd_flags;
2416 #define MBX_INTERRUPT   1
2417 #define MBX_INTR_WAIT   2
2418 #define MBX_UPDATE_FLASH_ACTIVE 3
2419
2420         struct semaphore mbx_cmd_sem;   /* Serialialize mbx access */
2421         struct semaphore vport_sem;     /* Virtual port synchronization */
2422         struct semaphore mbx_intr_sem;  /* Used for completion notification */
2423
2424         uint32_t        mbx_flags;
2425 #define  MBX_IN_PROGRESS        BIT_0
2426 #define  MBX_BUSY               BIT_1   /* Got the Access */
2427 #define  MBX_SLEEPING_ON_SEM    BIT_2
2428 #define  MBX_POLLING_FOR_COMP   BIT_3
2429 #define  MBX_COMPLETED          BIT_4
2430 #define  MBX_TIMEDOUT           BIT_5
2431 #define  MBX_ACCESS_TIMEDOUT    BIT_6
2432
2433         mbx_cmd_t       mc;
2434
2435         /* Basic firmware related information. */
2436         uint16_t        fw_major_version;
2437         uint16_t        fw_minor_version;
2438         uint16_t        fw_subminor_version;
2439         uint16_t        fw_attributes;
2440         uint32_t        fw_memory_size;
2441         uint32_t        fw_transfer_size;
2442         uint32_t        fw_srisc_address;
2443 #define RISC_START_ADDRESS_2100 0x1000
2444 #define RISC_START_ADDRESS_2300 0x800
2445 #define RISC_START_ADDRESS_2400 0x100000
2446
2447         uint16_t        fw_options[16];         /* slots: 1,2,3,10,11 */
2448         uint8_t         fw_seriallink_options[4];
2449         uint16_t        fw_seriallink_options24[4];
2450
2451         /* Firmware dump information. */
2452         struct qla2xxx_fw_dump *fw_dump;
2453         uint32_t        fw_dump_len;
2454         int             fw_dumped;
2455         int             fw_dump_reading;
2456         dma_addr_t      eft_dma;
2457         void            *eft;
2458
2459         uint8_t         host_str[16];
2460         uint32_t        pci_attr;
2461         uint16_t        chip_revision;
2462
2463         uint16_t        product_id[4];
2464
2465         uint8_t         model_number[16+1];
2466 #define BINZERO         "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
2467         char            *model_desc;
2468         uint8_t         adapter_id[16+1];
2469
2470         uint8_t         *node_name;
2471         uint8_t         *port_name;
2472         uint8_t         fabric_node_name[WWN_SIZE];
2473         uint32_t    isp_abort_cnt;
2474
2475         /* Option ROM information. */
2476         char            *optrom_buffer;
2477         uint32_t        optrom_size;
2478         int             optrom_state;
2479 #define QLA_SWAITING    0
2480 #define QLA_SREADING    1
2481 #define QLA_SWRITING    2
2482         uint32_t        optrom_region_start;
2483         uint32_t        optrom_region_size;
2484
2485         /* PCI expansion ROM image information. */
2486 #define ROM_CODE_TYPE_BIOS      0
2487 #define ROM_CODE_TYPE_FCODE     1
2488 #define ROM_CODE_TYPE_EFI       3
2489         uint8_t         bios_revision[2];
2490         uint8_t         efi_revision[2];
2491         uint8_t         fcode_revision[16];
2492         uint32_t        fw_revision[4];
2493
2494         /* Needed for BEACON */
2495         uint16_t        beacon_blink_led;
2496         uint8_t         beacon_color_state;
2497 #define QLA_LED_GRN_ON          0x01
2498 #define QLA_LED_YLW_ON          0x02
2499 #define QLA_LED_ABR_ON          0x04
2500 #define QLA_LED_ALL_ON          0x07    /* yellow, green, amber. */
2501                                         /* ISP2322: red, green, amber. */
2502
2503         uint16_t        zio_mode;
2504         uint16_t        zio_timer;
2505         struct fc_host_statistics fc_host_stat;
2506
2507         struct qla_msix_entry msix_entries[QLA_MSIX_ENTRIES];
2508
2509         struct list_head        vp_list;        /* list of VP */
2510         struct fc_vport *fc_vport;      /* holds fc_vport * for each vport */
2511         uint8_t         vp_idx_map[16];
2512         uint16_t        num_vhosts;     /* number of vports created */
2513         uint16_t        num_vsans;      /* number of vsan created */
2514         uint16_t        vp_idx;         /* vport ID */
2515
2516         struct scsi_qla_host    *parent;        /* holds pport */
2517         unsigned long           vp_flags;
2518         struct list_head        vp_fcports;     /* list of fcports */
2519 #define VP_IDX_ACQUIRED         0       /* bit no 0 */
2520 #define VP_CREATE_NEEDED        1
2521 #define VP_BIND_NEEDED          2
2522 #define VP_DELETE_NEEDED        3
2523 #define VP_SCR_NEEDED           4       /* State Change Request registration */
2524         atomic_t                vp_state;
2525 #define VP_OFFLINE              0
2526 #define VP_ACTIVE               1
2527 #define VP_FAILED               2
2528 // #define VP_DISABLE           3
2529         uint16_t        vp_err_state;
2530         uint16_t        vp_prev_err_state;
2531 #define VP_ERR_UNKWN            0
2532 #define VP_ERR_PORTDWN          1
2533 #define VP_ERR_FAB_UNSUPPORTED  2
2534 #define VP_ERR_FAB_NORESOURCES  3
2535 #define VP_ERR_FAB_LOGOUT       4
2536 #define VP_ERR_ADAP_NORESOURCES 5
2537         int             max_npiv_vports;        /* 63 or 125 per topoloty */
2538         int             cur_vport_count;
2539 } scsi_qla_host_t;
2540
2541
2542 /*
2543  * Macros to help code, maintain, etc.
2544  */
2545 #define LOOP_TRANSITION(ha) \
2546         (test_bit(ISP_ABORT_NEEDED, &ha->dpc_flags) || \
2547          test_bit(LOOP_RESYNC_NEEDED, &ha->dpc_flags) || \
2548          atomic_read(&ha->loop_state) == LOOP_DOWN)
2549
2550 #define to_qla_host(x)          ((scsi_qla_host_t *) (x)->hostdata)
2551
2552 #define qla_printk(level, ha, format, arg...) \
2553         dev_printk(level , &((ha)->pdev->dev) , format , ## arg)
2554
2555 /*
2556  * qla2x00 local function return status codes
2557  */
2558 #define MBS_MASK                0x3fff
2559
2560 #define QLA_SUCCESS             (MBS_COMMAND_COMPLETE & MBS_MASK)
2561 #define QLA_INVALID_COMMAND     (MBS_INVALID_COMMAND & MBS_MASK)
2562 #define QLA_INTERFACE_ERROR     (MBS_HOST_INTERFACE_ERROR & MBS_MASK)
2563 #define QLA_TEST_FAILED         (MBS_TEST_FAILED & MBS_MASK)
2564 #define QLA_COMMAND_ERROR       (MBS_COMMAND_ERROR & MBS_MASK)
2565 #define QLA_PARAMETER_ERROR     (MBS_COMMAND_PARAMETER_ERROR & MBS_MASK)
2566 #define QLA_PORT_ID_USED        (MBS_PORT_ID_USED & MBS_MASK)
2567 #define QLA_LOOP_ID_USED        (MBS_LOOP_ID_USED & MBS_MASK)
2568 #define QLA_ALL_IDS_IN_USE      (MBS_ALL_IDS_IN_USE & MBS_MASK)
2569 #define QLA_NOT_LOGGED_IN       (MBS_NOT_LOGGED_IN & MBS_MASK)
2570
2571 #define QLA_FUNCTION_TIMEOUT            0x100
2572 #define QLA_FUNCTION_PARAMETER_ERROR    0x101
2573 #define QLA_FUNCTION_FAILED             0x102
2574 #define QLA_MEMORY_ALLOC_FAILED         0x103
2575 #define QLA_LOCK_TIMEOUT                0x104
2576 #define QLA_ABORTED                     0x105
2577 #define QLA_SUSPENDED                   0x106
2578 #define QLA_BUSY                        0x107
2579 #define QLA_RSCNS_HANDLED               0x108
2580 #define QLA_ALREADY_REGISTERED          0x109
2581
2582 #define NVRAM_DELAY()           udelay(10)
2583
2584 #define INVALID_HANDLE  (MAX_OUTSTANDING_COMMANDS+1)
2585
2586 /*
2587  * Flash support definitions
2588  */
2589 #define OPTROM_SIZE_2300        0x20000
2590 #define OPTROM_SIZE_2322        0x100000
2591 #define OPTROM_SIZE_24XX        0x100000
2592 #define OPTROM_SIZE_25XX        0x200000
2593
2594 #include "qla_gbl.h"
2595 #include "qla_dbg.h"
2596 #include "qla_inline.h"
2597
2598 #define CMD_SP(Cmnd)            ((Cmnd)->SCp.ptr)
2599 #define CMD_COMPL_STATUS(Cmnd)  ((Cmnd)->SCp.this_residual)
2600 #define CMD_RESID_LEN(Cmnd)     ((Cmnd)->SCp.buffers_residual)
2601 #define CMD_SCSI_STATUS(Cmnd)   ((Cmnd)->SCp.Status)
2602 #define CMD_ACTUAL_SNSLEN(Cmnd) ((Cmnd)->SCp.Message)
2603 #define CMD_ENTRY_STATUS(Cmnd)  ((Cmnd)->SCp.have_data_in)
2604
2605 #endif