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
75 RTE_KNI_REQ_UNKNOWN = 0,
76 RTE_KNI_REQ_CHANGE_MTU,
77 RTE_KNI_REQ_CFG_NETWORK_IF,
82 * Structure for KNI request.
84 struct rte_kni_request {
85 uint32_t req_id; /**< Request id */
87 uint32_t new_mtu; /**< New MTU */
88 uint8_t if_up; /**< 1: interface up, 0: interface down */
90 int32_t result; /**< Result for processing request */
91 } __attribute__((__packed__));
94 * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
95 * Write and read should wrap around. Fifo is empty when write == read
96 * Writing should never overwrite the read position
99 volatile unsigned write; /**< Next position to be written*/
100 volatile unsigned read; /**< Next position to be read */
101 unsigned len; /**< Circular buffer length */
102 unsigned elem_size; /**< Pointer size - for 32/64 bit OS */
103 void * volatile buffer[0]; /**< The buffer contains mbuf pointers */
107 * The kernel image of the rte_mbuf struct, with only the relevant fields.
108 * Padding is necessary to assure the offsets of these fields
110 struct rte_kni_mbuf {
111 void *buf_addr __attribute__((__aligned__(64)));
113 uint16_t data_off; /**< Start address of data in segment buffer. */
115 uint64_t ol_flags; /**< Offload features. */
117 uint16_t data_len; /**< Amount of data in segment buffer. */
118 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
120 /* fields on second cache line */
121 char pad3[8] __attribute__((__aligned__(64)));
127 * Struct used to create a KNI device. Passed to the kernel in IOCTL call
130 struct rte_kni_device_info {
131 char name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */
135 phys_addr_t alloc_phys;
136 phys_addr_t free_phys;
138 /* Used by Ethtool */
139 phys_addr_t req_phys;
140 phys_addr_t resp_phys;
141 phys_addr_t sync_phys;
146 phys_addr_t mbuf_phys;
149 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
150 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
151 uint8_t bus; /**< Device bus */
152 uint8_t devid; /**< Device ID */
153 uint8_t function; /**< Device function. */
155 uint16_t group_id; /**< Group ID */
156 uint32_t core_id; /**< core ID to bind for kernel thread */
158 uint8_t force_bind : 1; /**< Flag for kernel thread binding */
164 #define KNI_DEVICE "kni"
166 #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)
167 #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
168 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
170 #endif /* _RTE_KNI_COMMON_H_ */