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