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