1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Interface for implementing AF_XDP zero-copy support in drivers.
3 * Copyright(c) 2020 Intel Corporation.
6 #ifndef _LINUX_XDP_SOCK_DRV_H
7 #define _LINUX_XDP_SOCK_DRV_H
9 #include <net/xdp_sock.h>
10 #include <net/xsk_buff_pool.h>
12 #ifdef CONFIG_XDP_SOCKETS
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,
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);
26 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
28 return XDP_PACKET_HEADROOM + pool->headroom;
31 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
33 return pool->chunk_size;
36 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
38 return xsk_pool_get_chunk_size(pool) - xsk_pool_get_headroom(pool);
41 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
42 struct xdp_rxq_info *rxq)
44 xp_set_rxq_info(pool, rxq);
47 static inline unsigned int xsk_pool_get_napi_id(struct xsk_buff_pool *pool)
49 #ifdef CONFIG_NET_RX_BUSY_POLL
50 return pool->heads[0].xdp.rxq->napi_id;
56 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
59 xp_dma_unmap(pool, attrs);
62 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
63 struct device *dev, unsigned long attrs)
65 struct xdp_umem *umem = pool->umem;
67 return xp_dma_map(pool, dev, attrs, umem->pgs, umem->npgs);
70 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
72 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
74 return xp_get_dma(xskb);
77 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
79 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
81 return xp_get_frame_dma(xskb);
84 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
86 return xp_alloc(pool);
89 /* Returns as many entries as possible up to max. 0 <= N <= max. */
90 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
92 return xp_alloc_batch(pool, xdp, max);
95 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
97 return xp_can_alloc(pool, count);
100 static inline void xsk_buff_free(struct xdp_buff *xdp)
102 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
107 static inline void xsk_buff_discard(struct xdp_buff *xdp)
109 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
114 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
116 xdp->data = xdp->data_hard_start + XDP_PACKET_HEADROOM;
117 xdp->data_meta = xdp->data;
118 xdp->data_end = xdp->data + size;
121 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
124 return xp_raw_get_dma(pool, addr);
127 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
129 return xp_raw_get_data(pool, addr);
132 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
134 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
136 if (!pool->dma_need_sync)
139 xp_dma_sync_for_cpu(xskb);
142 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
146 xp_dma_sync_for_device(pool, dma, size);
151 static inline void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
155 static inline bool xsk_tx_peek_desc(struct xsk_buff_pool *pool,
156 struct xdp_desc *desc)
161 static inline u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 max)
166 static inline void xsk_tx_release(struct xsk_buff_pool *pool)
170 static inline struct xsk_buff_pool *
171 xsk_get_pool_from_qid(struct net_device *dev, u16 queue_id)
176 static inline void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
180 static inline void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
184 static inline void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
188 static inline void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
192 static inline bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
197 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
202 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
207 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
212 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
213 struct xdp_rxq_info *rxq)
217 static inline unsigned int xsk_pool_get_napi_id(struct xsk_buff_pool *pool)
222 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
227 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
228 struct device *dev, unsigned long attrs)
233 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
238 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
243 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
248 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
253 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
258 static inline void xsk_buff_free(struct xdp_buff *xdp)
262 static inline void xsk_buff_discard(struct xdp_buff *xdp)
266 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
270 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
276 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
281 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
285 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
291 #endif /* CONFIG_XDP_SOCKETS */
293 #endif /* _LINUX_XDP_SOCK_DRV_H */