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 #define XDP_UMEM_MIN_CHUNK_SHIFT 11
13 #define XDP_UMEM_MIN_CHUNK_SIZE (1 << XDP_UMEM_MIN_CHUNK_SHIFT)
15 #ifdef CONFIG_XDP_SOCKETS
17 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries);
18 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc);
19 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 max);
20 void xsk_tx_release(struct xsk_buff_pool *pool);
21 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
23 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool);
24 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool);
25 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool);
26 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool);
27 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool);
29 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
31 return XDP_PACKET_HEADROOM + pool->headroom;
34 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
36 return pool->chunk_size;
39 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
41 return xsk_pool_get_chunk_size(pool) - xsk_pool_get_headroom(pool);
44 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
45 struct xdp_rxq_info *rxq)
47 xp_set_rxq_info(pool, rxq);
50 static inline unsigned int xsk_pool_get_napi_id(struct xsk_buff_pool *pool)
52 #ifdef CONFIG_NET_RX_BUSY_POLL
53 return pool->heads[0].xdp.rxq->napi_id;
59 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
62 xp_dma_unmap(pool, attrs);
65 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
66 struct device *dev, unsigned long attrs)
68 struct xdp_umem *umem = pool->umem;
70 return xp_dma_map(pool, dev, attrs, umem->pgs, umem->npgs);
73 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
75 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
77 return xp_get_dma(xskb);
80 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
82 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
84 return xp_get_frame_dma(xskb);
87 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
89 return xp_alloc(pool);
92 /* Returns as many entries as possible up to max. 0 <= N <= max. */
93 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
95 return xp_alloc_batch(pool, xdp, max);
98 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
100 return xp_can_alloc(pool, count);
103 static inline void xsk_buff_free(struct xdp_buff *xdp)
105 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
110 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
112 xdp->data = xdp->data_hard_start + XDP_PACKET_HEADROOM;
113 xdp->data_meta = xdp->data;
114 xdp->data_end = xdp->data + size;
117 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
120 return xp_raw_get_dma(pool, addr);
123 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
125 return xp_raw_get_data(pool, addr);
128 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
130 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
132 if (!pool->dma_need_sync)
135 xp_dma_sync_for_cpu(xskb);
138 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
142 xp_dma_sync_for_device(pool, dma, size);
147 static inline void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
151 static inline bool xsk_tx_peek_desc(struct xsk_buff_pool *pool,
152 struct xdp_desc *desc)
157 static inline u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 max)
162 static inline void xsk_tx_release(struct xsk_buff_pool *pool)
166 static inline struct xsk_buff_pool *
167 xsk_get_pool_from_qid(struct net_device *dev, u16 queue_id)
172 static inline void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
176 static inline void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
180 static inline void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
184 static inline void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
188 static inline bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
193 static inline u32 xsk_pool_get_headroom(struct xsk_buff_pool *pool)
198 static inline u32 xsk_pool_get_chunk_size(struct xsk_buff_pool *pool)
203 static inline u32 xsk_pool_get_rx_frame_size(struct xsk_buff_pool *pool)
208 static inline void xsk_pool_set_rxq_info(struct xsk_buff_pool *pool,
209 struct xdp_rxq_info *rxq)
213 static inline unsigned int xsk_pool_get_napi_id(struct xsk_buff_pool *pool)
218 static inline void xsk_pool_dma_unmap(struct xsk_buff_pool *pool,
223 static inline int xsk_pool_dma_map(struct xsk_buff_pool *pool,
224 struct device *dev, unsigned long attrs)
229 static inline dma_addr_t xsk_buff_xdp_get_dma(struct xdp_buff *xdp)
234 static inline dma_addr_t xsk_buff_xdp_get_frame_dma(struct xdp_buff *xdp)
239 static inline struct xdp_buff *xsk_buff_alloc(struct xsk_buff_pool *pool)
244 static inline u32 xsk_buff_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
249 static inline bool xsk_buff_can_alloc(struct xsk_buff_pool *pool, u32 count)
254 static inline void xsk_buff_free(struct xdp_buff *xdp)
258 static inline void xsk_buff_discard(struct xdp_buff *xdp)
262 static inline void xsk_buff_set_size(struct xdp_buff *xdp, u32 size)
266 static inline dma_addr_t xsk_buff_raw_get_dma(struct xsk_buff_pool *pool,
272 static inline void *xsk_buff_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
277 static inline void xsk_buff_dma_sync_for_cpu(struct xdp_buff *xdp, struct xsk_buff_pool *pool)
281 static inline void xsk_buff_raw_dma_sync_for_device(struct xsk_buff_pool *pool,
287 #endif /* CONFIG_XDP_SOCKETS */
289 #endif /* _LINUX_XDP_SOCK_DRV_H */