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_
13 #include <rte_common.h>
14 #include <rte_config.h>
18 * KNI name is part of memzone name.
20 #define RTE_KNI_NAMESIZE 32
22 #define RTE_CACHE_LINE_MIN_SIZE 64
28 RTE_KNI_REQ_UNKNOWN = 0,
29 RTE_KNI_REQ_CHANGE_MTU,
30 RTE_KNI_REQ_CFG_NETWORK_IF,
31 RTE_KNI_REQ_CHANGE_MAC_ADDR,
36 * Structure for KNI request.
38 struct rte_kni_request {
39 uint32_t req_id; /**< Request id */
42 uint32_t new_mtu; /**< New MTU */
43 uint8_t if_up; /**< 1: interface up, 0: interface down */
44 uint8_t mac_addr[6]; /**< MAC address for interface */
46 int32_t result; /**< Result for processing request */
47 } __attribute__((__packed__));
50 * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
51 * Write and read should wrap around. Fifo is empty when write == read
52 * Writing should never overwrite the read position
55 volatile unsigned write; /**< Next position to be written*/
56 volatile unsigned read; /**< Next position to be read */
57 unsigned len; /**< Circular buffer length */
58 unsigned elem_size; /**< Pointer size - for 32/64 bit OS */
59 void *volatile buffer[]; /**< The buffer contains mbuf pointers */
63 * The kernel image of the rte_mbuf struct, with only the relevant fields.
64 * Padding is necessary to assure the offsets of these fields
67 void *buf_addr __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
68 uint64_t buf_physaddr;
69 uint16_t data_off; /**< Start address of data in segment buffer. */
71 uint16_t nb_segs; /**< Number of segments. */
73 uint64_t ol_flags; /**< Offload features. */
75 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
76 uint16_t data_len; /**< Amount of data in segment buffer. */
78 /* fields on second cache line */
79 char pad3[8] __attribute__((__aligned__(RTE_CACHE_LINE_MIN_SIZE)));
85 * Struct used to create a KNI device. Passed to the kernel in IOCTL call
88 struct rte_kni_device_info {
89 char name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */
93 phys_addr_t alloc_phys;
94 phys_addr_t free_phys;
98 phys_addr_t resp_phys;
99 phys_addr_t sync_phys;
104 phys_addr_t mbuf_phys;
107 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
108 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
109 uint8_t bus; /**< Device bus */
110 uint8_t devid; /**< Device ID */
111 uint8_t function; /**< Device function. */
113 uint16_t group_id; /**< Group ID */
114 uint32_t core_id; /**< core ID to bind for kernel thread */
117 uint8_t force_bind : 1; /**< Flag for kernel thread binding */
124 #define KNI_DEVICE "kni"
126 #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)
127 #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
128 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
130 #endif /* _RTE_KNI_COMMON_H_ */