xref: /dpdk/drivers/net/ionic/ionic_dev.h (revision 598f6726)
1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
2  * Copyright(c) 2018-2019 Pensando Systems, Inc. All rights reserved.
3  */
4 
5 #ifndef _IONIC_DEV_H_
6 #define _IONIC_DEV_H_
7 
8 #include "ionic_osdep.h"
9 #include "ionic_if.h"
10 #include "ionic_regs.h"
11 
12 #define IONIC_MIN_MTU			RTE_ETHER_MIN_MTU
13 #define IONIC_MAX_MTU			9194
14 
15 #define IONIC_MAX_RING_DESC		32768
16 #define IONIC_MIN_RING_DESC		16
17 
18 #define IONIC_LIFS_MAX			1024
19 
20 #define IONIC_DEVCMD_TIMEOUT	30 /* devcmd_timeout */
21 #define	IONIC_ALIGN             4096
22 
23 struct ionic_adapter;
24 
25 struct ionic_dev_bar {
26 	void __iomem *vaddr;
27 	rte_iova_t bus_addr;
28 	unsigned long len;
29 };
30 
31 static inline void ionic_struct_size_checks(void)
32 {
33 	RTE_BUILD_BUG_ON(sizeof(struct ionic_doorbell) != 8);
34 	RTE_BUILD_BUG_ON(sizeof(struct ionic_intr) != 32);
35 	RTE_BUILD_BUG_ON(sizeof(struct ionic_intr_status) != 8);
36 
37 	RTE_BUILD_BUG_ON(sizeof(union ionic_dev_regs) != 4096);
38 	RTE_BUILD_BUG_ON(sizeof(union ionic_dev_info_regs) != 2048);
39 	RTE_BUILD_BUG_ON(sizeof(union ionic_dev_cmd_regs) != 2048);
40 
41 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_stats) != 1024);
42 
43 	RTE_BUILD_BUG_ON(sizeof(struct ionic_admin_cmd) != 64);
44 	RTE_BUILD_BUG_ON(sizeof(struct ionic_admin_comp) != 16);
45 	RTE_BUILD_BUG_ON(sizeof(struct ionic_nop_cmd) != 64);
46 	RTE_BUILD_BUG_ON(sizeof(struct ionic_nop_comp) != 16);
47 
48 	/* Device commands */
49 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_identify_cmd) != 64);
50 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_identify_comp) != 16);
51 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_init_cmd) != 64);
52 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_init_comp) != 16);
53 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_reset_cmd) != 64);
54 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_reset_comp) != 16);
55 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_getattr_cmd) != 64);
56 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_getattr_comp) != 16);
57 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_setattr_cmd) != 64);
58 	RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_setattr_comp) != 16);
59 
60 	/* Port commands */
61 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_identify_cmd) != 64);
62 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_identify_comp) != 16);
63 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_init_cmd) != 64);
64 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_init_comp) != 16);
65 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_reset_cmd) != 64);
66 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_reset_comp) != 16);
67 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_getattr_cmd) != 64);
68 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_getattr_comp) != 16);
69 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_setattr_cmd) != 64);
70 	RTE_BUILD_BUG_ON(sizeof(struct ionic_port_setattr_comp) != 16);
71 
72 	/* LIF commands */
73 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_init_cmd) != 64);
74 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_init_comp) != 16);
75 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_reset_cmd) != 64);
76 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_getattr_cmd) != 64);
77 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_getattr_comp) != 16);
78 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_setattr_cmd) != 64);
79 	RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_setattr_comp) != 16);
80 
81 	RTE_BUILD_BUG_ON(sizeof(struct ionic_q_init_cmd) != 64);
82 	RTE_BUILD_BUG_ON(sizeof(struct ionic_q_init_comp) != 16);
83 	RTE_BUILD_BUG_ON(sizeof(struct ionic_q_control_cmd) != 64);
84 
85 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_mode_set_cmd) != 64);
86 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_add_cmd) != 64);
87 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_add_comp) != 16);
88 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_del_cmd) != 64);
89 
90 	/* RDMA commands */
91 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rdma_reset_cmd) != 64);
92 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rdma_queue_cmd) != 64);
93 
94 	/* Events */
95 	RTE_BUILD_BUG_ON(sizeof(struct ionic_notifyq_cmd) != 4);
96 	RTE_BUILD_BUG_ON(sizeof(union ionic_notifyq_comp) != 64);
97 	RTE_BUILD_BUG_ON(sizeof(struct ionic_notifyq_event) != 64);
98 	RTE_BUILD_BUG_ON(sizeof(struct ionic_link_change_event) != 64);
99 	RTE_BUILD_BUG_ON(sizeof(struct ionic_reset_event) != 64);
100 	RTE_BUILD_BUG_ON(sizeof(struct ionic_heartbeat_event) != 64);
101 	RTE_BUILD_BUG_ON(sizeof(struct ionic_log_event) != 64);
102 
103 	/* I/O */
104 	RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_desc) != 16);
105 	RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_sg_desc) != 128);
106 	RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_comp) != 16);
107 
108 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_desc) != 16);
109 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_sg_desc) != 128);
110 	RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_comp) != 16);
111 }
112 
113 struct ionic_dev {
114 	union ionic_dev_info_regs __iomem *dev_info;
115 	union ionic_dev_cmd_regs __iomem *dev_cmd;
116 
117 	struct ionic_doorbell __iomem *db_pages;
118 	rte_iova_t phy_db_pages;
119 
120 	struct ionic_intr __iomem *intr_ctrl;
121 
122 	struct ionic_intr_status __iomem *intr_status;
123 
124 	struct ionic_port_info *port_info;
125 	const struct rte_memzone *port_info_z;
126 	rte_iova_t port_info_pa;
127 	uint32_t port_info_sz;
128 };
129 
130 struct ionic_queue;
131 struct ionic_desc_info;
132 
133 typedef void (*desc_cb)(struct ionic_queue *q,
134 	uint32_t q_desc_index,
135 	uint32_t cq_desc_index,
136 	void *cb_arg, void *service_cb_arg);
137 
138 struct ionic_desc_info {
139 	desc_cb cb;
140 	void *cb_arg;
141 };
142 
143 struct ionic_queue {
144 	struct ionic_dev *idev;
145 	struct ionic_lif *lif;
146 	struct ionic_cq *bound_cq;
147 	uint32_t index;
148 	uint32_t type;
149 	uint32_t hw_index;
150 	uint32_t hw_type;
151 	void *base;
152 	void *sg_base;
153 	rte_iova_t base_pa;
154 	rte_iova_t sg_base_pa;
155 	struct ionic_desc_info *info;
156 	uint32_t tail_idx;
157 	uint32_t head_idx;
158 	uint32_t num_descs;
159 	uint32_t desc_size;
160 	uint32_t sg_desc_size;
161 	uint32_t pid;
162 	uint32_t qid;
163 	uint32_t qtype;
164 	struct ionic_doorbell __iomem *db;
165 	void *nop_desc;
166 };
167 
168 #define IONIC_INTR_INDEX_NOT_ASSIGNED	(-1)
169 #define IONIC_INTR_NAME_MAX_SZ		(32)
170 
171 struct ionic_intr_info {
172 	char name[IONIC_INTR_NAME_MAX_SZ];
173 	int index;
174 	uint32_t vector;
175 	struct ionic_intr __iomem *ctrl;
176 };
177 
178 struct ionic_cq {
179 	struct ionic_lif *lif;
180 	struct ionic_queue *bound_q;
181 	uint32_t tail_idx;
182 	uint32_t num_descs;
183 	uint32_t desc_size;
184 	bool done_color;
185 	void *base;
186 	rte_iova_t base_pa;
187 	struct ionic_intr_info *bound_intr;
188 };
189 
190 /** ionic_admin_ctx - Admin command context.
191  * @pending_work:	Flag that indicates a completion.
192  * @cmd:		Admin command (64B) to be copied to the queue.
193  * @comp:		Admin completion (16B) copied from the queue.
194  */
195 struct ionic_admin_ctx {
196 	bool pending_work;
197 	union ionic_adminq_cmd cmd;
198 	union ionic_adminq_comp comp;
199 };
200 
201 struct ionic_lif;
202 struct ionic_adapter;
203 struct ionic_qcq;
204 
205 void ionic_intr_init(struct ionic_dev *idev, struct ionic_intr_info *intr,
206 	unsigned long index);
207 
208 int ionic_dev_setup(struct ionic_adapter *adapter);
209 
210 void ionic_dev_cmd_go(struct ionic_dev *idev, union ionic_dev_cmd *cmd);
211 uint8_t ionic_dev_cmd_status(struct ionic_dev *idev);
212 bool ionic_dev_cmd_done(struct ionic_dev *idev);
213 void ionic_dev_cmd_comp(struct ionic_dev *idev, void *mem);
214 
215 void ionic_dev_cmd_identify(struct ionic_dev *idev, uint8_t ver);
216 void ionic_dev_cmd_init(struct ionic_dev *idev);
217 void ionic_dev_cmd_reset(struct ionic_dev *idev);
218 
219 void ionic_dev_cmd_port_identify(struct ionic_dev *idev);
220 void ionic_dev_cmd_port_init(struct ionic_dev *idev);
221 void ionic_dev_cmd_port_reset(struct ionic_dev *idev);
222 void ionic_dev_cmd_port_state(struct ionic_dev *idev, uint8_t state);
223 void ionic_dev_cmd_port_speed(struct ionic_dev *idev, uint32_t speed);
224 void ionic_dev_cmd_port_mtu(struct ionic_dev *idev, uint32_t mtu);
225 void ionic_dev_cmd_port_autoneg(struct ionic_dev *idev, uint8_t an_enable);
226 void ionic_dev_cmd_port_fec(struct ionic_dev *idev, uint8_t fec_type);
227 void ionic_dev_cmd_port_pause(struct ionic_dev *idev, uint8_t pause_type);
228 void ionic_dev_cmd_port_loopback(struct ionic_dev *idev,
229 	uint8_t loopback_mode);
230 
231 void ionic_dev_cmd_lif_identify(struct ionic_dev *idev, uint8_t type,
232 	uint8_t ver);
233 void ionic_dev_cmd_lif_init(struct ionic_dev *idev, uint16_t lif_index,
234 	rte_iova_t addr);
235 void ionic_dev_cmd_lif_reset(struct ionic_dev *idev, uint16_t lif_index);
236 void ionic_dev_cmd_adminq_init(struct ionic_dev *idev, struct ionic_qcq *qcq,
237 	uint16_t lif_index, uint16_t intr_index);
238 
239 struct ionic_doorbell __iomem *ionic_db_map(struct ionic_lif *lif,
240 	struct ionic_queue *q);
241 int ionic_db_page_num(struct ionic_lif *lif, int pid);
242 
243 int ionic_cq_init(struct ionic_lif *lif, struct ionic_cq *cq,
244 	struct ionic_intr_info *intr, uint32_t num_descs,
245 	size_t desc_size);
246 void ionic_cq_map(struct ionic_cq *cq, void *base, rte_iova_t base_pa);
247 void ionic_cq_bind(struct ionic_cq *cq, struct ionic_queue *q);
248 typedef bool (*ionic_cq_cb)(struct ionic_cq *cq, uint32_t cq_desc_index,
249 		void *cb_arg);
250 uint32_t ionic_cq_service(struct ionic_cq *cq, uint32_t work_to_do,
251 	ionic_cq_cb cb, void *cb_arg);
252 
253 int ionic_q_init(struct ionic_lif *lif, struct ionic_dev *idev,
254 	struct ionic_queue *q, uint32_t index, uint32_t num_descs,
255 	size_t desc_size, size_t sg_desc_size, uint32_t pid);
256 void ionic_q_map(struct ionic_queue *q, void *base, rte_iova_t base_pa);
257 void ionic_q_sg_map(struct ionic_queue *q, void *base, rte_iova_t base_pa);
258 void ionic_q_flush(struct ionic_queue *q);
259 void ionic_q_post(struct ionic_queue *q, bool ring_doorbell, desc_cb cb,
260 	void *cb_arg);
261 uint32_t ionic_q_space_avail(struct ionic_queue *q);
262 bool ionic_q_has_space(struct ionic_queue *q, uint32_t want);
263 void ionic_q_service(struct ionic_queue *q, uint32_t cq_desc_index,
264 	uint32_t stop_index, void *service_cb_arg);
265 
266 int ionic_adminq_post(struct ionic_lif *lif, struct ionic_admin_ctx *ctx);
267 
268 #endif /* _IONIC_DEV_H_ */
269