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. *
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 *******************************************************************/
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
26 /* Amount of time in seconds for waiting FCF rediscovery to complete */
27 #define LPFC_FCF_REDISCOVER_WAIT_TMO 2000 /* msec */
29 /* Number of SGL entries can be posted in a 4KB nonembedded mbox command */
30 #define LPFC_NEMBED_MBOX_SGL_CNT 254
32 /* Multi-queue arrangement for fast-path FCP work queues */
33 #define LPFC_FN_EQN_MAX 8
34 #define LPFC_SP_EQN_DEF 1
35 #define LPFC_FP_EQN_DEF 4
36 #define LPFC_FP_EQN_MIN 1
37 #define LPFC_FP_EQN_MAX (LPFC_FN_EQN_MAX - LPFC_SP_EQN_DEF)
39 #define LPFC_FN_WQN_MAX 32
40 #define LPFC_SP_WQN_DEF 1
41 #define LPFC_FP_WQN_DEF 4
42 #define LPFC_FP_WQN_MIN 1
43 #define LPFC_FP_WQN_MAX (LPFC_FN_WQN_MAX - LPFC_SP_WQN_DEF)
46 * Provide the default FCF Record attributes used by the driver
47 * when nonFIP mode is configured and there is no other default
48 * FCF Record attributes.
50 #define LPFC_FCOE_FCF_DEF_INDEX 0
51 #define LPFC_FCOE_FCF_GET_FIRST 0xFFFF
52 #define LPFC_FCOE_FCF_NEXT_NONE 0xFFFF
54 /* First 3 bytes of default FCF MAC is specified by FC_MAP */
55 #define LPFC_FCOE_FCF_MAC3 0xFF
56 #define LPFC_FCOE_FCF_MAC4 0xFF
57 #define LPFC_FCOE_FCF_MAC5 0xFE
58 #define LPFC_FCOE_FCF_MAP0 0x0E
59 #define LPFC_FCOE_FCF_MAP1 0xFC
60 #define LPFC_FCOE_FCF_MAP2 0x00
61 #define LPFC_FCOE_MAX_RCV_SIZE 0x5AC
62 #define LPFC_FCOE_FKA_ADV_PER 0
63 #define LPFC_FCOE_FIP_PRIORITY 0x80
65 #define sli4_sid_from_fc_hdr(fc_hdr) \
66 ((fc_hdr)->fh_s_id[0] << 16 | \
67 (fc_hdr)->fh_s_id[1] << 8 | \
70 #define sli4_fctl_from_fc_hdr(fc_hdr) \
71 ((fc_hdr)->fh_f_ctl[0] << 16 | \
72 (fc_hdr)->fh_f_ctl[1] << 8 | \
73 (fc_hdr)->fh_f_ctl[2])
75 enum lpfc_sli4_queue_type {
87 /* The queue sub-type defines the functional purpose of the queue */
88 enum lpfc_sli4_queue_subtype {
100 struct lpfc_mcqe *mcqe;
101 struct lpfc_wcqe_complete *wcqe_complete;
102 struct lpfc_wcqe_release *wcqe_release;
103 struct sli4_wcqe_xri_aborted *wcqe_xri_aborted;
104 struct lpfc_rcqe_complete *rcqe_complete;
105 struct lpfc_mqe *mqe;
107 struct lpfc_rqe *rqe;
111 struct list_head list;
112 enum lpfc_sli4_queue_type type;
113 enum lpfc_sli4_queue_subtype subtype;
114 struct lpfc_hba *phba;
115 struct list_head child_list;
116 uint32_t entry_count; /* Number of entries to support on the queue */
117 uint32_t entry_size; /* Size of each queue entry. */
118 uint32_t queue_id; /* Queue ID assigned by the hardware */
119 struct list_head page_list;
120 uint32_t page_count; /* Number of pages allocated for this queue */
122 uint32_t host_index; /* The host's index for putting or getting */
123 uint32_t hba_index; /* The last known hba index for get or put */
124 union sli4_qe qe[1]; /* array to index entries (must be last) */
127 struct lpfc_sli4_link {
133 uint16_t logical_speed;
136 struct lpfc_fcf_rec {
137 uint8_t fabric_name[8];
138 uint8_t switch_name[8];
145 #define BOOT_ENABLE 0x01
146 #define RECORD_VALID 0x02
152 #define FCF_AVAILABLE 0x01 /* FCF available for discovery */
153 #define FCF_REGISTERED 0x02 /* FCF registered with FW */
154 #define FCF_SCAN_DONE 0x04 /* FCF table scan done */
155 #define FCF_IN_USE 0x08 /* Atleast one discovery completed */
156 #define FCF_DEAD_FOVER 0x10 /* FCF DEAD triggered fast FCF failover */
157 #define FCF_CVL_FOVER 0x20 /* CVL triggered fast FCF failover */
158 #define FCF_REDISC_PEND 0x40 /* FCF rediscovery pending */
159 #define FCF_REDISC_EVT 0x80 /* FCF rediscovery event to worker thread */
160 #define FCF_REDISC_FOV 0x100 /* Post FCF rediscovery fast failover */
162 struct lpfc_fcf_rec current_rec;
163 struct lpfc_fcf_rec failover_rec;
164 struct timer_list redisc_wait;
167 #define LPFC_REGION23_SIGNATURE "RG23"
168 #define LPFC_REGION23_VERSION 1
169 #define LPFC_REGION23_LAST_REC 0xff
170 #define DRIVER_SPECIFIC_TYPE 0xA2
171 #define LINUX_DRIVER_ID 0x20
172 #define PORT_STE_TYPE 0x1
174 struct lpfc_fip_param_hdr {
176 #define FCOE_PARAM_TYPE 0xA0
178 #define FCOE_PARAM_LENGTH 2
179 uint8_t parm_version;
180 #define FIPP_VERSION 0x01
182 #define lpfc_fip_param_hdr_fipp_mode_SHIFT 6
183 #define lpfc_fip_param_hdr_fipp_mode_MASK 0x3
184 #define lpfc_fip_param_hdr_fipp_mode_WORD parm_flags
185 #define FIPP_MODE_ON 0x1
186 #define FIPP_MODE_OFF 0x0
187 #define FIPP_VLAN_VALID 0x1
190 struct lpfc_fcoe_params {
197 struct lpfc_fcf_conn_hdr {
199 #define FCOE_CONN_TBL_TYPE 0xA1
200 uint8_t length; /* words */
204 struct lpfc_fcf_conn_rec {
206 #define FCFCNCT_VALID 0x0001
207 #define FCFCNCT_BOOT 0x0002
208 #define FCFCNCT_PRIMARY 0x0004 /* if not set, Secondary */
209 #define FCFCNCT_FBNM_VALID 0x0008
210 #define FCFCNCT_SWNM_VALID 0x0010
211 #define FCFCNCT_VLAN_VALID 0x0020
212 #define FCFCNCT_AM_VALID 0x0040
213 #define FCFCNCT_AM_PREFERRED 0x0080 /* if not set, AM Required */
214 #define FCFCNCT_AM_SPMA 0x0100 /* if not set, FPMA */
217 uint8_t fabric_name[8];
218 uint8_t switch_name[8];
221 struct lpfc_fcf_conn_entry {
222 struct list_head list;
223 struct lpfc_fcf_conn_rec conn_rec;
227 * Define the host's bootstrap mailbox. This structure contains
228 * the member attributes needed to create, use, and destroy the
229 * bootstrap mailbox region.
231 * The macro definitions for the bmbx data structure are defined
232 * in lpfc_hw4.h with the register definition.
235 struct lpfc_dmabuf *dmabuf;
236 struct dma_address dma_address;
242 #define LPFC_EQE_SIZE LPFC_EQE_SIZE_4
244 #define LPFC_EQE_SIZE_4B 4
245 #define LPFC_EQE_SIZE_16B 16
246 #define LPFC_CQE_SIZE 16
247 #define LPFC_WQE_SIZE 64
248 #define LPFC_MQE_SIZE 256
249 #define LPFC_RQE_SIZE 8
251 #define LPFC_EQE_DEF_COUNT 1024
252 #define LPFC_CQE_DEF_COUNT 256
253 #define LPFC_WQE_DEF_COUNT 256
254 #define LPFC_MQE_DEF_COUNT 16
255 #define LPFC_RQE_DEF_COUNT 512
257 #define LPFC_QUEUE_NOARM false
258 #define LPFC_QUEUE_REARM true
262 * SLI4 CT field defines
264 #define SLI4_CT_RPI 0
265 #define SLI4_CT_VPI 1
266 #define SLI4_CT_VFI 2
267 #define SLI4_CT_FCFI 3
269 #define LPFC_SLI4_FL1_MAX_SEGMENT_SIZE 0x10000
270 #define LPFC_SLI4_FL1_MAX_BUF_SIZE 0X2000
271 #define LPFC_SLI4_MIN_BUF_SIZE 0x400
272 #define LPFC_SLI4_MAX_BUF_SIZE 0x20000
275 * SLI4 specific data structures
277 struct lpfc_max_cfg_param {
300 /* SLI4 HBA multi-fcp queue handler struct */
301 struct lpfc_fcp_eq_hdl {
303 struct lpfc_hba *phba;
306 /* Port Capabilities for SLI4 Parameters */
307 struct lpfc_pc_sli4_params {
312 uint32_t featurelevel_1;
313 uint32_t featurelevel_2;
314 uint32_t proto_types;
315 #define LPFC_SLI4_PROTO_FCOE 0x0000001
316 #define LPFC_SLI4_PROTO_FC 0x0000002
317 #define LPFC_SLI4_PROTO_NIC 0x0000004
318 #define LPFC_SLI4_PROTO_ISCSI 0x0000008
319 #define LPFC_SLI4_PROTO_RDMA 0x0000010
320 uint32_t sge_supp_len;
322 uint32_t rq_db_window;
323 uint32_t loopbk_scope;
324 uint32_t eq_pages_max;
326 uint32_t cq_pages_max;
328 uint32_t mq_pages_max;
330 uint32_t mq_elem_cnt;
331 uint32_t wq_pages_max;
333 uint32_t rq_pages_max;
335 uint32_t hdr_pages_max;
337 uint32_t hdr_pp_align;
338 uint32_t sgl_pages_max;
339 uint32_t sgl_pp_align;
342 /* SLI4 HBA data structure entries */
343 struct lpfc_sli4_hba {
344 void __iomem *conf_regs_memmap_p; /* Kernel memory mapped address for
345 PCI BAR0, config space registers */
346 void __iomem *ctrl_regs_memmap_p; /* Kernel memory mapped address for
347 PCI BAR1, control registers */
348 void __iomem *drbl_regs_memmap_p; /* Kernel memory mapped address for
349 PCI BAR2, doorbell registers */
350 /* BAR0 PCI config space register memory map */
351 void __iomem *UERRLOregaddr; /* Address to UERR_STATUS_LO register */
352 void __iomem *UERRHIregaddr; /* Address to UERR_STATUS_HI register */
353 void __iomem *UEMASKLOregaddr; /* Address to UE_MASK_LO register */
354 void __iomem *UEMASKHIregaddr; /* Address to UE_MASK_HI register */
355 void __iomem *SLIINTFregaddr; /* Address to SLI_INTF register */
356 /* BAR1 FCoE function CSR register memory map */
357 void __iomem *STAregaddr; /* Address to HST_STATE register */
358 void __iomem *ISRregaddr; /* Address to HST_ISR register */
359 void __iomem *IMRregaddr; /* Address to HST_IMR register */
360 void __iomem *ISCRregaddr; /* Address to HST_ISCR register */
361 /* BAR2 VF-0 doorbell register memory map */
362 void __iomem *RQDBregaddr; /* Address to RQ_DOORBELL register */
363 void __iomem *WQDBregaddr; /* Address to WQ_DOORBELL register */
364 void __iomem *EQCQDBregaddr; /* Address to EQCQ_DOORBELL register */
365 void __iomem *MQDBregaddr; /* Address to MQ_DOORBELL register */
366 void __iomem *BMBXregaddr; /* Address to BootStrap MBX register */
370 struct lpfc_register sli_intf;
371 struct lpfc_pc_sli4_params pc_sli4_params;
372 struct msix_entry *msix_entries;
374 struct lpfc_fcp_eq_hdl *fcp_eq_hdl; /* FCP per-WQ handle */
375 /* Pointers to the constructed SLI4 queues */
376 struct lpfc_queue **fp_eq; /* Fast-path event queue */
377 struct lpfc_queue *sp_eq; /* Slow-path event queue */
378 struct lpfc_queue **fcp_wq;/* Fast-path FCP work queue */
379 struct lpfc_queue *mbx_wq; /* Slow-path MBOX work queue */
380 struct lpfc_queue *els_wq; /* Slow-path ELS work queue */
381 struct lpfc_queue *hdr_rq; /* Slow-path Header Receive queue */
382 struct lpfc_queue *dat_rq; /* Slow-path Data Receive queue */
383 struct lpfc_queue **fcp_cq;/* Fast-path FCP compl queue */
384 struct lpfc_queue *mbx_cq; /* Slow-path mailbox complete queue */
385 struct lpfc_queue *els_cq; /* Slow-path ELS response complete queue */
387 /* Setup information for various queue parameters */
398 #define LPFC_SP_EQ_MAX_INTR_SEC 10000
399 #define LPFC_FP_EQ_MAX_INTR_SEC 10000
401 uint32_t intr_enable;
402 struct lpfc_bmbx bmbx;
403 struct lpfc_max_cfg_param max_cfg_param;
404 uint16_t next_xri; /* last_xri - max_cfg_param.xri_base = used */
406 uint16_t scsi_xri_max;
407 uint16_t scsi_xri_cnt;
408 struct list_head lpfc_free_sgl_list;
409 struct list_head lpfc_sgl_list;
410 struct lpfc_sglq **lpfc_els_sgl_array;
411 struct list_head lpfc_abts_els_sgl_list;
412 struct lpfc_scsi_buf **lpfc_scsi_psb_array;
413 struct list_head lpfc_abts_scsi_buf_list;
414 uint32_t total_sglq_bufs;
415 struct lpfc_sglq **lpfc_sglq_active_list;
416 struct list_head lpfc_rpi_hdr_list;
417 unsigned long *rpi_bmask;
419 struct lpfc_sli4_flags sli4_flags;
420 struct list_head sp_queue_event;
421 struct list_head sp_cqe_event_pool;
422 struct list_head sp_asynce_work_queue;
423 struct list_head sp_fcp_xri_aborted_work_queue;
424 struct list_head sp_els_xri_aborted_work_queue;
425 struct list_head sp_unsol_work_queue;
426 struct lpfc_sli4_link link_state;
427 spinlock_t abts_scsi_buf_list_lock; /* list of aborted SCSI IOs */
428 spinlock_t abts_sgl_list_lock; /* list of aborted els IOs */
436 enum lpfc_sgl_state {
443 /* lpfc_sglqs are used in double linked lists */
444 struct list_head list;
445 struct list_head clist;
446 enum lpfc_sge_type buff_type; /* is this a scsi sgl */
447 enum lpfc_sgl_state state;
448 uint16_t iotag; /* pre-assigned IO tag */
449 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
450 struct sli4_sge *sgl; /* pre-assigned SGL */
451 void *virt; /* virtual address. */
452 dma_addr_t phys; /* physical address */
455 struct lpfc_rpi_hdr {
456 struct list_head list;
458 struct lpfc_dmabuf *dmabuf;
464 * SLI4 specific function prototypes
466 int lpfc_pci_function_reset(struct lpfc_hba *);
467 int lpfc_sli4_hba_setup(struct lpfc_hba *);
468 int lpfc_sli4_hba_down(struct lpfc_hba *);
469 int lpfc_sli4_config(struct lpfc_hba *, struct lpfcMboxq *, uint8_t,
470 uint8_t, uint32_t, bool);
471 void lpfc_sli4_mbox_cmd_free(struct lpfc_hba *, struct lpfcMboxq *);
472 void lpfc_sli4_mbx_sge_set(struct lpfcMboxq *, uint32_t, dma_addr_t, uint32_t);
473 void lpfc_sli4_mbx_sge_get(struct lpfcMboxq *, uint32_t,
474 struct lpfc_mbx_sge *);
475 int lpfc_sli4_mbx_read_fcf_record(struct lpfc_hba *, struct lpfcMboxq *,
478 void lpfc_sli4_hba_reset(struct lpfc_hba *);
479 struct lpfc_queue *lpfc_sli4_queue_alloc(struct lpfc_hba *, uint32_t,
481 void lpfc_sli4_queue_free(struct lpfc_queue *);
482 uint32_t lpfc_eq_create(struct lpfc_hba *, struct lpfc_queue *, uint16_t);
483 uint32_t lpfc_cq_create(struct lpfc_hba *, struct lpfc_queue *,
484 struct lpfc_queue *, uint32_t, uint32_t);
485 uint32_t lpfc_mq_create(struct lpfc_hba *, struct lpfc_queue *,
486 struct lpfc_queue *, uint32_t);
487 uint32_t lpfc_wq_create(struct lpfc_hba *, struct lpfc_queue *,
488 struct lpfc_queue *, uint32_t);
489 uint32_t lpfc_rq_create(struct lpfc_hba *, struct lpfc_queue *,
490 struct lpfc_queue *, struct lpfc_queue *, uint32_t);
491 uint32_t lpfc_eq_destroy(struct lpfc_hba *, struct lpfc_queue *);
492 uint32_t lpfc_cq_destroy(struct lpfc_hba *, struct lpfc_queue *);
493 uint32_t lpfc_mq_destroy(struct lpfc_hba *, struct lpfc_queue *);
494 uint32_t lpfc_wq_destroy(struct lpfc_hba *, struct lpfc_queue *);
495 uint32_t lpfc_rq_destroy(struct lpfc_hba *, struct lpfc_queue *,
496 struct lpfc_queue *);
497 int lpfc_sli4_queue_setup(struct lpfc_hba *);
498 void lpfc_sli4_queue_unset(struct lpfc_hba *);
499 int lpfc_sli4_post_sgl(struct lpfc_hba *, dma_addr_t, dma_addr_t, uint16_t);
500 int lpfc_sli4_repost_scsi_sgl_list(struct lpfc_hba *);
501 int lpfc_sli4_remove_all_sgl_pages(struct lpfc_hba *);
502 uint16_t lpfc_sli4_next_xritag(struct lpfc_hba *);
503 int lpfc_sli4_post_async_mbox(struct lpfc_hba *);
504 int lpfc_sli4_post_sgl_list(struct lpfc_hba *phba);
505 int lpfc_sli4_post_scsi_sgl_block(struct lpfc_hba *, struct list_head *, int);
506 struct lpfc_cq_event *__lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
507 struct lpfc_cq_event *lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
508 void __lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
509 void lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
510 int lpfc_sli4_init_rpi_hdrs(struct lpfc_hba *);
511 int lpfc_sli4_post_rpi_hdr(struct lpfc_hba *, struct lpfc_rpi_hdr *);
512 int lpfc_sli4_post_all_rpi_hdrs(struct lpfc_hba *);
513 struct lpfc_rpi_hdr *lpfc_sli4_create_rpi_hdr(struct lpfc_hba *);
514 void lpfc_sli4_remove_rpi_hdrs(struct lpfc_hba *);
515 int lpfc_sli4_alloc_rpi(struct lpfc_hba *);
516 void lpfc_sli4_free_rpi(struct lpfc_hba *, int);
517 void lpfc_sli4_remove_rpis(struct lpfc_hba *);
518 void lpfc_sli4_async_event_proc(struct lpfc_hba *);
519 void lpfc_sli4_fcf_redisc_event_proc(struct lpfc_hba *);
520 int lpfc_sli4_resume_rpi(struct lpfc_nodelist *);
521 void lpfc_sli4_fcp_xri_abort_event_proc(struct lpfc_hba *);
522 void lpfc_sli4_els_xri_abort_event_proc(struct lpfc_hba *);
523 void lpfc_sli4_fcp_xri_aborted(struct lpfc_hba *,
524 struct sli4_wcqe_xri_aborted *);
525 void lpfc_sli4_els_xri_aborted(struct lpfc_hba *,
526 struct sli4_wcqe_xri_aborted *);
527 int lpfc_sli4_brdreset(struct lpfc_hba *);
528 int lpfc_sli4_add_fcf_record(struct lpfc_hba *, struct fcf_record *);
529 void lpfc_sli_remove_dflt_fcf(struct lpfc_hba *);
530 int lpfc_sli4_get_els_iocb_cnt(struct lpfc_hba *);
531 int lpfc_sli4_init_vpi(struct lpfc_hba *, uint16_t);
532 uint32_t lpfc_sli4_cq_release(struct lpfc_queue *, bool);
533 uint32_t lpfc_sli4_eq_release(struct lpfc_queue *, bool);
534 void lpfc_sli4_fcfi_unreg(struct lpfc_hba *, uint16_t);
535 int lpfc_sli4_read_fcf_record(struct lpfc_hba *, uint16_t);
536 void lpfc_mbx_cmpl_read_fcf_record(struct lpfc_hba *, LPFC_MBOXQ_t *);
537 int lpfc_sli4_post_status_check(struct lpfc_hba *);
538 uint8_t lpfc_sli4_mbox_opcode_get(struct lpfc_hba *, struct lpfcMboxq *);