1 /* SPDX-License-Identifier: (BSD-3-Clause OR LGPL-2.1) */
3 * Copyright(c) 2007-2014 Intel Corporation.
6 #ifndef _RTE_KNI_COMMON_H_
7 #define _RTE_KNI_COMMON_H_
15 #include <asm/barrier.h>
18 #include <rte_common.h>
19 #include <rte_config.h>
23 * KNI name is part of memzone name. Must not exceed IFNAMSIZ.
25 #define RTE_KNI_NAMESIZE 16
27 #define RTE_CACHE_LINE_MIN_SIZE 64
33 RTE_KNI_REQ_UNKNOWN = 0,
34 RTE_KNI_REQ_CHANGE_MTU,
35 RTE_KNI_REQ_CFG_NETWORK_IF,
36 RTE_KNI_REQ_CHANGE_MAC_ADDR,
37 RTE_KNI_REQ_CHANGE_PROMISC,
38 RTE_KNI_REQ_CHANGE_ALLMULTI,
43 * Structure for KNI request.
45 struct rte_kni_request {
46 uint32_t req_id; /**< Request id */
49 uint32_t new_mtu; /**< New MTU */
50 uint8_t if_up; /**< 1: interface up, 0: interface down */
51 uint8_t mac_addr[6]; /**< MAC address for interface */
52 uint8_t promiscusity;/**< 1: promisc mode enable, 0: disable */
53 uint8_t allmulti; /**< 1: all-multicast mode enable, 0: disable */
55 int32_t async : 1; /**< 1: request is asynchronous */
56 int32_t result; /**< Result for processing request */
57 } __attribute__((__packed__));
60 * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
61 * Write and read should wrap around. Fifo is empty when write == read
62 * Writing should never overwrite the read position
65 #ifdef RTE_USE_C11_MEM_MODEL
66 unsigned write; /**< Next position to be written*/
67 unsigned read; /**< Next position to be read */
69 volatile unsigned write; /**< Next position to be written*/
70 volatile unsigned read; /**< Next position to be read */
72 unsigned len; /**< Circular buffer length */
73 unsigned elem_size; /**< Pointer size - for 32/64 bit OS */
74 void *volatile buffer[]; /**< The buffer contains mbuf pointers */
78 * The kernel image of the rte_mbuf struct, with only the relevant fields.
79 * Padding is necessary to assure the offsets of these fields
82 void *buf_addr __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
84 uint16_t data_off; /**< Start address of data in segment buffer. */
86 uint16_t nb_segs; /**< Number of segments. */
88 uint64_t ol_flags; /**< Offload features. */
90 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
91 uint16_t data_len; /**< Amount of data in segment buffer. */
95 /* fields on second cache line */
96 __attribute__((__aligned__(RTE_CACHE_LINE_MIN_SIZE)))
97 void *next; /**< Physical address of next mbuf in kernel. */
101 * Struct used to create a KNI device. Passed to the kernel in IOCTL call
104 struct rte_kni_device_info {
105 char name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */
109 phys_addr_t alloc_phys;
110 phys_addr_t free_phys;
112 /* Used by Ethtool */
113 phys_addr_t req_phys;
114 phys_addr_t resp_phys;
115 phys_addr_t sync_phys;
120 phys_addr_t mbuf_phys;
122 uint16_t group_id; /**< Group ID */
123 uint32_t core_id; /**< core ID to bind for kernel thread */
126 uint8_t force_bind : 1; /**< Flag for kernel thread binding */
131 unsigned int min_mtu;
132 unsigned int max_mtu;
137 #define KNI_DEVICE "kni"
139 #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)
140 #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
141 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
147 #endif /* _RTE_KNI_COMMON_H_ */