lib/librte_eal/linuxapp/eal/include/exec-env/rte_kni_common.h

   1 /*-
   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.
   4  *
   5  *   GNU LESSER GENERAL PUBLIC LICENSE
   6  *
   7  *   Copyright(c) 2007-2013 Intel Corporation. All rights reserved.
   8  *
   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.
  12  *
  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.
  17  *
  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.
  21  *
  22  *   Contact Information:
  23  *   Intel Corporation
  24  *
  25  *
  26  *   BSD LICENSE
  27  *
  28  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
  29  *   All rights reserved.
  30  *
  31  *   Redistribution and use in source and binary forms, with or without
  32  *   modification, are permitted provided that the following conditions
  33  *   are met:
  34  *
  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
  40  *     distribution.
  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.
  44  *
  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.
  56  *
  57  */
  58
  59 #ifndef _RTE_KNI_COMMON_H_
  60 #define _RTE_KNI_COMMON_H_
  61
  62 #ifdef __KERNEL__
  63 #include <linux/if.h>
  64 #endif
  65
  66 /*
  67  * Request id.
  68  */
  69 enum rte_kni_req_id {
  70         RTE_KNI_REQ_UNKNOWN = 0,
  71         RTE_KNI_REQ_CHANGE_MTU,
  72         RTE_KNI_REQ_CFG_NETWORK_IF,
  73         RTE_KNI_REQ_MAX,
  74 };
  75
  76 /*
  77  * Structure for KNI request.
  78  */
  79 struct rte_kni_request {
  80         uint32_t req_id;             /**< Request id */
  81         union {
  82                 uint32_t new_mtu;    /**< New MTU */
  83                 uint8_t if_up;       /**< 1: interface up, 0: interface down */
  84         };
  85         int32_t result;               /**< Result for processing request */
  86 } __attribute__((__packed__));
  87
  88 /*
  89  * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
  90  * Write and read should wrap arround. Fifo is empty when write == read
  91  * Writing should never overwrite the read position
  92  */
  93 struct rte_kni_fifo {
  94         volatile unsigned write;     /**< Next position to be written*/
  95         volatile unsigned read;      /**< Next position to be read */
  96         unsigned len;                /**< Circular buffer length */
  97         unsigned elem_size;          /**< Pointer size - for 32/64 bit OS */
  98         void * volatile buffer[0];   /**< The buffer contains mbuf pointers */
  99 };
 100
 101 /*
 102  * The kernel image of the rte_mbuf struct, with only the relevant fields.
 103  * Padding is necessary to assure the offsets of these fields
 104  */
 105 struct rte_kni_mbuf {
 106         void *pool;
 107         void *buf_addr;
 108         char pad0[14];
 109         uint16_t ol_flags;      /**< Offload features. */
 110         void *next;
 111         void *data;             /**< Start address of data in segment buffer. */
 112         uint16_t data_len;      /**< Amount of data in segment buffer. */
 113         char pad2[2];
 114         uint16_t pkt_len;       /**< Total pkt len: sum of all segment data_len. */
 115 } __attribute__((__aligned__(64)));
 116
 117 /*
 118  * Struct used to create a KNI device. Passed to the kernel in IOCTL call
 119  */
 120
 121 struct rte_kni_device_info
 122 {
 123         char name[IFNAMSIZ];
 124
 125         phys_addr_t tx_phys;
 126         phys_addr_t rx_phys;
 127         phys_addr_t alloc_phys;
 128         phys_addr_t free_phys;
 129
 130         /* Used by Ethtool */
 131         phys_addr_t req_phys;
 132         phys_addr_t resp_phys;
 133         phys_addr_t sync_phys;
 134         void * sync_va;
 135
 136         /* mbuf mempool */
 137         void * mbuf_va;
 138         phys_addr_t mbuf_phys;
 139
 140         /* PCI info */
 141         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
 142         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
 143         uint8_t bus;                  /**< Device bus */
 144         uint8_t devid;                /**< Device ID */
 145         uint8_t function;             /**< Device function. */
 146         uint8_t port_id;              /**< Port ID */
 147
 148         /* mbuf size */
 149         unsigned mbuf_size;
 150 };
 151
 152 #define KNI_DEVICE "kni"
 153
 154 #define RTE_KNI_IOCTL_TEST    _IOWR(0, 1, int)
 155 #define RTE_KNI_IOCTL_CREATE  _IOWR(0, 2, struct rte_kni_device_info)
 156 #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, uint8_t)
 157
 158 #endif /* _RTE_KNI_COMMON_H_ */