1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * QLogic FCoE Offload Driver
4 * Copyright (c) 2016-2018 Cavium Inc.
9 #include <scsi/libfcoe.h>
10 #include <scsi/libfc.h>
11 #include <scsi/fc/fc_fip.h>
12 #include <scsi/fc/fc_fc2.h>
13 #include <scsi/scsi_tcq.h>
14 #include <scsi/fc_encode.h>
15 #include <linux/version.h>
18 /* qedf_hsi.h needs to before included any qed includes */
21 #include <linux/qed/qed_if.h>
22 #include <linux/qed/qed_fcoe_if.h>
23 #include <linux/qed/qed_ll2_if.h>
24 #include "qedf_version.h"
26 #include "drv_fcoe_fw_funcs.h"
28 /* Helpers to extract upper and lower 32-bits of pointer */
29 #define U64_HI(val) ((u32)(((u64)(val)) >> 32))
30 #define U64_LO(val) ((u32)(((u64)(val)) & 0xffffffff))
32 #define QEDF_DESCR "QLogic FCoE Offload Driver"
33 #define QEDF_MODULE_NAME "qedf"
35 #define QEDF_FLOGI_RETRY_CNT 3
36 #define QEDF_RPORT_RETRY_CNT 255
37 #define QEDF_MAX_SESSIONS 1024
38 #define QEDF_MAX_PAYLOAD 2048
39 #define QEDF_MAX_BDS_PER_CMD 256
40 #define QEDF_MAX_BD_LEN 0xffff
41 #define QEDF_BD_SPLIT_SZ 0x1000
42 #define QEDF_PAGE_SIZE 4096
43 #define QED_HW_DMA_BOUNDARY 0xfff
44 #define QEDF_MAX_SGLEN_FOR_CACHESGL ((1U << 16) - 1)
45 #define QEDF_MFS (QEDF_MAX_PAYLOAD + \
46 sizeof(struct fc_frame_header))
47 #define QEDF_MAX_NPIV 64
48 #define QEDF_TM_TIMEOUT 10
49 #define QEDF_ABORT_TIMEOUT (10 * 1000)
50 #define QEDF_CLEANUP_TIMEOUT 1
51 #define QEDF_MAX_CDB_LEN 16
52 #define QEDF_LL2_BUF_SIZE 2500 /* Buffer size required for LL2 Rx */
54 #define UPSTREAM_REMOVE 1
55 #define UPSTREAM_KEEP 1
60 dma_addr_t req_buf_dma;
61 struct scsi_sge *mp_req_bd;
62 dma_addr_t mp_req_bd_dma;
63 struct fc_frame_header req_fc_hdr;
67 dma_addr_t resp_buf_dma;
68 struct scsi_sge *mp_resp_bd;
69 dma_addr_t mp_resp_bd_dma;
70 struct fc_frame_header resp_fc_hdr;
73 struct qedf_els_cb_arg {
74 struct qedf_ioreq *aborted_io_req;
75 struct qedf_ioreq *io_req;
76 u8 op; /* Used to keep track of ELS op */
78 u32 offset; /* Used for sequence cleanup */
79 u8 r_ctl; /* Used for sequence cleanup */
82 enum qedf_ioreq_event {
84 QEDF_IOREQ_EV_ABORT_SUCCESS,
85 QEDF_IOREQ_EV_ABORT_FAILED,
86 QEDF_IOREQ_EV_SEND_RRQ,
87 QEDF_IOREQ_EV_ELS_TMO,
88 QEDF_IOREQ_EV_ELS_ERR_DETECT,
89 QEDF_IOREQ_EV_ELS_FLUSH,
90 QEDF_IOREQ_EV_CLEANUP_SUCCESS,
91 QEDF_IOREQ_EV_CLEANUP_FAILED,
95 #define FCOE_FCP_RSP_FLAGS_FCP_RESID_OVER (0x1<<2)
96 #define FCOE_FCP_RSP_FLAGS_FCP_RESID_UNDER (0x1<<3)
97 #define CMD_SCSI_STATUS(Cmnd) ((Cmnd)->SCp.Status)
98 #define FCOE_FCP_RSP_FLAGS_FCP_RSP_LEN_VALID (0x1<<0)
99 #define FCOE_FCP_RSP_FLAGS_FCP_SNS_LEN_VALID (0x1<<1)
101 struct list_head link;
103 struct scsi_cmnd *sc_cmd;
104 #define QEDF_SCSI_CMD 1
105 #define QEDF_TASK_MGMT_CMD 2
108 #define QEDF_CLEANUP 5
109 #define QEDF_SEQ_CLEANUP 6
111 #define QEDF_CMD_OUTSTANDING 0x0
112 #define QEDF_CMD_IN_ABORT 0x1
113 #define QEDF_CMD_IN_CLEANUP 0x2
114 #define QEDF_CMD_SRR_SENT 0x3
115 #define QEDF_CMD_DIRTY 0x4
116 #define QEDF_CMD_ERR_SCSI_DONE 0x5
119 struct qedf_rport *fcport;
120 #define QEDF_CMD_ST_INACTIVE 0
121 #define QEDFC_CMD_ST_IO_ACTIVE 1
122 #define QEDFC_CMD_ST_ABORT_ACTIVE 2
123 #define QEDFC_CMD_ST_ABORT_ACTIVE_EH 3
124 #define QEDFC_CMD_ST_CLEANUP_ACTIVE 4
125 #define QEDFC_CMD_ST_CLEANUP_ACTIVE_EH 5
126 #define QEDFC_CMD_ST_RRQ_ACTIVE 6
127 #define QEDFC_CMD_ST_RRQ_WAIT 7
128 #define QEDFC_CMD_ST_OXID_RETIRE_WAIT 8
129 #define QEDFC_CMD_ST_TMF_ACTIVE 9
130 #define QEDFC_CMD_ST_DRAIN_ACTIVE 10
131 #define QEDFC_CMD_ST_CLEANED 11
132 #define QEDFC_CMD_ST_ELS_ACTIVE 12
135 enum qedf_ioreq_event event;
136 size_t data_xfer_len;
137 /* ID: 001: Alloc cmd (qedf_alloc_cmd) */
138 /* ID: 002: Initiate ABTS (qedf_initiate_abts) */
139 /* ID: 003: For RRQ (qedf_process_abts_compl) */
140 struct kref refcount;
141 struct qedf_cmd_mgr *cmd_mgr;
142 struct io_bdt *bd_tbl;
143 struct delayed_work timeout_work;
144 struct completion tm_done;
145 struct completion abts_done;
146 struct completion cleanup_done;
147 struct e4_fcoe_task_context *task;
148 struct fcoe_task_params *task_params;
149 struct scsi_sgl_task_params *sgl_task_params;
153 * Need to allocate enough room for both sense data and FCP response data
154 * which has a max length of 8 bytes according to spec.
156 #define QEDF_SCSI_SENSE_BUFFERSIZE (SCSI_SENSE_BUFFERSIZE + 8)
157 uint8_t *sense_buffer;
158 dma_addr_t sense_buffer_dma;
166 #define QEDF_MAX_REUSE 0xfff
168 struct qedf_mp_req mp_req;
169 void (*cb_func)(struct qedf_els_cb_arg *cb_arg);
170 struct qedf_els_cb_arg *cb_arg;
173 unsigned int int_cpu;
174 #define QEDF_IOREQ_UNKNOWN_SGE 1
175 #define QEDF_IOREQ_SLOW_SGE 2
176 #define QEDF_IOREQ_FAST_SGE 3
178 struct delayed_work rrq_work;
180 /* Used for sequence level recovery; i.e. REC/SRR */
184 uint32_t task_retry_identifier;
187 * Used to tell if we need to return a SCSI command
188 * during some form of error processing.
190 bool return_scsi_cmd_on_abts;
195 extern struct workqueue_struct *qedf_io_wq;
198 spinlock_t rport_lock;
199 #define QEDF_RPORT_SESSION_READY 1
200 #define QEDF_RPORT_UPLOADING_CONNECTION 2
201 #define QEDF_RPORT_IN_RESET 3
202 #define QEDF_RPORT_IN_LUN_RESET 4
203 #define QEDF_RPORT_IN_TARGET_RESET 5
206 unsigned long retry_delay_timestamp;
207 struct fc_rport *rport;
208 struct fc_rport_priv *rdata;
209 struct qedf_ctx *qedf;
210 u32 handle; /* Handle from qed */
211 u32 fw_cid; /* fw_cid from qed */
212 void __iomem *p_doorbell;
213 /* Send queue management */
215 atomic_t ios_to_queue;
216 atomic_t num_active_ios;
224 dma_addr_t sq_pbl_dma;
227 #define QEDF_RPORT_TYPE_DISK 0
228 #define QEDF_RPORT_TYPE_TAPE 1
229 uint dev_type; /* Disk or tape */
230 struct list_head peers;
233 /* Used to contain LL2 skb's in ll2_skb_list */
234 struct qedf_skb_work {
235 struct work_struct work;
237 struct qedf_ctx *qedf;
240 struct qedf_fastpath {
241 #define QEDF_SB_ID_NULL 0xffff
243 struct qed_sb_info *sb_info;
244 struct qedf_ctx *qedf;
245 /* Keep track of number of completions on this fastpath */
246 unsigned long completions;
247 uint32_t cq_num_entries;
250 /* Used to pass fastpath information needed to process CQEs */
251 struct qedf_io_work {
252 struct work_struct work;
254 struct qedf_ctx *qedf;
258 struct qedf_glbl_q_params {
259 u64 hw_p_cq; /* Completion queue PBL */
260 u64 hw_p_rq; /* Request queue PBL */
261 u64 hw_p_cmdq; /* Command queue PBL */
264 struct global_queue {
268 u32 cq_cons_idx; /* Completion queue consumer index */
272 dma_addr_t cq_pbl_dma;
276 /* I/O tracing entry */
277 #define QEDF_IO_TRACE_SIZE 2048
279 #define QEDF_IO_TRACE_REQ 0
280 #define QEDF_IO_TRACE_RSP 1
283 uint32_t port_id; /* Remote port fabric ID */
285 unsigned char op; /* SCSI CDB */
287 unsigned int bufflen; /* SCSI buffer length */
288 unsigned int sg_count; /* Number of SG elements */
289 int result; /* Result passed back to mid-layer */
290 unsigned long jiffies; /* Time stamp when I/O logged */
291 int refcount; /* Reference count for task id */
292 unsigned int req_cpu; /* CPU that the task is queued on */
293 unsigned int int_cpu; /* Interrupt CPU that the task is received on */
294 unsigned int rsp_cpu; /* CPU that task is returned on */
295 u8 sge_type; /* Did we take the slow, single or fast SGE path */
298 /* Number of entries in BDQ */
299 #define QEDF_BDQ_SIZE 256
300 #define QEDF_BDQ_BUF_SIZE 2072
302 /* DMA coherent buffers for BDQ */
303 struct qedf_bdq_buf {
308 /* Main adapter struct */
310 struct qedf_dbg_ctx dbg_ctx;
311 struct fcoe_ctlr ctlr;
312 struct fc_lport *lport;
313 u8 data_src_addr[ETH_ALEN];
314 #define QEDF_LINK_DOWN 0
315 #define QEDF_LINK_UP 1
317 #define QEDF_DCBX_PENDING 0
318 #define QEDF_DCBX_DONE 1
320 #define QEDF_NULL_VLAN_ID -1
321 #define QEDF_FALLBACK_VLAN 1002
322 #define QEDF_DEFAULT_PRIO 3
325 struct qed_dev *cdev;
326 struct qed_dev_fcoe_info dev_info;
327 struct qed_int_info int_info;
328 uint16_t last_command;
330 struct pci_dev *pdev;
333 u8 __aligned(16) mac[ETH_ALEN];
334 struct list_head fcports;
335 atomic_t num_offloads;
336 unsigned int curr_conn_id;
337 struct workqueue_struct *ll2_recv_wq;
338 struct workqueue_struct *link_update_wq;
339 struct delayed_work link_update;
340 struct delayed_work link_recovery;
341 struct completion flogi_compl;
342 struct completion fipvlan_compl;
345 * Used to tell if we're in the window where we are waiting for
346 * the link to come back up before informting fcoe that the link is
349 atomic_t link_down_tmo_valid;
350 #define QEDF_TIMER_INTERVAL (1 * HZ)
351 struct timer_list timer; /* One second book keeping timer */
352 #define QEDF_DRAIN_ACTIVE 1
353 #define QEDF_LL2_STARTED 2
354 #define QEDF_UNLOADING 3
355 #define QEDF_GRCDUMP_CAPTURE 4
356 #define QEDF_IN_RECOVERY 5
357 #define QEDF_DBG_STOP_IO 6
358 #define QEDF_PROBING 8
359 unsigned long flags; /* Miscellaneous state flags */
362 struct global_queue **global_queues;
363 /* Pointer to array of queue structures */
364 struct qedf_glbl_q_params *p_cpuq;
365 /* Physical address of array of queue structures */
366 dma_addr_t hw_p_cpuq;
368 struct qedf_bdq_buf bdq[QEDF_BDQ_SIZE];
370 dma_addr_t bdq_pbl_dma;
371 size_t bdq_pbl_mem_size;
373 dma_addr_t bdq_pbl_list_dma;
374 u8 bdq_pbl_list_num_entries;
375 void __iomem *bdq_primary_prod;
376 void __iomem *bdq_secondary_prod;
377 uint16_t bdq_prod_idx;
379 /* Structure for holding all the fastpath for this qedf_ctx */
380 struct qedf_fastpath *fp_array;
381 struct qed_fcoe_tid tasks;
382 struct qedf_cmd_mgr *cmd_mgr;
383 /* Holds the PF parameters we pass to qed to start he FCoE function */
384 struct qed_pf_params pf_params;
385 /* Used to time middle path ELS and TM commands */
386 struct workqueue_struct *timer_work_queue;
388 #define QEDF_IO_WORK_MIN 64
389 mempool_t *io_mempool;
390 struct workqueue_struct *dpc_wq;
391 struct delayed_work recovery_work;
392 struct delayed_work grcdump_work;
393 struct delayed_work stag_work;
399 uint32_t grcdump_size;
401 struct qedf_io_log io_trace_buf[QEDF_IO_TRACE_SIZE];
402 spinlock_t io_trace_lock;
403 uint16_t io_trace_idx;
405 bool stop_io_on_error;
411 /* Used for fc statistics */
412 struct mutex stats_mutex;
415 u64 control_requests;
422 /* Used for flush routine */
423 struct mutex flush_mutex;
427 struct qedf_ioreq *io_req;
428 struct scsi_sge *bd_tbl;
429 dma_addr_t bd_tbl_dma;
433 struct qedf_cmd_mgr {
434 struct qedf_ctx *qedf;
436 struct io_bdt **io_bdt_pool;
437 #define FCOE_PARAMS_NUM_TASKS 2048
438 struct qedf_ioreq cmds[FCOE_PARAMS_NUM_TASKS];
440 atomic_t free_list_cnt;
443 /* Stolen from qed_cxt_api.h and adapted for qed_fcoe_info
447 * ptr = qedf_get_task_mem(&qedf->tasks, 128);
449 static inline void *qedf_get_task_mem(struct qed_fcoe_tid *info, u32 tid)
451 return (void *)(info->blocks[tid / info->num_tids_per_block] +
452 (tid % info->num_tids_per_block) * info->size);
455 static inline void qedf_stop_all_io(struct qedf_ctx *qedf)
457 set_bit(QEDF_DBG_STOP_IO, &qedf->flags);
465 * (QEDF_LOG_NPIV | QEDF_LOG_SESS | QEDF_LOG_LPORT | QEDF_LOG_ELS | QEDF_LOG_MQ
466 * | QEDF_LOG_IO | QEDF_LOG_UNSOL | QEDF_LOG_SCSI_TM | QEDF_LOG_MP_REQ |
467 * QEDF_LOG_EVT | QEDF_LOG_CONN | QEDF_LOG_DISC | QEDF_LOG_INFO)
469 #define QEDF_DEFAULT_LOG_MASK 0x3CFB6
470 extern const struct qed_fcoe_ops *qed_ops;
471 extern uint qedf_dump_frames;
472 extern uint qedf_io_tracing;
473 extern uint qedf_stop_io_on_error;
474 extern uint qedf_link_down_tmo;
475 #define QEDF_RETRY_DELAY_MAX 600 /* 60 seconds */
476 extern bool qedf_retry_delay;
477 extern uint qedf_debug;
479 extern struct qedf_cmd_mgr *qedf_cmd_mgr_alloc(struct qedf_ctx *qedf);
480 extern void qedf_cmd_mgr_free(struct qedf_cmd_mgr *cmgr);
481 extern int qedf_queuecommand(struct Scsi_Host *host,
482 struct scsi_cmnd *sc_cmd);
483 extern void qedf_fip_send(struct fcoe_ctlr *fip, struct sk_buff *skb);
484 extern u8 *qedf_get_src_mac(struct fc_lport *lport);
485 extern void qedf_fip_recv(struct qedf_ctx *qedf, struct sk_buff *skb);
486 extern void qedf_fcoe_send_vlan_req(struct qedf_ctx *qedf);
487 extern void qedf_scsi_completion(struct qedf_ctx *qedf, struct fcoe_cqe *cqe,
488 struct qedf_ioreq *io_req);
489 extern void qedf_process_warning_compl(struct qedf_ctx *qedf,
490 struct fcoe_cqe *cqe, struct qedf_ioreq *io_req);
491 extern void qedf_process_error_detect(struct qedf_ctx *qedf,
492 struct fcoe_cqe *cqe, struct qedf_ioreq *io_req);
493 extern void qedf_flush_active_ios(struct qedf_rport *fcport, int lun);
494 extern void qedf_release_cmd(struct kref *ref);
495 extern int qedf_initiate_abts(struct qedf_ioreq *io_req,
496 bool return_scsi_cmd_on_abts);
497 extern void qedf_process_abts_compl(struct qedf_ctx *qedf, struct fcoe_cqe *cqe,
498 struct qedf_ioreq *io_req);
499 extern struct qedf_ioreq *qedf_alloc_cmd(struct qedf_rport *fcport,
502 extern struct device_attribute *qedf_host_attrs[];
503 extern void qedf_cmd_timer_set(struct qedf_ctx *qedf, struct qedf_ioreq *io_req,
504 unsigned int timer_msec);
505 extern int qedf_init_mp_req(struct qedf_ioreq *io_req);
506 extern void qedf_init_mp_task(struct qedf_ioreq *io_req,
507 struct e4_fcoe_task_context *task_ctx, struct fcoe_wqe *sqe);
508 extern u16 qedf_get_sqe_idx(struct qedf_rport *fcport);
509 extern void qedf_ring_doorbell(struct qedf_rport *fcport);
510 extern void qedf_process_els_compl(struct qedf_ctx *qedf, struct fcoe_cqe *cqe,
511 struct qedf_ioreq *els_req);
512 extern int qedf_send_rrq(struct qedf_ioreq *aborted_io_req);
513 extern int qedf_send_adisc(struct qedf_rport *fcport, struct fc_frame *fp);
514 extern int qedf_initiate_cleanup(struct qedf_ioreq *io_req,
515 bool return_scsi_cmd_on_abts);
516 extern void qedf_process_cleanup_compl(struct qedf_ctx *qedf,
517 struct fcoe_cqe *cqe, struct qedf_ioreq *io_req);
518 extern int qedf_initiate_tmf(struct scsi_cmnd *sc_cmd, u8 tm_flags);
519 extern void qedf_process_tmf_compl(struct qedf_ctx *qedf, struct fcoe_cqe *cqe,
520 struct qedf_ioreq *io_req);
521 extern void qedf_process_cqe(struct qedf_ctx *qedf, struct fcoe_cqe *cqe);
522 extern void qedf_scsi_done(struct qedf_ctx *qedf, struct qedf_ioreq *io_req,
524 extern void qedf_set_vlan_id(struct qedf_ctx *qedf, int vlan_id);
525 extern void qedf_create_sysfs_ctx_attr(struct qedf_ctx *qedf);
526 extern void qedf_remove_sysfs_ctx_attr(struct qedf_ctx *qedf);
527 extern void qedf_capture_grc_dump(struct qedf_ctx *qedf);
528 bool qedf_wait_for_upload(struct qedf_ctx *qedf);
529 extern void qedf_process_unsol_compl(struct qedf_ctx *qedf, uint16_t que_idx,
530 struct fcoe_cqe *cqe);
531 extern void qedf_restart_rport(struct qedf_rport *fcport);
532 extern int qedf_send_rec(struct qedf_ioreq *orig_io_req);
533 extern int qedf_post_io_req(struct qedf_rport *fcport,
534 struct qedf_ioreq *io_req);
535 extern void qedf_process_seq_cleanup_compl(struct qedf_ctx *qedf,
536 struct fcoe_cqe *cqe, struct qedf_ioreq *io_req);
537 extern int qedf_send_flogi(struct qedf_ctx *qedf);
538 extern void qedf_get_protocol_tlv_data(void *dev, void *data);
539 extern void qedf_fp_io_handler(struct work_struct *work);
540 extern void qedf_get_generic_tlv_data(void *dev, struct qed_generic_tlvs *data);
541 extern void qedf_wq_grcdump(struct work_struct *work);
542 void qedf_stag_change_work(struct work_struct *work);
543 void qedf_ctx_soft_reset(struct fc_lport *lport);
545 #define FCOE_WORD_TO_BYTE 4
546 #define QEDF_MAX_TASK_NUM 0xFFFF
550 struct fip_header fip;
552 struct fip_mac_desc mac;
553 struct fip_wwn_desc wwnn;
558 #define GBL_RSVD_TASKS 16
559 #define NUM_TASKS_PER_CONNECTION 1024
560 #define NUM_RW_TASKS_PER_CONNECTION 512
561 #define FCOE_PARAMS_CQ_NUM_ENTRIES FCOE_PARAMS_NUM_TASKS
563 #define FCOE_PARAMS_CMDQ_NUM_ENTRIES FCOE_PARAMS_NUM_TASKS
564 #define SQ_NUM_ENTRIES NUM_TASKS_PER_CONNECTION
566 #define QEDF_FCOE_PARAMS_GL_RQ_PI 0
567 #define QEDF_FCOE_PARAMS_GL_CMD_PI 1
569 #define QEDF_READ (1 << 1)
570 #define QEDF_WRITE (1 << 0)
571 #define MAX_FIBRE_LUNS 0xffffffff
573 #define MIN_NUM_CPUS_MSIX(x) min_t(u32, x->dev_info.num_cqs, \
577 * PCI function probe defines
579 /* Probe/remove called during normal PCI probe */
580 #define QEDF_MODE_NORMAL 0
581 /* Probe/remove called from qed error recovery */
582 #define QEDF_MODE_RECOVERY 1
584 #define SUPPORTED_25000baseKR_Full (1<<27)
585 #define SUPPORTED_50000baseKR2_Full (1<<28)
586 #define SUPPORTED_100000baseKR4_Full (1<<29)
587 #define SUPPORTED_100000baseCR4_Full (1<<30)