1/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
2/*
3 * Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All rights reserved.
4 */
5
6#ifndef _EFA_COM_CMD_H_
7#define _EFA_COM_CMD_H_
8
9#include "efa_com.h"
10
11#define EFA_GID_SIZE 16
12
13struct efa_com_create_qp_params {
14	u64 rq_base_addr;
15	u32 send_cq_idx;
16	u32 recv_cq_idx;
17	/*
18	 * Send descriptor ring size in bytes,
19	 * sufficient for user-provided number of WQEs and SGL size
20	 */
21	u32 sq_ring_size_in_bytes;
22	/* Max number of WQEs that will be posted on send queue */
23	u32 sq_depth;
24	/* Recv descriptor ring size in bytes */
25	u32 rq_ring_size_in_bytes;
26	u32 rq_depth;
27	u16 pd;
28	u16 uarn;
29	u8 qp_type;
30	u8 unsolicited_write_recv : 1;
31};
32
33struct efa_com_create_qp_result {
34	u32 qp_handle;
35	u32 qp_num;
36	u32 sq_db_offset;
37	u32 rq_db_offset;
38	u32 llq_descriptors_offset;
39	u16 send_sub_cq_idx;
40	u16 recv_sub_cq_idx;
41};
42
43struct efa_com_modify_qp_params {
44	u32 modify_mask;
45	u32 qp_handle;
46	u32 qp_state;
47	u32 cur_qp_state;
48	u32 qkey;
49	u32 sq_psn;
50	u8 sq_drained_async_notify;
51	u8 rnr_retry;
52};
53
54struct efa_com_query_qp_params {
55	u32 qp_handle;
56};
57
58struct efa_com_query_qp_result {
59	u32 qp_state;
60	u32 qkey;
61	u32 sq_draining;
62	u32 sq_psn;
63	u8 rnr_retry;
64};
65
66struct efa_com_destroy_qp_params {
67	u32 qp_handle;
68};
69
70struct efa_com_create_cq_params {
71	/* cq physical base address in OS memory */
72	dma_addr_t dma_addr;
73	/* completion queue depth in # of entries */
74	u16 cq_depth;
75	u16 num_sub_cqs;
76	u16 uarn;
77	u16 eqn;
78	u8 entry_size_in_bytes;
79	u8 interrupt_mode_enabled : 1;
80	u8 set_src_addr : 1;
81};
82
83struct efa_com_create_cq_result {
84	/* cq identifier */
85	u16 cq_idx;
86	/* actual cq depth in # of entries */
87	u16 actual_depth;
88	u32 db_off;
89	bool db_valid;
90};
91
92struct efa_com_destroy_cq_params {
93	u16 cq_idx;
94};
95
96struct efa_com_create_ah_params {
97	u16 pdn;
98	/* Destination address in network byte order */
99	u8 dest_addr[EFA_GID_SIZE];
100};
101
102struct efa_com_create_ah_result {
103	u16 ah;
104};
105
106struct efa_com_destroy_ah_params {
107	u16 ah;
108	u16 pdn;
109};
110
111struct efa_com_get_device_attr_result {
112	u8 addr[EFA_GID_SIZE];
113	u64 page_size_cap;
114	u64 max_mr_pages;
115	u32 mtu;
116	u32 fw_version;
117	u32 admin_api_version;
118	u32 device_version;
119	u32 supported_features;
120	u32 phys_addr_width;
121	u32 virt_addr_width;
122	u32 max_qp;
123	u32 max_sq_depth; /* wqes */
124	u32 max_rq_depth; /* wqes */
125	u32 max_cq;
126	u32 max_cq_depth; /* cqes */
127	u32 inline_buf_size;
128	u32 max_mr;
129	u32 max_pd;
130	u32 max_ah;
131	u32 max_llq_size;
132	u32 max_rdma_size;
133	u32 device_caps;
134	u32 max_eq;
135	u32 max_eq_depth;
136	u32 event_bitmask; /* EQ events bitmask */
137	u16 sub_cqs_per_cq;
138	u16 max_sq_sge;
139	u16 max_rq_sge;
140	u16 max_wr_rdma_sge;
141	u16 max_tx_batch;
142	u16 min_sq_depth;
143	u8 db_bar;
144};
145
146struct efa_com_get_hw_hints_result {
147	u16 mmio_read_timeout;
148	u16 driver_watchdog_timeout;
149	u16 admin_completion_timeout;
150	u16 poll_interval;
151	u32 reserved[4];
152};
153
154struct efa_com_mem_addr {
155	u32 mem_addr_low;
156	u32 mem_addr_high;
157};
158
159/* Used at indirect mode page list chunks for chaining */
160struct efa_com_ctrl_buff_info {
161	/* indicates length of the buffer pointed by control_buffer_address. */
162	u32 length;
163	/* points to control buffer (direct or indirect) */
164	struct efa_com_mem_addr address;
165};
166
167struct efa_com_reg_mr_params {
168	/* Memory region length, in bytes. */
169	u64 mr_length_in_bytes;
170	/* IO Virtual Address associated with this MR. */
171	u64 iova;
172	/* words 8:15: Physical Buffer List, each element is page-aligned. */
173	union {
174		/*
175		 * Inline array of physical addresses of app pages
176		 * (optimization for short region reservations)
177		 */
178		u64 inline_pbl_array[4];
179		/*
180		 * Describes the next physically contiguous chunk of indirect
181		 * page list. A page list contains physical addresses of command
182		 * data pages. Data pages are 4KB; page list chunks are
183		 * variable-sized.
184		 */
185		struct efa_com_ctrl_buff_info pbl;
186	} pbl;
187	/* number of pages in PBL (redundant, could be calculated) */
188	u32 page_num;
189	/* Protection Domain */
190	u16 pd;
191	/*
192	 * phys_page_size_shift - page size is (1 << phys_page_size_shift)
193	 * Page size is used for building the Virtual to Physical
194	 * address mapping
195	 */
196	u8 page_shift;
197	/* see permissions field of struct efa_admin_reg_mr_cmd */
198	u8 permissions;
199	u8 inline_pbl;
200	u8 indirect;
201};
202
203struct efa_com_mr_interconnect_info {
204	u16 recv_ic_id;
205	u16 rdma_read_ic_id;
206	u16 rdma_recv_ic_id;
207	u8 recv_ic_id_valid : 1;
208	u8 rdma_read_ic_id_valid : 1;
209	u8 rdma_recv_ic_id_valid : 1;
210};
211
212struct efa_com_reg_mr_result {
213	/*
214	 * To be used in conjunction with local buffers references in SQ and
215	 * RQ WQE
216	 */
217	u32 l_key;
218	/*
219	 * To be used in incoming RDMA semantics messages to refer to remotely
220	 * accessed memory region
221	 */
222	u32 r_key;
223	struct efa_com_mr_interconnect_info ic_info;
224};
225
226struct efa_com_dereg_mr_params {
227	u32 l_key;
228};
229
230struct efa_com_alloc_pd_result {
231	u16 pdn;
232};
233
234struct efa_com_dealloc_pd_params {
235	u16 pdn;
236};
237
238struct efa_com_alloc_uar_result {
239	u16 uarn;
240};
241
242struct efa_com_dealloc_uar_params {
243	u16 uarn;
244};
245
246struct efa_com_get_stats_params {
247	/* see enum efa_admin_get_stats_type */
248	u8 type;
249	/* see enum efa_admin_get_stats_scope */
250	u8 scope;
251	u16 scope_modifier;
252};
253
254struct efa_com_basic_stats {
255	u64 tx_bytes;
256	u64 tx_pkts;
257	u64 rx_bytes;
258	u64 rx_pkts;
259	u64 rx_drops;
260};
261
262struct efa_com_messages_stats {
263	u64 send_bytes;
264	u64 send_wrs;
265	u64 recv_bytes;
266	u64 recv_wrs;
267};
268
269struct efa_com_rdma_read_stats {
270	u64 read_wrs;
271	u64 read_bytes;
272	u64 read_wr_err;
273	u64 read_resp_bytes;
274};
275
276struct efa_com_rdma_write_stats {
277	u64 write_wrs;
278	u64 write_bytes;
279	u64 write_wr_err;
280	u64 write_recv_bytes;
281};
282
283union efa_com_get_stats_result {
284	struct efa_com_basic_stats basic_stats;
285	struct efa_com_messages_stats messages_stats;
286	struct efa_com_rdma_read_stats rdma_read_stats;
287	struct efa_com_rdma_write_stats rdma_write_stats;
288};
289
290int efa_com_create_qp(struct efa_com_dev *edev,
291		      struct efa_com_create_qp_params *params,
292		      struct efa_com_create_qp_result *res);
293int efa_com_modify_qp(struct efa_com_dev *edev,
294		      struct efa_com_modify_qp_params *params);
295int efa_com_query_qp(struct efa_com_dev *edev,
296		     struct efa_com_query_qp_params *params,
297		     struct efa_com_query_qp_result *result);
298int efa_com_destroy_qp(struct efa_com_dev *edev,
299		       struct efa_com_destroy_qp_params *params);
300int efa_com_create_cq(struct efa_com_dev *edev,
301		      struct efa_com_create_cq_params *params,
302		      struct efa_com_create_cq_result *result);
303int efa_com_destroy_cq(struct efa_com_dev *edev,
304		       struct efa_com_destroy_cq_params *params);
305int efa_com_register_mr(struct efa_com_dev *edev,
306			struct efa_com_reg_mr_params *params,
307			struct efa_com_reg_mr_result *result);
308int efa_com_dereg_mr(struct efa_com_dev *edev,
309		     struct efa_com_dereg_mr_params *params);
310int efa_com_create_ah(struct efa_com_dev *edev,
311		      struct efa_com_create_ah_params *params,
312		      struct efa_com_create_ah_result *result);
313int efa_com_destroy_ah(struct efa_com_dev *edev,
314		       struct efa_com_destroy_ah_params *params);
315int efa_com_get_device_attr(struct efa_com_dev *edev,
316			    struct efa_com_get_device_attr_result *result);
317int efa_com_get_hw_hints(struct efa_com_dev *edev,
318			 struct efa_com_get_hw_hints_result *result);
319bool
320efa_com_check_supported_feature_id(struct efa_com_dev *edev,
321				   enum efa_admin_aq_feature_id feature_id);
322int efa_com_set_feature_ex(struct efa_com_dev *edev,
323			   struct efa_admin_set_feature_resp *set_resp,
324			   struct efa_admin_set_feature_cmd *set_cmd,
325			   enum efa_admin_aq_feature_id feature_id,
326			   dma_addr_t control_buf_dma_addr,
327			   u32 control_buff_size);
328int efa_com_set_aenq_config(struct efa_com_dev *edev, u32 groups);
329int efa_com_alloc_pd(struct efa_com_dev *edev,
330		     struct efa_com_alloc_pd_result *result);
331int efa_com_dealloc_pd(struct efa_com_dev *edev,
332		       struct efa_com_dealloc_pd_params *params);
333int efa_com_alloc_uar(struct efa_com_dev *edev,
334		      struct efa_com_alloc_uar_result *result);
335int efa_com_dealloc_uar(struct efa_com_dev *edev,
336			struct efa_com_dealloc_uar_params *params);
337int efa_com_get_stats(struct efa_com_dev *edev,
338		      struct efa_com_get_stats_params *params,
339		      union efa_com_get_stats_result *result);
340
341#endif /* _EFA_COM_CMD_H_ */
342