V4L/DVB (12291): b2c2: fix frontends compiled into kernel
[linux-2.6] / drivers / scsi / lpfc / lpfc_sli4.h
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2009 Emulex.  All rights reserved.                *
5  * EMULEX and SLI are trademarks of Emulex.                        *
6  * www.emulex.com                                                  *
7  *                                                                 *
8  * This program is free software; you can redistribute it and/or   *
9  * modify it under the terms of version 2 of the GNU General       *
10  * Public License as published by the Free Software Foundation.    *
11  * This program is distributed in the hope that it will be useful. *
12  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
13  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
14  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
15  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
16  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
17  * more details, a copy of which can be found in the file COPYING  *
18  * included with this package.                                     *
19  *******************************************************************/
20
21 #define LPFC_ACTIVE_MBOX_WAIT_CNT               100
22 #define LPFC_RELEASE_NOTIFICATION_INTERVAL      32
23 #define LPFC_GET_QE_REL_INT                     32
24 #define LPFC_RPI_LOW_WATER_MARK                 10
25 /* Number of SGL entries can be posted in a 4KB nonembedded mbox command */
26 #define LPFC_NEMBED_MBOX_SGL_CNT                254
27
28 /* Multi-queue arrangement for fast-path FCP work queues */
29 #define LPFC_FN_EQN_MAX       8
30 #define LPFC_SP_EQN_DEF       1
31 #define LPFC_FP_EQN_DEF       1
32 #define LPFC_FP_EQN_MIN       1
33 #define LPFC_FP_EQN_MAX       (LPFC_FN_EQN_MAX - LPFC_SP_EQN_DEF)
34
35 #define LPFC_FN_WQN_MAX       32
36 #define LPFC_SP_WQN_DEF       1
37 #define LPFC_FP_WQN_DEF       4
38 #define LPFC_FP_WQN_MIN       1
39 #define LPFC_FP_WQN_MAX       (LPFC_FN_WQN_MAX - LPFC_SP_WQN_DEF)
40
41 /*
42  * Provide the default FCF Record attributes used by the driver
43  * when nonFIP mode is configured and there is no other default
44  * FCF Record attributes.
45  */
46 #define LPFC_FCOE_FCF_DEF_INDEX 0
47 #define LPFC_FCOE_FCF_GET_FIRST 0xFFFF
48 #define LPFC_FCOE_FCF_NEXT_NONE 0xFFFF
49
50 /* First 3 bytes of default FCF MAC is specified by FC_MAP */
51 #define LPFC_FCOE_FCF_MAC3      0xFF
52 #define LPFC_FCOE_FCF_MAC4      0xFF
53 #define LPFC_FCOE_FCF_MAC5      0xFE
54 #define LPFC_FCOE_FCF_MAP0      0x0E
55 #define LPFC_FCOE_FCF_MAP1      0xFC
56 #define LPFC_FCOE_FCF_MAP2      0x00
57 #define LPFC_FCOE_MAX_RCV_SIZE  0x5AC
58 #define LPFC_FCOE_FKA_ADV_PER   0
59 #define LPFC_FCOE_FIP_PRIORITY  0x80
60
61 enum lpfc_sli4_queue_type {
62         LPFC_EQ,
63         LPFC_GCQ,
64         LPFC_MCQ,
65         LPFC_WCQ,
66         LPFC_RCQ,
67         LPFC_MQ,
68         LPFC_WQ,
69         LPFC_HRQ,
70         LPFC_DRQ
71 };
72
73 /* The queue sub-type defines the functional purpose of the queue */
74 enum lpfc_sli4_queue_subtype {
75         LPFC_NONE,
76         LPFC_MBOX,
77         LPFC_FCP,
78         LPFC_ELS,
79         LPFC_USOL
80 };
81
82 union sli4_qe {
83         void *address;
84         struct lpfc_eqe *eqe;
85         struct lpfc_cqe *cqe;
86         struct lpfc_mcqe *mcqe;
87         struct lpfc_wcqe_complete *wcqe_complete;
88         struct lpfc_wcqe_release *wcqe_release;
89         struct sli4_wcqe_xri_aborted *wcqe_xri_aborted;
90         struct lpfc_rcqe_complete *rcqe_complete;
91         struct lpfc_mqe *mqe;
92         union  lpfc_wqe *wqe;
93         struct lpfc_rqe *rqe;
94 };
95
96 struct lpfc_queue {
97         struct list_head list;
98         enum lpfc_sli4_queue_type type;
99         enum lpfc_sli4_queue_subtype subtype;
100         struct lpfc_hba *phba;
101         struct list_head child_list;
102         uint32_t entry_count;   /* Number of entries to support on the queue */
103         uint32_t entry_size;    /* Size of each queue entry. */
104         uint32_t queue_id;      /* Queue ID assigned by the hardware */
105         struct list_head page_list;
106         uint32_t page_count;    /* Number of pages allocated for this queue */
107
108         uint32_t host_index;    /* The host's index for putting or getting */
109         uint32_t hba_index;     /* The last known hba index for get or put */
110         union sli4_qe qe[1];    /* array to index entries (must be last) */
111 };
112
113 struct lpfc_cq_event {
114         struct list_head list;
115         union {
116                 struct lpfc_mcqe                mcqe_cmpl;
117                 struct lpfc_acqe_link           acqe_link;
118                 struct lpfc_acqe_fcoe           acqe_fcoe;
119                 struct lpfc_acqe_dcbx           acqe_dcbx;
120                 struct lpfc_rcqe                rcqe_cmpl;
121                 struct sli4_wcqe_xri_aborted    wcqe_axri;
122         } cqe;
123 };
124
125 struct lpfc_sli4_link {
126         uint8_t speed;
127         uint8_t duplex;
128         uint8_t status;
129         uint8_t physical;
130         uint8_t fault;
131 };
132
133 struct lpfc_fcf {
134         uint8_t  fabric_name[8];
135         uint8_t  mac_addr[6];
136         uint16_t fcf_indx;
137         uint16_t fcfi;
138         uint32_t fcf_flag;
139 #define FCF_AVAILABLE   0x01 /* FCF available for discovery */
140 #define FCF_REGISTERED  0x02 /* FCF registered with FW */
141 #define FCF_DISCOVERED  0x04 /* FCF discovery started  */
142 #define FCF_BOOT_ENABLE 0x08 /* Boot bios use this FCF */
143 #define FCF_IN_USE      0x10 /* Atleast one discovery completed */
144 #define FCF_VALID_VLAN  0x20 /* Use the vlan id specified */
145         uint32_t priority;
146         uint32_t addr_mode;
147         uint16_t vlan_id;
148 };
149
150 #define LPFC_REGION23_SIGNATURE "RG23"
151 #define LPFC_REGION23_VERSION   1
152 #define LPFC_REGION23_LAST_REC  0xff
153 struct lpfc_fip_param_hdr {
154         uint8_t type;
155 #define FCOE_PARAM_TYPE         0xA0
156         uint8_t length;
157 #define FCOE_PARAM_LENGTH       2
158         uint8_t parm_version;
159 #define FIPP_VERSION            0x01
160         uint8_t parm_flags;
161 #define lpfc_fip_param_hdr_fipp_mode_SHIFT      6
162 #define lpfc_fip_param_hdr_fipp_mode_MASK       0x3
163 #define lpfc_fip_param_hdr_fipp_mode_WORD       parm_flags
164 #define FIPP_MODE_ON                            0x2
165 #define FIPP_MODE_OFF                           0x0
166 #define FIPP_VLAN_VALID                         0x1
167 };
168
169 struct lpfc_fcoe_params {
170         uint8_t fc_map[3];
171         uint8_t reserved1;
172         uint16_t vlan_tag;
173         uint8_t reserved[2];
174 };
175
176 struct lpfc_fcf_conn_hdr {
177         uint8_t type;
178 #define FCOE_CONN_TBL_TYPE              0xA1
179         uint8_t length;   /* words */
180         uint8_t reserved[2];
181 };
182
183 struct lpfc_fcf_conn_rec {
184         uint16_t flags;
185 #define FCFCNCT_VALID           0x0001
186 #define FCFCNCT_BOOT            0x0002
187 #define FCFCNCT_PRIMARY         0x0004   /* if not set, Secondary */
188 #define FCFCNCT_FBNM_VALID      0x0008
189 #define FCFCNCT_SWNM_VALID      0x0010
190 #define FCFCNCT_VLAN_VALID      0x0020
191 #define FCFCNCT_AM_VALID        0x0040
192 #define FCFCNCT_AM_PREFERRED    0x0080   /* if not set, AM Required */
193 #define FCFCNCT_AM_SPMA         0x0100   /* if not set, FPMA */
194
195         uint16_t vlan_tag;
196         uint8_t fabric_name[8];
197         uint8_t switch_name[8];
198 };
199
200 struct lpfc_fcf_conn_entry {
201         struct list_head list;
202         struct lpfc_fcf_conn_rec conn_rec;
203 };
204
205 /*
206  * Define the host's bootstrap mailbox.  This structure contains
207  * the member attributes needed to create, use, and destroy the
208  * bootstrap mailbox region.
209  *
210  * The macro definitions for the bmbx data structure are defined
211  * in lpfc_hw4.h with the register definition.
212  */
213 struct lpfc_bmbx {
214         struct lpfc_dmabuf *dmabuf;
215         struct dma_address dma_address;
216         void *avirt;
217         dma_addr_t aphys;
218         uint32_t bmbx_size;
219 };
220
221 #define LPFC_EQE_SIZE LPFC_EQE_SIZE_4
222
223 #define LPFC_EQE_SIZE_4B        4
224 #define LPFC_EQE_SIZE_16B       16
225 #define LPFC_CQE_SIZE           16
226 #define LPFC_WQE_SIZE           64
227 #define LPFC_MQE_SIZE           256
228 #define LPFC_RQE_SIZE           8
229
230 #define LPFC_EQE_DEF_COUNT      1024
231 #define LPFC_CQE_DEF_COUNT      256
232 #define LPFC_WQE_DEF_COUNT      256
233 #define LPFC_MQE_DEF_COUNT      16
234 #define LPFC_RQE_DEF_COUNT      512
235
236 #define LPFC_QUEUE_NOARM        false
237 #define LPFC_QUEUE_REARM        true
238
239
240 /*
241  * SLI4 CT field defines
242  */
243 #define SLI4_CT_RPI 0
244 #define SLI4_CT_VPI 1
245 #define SLI4_CT_VFI 2
246 #define SLI4_CT_FCFI 3
247
248 #define LPFC_SLI4_MAX_SEGMENT_SIZE 0x10000
249
250 /*
251  * SLI4 specific data structures
252  */
253 struct lpfc_max_cfg_param {
254         uint16_t max_xri;
255         uint16_t xri_base;
256         uint16_t xri_used;
257         uint16_t max_rpi;
258         uint16_t rpi_base;
259         uint16_t rpi_used;
260         uint16_t max_vpi;
261         uint16_t vpi_base;
262         uint16_t vpi_used;
263         uint16_t max_vfi;
264         uint16_t vfi_base;
265         uint16_t vfi_used;
266         uint16_t max_fcfi;
267         uint16_t fcfi_base;
268         uint16_t fcfi_used;
269         uint16_t max_eq;
270         uint16_t max_rq;
271         uint16_t max_cq;
272         uint16_t max_wq;
273 };
274
275 struct lpfc_hba;
276 /* SLI4 HBA multi-fcp queue handler struct */
277 struct lpfc_fcp_eq_hdl {
278         uint32_t idx;
279         struct lpfc_hba *phba;
280 };
281
282 /* SLI4 HBA data structure entries */
283 struct lpfc_sli4_hba {
284         void __iomem *conf_regs_memmap_p; /* Kernel memory mapped address for
285                                              PCI BAR0, config space registers */
286         void __iomem *ctrl_regs_memmap_p; /* Kernel memory mapped address for
287                                              PCI BAR1, control registers */
288         void __iomem *drbl_regs_memmap_p; /* Kernel memory mapped address for
289                                              PCI BAR2, doorbell registers */
290         /* BAR0 PCI config space register memory map */
291         void __iomem *UERRLOregaddr; /* Address to UERR_STATUS_LO register */
292         void __iomem *UERRHIregaddr; /* Address to UERR_STATUS_HI register */
293         void __iomem *ONLINE0regaddr; /* Address to components of internal UE */
294         void __iomem *ONLINE1regaddr; /* Address to components of internal UE */
295 #define LPFC_ONLINE_NERR        0xFFFFFFFF
296         void __iomem *SCRATCHPADregaddr; /* Address to scratchpad register */
297         /* BAR1 FCoE function CSR register memory map */
298         void __iomem *STAregaddr;    /* Address to HST_STATE register */
299         void __iomem *ISRregaddr;    /* Address to HST_ISR register */
300         void __iomem *IMRregaddr;    /* Address to HST_IMR register */
301         void __iomem *ISCRregaddr;   /* Address to HST_ISCR register */
302         /* BAR2 VF-0 doorbell register memory map */
303         void __iomem *RQDBregaddr;   /* Address to RQ_DOORBELL register */
304         void __iomem *WQDBregaddr;   /* Address to WQ_DOORBELL register */
305         void __iomem *EQCQDBregaddr; /* Address to EQCQ_DOORBELL register */
306         void __iomem *MQDBregaddr;   /* Address to MQ_DOORBELL register */
307         void __iomem *BMBXregaddr;   /* Address to BootStrap MBX register */
308
309         struct msix_entry *msix_entries;
310         uint32_t cfg_eqn;
311         struct lpfc_fcp_eq_hdl *fcp_eq_hdl; /* FCP per-WQ handle */
312         /* Pointers to the constructed SLI4 queues */
313         struct lpfc_queue **fp_eq; /* Fast-path event queue */
314         struct lpfc_queue *sp_eq;  /* Slow-path event queue */
315         struct lpfc_queue **fcp_wq;/* Fast-path FCP work queue */
316         struct lpfc_queue *mbx_wq; /* Slow-path MBOX work queue */
317         struct lpfc_queue *els_wq; /* Slow-path ELS work queue */
318         struct lpfc_queue *hdr_rq; /* Slow-path Header Receive queue */
319         struct lpfc_queue *dat_rq; /* Slow-path Data Receive queue */
320         struct lpfc_queue **fcp_cq;/* Fast-path FCP compl queue */
321         struct lpfc_queue *mbx_cq; /* Slow-path mailbox complete queue */
322         struct lpfc_queue *els_cq; /* Slow-path ELS response complete queue */
323         struct lpfc_queue *rxq_cq; /* Slow-path unsolicited complete queue */
324
325         /* Setup information for various queue parameters */
326         int eq_esize;
327         int eq_ecount;
328         int cq_esize;
329         int cq_ecount;
330         int wq_esize;
331         int wq_ecount;
332         int mq_esize;
333         int mq_ecount;
334         int rq_esize;
335         int rq_ecount;
336 #define LPFC_SP_EQ_MAX_INTR_SEC         10000
337 #define LPFC_FP_EQ_MAX_INTR_SEC         10000
338
339         uint32_t intr_enable;
340         struct lpfc_bmbx bmbx;
341         struct lpfc_max_cfg_param max_cfg_param;
342         uint16_t next_xri; /* last_xri - max_cfg_param.xri_base = used */
343         uint16_t next_rpi;
344         uint16_t scsi_xri_max;
345         uint16_t scsi_xri_cnt;
346         struct list_head lpfc_free_sgl_list;
347         struct list_head lpfc_sgl_list;
348         struct lpfc_sglq **lpfc_els_sgl_array;
349         struct list_head lpfc_abts_els_sgl_list;
350         struct lpfc_scsi_buf **lpfc_scsi_psb_array;
351         struct list_head lpfc_abts_scsi_buf_list;
352         uint32_t total_sglq_bufs;
353         struct lpfc_sglq **lpfc_sglq_active_list;
354         struct list_head lpfc_rpi_hdr_list;
355         unsigned long *rpi_bmask;
356         uint16_t rpi_count;
357         struct lpfc_sli4_flags sli4_flags;
358         struct list_head sp_rspiocb_work_queue;
359         struct list_head sp_cqe_event_pool;
360         struct list_head sp_asynce_work_queue;
361         struct list_head sp_fcp_xri_aborted_work_queue;
362         struct list_head sp_els_xri_aborted_work_queue;
363         struct list_head sp_unsol_work_queue;
364         struct lpfc_sli4_link link_state;
365         spinlock_t abts_scsi_buf_list_lock; /* list of aborted SCSI IOs */
366         spinlock_t abts_sgl_list_lock; /* list of aborted els IOs */
367 };
368
369 enum lpfc_sge_type {
370         GEN_BUFF_TYPE,
371         SCSI_BUFF_TYPE
372 };
373
374 struct lpfc_sglq {
375         /* lpfc_sglqs are used in double linked lists */
376         struct list_head list;
377         struct list_head clist;
378         enum lpfc_sge_type buff_type; /* is this a scsi sgl */
379         uint16_t iotag;         /* pre-assigned IO tag */
380         uint16_t sli4_xritag;   /* pre-assigned XRI, (OXID) tag. */
381         struct sli4_sge *sgl;   /* pre-assigned SGL */
382         void *virt;             /* virtual address. */
383         dma_addr_t phys;        /* physical address */
384 };
385
386 struct lpfc_rpi_hdr {
387         struct list_head list;
388         uint32_t len;
389         struct lpfc_dmabuf *dmabuf;
390         uint32_t page_count;
391         uint32_t start_rpi;
392 };
393
394 /*
395  * SLI4 specific function prototypes
396  */
397 int lpfc_pci_function_reset(struct lpfc_hba *);
398 int lpfc_sli4_hba_setup(struct lpfc_hba *);
399 int lpfc_sli4_hba_down(struct lpfc_hba *);
400 int lpfc_sli4_config(struct lpfc_hba *, struct lpfcMboxq *, uint8_t,
401                      uint8_t, uint32_t, bool);
402 void lpfc_sli4_mbox_cmd_free(struct lpfc_hba *, struct lpfcMboxq *);
403 void lpfc_sli4_mbx_sge_set(struct lpfcMboxq *, uint32_t, dma_addr_t, uint32_t);
404 void lpfc_sli4_mbx_sge_get(struct lpfcMboxq *, uint32_t,
405                            struct lpfc_mbx_sge *);
406
407 void lpfc_sli4_hba_reset(struct lpfc_hba *);
408 struct lpfc_queue *lpfc_sli4_queue_alloc(struct lpfc_hba *, uint32_t,
409                         uint32_t);
410 void lpfc_sli4_queue_free(struct lpfc_queue *);
411 uint32_t lpfc_eq_create(struct lpfc_hba *, struct lpfc_queue *, uint16_t);
412 uint32_t lpfc_cq_create(struct lpfc_hba *, struct lpfc_queue *,
413                         struct lpfc_queue *, uint32_t, uint32_t);
414 uint32_t lpfc_mq_create(struct lpfc_hba *, struct lpfc_queue *,
415                         struct lpfc_queue *, uint32_t);
416 uint32_t lpfc_wq_create(struct lpfc_hba *, struct lpfc_queue *,
417                         struct lpfc_queue *, uint32_t);
418 uint32_t lpfc_rq_create(struct lpfc_hba *, struct lpfc_queue *,
419                         struct lpfc_queue *, struct lpfc_queue *, uint32_t);
420 uint32_t lpfc_eq_destroy(struct lpfc_hba *, struct lpfc_queue *);
421 uint32_t lpfc_cq_destroy(struct lpfc_hba *, struct lpfc_queue *);
422 uint32_t lpfc_mq_destroy(struct lpfc_hba *, struct lpfc_queue *);
423 uint32_t lpfc_wq_destroy(struct lpfc_hba *, struct lpfc_queue *);
424 uint32_t lpfc_rq_destroy(struct lpfc_hba *, struct lpfc_queue *,
425                          struct lpfc_queue *);
426 int lpfc_sli4_queue_setup(struct lpfc_hba *);
427 void lpfc_sli4_queue_unset(struct lpfc_hba *);
428 int lpfc_sli4_post_sgl(struct lpfc_hba *, dma_addr_t, dma_addr_t, uint16_t);
429 int lpfc_sli4_repost_scsi_sgl_list(struct lpfc_hba *);
430 int lpfc_sli4_remove_all_sgl_pages(struct lpfc_hba *);
431 uint16_t lpfc_sli4_next_xritag(struct lpfc_hba *);
432 int lpfc_sli4_post_async_mbox(struct lpfc_hba *);
433 int lpfc_sli4_post_sgl_list(struct lpfc_hba *phba);
434 int lpfc_sli4_post_scsi_sgl_block(struct lpfc_hba *, struct list_head *, int);
435 struct lpfc_cq_event *__lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
436 struct lpfc_cq_event *lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
437 void __lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
438 void lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
439 int lpfc_sli4_init_rpi_hdrs(struct lpfc_hba *);
440 int lpfc_sli4_post_rpi_hdr(struct lpfc_hba *, struct lpfc_rpi_hdr *);
441 int lpfc_sli4_post_all_rpi_hdrs(struct lpfc_hba *);
442 struct lpfc_rpi_hdr *lpfc_sli4_create_rpi_hdr(struct lpfc_hba *);
443 void lpfc_sli4_remove_rpi_hdrs(struct lpfc_hba *);
444 int lpfc_sli4_alloc_rpi(struct lpfc_hba *);
445 void lpfc_sli4_free_rpi(struct lpfc_hba *, int);
446 void lpfc_sli4_remove_rpis(struct lpfc_hba *);
447 void lpfc_sli4_async_event_proc(struct lpfc_hba *);
448 int lpfc_sli4_resume_rpi(struct lpfc_nodelist *);
449 void lpfc_sli4_fcp_xri_abort_event_proc(struct lpfc_hba *);
450 void lpfc_sli4_els_xri_abort_event_proc(struct lpfc_hba *);
451 void lpfc_sli4_fcp_xri_aborted(struct lpfc_hba *,
452                                struct sli4_wcqe_xri_aborted *);
453 void lpfc_sli4_els_xri_aborted(struct lpfc_hba *,
454                                struct sli4_wcqe_xri_aborted *);
455 int lpfc_sli4_brdreset(struct lpfc_hba *);
456 int lpfc_sli4_add_fcf_record(struct lpfc_hba *, struct fcf_record *);
457 void lpfc_sli_remove_dflt_fcf(struct lpfc_hba *);
458 int lpfc_sli4_get_els_iocb_cnt(struct lpfc_hba *);
459 int lpfc_sli4_init_vpi(struct lpfc_hba *, uint16_t);
460 uint32_t lpfc_sli4_cq_release(struct lpfc_queue *, bool);
461 uint32_t lpfc_sli4_eq_release(struct lpfc_queue *, bool);
462 void lpfc_sli4_fcfi_unreg(struct lpfc_hba *, uint16_t);
463 int lpfc_sli4_read_fcf_record(struct lpfc_hba *, uint16_t);
464 void lpfc_mbx_cmpl_read_fcf_record(struct lpfc_hba *, LPFC_MBOXQ_t *);
465 int lpfc_sli4_post_status_check(struct lpfc_hba *);
466 uint8_t lpfc_sli4_mbox_opcode_get(struct lpfc_hba *, struct lpfcMboxq *);
467