lib/librte_pmd_vmxnet3/vmxnet3_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _VMXNET3_ETHDEV_H_
  35 #define _VMXNET3_ETHDEV_H_
  36
  37 #ifdef RTE_LIBRTE_VMXNET3_DEBUG_DRIVER
  38 #define VMXNET3_ASSERT(x) do { \
  39         if(!(x)) rte_panic("VMXNET3: x"); \
  40 } while(0)
  41 #endif
  42
  43 #define VMXNET3_MAX_MAC_ADDRS 1
  44
  45 /* UPT feature to negotiate */
  46 #define VMXNET3_F_RXCSUM      0x0001
  47 #define VMXNET3_F_RSS         0x0002
  48 #define VMXNET3_F_RXVLAN      0x0004
  49 #define VMXNET3_F_LRO         0x0008
  50
  51 /* Hash Types supported by device */
  52 #define VMXNET3_RSS_HASH_TYPE_NONE      0x0
  53 #define VMXNET3_RSS_HASH_TYPE_IPV4      0x01
  54 #define VMXNET3_RSS_HASH_TYPE_TCP_IPV4  0x02
  55 #define VMXNET3_RSS_HASH_TYPE_IPV6      0x04
  56 #define VMXNET3_RSS_HASH_TYPE_TCP_IPV6  0x08
  57
  58 #define VMXNET3_RSS_HASH_FUNC_NONE      0x0
  59 #define VMXNET3_RSS_HASH_FUNC_TOEPLITZ  0x01
  60
  61 #define VMXNET3_RSS_MAX_KEY_SIZE        40
  62 #define VMXNET3_RSS_MAX_IND_TABLE_SIZE  128
  63
  64 /* RSS configuration structure - shared with device through GPA */
  65 typedef
  66 struct VMXNET3_RSSConf {
  67    uint16_t   hashType;
  68    uint16_t   hashFunc;
  69    uint16_t   hashKeySize;
  70    uint16_t   indTableSize;
  71    uint8_t    hashKey[VMXNET3_RSS_MAX_KEY_SIZE];
  72    /*
  73     * indTable is only element that can be changed without
  74     * device quiesce-reset-update-activation cycle
  75     */
  76    uint8_t    indTable[VMXNET3_RSS_MAX_IND_TABLE_SIZE];
  77 } VMXNET3_RSSConf;
  78
  79 typedef
  80 struct vmxnet3_mf_table {
  81         void          *mfTableBase; /* Multicast addresses list */
  82         uint64_t      mfTablePA;    /* Physical address of the list */
  83         uint16_t      num_addrs;    /* number of multicast addrs */
  84 } vmxnet3_mf_table_t;
  85
  86 struct vmxnet3_hw {
  87
  88         uint8_t *hw_addr0;      /* BAR0: PT-Passthrough Regs    */
  89         uint8_t *hw_addr1;      /* BAR1: VD-Virtual Device Regs */
  90         /* BAR2: MSI-X Regs */
  91         /* BAR3: Port IO    */
  92         void *back;
  93
  94         uint16_t device_id;
  95         uint16_t vendor_id;
  96         uint16_t subsystem_device_id;
  97         uint16_t subsystem_vendor_id;
  98         bool adapter_stopped;
  99
 100         uint8_t perm_addr[ETHER_ADDR_LEN];
 101         uint8_t num_tx_queues;
 102         uint8_t num_rx_queues;
 103         uint8_t bufs_per_pkt;
 104         uint16_t cur_mtu;
 105
 106         Vmxnet3_TxQueueDesc   *tqd_start;       /* start address of all tx queue desc */
 107         Vmxnet3_RxQueueDesc   *rqd_start;       /* start address of all rx queue desc */
 108
 109         Vmxnet3_DriverShared  *shared;
 110         uint64_t              sharedPA;
 111
 112         uint64_t              queueDescPA;
 113         uint16_t              queue_desc_len;
 114
 115         VMXNET3_RSSConf          *rss_conf;
 116         uint64_t                         rss_confPA;
 117         vmxnet3_mf_table_t   *mf_table;
 118 };
 119
 120 /*
 121  * Structure to store private data for each driver instance (for each port).
 122  */
 123 struct vmxnet3_adapter {
 124         struct vmxnet3_hw              hw;
 125 };
 126
 127 #define VMXNET3_DEV_PRIVATE_TO_HW(adapter)\
 128         (&((struct vmxnet3_adapter *)adapter)->hw)
 129
 130 #define VMXNET3_GET_ADDR_LO(reg)   ((uint32_t)(reg))
 131 #define VMXNET3_GET_ADDR_HI(reg)   ((uint32_t)(((uint64_t)(reg)) >> 32))
 132
 133 /* Config space read/writes */
 134
 135 #define VMXNET3_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 136
 137 static inline uint32_t vmxnet3_read_addr(volatile void* addr)
 138 {
 139         return VMXNET3_PCI_REG(addr);
 140 }
 141
 142 #define VMXNET3_PCI_REG_WRITE(reg, value) do { \
 143         VMXNET3_PCI_REG((reg)) = (value); \
 144 } while(0)
 145
 146 #define VMXNET3_PCI_BAR0_REG_ADDR(hw, reg) \
 147         ((volatile uint32_t *)((char *)(hw)->hw_addr0 + (reg)))
 148 #define VMXNET3_READ_BAR0_REG(hw, reg) \
 149         vmxnet3_read_addr(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)))
 150 #define VMXNET3_WRITE_BAR0_REG(hw, reg, value) \
 151         VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)), (value))
 152
 153 #define VMXNET3_PCI_BAR1_REG_ADDR(hw, reg) \
 154         ((volatile uint32_t *)((char *)(hw)->hw_addr1 + (reg)))
 155 #define VMXNET3_READ_BAR1_REG(hw, reg) \
 156         vmxnet3_read_addr(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)))
 157 #define VMXNET3_WRITE_BAR1_REG(hw, reg, value) \
 158         VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)), (value))
 159
 160 /*
 161  * RX/TX function prototypes
 162  */
 163
 164 void vmxnet3_dev_clear_queues(struct rte_eth_dev *dev);
 165
 166 void vmxnet3_dev_rx_queue_release(void *rxq);
 167 void vmxnet3_dev_tx_queue_release(void *txq);
 168
 169 int  vmxnet3_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 170                 uint16_t nb_rx_desc, unsigned int socket_id,
 171                 const struct rte_eth_rxconf *rx_conf,
 172                 struct rte_mempool *mb_pool);
 173 int  vmxnet3_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 174                 uint16_t nb_tx_desc, unsigned int socket_id,
 175                 const struct rte_eth_txconf *tx_conf);
 176
 177 int vmxnet3_dev_rxtx_init(struct rte_eth_dev *dev);
 178
 179 int vmxnet3_rss_configure(struct rte_eth_dev *dev);
 180 int vmxnet3_vlan_configure(struct rte_eth_dev *dev);
 181
 182 uint16_t vmxnet3_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 183                 uint16_t nb_pkts);
 184 uint16_t vmxnet3_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 185                 uint16_t nb_pkts);
 186
 187 #endif /* _VMXNET3_ETHDEV_H_ */