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