drivers/scsi/be2iscsi/be_main.h

   1 /**
   2  * Copyright (C) 2005 - 2012 Emulex
   3  * All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License version 2
   7  * as published by the Free Software Foundation.  The full GNU General
   8  * Public License is included in this distribution in the file called COPYING.
   9  *
  10  * Written by: Jayamohan Kallickal (jayamohan.kallickal@emulex.com)
  11  *
  12  * Contact Information:
  13  * linux-drivers@emulex.com
  14  *
  15  * Emulex
  16  * 3333 Susan Street
  17  * Costa Mesa, CA 92626
  18  */
  19
  20 #ifndef _BEISCSI_MAIN_
  21 #define _BEISCSI_MAIN_
  22
  23 #include <linux/kernel.h>
  24 #include <linux/pci.h>
  25 #include <linux/if_ether.h>
  26 #include <linux/in.h>
  27 #include <linux/ctype.h>
  28 #include <linux/module.h>
  29 #include <scsi/scsi.h>
  30 #include <scsi/scsi_cmnd.h>
  31 #include <scsi/scsi_device.h>
  32 #include <scsi/scsi_host.h>
  33 #include <scsi/iscsi_proto.h>
  34 #include <scsi/libiscsi.h>
  35 #include <scsi/scsi_transport_iscsi.h>
  36
  37 #include "be.h"
  38 #define DRV_NAME                "be2iscsi"
  39 #define BUILD_STR               "4.4.58.0"
  40 #define BE_NAME                 "Emulex OneConnect" \
  41                                 "Open-iSCSI Driver version" BUILD_STR
  42 #define DRV_DESC                BE_NAME " " "Driver"
  43
  44 #define BE_VENDOR_ID            0x19A2
  45 #define ELX_VENDOR_ID           0x10DF
  46 /* DEVICE ID's for BE2 */
  47 #define BE_DEVICE_ID1           0x212
  48 #define OC_DEVICE_ID1           0x702
  49 #define OC_DEVICE_ID2           0x703
  50
  51 /* DEVICE ID's for BE3 */
  52 #define BE_DEVICE_ID2           0x222
  53 #define OC_DEVICE_ID3           0x712
  54
  55 /* DEVICE ID for SKH */
  56 #define OC_SKH_ID1              0x722
  57
  58 #define BE2_IO_DEPTH            1024
  59 #define BE2_MAX_SESSIONS        256
  60 #define BE2_CMDS_PER_CXN        128
  61 #define BE2_TMFS                16
  62 #define BE2_NOPOUT_REQ          16
  63 #define BE2_SGE                 32
  64 #define BE2_DEFPDU_HDR_SZ       64
  65 #define BE2_DEFPDU_DATA_SZ      8192
  66
  67 #define MAX_CPUS                64
  68 #define BEISCSI_MAX_NUM_CPUS    7
  69 #define OC_SKH_MAX_NUM_CPUS     63
  70
  71
  72 #define BEISCSI_SGLIST_ELEMENTS 30
  73
  74 #define BEISCSI_CMD_PER_LUN     128     /* scsi_host->cmd_per_lun */
  75 #define BEISCSI_MAX_SECTORS     2048    /* scsi_host->max_sectors */
  76
  77 #define BEISCSI_MAX_CMD_LEN     16      /* scsi_host->max_cmd_len */
  78 #define BEISCSI_NUM_MAX_LUN     256     /* scsi_host->max_lun */
  79 #define BEISCSI_NUM_DEVICES_SUPPORTED   0x01
  80 #define BEISCSI_MAX_FRAGS_INIT  192
  81 #define BE_NUM_MSIX_ENTRIES     1
  82
  83 #define MPU_EP_CONTROL          0
  84 #define MPU_EP_SEMAPHORE        0xac
  85 #define BE2_SOFT_RESET          0x5c
  86 #define BE2_PCI_ONLINE0         0xb0
  87 #define BE2_PCI_ONLINE1         0xb4
  88 #define BE2_SET_RESET           0x80
  89 #define BE2_MPU_IRAM_ONLINE     0x00000080
  90
  91 #define BE_SENSE_INFO_SIZE              258
  92 #define BE_ISCSI_PDU_HEADER_SIZE        64
  93 #define BE_MIN_MEM_SIZE                 16384
  94 #define MAX_CMD_SZ                      65536
  95 #define IIOC_SCSI_DATA                  0x05    /* Write Operation */
  96
  97 #define INVALID_SESS_HANDLE     0xFFFFFFFF
  98
  99 #define BE_ADAPTER_UP           0x00000000
 100 #define BE_ADAPTER_LINK_DOWN    0x00000001
 101 /**
 102  * hardware needs the async PDU buffers to be posted in multiples of 8
 103  * So have atleast 8 of them by default
 104  */
 105
 106 #define HWI_GET_ASYNC_PDU_CTX(phwi)     (phwi->phwi_ctxt->pasync_ctx)
 107
 108 /********* Memory BAR register ************/
 109 #define PCICFG_MEMBAR_CTRL_INT_CTRL_OFFSET      0xfc
 110 /**
 111  * Host Interrupt Enable, if set interrupts are enabled although "PCI Interrupt
 112  * Disable" may still globally block interrupts in addition to individual
 113  * interrupt masks; a mechanism for the device driver to block all interrupts
 114  * atomically without having to arbitrate for the PCI Interrupt Disable bit
 115  * with the OS.
 116  */
 117 #define MEMBAR_CTRL_INT_CTRL_HOSTINTR_MASK      (1 << 29)       /* bit 29 */
 118
 119 /********* ISR0 Register offset **********/
 120 #define CEV_ISR0_OFFSET                         0xC18
 121 #define CEV_ISR_SIZE                            4
 122
 123 /**
 124  * Macros for reading/writing a protection domain or CSR registers
 125  * in BladeEngine.
 126  */
 127
 128 #define DB_TXULP0_OFFSET 0x40
 129 #define DB_RXULP0_OFFSET 0xA0
 130 /********* Event Q door bell *************/
 131 #define DB_EQ_OFFSET                    DB_CQ_OFFSET
 132 #define DB_EQ_RING_ID_MASK              0x1FF   /* bits 0 - 8 */
 133 /* Clear the interrupt for this eq */
 134 #define DB_EQ_CLR_SHIFT                 (9)     /* bit 9 */
 135 /* Must be 1 */
 136 #define DB_EQ_EVNT_SHIFT                (10)    /* bit 10 */
 137 /* Number of event entries processed */
 138 #define DB_EQ_NUM_POPPED_SHIFT          (16)    /* bits 16 - 28 */
 139 /* Rearm bit */
 140 #define DB_EQ_REARM_SHIFT               (29)    /* bit 29 */
 141
 142 /********* Compl Q door bell *************/
 143 #define DB_CQ_OFFSET                    0x120
 144 #define DB_CQ_RING_ID_MASK              0x3FF   /* bits 0 - 9 */
 145 /* Number of event entries processed */
 146 #define DB_CQ_NUM_POPPED_SHIFT          (16)    /* bits 16 - 28 */
 147 /* Rearm bit */
 148 #define DB_CQ_REARM_SHIFT               (29)    /* bit 29 */
 149
 150 #define GET_HWI_CONTROLLER_WS(pc)       (pc->phwi_ctrlr)
 151 #define HWI_GET_DEF_BUFQ_ID(pc) (((struct hwi_controller *)\
 152                 (GET_HWI_CONTROLLER_WS(pc)))->default_pdu_data.id)
 153 #define HWI_GET_DEF_HDRQ_ID(pc) (((struct hwi_controller *)\
 154                 (GET_HWI_CONTROLLER_WS(pc)))->default_pdu_hdr.id)
 155
 156 #define PAGES_REQUIRED(x) \
 157         ((x < PAGE_SIZE) ? 1 :  ((x + PAGE_SIZE - 1) / PAGE_SIZE))
 158
 159 #define BEISCSI_MSI_NAME 20 /* size of msi_name string */
 160
 161 enum be_mem_enum {
 162         HWI_MEM_ADDN_CONTEXT,
 163         HWI_MEM_WRB,
 164         HWI_MEM_WRBH,
 165         HWI_MEM_SGLH,
 166         HWI_MEM_SGE,
 167         HWI_MEM_ASYNC_HEADER_BUF,       /* 5 */
 168         HWI_MEM_ASYNC_DATA_BUF,
 169         HWI_MEM_ASYNC_HEADER_RING,
 170         HWI_MEM_ASYNC_DATA_RING,
 171         HWI_MEM_ASYNC_HEADER_HANDLE,
 172         HWI_MEM_ASYNC_DATA_HANDLE,      /* 10 */
 173         HWI_MEM_ASYNC_PDU_CONTEXT,
 174         ISCSI_MEM_GLOBAL_HEADER,
 175         SE_MEM_MAX
 176 };
 177
 178 struct be_bus_address32 {
 179         unsigned int address_lo;
 180         unsigned int address_hi;
 181 };
 182
 183 struct be_bus_address64 {
 184         unsigned long long address;
 185 };
 186
 187 struct be_bus_address {
 188         union {
 189                 struct be_bus_address32 a32;
 190                 struct be_bus_address64 a64;
 191         } u;
 192 };
 193
 194 struct mem_array {
 195         struct be_bus_address bus_address;      /* Bus address of location */
 196         void *virtual_address;          /* virtual address to the location */
 197         unsigned int size;              /* Size required by memory block */
 198 };
 199
 200 struct be_mem_descriptor {
 201         unsigned int index;     /* Index of this memory parameter */
 202         unsigned int category;  /* type indicates cached/non-cached */
 203         unsigned int num_elements;      /* number of elements in this
 204                                          * descriptor
 205                                          */
 206         unsigned int alignment_mask;    /* Alignment mask for this block */
 207         unsigned int size_in_bytes;     /* Size required by memory block */
 208         struct mem_array *mem_array;
 209 };
 210
 211 struct sgl_handle {
 212         unsigned int sgl_index;
 213         unsigned int type;
 214         unsigned int cid;
 215         struct iscsi_task *task;
 216         struct iscsi_sge *pfrag;
 217 };
 218
 219 struct hba_parameters {
 220         unsigned int ios_per_ctrl;
 221         unsigned int cxns_per_ctrl;
 222         unsigned int asyncpdus_per_ctrl;
 223         unsigned int icds_per_ctrl;
 224         unsigned int num_sge_per_io;
 225         unsigned int defpdu_hdr_sz;
 226         unsigned int defpdu_data_sz;
 227         unsigned int num_cq_entries;
 228         unsigned int num_eq_entries;
 229         unsigned int wrbs_per_cxn;
 230         unsigned int crashmode;
 231         unsigned int hba_num;
 232
 233         unsigned int mgmt_ws_sz;
 234         unsigned int hwi_ws_sz;
 235
 236         unsigned int eto;
 237         unsigned int ldto;
 238
 239         unsigned int dbg_flags;
 240         unsigned int num_cxn;
 241
 242         unsigned int eq_timer;
 243         /**
 244          * These are calculated from other params. They're here
 245          * for debug purposes
 246          */
 247         unsigned int num_mcc_pages;
 248         unsigned int num_mcc_cq_pages;
 249         unsigned int num_cq_pages;
 250         unsigned int num_eq_pages;
 251
 252         unsigned int num_async_pdu_buf_pages;
 253         unsigned int num_async_pdu_buf_sgl_pages;
 254         unsigned int num_async_pdu_buf_cq_pages;
 255
 256         unsigned int num_async_pdu_hdr_pages;
 257         unsigned int num_async_pdu_hdr_sgl_pages;
 258         unsigned int num_async_pdu_hdr_cq_pages;
 259
 260         unsigned int num_sge;
 261 };
 262
 263 struct invalidate_command_table {
 264         unsigned short icd;
 265         unsigned short cid;
 266 } __packed;
 267
 268 #define chip_skh_r(pdev)        (pdev->device == OC_SKH_ID1)
 269 struct beiscsi_hba {
 270         struct hba_parameters params;
 271         struct hwi_controller *phwi_ctrlr;
 272         unsigned int mem_req[SE_MEM_MAX];
 273         /* PCI BAR mapped addresses */
 274         u8 __iomem *csr_va;     /* CSR */
 275         u8 __iomem *db_va;      /* Door  Bell  */
 276         u8 __iomem *pci_va;     /* PCI Config */
 277         struct be_bus_address csr_pa;   /* CSR */
 278         struct be_bus_address db_pa;    /* CSR */
 279         struct be_bus_address pci_pa;   /* CSR */
 280         /* PCI representation of our HBA */
 281         struct pci_dev *pcidev;
 282         unsigned int state;
 283         unsigned short asic_revision;
 284         unsigned int num_cpus;
 285         unsigned int nxt_cqid;
 286         struct msix_entry msix_entries[MAX_CPUS];
 287         char *msi_name[MAX_CPUS];
 288         bool msix_enabled;
 289         struct be_mem_descriptor *init_mem;
 290
 291         unsigned short io_sgl_alloc_index;
 292         unsigned short io_sgl_free_index;
 293         unsigned short io_sgl_hndl_avbl;
 294         struct sgl_handle **io_sgl_hndl_base;
 295         struct sgl_handle **sgl_hndl_array;
 296
 297         unsigned short eh_sgl_alloc_index;
 298         unsigned short eh_sgl_free_index;
 299         unsigned short eh_sgl_hndl_avbl;
 300         struct sgl_handle **eh_sgl_hndl_base;
 301         spinlock_t io_sgl_lock;
 302         spinlock_t mgmt_sgl_lock;
 303         spinlock_t isr_lock;
 304         unsigned int age;
 305         unsigned short avlbl_cids;
 306         unsigned short cid_alloc;
 307         unsigned short cid_free;
 308         struct beiscsi_conn *conn_table[BE2_MAX_SESSIONS * 2];
 309         struct list_head hba_queue;
 310         unsigned short *cid_array;
 311         struct iscsi_endpoint **ep_array;
 312         struct iscsi_boot_kset *boot_kset;
 313         struct Scsi_Host *shost;
 314         struct iscsi_iface *ipv4_iface;
 315         struct iscsi_iface *ipv6_iface;
 316         struct {
 317                 /**
 318                  * group together since they are used most frequently
 319                  * for cid to cri conversion
 320                  */
 321                 unsigned int iscsi_cid_start;
 322                 unsigned int phys_port;
 323
 324                 unsigned int isr_offset;
 325                 unsigned int iscsi_icd_start;
 326                 unsigned int iscsi_cid_count;
 327                 unsigned int iscsi_icd_count;
 328                 unsigned int pci_function;
 329
 330                 unsigned short cid_alloc;
 331                 unsigned short cid_free;
 332                 unsigned short avlbl_cids;
 333                 unsigned short iscsi_features;
 334                 spinlock_t cid_lock;
 335         } fw_config;
 336
 337         u8 mac_address[ETH_ALEN];
 338         char wq_name[20];
 339         struct workqueue_struct *wq;    /* The actuak work queue */
 340         struct be_ctrl_info ctrl;
 341         unsigned int generation;
 342         unsigned int interface_handle;
 343         struct mgmt_session_info boot_sess;
 344         struct invalidate_command_table inv_tbl[128];
 345
 346         unsigned int attr_log_enable;
 347         int (*iotask_fn)(struct iscsi_task *,
 348                         struct scatterlist *sg,
 349                         uint32_t num_sg, uint32_t xferlen,
 350                         uint32_t writedir);
 351 };
 352
 353 struct beiscsi_session {
 354         struct pci_pool *bhs_pool;
 355 };
 356
 357 /**
 358  * struct beiscsi_conn - iscsi connection structure
 359  */
 360 struct beiscsi_conn {
 361         struct iscsi_conn *conn;
 362         struct beiscsi_hba *phba;
 363         u32 exp_statsn;
 364         u32 beiscsi_conn_cid;
 365         struct beiscsi_endpoint *ep;
 366         unsigned short login_in_progress;
 367         struct wrb_handle *plogin_wrb_handle;
 368         struct sgl_handle *plogin_sgl_handle;
 369         struct beiscsi_session *beiscsi_sess;
 370         struct iscsi_task *task;
 371 };
 372
 373 /* This structure is used by the chip */
 374 struct pdu_data_out {
 375         u32 dw[12];
 376 };
 377 /**
 378  * Pseudo amap definition in which each bit of the actual structure is defined
 379  * as a byte: used to calculate offset/shift/mask of each field
 380  */
 381 struct amap_pdu_data_out {
 382         u8 opcode[6];           /* opcode */
 383         u8 rsvd0[2];            /* should be 0 */
 384         u8 rsvd1[7];
 385         u8 final_bit;           /* F bit */
 386         u8 rsvd2[16];
 387         u8 ahs_length[8];       /* no AHS */
 388         u8 data_len_hi[8];
 389         u8 data_len_lo[16];     /* DataSegmentLength */
 390         u8 lun[64];
 391         u8 itt[32];             /* ITT; initiator task tag */
 392         u8 ttt[32];             /* TTT; valid for R2T or 0xffffffff */
 393         u8 rsvd3[32];
 394         u8 exp_stat_sn[32];
 395         u8 rsvd4[32];
 396         u8 data_sn[32];
 397         u8 buffer_offset[32];
 398         u8 rsvd5[32];
 399 };
 400
 401 struct be_cmd_bhs {
 402         struct iscsi_scsi_req iscsi_hdr;
 403         unsigned char pad1[16];
 404         struct pdu_data_out iscsi_data_pdu;
 405         unsigned char pad2[BE_SENSE_INFO_SIZE -
 406                         sizeof(struct pdu_data_out)];
 407 };
 408
 409 struct beiscsi_io_task {
 410         struct wrb_handle *pwrb_handle;
 411         struct sgl_handle *psgl_handle;
 412         struct beiscsi_conn *conn;
 413         struct scsi_cmnd *scsi_cmnd;
 414         unsigned int cmd_sn;
 415         unsigned int flags;
 416         unsigned short cid;
 417         unsigned short header_len;
 418         itt_t libiscsi_itt;
 419         struct be_cmd_bhs *cmd_bhs;
 420         struct be_bus_address bhs_pa;
 421         unsigned short bhs_len;
 422         dma_addr_t mtask_addr;
 423         uint32_t mtask_data_count;
 424         uint8_t wrb_type;
 425 };
 426
 427 struct be_nonio_bhs {
 428         struct iscsi_hdr iscsi_hdr;
 429         unsigned char pad1[16];
 430         struct pdu_data_out iscsi_data_pdu;
 431         unsigned char pad2[BE_SENSE_INFO_SIZE -
 432                         sizeof(struct pdu_data_out)];
 433 };
 434
 435 struct be_status_bhs {
 436         struct iscsi_scsi_req iscsi_hdr;
 437         unsigned char pad1[16];
 438         /**
 439          * The plus 2 below is to hold the sense info length that gets
 440          * DMA'ed by RxULP
 441          */
 442         unsigned char sense_info[BE_SENSE_INFO_SIZE];
 443 };
 444
 445 struct iscsi_sge {
 446         u32 dw[4];
 447 };
 448
 449 /**
 450  * Pseudo amap definition in which each bit of the actual structure is defined
 451  * as a byte: used to calculate offset/shift/mask of each field
 452  */
 453 struct amap_iscsi_sge {
 454         u8 addr_hi[32];
 455         u8 addr_lo[32];
 456         u8 sge_offset[22];      /* DWORD 2 */
 457         u8 rsvd0[9];            /* DWORD 2 */
 458         u8 last_sge;            /* DWORD 2 */
 459         u8 len[17];             /* DWORD 3 */
 460         u8 rsvd1[15];           /* DWORD 3 */
 461 };
 462
 463 struct beiscsi_offload_params {
 464         u32 dw[5];
 465 };
 466
 467 #define OFFLD_PARAMS_ERL        0x00000003
 468 #define OFFLD_PARAMS_DDE        0x00000004
 469 #define OFFLD_PARAMS_HDE        0x00000008
 470 #define OFFLD_PARAMS_IR2T       0x00000010
 471 #define OFFLD_PARAMS_IMD        0x00000020
 472 #define OFFLD_PARAMS_DATA_SEQ_INORDER   0x00000040
 473 #define OFFLD_PARAMS_PDU_SEQ_INORDER    0x00000080
 474 #define OFFLD_PARAMS_MAX_R2T 0x00FFFF00
 475
 476 /**
 477  * Pseudo amap definition in which each bit of the actual structure is defined
 478  * as a byte: used to calculate offset/shift/mask of each field
 479  */
 480 struct amap_beiscsi_offload_params {
 481         u8 max_burst_length[32];
 482         u8 max_send_data_segment_length[32];
 483         u8 first_burst_length[32];
 484         u8 erl[2];
 485         u8 dde[1];
 486         u8 hde[1];
 487         u8 ir2t[1];
 488         u8 imd[1];
 489         u8 data_seq_inorder[1];
 490         u8 pdu_seq_inorder[1];
 491         u8 max_r2t[16];
 492         u8 pad[8];
 493         u8 exp_statsn[32];
 494 };
 495
 496 /* void hwi_complete_drvr_msgs(struct beiscsi_conn *beiscsi_conn,
 497                 struct beiscsi_hba *phba, struct sol_cqe *psol);*/
 498
 499 struct async_pdu_handle {
 500         struct list_head link;
 501         struct be_bus_address pa;
 502         void *pbuffer;
 503         unsigned int consumed;
 504         unsigned char index;
 505         unsigned char is_header;
 506         unsigned short cri;
 507         unsigned long buffer_len;
 508 };
 509
 510 struct hwi_async_entry {
 511         struct {
 512                 unsigned char hdr_received;
 513                 unsigned char hdr_len;
 514                 unsigned short bytes_received;
 515                 unsigned int bytes_needed;
 516                 struct list_head list;
 517         } wait_queue;
 518
 519         struct list_head header_busy_list;
 520         struct list_head data_busy_list;
 521 };
 522
 523 struct hwi_async_pdu_context {
 524         struct {
 525                 struct be_bus_address pa_base;
 526                 void *va_base;
 527                 void *ring_base;
 528                 struct async_pdu_handle *handle_base;
 529
 530                 unsigned int host_write_ptr;
 531                 unsigned int ep_read_ptr;
 532                 unsigned int writables;
 533
 534                 unsigned int free_entries;
 535                 unsigned int busy_entries;
 536
 537                 struct list_head free_list;
 538         } async_header;
 539
 540         struct {
 541                 struct be_bus_address pa_base;
 542                 void *va_base;
 543                 void *ring_base;
 544                 struct async_pdu_handle *handle_base;
 545
 546                 unsigned int host_write_ptr;
 547                 unsigned int ep_read_ptr;
 548                 unsigned int writables;
 549
 550                 unsigned int free_entries;
 551                 unsigned int busy_entries;
 552                 struct list_head free_list;
 553         } async_data;
 554
 555         unsigned int buffer_size;
 556         unsigned int num_entries;
 557
 558         /**
 559          * This is a varying size list! Do not add anything
 560          * after this entry!!
 561          */
 562         struct hwi_async_entry async_entry[BE2_MAX_SESSIONS * 2];
 563 };
 564
 565 #define PDUCQE_CODE_MASK        0x0000003F
 566 #define PDUCQE_DPL_MASK         0xFFFF0000
 567 #define PDUCQE_INDEX_MASK       0x0000FFFF
 568
 569 struct i_t_dpdu_cqe {
 570         u32 dw[4];
 571 } __packed;
 572
 573 /**
 574  * Pseudo amap definition in which each bit of the actual structure is defined
 575  * as a byte: used to calculate offset/shift/mask of each field
 576  */
 577 struct amap_i_t_dpdu_cqe {
 578         u8 db_addr_hi[32];
 579         u8 db_addr_lo[32];
 580         u8 code[6];
 581         u8 cid[10];
 582         u8 dpl[16];
 583         u8 index[16];
 584         u8 num_cons[10];
 585         u8 rsvd0[4];
 586         u8 final;
 587         u8 valid;
 588 } __packed;
 589
 590 struct amap_i_t_dpdu_cqe_v2 {
 591         u8 db_addr_hi[32];  /* DWORD 0 */
 592         u8 db_addr_lo[32];  /* DWORD 1 */
 593         u8 code[6]; /* DWORD 2 */
 594         u8 num_cons; /* DWORD 2*/
 595         u8 rsvd0[8]; /* DWORD 2 */
 596         u8 dpl[17]; /* DWORD 2 */
 597         u8 index[16]; /* DWORD 3 */
 598         u8 cid[13]; /* DWORD 3 */
 599         u8 rsvd1; /* DWORD 3 */
 600         u8 final; /* DWORD 3 */
 601         u8 valid; /* DWORD 3 */
 602 } __packed;
 603
 604 #define CQE_VALID_MASK  0x80000000
 605 #define CQE_CODE_MASK   0x0000003F
 606 #define CQE_CID_MASK    0x0000FFC0
 607
 608 #define EQE_VALID_MASK          0x00000001
 609 #define EQE_MAJORCODE_MASK      0x0000000E
 610 #define EQE_RESID_MASK          0xFFFF0000
 611
 612 struct be_eq_entry {
 613         u32 dw[1];
 614 } __packed;
 615
 616 /**
 617  * Pseudo amap definition in which each bit of the actual structure is defined
 618  * as a byte: used to calculate offset/shift/mask of each field
 619  */
 620 struct amap_eq_entry {
 621         u8 valid;               /* DWORD 0 */
 622         u8 major_code[3];       /* DWORD 0 */
 623         u8 minor_code[12];      /* DWORD 0 */
 624         u8 resource_id[16];     /* DWORD 0 */
 625
 626 } __packed;
 627
 628 struct cq_db {
 629         u32 dw[1];
 630 } __packed;
 631
 632 /**
 633  * Pseudo amap definition in which each bit of the actual structure is defined
 634  * as a byte: used to calculate offset/shift/mask of each field
 635  */
 636 struct amap_cq_db {
 637         u8 qid[10];
 638         u8 event[1];
 639         u8 rsvd0[5];
 640         u8 num_popped[13];
 641         u8 rearm[1];
 642         u8 rsvd1[2];
 643 } __packed;
 644
 645 void beiscsi_process_eq(struct beiscsi_hba *phba);
 646
 647 struct iscsi_wrb {
 648         u32 dw[16];
 649 } __packed;
 650
 651 #define WRB_TYPE_MASK 0xF0000000
 652 #define SKH_WRB_TYPE_OFFSET 27
 653 #define BE_WRB_TYPE_OFFSET  28
 654
 655 #define ADAPTER_SET_WRB_TYPE(pwrb, wrb_type, type_offset) \
 656                 (pwrb->dw[0] |= (wrb_type << type_offset))
 657
 658 /**
 659  * Pseudo amap definition in which each bit of the actual structure is defined
 660  * as a byte: used to calculate offset/shift/mask of each field
 661  */
 662 struct amap_iscsi_wrb {
 663         u8 lun[14];             /* DWORD 0 */
 664         u8 lt;                  /* DWORD 0 */
 665         u8 invld;               /* DWORD 0 */
 666         u8 wrb_idx[8];          /* DWORD 0 */
 667         u8 dsp;                 /* DWORD 0 */
 668         u8 dmsg;                /* DWORD 0 */
 669         u8 undr_run;            /* DWORD 0 */
 670         u8 over_run;            /* DWORD 0 */
 671         u8 type[4];             /* DWORD 0 */
 672         u8 ptr2nextwrb[8];      /* DWORD 1 */
 673         u8 r2t_exp_dtl[24];     /* DWORD 1 */
 674         u8 sgl_icd_idx[12];     /* DWORD 2 */
 675         u8 rsvd0[20];           /* DWORD 2 */
 676         u8 exp_data_sn[32];     /* DWORD 3 */
 677         u8 iscsi_bhs_addr_hi[32];       /* DWORD 4 */
 678         u8 iscsi_bhs_addr_lo[32];       /* DWORD 5 */
 679         u8 cmdsn_itt[32];       /* DWORD 6 */
 680         u8 dif_ref_tag[32];     /* DWORD 7 */
 681         u8 sge0_addr_hi[32];    /* DWORD 8 */
 682         u8 sge0_addr_lo[32];    /* DWORD 9  */
 683         u8 sge0_offset[22];     /* DWORD 10 */
 684         u8 pbs;                 /* DWORD 10 */
 685         u8 dif_mode[2];         /* DWORD 10 */
 686         u8 rsvd1[6];            /* DWORD 10 */
 687         u8 sge0_last;           /* DWORD 10 */
 688         u8 sge0_len[17];        /* DWORD 11 */
 689         u8 dif_meta_tag[14];    /* DWORD 11 */
 690         u8 sge0_in_ddr;         /* DWORD 11 */
 691         u8 sge1_addr_hi[32];    /* DWORD 12 */
 692         u8 sge1_addr_lo[32];    /* DWORD 13 */
 693         u8 sge1_r2t_offset[22]; /* DWORD 14 */
 694         u8 rsvd2[9];            /* DWORD 14 */
 695         u8 sge1_last;           /* DWORD 14 */
 696         u8 sge1_len[17];        /* DWORD 15 */
 697         u8 ref_sgl_icd_idx[12]; /* DWORD 15 */
 698         u8 rsvd3[2];            /* DWORD 15 */
 699         u8 sge1_in_ddr;         /* DWORD 15 */
 700
 701 } __packed;
 702
 703 struct amap_iscsi_wrb_v2 {
 704         u8 r2t_exp_dtl[25]; /* DWORD 0 */
 705         u8 rsvd0[2];    /* DWORD 0*/
 706         u8 type[5];     /* DWORD 0 */
 707         u8 ptr2nextwrb[8];  /* DWORD 1 */
 708         u8 wrb_idx[8];      /* DWORD 1 */
 709         u8 lun[16];     /* DWORD 1 */
 710         u8 sgl_idx[16]; /* DWORD 2 */
 711         u8 ref_sgl_icd_idx[16]; /* DWORD 2 */
 712         u8 exp_data_sn[32]; /* DWORD 3 */
 713         u8 iscsi_bhs_addr_hi[32];   /* DWORD 4 */
 714         u8 iscsi_bhs_addr_lo[32];   /* DWORD 5 */
 715         u8 cq_id[16];   /* DWORD 6 */
 716         u8 rsvd1[16];   /* DWORD 6 */
 717         u8 cmdsn_itt[32];   /* DWORD 7 */
 718         u8 sge0_addr_hi[32];    /* DWORD 8 */
 719         u8 sge0_addr_lo[32];    /* DWORD 9 */
 720         u8 sge0_offset[24]; /* DWORD 10 */
 721         u8 rsvd2[7];    /* DWORD 10 */
 722         u8 sge0_last;   /* DWORD 10 */
 723         u8 sge0_len[17];    /* DWORD 11 */
 724         u8 rsvd3[7];    /* DWORD 11 */
 725         u8 diff_enbl;   /* DWORD 11 */
 726         u8 u_run;       /* DWORD 11 */
 727         u8 o_run;       /* DWORD 11 */
 728         u8 invalid;     /* DWORD 11 */
 729         u8 dsp;         /* DWORD 11 */
 730         u8 dmsg;        /* DWORD 11 */
 731         u8 rsvd4;       /* DWORD 11 */
 732         u8 lt;          /* DWORD 11 */
 733         u8 sge1_addr_hi[32];    /* DWORD 12 */
 734         u8 sge1_addr_lo[32];    /* DWORD 13 */
 735         u8 sge1_r2t_offset[24]; /* DWORD 14 */
 736         u8 rsvd5[7];    /* DWORD 14 */
 737         u8 sge1_last;   /* DWORD 14 */
 738         u8 sge1_len[17];    /* DWORD 15 */
 739         u8 rsvd6[15];   /* DWORD 15 */
 740 } __packed;
 741
 742
 743 struct wrb_handle *alloc_wrb_handle(struct beiscsi_hba *phba, unsigned int cid);
 744 void
 745 free_mgmt_sgl_handle(struct beiscsi_hba *phba, struct sgl_handle *psgl_handle);
 746
 747 void beiscsi_process_all_cqs(struct work_struct *work);
 748
 749 struct pdu_nop_out {
 750         u32 dw[12];
 751 };
 752
 753 /**
 754  * Pseudo amap definition in which each bit of the actual structure is defined
 755  * as a byte: used to calculate offset/shift/mask of each field
 756  */
 757 struct amap_pdu_nop_out {
 758         u8 opcode[6];           /* opcode 0x00 */
 759         u8 i_bit;               /* I Bit */
 760         u8 x_bit;               /* reserved; should be 0 */
 761         u8 fp_bit_filler1[7];
 762         u8 f_bit;               /* always 1 */
 763         u8 reserved1[16];
 764         u8 ahs_length[8];       /* no AHS */
 765         u8 data_len_hi[8];
 766         u8 data_len_lo[16];     /* DataSegmentLength */
 767         u8 lun[64];
 768         u8 itt[32];             /* initiator id for ping or 0xffffffff */
 769         u8 ttt[32];             /* target id for ping or 0xffffffff */
 770         u8 cmd_sn[32];
 771         u8 exp_stat_sn[32];
 772         u8 reserved5[128];
 773 };
 774
 775 #define PDUBASE_OPCODE_MASK     0x0000003F
 776 #define PDUBASE_DATALENHI_MASK  0x0000FF00
 777 #define PDUBASE_DATALENLO_MASK  0xFFFF0000
 778
 779 struct pdu_base {
 780         u32 dw[16];
 781 } __packed;
 782
 783 /**
 784  * Pseudo amap definition in which each bit of the actual structure is defined
 785  * as a byte: used to calculate offset/shift/mask of each field
 786  */
 787 struct amap_pdu_base {
 788         u8 opcode[6];
 789         u8 i_bit;               /* immediate bit */
 790         u8 x_bit;               /* reserved, always 0 */
 791         u8 reserved1[24];       /* opcode-specific fields */
 792         u8 ahs_length[8];       /* length units is 4 byte words */
 793         u8 data_len_hi[8];
 794         u8 data_len_lo[16];     /* DatasegmentLength */
 795         u8 lun[64];             /* lun or opcode-specific fields */
 796         u8 itt[32];             /* initiator task tag */
 797         u8 reserved4[224];
 798 };
 799
 800 struct iscsi_target_context_update_wrb {
 801         u32 dw[16];
 802 } __packed;
 803
 804 /**
 805  * Pseudo amap definition in which each bit of the actual structure is defined
 806  * as a byte: used to calculate offset/shift/mask of each field
 807  */
 808 #define BE_TGT_CTX_UPDT_CMD 0x07
 809 struct amap_iscsi_target_context_update_wrb {
 810         u8 lun[14];             /* DWORD 0 */
 811         u8 lt;                  /* DWORD 0 */
 812         u8 invld;               /* DWORD 0 */
 813         u8 wrb_idx[8];          /* DWORD 0 */
 814         u8 dsp;                 /* DWORD 0 */
 815         u8 dmsg;                /* DWORD 0 */
 816         u8 undr_run;            /* DWORD 0 */
 817         u8 over_run;            /* DWORD 0 */
 818         u8 type[4];             /* DWORD 0 */
 819         u8 ptr2nextwrb[8];      /* DWORD 1 */
 820         u8 max_burst_length[19];        /* DWORD 1 */
 821         u8 rsvd0[5];            /* DWORD 1 */
 822         u8 rsvd1[15];           /* DWORD 2 */
 823         u8 max_send_data_segment_length[17];    /* DWORD 2 */
 824         u8 first_burst_length[14];      /* DWORD 3 */
 825         u8 rsvd2[2];            /* DWORD 3 */
 826         u8 tx_wrbindex_drv_msg[8];      /* DWORD 3 */
 827         u8 rsvd3[5];            /* DWORD 3 */
 828         u8 session_state[3];    /* DWORD 3 */
 829         u8 rsvd4[16];           /* DWORD 4 */
 830         u8 tx_jumbo;            /* DWORD 4 */
 831         u8 hde;                 /* DWORD 4 */
 832         u8 dde;                 /* DWORD 4 */
 833         u8 erl[2];              /* DWORD 4 */
 834         u8 domain_id[5];                /* DWORD 4 */
 835         u8 mode;                /* DWORD 4 */
 836         u8 imd;                 /* DWORD 4 */
 837         u8 ir2t;                /* DWORD 4 */
 838         u8 notpredblq[2];       /* DWORD 4 */
 839         u8 compltonack;         /* DWORD 4 */
 840         u8 stat_sn[32];         /* DWORD 5 */
 841         u8 pad_buffer_addr_hi[32];      /* DWORD 6 */
 842         u8 pad_buffer_addr_lo[32];      /* DWORD 7 */
 843         u8 pad_addr_hi[32];     /* DWORD 8 */
 844         u8 pad_addr_lo[32];     /* DWORD 9 */
 845         u8 rsvd5[32];           /* DWORD 10 */
 846         u8 rsvd6[32];           /* DWORD 11 */
 847         u8 rsvd7[32];           /* DWORD 12 */
 848         u8 rsvd8[32];           /* DWORD 13 */
 849         u8 rsvd9[32];           /* DWORD 14 */
 850         u8 rsvd10[32];          /* DWORD 15 */
 851
 852 } __packed;
 853
 854 #define BEISCSI_MAX_RECV_DATASEG_LEN    (64 * 1024)
 855 #define BEISCSI_MAX_CXNS    1
 856 struct amap_iscsi_target_context_update_wrb_v2 {
 857         u8 max_burst_length[24];    /* DWORD 0 */
 858         u8 rsvd0[3];    /* DWORD 0 */
 859         u8 type[5];     /* DWORD 0 */
 860         u8 ptr2nextwrb[8];  /* DWORD 1 */
 861         u8 wrb_idx[8];      /* DWORD 1 */
 862         u8 rsvd1[16];       /* DWORD 1 */
 863         u8 max_send_data_segment_length[24];    /* DWORD 2 */
 864         u8 rsvd2[8];    /* DWORD 2 */
 865         u8 first_burst_length[24]; /* DWORD 3 */
 866         u8 rsvd3[8]; /* DOWRD 3 */
 867         u8 max_r2t[16]; /* DWORD 4 */
 868         u8 rsvd4[10];   /* DWORD 4 */
 869         u8 hde;         /* DWORD 4 */
 870         u8 dde;         /* DWORD 4 */
 871         u8 erl[2];      /* DWORD 4 */
 872         u8 imd;         /* DWORD 4 */
 873         u8 ir2t;        /* DWORD 4 */
 874         u8 stat_sn[32];     /* DWORD 5 */
 875         u8 rsvd5[32];   /* DWORD 6 */
 876         u8 rsvd6[32];   /* DWORD 7 */
 877         u8 max_recv_dataseg_len[24];    /* DWORD 8 */
 878         u8 rsvd7[8]; /* DWORD 8 */
 879         u8 rsvd8[32];   /* DWORD 9 */
 880         u8 rsvd9[32];   /* DWORD 10 */
 881         u8 max_cxns[16]; /* DWORD 11 */
 882         u8 rsvd10[11]; /* DWORD  11*/
 883         u8 invld; /* DWORD 11 */
 884         u8 rsvd11;/* DWORD 11*/
 885         u8 dmsg; /* DWORD 11 */
 886         u8 data_seq_inorder; /* DWORD 11 */
 887         u8 pdu_seq_inorder; /* DWORD 11 */
 888         u8 rsvd12[32]; /*DWORD 12 */
 889         u8 rsvd13[32]; /* DWORD 13 */
 890         u8 rsvd14[32]; /* DWORD 14 */
 891         u8 rsvd15[32]; /* DWORD 15 */
 892 } __packed;
 893
 894
 895 struct be_ring {
 896         u32 pages;              /* queue size in pages */
 897         u32 id;                 /* queue id assigned by beklib */
 898         u32 num;                /* number of elements in queue */
 899         u32 cidx;               /* consumer index */
 900         u32 pidx;               /* producer index -- not used by most rings */
 901         u32 item_size;          /* size in bytes of one object */
 902
 903         void *va;               /* The virtual address of the ring.  This
 904                                  * should be last to allow 32 & 64 bit debugger
 905                                  * extensions to work.
 906                                  */
 907 };
 908
 909 struct hwi_wrb_context {
 910         struct list_head wrb_handle_list;
 911         struct list_head wrb_handle_drvr_list;
 912         struct wrb_handle **pwrb_handle_base;
 913         struct wrb_handle **pwrb_handle_basestd;
 914         struct iscsi_wrb *plast_wrb;
 915         unsigned short alloc_index;
 916         unsigned short free_index;
 917         unsigned short wrb_handles_available;
 918         unsigned short cid;
 919 };
 920
 921 struct hwi_controller {
 922         struct list_head io_sgl_list;
 923         struct list_head eh_sgl_list;
 924         struct sgl_handle *psgl_handle_base;
 925         unsigned int wrb_mem_index;
 926
 927         struct hwi_wrb_context wrb_context[BE2_MAX_SESSIONS * 2];
 928         struct mcc_wrb *pmcc_wrb_base;
 929         struct be_ring default_pdu_hdr;
 930         struct be_ring default_pdu_data;
 931         struct hwi_context_memory *phwi_ctxt;
 932 };
 933
 934 enum hwh_type_enum {
 935         HWH_TYPE_IO = 1,
 936         HWH_TYPE_LOGOUT = 2,
 937         HWH_TYPE_TMF = 3,
 938         HWH_TYPE_NOP = 4,
 939         HWH_TYPE_IO_RD = 5,
 940         HWH_TYPE_LOGIN = 11,
 941         HWH_TYPE_INVALID = 0xFFFFFFFF
 942 };
 943
 944 struct wrb_handle {
 945         enum hwh_type_enum type;
 946         unsigned short wrb_index;
 947         unsigned short nxt_wrb_index;
 948
 949         struct iscsi_task *pio_handle;
 950         struct iscsi_wrb *pwrb;
 951 };
 952
 953 struct hwi_context_memory {
 954         /* Adaptive interrupt coalescing (AIC) info */
 955         u16 min_eqd;            /* in usecs */
 956         u16 max_eqd;            /* in usecs */
 957         u16 cur_eqd;            /* in usecs */
 958         struct be_eq_obj be_eq[MAX_CPUS];
 959         struct be_queue_info be_cq[MAX_CPUS - 1];
 960
 961         struct be_queue_info be_def_hdrq;
 962         struct be_queue_info be_def_dataq;
 963
 964         struct be_queue_info be_wrbq[BE2_MAX_SESSIONS];
 965         struct be_mcc_wrb_context *pbe_mcc_context;
 966
 967         struct hwi_async_pdu_context *pasync_ctx;
 968 };
 969
 970 /* Logging related definitions */
 971 #define BEISCSI_LOG_INIT        0x0001  /* Initialization events */
 972 #define BEISCSI_LOG_MBOX        0x0002  /* Mailbox Events */
 973 #define BEISCSI_LOG_MISC        0x0004  /* Miscllaneous Events */
 974 #define BEISCSI_LOG_EH          0x0008  /* Error Handler */
 975 #define BEISCSI_LOG_IO          0x0010  /* IO Code Path */
 976 #define BEISCSI_LOG_CONFIG      0x0020  /* CONFIG Code Path */
 977
 978 #define beiscsi_log(phba, level, mask, fmt, arg...) \
 979 do { \
 980         uint32_t log_value = phba->attr_log_enable; \
 981                 if (((mask) & log_value) || (level[1] <= '3')) \
 982                         shost_printk(level, phba->shost, \
 983                                      fmt, __LINE__, ##arg); \
 984 } while (0)
 985
 986 #endif