xref: /linux-6.15/include/uapi/linux/if_xdp.h (revision b9b6b68e)
1c0c77d8fSBjörn Töpel /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note
2c0c77d8fSBjörn Töpel  *
3c0c77d8fSBjörn Töpel  * if_xdp: XDP socket user-space interface
4c0c77d8fSBjörn Töpel  * Copyright(c) 2018 Intel Corporation.
5c0c77d8fSBjörn Töpel  *
6c0c77d8fSBjörn Töpel  * This program is free software; you can redistribute it and/or modify it
7c0c77d8fSBjörn Töpel  * under the terms and conditions of the GNU General Public License,
8c0c77d8fSBjörn Töpel  * version 2, as published by the Free Software Foundation.
9c0c77d8fSBjörn Töpel  *
10c0c77d8fSBjörn Töpel  * This program is distributed in the hope it will be useful, but WITHOUT
11c0c77d8fSBjörn Töpel  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12c0c77d8fSBjörn Töpel  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13c0c77d8fSBjörn Töpel  * more details.
14c0c77d8fSBjörn Töpel  *
15c0c77d8fSBjörn Töpel  * Author(s): Björn Töpel <[email protected]>
16c0c77d8fSBjörn Töpel  *	      Magnus Karlsson <[email protected]>
17c0c77d8fSBjörn Töpel  */
18c0c77d8fSBjörn Töpel 
19c0c77d8fSBjörn Töpel #ifndef _LINUX_IF_XDP_H
20c0c77d8fSBjörn Töpel #define _LINUX_IF_XDP_H
21c0c77d8fSBjörn Töpel 
22c0c77d8fSBjörn Töpel #include <linux/types.h>
23c0c77d8fSBjörn Töpel 
24c0c77d8fSBjörn Töpel /* XDP socket options */
25*b9b6b68eSBjörn Töpel #define XDP_RX_RING			1
26c0c77d8fSBjörn Töpel #define XDP_UMEM_REG			3
27423f3832SMagnus Karlsson #define XDP_UMEM_FILL_RING		4
28c0c77d8fSBjörn Töpel 
29c0c77d8fSBjörn Töpel struct xdp_umem_reg {
30c0c77d8fSBjörn Töpel 	__u64 addr; /* Start of packet data area */
31c0c77d8fSBjörn Töpel 	__u64 len; /* Length of packet data area */
32c0c77d8fSBjörn Töpel 	__u32 frame_size; /* Frame size */
33c0c77d8fSBjörn Töpel 	__u32 frame_headroom; /* Frame head room */
34c0c77d8fSBjörn Töpel };
35c0c77d8fSBjörn Töpel 
36423f3832SMagnus Karlsson /* Pgoff for mmaping the rings */
37*b9b6b68eSBjörn Töpel #define XDP_PGOFF_RX_RING			  0
38423f3832SMagnus Karlsson #define XDP_UMEM_PGOFF_FILL_RING	0x100000000
39423f3832SMagnus Karlsson 
40*b9b6b68eSBjörn Töpel struct xdp_desc {
41*b9b6b68eSBjörn Töpel 	__u32 idx;
42*b9b6b68eSBjörn Töpel 	__u32 len;
43*b9b6b68eSBjörn Töpel 	__u16 offset;
44*b9b6b68eSBjörn Töpel 	__u8 flags;
45*b9b6b68eSBjörn Töpel 	__u8 padding[5];
46*b9b6b68eSBjörn Töpel };
47*b9b6b68eSBjörn Töpel 
48423f3832SMagnus Karlsson struct xdp_ring {
49423f3832SMagnus Karlsson 	__u32 producer __attribute__((aligned(64)));
50423f3832SMagnus Karlsson 	__u32 consumer __attribute__((aligned(64)));
51423f3832SMagnus Karlsson };
52423f3832SMagnus Karlsson 
53*b9b6b68eSBjörn Töpel /* Used for the RX and TX queues for packets */
54*b9b6b68eSBjörn Töpel struct xdp_rxtx_ring {
55*b9b6b68eSBjörn Töpel 	struct xdp_ring ptrs;
56*b9b6b68eSBjörn Töpel 	struct xdp_desc desc[0] __attribute__((aligned(64)));
57*b9b6b68eSBjörn Töpel };
58*b9b6b68eSBjörn Töpel 
59423f3832SMagnus Karlsson /* Used for the fill and completion queues for buffers */
60423f3832SMagnus Karlsson struct xdp_umem_ring {
61423f3832SMagnus Karlsson 	struct xdp_ring ptrs;
62423f3832SMagnus Karlsson 	__u32 desc[0] __attribute__((aligned(64)));
63423f3832SMagnus Karlsson };
64423f3832SMagnus Karlsson 
65c0c77d8fSBjörn Töpel #endif /* _LINUX_IF_XDP_H */
66