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