xref: /freebsd/sys/dev/irdma/fbsd_kcompat.h (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*-
2  * SPDX-License-Identifier: GPL-2.0 or Linux-OpenIB
3  *
4  * Copyright (c) 2021 - 2023 Intel Corporation
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenFabrics.org BSD license below:
11  *
12  *   Redistribution and use in source and binary forms, with or
13  *   without modification, are permitted provided that the following
14  *   conditions are met:
15  *
16  *    - Redistributions of source code must retain the above
17  *	copyright notice, this list of conditions and the following
18  *	disclaimer.
19  *
20  *    - Redistributions in binary form must reproduce the above
21  *	copyright notice, this list of conditions and the following
22  *	disclaimer in the documentation and/or other materials
23  *	provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34 
35 #ifndef FBSD_KCOMPAT_H
36 #define FBSD_KCOMPAT_H
37 #include "ice_rdma.h"
38 
39 #define TASKLET_DATA_TYPE	unsigned long
40 #define TASKLET_FUNC_TYPE	void (*)(TASKLET_DATA_TYPE)
41 
42 #ifndef tasklet_setup
43 #define tasklet_setup(tasklet, callback)				\
44 	tasklet_init((tasklet), (TASKLET_FUNC_TYPE)(callback),		\
45 		      (TASKLET_DATA_TYPE)(tasklet))
46 #endif
47 #ifndef from_tasklet
48 #define from_tasklet(var, callback_tasklet, tasklet_fieldname) \
49 	container_of(callback_tasklet, typeof(*var), tasklet_fieldname)
50 #endif
51 
52 #if __FreeBSD_version >= 1400000
53 #define IRDMA_SET_RDMA_OBJ_SIZE(ib_struct, drv_struct, member)    \
54 	(sizeof(struct drv_struct) +                              \
55 	 BUILD_BUG_ON_ZERO(offsetof(struct drv_struct, member)) + \
56 	 BUILD_BUG_ON_ZERO(                                       \
57 		!__same_type(((struct drv_struct *)NULL)->member, \
58                                       struct ib_struct)))
59 #endif /* __FreeBSD_version > 1400000 */
60 
61 #define set_ibdev_dma_device(ibdev, dev) \
62 	ibdev.dma_device = (dev)
63 #define set_max_sge(props, rf)  \
64 	((props)->max_sge = (rf)->sc_dev.hw_attrs.uk_attrs.max_hw_wq_frags)
65 #define rdma_query_gid(ibdev, port, index, gid) \
66 	ib_get_cached_gid(ibdev, port, index, gid, NULL)
67 #define kmap(pg) page_address(pg)
68 #define kmap_local_page(pg) page_address(pg)
69 #define kunmap(pg)
70 #define kunmap_local(pg)
71 
72 #define IB_UVERBS_CQ_FLAGS_TIMESTAMP_COMPLETION IB_CQ_FLAGS_TIMESTAMP_COMPLETION
73 #if __FreeBSD_version < 1400026
74 #define kc_irdma_destroy_qp(ibqp, udata) irdma_destroy_qp(ibqp)
75 #else
76 #define kc_irdma_destroy_qp(ibqp, udata) irdma_destroy_qp(ibqp, udata)
77 #endif
78 #ifndef IB_QP_ATTR_STANDARD_BITS
79 #define IB_QP_ATTR_STANDARD_BITS GENMASK(20, 0)
80 #endif
81 
82 #define IRDMA_QOS_MODE_VLAN 0x0
83 #define IRDMA_QOS_MODE_DSCP 0x1
84 
85 #define IRDMA_VER_LEN 24
86 
87 void kc_set_roce_uverbs_cmd_mask(struct irdma_device *iwdev);
88 void kc_set_rdma_uverbs_cmd_mask(struct irdma_device *iwdev);
89 
90 struct irdma_tunable_info {
91 	struct sysctl_ctx_list irdma_sysctl_ctx;
92 	struct sysctl_oid *irdma_sysctl_tree;
93 	struct sysctl_oid *sws_sysctl_tree;
94 	char drv_ver[IRDMA_VER_LEN];
95 	u8 roce_ena;
96 };
97 
98 static inline int irdma_iw_query_pkey(struct ib_device *ibdev, u8 port, u16 index,
99 				      u16 *pkey)
100 {
101 	*pkey = 0;
102 	return 0;
103 }
104 
105 static inline int cq_validate_flags(u32 flags, u8 hw_rev)
106 {
107 	/* GEN1 does not support CQ create flags */
108 	if (hw_rev == IRDMA_GEN_1)
109 		return flags ? -EOPNOTSUPP : 0;
110 
111 	return flags & ~IB_UVERBS_CQ_FLAGS_TIMESTAMP_COMPLETION ? -EOPNOTSUPP : 0;
112 }
113 static inline u64 *irdma_next_pbl_addr(u64 *pbl, struct irdma_pble_info **pinfo,
114 				       u32 *idx)
115 {
116 	*idx += 1;
117 	if (!(*pinfo) || *idx != (*pinfo)->cnt)
118 		return ++pbl;
119 	*idx = 0;
120 	(*pinfo)++;
121 
122 	return (*pinfo)->addr;
123 }
124 #if __FreeBSD_version < 1400026
125 struct ib_cq *irdma_create_cq(struct ib_device *ibdev,
126 			      const struct ib_cq_init_attr *attr,
127 			      struct ib_ucontext *context,
128 			      struct ib_udata *udata);
129 #else
130 int irdma_create_cq(struct ib_cq *ibcq,
131 		    const struct ib_cq_init_attr *attr,
132 		    struct ib_udata *udata);
133 #endif
134 struct ib_qp *irdma_create_qp(struct ib_pd *ibpd,
135 			      struct ib_qp_init_attr *init_attr,
136 			      struct ib_udata *udata);
137 #if __FreeBSD_version >= 1400026
138 int irdma_create_ah(struct ib_ah *ib_ah,
139 		    struct ib_ah_attr *attr, u32 flags,
140 		    struct ib_udata *udata);
141 int irdma_create_ah_stub(struct ib_ah *ib_ah,
142 			 struct ib_ah_attr *attr, u32 flags,
143 			 struct ib_udata *udata);
144 #else
145 struct ib_ah *irdma_create_ah(struct ib_pd *ibpd,
146 			      struct ib_ah_attr *attr,
147 			      struct ib_udata *udata);
148 struct ib_ah *irdma_create_ah_stub(struct ib_pd *ibpd,
149 				   struct ib_ah_attr *attr,
150 				   struct ib_udata *udata);
151 #endif
152 void irdma_ether_copy(u8 *dmac, struct ib_ah_attr *attr);
153 
154 #if __FreeBSD_version >= 1400026
155 void irdma_destroy_ah(struct ib_ah *ibah, u32 flags);
156 void irdma_destroy_ah_stub(struct ib_ah *ibah, u32 flags);
157 #else
158 int irdma_destroy_ah(struct ib_ah *ibah);
159 int irdma_destroy_ah_stub(struct ib_ah *ibah);
160 #endif
161 #if __FreeBSD_version < 1400026
162 int irdma_destroy_qp(struct ib_qp *ibqp);
163 #else
164 int irdma_destroy_qp(struct ib_qp *ibqp, struct ib_udata *udata);
165 #endif
166 #if __FreeBSD_version < 1400026
167 int irdma_dereg_mr(struct ib_mr *ib_mr);
168 #else
169 int irdma_dereg_mr(struct ib_mr *ib_mr, struct ib_udata *udata);
170 #endif
171 int ib_get_eth_speed(struct ib_device *dev, u32 port_num, u8 *speed, u8 *width);
172 enum rdma_link_layer irdma_get_link_layer(struct ib_device *ibdev,
173 					  u8 port_num);
174 int irdma_roce_port_immutable(struct ib_device *ibdev, u8 port_num,
175 			      struct ib_port_immutable *immutable);
176 int irdma_iw_port_immutable(struct ib_device *ibdev, u8 port_num,
177 			    struct ib_port_immutable *immutable);
178 int irdma_query_gid(struct ib_device *ibdev, u8 port, int index,
179 		    union ib_gid *gid);
180 int irdma_query_gid_roce(struct ib_device *ibdev, u8 port, int index,
181 			 union ib_gid *gid);
182 int irdma_query_pkey(struct ib_device *ibdev, u8 port, u16 index,
183 		     u16 *pkey);
184 int irdma_query_port(struct ib_device *ibdev, u8 port,
185 		     struct ib_port_attr *props);
186 struct rdma_hw_stats *irdma_alloc_hw_stats(struct ib_device *ibdev, u8 port_num);
187 int irdma_get_hw_stats(struct ib_device *ibdev,
188 		       struct rdma_hw_stats *stats, u8 port_num,
189 		       int index);
190 
191 void irdma_request_reset(struct irdma_pci_f *rf);
192 int irdma_register_qset(struct irdma_sc_vsi *vsi,
193 			struct irdma_ws_node *tc_node);
194 void irdma_unregister_qset(struct irdma_sc_vsi *vsi,
195 			   struct irdma_ws_node *tc_node);
196 void ib_unregister_device(struct ib_device *ibdev);
197 #if __FreeBSD_version < 1400026
198 int rdma_user_mmap_io(struct ib_ucontext *ucontext, struct vm_area_struct *vma,
199 		      unsigned long pfn, unsigned long size, pgprot_t prot);
200 #endif
201 void irdma_disassociate_ucontext(struct ib_ucontext *context);
202 int kc_irdma_set_roce_cm_info(struct irdma_qp *iwqp,
203 			      struct ib_qp_attr *attr,
204 			      u16 *vlan_id);
205 
206 void kc_set_loc_seq_num_mss(struct irdma_cm_node *cm_node);
207 u16 kc_rdma_get_udp_sport(u32 fl, u32 lqpn, u32 rqpn);
208 
209 void irdma_get_dev_fw_str(struct ib_device *dev, char *str, size_t str_len);
210 
211 int irdma_modify_port(struct ib_device *ibdev, u8 port, int mask,
212 		      struct ib_port_modify *props);
213 int irdma_get_dst_mac(struct irdma_cm_node *cm_node, struct sockaddr *dst_sin,
214 		      u8 *dst_mac);
215 int irdma_resolve_neigh_lpb_chk(struct irdma_device *iwdev, struct irdma_cm_node *cm_node,
216 				struct irdma_cm_info *cm_info);
217 int irdma_addr_resolve_neigh(struct irdma_cm_node *cm_node, u32 dst_ip,
218 			     int arpindex);
219 int irdma_addr_resolve_neigh_ipv6(struct irdma_cm_node *cm_node, u32 *dest,
220 				  int arpindex);
221 void irdma_dcqcn_tunables_init(struct irdma_pci_f *rf);
222 void irdma_sysctl_settings(struct irdma_pci_f *rf);
223 void irdma_sw_stats_tunables_init(struct irdma_pci_f *rf);
224 u32 irdma_create_stag(struct irdma_device *iwdev);
225 void irdma_free_stag(struct irdma_device *iwdev, u32 stag);
226 
227 int irdma_hwdereg_mr(struct ib_mr *ib_mr);
228 int irdma_rereg_user_mr(struct ib_mr *ib_mr, int flags, u64 start, u64 len,
229 			u64 virt, int new_access, struct ib_pd *new_pd,
230 			struct ib_udata *udata);
231 struct irdma_mr;
232 struct irdma_cq;
233 struct irdma_cq_buf;
234 #if __FreeBSD_version < 1400026
235 struct ib_mr *irdma_alloc_mr(struct ib_pd *pd, enum ib_mr_type mr_type,
236 			     u32 max_num_sg);
237 #else
238 struct ib_mr *irdma_alloc_mr(struct ib_pd *pd, enum ib_mr_type mr_type,
239 			     u32 max_num_sg, struct ib_udata *udata);
240 #endif
241 int irdma_hwreg_mr(struct irdma_device *iwdev, struct irdma_mr *iwmr,
242 		   u16 access);
243 struct ib_mr *irdma_rereg_mr_trans(struct irdma_mr *iwmr, u64 start, u64 len,
244 				   u64 virt, struct ib_udata *udata);
245 int irdma_hw_alloc_mw(struct irdma_device *iwdev, struct irdma_mr *iwmr);
246 struct ib_mw *irdma_alloc_mw(struct ib_pd *pd, enum ib_mw_type type,
247 			     struct ib_udata *udata);
248 int irdma_hw_alloc_stag(struct irdma_device *iwdev, struct irdma_mr *iwmr);
249 void irdma_cq_free_rsrc(struct irdma_pci_f *rf, struct irdma_cq *iwcq);
250 int irdma_validate_qp_attrs(struct ib_qp_init_attr *init_attr,
251 			    struct irdma_device *iwdev);
252 void irdma_setup_virt_qp(struct irdma_device *iwdev,
253                          struct irdma_qp *iwqp,
254                          struct irdma_qp_init_info *init_info);
255 int irdma_setup_kmode_qp(struct irdma_device *iwdev,
256 			 struct irdma_qp *iwqp,
257 			 struct irdma_qp_init_info *info,
258 			 struct ib_qp_init_attr *init_attr);
259 int irdma_setup_umode_qp(struct ib_udata *udata,
260 			 struct irdma_device *iwdev,
261 			 struct irdma_qp *iwqp,
262 			 struct irdma_qp_init_info *info,
263 			 struct ib_qp_init_attr *init_attr);
264 void irdma_roce_fill_and_set_qpctx_info(struct irdma_qp *iwqp,
265 					struct irdma_qp_host_ctx_info *ctx_info);
266 void irdma_iw_fill_and_set_qpctx_info(struct irdma_qp *iwqp,
267 				      struct irdma_qp_host_ctx_info *ctx_info);
268 int irdma_cqp_create_qp_cmd(struct irdma_qp *iwqp);
269 void irdma_dealloc_push_page(struct irdma_pci_f *rf,
270 			     struct irdma_sc_qp *qp);
271 int irdma_process_resize_list(struct irdma_cq *iwcq, struct irdma_device *iwdev,
272 			      struct irdma_cq_buf *lcqe_buf);
273 #if __FreeBSD_version < 1400026
274 int irdma_destroy_cq(struct ib_cq *ib_cq);
275 #else
276 void irdma_destroy_cq(struct ib_cq *ib_cq, struct ib_udata *udata);
277 #endif
278 #if __FreeBSD_version < 1400026
279 struct ib_ucontext *irdma_alloc_ucontext(struct ib_device *, struct ib_udata *);
280 #else
281 int irdma_alloc_ucontext(struct ib_ucontext *uctx, struct ib_udata *udata);
282 #endif
283 #if __FreeBSD_version < 1400026
284 int irdma_dealloc_ucontext(struct ib_ucontext *);
285 #else
286 void irdma_dealloc_ucontext(struct ib_ucontext *context);
287 #endif
288 #if __FreeBSD_version < 1400026
289 struct ib_pd *irdma_alloc_pd(struct ib_device *, struct ib_ucontext *,
290 			     struct ib_udata *);
291 #else
292 int irdma_alloc_pd(struct ib_pd *pd, struct ib_udata *udata);
293 #endif
294 #if __FreeBSD_version < 1400026
295 int irdma_dealloc_pd(struct ib_pd *);
296 #else
297 void irdma_dealloc_pd(struct ib_pd *ibpd, struct ib_udata *udata);
298 #endif
299 int irdma_add_gid(struct ib_device *, u8, unsigned int, const union ib_gid *,
300 		  const struct ib_gid_attr *, void **);
301 int irdma_del_gid(struct ib_device *, u8, unsigned int, void **);
302 struct ib_device *ib_device_get_by_netdev(struct ifnet *ndev, int driver_id);
303 void ib_device_put(struct ib_device *device);
304 void ib_unregister_device_put(struct ib_device *device);
305 enum ib_mtu ib_mtu_int_to_enum(int mtu);
306 struct irdma_pbl *irdma_get_pbl(unsigned long va, struct list_head *pbl_list);
307 void irdma_clean_cqes(struct irdma_qp *iwqp, struct irdma_cq *iwcq);
308 void irdma_remove_push_mmap_entries(struct irdma_qp *iwqp);
309 
310 struct irdma_ucontext;
311 void irdma_del_memlist(struct irdma_mr *iwmr, struct irdma_ucontext *ucontext);
312 void irdma_copy_user_pgaddrs(struct irdma_mr *iwmr, u64 *pbl,
313 			     enum irdma_pble_level level);
314 void irdma_reg_ipaddr_event_cb(struct irdma_pci_f *rf);
315 void irdma_dereg_ipaddr_event_cb(struct irdma_pci_f *rf);
316 
317 /* Introduced in this series https://lore.kernel.org/linux-rdma/0-v2-270386b7e60b+28f4-umem_1_jgg@nvidia.com/
318  * An irdma version helper doing same for older functions with difference that iova is passed in
319  * as opposed to derived from umem->iova.
320  */
321 static inline size_t irdma_ib_umem_num_dma_blocks(struct ib_umem *umem, unsigned long pgsz, u64 iova)
322 {
323 	/* some older OFED distros do not have ALIGN_DOWN */
324 #ifndef ALIGN_DOWN
325 #define ALIGN_DOWN(x, a)	ALIGN((x) - ((a) - 1), (a))
326 #endif
327 
328 	return (size_t)((ALIGN(iova + umem->length, pgsz) -
329 			 ALIGN_DOWN(iova, pgsz))) / pgsz;
330 }
331 
332 static inline void addrconf_addr_eui48(u8 *deui, const char *const addr)
333 {
334 	memcpy(deui, addr, 3);
335 	deui[3] = 0xFF;
336 	deui[4] = 0xFE;
337 	memcpy(deui + 5, addr + 3, 3);
338 	deui[0] ^= 2;
339 }
340 
341 #endif /* FBSD_KCOMPAT_H */
342