2 * This file is provided under a dual BSD/LGPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
5 * GNU LESSER GENERAL PUBLIC LICENSE
7 * Copyright(c) 2007-2014 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2.1 of the GNU Lesser General Public License
11 * as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
22 * Contact Information:
28 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
35 * * Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * * Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in
39 * the documentation and/or other materials provided with the
41 * * Neither the name of Intel Corporation nor the names of its
42 * contributors may be used to endorse or promote products derived
43 * from this software without specific prior written permission.
45 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
46 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
48 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
49 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
50 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
51 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
52 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
53 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
54 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
55 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59 #ifndef _RTE_KNI_COMMON_H_
60 #define _RTE_KNI_COMMON_H_
67 * KNI name is part of memzone name.
69 #define RTE_KNI_NAMESIZE 32
71 #ifndef RTE_CACHE_LINE_SIZE
72 #define RTE_CACHE_LINE_SIZE 64 /**< Cache line size. */
79 RTE_KNI_REQ_UNKNOWN = 0,
80 RTE_KNI_REQ_CHANGE_MTU,
81 RTE_KNI_REQ_CFG_NETWORK_IF,
86 * Structure for KNI request.
88 struct rte_kni_request {
89 uint32_t req_id; /**< Request id */
91 uint32_t new_mtu; /**< New MTU */
92 uint8_t if_up; /**< 1: interface up, 0: interface down */
94 int32_t result; /**< Result for processing request */
95 } __attribute__((__packed__));
98 * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
99 * Write and read should wrap around. Fifo is empty when write == read
100 * Writing should never overwrite the read position
102 struct rte_kni_fifo {
103 volatile unsigned write; /**< Next position to be written*/
104 volatile unsigned read; /**< Next position to be read */
105 unsigned len; /**< Circular buffer length */
106 unsigned elem_size; /**< Pointer size - for 32/64 bit OS */
107 void * volatile buffer[0]; /**< The buffer contains mbuf pointers */
111 * The kernel image of the rte_mbuf struct, with only the relevant fields.
112 * Padding is necessary to assure the offsets of these fields
114 struct rte_kni_mbuf {
115 void *buf_addr __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
117 uint16_t data_off; /**< Start address of data in segment buffer. */
119 uint64_t ol_flags; /**< Offload features. */
122 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
123 uint16_t data_len; /**< Amount of data in segment buffer. */
126 uint16_t data_len; /**< Amount of data in segment buffer. */
127 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
130 /* fields on second cache line */
131 char pad3[8] __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
137 * Struct used to create a KNI device. Passed to the kernel in IOCTL call
140 struct rte_kni_device_info {
141 char name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */
145 phys_addr_t alloc_phys;
146 phys_addr_t free_phys;
148 /* Used by Ethtool */
149 phys_addr_t req_phys;
150 phys_addr_t resp_phys;
151 phys_addr_t sync_phys;
156 phys_addr_t mbuf_phys;
159 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
160 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
161 uint8_t bus; /**< Device bus */
162 uint8_t devid; /**< Device ID */
163 uint8_t function; /**< Device function. */
165 uint16_t group_id; /**< Group ID */
166 uint32_t core_id; /**< core ID to bind for kernel thread */
168 uint8_t force_bind : 1; /**< Flag for kernel thread binding */
174 #define KNI_DEVICE "kni"
176 #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)
177 #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
178 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
180 #endif /* _RTE_KNI_COMMON_H_ */