drivers/scsi/qla4xxx/ql4_def.h

   1 /*
   2  * QLogic iSCSI HBA Driver
   3  * Copyright (c)  2003-2013 QLogic Corporation
   4  *
   5  * See LICENSE.qla4xxx for copyright and licensing details.
   6  */
   7
   8 #ifndef __QL4_DEF_H
   9 #define __QL4_DEF_H
  10
  11 #include <linux/kernel.h>
  12 #include <linux/init.h>
  13 #include <linux/types.h>
  14 #include <linux/module.h>
  15 #include <linux/list.h>
  16 #include <linux/pci.h>
  17 #include <linux/dma-mapping.h>
  18 #include <linux/sched.h>
  19 #include <linux/slab.h>
  20 #include <linux/dmapool.h>
  21 #include <linux/mempool.h>
  22 #include <linux/spinlock.h>
  23 #include <linux/workqueue.h>
  24 #include <linux/delay.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/mutex.h>
  27 #include <linux/aer.h>
  28 #include <linux/bsg-lib.h>
  29 #include <linux/vmalloc.h>
  30
  31 #include <net/tcp.h>
  32 #include <scsi/scsi.h>
  33 #include <scsi/scsi_host.h>
  34 #include <scsi/scsi_device.h>
  35 #include <scsi/scsi_cmnd.h>
  36 #include <scsi/scsi_transport.h>
  37 #include <scsi/scsi_transport_iscsi.h>
  38 #include <scsi/scsi_bsg_iscsi.h>
  39 #include <scsi/scsi_netlink.h>
  40 #include <scsi/libiscsi.h>
  41
  42 #include "ql4_dbg.h"
  43 #include "ql4_nx.h"
  44 #include "ql4_fw.h"
  45 #include "ql4_nvram.h"
  46 #include "ql4_83xx.h"
  47
  48 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4010
  49 #define PCI_DEVICE_ID_QLOGIC_ISP4010    0x4010
  50 #endif
  51
  52 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4022
  53 #define PCI_DEVICE_ID_QLOGIC_ISP4022    0x4022
  54 #endif
  55
  56 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4032
  57 #define PCI_DEVICE_ID_QLOGIC_ISP4032    0x4032
  58 #endif
  59
  60 #ifndef PCI_DEVICE_ID_QLOGIC_ISP8022
  61 #define PCI_DEVICE_ID_QLOGIC_ISP8022    0x8022
  62 #endif
  63
  64 #ifndef PCI_DEVICE_ID_QLOGIC_ISP8324
  65 #define PCI_DEVICE_ID_QLOGIC_ISP8324    0x8032
  66 #endif
  67
  68 #ifndef PCI_DEVICE_ID_QLOGIC_ISP8042
  69 #define PCI_DEVICE_ID_QLOGIC_ISP8042    0x8042
  70 #endif
  71
  72 #define ISP4XXX_PCI_FN_1        0x1
  73 #define ISP4XXX_PCI_FN_2        0x3
  74
  75 #define QLA_SUCCESS                     0
  76 #define QLA_ERROR                       1
  77 #define STATUS(status)          status == QLA_ERROR ? "FAILED" : "SUCCEEDED"
  78
  79 /*
  80  * Data bit definitions
  81  */
  82 #define BIT_0   0x1
  83 #define BIT_1   0x2
  84 #define BIT_2   0x4
  85 #define BIT_3   0x8
  86 #define BIT_4   0x10
  87 #define BIT_5   0x20
  88 #define BIT_6   0x40
  89 #define BIT_7   0x80
  90 #define BIT_8   0x100
  91 #define BIT_9   0x200
  92 #define BIT_10  0x400
  93 #define BIT_11  0x800
  94 #define BIT_12  0x1000
  95 #define BIT_13  0x2000
  96 #define BIT_14  0x4000
  97 #define BIT_15  0x8000
  98 #define BIT_16  0x10000
  99 #define BIT_17  0x20000
 100 #define BIT_18  0x40000
 101 #define BIT_19  0x80000
 102 #define BIT_20  0x100000
 103 #define BIT_21  0x200000
 104 #define BIT_22  0x400000
 105 #define BIT_23  0x800000
 106 #define BIT_24  0x1000000
 107 #define BIT_25  0x2000000
 108 #define BIT_26  0x4000000
 109 #define BIT_27  0x8000000
 110 #define BIT_28  0x10000000
 111 #define BIT_29  0x20000000
 112 #define BIT_30  0x40000000
 113 #define BIT_31  0x80000000
 114
 115 /**
 116  * Macros to help code, maintain, etc.
 117  **/
 118 #define ql4_printk(level, ha, format, arg...) \
 119         dev_printk(level , &((ha)->pdev->dev) , format , ## arg)
 120
 121
 122 /*
 123  * Host adapter default definitions
 124  ***********************************/
 125 #define MAX_HBAS                16
 126 #define MAX_BUSES               1
 127 #define MAX_TARGETS             MAX_DEV_DB_ENTRIES
 128 #define MAX_LUNS                0xffff
 129 #define MAX_AEN_ENTRIES         MAX_DEV_DB_ENTRIES
 130 #define MAX_DDB_ENTRIES         MAX_DEV_DB_ENTRIES
 131 #define MAX_PDU_ENTRIES         32
 132 #define INVALID_ENTRY           0xFFFF
 133 #define MAX_CMDS_TO_RISC        1024
 134 #define MAX_SRBS                MAX_CMDS_TO_RISC
 135 #define MBOX_AEN_REG_COUNT      8
 136 #define MAX_INIT_RETRIES        5
 137
 138 /*
 139  * Buffer sizes
 140  */
 141 #define REQUEST_QUEUE_DEPTH             MAX_CMDS_TO_RISC
 142 #define RESPONSE_QUEUE_DEPTH            64
 143 #define QUEUE_SIZE                      64
 144 #define DMA_BUFFER_SIZE                 512
 145 #define IOCB_HIWAT_CUSHION              4
 146
 147 /*
 148  * Misc
 149  */
 150 #define MAC_ADDR_LEN                    6       /* in bytes */
 151 #define IP_ADDR_LEN                     4       /* in bytes */
 152 #define IPv6_ADDR_LEN                   16      /* IPv6 address size */
 153 #define DRIVER_NAME                     "qla4xxx"
 154
 155 #define MAX_LINKED_CMDS_PER_LUN         3
 156 #define MAX_REQS_SERVICED_PER_INTR      1
 157
 158 #define ISCSI_IPADDR_SIZE               4       /* IP address size */
 159 #define ISCSI_ALIAS_SIZE                32      /* ISCSI Alias name size */
 160 #define ISCSI_NAME_SIZE                 0xE0    /* ISCSI Name size */
 161
 162 #define QL4_SESS_RECOVERY_TMO           120     /* iSCSI session */
 163                                                 /* recovery timeout */
 164
 165 #define LSDW(x) ((u32)((u64)(x)))
 166 #define MSDW(x) ((u32)((((u64)(x)) >> 16) >> 16))
 167
 168 #define DEV_DB_NON_PERSISTENT   0
 169 #define DEV_DB_PERSISTENT       1
 170
 171 #define QL4_ISP_REG_DISCONNECT 0xffffffffU
 172
 173 #define COPY_ISID(dst_isid, src_isid) {                 \
 174         int i, j;                                       \
 175         for (i = 0, j = ISID_SIZE - 1; i < ISID_SIZE;)  \
 176                 dst_isid[i++] = src_isid[j--];          \
 177 }
 178
 179 #define SET_BITVAL(o, n, v) {   \
 180         if (o)                  \
 181                 n |= v;         \
 182         else                    \
 183                 n &= ~v;        \
 184 }
 185
 186 #define OP_STATE(o, f, p) {                     \
 187         p = (o & f) ? "enable" : "disable";     \
 188 }
 189
 190 /*
 191  * Retry & Timeout Values
 192  */
 193 #define MBOX_TOV                        60
 194 #define SOFT_RESET_TOV                  30
 195 #define RESET_INTR_TOV                  3
 196 #define SEMAPHORE_TOV                   10
 197 #define ADAPTER_INIT_TOV                30
 198 #define ADAPTER_RESET_TOV               180
 199 #define EXTEND_CMD_TOV                  60
 200 #define WAIT_CMD_TOV                    5
 201 #define EH_WAIT_CMD_TOV                 120
 202 #define FIRMWARE_UP_TOV                 60
 203 #define RESET_FIRMWARE_TOV              30
 204 #define LOGOUT_TOV                      10
 205 #define IOCB_TOV_MARGIN                 10
 206 #define RELOGIN_TOV                     18
 207 #define ISNS_DEREG_TOV                  5
 208 #define HBA_ONLINE_TOV                  30
 209 #define DISABLE_ACB_TOV                 30
 210 #define IP_CONFIG_TOV                   30
 211 #define LOGIN_TOV                       12
 212 #define BOOT_LOGIN_RESP_TOV             60
 213
 214 #define MAX_RESET_HA_RETRIES            2
 215 #define FW_ALIVE_WAIT_TOV               3
 216 #define IDC_EXTEND_TOV                  8
 217 #define IDC_COMP_TOV                    5
 218 #define LINK_UP_COMP_TOV                30
 219
 220 #define CMD_SP(Cmnd)                    ((Cmnd)->SCp.ptr)
 221
 222 /*
 223  * SCSI Request Block structure  (srb)  that is placed
 224  * on cmd->SCp location of every I/O     [We have 22 bytes available]
 225  */
 226 struct srb {
 227         struct list_head list;  /* (8)   */
 228         struct scsi_qla_host *ha;       /* HA the SP is queued on */
 229         struct ddb_entry *ddb;
 230         uint16_t flags;         /* (1) Status flags. */
 231
 232 #define SRB_DMA_VALID           BIT_3   /* DMA Buffer mapped. */
 233 #define SRB_GOT_SENSE           BIT_4   /* sense data received. */
 234         uint8_t state;          /* (1) Status flags. */
 235
 236 #define SRB_NO_QUEUE_STATE       0      /* Request is in between states */
 237 #define SRB_FREE_STATE           1
 238 #define SRB_ACTIVE_STATE         3
 239 #define SRB_ACTIVE_TIMEOUT_STATE 4
 240 #define SRB_SUSPENDED_STATE      7      /* Request in suspended state */
 241
 242         struct scsi_cmnd *cmd;  /* (4) SCSI command block */
 243         dma_addr_t dma_handle;  /* (4) for unmap of single transfers */
 244         struct kref srb_ref;    /* reference count for this srb */
 245         uint8_t err_id;         /* error id */
 246 #define SRB_ERR_PORT       1    /* Request failed because "port down" */
 247 #define SRB_ERR_LOOP       2    /* Request failed because "loop down" */
 248 #define SRB_ERR_DEVICE     3    /* Request failed because "device error" */
 249 #define SRB_ERR_OTHER      4
 250
 251         uint16_t reserved;
 252         uint16_t iocb_tov;
 253         uint16_t iocb_cnt;      /* Number of used iocbs */
 254         uint16_t cc_stat;
 255
 256         /* Used for extended sense / status continuation */
 257         uint8_t *req_sense_ptr;
 258         uint16_t req_sense_len;
 259         uint16_t reserved2;
 260 };
 261
 262 /* Mailbox request block structure */
 263 struct mrb {
 264         struct scsi_qla_host *ha;
 265         struct mbox_cmd_iocb *mbox;
 266         uint32_t mbox_cmd;
 267         uint16_t iocb_cnt;              /* Number of used iocbs */
 268         uint32_t pid;
 269 };
 270
 271 /*
 272  * Asynchronous Event Queue structure
 273  */
 274 struct aen {
 275         uint32_t mbox_sts[MBOX_AEN_REG_COUNT];
 276 };
 277
 278 struct ql4_aen_log {
 279         int count;
 280         struct aen entry[MAX_AEN_ENTRIES];
 281 };
 282
 283 /*
 284  * Device Database (DDB) structure
 285  */
 286 struct ddb_entry {
 287         struct scsi_qla_host *ha;
 288         struct iscsi_cls_session *sess;
 289         struct iscsi_cls_conn *conn;
 290
 291         uint16_t fw_ddb_index;  /* DDB firmware index */
 292         uint32_t fw_ddb_device_state; /* F/W Device State  -- see ql4_fw.h */
 293         uint16_t ddb_type;
 294 #define FLASH_DDB 0x01
 295
 296         struct dev_db_entry fw_ddb_entry;
 297         int (*unblock_sess)(struct iscsi_cls_session *cls_session);
 298         int (*ddb_change)(struct scsi_qla_host *ha, uint32_t fw_ddb_index,
 299                           struct ddb_entry *ddb_entry, uint32_t state);
 300
 301         /* Driver Re-login  */
 302         unsigned long flags;              /* DDB Flags */
 303 #define DDB_CONN_CLOSE_FAILURE          0 /* 0x00000001 */
 304
 305         uint16_t default_relogin_timeout; /*  Max time to wait for
 306                                            *  relogin to complete */
 307         atomic_t retry_relogin_timer;     /* Min Time between relogins
 308                                            * (4000 only) */
 309         atomic_t relogin_timer;           /* Max Time to wait for
 310                                            * relogin to complete */
 311         atomic_t relogin_retry_count;     /* Num of times relogin has been
 312                                            * retried */
 313         uint32_t default_time2wait;       /* Default Min time between
 314                                            * relogins (+aens) */
 315         uint16_t chap_tbl_idx;
 316 };
 317
 318 struct qla_ddb_index {
 319         struct list_head list;
 320         uint16_t fw_ddb_idx;
 321         uint16_t flash_ddb_idx;
 322         struct dev_db_entry fw_ddb;
 323         uint8_t flash_isid[6];
 324 };
 325
 326 #define DDB_IPADDR_LEN 64
 327
 328 struct ql4_tuple_ddb {
 329         int port;
 330         int tpgt;
 331         char ip_addr[DDB_IPADDR_LEN];
 332         char iscsi_name[ISCSI_NAME_SIZE];
 333         uint16_t options;
 334 #define DDB_OPT_IPV6 0x0e0e
 335 #define DDB_OPT_IPV4 0x0f0f
 336         uint8_t isid[6];
 337 };
 338
 339 /*
 340  * DDB states.
 341  */
 342 #define DDB_STATE_DEAD          0       /* We can no longer talk to
 343                                          * this device */
 344 #define DDB_STATE_ONLINE        1       /* Device ready to accept
 345                                          * commands */
 346 #define DDB_STATE_MISSING       2       /* Device logged off, trying
 347                                          * to re-login */
 348
 349 /*
 350  * DDB flags.
 351  */
 352 #define DF_RELOGIN              0       /* Relogin to device */
 353 #define DF_BOOT_TGT             1       /* Boot target entry */
 354 #define DF_ISNS_DISCOVERED      2       /* Device was discovered via iSNS */
 355 #define DF_FO_MASKED            3
 356 #define DF_DISABLE_RELOGIN              4       /* Disable relogin to device */
 357
 358 enum qla4_work_type {
 359         QLA4_EVENT_AEN,
 360         QLA4_EVENT_PING_STATUS,
 361 };
 362
 363 struct qla4_work_evt {
 364         struct list_head list;
 365         enum qla4_work_type type;
 366         union {
 367                 struct {
 368                         enum iscsi_host_event_code code;
 369                         uint32_t data_size;
 370                         uint8_t data[0];
 371                 } aen;
 372                 struct {
 373                         uint32_t status;
 374                         uint32_t pid;
 375                         uint32_t data_size;
 376                         uint8_t data[0];
 377                 } ping;
 378         } u;
 379 };
 380
 381 struct ql82xx_hw_data {
 382         /* Offsets for flash/nvram access (set to ~0 if not used). */
 383         uint32_t flash_conf_off;
 384         uint32_t flash_data_off;
 385
 386         uint32_t fdt_wrt_disable;
 387         uint32_t fdt_erase_cmd;
 388         uint32_t fdt_block_size;
 389         uint32_t fdt_unprotect_sec_cmd;
 390         uint32_t fdt_protect_sec_cmd;
 391
 392         uint32_t flt_region_flt;
 393         uint32_t flt_region_fdt;
 394         uint32_t flt_region_boot;
 395         uint32_t flt_region_bootload;
 396         uint32_t flt_region_fw;
 397
 398         uint32_t flt_iscsi_param;
 399         uint32_t flt_region_chap;
 400         uint32_t flt_chap_size;
 401         uint32_t flt_region_ddb;
 402         uint32_t flt_ddb_size;
 403 };
 404
 405 struct qla4_8xxx_legacy_intr_set {
 406         uint32_t int_vec_bit;
 407         uint32_t tgt_status_reg;
 408         uint32_t tgt_mask_reg;
 409         uint32_t pci_int_reg;
 410 };
 411
 412 /* MSI-X Support */
 413
 414 #define QLA_MSIX_DEFAULT        0x00
 415 #define QLA_MSIX_RSP_Q          0x01
 416
 417 #define QLA_MSIX_ENTRIES        2
 418 #define QLA_MIDX_DEFAULT        0
 419 #define QLA_MIDX_RSP_Q          1
 420
 421 struct ql4_msix_entry {
 422         int have_irq;
 423         uint16_t msix_vector;
 424         uint16_t msix_entry;
 425 };
 426
 427 /*
 428  * ISP Operations
 429  */
 430 struct isp_operations {
 431         int (*iospace_config) (struct scsi_qla_host *ha);
 432         void (*pci_config) (struct scsi_qla_host *);
 433         void (*disable_intrs) (struct scsi_qla_host *);
 434         void (*enable_intrs) (struct scsi_qla_host *);
 435         int (*start_firmware) (struct scsi_qla_host *);
 436         int (*restart_firmware) (struct scsi_qla_host *);
 437         irqreturn_t (*intr_handler) (int , void *);
 438         void (*interrupt_service_routine) (struct scsi_qla_host *, uint32_t);
 439         int (*need_reset) (struct scsi_qla_host *);
 440         int (*reset_chip) (struct scsi_qla_host *);
 441         int (*reset_firmware) (struct scsi_qla_host *);
 442         void (*queue_iocb) (struct scsi_qla_host *);
 443         void (*complete_iocb) (struct scsi_qla_host *);
 444         uint16_t (*rd_shdw_req_q_out) (struct scsi_qla_host *);
 445         uint16_t (*rd_shdw_rsp_q_in) (struct scsi_qla_host *);
 446         int (*get_sys_info) (struct scsi_qla_host *);
 447         uint32_t (*rd_reg_direct) (struct scsi_qla_host *, ulong);
 448         void (*wr_reg_direct) (struct scsi_qla_host *, ulong, uint32_t);
 449         int (*rd_reg_indirect) (struct scsi_qla_host *, uint32_t, uint32_t *);
 450         int (*wr_reg_indirect) (struct scsi_qla_host *, uint32_t, uint32_t);
 451         int (*idc_lock) (struct scsi_qla_host *);
 452         void (*idc_unlock) (struct scsi_qla_host *);
 453         void (*rom_lock_recovery) (struct scsi_qla_host *);
 454         void (*queue_mailbox_command) (struct scsi_qla_host *, uint32_t *, int);
 455         void (*process_mailbox_interrupt) (struct scsi_qla_host *, int);
 456 };
 457
 458 struct ql4_mdump_size_table {
 459         uint32_t size;
 460         uint32_t size_cmask_02;
 461         uint32_t size_cmask_04;
 462         uint32_t size_cmask_08;
 463         uint32_t size_cmask_10;
 464         uint32_t size_cmask_FF;
 465         uint32_t version;
 466 };
 467
 468 /*qla4xxx ipaddress configuration details */
 469 struct ipaddress_config {
 470         uint16_t ipv4_options;
 471         uint16_t tcp_options;
 472         uint16_t ipv4_vlan_tag;
 473         uint8_t ipv4_addr_state;
 474         uint8_t ip_address[IP_ADDR_LEN];
 475         uint8_t subnet_mask[IP_ADDR_LEN];
 476         uint8_t gateway[IP_ADDR_LEN];
 477         uint32_t ipv6_options;
 478         uint32_t ipv6_addl_options;
 479         uint8_t ipv6_link_local_state;
 480         uint8_t ipv6_addr0_state;
 481         uint8_t ipv6_addr1_state;
 482         uint8_t ipv6_default_router_state;
 483         uint16_t ipv6_vlan_tag;
 484         struct in6_addr ipv6_link_local_addr;
 485         struct in6_addr ipv6_addr0;
 486         struct in6_addr ipv6_addr1;
 487         struct in6_addr ipv6_default_router_addr;
 488         uint16_t eth_mtu_size;
 489         uint16_t ipv4_port;
 490         uint16_t ipv6_port;
 491         uint8_t control;
 492         uint16_t ipv6_tcp_options;
 493         uint8_t tcp_wsf;
 494         uint8_t ipv6_tcp_wsf;
 495         uint8_t ipv4_tos;
 496         uint8_t ipv4_cache_id;
 497         uint8_t ipv6_cache_id;
 498         uint8_t ipv4_alt_cid_len;
 499         uint8_t ipv4_alt_cid[11];
 500         uint8_t ipv4_vid_len;
 501         uint8_t ipv4_vid[11];
 502         uint8_t ipv4_ttl;
 503         uint16_t ipv6_flow_lbl;
 504         uint8_t ipv6_traffic_class;
 505         uint8_t ipv6_hop_limit;
 506         uint32_t ipv6_nd_reach_time;
 507         uint32_t ipv6_nd_rexmit_timer;
 508         uint32_t ipv6_nd_stale_timeout;
 509         uint8_t ipv6_dup_addr_detect_count;
 510         uint32_t ipv6_gw_advrt_mtu;
 511         uint16_t def_timeout;
 512         uint8_t abort_timer;
 513         uint16_t iscsi_options;
 514         uint16_t iscsi_max_pdu_size;
 515         uint16_t iscsi_first_burst_len;
 516         uint16_t iscsi_max_outstnd_r2t;
 517         uint16_t iscsi_max_burst_len;
 518         uint8_t iscsi_name[224];
 519 };
 520
 521 #define QL4_CHAP_MAX_NAME_LEN 256
 522 #define QL4_CHAP_MAX_SECRET_LEN 100
 523 #define LOCAL_CHAP      0
 524 #define BIDI_CHAP       1
 525
 526 struct ql4_chap_format {
 527         u8  intr_chap_name[QL4_CHAP_MAX_NAME_LEN];
 528         u8  intr_secret[QL4_CHAP_MAX_SECRET_LEN];
 529         u8  target_chap_name[QL4_CHAP_MAX_NAME_LEN];
 530         u8  target_secret[QL4_CHAP_MAX_SECRET_LEN];
 531         u16 intr_chap_name_length;
 532         u16 intr_secret_length;
 533         u16 target_chap_name_length;
 534         u16 target_secret_length;
 535 };
 536
 537 struct ip_address_format {
 538         u8 ip_type;
 539         u8 ip_address[16];
 540 };
 541
 542 struct  ql4_conn_info {
 543         u16     dest_port;
 544         struct  ip_address_format dest_ipaddr;
 545         struct  ql4_chap_format chap;
 546 };
 547
 548 struct ql4_boot_session_info {
 549         u8      target_name[224];
 550         struct  ql4_conn_info conn_list[1];
 551 };
 552
 553 struct ql4_boot_tgt_info {
 554         struct ql4_boot_session_info boot_pri_sess;
 555         struct ql4_boot_session_info boot_sec_sess;
 556 };
 557
 558 /*
 559  * Linux Host Adapter structure
 560  */
 561 struct scsi_qla_host {
 562         /* Linux adapter configuration data */
 563         unsigned long flags;
 564
 565 #define AF_ONLINE                       0 /* 0x00000001 */
 566 #define AF_INIT_DONE                    1 /* 0x00000002 */
 567 #define AF_MBOX_COMMAND                 2 /* 0x00000004 */
 568 #define AF_MBOX_COMMAND_DONE            3 /* 0x00000008 */
 569 #define AF_ST_DISCOVERY_IN_PROGRESS     4 /* 0x00000010 */
 570 #define AF_INTERRUPTS_ON                6 /* 0x00000040 */
 571 #define AF_GET_CRASH_RECORD             7 /* 0x00000080 */
 572 #define AF_LINK_UP                      8 /* 0x00000100 */
 573 #define AF_LOOPBACK                     9 /* 0x00000200 */
 574 #define AF_IRQ_ATTACHED                 10 /* 0x00000400 */
 575 #define AF_DISABLE_ACB_COMPLETE         11 /* 0x00000800 */
 576 #define AF_HA_REMOVAL                   12 /* 0x00001000 */
 577 #define AF_INTx_ENABLED                 15 /* 0x00008000 */
 578 #define AF_MSI_ENABLED                  16 /* 0x00010000 */
 579 #define AF_MSIX_ENABLED                 17 /* 0x00020000 */
 580 #define AF_MBOX_COMMAND_NOPOLL          18 /* 0x00040000 */
 581 #define AF_FW_RECOVERY                  19 /* 0x00080000 */
 582 #define AF_EEH_BUSY                     20 /* 0x00100000 */
 583 #define AF_PCI_CHANNEL_IO_PERM_FAILURE  21 /* 0x00200000 */
 584 #define AF_BUILD_DDB_LIST               22 /* 0x00400000 */
 585 #define AF_82XX_FW_DUMPED               24 /* 0x01000000 */
 586 #define AF_8XXX_RST_OWNER               25 /* 0x02000000 */
 587 #define AF_82XX_DUMP_READING            26 /* 0x04000000 */
 588 #define AF_83XX_IOCB_INTR_ON            28 /* 0x10000000 */
 589 #define AF_83XX_MBOX_INTR_ON            29 /* 0x20000000 */
 590
 591         unsigned long dpc_flags;
 592
 593 #define DPC_RESET_HA                    1 /* 0x00000002 */
 594 #define DPC_RETRY_RESET_HA              2 /* 0x00000004 */
 595 #define DPC_RELOGIN_DEVICE              3 /* 0x00000008 */
 596 #define DPC_RESET_HA_FW_CONTEXT         4 /* 0x00000010 */
 597 #define DPC_RESET_HA_INTR               5 /* 0x00000020 */
 598 #define DPC_ISNS_RESTART                7 /* 0x00000080 */
 599 #define DPC_AEN                         9 /* 0x00000200 */
 600 #define DPC_GET_DHCP_IP_ADDR            15 /* 0x00008000 */
 601 #define DPC_LINK_CHANGED                18 /* 0x00040000 */
 602 #define DPC_RESET_ACTIVE                20 /* 0x00100000 */
 603 #define DPC_HA_UNRECOVERABLE            21 /* 0x00200000 ISP-82xx only*/
 604 #define DPC_HA_NEED_QUIESCENT           22 /* 0x00400000 ISP-82xx only*/
 605 #define DPC_POST_IDC_ACK                23 /* 0x00800000 */
 606 #define DPC_RESTORE_ACB                 24 /* 0x01000000 */
 607 #define DPC_SYSFS_DDB_EXPORT            25 /* 0x02000000 */
 608
 609         struct Scsi_Host *host; /* pointer to host data */
 610         uint32_t tot_ddbs;
 611
 612         uint16_t iocb_cnt;
 613         uint16_t iocb_hiwat;
 614
 615         /* SRB cache. */
 616 #define SRB_MIN_REQ     128
 617         mempool_t *srb_mempool;
 618
 619         /* pci information */
 620         struct pci_dev *pdev;
 621
 622         struct isp_reg __iomem *reg; /* Base I/O address */
 623         unsigned long pio_address;
 624         unsigned long pio_length;
 625 #define MIN_IOBASE_LEN          0x100
 626
 627         uint16_t req_q_count;
 628
 629         unsigned long host_no;
 630
 631         /* NVRAM registers */
 632         struct eeprom_data *nvram;
 633         spinlock_t hardware_lock ____cacheline_aligned;
 634         uint32_t eeprom_cmd_data;
 635
 636         /* Counters for general statistics */
 637         uint64_t isr_count;
 638         uint64_t adapter_error_count;
 639         uint64_t device_error_count;
 640         uint64_t total_io_count;
 641         uint64_t total_mbytes_xferred;
 642         uint64_t link_failure_count;
 643         uint64_t invalid_crc_count;
 644         uint32_t bytes_xfered;
 645         uint32_t spurious_int_count;
 646         uint32_t aborted_io_count;
 647         uint32_t io_timeout_count;
 648         uint32_t mailbox_timeout_count;
 649         uint32_t seconds_since_last_intr;
 650         uint32_t seconds_since_last_heartbeat;
 651         uint32_t mac_index;
 652
 653         /* Info Needed for Management App */
 654         /* --- From GetFwVersion --- */
 655         uint32_t firmware_version[2];
 656         uint32_t patch_number;
 657         uint32_t build_number;
 658         uint32_t board_id;
 659
 660         /* --- From Init_FW --- */
 661         /* init_cb_t *init_cb; */
 662         uint16_t firmware_options;
 663         uint8_t alias[32];
 664         uint8_t name_string[256];
 665         uint8_t heartbeat_interval;
 666
 667         /* --- From FlashSysInfo --- */
 668         uint8_t my_mac[MAC_ADDR_LEN];
 669         uint8_t serial_number[16];
 670         uint16_t port_num;
 671         /* --- From GetFwState --- */
 672         uint32_t firmware_state;
 673         uint32_t addl_fw_state;
 674
 675         /* Linux kernel thread */
 676         struct workqueue_struct *dpc_thread;
 677         struct work_struct dpc_work;
 678
 679         /* Linux timer thread */
 680         struct timer_list timer;
 681         uint32_t timer_active;
 682
 683         /* Recovery Timers */
 684         atomic_t check_relogin_timeouts;
 685         uint32_t retry_reset_ha_cnt;
 686         uint32_t isp_reset_timer;       /* reset test timer */
 687         uint32_t nic_reset_timer;       /* simulated nic reset test timer */
 688         int eh_start;
 689         struct list_head free_srb_q;
 690         uint16_t free_srb_q_count;
 691         uint16_t num_srbs_allocated;
 692
 693         /* DMA Memory Block */
 694         void *queues;
 695         dma_addr_t queues_dma;
 696         unsigned long queues_len;
 697
 698 #define MEM_ALIGN_VALUE \
 699             ((max(REQUEST_QUEUE_DEPTH, RESPONSE_QUEUE_DEPTH)) * \
 700              sizeof(struct queue_entry))
 701         /* request and response queue variables */
 702         dma_addr_t request_dma;
 703         struct queue_entry *request_ring;
 704         struct queue_entry *request_ptr;
 705         dma_addr_t response_dma;
 706         struct queue_entry *response_ring;
 707         struct queue_entry *response_ptr;
 708         dma_addr_t shadow_regs_dma;
 709         struct shadow_regs *shadow_regs;
 710         uint16_t request_in;    /* Current indexes. */
 711         uint16_t request_out;
 712         uint16_t response_in;
 713         uint16_t response_out;
 714
 715         /* aen queue variables */
 716         uint16_t aen_q_count;   /* Number of available aen_q entries */
 717         uint16_t aen_in;        /* Current indexes */
 718         uint16_t aen_out;
 719         struct aen aen_q[MAX_AEN_ENTRIES];
 720
 721         struct ql4_aen_log aen_log;/* tracks all aens */
 722
 723         /* This mutex protects several threads to do mailbox commands
 724          * concurrently.
 725          */
 726         struct mutex  mbox_sem;
 727
 728         /* temporary mailbox status registers */
 729         volatile uint8_t mbox_status_count;
 730         volatile uint32_t mbox_status[MBOX_REG_COUNT];
 731
 732         /* FW ddb index map */
 733         struct ddb_entry *fw_ddb_index_map[MAX_DDB_ENTRIES];
 734
 735         /* Saved srb for status continuation entry processing */
 736         struct srb *status_srb;
 737
 738         uint8_t acb_version;
 739
 740         /* qla82xx specific fields */
 741         struct device_reg_82xx  __iomem *qla4_82xx_reg; /* Base I/O address */
 742         unsigned long nx_pcibase;       /* Base I/O address */
 743         uint8_t *nx_db_rd_ptr;          /* Doorbell read pointer */
 744         unsigned long nx_db_wr_ptr;     /* Door bell write pointer */
 745         unsigned long first_page_group_start;
 746         unsigned long first_page_group_end;
 747
 748         uint32_t crb_win;
 749         uint32_t curr_window;
 750         uint32_t ddr_mn_window;
 751         unsigned long mn_win_crb;
 752         unsigned long ms_win_crb;
 753         int qdr_sn_window;
 754         rwlock_t hw_lock;
 755         uint16_t func_num;
 756         int link_width;
 757
 758         struct qla4_8xxx_legacy_intr_set nx_legacy_intr;
 759         u32 nx_crb_mask;
 760
 761         uint8_t revision_id;
 762         uint32_t fw_heartbeat_counter;
 763
 764         struct isp_operations *isp_ops;
 765         struct ql82xx_hw_data hw;
 766
 767         struct ql4_msix_entry msix_entries[QLA_MSIX_ENTRIES];
 768
 769         uint32_t nx_dev_init_timeout;
 770         uint32_t nx_reset_timeout;
 771         void *fw_dump;
 772         uint32_t fw_dump_size;
 773         uint32_t fw_dump_capture_mask;
 774         void *fw_dump_tmplt_hdr;
 775         uint32_t fw_dump_tmplt_size;
 776         uint32_t fw_dump_skip_size;
 777
 778         struct completion mbx_intr_comp;
 779
 780         struct ipaddress_config ip_config;
 781         struct iscsi_iface *iface_ipv4;
 782         struct iscsi_iface *iface_ipv6_0;
 783         struct iscsi_iface *iface_ipv6_1;
 784
 785         /* --- From About Firmware --- */
 786         struct about_fw_info fw_info;
 787         uint32_t fw_uptime_secs;  /* seconds elapsed since fw bootup */
 788         uint32_t fw_uptime_msecs; /* milliseconds beyond elapsed seconds */
 789         uint16_t def_timeout; /* Default login timeout */
 790
 791         uint32_t flash_state;
 792 #define QLFLASH_WAITING         0
 793 #define QLFLASH_READING         1
 794 #define QLFLASH_WRITING         2
 795         struct dma_pool *chap_dma_pool;
 796         uint8_t *chap_list; /* CHAP table cache */
 797         struct mutex  chap_sem;
 798
 799 #define CHAP_DMA_BLOCK_SIZE    512
 800         struct workqueue_struct *task_wq;
 801         unsigned long ddb_idx_map[MAX_DDB_ENTRIES / BITS_PER_LONG];
 802 #define SYSFS_FLAG_FW_SEL_BOOT 2
 803         struct iscsi_boot_kset *boot_kset;
 804         struct ql4_boot_tgt_info boot_tgt;
 805         uint16_t phy_port_num;
 806         uint16_t phy_port_cnt;
 807         uint16_t iscsi_pci_func_cnt;
 808         uint8_t model_name[16];
 809         struct completion disable_acb_comp;
 810         struct dma_pool *fw_ddb_dma_pool;
 811 #define DDB_DMA_BLOCK_SIZE 512
 812         uint16_t pri_ddb_idx;
 813         uint16_t sec_ddb_idx;
 814         int is_reset;
 815         uint16_t temperature;
 816
 817         /* event work list */
 818         struct list_head work_list;
 819         spinlock_t work_lock;
 820
 821         /* mbox iocb */
 822 #define MAX_MRB         128
 823         struct mrb *active_mrb_array[MAX_MRB];
 824         uint32_t mrb_index;
 825
 826         uint32_t *reg_tbl;
 827         struct qla4_83xx_reset_template reset_tmplt;
 828         struct device_reg_83xx  __iomem *qla4_83xx_reg; /* Base I/O address
 829                                                            for ISP8324 and
 830                                                            and ISP8042 */
 831         uint32_t pf_bit;
 832         struct qla4_83xx_idc_information idc_info;
 833         struct addr_ctrl_blk *saved_acb;
 834         int notify_idc_comp;
 835         int notify_link_up_comp;
 836         int idc_extend_tmo;
 837         struct completion idc_comp;
 838         struct completion link_up_comp;
 839 };
 840
 841 struct ql4_task_data {
 842         struct scsi_qla_host *ha;
 843         uint8_t iocb_req_cnt;
 844         dma_addr_t data_dma;
 845         void *req_buffer;
 846         dma_addr_t req_dma;
 847         uint32_t req_len;
 848         void *resp_buffer;
 849         dma_addr_t resp_dma;
 850         uint32_t resp_len;
 851         struct iscsi_task *task;
 852         struct passthru_status sts;
 853         struct work_struct task_work;
 854 };
 855
 856 struct qla_endpoint {
 857         struct Scsi_Host *host;
 858         struct sockaddr_storage dst_addr;
 859 };
 860
 861 struct qla_conn {
 862         struct qla_endpoint *qla_ep;
 863 };
 864
 865 static inline int is_ipv4_enabled(struct scsi_qla_host *ha)
 866 {
 867         return ((ha->ip_config.ipv4_options & IPOPT_IPV4_PROTOCOL_ENABLE) != 0);
 868 }
 869
 870 static inline int is_ipv6_enabled(struct scsi_qla_host *ha)
 871 {
 872         return ((ha->ip_config.ipv6_options &
 873                 IPV6_OPT_IPV6_PROTOCOL_ENABLE) != 0);
 874 }
 875
 876 static inline int is_qla4010(struct scsi_qla_host *ha)
 877 {
 878         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4010;
 879 }
 880
 881 static inline int is_qla4022(struct scsi_qla_host *ha)
 882 {
 883         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4022;
 884 }
 885
 886 static inline int is_qla4032(struct scsi_qla_host *ha)
 887 {
 888         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4032;
 889 }
 890
 891 static inline int is_qla40XX(struct scsi_qla_host *ha)
 892 {
 893         return is_qla4032(ha) || is_qla4022(ha) || is_qla4010(ha);
 894 }
 895
 896 static inline int is_qla8022(struct scsi_qla_host *ha)
 897 {
 898         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8022;
 899 }
 900
 901 static inline int is_qla8032(struct scsi_qla_host *ha)
 902 {
 903         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8324;
 904 }
 905
 906 static inline int is_qla8042(struct scsi_qla_host *ha)
 907 {
 908         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8042;
 909 }
 910
 911 static inline int is_qla80XX(struct scsi_qla_host *ha)
 912 {
 913         return is_qla8022(ha) || is_qla8032(ha) || is_qla8042(ha);
 914 }
 915
 916 static inline int is_aer_supported(struct scsi_qla_host *ha)
 917 {
 918         return ((ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8022) ||
 919                 (ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8324) ||
 920                 (ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP8042));
 921 }
 922
 923 static inline int adapter_up(struct scsi_qla_host *ha)
 924 {
 925         return (test_bit(AF_ONLINE, &ha->flags) != 0) &&
 926                (test_bit(AF_LINK_UP, &ha->flags) != 0) &&
 927                (!test_bit(AF_LOOPBACK, &ha->flags));
 928 }
 929
 930 static inline struct scsi_qla_host* to_qla_host(struct Scsi_Host *shost)
 931 {
 932         return (struct scsi_qla_host *)iscsi_host_priv(shost);
 933 }
 934
 935 static inline void __iomem* isp_semaphore(struct scsi_qla_host *ha)
 936 {
 937         return (is_qla4010(ha) ?
 938                 &ha->reg->u1.isp4010.nvram :
 939                 &ha->reg->u1.isp4022.semaphore);
 940 }
 941
 942 static inline void __iomem* isp_nvram(struct scsi_qla_host *ha)
 943 {
 944         return (is_qla4010(ha) ?
 945                 &ha->reg->u1.isp4010.nvram :
 946                 &ha->reg->u1.isp4022.nvram);
 947 }
 948
 949 static inline void __iomem* isp_ext_hw_conf(struct scsi_qla_host *ha)
 950 {
 951         return (is_qla4010(ha) ?
 952                 &ha->reg->u2.isp4010.ext_hw_conf :
 953                 &ha->reg->u2.isp4022.p0.ext_hw_conf);
 954 }
 955
 956 static inline void __iomem* isp_port_status(struct scsi_qla_host *ha)
 957 {
 958         return (is_qla4010(ha) ?
 959                 &ha->reg->u2.isp4010.port_status :
 960                 &ha->reg->u2.isp4022.p0.port_status);
 961 }
 962
 963 static inline void __iomem* isp_port_ctrl(struct scsi_qla_host *ha)
 964 {
 965         return (is_qla4010(ha) ?
 966                 &ha->reg->u2.isp4010.port_ctrl :
 967                 &ha->reg->u2.isp4022.p0.port_ctrl);
 968 }
 969
 970 static inline void __iomem* isp_port_error_status(struct scsi_qla_host *ha)
 971 {
 972         return (is_qla4010(ha) ?
 973                 &ha->reg->u2.isp4010.port_err_status :
 974                 &ha->reg->u2.isp4022.p0.port_err_status);
 975 }
 976
 977 static inline void __iomem * isp_gp_out(struct scsi_qla_host *ha)
 978 {
 979         return (is_qla4010(ha) ?
 980                 &ha->reg->u2.isp4010.gp_out :
 981                 &ha->reg->u2.isp4022.p0.gp_out);
 982 }
 983
 984 static inline int eeprom_ext_hw_conf_offset(struct scsi_qla_host *ha)
 985 {
 986         return (is_qla4010(ha) ?
 987                 offsetof(struct eeprom_data, isp4010.ext_hw_conf) / 2 :
 988                 offsetof(struct eeprom_data, isp4022.ext_hw_conf) / 2);
 989 }
 990
 991 int ql4xxx_sem_spinlock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
 992 void ql4xxx_sem_unlock(struct scsi_qla_host * ha, u32 sem_mask);
 993 int ql4xxx_sem_lock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
 994
 995 static inline int ql4xxx_lock_flash(struct scsi_qla_host *a)
 996 {
 997         if (is_qla4010(a))
 998                 return ql4xxx_sem_spinlock(a, QL4010_FLASH_SEM_MASK,
 999                                            QL4010_FLASH_SEM_BITS);
1000         else
1001                 return ql4xxx_sem_spinlock(a, QL4022_FLASH_SEM_MASK,
1002                                            (QL4022_RESOURCE_BITS_BASE_CODE |
1003                                             (a->mac_index)) << 13);
1004 }
1005
1006 static inline void ql4xxx_unlock_flash(struct scsi_qla_host *a)
1007 {
1008         if (is_qla4010(a))
1009                 ql4xxx_sem_unlock(a, QL4010_FLASH_SEM_MASK);
1010         else
1011                 ql4xxx_sem_unlock(a, QL4022_FLASH_SEM_MASK);
1012 }
1013
1014 static inline int ql4xxx_lock_nvram(struct scsi_qla_host *a)
1015 {
1016         if (is_qla4010(a))
1017                 return ql4xxx_sem_spinlock(a, QL4010_NVRAM_SEM_MASK,
1018                                            QL4010_NVRAM_SEM_BITS);
1019         else
1020                 return ql4xxx_sem_spinlock(a, QL4022_NVRAM_SEM_MASK,
1021                                            (QL4022_RESOURCE_BITS_BASE_CODE |
1022                                             (a->mac_index)) << 10);
1023 }
1024
1025 static inline void ql4xxx_unlock_nvram(struct scsi_qla_host *a)
1026 {
1027         if (is_qla4010(a))
1028                 ql4xxx_sem_unlock(a, QL4010_NVRAM_SEM_MASK);
1029         else
1030                 ql4xxx_sem_unlock(a, QL4022_NVRAM_SEM_MASK);
1031 }
1032
1033 static inline int ql4xxx_lock_drvr(struct scsi_qla_host *a)
1034 {
1035         if (is_qla4010(a))
1036                 return ql4xxx_sem_lock(a, QL4010_DRVR_SEM_MASK,
1037                                        QL4010_DRVR_SEM_BITS);
1038         else
1039                 return ql4xxx_sem_lock(a, QL4022_DRVR_SEM_MASK,
1040                                        (QL4022_RESOURCE_BITS_BASE_CODE |
1041                                         (a->mac_index)) << 1);
1042 }
1043
1044 static inline void ql4xxx_unlock_drvr(struct scsi_qla_host *a)
1045 {
1046         if (is_qla4010(a))
1047                 ql4xxx_sem_unlock(a, QL4010_DRVR_SEM_MASK);
1048         else
1049                 ql4xxx_sem_unlock(a, QL4022_DRVR_SEM_MASK);
1050 }
1051
1052 static inline int ql4xxx_reset_active(struct scsi_qla_host *ha)
1053 {
1054         return test_bit(DPC_RESET_ACTIVE, &ha->dpc_flags) ||
1055                test_bit(DPC_RESET_HA, &ha->dpc_flags) ||
1056                test_bit(DPC_RETRY_RESET_HA, &ha->dpc_flags) ||
1057                test_bit(DPC_RESET_HA_INTR, &ha->dpc_flags) ||
1058                test_bit(DPC_RESET_HA_FW_CONTEXT, &ha->dpc_flags) ||
1059                test_bit(DPC_HA_UNRECOVERABLE, &ha->dpc_flags);
1060
1061 }
1062
1063 static inline int qla4_8xxx_rd_direct(struct scsi_qla_host *ha,
1064                                       const uint32_t crb_reg)
1065 {
1066         return ha->isp_ops->rd_reg_direct(ha, ha->reg_tbl[crb_reg]);
1067 }
1068
1069 static inline void qla4_8xxx_wr_direct(struct scsi_qla_host *ha,
1070                                        const uint32_t crb_reg,
1071                                        const uint32_t value)
1072 {
1073         ha->isp_ops->wr_reg_direct(ha, ha->reg_tbl[crb_reg], value);
1074 }
1075
1076 /*---------------------------------------------------------------------------*/
1077
1078 /* Defines for qla4xxx_initialize_adapter() and qla4xxx_recover_adapter() */
1079
1080 #define INIT_ADAPTER    0
1081 #define RESET_ADAPTER   1
1082
1083 #define PRESERVE_DDB_LIST       0
1084 #define REBUILD_DDB_LIST        1
1085
1086 /* Defines for process_aen() */
1087 #define PROCESS_ALL_AENS         0
1088 #define FLUSH_DDB_CHANGED_AENS   1
1089
1090 /* Defines for udev events */
1091 #define QL4_UEVENT_CODE_FW_DUMP         0
1092
1093 #endif  /*_QLA4XXX_H */