xref: /openbmc/linux/drivers/scsi/bnx2fc/bnx2fc.h (revision 54525552)
1 #ifndef _BNX2FC_H_
2 #define _BNX2FC_H_
3 /* bnx2fc.h: Broadcom NetXtreme II Linux FCoE offload driver.
4  *
5  * Copyright (c) 2008 - 2010 Broadcom Corporation
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation.
10  *
11  * Written by: Bhanu Prakash Gollapudi (bprakash@broadcom.com)
12  */
13 
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/kernel.h>
17 #include <linux/skbuff.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/if_ether.h>
21 #include <linux/if_vlan.h>
22 #include <linux/kthread.h>
23 #include <linux/crc32.h>
24 #include <linux/cpu.h>
25 #include <linux/types.h>
26 #include <linux/list.h>
27 #include <linux/delay.h>
28 #include <linux/timer.h>
29 #include <linux/errno.h>
30 #include <linux/pci.h>
31 #include <linux/init.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/workqueue.h>
34 #include <linux/mutex.h>
35 #include <linux/spinlock.h>
36 #include <linux/bitops.h>
37 #include <linux/log2.h>
38 #include <linux/interrupt.h>
39 #include <linux/sched.h>
40 #include <linux/io.h>
41 
42 #include <scsi/scsi.h>
43 #include <scsi/scsi_host.h>
44 #include <scsi/scsi_device.h>
45 #include <scsi/scsi_cmnd.h>
46 #include <scsi/scsi_eh.h>
47 #include <scsi/scsi_tcq.h>
48 #include <scsi/libfc.h>
49 #include <scsi/libfcoe.h>
50 #include <scsi/fc_encode.h>
51 #include <scsi/scsi_transport.h>
52 #include <scsi/scsi_transport_fc.h>
53 #include <scsi/fc/fc_fip.h>
54 #include <scsi/fc/fc_fc2.h>
55 #include <scsi/fc_frame.h>
56 #include <scsi/fc/fc_fcoe.h>
57 #include <scsi/fc/fc_fcp.h>
58 
59 #include "57xx_hsi_bnx2fc.h"
60 #include "bnx2fc_debug.h"
61 #include "../../net/cnic_if.h"
62 #include "bnx2fc_constants.h"
63 
64 #define BNX2FC_NAME		"bnx2fc"
65 #define BNX2FC_VERSION		"1.0.1"
66 
67 #define PFX			"bnx2fc: "
68 
69 #define BNX2X_DOORBELL_PCI_BAR		2
70 
71 #define BNX2FC_MAX_BD_LEN		0xffff
72 #define BNX2FC_BD_SPLIT_SZ		0x8000
73 #define BNX2FC_MAX_BDS_PER_CMD		256
74 
75 #define BNX2FC_SQ_WQES_MAX	256
76 
77 #define BNX2FC_SCSI_MAX_SQES	((3 * BNX2FC_SQ_WQES_MAX) / 8)
78 #define BNX2FC_TM_MAX_SQES	((BNX2FC_SQ_WQES_MAX) / 2)
79 #define BNX2FC_ELS_MAX_SQES	(BNX2FC_TM_MAX_SQES - 1)
80 
81 #define BNX2FC_RQ_WQES_MAX	16
82 #define BNX2FC_CQ_WQES_MAX	(BNX2FC_SQ_WQES_MAX + BNX2FC_RQ_WQES_MAX)
83 
84 #define BNX2FC_NUM_MAX_SESS	128
85 #define BNX2FC_NUM_MAX_SESS_LOG	(ilog2(BNX2FC_NUM_MAX_SESS))
86 
87 #define BNX2FC_MAX_OUTSTANDING_CMNDS	2048
88 #define BNX2FC_CAN_QUEUE		BNX2FC_MAX_OUTSTANDING_CMNDS
89 #define BNX2FC_ELSTM_XIDS		BNX2FC_CAN_QUEUE
90 #define BNX2FC_MIN_PAYLOAD		256
91 #define BNX2FC_MAX_PAYLOAD		2048
92 #define BNX2FC_MFS			\
93 			(BNX2FC_MAX_PAYLOAD + sizeof(struct fc_frame_header))
94 #define BNX2FC_MINI_JUMBO_MTU		2500
95 
96 
97 #define BNX2FC_RQ_BUF_SZ		256
98 #define BNX2FC_RQ_BUF_LOG_SZ		(ilog2(BNX2FC_RQ_BUF_SZ))
99 
100 #define BNX2FC_SQ_WQE_SIZE		(sizeof(struct fcoe_sqe))
101 #define BNX2FC_CQ_WQE_SIZE		(sizeof(struct fcoe_cqe))
102 #define BNX2FC_RQ_WQE_SIZE		(BNX2FC_RQ_BUF_SZ)
103 #define BNX2FC_XFERQ_WQE_SIZE		(sizeof(struct fcoe_xfrqe))
104 #define BNX2FC_CONFQ_WQE_SIZE		(sizeof(struct fcoe_confqe))
105 #define BNX2FC_5771X_DB_PAGE_SIZE	128
106 
107 #define BNX2FC_MAX_TASKS		\
108 			     (BNX2FC_MAX_OUTSTANDING_CMNDS + BNX2FC_ELSTM_XIDS)
109 #define BNX2FC_TASK_SIZE		128
110 #define	BNX2FC_TASKS_PER_PAGE		(PAGE_SIZE/BNX2FC_TASK_SIZE)
111 #define BNX2FC_TASK_CTX_ARR_SZ		(BNX2FC_MAX_TASKS/BNX2FC_TASKS_PER_PAGE)
112 
113 #define BNX2FC_MAX_ROWS_IN_HASH_TBL	8
114 #define BNX2FC_HASH_TBL_CHUNK_SIZE	(16 * 1024)
115 
116 #define BNX2FC_MAX_SEQS			255
117 
118 #define BNX2FC_READ			(1 << 1)
119 #define BNX2FC_WRITE			(1 << 0)
120 
121 #define BNX2FC_MIN_XID			0
122 #define BNX2FC_MAX_XID			\
123 			(BNX2FC_MAX_OUTSTANDING_CMNDS + BNX2FC_ELSTM_XIDS - 1)
124 #define FCOE_MIN_XID			(BNX2FC_MAX_XID + 1)
125 #define FCOE_MAX_XID			(FCOE_MIN_XID + 4095)
126 #define BNX2FC_MAX_LUN			0xFFFF
127 #define BNX2FC_MAX_FCP_TGT		256
128 #define BNX2FC_MAX_CMD_LEN		16
129 
130 #define BNX2FC_TM_TIMEOUT		60	/* secs */
131 #define BNX2FC_IO_TIMEOUT		20000UL	/* msecs */
132 
133 #define BNX2FC_WAIT_CNT			1200
134 #define BNX2FC_FW_TIMEOUT		(3 * HZ)
135 #define PORT_MAX			2
136 
137 #define CMD_SCSI_STATUS(Cmnd)		((Cmnd)->SCp.Status)
138 
139 /* FC FCP Status */
140 #define	FC_GOOD				0
141 
142 #define BNX2FC_RNID_HBA			0x7
143 
144 /* bnx2fc driver uses only one instance of fcoe_percpu_s */
145 extern struct fcoe_percpu_s bnx2fc_global;
146 
147 extern struct workqueue_struct *bnx2fc_wq;
148 
149 struct bnx2fc_percpu_s {
150 	struct task_struct *iothread;
151 	struct list_head work_list;
152 	spinlock_t fp_work_lock;
153 };
154 
155 
156 struct bnx2fc_hba {
157 	struct list_head link;
158 	struct cnic_dev *cnic;
159 	struct pci_dev *pcidev;
160 	struct net_device *netdev;
161 	struct net_device *phys_dev;
162 	unsigned long reg_with_cnic;
163 		#define BNX2FC_CNIC_REGISTERED           1
164 	struct packet_type fcoe_packet_type;
165 	struct packet_type fip_packet_type;
166 	struct bnx2fc_cmd_mgr *cmd_mgr;
167 	struct workqueue_struct *timer_work_queue;
168 	struct kref kref;
169 	spinlock_t hba_lock;
170 	struct mutex hba_mutex;
171 	unsigned long adapter_state;
172 		#define ADAPTER_STATE_UP		0
173 		#define ADAPTER_STATE_GOING_DOWN	1
174 		#define ADAPTER_STATE_LINK_DOWN		2
175 		#define ADAPTER_STATE_READY		3
176 	u32 flags;
177 	unsigned long init_done;
178 		#define BNX2FC_FW_INIT_DONE		0
179 		#define BNX2FC_CTLR_INIT_DONE		1
180 		#define BNX2FC_CREATE_DONE		2
181 	struct fcoe_ctlr ctlr;
182 	u8 vlan_enabled;
183 	int vlan_id;
184 	u32 next_conn_id;
185 	struct fcoe_task_ctx_entry **task_ctx;
186 	dma_addr_t *task_ctx_dma;
187 	struct regpair *task_ctx_bd_tbl;
188 	dma_addr_t task_ctx_bd_dma;
189 
190 	int hash_tbl_segment_count;
191 	void **hash_tbl_segments;
192 	void *hash_tbl_pbl;
193 	dma_addr_t hash_tbl_pbl_dma;
194 	struct fcoe_t2_hash_table_entry *t2_hash_tbl;
195 	dma_addr_t t2_hash_tbl_dma;
196 	char *t2_hash_tbl_ptr;
197 	dma_addr_t t2_hash_tbl_ptr_dma;
198 
199 	char *dummy_buffer;
200 	dma_addr_t dummy_buf_dma;
201 
202 	struct fcoe_statistics_params *stats_buffer;
203 	dma_addr_t stats_buf_dma;
204 
205 	/*
206 	 * PCI related info.
207 	 */
208 	u16 pci_did;
209 	u16 pci_vid;
210 	u16 pci_sdid;
211 	u16 pci_svid;
212 	u16 pci_func;
213 	u16 pci_devno;
214 
215 	struct task_struct *l2_thread;
216 
217 	/* linkdown handling */
218 	wait_queue_head_t shutdown_wait;
219 	int wait_for_link_down;
220 
221 	/*destroy handling */
222 	struct timer_list destroy_timer;
223 	wait_queue_head_t destroy_wait;
224 
225 	/* Active list of offloaded sessions */
226 	struct bnx2fc_rport *tgt_ofld_list[BNX2FC_NUM_MAX_SESS];
227 	int num_ofld_sess;
228 
229 	/* statistics */
230 	struct completion stat_req_done;
231 };
232 
233 #define bnx2fc_from_ctlr(fip) container_of(fip, struct bnx2fc_hba, ctlr)
234 
235 struct bnx2fc_cmd_mgr {
236 	struct bnx2fc_hba *hba;
237 	u16 next_idx;
238 	struct list_head *free_list;
239 	spinlock_t *free_list_lock;
240 	struct io_bdt **io_bdt_pool;
241 	struct bnx2fc_cmd **cmds;
242 };
243 
244 struct bnx2fc_rport {
245 	struct fcoe_port *port;
246 	struct fc_rport *rport;
247 	struct fc_rport_priv *rdata;
248 	void __iomem *ctx_base;
249 #define DPM_TRIGER_TYPE		0x40
250 	u32 fcoe_conn_id;
251 	u32 context_id;
252 	u32 sid;
253 
254 	unsigned long flags;
255 #define BNX2FC_FLAG_SESSION_READY	0x1
256 #define BNX2FC_FLAG_OFFLOADED		0x2
257 #define BNX2FC_FLAG_DISABLED		0x3
258 #define BNX2FC_FLAG_DESTROYED		0x4
259 #define BNX2FC_FLAG_OFLD_REQ_CMPL	0x5
260 #define BNX2FC_FLAG_DESTROY_CMPL	0x6
261 #define BNX2FC_FLAG_CTX_ALLOC_FAILURE	0x7
262 #define BNX2FC_FLAG_UPLD_REQ_COMPL	0x8
263 #define BNX2FC_FLAG_EXPL_LOGO		0x9
264 
265 	u32 max_sqes;
266 	u32 max_rqes;
267 	u32 max_cqes;
268 
269 	struct fcoe_sqe *sq;
270 	dma_addr_t sq_dma;
271 	u16 sq_prod_idx;
272 	u8 sq_curr_toggle_bit;
273 	u32 sq_mem_size;
274 
275 	struct fcoe_cqe *cq;
276 	dma_addr_t cq_dma;
277 	u32 cq_cons_idx;
278 	u8 cq_curr_toggle_bit;
279 	u32 cq_mem_size;
280 
281 	void *rq;
282 	dma_addr_t rq_dma;
283 	u32 rq_prod_idx;
284 	u32 rq_cons_idx;
285 	u32 rq_mem_size;
286 
287 	void *rq_pbl;
288 	dma_addr_t rq_pbl_dma;
289 	u32 rq_pbl_size;
290 
291 	struct fcoe_xfrqe *xferq;
292 	dma_addr_t xferq_dma;
293 	u32 xferq_mem_size;
294 
295 	struct fcoe_confqe *confq;
296 	dma_addr_t confq_dma;
297 	u32 confq_mem_size;
298 
299 	void *confq_pbl;
300 	dma_addr_t confq_pbl_dma;
301 	u32 confq_pbl_size;
302 
303 	struct fcoe_conn_db *conn_db;
304 	dma_addr_t conn_db_dma;
305 	u32 conn_db_mem_size;
306 
307 	struct fcoe_sqe *lcq;
308 	dma_addr_t lcq_dma;
309 	u32 lcq_mem_size;
310 
311 	void *ofld_req[4];
312 	dma_addr_t ofld_req_dma[4];
313 	void *enbl_req;
314 	dma_addr_t enbl_req_dma;
315 
316 	spinlock_t tgt_lock;
317 	spinlock_t cq_lock;
318 	atomic_t num_active_ios;
319 	u32 flush_in_prog;
320 	unsigned long work_time_slice;
321 	unsigned long timestamp;
322 	struct list_head free_task_list;
323 	struct bnx2fc_cmd *pending_queue[BNX2FC_SQ_WQES_MAX+1];
324 	atomic_t pi;
325 	atomic_t ci;
326 	struct list_head active_cmd_queue;
327 	struct list_head els_queue;
328 	struct list_head io_retire_queue;
329 	struct list_head active_tm_queue;
330 
331 	struct timer_list ofld_timer;
332 	wait_queue_head_t ofld_wait;
333 
334 	struct timer_list upld_timer;
335 	wait_queue_head_t upld_wait;
336 };
337 
338 struct bnx2fc_mp_req {
339 	u8 tm_flags;
340 
341 	u32 req_len;
342 	void *req_buf;
343 	dma_addr_t req_buf_dma;
344 	struct fcoe_bd_ctx *mp_req_bd;
345 	dma_addr_t mp_req_bd_dma;
346 	struct fc_frame_header req_fc_hdr;
347 
348 	u32 resp_len;
349 	void *resp_buf;
350 	dma_addr_t resp_buf_dma;
351 	struct fcoe_bd_ctx *mp_resp_bd;
352 	dma_addr_t mp_resp_bd_dma;
353 	struct fc_frame_header resp_fc_hdr;
354 };
355 
356 struct bnx2fc_els_cb_arg {
357 	struct bnx2fc_cmd *aborted_io_req;
358 	struct bnx2fc_cmd *io_req;
359 	u16 l2_oxid;
360 };
361 
362 /* bnx2fc command structure */
363 struct bnx2fc_cmd {
364 	struct list_head link;
365 	u8 on_active_queue;
366 	u8 on_tmf_queue;
367 	u8 cmd_type;
368 #define BNX2FC_SCSI_CMD		1
369 #define BNX2FC_TASK_MGMT_CMD		2
370 #define BNX2FC_ABTS			3
371 #define BNX2FC_ELS			4
372 #define BNX2FC_CLEANUP			5
373 	u8 io_req_flags;
374 	struct kref refcount;
375 	struct fcoe_port *port;
376 	struct bnx2fc_rport *tgt;
377 	struct scsi_cmnd *sc_cmd;
378 	struct bnx2fc_cmd_mgr *cmd_mgr;
379 	struct bnx2fc_mp_req mp_req;
380 	void (*cb_func)(struct bnx2fc_els_cb_arg *cb_arg);
381 	struct bnx2fc_els_cb_arg *cb_arg;
382 	struct delayed_work timeout_work; /* timer for ULP timeouts */
383 	struct completion tm_done;
384 	int wait_for_comp;
385 	u16 xid;
386 	struct fcoe_task_ctx_entry *task;
387 	struct io_bdt *bd_tbl;
388 	struct fcp_rsp *rsp;
389 	size_t data_xfer_len;
390 	unsigned long req_flags;
391 #define BNX2FC_FLAG_ISSUE_RRQ		0x1
392 #define BNX2FC_FLAG_ISSUE_ABTS		0x2
393 #define BNX2FC_FLAG_ABTS_DONE		0x3
394 #define BNX2FC_FLAG_TM_COMPL		0x4
395 #define BNX2FC_FLAG_TM_TIMEOUT		0x5
396 #define BNX2FC_FLAG_IO_CLEANUP		0x6
397 #define BNX2FC_FLAG_RETIRE_OXID		0x7
398 #define	BNX2FC_FLAG_EH_ABORT		0x8
399 #define BNX2FC_FLAG_IO_COMPL		0x9
400 #define BNX2FC_FLAG_ELS_DONE		0xa
401 #define BNX2FC_FLAG_ELS_TIMEOUT		0xb
402 	u32 fcp_resid;
403 	u32 fcp_rsp_len;
404 	u32 fcp_sns_len;
405 	u8 cdb_status; /* SCSI IO status */
406 	u8 fcp_status; /* FCP IO status */
407 	u8 fcp_rsp_code;
408 	u8 scsi_comp_flags;
409 };
410 
411 struct io_bdt {
412 	struct bnx2fc_cmd *io_req;
413 	struct fcoe_bd_ctx *bd_tbl;
414 	dma_addr_t bd_tbl_dma;
415 	u16 bd_valid;
416 };
417 
418 struct bnx2fc_work {
419 	struct list_head list;
420 	struct bnx2fc_rport *tgt;
421 	u16 wqe;
422 };
423 struct bnx2fc_unsol_els {
424 	struct fc_lport *lport;
425 	struct fc_frame *fp;
426 	struct work_struct unsol_els_work;
427 };
428 
429 
430 
431 struct bnx2fc_cmd *bnx2fc_elstm_alloc(struct bnx2fc_rport *tgt, int type);
432 void bnx2fc_cmd_release(struct kref *ref);
433 int bnx2fc_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *sc_cmd);
434 int bnx2fc_send_fw_fcoe_init_msg(struct bnx2fc_hba *hba);
435 int bnx2fc_send_fw_fcoe_destroy_msg(struct bnx2fc_hba *hba);
436 int bnx2fc_send_session_ofld_req(struct fcoe_port *port,
437 					struct bnx2fc_rport *tgt);
438 int bnx2fc_send_session_disable_req(struct fcoe_port *port,
439 				    struct bnx2fc_rport *tgt);
440 int bnx2fc_send_session_destroy_req(struct bnx2fc_hba *hba,
441 					struct bnx2fc_rport *tgt);
442 int bnx2fc_map_doorbell(struct bnx2fc_rport *tgt);
443 void bnx2fc_indicate_kcqe(void *context, struct kcqe *kcq[],
444 					u32 num_cqe);
445 int bnx2fc_setup_task_ctx(struct bnx2fc_hba *hba);
446 void bnx2fc_free_task_ctx(struct bnx2fc_hba *hba);
447 int bnx2fc_setup_fw_resc(struct bnx2fc_hba *hba);
448 void bnx2fc_free_fw_resc(struct bnx2fc_hba *hba);
449 struct bnx2fc_cmd_mgr *bnx2fc_cmd_mgr_alloc(struct bnx2fc_hba *hba,
450 						u16 min_xid, u16 max_xid);
451 void bnx2fc_cmd_mgr_free(struct bnx2fc_cmd_mgr *cmgr);
452 void bnx2fc_get_link_state(struct bnx2fc_hba *hba);
453 char *bnx2fc_get_next_rqe(struct bnx2fc_rport *tgt, u8 num_items);
454 void bnx2fc_return_rqe(struct bnx2fc_rport *tgt, u8 num_items);
455 int bnx2fc_get_paged_crc_eof(struct sk_buff *skb, int tlen);
456 int bnx2fc_send_rrq(struct bnx2fc_cmd *aborted_io_req);
457 int bnx2fc_send_adisc(struct bnx2fc_rport *tgt, struct fc_frame *fp);
458 int bnx2fc_send_logo(struct bnx2fc_rport *tgt, struct fc_frame *fp);
459 int bnx2fc_send_rls(struct bnx2fc_rport *tgt, struct fc_frame *fp);
460 int bnx2fc_initiate_cleanup(struct bnx2fc_cmd *io_req);
461 int bnx2fc_initiate_abts(struct bnx2fc_cmd *io_req);
462 void bnx2fc_cmd_timer_set(struct bnx2fc_cmd *io_req,
463 			  unsigned int timer_msec);
464 int bnx2fc_init_mp_req(struct bnx2fc_cmd *io_req);
465 void bnx2fc_init_cleanup_task(struct bnx2fc_cmd *io_req,
466 			      struct fcoe_task_ctx_entry *task,
467 			      u16 orig_xid);
468 void bnx2fc_init_mp_task(struct bnx2fc_cmd *io_req,
469 			 struct fcoe_task_ctx_entry *task);
470 void bnx2fc_init_task(struct bnx2fc_cmd *io_req,
471 			     struct fcoe_task_ctx_entry *task);
472 void bnx2fc_add_2_sq(struct bnx2fc_rport *tgt, u16 xid);
473 void bnx2fc_ring_doorbell(struct bnx2fc_rport *tgt);
474 int bnx2fc_eh_abort(struct scsi_cmnd *sc_cmd);
475 int bnx2fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
476 int bnx2fc_eh_target_reset(struct scsi_cmnd *sc_cmd);
477 int bnx2fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
478 void bnx2fc_rport_event_handler(struct fc_lport *lport,
479 				struct fc_rport_priv *rport,
480 				enum fc_rport_event event);
481 void bnx2fc_process_scsi_cmd_compl(struct bnx2fc_cmd *io_req,
482 				   struct fcoe_task_ctx_entry *task,
483 				   u8 num_rq);
484 void bnx2fc_process_cleanup_compl(struct bnx2fc_cmd *io_req,
485 			       struct fcoe_task_ctx_entry *task,
486 			       u8 num_rq);
487 void bnx2fc_process_abts_compl(struct bnx2fc_cmd *io_req,
488 			       struct fcoe_task_ctx_entry *task,
489 			       u8 num_rq);
490 void bnx2fc_process_tm_compl(struct bnx2fc_cmd *io_req,
491 			     struct fcoe_task_ctx_entry *task,
492 			     u8 num_rq);
493 void bnx2fc_process_els_compl(struct bnx2fc_cmd *els_req,
494 			      struct fcoe_task_ctx_entry *task,
495 			      u8 num_rq);
496 void bnx2fc_build_fcp_cmnd(struct bnx2fc_cmd *io_req,
497 			   struct fcp_cmnd *fcp_cmnd);
498 
499 
500 
501 void bnx2fc_flush_active_ios(struct bnx2fc_rport *tgt);
502 struct fc_seq *bnx2fc_elsct_send(struct fc_lport *lport, u32 did,
503 				      struct fc_frame *fp, unsigned int op,
504 				      void (*resp)(struct fc_seq *,
505 						   struct fc_frame *,
506 						   void *),
507 				      void *arg, u32 timeout);
508 int bnx2fc_process_new_cqes(struct bnx2fc_rport *tgt);
509 void bnx2fc_process_cq_compl(struct bnx2fc_rport *tgt, u16 wqe);
510 struct bnx2fc_rport *bnx2fc_tgt_lookup(struct fcoe_port *port,
511 					     u32 port_id);
512 void bnx2fc_process_l2_frame_compl(struct bnx2fc_rport *tgt,
513 				   unsigned char *buf,
514 				   u32 frame_len, u16 l2_oxid);
515 int bnx2fc_send_stat_req(struct bnx2fc_hba *hba);
516 
517 #endif
518