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>
17 * KNI name is part of memzone name.
19 #define RTE_KNI_NAMESIZE 32
21 #define RTE_CACHE_LINE_MIN_SIZE 64
27 RTE_KNI_REQ_UNKNOWN = 0,
28 RTE_KNI_REQ_CHANGE_MTU,
29 RTE_KNI_REQ_CFG_NETWORK_IF,
34 * Structure for KNI request.
36 struct rte_kni_request {
37 uint32_t req_id; /**< Request id */
40 uint32_t new_mtu; /**< New MTU */
41 uint8_t if_up; /**< 1: interface up, 0: interface down */
43 int32_t result; /**< Result for processing request */
44 } __attribute__((__packed__));
47 * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
48 * Write and read should wrap around. Fifo is empty when write == read
49 * Writing should never overwrite the read position
52 volatile unsigned write; /**< Next position to be written*/
53 volatile unsigned read; /**< Next position to be read */
54 unsigned len; /**< Circular buffer length */
55 unsigned elem_size; /**< Pointer size - for 32/64 bit OS */
56 void *volatile buffer[]; /**< The buffer contains mbuf pointers */
60 * The kernel image of the rte_mbuf struct, with only the relevant fields.
61 * Padding is necessary to assure the offsets of these fields
64 void *buf_addr __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
65 uint64_t buf_physaddr;
66 uint16_t data_off; /**< Start address of data in segment buffer. */
68 uint16_t nb_segs; /**< Number of segments. */
70 uint64_t ol_flags; /**< Offload features. */
72 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
73 uint16_t data_len; /**< Amount of data in segment buffer. */
75 /* fields on second cache line */
76 char pad3[8] __attribute__((__aligned__(RTE_CACHE_LINE_MIN_SIZE)));
82 * Struct used to create a KNI device. Passed to the kernel in IOCTL call
85 struct rte_kni_device_info {
86 char name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */
90 phys_addr_t alloc_phys;
91 phys_addr_t free_phys;
95 phys_addr_t resp_phys;
96 phys_addr_t sync_phys;
101 phys_addr_t mbuf_phys;
104 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
105 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
106 uint8_t bus; /**< Device bus */
107 uint8_t devid; /**< Device ID */
108 uint8_t function; /**< Device function. */
110 uint16_t group_id; /**< Group ID */
111 uint32_t core_id; /**< core ID to bind for kernel thread */
114 uint8_t force_bind : 1; /**< Flag for kernel thread binding */
120 #define KNI_DEVICE "kni"
122 #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)
123 #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
124 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
126 #endif /* _RTE_KNI_COMMON_H_ */