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 #define LPFC_UNREG_FCF 1
27 #define LPFC_SKIP_UNREG_FCF 0
29 /* Amount of time in seconds for waiting FCF rediscovery to complete */
30 #define LPFC_FCF_REDISCOVER_WAIT_TMO 2000 /* msec */
32 /* Number of SGL entries can be posted in a 4KB nonembedded mbox command */
33 #define LPFC_NEMBED_MBOX_SGL_CNT 254
35 /* Multi-queue arrangement for fast-path FCP work queues */
36 #define LPFC_FN_EQN_MAX 8
37 #define LPFC_SP_EQN_DEF 1
38 #define LPFC_FP_EQN_DEF 4
39 #define LPFC_FP_EQN_MIN 1
40 #define LPFC_FP_EQN_MAX (LPFC_FN_EQN_MAX - LPFC_SP_EQN_DEF)
42 #define LPFC_FN_WQN_MAX 32
43 #define LPFC_SP_WQN_DEF 1
44 #define LPFC_FP_WQN_DEF 4
45 #define LPFC_FP_WQN_MIN 1
46 #define LPFC_FP_WQN_MAX (LPFC_FN_WQN_MAX - LPFC_SP_WQN_DEF)
49 * Provide the default FCF Record attributes used by the driver
50 * when nonFIP mode is configured and there is no other default
51 * FCF Record attributes.
53 #define LPFC_FCOE_FCF_DEF_INDEX 0
54 #define LPFC_FCOE_FCF_GET_FIRST 0xFFFF
55 #define LPFC_FCOE_FCF_NEXT_NONE 0xFFFF
57 #define LPFC_FCOE_NULL_VID 0xFFF
58 #define LPFC_FCOE_IGNORE_VID 0xFFFF
60 /* First 3 bytes of default FCF MAC is specified by FC_MAP */
61 #define LPFC_FCOE_FCF_MAC3 0xFF
62 #define LPFC_FCOE_FCF_MAC4 0xFF
63 #define LPFC_FCOE_FCF_MAC5 0xFE
64 #define LPFC_FCOE_FCF_MAP0 0x0E
65 #define LPFC_FCOE_FCF_MAP1 0xFC
66 #define LPFC_FCOE_FCF_MAP2 0x00
67 #define LPFC_FCOE_MAX_RCV_SIZE 0x800
68 #define LPFC_FCOE_FKA_ADV_PER 0
69 #define LPFC_FCOE_FIP_PRIORITY 0x80
71 #define sli4_sid_from_fc_hdr(fc_hdr) \
72 ((fc_hdr)->fh_s_id[0] << 16 | \
73 (fc_hdr)->fh_s_id[1] << 8 | \
76 #define sli4_fctl_from_fc_hdr(fc_hdr) \
77 ((fc_hdr)->fh_f_ctl[0] << 16 | \
78 (fc_hdr)->fh_f_ctl[1] << 8 | \
79 (fc_hdr)->fh_f_ctl[2])
81 enum lpfc_sli4_queue_type {
93 /* The queue sub-type defines the functional purpose of the queue */
94 enum lpfc_sli4_queue_subtype {
104 struct lpfc_eqe *eqe;
105 struct lpfc_cqe *cqe;
106 struct lpfc_mcqe *mcqe;
107 struct lpfc_wcqe_complete *wcqe_complete;
108 struct lpfc_wcqe_release *wcqe_release;
109 struct sli4_wcqe_xri_aborted *wcqe_xri_aborted;
110 struct lpfc_rcqe_complete *rcqe_complete;
111 struct lpfc_mqe *mqe;
113 struct lpfc_rqe *rqe;
117 struct list_head list;
118 enum lpfc_sli4_queue_type type;
119 enum lpfc_sli4_queue_subtype subtype;
120 struct lpfc_hba *phba;
121 struct list_head child_list;
122 uint32_t entry_count; /* Number of entries to support on the queue */
123 uint32_t entry_size; /* Size of each queue entry. */
124 uint32_t queue_id; /* Queue ID assigned by the hardware */
125 struct list_head page_list;
126 uint32_t page_count; /* Number of pages allocated for this queue */
128 uint32_t host_index; /* The host's index for putting or getting */
129 uint32_t hba_index; /* The last known hba index for get or put */
130 union sli4_qe qe[1]; /* array to index entries (must be last) */
133 struct lpfc_sli4_link {
139 uint16_t logical_speed;
142 struct lpfc_fcf_rec {
143 uint8_t fabric_name[8];
144 uint8_t switch_name[8];
151 #define BOOT_ENABLE 0x01
152 #define RECORD_VALID 0x02
158 #define FCF_AVAILABLE 0x01 /* FCF available for discovery */
159 #define FCF_REGISTERED 0x02 /* FCF registered with FW */
160 #define FCF_SCAN_DONE 0x04 /* FCF table scan done */
161 #define FCF_IN_USE 0x08 /* Atleast one discovery completed */
162 #define FCF_INIT_DISC 0x10 /* Initial FCF discovery */
163 #define FCF_DEAD_DISC 0x20 /* FCF DEAD fast FCF failover discovery */
164 #define FCF_ACVL_DISC 0x40 /* All CVL fast FCF failover discovery */
165 #define FCF_DISCOVERY (FCF_INIT_DISC | FCF_DEAD_DISC | FCF_ACVL_DISC)
166 #define FCF_REDISC_PEND 0x80 /* FCF rediscovery pending */
167 #define FCF_REDISC_EVT 0x100 /* FCF rediscovery event to worker thread */
168 #define FCF_REDISC_FOV 0x200 /* Post FCF rediscovery fast failover */
169 #define FCF_REDISC_PROG (FCF_REDISC_PEND | FCF_REDISC_EVT)
171 uint32_t eligible_fcf_cnt;
172 struct lpfc_fcf_rec current_rec;
173 struct lpfc_fcf_rec failover_rec;
174 struct timer_list redisc_wait;
175 unsigned long *fcf_rr_bmask; /* Eligible FCF indexes for RR failover */
179 * Maximum FCF table index, it is for driver internal book keeping, it
180 * just needs to be no less than the supported HBA's FCF table size.
182 #define LPFC_SLI4_FCF_TBL_INDX_MAX 32
184 #define LPFC_REGION23_SIGNATURE "RG23"
185 #define LPFC_REGION23_VERSION 1
186 #define LPFC_REGION23_LAST_REC 0xff
187 #define DRIVER_SPECIFIC_TYPE 0xA2
188 #define LINUX_DRIVER_ID 0x20
189 #define PORT_STE_TYPE 0x1
191 struct lpfc_fip_param_hdr {
193 #define FCOE_PARAM_TYPE 0xA0
195 #define FCOE_PARAM_LENGTH 2
196 uint8_t parm_version;
197 #define FIPP_VERSION 0x01
199 #define lpfc_fip_param_hdr_fipp_mode_SHIFT 6
200 #define lpfc_fip_param_hdr_fipp_mode_MASK 0x3
201 #define lpfc_fip_param_hdr_fipp_mode_WORD parm_flags
202 #define FIPP_MODE_ON 0x1
203 #define FIPP_MODE_OFF 0x0
204 #define FIPP_VLAN_VALID 0x1
207 struct lpfc_fcoe_params {
214 struct lpfc_fcf_conn_hdr {
216 #define FCOE_CONN_TBL_TYPE 0xA1
217 uint8_t length; /* words */
221 struct lpfc_fcf_conn_rec {
223 #define FCFCNCT_VALID 0x0001
224 #define FCFCNCT_BOOT 0x0002
225 #define FCFCNCT_PRIMARY 0x0004 /* if not set, Secondary */
226 #define FCFCNCT_FBNM_VALID 0x0008
227 #define FCFCNCT_SWNM_VALID 0x0010
228 #define FCFCNCT_VLAN_VALID 0x0020
229 #define FCFCNCT_AM_VALID 0x0040
230 #define FCFCNCT_AM_PREFERRED 0x0080 /* if not set, AM Required */
231 #define FCFCNCT_AM_SPMA 0x0100 /* if not set, FPMA */
234 uint8_t fabric_name[8];
235 uint8_t switch_name[8];
238 struct lpfc_fcf_conn_entry {
239 struct list_head list;
240 struct lpfc_fcf_conn_rec conn_rec;
244 * Define the host's bootstrap mailbox. This structure contains
245 * the member attributes needed to create, use, and destroy the
246 * bootstrap mailbox region.
248 * The macro definitions for the bmbx data structure are defined
249 * in lpfc_hw4.h with the register definition.
252 struct lpfc_dmabuf *dmabuf;
253 struct dma_address dma_address;
259 #define LPFC_EQE_SIZE LPFC_EQE_SIZE_4
261 #define LPFC_EQE_SIZE_4B 4
262 #define LPFC_EQE_SIZE_16B 16
263 #define LPFC_CQE_SIZE 16
264 #define LPFC_WQE_SIZE 64
265 #define LPFC_MQE_SIZE 256
266 #define LPFC_RQE_SIZE 8
268 #define LPFC_EQE_DEF_COUNT 1024
269 #define LPFC_CQE_DEF_COUNT 256
270 #define LPFC_WQE_DEF_COUNT 256
271 #define LPFC_MQE_DEF_COUNT 16
272 #define LPFC_RQE_DEF_COUNT 512
274 #define LPFC_QUEUE_NOARM false
275 #define LPFC_QUEUE_REARM true
279 * SLI4 CT field defines
281 #define SLI4_CT_RPI 0
282 #define SLI4_CT_VPI 1
283 #define SLI4_CT_VFI 2
284 #define SLI4_CT_FCFI 3
286 #define LPFC_SLI4_FL1_MAX_SEGMENT_SIZE 0x10000
287 #define LPFC_SLI4_FL1_MAX_BUF_SIZE 0X2000
288 #define LPFC_SLI4_MIN_BUF_SIZE 0x400
289 #define LPFC_SLI4_MAX_BUF_SIZE 0x20000
292 * SLI4 specific data structures
294 struct lpfc_max_cfg_param {
317 /* SLI4 HBA multi-fcp queue handler struct */
318 struct lpfc_fcp_eq_hdl {
320 struct lpfc_hba *phba;
323 /* Port Capabilities for SLI4 Parameters */
324 struct lpfc_pc_sli4_params {
329 uint32_t featurelevel_1;
330 uint32_t featurelevel_2;
331 uint32_t proto_types;
332 #define LPFC_SLI4_PROTO_FCOE 0x0000001
333 #define LPFC_SLI4_PROTO_FC 0x0000002
334 #define LPFC_SLI4_PROTO_NIC 0x0000004
335 #define LPFC_SLI4_PROTO_ISCSI 0x0000008
336 #define LPFC_SLI4_PROTO_RDMA 0x0000010
337 uint32_t sge_supp_len;
339 uint32_t rq_db_window;
340 uint32_t loopbk_scope;
341 uint32_t eq_pages_max;
343 uint32_t cq_pages_max;
345 uint32_t mq_pages_max;
347 uint32_t mq_elem_cnt;
348 uint32_t wq_pages_max;
350 uint32_t rq_pages_max;
352 uint32_t hdr_pages_max;
354 uint32_t hdr_pp_align;
355 uint32_t sgl_pages_max;
356 uint32_t sgl_pp_align;
359 /* SLI4 HBA data structure entries */
360 struct lpfc_sli4_hba {
361 void __iomem *conf_regs_memmap_p; /* Kernel memory mapped address for
362 PCI BAR0, config space registers */
363 void __iomem *ctrl_regs_memmap_p; /* Kernel memory mapped address for
364 PCI BAR1, control registers */
365 void __iomem *drbl_regs_memmap_p; /* Kernel memory mapped address for
366 PCI BAR2, doorbell registers */
367 /* BAR0 PCI config space register memory map */
368 void __iomem *UERRLOregaddr; /* Address to UERR_STATUS_LO register */
369 void __iomem *UERRHIregaddr; /* Address to UERR_STATUS_HI register */
370 void __iomem *UEMASKLOregaddr; /* Address to UE_MASK_LO register */
371 void __iomem *UEMASKHIregaddr; /* Address to UE_MASK_HI register */
372 void __iomem *SLIINTFregaddr; /* Address to SLI_INTF register */
373 /* BAR1 FCoE function CSR register memory map */
374 void __iomem *STAregaddr; /* Address to HST_STATE register */
375 void __iomem *ISRregaddr; /* Address to HST_ISR register */
376 void __iomem *IMRregaddr; /* Address to HST_IMR register */
377 void __iomem *ISCRregaddr; /* Address to HST_ISCR register */
378 /* BAR2 VF-0 doorbell register memory map */
379 void __iomem *RQDBregaddr; /* Address to RQ_DOORBELL register */
380 void __iomem *WQDBregaddr; /* Address to WQ_DOORBELL register */
381 void __iomem *EQCQDBregaddr; /* Address to EQCQ_DOORBELL register */
382 void __iomem *MQDBregaddr; /* Address to MQ_DOORBELL register */
383 void __iomem *BMBXregaddr; /* Address to BootStrap MBX register */
387 struct lpfc_register sli_intf;
388 struct lpfc_pc_sli4_params pc_sli4_params;
389 struct msix_entry *msix_entries;
391 uint32_t msix_vec_nr;
392 struct lpfc_fcp_eq_hdl *fcp_eq_hdl; /* FCP per-WQ handle */
393 /* Pointers to the constructed SLI4 queues */
394 struct lpfc_queue **fp_eq; /* Fast-path event queue */
395 struct lpfc_queue *sp_eq; /* Slow-path event queue */
396 struct lpfc_queue **fcp_wq;/* Fast-path FCP work queue */
397 struct lpfc_queue *mbx_wq; /* Slow-path MBOX work queue */
398 struct lpfc_queue *els_wq; /* Slow-path ELS work queue */
399 struct lpfc_queue *hdr_rq; /* Slow-path Header Receive queue */
400 struct lpfc_queue *dat_rq; /* Slow-path Data Receive queue */
401 struct lpfc_queue **fcp_cq;/* Fast-path FCP compl queue */
402 struct lpfc_queue *mbx_cq; /* Slow-path mailbox complete queue */
403 struct lpfc_queue *els_cq; /* Slow-path ELS response complete queue */
405 /* Setup information for various queue parameters */
416 #define LPFC_SP_EQ_MAX_INTR_SEC 10000
417 #define LPFC_FP_EQ_MAX_INTR_SEC 10000
419 uint32_t intr_enable;
420 struct lpfc_bmbx bmbx;
421 struct lpfc_max_cfg_param max_cfg_param;
422 uint16_t next_xri; /* last_xri - max_cfg_param.xri_base = used */
424 uint16_t scsi_xri_max;
425 uint16_t scsi_xri_cnt;
426 struct list_head lpfc_free_sgl_list;
427 struct list_head lpfc_sgl_list;
428 struct lpfc_sglq **lpfc_els_sgl_array;
429 struct list_head lpfc_abts_els_sgl_list;
430 struct lpfc_scsi_buf **lpfc_scsi_psb_array;
431 struct list_head lpfc_abts_scsi_buf_list;
432 uint32_t total_sglq_bufs;
433 struct lpfc_sglq **lpfc_sglq_active_list;
434 struct list_head lpfc_rpi_hdr_list;
435 unsigned long *rpi_bmask;
437 struct lpfc_sli4_flags sli4_flags;
438 struct list_head sp_queue_event;
439 struct list_head sp_cqe_event_pool;
440 struct list_head sp_asynce_work_queue;
441 struct list_head sp_fcp_xri_aborted_work_queue;
442 struct list_head sp_els_xri_aborted_work_queue;
443 struct list_head sp_unsol_work_queue;
444 struct lpfc_sli4_link link_state;
445 spinlock_t abts_scsi_buf_list_lock; /* list of aborted SCSI IOs */
446 spinlock_t abts_sgl_list_lock; /* list of aborted els IOs */
454 enum lpfc_sgl_state {
461 /* lpfc_sglqs are used in double linked lists */
462 struct list_head list;
463 struct list_head clist;
464 enum lpfc_sge_type buff_type; /* is this a scsi sgl */
465 enum lpfc_sgl_state state;
466 uint16_t iotag; /* pre-assigned IO tag */
467 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
468 struct sli4_sge *sgl; /* pre-assigned SGL */
469 void *virt; /* virtual address. */
470 dma_addr_t phys; /* physical address */
473 struct lpfc_rpi_hdr {
474 struct list_head list;
476 struct lpfc_dmabuf *dmabuf;
482 * SLI4 specific function prototypes
484 int lpfc_pci_function_reset(struct lpfc_hba *);
485 int lpfc_sli4_hba_setup(struct lpfc_hba *);
486 int lpfc_sli4_config(struct lpfc_hba *, struct lpfcMboxq *, uint8_t,
487 uint8_t, uint32_t, bool);
488 void lpfc_sli4_mbox_cmd_free(struct lpfc_hba *, struct lpfcMboxq *);
489 void lpfc_sli4_mbx_sge_set(struct lpfcMboxq *, uint32_t, dma_addr_t, uint32_t);
490 void lpfc_sli4_mbx_sge_get(struct lpfcMboxq *, uint32_t,
491 struct lpfc_mbx_sge *);
492 int lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *, struct lpfcMboxq *,
495 void lpfc_sli4_hba_reset(struct lpfc_hba *);
496 struct lpfc_queue *lpfc_sli4_queue_alloc(struct lpfc_hba *, uint32_t,
498 void lpfc_sli4_queue_free(struct lpfc_queue *);
499 uint32_t lpfc_eq_create(struct lpfc_hba *, struct lpfc_queue *, uint16_t);
500 uint32_t lpfc_cq_create(struct lpfc_hba *, struct lpfc_queue *,
501 struct lpfc_queue *, uint32_t, uint32_t);
502 int32_t lpfc_mq_create(struct lpfc_hba *, struct lpfc_queue *,
503 struct lpfc_queue *, uint32_t);
504 uint32_t lpfc_wq_create(struct lpfc_hba *, struct lpfc_queue *,
505 struct lpfc_queue *, uint32_t);
506 uint32_t lpfc_rq_create(struct lpfc_hba *, struct lpfc_queue *,
507 struct lpfc_queue *, struct lpfc_queue *, uint32_t);
508 uint32_t lpfc_eq_destroy(struct lpfc_hba *, struct lpfc_queue *);
509 uint32_t lpfc_cq_destroy(struct lpfc_hba *, struct lpfc_queue *);
510 uint32_t lpfc_mq_destroy(struct lpfc_hba *, struct lpfc_queue *);
511 uint32_t lpfc_wq_destroy(struct lpfc_hba *, struct lpfc_queue *);
512 uint32_t lpfc_rq_destroy(struct lpfc_hba *, struct lpfc_queue *,
513 struct lpfc_queue *);
514 int lpfc_sli4_queue_setup(struct lpfc_hba *);
515 void lpfc_sli4_queue_unset(struct lpfc_hba *);
516 int lpfc_sli4_post_sgl(struct lpfc_hba *, dma_addr_t, dma_addr_t, uint16_t);
517 int lpfc_sli4_repost_scsi_sgl_list(struct lpfc_hba *);
518 uint16_t lpfc_sli4_next_xritag(struct lpfc_hba *);
519 int lpfc_sli4_post_async_mbox(struct lpfc_hba *);
520 int lpfc_sli4_post_sgl_list(struct lpfc_hba *phba);
521 int lpfc_sli4_post_scsi_sgl_block(struct lpfc_hba *, struct list_head *, int);
522 struct lpfc_cq_event *__lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
523 struct lpfc_cq_event *lpfc_sli4_cq_event_alloc(struct lpfc_hba *);
524 void __lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
525 void lpfc_sli4_cq_event_release(struct lpfc_hba *, struct lpfc_cq_event *);
526 int lpfc_sli4_init_rpi_hdrs(struct lpfc_hba *);
527 int lpfc_sli4_post_rpi_hdr(struct lpfc_hba *, struct lpfc_rpi_hdr *);
528 int lpfc_sli4_post_all_rpi_hdrs(struct lpfc_hba *);
529 struct lpfc_rpi_hdr *lpfc_sli4_create_rpi_hdr(struct lpfc_hba *);
530 void lpfc_sli4_remove_rpi_hdrs(struct lpfc_hba *);
531 int lpfc_sli4_alloc_rpi(struct lpfc_hba *);
532 void __lpfc_sli4_free_rpi(struct lpfc_hba *, int);
533 void lpfc_sli4_free_rpi(struct lpfc_hba *, int);
534 void lpfc_sli4_remove_rpis(struct lpfc_hba *);
535 void lpfc_sli4_async_event_proc(struct lpfc_hba *);
536 void lpfc_sli4_fcf_redisc_event_proc(struct lpfc_hba *);
537 int lpfc_sli4_resume_rpi(struct lpfc_nodelist *);
538 void lpfc_sli4_fcp_xri_abort_event_proc(struct lpfc_hba *);
539 void lpfc_sli4_els_xri_abort_event_proc(struct lpfc_hba *);
540 void lpfc_sli4_fcp_xri_aborted(struct lpfc_hba *,
541 struct sli4_wcqe_xri_aborted *);
542 void lpfc_sli4_els_xri_aborted(struct lpfc_hba *,
543 struct sli4_wcqe_xri_aborted *);
544 int lpfc_sli4_brdreset(struct lpfc_hba *);
545 int lpfc_sli4_add_fcf_record(struct lpfc_hba *, struct fcf_record *);
546 void lpfc_sli_remove_dflt_fcf(struct lpfc_hba *);
547 int lpfc_sli4_get_els_iocb_cnt(struct lpfc_hba *);
548 int lpfc_sli4_init_vpi(struct lpfc_hba *, uint16_t);
549 uint32_t lpfc_sli4_cq_release(struct lpfc_queue *, bool);
550 uint32_t lpfc_sli4_eq_release(struct lpfc_queue *, bool);
551 void lpfc_sli4_fcfi_unreg(struct lpfc_hba *, uint16_t);
552 int lpfc_sli4_fcf_scan_read_fcf_rec(struct lpfc_hba *, uint16_t);
553 int lpfc_sli4_fcf_rr_read_fcf_rec(struct lpfc_hba *, uint16_t);
554 int lpfc_sli4_read_fcf_rec(struct lpfc_hba *, uint16_t);
555 void lpfc_mbx_cmpl_fcf_scan_read_fcf_rec(struct lpfc_hba *, LPFC_MBOXQ_t *);
556 void lpfc_mbx_cmpl_fcf_rr_read_fcf_rec(struct lpfc_hba *, LPFC_MBOXQ_t *);
557 void lpfc_mbx_cmpl_read_fcf_rec(struct lpfc_hba *, LPFC_MBOXQ_t *);
558 int lpfc_sli4_unregister_fcf(struct lpfc_hba *);
559 int lpfc_sli4_post_status_check(struct lpfc_hba *);
560 uint8_t lpfc_sli4_mbox_opcode_get(struct lpfc_hba *, struct lpfcMboxq *);