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