xref: /openbmc/linux/include/net/xdp_sock_drv.h (revision 349d03ff) 
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Interface for implementing AF_XDP zero-copy support in drivers.
3  * Copyright(c) 2020 Intel Corporation.
4  */
5 
6 #ifndef _LINUX_XDP_SOCK_DRV_H
7 #define _LINUX_XDP_SOCK_DRV_H
8 
9 #include <net/xdp_sock.h>
10 #include <net/xsk_buff_pool.h>
11 
12 #ifdef CONFIG_XDP_SOCKETS
13 
14 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries);
15 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc);
16 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 max);
17 void xsk_tx_release(struct xsk_buff_pool *pool);
18 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
19 					    u16 queue_id);
20 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool);
21 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool);
22 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool);
23 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool);
24 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool);
25 
26 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
27 {
28 	return XDP_PACKET_HEADROOM + pool->headroom;
29 }
30 
31 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
32 {
33 	return pool->chunk_size;
34 }
35 
36 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
37 {
38 	return xsk_pool_get_chunk_size(pool) - xsk_pool_get_headroom(pool);
39 }
40 
41 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
42 					 struct xdp_rxq_info *rxq)
43 {
44 	xp_set_rxq_info(pool, rxq);
45 }
46 
47 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
48 				      unsigned long attrs)
49 {
50 	xp_dma_unmap(pool, attrs);
51 }
52 
53 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
54 				   struct device *dev, unsigned long attrs)
55 {
56 	struct xdp_umem *umem = pool->umem;
57 
58 	return xp_dma_map(pool, dev, attrs, umem->pgs, umem->npgs);
59 }
60 
61 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
62 {
63 	struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
64 
65 	return xp_get_dma(xskb);
66 }
67 
68 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
69 {
70 	struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
71 
72 	return xp_get_frame_dma(xskb);
73 }
74 
75 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
76 {
77 	return xp_alloc(pool);
78 }
79 
80 /* Returns as many entries as possible up to max. 0 <= N <= max. */
81 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
82 {
83 	return xp_alloc_batch(pool, xdp, max);
84 }
85 
86 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
87 {
88 	return xp_can_alloc(pool, count);
89 }
90 
91 static inline void xsk_buff_free(struct xdp_buff *xdp)
92 {
93 	struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
94 
95 	xp_free(xskb);
96 }
97 
98 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
99 {
100 	xdp->data = xdp->data_hard_start + XDP_PACKET_HEADROOM;
101 	xdp->data_meta = xdp->data;
102 	xdp->data_end = xdp->data + size;
103 }
104 
105 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
106 					      u64 addr)
107 {
108 	return xp_raw_get_dma(pool, addr);
109 }
110 
111 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
112 {
113 	return xp_raw_get_data(pool, addr);
114 }
115 
116 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
117 {
118 	struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
119 
120 	if (!pool->dma_need_sync)
121 		return;
122 
123 	xp_dma_sync_for_cpu(xskb);
124 }
125 
126 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
127 						    dma_addr_t dma,
128 						    size_t size)
129 {
130 	xp_dma_sync_for_device(pool, dma, size);
131 }
132 
133 #else
134 
135 static inline void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
136 {
137 }
138 
139 static inline bool xsk_tx_peek_desc(struct xsk_buff_pool *pool,
140 				    struct xdp_desc *desc)
141 {
142 	return false;
143 }
144 
145 static inline u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 max)
146 {
147 	return 0;
148 }
149 
150 static inline void xsk_tx_release(struct xsk_buff_pool *pool)
151 {
152 }
153 
154 static inline struct xsk_buff_pool *
155 xsk_get_pool_from_qid(struct net_device *dev, u16 queue_id)
156 {
157 	return NULL;
158 }
159 
160 static inline void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
161 {
162 }
163 
164 static inline void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
165 {
166 }
167 
168 static inline void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
169 {
170 }
171 
172 static inline void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
173 {
174 }
175 
176 static inline bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
177 {
178 	return false;
179 }
180 
181 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
182 {
183 	return 0;
184 }
185 
186 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
187 {
188 	return 0;
189 }
190 
191 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
192 {
193 	return 0;
194 }
195 
196 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
197 					 struct xdp_rxq_info *rxq)
198 {
199 }
200 
201 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
202 				      unsigned long attrs)
203 {
204 }
205 
206 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
207 				   struct device *dev, unsigned long attrs)
208 {
209 	return 0;
210 }
211 
212 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
213 {
214 	return 0;
215 }
216 
217 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
218 {
219 	return 0;
220 }
221 
222 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
223 {
224 	return NULL;
225 }
226 
227 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
228 {
229 	return 0;
230 }
231 
232 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
233 {
234 	return false;
235 }
236 
237 static inline void xsk_buff_free(struct xdp_buff *xdp)
238 {
239 }
240 
241 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
242 {
243 }
244 
245 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
246 					      u64 addr)
247 {
248 	return 0;
249 }
250 
251 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
252 {
253 	return NULL;
254 }
255 
256 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
257 {
258 }
259 
260 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
261 						    dma_addr_t dma,
262 						    size_t size)
263 {
264 }
265 
266 #endif /* CONFIG_XDP_SOCKETS */
267 
268 #endif /* _LINUX_XDP_SOCK_DRV_H */
269