1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright(c) 2017 - 2019 Pensando Systems, Inc */
3
4#ifndef _IONIC_DEV_H_
5#define _IONIC_DEV_H_
6
7#include <linux/atomic.h>
8#include <linux/mutex.h>
9#include <linux/workqueue.h>
10
11#include "ionic_if.h"
12#include "ionic_regs.h"
13
14#define IONIC_MAX_TX_DESC		8192
15#define IONIC_MAX_RX_DESC		16384
16#define IONIC_MIN_TXRX_DESC		64
17#define IONIC_DEF_TXRX_DESC		4096
18#define IONIC_RX_FILL_THRESHOLD		16
19#define IONIC_RX_FILL_DIV		8
20#define IONIC_LIFS_MAX			1024
21#define IONIC_WATCHDOG_SECS		5
22#define IONIC_ITR_COAL_USEC_DEFAULT	64
23
24#define IONIC_DEV_CMD_REG_VERSION	1
25#define IONIC_DEV_INFO_REG_COUNT	32
26#define IONIC_DEV_CMD_REG_COUNT		32
27
28#define IONIC_NAPI_DEADLINE		(HZ / 200)	/* 5ms */
29#define IONIC_ADMIN_DOORBELL_DEADLINE	(HZ / 2)	/* 500ms */
30#define IONIC_TX_DOORBELL_DEADLINE	(HZ / 100)	/* 10ms */
31#define IONIC_RX_MIN_DOORBELL_DEADLINE	(HZ / 100)	/* 10ms */
32#define IONIC_RX_MAX_DOORBELL_DEADLINE	(HZ * 5)	/* 5s */
33
34struct ionic_dev_bar {
35	void __iomem *vaddr;
36	phys_addr_t bus_addr;
37	unsigned long len;
38	int res_index;
39};
40
41#ifndef __CHECKER__
42/* Registers */
43static_assert(sizeof(struct ionic_intr) == 32);
44
45static_assert(sizeof(struct ionic_doorbell) == 8);
46static_assert(sizeof(struct ionic_intr_status) == 8);
47static_assert(sizeof(union ionic_dev_regs) == 4096);
48static_assert(sizeof(union ionic_dev_info_regs) == 2048);
49static_assert(sizeof(union ionic_dev_cmd_regs) == 2048);
50static_assert(sizeof(struct ionic_lif_stats) == 1024);
51
52static_assert(sizeof(struct ionic_admin_cmd) == 64);
53static_assert(sizeof(struct ionic_admin_comp) == 16);
54static_assert(sizeof(struct ionic_nop_cmd) == 64);
55static_assert(sizeof(struct ionic_nop_comp) == 16);
56
57/* Device commands */
58static_assert(sizeof(struct ionic_dev_identify_cmd) == 64);
59static_assert(sizeof(struct ionic_dev_identify_comp) == 16);
60static_assert(sizeof(struct ionic_dev_init_cmd) == 64);
61static_assert(sizeof(struct ionic_dev_init_comp) == 16);
62static_assert(sizeof(struct ionic_dev_reset_cmd) == 64);
63static_assert(sizeof(struct ionic_dev_reset_comp) == 16);
64static_assert(sizeof(struct ionic_dev_getattr_cmd) == 64);
65static_assert(sizeof(struct ionic_dev_getattr_comp) == 16);
66static_assert(sizeof(struct ionic_dev_setattr_cmd) == 64);
67static_assert(sizeof(struct ionic_dev_setattr_comp) == 16);
68static_assert(sizeof(struct ionic_lif_setphc_cmd) == 64);
69
70/* Port commands */
71static_assert(sizeof(struct ionic_port_identify_cmd) == 64);
72static_assert(sizeof(struct ionic_port_identify_comp) == 16);
73static_assert(sizeof(struct ionic_port_init_cmd) == 64);
74static_assert(sizeof(struct ionic_port_init_comp) == 16);
75static_assert(sizeof(struct ionic_port_reset_cmd) == 64);
76static_assert(sizeof(struct ionic_port_reset_comp) == 16);
77static_assert(sizeof(struct ionic_port_getattr_cmd) == 64);
78static_assert(sizeof(struct ionic_port_getattr_comp) == 16);
79static_assert(sizeof(struct ionic_port_setattr_cmd) == 64);
80static_assert(sizeof(struct ionic_port_setattr_comp) == 16);
81
82/* LIF commands */
83static_assert(sizeof(struct ionic_lif_init_cmd) == 64);
84static_assert(sizeof(struct ionic_lif_init_comp) == 16);
85static_assert(sizeof(struct ionic_lif_reset_cmd) == 64);
86static_assert(sizeof(ionic_lif_reset_comp) == 16);
87static_assert(sizeof(struct ionic_lif_getattr_cmd) == 64);
88static_assert(sizeof(struct ionic_lif_getattr_comp) == 16);
89static_assert(sizeof(struct ionic_lif_setattr_cmd) == 64);
90static_assert(sizeof(struct ionic_lif_setattr_comp) == 16);
91
92static_assert(sizeof(struct ionic_q_init_cmd) == 64);
93static_assert(sizeof(struct ionic_q_init_comp) == 16);
94static_assert(sizeof(struct ionic_q_control_cmd) == 64);
95static_assert(sizeof(ionic_q_control_comp) == 16);
96static_assert(sizeof(struct ionic_q_identify_cmd) == 64);
97static_assert(sizeof(struct ionic_q_identify_comp) == 16);
98
99static_assert(sizeof(struct ionic_rx_mode_set_cmd) == 64);
100static_assert(sizeof(ionic_rx_mode_set_comp) == 16);
101static_assert(sizeof(struct ionic_rx_filter_add_cmd) == 64);
102static_assert(sizeof(struct ionic_rx_filter_add_comp) == 16);
103static_assert(sizeof(struct ionic_rx_filter_del_cmd) == 64);
104static_assert(sizeof(ionic_rx_filter_del_comp) == 16);
105
106/* RDMA commands */
107static_assert(sizeof(struct ionic_rdma_reset_cmd) == 64);
108static_assert(sizeof(struct ionic_rdma_queue_cmd) == 64);
109
110/* Events */
111static_assert(sizeof(struct ionic_notifyq_cmd) == 4);
112static_assert(sizeof(union ionic_notifyq_comp) == 64);
113static_assert(sizeof(struct ionic_notifyq_event) == 64);
114static_assert(sizeof(struct ionic_link_change_event) == 64);
115static_assert(sizeof(struct ionic_reset_event) == 64);
116static_assert(sizeof(struct ionic_heartbeat_event) == 64);
117static_assert(sizeof(struct ionic_log_event) == 64);
118
119/* I/O */
120static_assert(sizeof(struct ionic_txq_desc) == 16);
121static_assert(sizeof(struct ionic_txq_sg_desc) == 128);
122static_assert(sizeof(struct ionic_txq_comp) == 16);
123
124static_assert(sizeof(struct ionic_rxq_desc) == 16);
125static_assert(sizeof(struct ionic_rxq_sg_desc) == 128);
126static_assert(sizeof(struct ionic_rxq_comp) == 16);
127
128/* SR/IOV */
129static_assert(sizeof(struct ionic_vf_setattr_cmd) == 64);
130static_assert(sizeof(struct ionic_vf_setattr_comp) == 16);
131static_assert(sizeof(struct ionic_vf_getattr_cmd) == 64);
132static_assert(sizeof(struct ionic_vf_getattr_comp) == 16);
133static_assert(sizeof(struct ionic_vf_ctrl_cmd) == 64);
134static_assert(sizeof(struct ionic_vf_ctrl_comp) == 16);
135#endif /* __CHECKER__ */
136
137struct ionic_devinfo {
138	u8 asic_type;
139	u8 asic_rev;
140	char fw_version[IONIC_DEVINFO_FWVERS_BUFLEN + 1];
141	char serial_num[IONIC_DEVINFO_SERIAL_BUFLEN + 1];
142};
143
144struct ionic_dev {
145	union ionic_dev_info_regs __iomem *dev_info_regs;
146	union ionic_dev_cmd_regs __iomem *dev_cmd_regs;
147	struct ionic_hwstamp_regs __iomem *hwstamp_regs;
148
149	atomic_long_t last_check_time;
150	unsigned long last_hb_time;
151	u32 last_fw_hb;
152	bool fw_hb_ready;
153	bool fw_status_ready;
154	u8 fw_generation;
155	u8 opcode;
156
157	u64 __iomem *db_pages;
158	dma_addr_t phy_db_pages;
159
160	struct ionic_intr __iomem *intr_ctrl;
161	u64 __iomem *intr_status;
162
163	struct mutex cmb_inuse_lock; /* for cmb_inuse */
164	unsigned long *cmb_inuse;
165	dma_addr_t phy_cmb_pages;
166	u32 cmb_npages;
167
168	u32 port_info_sz;
169	struct ionic_port_info *port_info;
170	dma_addr_t port_info_pa;
171
172	struct ionic_devinfo dev_info;
173};
174
175struct ionic_cq_info {
176	union {
177		void *cq_desc;
178		struct ionic_admin_comp *admincq;
179		struct ionic_notifyq_event *notifyq;
180	};
181};
182
183struct ionic_queue;
184struct ionic_qcq;
185struct ionic_desc_info;
186
187typedef void (*ionic_desc_cb)(struct ionic_queue *q,
188			      struct ionic_desc_info *desc_info,
189			      struct ionic_cq_info *cq_info, void *cb_arg);
190
191#define IONIC_MAX_BUF_LEN			((u16)-1)
192#define IONIC_PAGE_SIZE				PAGE_SIZE
193#define IONIC_PAGE_SPLIT_SZ			(PAGE_SIZE / 2)
194#define IONIC_PAGE_GFP_MASK			(GFP_ATOMIC | __GFP_NOWARN |\
195						 __GFP_COMP | __GFP_MEMALLOC)
196
197struct ionic_buf_info {
198	struct page *page;
199	dma_addr_t dma_addr;
200	u32 page_offset;
201	u32 len;
202};
203
204#define IONIC_MAX_FRAGS			(1 + IONIC_TX_MAX_SG_ELEMS_V1)
205
206struct ionic_desc_info {
207	union {
208		void *desc;
209		struct ionic_txq_desc *txq_desc;
210		struct ionic_rxq_desc *rxq_desc;
211		struct ionic_admin_cmd *adminq_desc;
212	};
213	void __iomem *cmb_desc;
214	union {
215		void *sg_desc;
216		struct ionic_txq_sg_desc *txq_sg_desc;
217		struct ionic_rxq_sg_desc *rxq_sgl_desc;
218	};
219	unsigned int bytes;
220	unsigned int nbufs;
221	struct ionic_buf_info bufs[IONIC_MAX_FRAGS];
222	ionic_desc_cb cb;
223	void *cb_arg;
224};
225
226#define IONIC_QUEUE_NAME_MAX_SZ		16
227
228struct ionic_queue {
229	struct device *dev;
230	struct ionic_lif *lif;
231	struct ionic_desc_info *info;
232	u64 dbval;
233	unsigned long dbell_deadline;
234	unsigned long dbell_jiffies;
235	u16 head_idx;
236	u16 tail_idx;
237	unsigned int index;
238	unsigned int num_descs;
239	unsigned int max_sg_elems;
240	u64 features;
241	u64 drop;
242	struct ionic_dev *idev;
243	unsigned int type;
244	unsigned int hw_index;
245	unsigned int hw_type;
246	union {
247		void *base;
248		struct ionic_txq_desc *txq;
249		struct ionic_rxq_desc *rxq;
250		struct ionic_admin_cmd *adminq;
251	};
252	void __iomem *cmb_base;
253	union {
254		void *sg_base;
255		struct ionic_txq_sg_desc *txq_sgl;
256		struct ionic_rxq_sg_desc *rxq_sgl;
257	};
258	dma_addr_t base_pa;
259	dma_addr_t cmb_base_pa;
260	dma_addr_t sg_base_pa;
261	unsigned int desc_size;
262	unsigned int sg_desc_size;
263	unsigned int pid;
264	char name[IONIC_QUEUE_NAME_MAX_SZ];
265} ____cacheline_aligned_in_smp;
266
267#define IONIC_INTR_INDEX_NOT_ASSIGNED	-1
268#define IONIC_INTR_NAME_MAX_SZ		32
269
270struct ionic_intr_info {
271	char name[IONIC_INTR_NAME_MAX_SZ];
272	unsigned int index;
273	unsigned int vector;
274	u64 rearm_count;
275	unsigned int cpu;
276	cpumask_t affinity_mask;
277	u32 dim_coal_hw;
278};
279
280struct ionic_cq {
281	struct ionic_lif *lif;
282	struct ionic_cq_info *info;
283	struct ionic_queue *bound_q;
284	struct ionic_intr_info *bound_intr;
285	u16 tail_idx;
286	bool done_color;
287	unsigned int num_descs;
288	unsigned int desc_size;
289	void *base;
290	dma_addr_t base_pa;
291} ____cacheline_aligned_in_smp;
292
293struct ionic;
294
295static inline void ionic_intr_init(struct ionic_dev *idev,
296				   struct ionic_intr_info *intr,
297				   unsigned long index)
298{
299	ionic_intr_clean(idev->intr_ctrl, index);
300	intr->index = index;
301}
302
303static inline unsigned int ionic_q_space_avail(struct ionic_queue *q)
304{
305	unsigned int avail = q->tail_idx;
306
307	if (q->head_idx >= avail)
308		avail += q->num_descs - q->head_idx - 1;
309	else
310		avail -= q->head_idx + 1;
311
312	return avail;
313}
314
315static inline bool ionic_q_has_space(struct ionic_queue *q, unsigned int want)
316{
317	return ionic_q_space_avail(q) >= want;
318}
319
320void ionic_init_devinfo(struct ionic *ionic);
321int ionic_dev_setup(struct ionic *ionic);
322void ionic_dev_teardown(struct ionic *ionic);
323
324void ionic_dev_cmd_go(struct ionic_dev *idev, union ionic_dev_cmd *cmd);
325u8 ionic_dev_cmd_status(struct ionic_dev *idev);
326bool ionic_dev_cmd_done(struct ionic_dev *idev);
327void ionic_dev_cmd_comp(struct ionic_dev *idev, union ionic_dev_cmd_comp *comp);
328
329void ionic_dev_cmd_identify(struct ionic_dev *idev, u8 ver);
330void ionic_dev_cmd_init(struct ionic_dev *idev);
331void ionic_dev_cmd_reset(struct ionic_dev *idev);
332
333void ionic_dev_cmd_port_identify(struct ionic_dev *idev);
334void ionic_dev_cmd_port_init(struct ionic_dev *idev);
335void ionic_dev_cmd_port_reset(struct ionic_dev *idev);
336void ionic_dev_cmd_port_state(struct ionic_dev *idev, u8 state);
337void ionic_dev_cmd_port_speed(struct ionic_dev *idev, u32 speed);
338void ionic_dev_cmd_port_autoneg(struct ionic_dev *idev, u8 an_enable);
339void ionic_dev_cmd_port_fec(struct ionic_dev *idev, u8 fec_type);
340void ionic_dev_cmd_port_pause(struct ionic_dev *idev, u8 pause_type);
341
342int ionic_set_vf_config(struct ionic *ionic, int vf,
343			struct ionic_vf_setattr_cmd *vfc);
344int ionic_dev_cmd_vf_getattr(struct ionic *ionic, int vf, u8 attr,
345			     struct ionic_vf_getattr_comp *comp);
346void ionic_dev_cmd_queue_identify(struct ionic_dev *idev,
347				  u16 lif_type, u8 qtype, u8 qver);
348void ionic_vf_start(struct ionic *ionic);
349void ionic_dev_cmd_lif_identify(struct ionic_dev *idev, u8 type, u8 ver);
350void ionic_dev_cmd_lif_init(struct ionic_dev *idev, u16 lif_index,
351			    dma_addr_t addr);
352void ionic_dev_cmd_lif_reset(struct ionic_dev *idev, u16 lif_index);
353void ionic_dev_cmd_adminq_init(struct ionic_dev *idev, struct ionic_qcq *qcq,
354			       u16 lif_index, u16 intr_index);
355
356int ionic_db_page_num(struct ionic_lif *lif, int pid);
357
358int ionic_get_cmb(struct ionic_lif *lif, u32 *pgid, phys_addr_t *pgaddr, int order);
359void ionic_put_cmb(struct ionic_lif *lif, u32 pgid, int order);
360
361int ionic_cq_init(struct ionic_lif *lif, struct ionic_cq *cq,
362		  struct ionic_intr_info *intr,
363		  unsigned int num_descs, size_t desc_size);
364void ionic_cq_map(struct ionic_cq *cq, void *base, dma_addr_t base_pa);
365void ionic_cq_bind(struct ionic_cq *cq, struct ionic_queue *q);
366typedef bool (*ionic_cq_cb)(struct ionic_cq *cq, struct ionic_cq_info *cq_info);
367typedef void (*ionic_cq_done_cb)(void *done_arg);
368unsigned int ionic_cq_service(struct ionic_cq *cq, unsigned int work_to_do,
369			      ionic_cq_cb cb, ionic_cq_done_cb done_cb,
370			      void *done_arg);
371
372int ionic_q_init(struct ionic_lif *lif, struct ionic_dev *idev,
373		 struct ionic_queue *q, unsigned int index, const char *name,
374		 unsigned int num_descs, size_t desc_size,
375		 size_t sg_desc_size, unsigned int pid);
376void ionic_q_map(struct ionic_queue *q, void *base, dma_addr_t base_pa);
377void ionic_q_cmb_map(struct ionic_queue *q, void __iomem *base, dma_addr_t base_pa);
378void ionic_q_sg_map(struct ionic_queue *q, void *base, dma_addr_t base_pa);
379void ionic_q_post(struct ionic_queue *q, bool ring_doorbell, ionic_desc_cb cb,
380		  void *cb_arg);
381void ionic_q_service(struct ionic_queue *q, struct ionic_cq_info *cq_info,
382		     unsigned int stop_index);
383int ionic_heartbeat_check(struct ionic *ionic);
384bool ionic_is_fw_running(struct ionic_dev *idev);
385
386bool ionic_adminq_poke_doorbell(struct ionic_queue *q);
387bool ionic_txq_poke_doorbell(struct ionic_queue *q);
388bool ionic_rxq_poke_doorbell(struct ionic_queue *q);
389
390#endif /* _IONIC_DEV_H_ */
391