drivers/scsi/be2iscsi/be_main.h

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