xref: /openbmc/linux/drivers/scsi/qedi/qedi.h (revision 3fb5a21f)
1 /*
2  * QLogic iSCSI Offload Driver
3  * Copyright (c) 2016 Cavium Inc.
4  *
5  * This software is available under the terms of the GNU General Public License
6  * (GPL) Version 2, available from the file COPYING in the main directory of
7  * this source tree.
8  */
9 
10 #ifndef _QEDI_H_
11 #define _QEDI_H_
12 
13 #define __PREVENT_QED_HSI__
14 
15 #include <scsi/scsi_transport_iscsi.h>
16 #include <scsi/libiscsi.h>
17 #include <scsi/scsi_host.h>
18 #include <linux/uio_driver.h>
19 
20 #include "qedi_hsi.h"
21 #include <linux/qed/qed_if.h>
22 #include "qedi_dbg.h"
23 #include <linux/qed/qed_iscsi_if.h>
24 #include <linux/qed/qed_ll2_if.h>
25 #include "qedi_version.h"
26 #include "qedi_nvm_iscsi_cfg.h"
27 
28 #define QEDI_MODULE_NAME		"qedi"
29 
30 struct qedi_endpoint;
31 
32 #ifndef GET_FIELD2
33 #define GET_FIELD2(value, name) \
34 	(((value) & (name ## _MASK)) >> (name ## _OFFSET))
35 #endif
36 
37 /*
38  * PCI function probe defines
39  */
40 #define QEDI_MODE_NORMAL	0
41 #define QEDI_MODE_RECOVERY	1
42 
43 #define ISCSI_WQE_SET_PTU_INVALIDATE	1
44 #define QEDI_MAX_ISCSI_TASK		4096
45 #define QEDI_MAX_TASK_NUM		0x0FFF
46 #define QEDI_MAX_ISCSI_CONNS_PER_HBA	1024
47 #define QEDI_ISCSI_MAX_BDS_PER_CMD	255	/* Firmware max BDs is 255 */
48 #define MAX_OUSTANDING_TASKS_PER_CON	1024
49 
50 #define QEDI_MAX_BD_LEN		0xffff
51 #define QEDI_BD_SPLIT_SZ	0x1000
52 #define QEDI_PAGE_SIZE		4096
53 #define QEDI_FAST_SGE_COUNT	4
54 /* MAX Length for cached SGL */
55 #define MAX_SGLEN_FOR_CACHESGL	((1U << 16) - 1)
56 
57 #define MIN_NUM_CPUS_MSIX(x)	min_t(u32, x->dev_info.num_cqs, \
58 					num_online_cpus())
59 
60 #define QEDI_LOCAL_PORT_MIN     60000
61 #define QEDI_LOCAL_PORT_MAX     61024
62 #define QEDI_LOCAL_PORT_RANGE   (QEDI_LOCAL_PORT_MAX - QEDI_LOCAL_PORT_MIN)
63 #define QEDI_LOCAL_PORT_INVALID	0xffff
64 #define TX_RX_RING		16
65 #define RX_RING			(TX_RX_RING - 1)
66 #define LL2_SINGLE_BUF_SIZE	0x400
67 #define QEDI_PAGE_ALIGN(addr)	ALIGN(addr, QEDI_PAGE_SIZE)
68 #define QEDI_PAGE_MASK		(~((QEDI_PAGE_SIZE) - 1))
69 
70 #define QEDI_HW_DMA_BOUNDARY	0xfff
71 #define QEDI_PATH_HANDLE	0xFE0000000UL
72 
73 enum qedi_nvm_tgts {
74 	QEDI_NVM_TGT_PRI,
75 	QEDI_NVM_TGT_SEC,
76 };
77 
78 struct qedi_nvm_iscsi_image {
79 	struct nvm_iscsi_cfg iscsi_cfg;
80 	u32 crc;
81 };
82 
83 struct qedi_uio_ctrl {
84 	/* meta data */
85 	u32 uio_hsi_version;
86 
87 	/* user writes */
88 	u32 host_tx_prod;
89 	u32 host_rx_cons;
90 	u32 host_rx_bd_cons;
91 	u32 host_tx_pkt_len;
92 	u32 host_rx_cons_cnt;
93 
94 	/* driver writes */
95 	u32 hw_tx_cons;
96 	u32 hw_rx_prod;
97 	u32 hw_rx_bd_prod;
98 	u32 hw_rx_prod_cnt;
99 
100 	/* other */
101 	u8 mac_addr[6];
102 	u8 reserve[2];
103 };
104 
105 struct qedi_rx_bd {
106 	u32 rx_pkt_index;
107 	u32 rx_pkt_len;
108 	u16 vlan_id;
109 };
110 
111 #define QEDI_RX_DESC_CNT	(QEDI_PAGE_SIZE / sizeof(struct qedi_rx_bd))
112 #define QEDI_MAX_RX_DESC_CNT	(QEDI_RX_DESC_CNT - 1)
113 #define QEDI_NUM_RX_BD		(QEDI_RX_DESC_CNT * 1)
114 #define QEDI_MAX_RX_BD		(QEDI_NUM_RX_BD - 1)
115 
116 #define QEDI_NEXT_RX_IDX(x)	((((x) & (QEDI_MAX_RX_DESC_CNT)) ==	\
117 				  (QEDI_MAX_RX_DESC_CNT - 1)) ?		\
118 				 (x) + 2 : (x) + 1)
119 
120 struct qedi_uio_dev {
121 	struct uio_info		qedi_uinfo;
122 	u32			uio_dev;
123 	struct list_head	list;
124 
125 	u32			ll2_ring_size;
126 	void			*ll2_ring;
127 
128 	u32			ll2_buf_size;
129 	void			*ll2_buf;
130 
131 	void			*rx_pkt;
132 	void			*tx_pkt;
133 
134 	struct qedi_ctx		*qedi;
135 	struct pci_dev		*pdev;
136 	void			*uctrl;
137 };
138 
139 /* List to maintain the skb pointers */
140 struct skb_work_list {
141 	struct list_head list;
142 	struct sk_buff *skb;
143 	u16 vlan_id;
144 };
145 
146 /* Queue sizes in number of elements */
147 #define QEDI_SQ_SIZE		MAX_OUSTANDING_TASKS_PER_CON
148 #define QEDI_CQ_SIZE		2048
149 #define QEDI_CMDQ_SIZE		QEDI_MAX_ISCSI_TASK
150 #define QEDI_PROTO_CQ_PROD_IDX	0
151 
152 struct qedi_glbl_q_params {
153 	u64 hw_p_cq;	/* Completion queue PBL */
154 	u64 hw_p_rq;	/* Request queue PBL */
155 	u64 hw_p_cmdq;	/* Command queue PBL */
156 };
157 
158 struct global_queue {
159 	union iscsi_cqe *cq;
160 	dma_addr_t cq_dma;
161 	u32 cq_mem_size;
162 	u32 cq_cons_idx; /* Completion queue consumer index */
163 
164 	void *cq_pbl;
165 	dma_addr_t cq_pbl_dma;
166 	u32 cq_pbl_size;
167 
168 };
169 
170 struct qedi_fastpath {
171 	struct qed_sb_info	*sb_info;
172 	u16			sb_id;
173 #define QEDI_NAME_SIZE		16
174 	char			name[QEDI_NAME_SIZE];
175 	struct qedi_ctx         *qedi;
176 };
177 
178 /* Used to pass fastpath information needed to process CQEs */
179 struct qedi_io_work {
180 	struct list_head list;
181 	struct iscsi_cqe_solicited cqe;
182 	u16	que_idx;
183 };
184 
185 /**
186  * struct iscsi_cid_queue - Per adapter iscsi cid queue
187  *
188  * @cid_que_base:           queue base memory
189  * @cid_que:                queue memory pointer
190  * @cid_q_prod_idx:         produce index
191  * @cid_q_cons_idx:         consumer index
192  * @cid_q_max_idx:          max index. used to detect wrap around condition
193  * @cid_free_cnt:           queue size
194  * @conn_cid_tbl:           iscsi cid to conn structure mapping table
195  *
196  * Per adapter iSCSI CID Queue
197  */
198 struct iscsi_cid_queue {
199 	void *cid_que_base;
200 	u32 *cid_que;
201 	u32 cid_q_prod_idx;
202 	u32 cid_q_cons_idx;
203 	u32 cid_q_max_idx;
204 	u32 cid_free_cnt;
205 	struct qedi_conn **conn_cid_tbl;
206 };
207 
208 struct qedi_portid_tbl {
209 	spinlock_t      lock;	/* Port id lock */
210 	u16             start;
211 	u16             max;
212 	u16             next;
213 	unsigned long   *table;
214 };
215 
216 struct qedi_itt_map {
217 	__le32	itt;
218 	struct qedi_cmd *p_cmd;
219 };
220 
221 /* I/O tracing entry */
222 #define QEDI_IO_TRACE_SIZE             2048
223 struct qedi_io_log {
224 #define QEDI_IO_TRACE_REQ              0
225 #define QEDI_IO_TRACE_RSP              1
226 	u8 direction;
227 	u16 task_id;
228 	u32 cid;
229 	u32 port_id;	/* Remote port fabric ID */
230 	int lun;
231 	u8 op;		/* SCSI CDB */
232 	u8 lba[4];
233 	unsigned int bufflen;	/* SCSI buffer length */
234 	unsigned int sg_count;	/* Number of SG elements */
235 	u8 fast_sgs;		/* number of fast sgls */
236 	u8 slow_sgs;		/* number of slow sgls */
237 	u8 cached_sgs;		/* number of cached sgls */
238 	int result;		/* Result passed back to mid-layer */
239 	unsigned long jiffies;	/* Time stamp when I/O logged */
240 	int refcount;		/* Reference count for task id */
241 	unsigned int blk_req_cpu; /* CPU that the task is queued on by
242 				   * blk layer
243 				   */
244 	unsigned int req_cpu;	/* CPU that the task is queued on */
245 	unsigned int intr_cpu;	/* Interrupt CPU that the task is received on */
246 	unsigned int blk_rsp_cpu;/* CPU that task is actually processed and
247 				  * returned to blk layer
248 				  */
249 	bool cached_sge;
250 	bool slow_sge;
251 	bool fast_sge;
252 };
253 
254 /* Number of entries in BDQ */
255 #define QEDI_BDQ_NUM		256
256 #define QEDI_BDQ_BUF_SIZE	256
257 
258 /* DMA coherent buffers for BDQ */
259 struct qedi_bdq_buf {
260 	void *buf_addr;
261 	dma_addr_t buf_dma;
262 };
263 
264 /* Main port level struct */
265 struct qedi_ctx {
266 	struct qedi_dbg_ctx dbg_ctx;
267 	struct Scsi_Host *shost;
268 	struct pci_dev *pdev;
269 	struct qed_dev *cdev;
270 	struct qed_dev_iscsi_info dev_info;
271 	struct qed_int_info int_info;
272 	struct qedi_glbl_q_params *p_cpuq;
273 	struct global_queue **global_queues;
274 	/* uio declaration */
275 	struct qedi_uio_dev *udev;
276 	struct list_head ll2_skb_list;
277 	spinlock_t ll2_lock;	/* Light L2 lock */
278 	spinlock_t hba_lock;	/* per port lock */
279 	struct task_struct *ll2_recv_thread;
280 	unsigned long flags;
281 #define UIO_DEV_OPENED		1
282 #define QEDI_IOTHREAD_WAKE	2
283 #define QEDI_IN_RECOVERY	5
284 #define QEDI_IN_OFFLINE		6
285 
286 	u8 mac[ETH_ALEN];
287 	u32 src_ip[4];
288 	u8 ip_type;
289 
290 	/* Physical address of above array */
291 	dma_addr_t hw_p_cpuq;
292 
293 	struct qedi_bdq_buf bdq[QEDI_BDQ_NUM];
294 	void *bdq_pbl;
295 	dma_addr_t bdq_pbl_dma;
296 	size_t bdq_pbl_mem_size;
297 	void *bdq_pbl_list;
298 	dma_addr_t bdq_pbl_list_dma;
299 	u8 bdq_pbl_list_num_entries;
300 	struct qedi_nvm_iscsi_image *iscsi_image;
301 	dma_addr_t nvm_buf_dma;
302 	void __iomem *bdq_primary_prod;
303 	void __iomem *bdq_secondary_prod;
304 	u16 bdq_prod_idx;
305 	u16 rq_num_entries;
306 
307 	u32 max_sqes;
308 	u8 num_queues;
309 	u32 max_active_conns;
310 
311 	struct iscsi_cid_queue cid_que;
312 	struct qedi_endpoint **ep_tbl;
313 	struct qedi_portid_tbl lcl_port_tbl;
314 
315 	/* Rx fast path intr context */
316 	struct qed_sb_info	*sb_array;
317 	struct qedi_fastpath	*fp_array;
318 	struct qed_iscsi_tid	tasks;
319 
320 #define QEDI_LINK_DOWN		0
321 #define QEDI_LINK_UP		1
322 	atomic_t link_state;
323 
324 #define QEDI_RESERVE_TASK_ID	0
325 #define MAX_ISCSI_TASK_ENTRIES	4096
326 #define QEDI_INVALID_TASK_ID	(MAX_ISCSI_TASK_ENTRIES + 1)
327 	unsigned long task_idx_map[MAX_ISCSI_TASK_ENTRIES / BITS_PER_LONG];
328 	struct qedi_itt_map *itt_map;
329 	u16 tid_reuse_count[QEDI_MAX_ISCSI_TASK];
330 	struct qed_pf_params pf_params;
331 
332 	struct workqueue_struct *tmf_thread;
333 	struct workqueue_struct *offload_thread;
334 
335 	u16 ll2_mtu;
336 
337 	struct workqueue_struct *dpc_wq;
338 
339 	spinlock_t task_idx_lock;	/* To protect gbl context */
340 	s32 last_tidx_alloc;
341 	s32 last_tidx_clear;
342 
343 	struct qedi_io_log io_trace_buf[QEDI_IO_TRACE_SIZE];
344 	spinlock_t io_trace_lock;	/* prtect trace Log buf */
345 	u16 io_trace_idx;
346 	unsigned int intr_cpu;
347 	u32 cached_sgls;
348 	bool use_cached_sge;
349 	u32 slow_sgls;
350 	bool use_slow_sge;
351 	u32 fast_sgls;
352 	bool use_fast_sge;
353 
354 	atomic_t num_offloads;
355 #define SYSFS_FLAG_FW_SEL_BOOT 2
356 #define IPV6_LEN	41
357 #define IPV4_LEN	17
358 	struct iscsi_boot_kset *boot_kset;
359 
360 	/* Used for iscsi statistics */
361 	struct mutex stats_lock;
362 };
363 
364 struct qedi_work {
365 	struct list_head list;
366 	struct qedi_ctx *qedi;
367 	union iscsi_cqe cqe;
368 	u16     que_idx;
369 	bool is_solicited;
370 };
371 
372 struct qedi_percpu_s {
373 	struct task_struct *iothread;
374 	struct list_head work_list;
375 	spinlock_t p_work_lock;		/* Per cpu worker lock */
376 };
377 
378 static inline void *qedi_get_task_mem(struct qed_iscsi_tid *info, u32 tid)
379 {
380 	return (info->blocks[tid / info->num_tids_per_block] +
381 		(tid % info->num_tids_per_block) * info->size);
382 }
383 
384 #define QEDI_U64_HI(val) ((u32)(((u64)(val)) >> 32))
385 #define QEDI_U64_LO(val) ((u32)(((u64)(val)) & 0xffffffff))
386 
387 #endif /* _QEDI_H_ */
388