xref: /freebsd/contrib/ofed/libirdma/osdep.h (revision 5b5f7d0e77a9eee73eb5d596f43aef4e1a3674d8)
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 _ICRDMA_OSDEP_H_
36 #define _ICRDMA_OSDEP_H_
37 
38 #include <stdatomic.h>
39 #include <stdbool.h>
40 #include <stdio.h>
41 #include <infiniband/types.h>
42 #include <infiniband/verbs.h>
43 #include <infiniband/udma_barrier.h>
44 #include <sys/bus.h>
45 #include <sys/bus_dma.h>
46 #include <sys/endian.h>
47 
48 #define IOMEM
49 #define IRDMA_NTOHL(a) ntohl(a)
50 #define IRDMA_NTOHS(a) ntohs(a)
51 #define MAKEMASK(m, s) ((m) << (s))
52 #define OS_TIMER timer_list
53 #define OS_LIST_HEAD list_head
54 #define OS_LIST_ENTRY list_head
55 #define DECLARE_HASHTABLE(n, b) struct hlist_head (n)[1 << (b)]
56 #define HASH_MIN(v, b) (sizeof(v) <= 4 ? hash_32(v, b) : hash_long(v, b))
57 #define HASH_FOR_EACH_RCU(n, b, o, m) 	for ((b) = 0, o = NULL; o == NULL && (b) < ARRAY_SIZE(n);\
58 			(b)++)\
59 		hlist_for_each_entry_rcu(o, &n[(b)], m)
60 #define HASH_FOR_EACH_POSSIBLE_RCU(n, o, m, k)		\
61 	hlist_for_each_entry_rcu(o, &n[jhash(&k, sizeof(k), 0) >> (32 - ilog2(ARRAY_SIZE(n)))],\
62 		m)
63 #define HASH_FOR_EACH_POSSIBLE(n, o, m, k)		\
64 	hlist_for_each_entry(o, &n[jhash(&k, sizeof(k), 0) >> (32 - ilog2(ARRAY_SIZE(n)))],\
65 		m)
66 #define HASH_ADD_RCU(h, n, k) \
67 	hlist_add_head_rcu(n, &h[jhash(&k, sizeof(k), 0) >> (32 - ilog2(ARRAY_SIZE(h)))])
68 #define HASH_DEL_RCU(tbl, node) hlist_del_rcu(node)
69 #define HASH_ADD(h, n, k) \
70 	hlist_add_head(n, &h[jhash(&k, sizeof(k), 0) >> (32 - ilog2(ARRAY_SIZE(h)))])
71 #define HASH_DEL(tbl, node) hlist_del(node)
72 
73 #define WQ_UNBOUND_MAX_ACTIVE max_t(int, 512, num_possible_cpus() * 4)
74 #define if_addr_rlock(x)
75 #define if_addr_runlock(x)
76 
77 /* constants */
78 #define STATS_TIMER_DELAY 60000
79 
80 #define BIT_ULL(a) (1ULL << (a))
81 #define min(a, b) ((a) > (b) ? (b) : (a))
82 #ifndef likely
83 #define likely(x)  __builtin_expect((x), 1)
84 #endif
85 #ifndef unlikely
86 #define unlikely(x)  __builtin_expect((x), 0)
87 #endif
88 
89 #define __aligned_u64 uint64_t __aligned(8)
90 
91 #define VLAN_PRIO_SHIFT 13
92 
93 /*
94  * debug definition section
95  */
96 #define irdma_print(S, ...) printf("%s:%d "S, __FUNCTION__, __LINE__, ##__VA_ARGS__)
97 #define irdma_debug_buf(dev, mask, desc, buf, size)							\
98 do {													\
99 	u32 i;												\
100 	if (!((mask) & (dev)->debug_mask)) {								\
101 		break;											\
102 	}												\
103 	irdma_debug(dev, mask, "%s\n", desc);								\
104 	irdma_debug(dev, mask, "starting address virt=%p phy=%lxh\n", buf, irdma_get_virt_to_phy(buf));	\
105 	for (i = 0; i < size ; i += 8)									\
106 		irdma_debug(dev, mask, "index %03d val: %016lx\n", i, ((unsigned long *)(buf))[i / 8]);	\
107 } while(0)
108 
109 #define irdma_debug(h, m, s, ...)				\
110 do {								\
111 	if (!(h)) {						\
112 		if ((m) == IRDMA_DEBUG_INIT)			\
113 			printf("irdma INIT " s, ##__VA_ARGS__);	\
114 	} else if (((m) & (h)->debug_mask)) {			\
115 		printf("irdma " s, ##__VA_ARGS__);		\
116 	} 							\
117 } while (0)
118 extern unsigned int irdma_dbg;
119 #define libirdma_debug(fmt, args...)				\
120 do {								\
121 	if (irdma_dbg)						\
122 		printf("libirdma-%s: " fmt, __func__, ##args);	\
123 } while (0)
124 #define irdma_dev_err(ibdev, fmt, ...) \
125 	pr_err("%s:%s:%d ERR "fmt, (ibdev)->name, __func__, __LINE__, ##__VA_ARGS__)
126 #define irdma_dev_warn(ibdev, fmt, ...) \
127 	pr_warn("%s:%s:%d WARN "fmt, (ibdev)->name, __func__, __LINE__, ##__VA_ARGS__)
128 #define irdma_dev_info(a, b, ...) printf(b, ##__VA_ARGS__)
129 #define irdma_pr_warn printf
130 
131 /*
132  * debug definition end
133  */
134 
135 typedef __be16 BE16;
136 typedef __be32 BE32;
137 typedef uintptr_t irdma_uintptr;
138 
139 struct irdma_hw;
140 struct irdma_pci_f;
141 struct irdma_sc_dev;
142 struct irdma_sc_qp;
143 struct irdma_sc_vsi;
144 
145 #define irdma_pr_info(fmt, args ...) printf("%s: WARN "fmt, __func__, ## args)
146 #define irdma_pr_err(fmt, args ...) printf("%s: ERR "fmt, __func__, ## args)
147 #define irdma_memcpy(a, b, c)  memcpy((a), (b), (c))
148 #define irdma_memset(a, b, c)  memset((a), (b), (c))
149 #define irdma_usec_delay(x) DELAY(x)
150 #define mdelay(x) DELAY((x) * 1000)
151 
152 #define rt_tos2priority(tos) (tos >> 5)
153 #define ah_attr_to_dmac(attr) ((attr).dmac)
154 #define irdma_del_timer_compat(tt) del_timer((tt))
155 #define IRDMA_TAILQ_FOREACH CK_STAILQ_FOREACH
156 #define IRDMA_TAILQ_FOREACH_SAFE CK_STAILQ_FOREACH_SAFE
157 #define between(a, b, c) (bool)(c-a >= b-a)
158 
db_wr32(__u32 val,__u32 * wqe_word)159 static inline void db_wr32(__u32 val, __u32 *wqe_word)
160 {
161 	*wqe_word = val;
162 }
163 
164 void *hw_to_dev(struct irdma_hw *hw);
165 
166 struct irdma_dma_mem {
167 	void *va;
168 	u64 pa;
169 	bus_dma_tag_t tag;
170 	bus_dmamap_t map;
171 	bus_dma_segment_t seg;
172 	bus_size_t size;
173 	int nseg;
174 	int flags;
175 };
176 
177 struct irdma_virt_mem {
178 	void *va;
179 	u32 size;
180 };
181 
182 #ifndef verbs_mr
183 enum ibv_mr_type {
184 	IBV_MR_TYPE_MR,
185 	IBV_MR_TYPE_NULL_MR,
186 };
187 
188 struct verbs_mr {
189 	struct ibv_mr		ibv_mr;
190 	enum ibv_mr_type	mr_type;
191 	int 			access;
192 };
193 #define verbs_get_mr(mr) container_of((mr), struct verbs_mr, ibv_mr)
194 #endif
195 #endif /* _ICRDMA_OSDEP_H_ */
196