xref: /linux/drivers/infiniband/hw/efa/efa.h (revision 3a2c4d55e32ad65efebdb6de44eef3bfa08bb49d)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
2 /*
3  * Copyright 2018-2026 Amazon.com, Inc. or its affiliates. All rights reserved.
4  */
5 
6 #ifndef _EFA_H_
7 #define _EFA_H_
8 
9 #include <linux/bitops.h>
10 #include <linux/interrupt.h>
11 #include <linux/pci.h>
12 
13 #include <rdma/efa-abi.h>
14 #include <rdma/ib_verbs.h>
15 
16 #include "efa_com_cmd.h"
17 
18 #define DRV_MODULE_NAME         "efa"
19 #define DEVICE_NAME             "Elastic Fabric Adapter (EFA)"
20 
21 #define EFA_IRQNAME_SIZE        40
22 
23 #define EFA_MGMNT_MSIX_VEC_IDX            0
24 #define EFA_COMP_EQS_VEC_BASE             1
25 
26 struct efa_irq {
27 	irq_handler_t handler;
28 	void *data;
29 	u32 irqn;
30 	u32 vector;
31 	cpumask_t affinity_hint_mask;
32 	char name[EFA_IRQNAME_SIZE];
33 };
34 
35 /* Don't use anything other than atomic64 */
36 struct efa_stats {
37 	atomic64_t alloc_pd_err;
38 	atomic64_t create_qp_err;
39 	atomic64_t create_cq_err;
40 	atomic64_t reg_mr_err;
41 	atomic64_t alloc_ucontext_err;
42 	atomic64_t create_ah_err;
43 	atomic64_t mmap_err;
44 	atomic64_t keep_alive_rcvd;
45 };
46 
47 struct efa_dev {
48 	struct ib_device ibdev;
49 	struct efa_com_dev edev;
50 	struct pci_dev *pdev;
51 	struct efa_com_get_device_attr_result dev_attr;
52 
53 	u64 reg_bar_addr;
54 	u64 reg_bar_len;
55 	u64 mem_bar_addr;
56 	u64 mem_bar_len;
57 	u64 db_bar_addr;
58 	u64 db_bar_len;
59 
60 	u32 num_irq_vectors;
61 	u32 admin_msix_vector_idx;
62 	struct efa_irq admin_irq;
63 
64 	struct efa_stats stats;
65 
66 	/* Array of completion EQs */
67 	struct efa_eq *eqs;
68 	u32 neqs;
69 
70 	/* Only stores CQs with interrupts enabled */
71 	struct xarray cqs_xa;
72 };
73 
74 struct efa_ucontext {
75 	struct ib_ucontext ibucontext;
76 	u16 uarn;
77 };
78 
79 struct efa_pd {
80 	struct ib_pd ibpd;
81 	u16 pdn;
82 };
83 
84 struct efa_mr_interconnect_info {
85 	u16 recv_ic_id;
86 	u16 rdma_read_ic_id;
87 	u16 rdma_recv_ic_id;
88 	u8 recv_ic_id_valid : 1;
89 	u8 rdma_read_ic_id_valid : 1;
90 	u8 rdma_recv_ic_id_valid : 1;
91 };
92 
93 struct efa_mr {
94 	struct ib_mr ibmr;
95 	struct ib_umem *umem;
96 	struct efa_mr_interconnect_info ic_info;
97 };
98 
99 struct efa_cq {
100 	struct ib_cq ibcq;
101 	struct efa_ucontext *ucontext;
102 	dma_addr_t dma_addr;
103 	void *cpu_addr;
104 	struct rdma_user_mmap_entry *mmap_entry;
105 	struct rdma_user_mmap_entry *db_mmap_entry;
106 	size_t size;
107 	u16 cq_idx;
108 	/* NULL when no interrupts requested */
109 	struct efa_eq *eq;
110 	struct ib_umem *umem;
111 };
112 
113 struct efa_comp_cntr {
114 	struct ib_comp_cntr ibcc;
115 	struct ib_umem *comp_umem;
116 	struct ib_umem *err_umem;
117 	u32 comp_handle;
118 	u32 err_handle;
119 };
120 
121 struct efa_qp {
122 	struct ib_qp ibqp;
123 	dma_addr_t rq_dma_addr;
124 	void *rq_cpu_addr;
125 	size_t rq_size;
126 	enum ib_qp_state state;
127 
128 	/* Used for saving mmap_xa entries */
129 	struct rdma_user_mmap_entry *sq_db_mmap_entry;
130 	struct rdma_user_mmap_entry *llq_desc_mmap_entry;
131 	struct rdma_user_mmap_entry *rq_db_mmap_entry;
132 	struct rdma_user_mmap_entry *rq_mmap_entry;
133 
134 	u32 qp_handle;
135 	u32 max_send_wr;
136 	u32 max_recv_wr;
137 	u32 max_send_sge;
138 	u32 max_recv_sge;
139 	u32 max_inline_data;
140 };
141 
142 struct efa_ah {
143 	struct ib_ah ibah;
144 	u16 ah;
145 	/* dest_addr */
146 	u8 id[EFA_GID_SIZE];
147 };
148 
149 struct efa_eq {
150 	struct efa_com_eq eeq;
151 	struct efa_irq irq;
152 };
153 
154 int efa_query_device(struct ib_device *ibdev,
155 		     struct ib_device_attr *props,
156 		     struct ib_udata *udata);
157 int efa_query_port(struct ib_device *ibdev, u32 port,
158 		   struct ib_port_attr *props);
159 int efa_query_port_speed(struct ib_device *ibdev, u32 port_num, u64 *speed);
160 int efa_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr,
161 		 int qp_attr_mask,
162 		 struct ib_qp_init_attr *qp_init_attr);
163 int efa_query_gid(struct ib_device *ibdev, u32 port, int index,
164 		  union ib_gid *gid);
165 int efa_query_pkey(struct ib_device *ibdev, u32 port, u16 index,
166 		   u16 *pkey);
167 int efa_alloc_pd(struct ib_pd *ibpd, struct ib_udata *udata);
168 int efa_dealloc_pd(struct ib_pd *ibpd, struct ib_udata *udata);
169 int efa_destroy_qp(struct ib_qp *ibqp, struct ib_udata *udata);
170 int efa_create_qp(struct ib_qp *ibqp, struct ib_qp_init_attr *init_attr,
171 		  struct ib_udata *udata);
172 int efa_destroy_cq(struct ib_cq *ibcq, struct ib_udata *udata);
173 int efa_create_user_cq(struct ib_cq *ibcq, const struct ib_cq_init_attr *attr,
174 		       struct uverbs_attr_bundle *attrs);
175 int efa_query_comp_cntr_caps(struct ib_device *ibdev,
176 			     struct ib_comp_cntr_caps *caps,
177 			     struct uverbs_attr_bundle *attrs);
178 int efa_create_comp_cntr(struct ib_comp_cntr *ibcc,
179 			 struct uverbs_attr_bundle *attrs);
180 int efa_destroy_comp_cntr(struct ib_comp_cntr *ibcc);
181 int efa_modify_comp_cntr(struct ib_comp_cntr *ibcc, enum ib_comp_cntr_entry entry,
182 			 enum ib_comp_cntr_modify_op op, u64 value);
183 int efa_qp_attach_comp_cntr(struct ib_qp *ibqp, struct ib_comp_cntr *ibcc,
184 			    struct ib_qp_attach_comp_cntr_attr *attr);
185 struct ib_mr *efa_reg_mr(struct ib_pd *ibpd, u64 start, u64 length,
186 			 u64 virt_addr, int access_flags,
187 			 struct ib_dmah *dmah,
188 			 struct ib_udata *udata);
189 struct ib_mr *efa_reg_user_mr_dmabuf(struct ib_pd *ibpd, u64 start,
190 				     u64 length, u64 virt_addr,
191 				     int fd, int access_flags,
192 				     struct ib_dmah *dmah,
193 				     struct uverbs_attr_bundle *attrs);
194 int efa_dereg_mr(struct ib_mr *ibmr, struct ib_udata *udata);
195 int efa_get_port_immutable(struct ib_device *ibdev, u32 port_num,
196 			   struct ib_port_immutable *immutable);
197 int efa_alloc_ucontext(struct ib_ucontext *ibucontext, struct ib_udata *udata);
198 void efa_dealloc_ucontext(struct ib_ucontext *ibucontext);
199 int efa_mmap(struct ib_ucontext *ibucontext,
200 	     struct vm_area_struct *vma);
201 void efa_mmap_free(struct rdma_user_mmap_entry *rdma_entry);
202 int efa_create_ah(struct ib_ah *ibah,
203 		  struct rdma_ah_init_attr *init_attr,
204 		  struct ib_udata *udata);
205 int efa_destroy_ah(struct ib_ah *ibah, u32 flags);
206 int efa_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr,
207 		  int qp_attr_mask, struct ib_udata *udata);
208 enum rdma_link_layer efa_port_link_layer(struct ib_device *ibdev,
209 					 u32 port_num);
210 struct rdma_hw_stats *efa_alloc_hw_port_stats(struct ib_device *ibdev, u32 port_num);
211 struct rdma_hw_stats *efa_alloc_hw_device_stats(struct ib_device *ibdev);
212 int efa_get_hw_stats(struct ib_device *ibdev, struct rdma_hw_stats *stats,
213 		     u32 port_num, int index);
214 
215 #endif /* _EFA_H_ */
216