xref: /linux/include/uapi/rdma/efa-abi.h (revision e2683c8868d03382da7e1ce8453b543a043066d1)
1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
2 /*
3  * Copyright 2018-2026 Amazon.com, Inc. or its affiliates. All rights reserved.
4  */
5 
6 #ifndef EFA_ABI_USER_H
7 #define EFA_ABI_USER_H
8 
9 #include <linux/types.h>
10 #include <rdma/ib_user_ioctl_cmds.h>
11 
12 /*
13  * Increment this value if any changes that break userspace ABI
14  * compatibility are made.
15  */
16 #define EFA_UVERBS_ABI_VERSION 1
17 
18 /*
19  * Keep structs aligned to 8 bytes.
20  * Keep reserved fields as arrays of __u8 named reserved_XXX where XXX is the
21  * hex bit offset of the field.
22  */
23 
24 enum {
25 	EFA_ALLOC_UCONTEXT_CMD_SUPP_CAPS_TX_BATCH  = 1 << 0,
26 	EFA_ALLOC_UCONTEXT_CMD_SUPP_CAPS_MIN_SQ_WR = 1 << 1,
27 };
28 
29 struct efa_ibv_alloc_ucontext_cmd {
30 	__u32 supported_caps;
31 	__u8 reserved_20[4];
32 };
33 
34 enum efa_ibv_user_cmds_supp_udata {
35 	EFA_USER_CMDS_SUPP_UDATA_QUERY_DEVICE = 1 << 0,
36 	EFA_USER_CMDS_SUPP_UDATA_CREATE_AH    = 1 << 1,
37 };
38 
39 struct efa_ibv_alloc_ucontext_resp {
40 	__u32 comp_mask;
41 	__u32 cmds_supp_udata_mask;
42 	__u16 sub_cqs_per_cq;
43 	__u16 inline_buf_size;
44 	__u32 max_llq_size; /* bytes */
45 	__u16 max_tx_batch; /* units of 64 bytes */
46 	__u16 min_sq_wr;
47 	__u16 inline_buf_size_ex;
48 	__u8 reserved_b0[2];
49 };
50 
51 struct efa_ibv_alloc_pd_resp {
52 	__u32 comp_mask;
53 	__u16 pdn;
54 	__u8 reserved_30[2];
55 };
56 
57 enum {
58 	EFA_CREATE_CQ_WITH_COMPLETION_CHANNEL = 1 << 0,
59 	EFA_CREATE_CQ_WITH_SGID               = 1 << 1,
60 };
61 
62 struct efa_ibv_create_cq {
63 	__u32 comp_mask;
64 	__u32 cq_entry_size;
65 	__u16 num_sub_cqs;
66 	__u8 flags;
67 	__u8 reserved_58[5];
68 };
69 
70 enum {
71 	EFA_CREATE_CQ_RESP_DB_OFF = 1 << 0,
72 };
73 
74 struct efa_ibv_create_cq_resp {
75 	__u32 comp_mask;
76 	__u8 reserved_20[4];
77 	__aligned_u64 q_mmap_key;
78 	__aligned_u64 q_mmap_size;
79 	__u16 cq_idx;
80 	__u8 reserved_d0[2];
81 	__u32 db_off;
82 	__aligned_u64 db_mmap_key;
83 };
84 
85 enum {
86 	EFA_QP_DRIVER_TYPE_SRD = 0,
87 };
88 
89 enum {
90 	EFA_CREATE_QP_WITH_UNSOLICITED_WRITE_RECV = 1 << 0,
91 };
92 
93 struct efa_ibv_create_qp {
94 	__u32 comp_mask;
95 	__u32 rq_ring_size; /* bytes */
96 	__u32 sq_ring_size; /* bytes */
97 	__u32 driver_qp_type;
98 	__u16 flags;
99 	__u8 sl;
100 	__u8 reserved_98[5];
101 };
102 
103 struct efa_ibv_create_qp_resp {
104 	__u32 comp_mask;
105 	/* the offset inside the page of the rq db */
106 	__u32 rq_db_offset;
107 	/* the offset inside the page of the sq db */
108 	__u32 sq_db_offset;
109 	/* the offset inside the page of descriptors buffer */
110 	__u32 llq_desc_offset;
111 	__aligned_u64 rq_mmap_key;
112 	__aligned_u64 rq_mmap_size;
113 	__aligned_u64 rq_db_mmap_key;
114 	__aligned_u64 sq_db_mmap_key;
115 	__aligned_u64 llq_desc_mmap_key;
116 	__u16 send_sub_cq_idx;
117 	__u16 recv_sub_cq_idx;
118 	__u8 reserved_1e0[4];
119 };
120 
121 struct efa_ibv_create_ah_resp {
122 	__u32 comp_mask;
123 	__u16 efa_address_handle;
124 	__u8 reserved_30[2];
125 };
126 
127 enum {
128 	EFA_QUERY_DEVICE_CAPS_RDMA_READ = 1 << 0,
129 	EFA_QUERY_DEVICE_CAPS_RNR_RETRY = 1 << 1,
130 	EFA_QUERY_DEVICE_CAPS_CQ_NOTIFICATIONS = 1 << 2,
131 	EFA_QUERY_DEVICE_CAPS_CQ_WITH_SGID     = 1 << 3,
132 	EFA_QUERY_DEVICE_CAPS_DATA_POLLING_128 = 1 << 4,
133 	EFA_QUERY_DEVICE_CAPS_RDMA_WRITE = 1 << 5,
134 	EFA_QUERY_DEVICE_CAPS_UNSOLICITED_WRITE_RECV = 1 << 6,
135 	EFA_QUERY_DEVICE_CAPS_CQ_WITH_EXT_MEM = 1 << 7,
136 };
137 
138 struct efa_ibv_ex_query_device_resp {
139 	__u32 comp_mask;
140 	__u32 max_sq_wr;
141 	__u32 max_rq_wr;
142 	__u16 max_sq_sge;
143 	__u16 max_rq_sge;
144 	__u32 max_rdma_size;
145 	__u32 device_caps;
146 };
147 
148 enum {
149 	EFA_QUERY_MR_VALIDITY_RECV_IC_ID = 1 << 0,
150 	EFA_QUERY_MR_VALIDITY_RDMA_READ_IC_ID = 1 << 1,
151 	EFA_QUERY_MR_VALIDITY_RDMA_RECV_IC_ID = 1 << 2,
152 };
153 
154 enum efa_query_mr_attrs {
155 	EFA_IB_ATTR_QUERY_MR_HANDLE = (1U << UVERBS_ID_NS_SHIFT),
156 	EFA_IB_ATTR_QUERY_MR_RESP_IC_ID_VALIDITY,
157 	EFA_IB_ATTR_QUERY_MR_RESP_RECV_IC_ID,
158 	EFA_IB_ATTR_QUERY_MR_RESP_RDMA_READ_IC_ID,
159 	EFA_IB_ATTR_QUERY_MR_RESP_RDMA_RECV_IC_ID,
160 };
161 
162 enum efa_mr_methods {
163 	EFA_IB_METHOD_MR_QUERY = (1U << UVERBS_ID_NS_SHIFT),
164 };
165 
166 #endif /* EFA_ABI_USER_H */
167