drivers/net/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: %s\n", #x); \
  40 } while(0)
  41 #else
  42 #define VMXNET3_ASSERT(x) do { (void)(x); } while (0)
  43 #endif
  44
  45 #define VMXNET3_MAX_MAC_ADDRS 1
  46
  47 /* UPT feature to negotiate */
  48 #define VMXNET3_F_RXCSUM      0x0001
  49 #define VMXNET3_F_RSS         0x0002
  50 #define VMXNET3_F_RXVLAN      0x0004
  51 #define VMXNET3_F_LRO         0x0008
  52
  53 /* Hash Types supported by device */
  54 #define VMXNET3_RSS_HASH_TYPE_NONE      0x0
  55 #define VMXNET3_RSS_HASH_TYPE_IPV4      0x01
  56 #define VMXNET3_RSS_HASH_TYPE_TCP_IPV4  0x02
  57 #define VMXNET3_RSS_HASH_TYPE_IPV6      0x04
  58 #define VMXNET3_RSS_HASH_TYPE_TCP_IPV6  0x08
  59
  60 #define VMXNET3_RSS_HASH_FUNC_NONE      0x0
  61 #define VMXNET3_RSS_HASH_FUNC_TOEPLITZ  0x01
  62
  63 #define VMXNET3_RSS_MAX_KEY_SIZE        40
  64 #define VMXNET3_RSS_MAX_IND_TABLE_SIZE  128
  65
  66 #define VMXNET3_RSS_OFFLOAD_ALL ( \
  67         ETH_RSS_IPV4 | \
  68         ETH_RSS_NONFRAG_IPV4_TCP | \
  69         ETH_RSS_IPV6 | \
  70         ETH_RSS_NONFRAG_IPV6_TCP)
  71
  72 /* RSS configuration structure - shared with device through GPA */
  73 typedef
  74 struct VMXNET3_RSSConf {
  75         uint16_t   hashType;
  76         uint16_t   hashFunc;
  77         uint16_t   hashKeySize;
  78         uint16_t   indTableSize;
  79         uint8_t    hashKey[VMXNET3_RSS_MAX_KEY_SIZE];
  80         /*
  81          * indTable is only element that can be changed without
  82          * device quiesce-reset-update-activation cycle
  83          */
  84         uint8_t    indTable[VMXNET3_RSS_MAX_IND_TABLE_SIZE];
  85 } VMXNET3_RSSConf;
  86
  87 typedef
  88 struct vmxnet3_mf_table {
  89         void          *mfTableBase; /* Multicast addresses list */
  90         uint64_t      mfTablePA;    /* Physical address of the list */
  91         uint16_t      num_addrs;    /* number of multicast addrs */
  92 } vmxnet3_mf_table_t;
  93
  94 struct vmxnet3_hw {
  95
  96         uint8_t *hw_addr0;      /* BAR0: PT-Passthrough Regs    */
  97         uint8_t *hw_addr1;      /* BAR1: VD-Virtual Device Regs */
  98         /* BAR2: MSI-X Regs */
  99         /* BAR3: Port IO    */
 100         void *back;
 101
 102         uint16_t device_id;
 103         uint16_t vendor_id;
 104         uint16_t subsystem_device_id;
 105         uint16_t subsystem_vendor_id;
 106         bool adapter_stopped;
 107
 108         uint8_t perm_addr[ETHER_ADDR_LEN];
 109         uint8_t num_tx_queues;
 110         uint8_t num_rx_queues;
 111         uint8_t bufs_per_pkt;
 112
 113         Vmxnet3_TxQueueDesc   *tqd_start;       /* start address of all tx queue desc */
 114         Vmxnet3_RxQueueDesc   *rqd_start;       /* start address of all rx queue desc */
 115
 116         Vmxnet3_DriverShared  *shared;
 117         uint64_t              sharedPA;
 118
 119         uint64_t              queueDescPA;
 120         uint16_t              queue_desc_len;
 121
 122         VMXNET3_RSSConf          *rss_conf;
 123         uint64_t                         rss_confPA;
 124         vmxnet3_mf_table_t   *mf_table;
 125         uint32_t              shadow_vfta[VMXNET3_VFT_SIZE];
 126 #define VMXNET3_VFT_TABLE_SIZE     (VMXNET3_VFT_SIZE * sizeof(uint32_t))
 127 };
 128
 129 #define VMXNET3_GET_ADDR_LO(reg)   ((uint32_t)(reg))
 130 #define VMXNET3_GET_ADDR_HI(reg)   ((uint32_t)(((uint64_t)(reg)) >> 32))
 131
 132 /* Config space read/writes */
 133
 134 #define VMXNET3_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 135
 136 static inline uint32_t vmxnet3_read_addr(volatile void *addr)
 137 {
 138         return VMXNET3_PCI_REG(addr);
 139 }
 140
 141 #define VMXNET3_PCI_REG_WRITE(reg, value) do { \
 142         VMXNET3_PCI_REG((reg)) = (value); \
 143 } while(0)
 144
 145 #define VMXNET3_PCI_BAR0_REG_ADDR(hw, reg) \
 146         ((volatile uint32_t *)((char *)(hw)->hw_addr0 + (reg)))
 147 #define VMXNET3_READ_BAR0_REG(hw, reg) \
 148         vmxnet3_read_addr(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)))
 149 #define VMXNET3_WRITE_BAR0_REG(hw, reg, value) \
 150         VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)), (value))
 151
 152 #define VMXNET3_PCI_BAR1_REG_ADDR(hw, reg) \
 153         ((volatile uint32_t *)((char *)(hw)->hw_addr1 + (reg)))
 154 #define VMXNET3_READ_BAR1_REG(hw, reg) \
 155         vmxnet3_read_addr(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)))
 156 #define VMXNET3_WRITE_BAR1_REG(hw, reg, value) \
 157         VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)), (value))
 158
 159 /*
 160  * RX/TX function prototypes
 161  */
 162
 163 void vmxnet3_dev_clear_queues(struct rte_eth_dev *dev);
 164
 165 void vmxnet3_dev_rx_queue_release(void *rxq);
 166 void vmxnet3_dev_tx_queue_release(void *txq);
 167
 168 int  vmxnet3_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 169                 uint16_t nb_rx_desc, unsigned int socket_id,
 170                 const struct rte_eth_rxconf *rx_conf,
 171                 struct rte_mempool *mb_pool);
 172 int  vmxnet3_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 173                 uint16_t nb_tx_desc, unsigned int socket_id,
 174                 const struct rte_eth_txconf *tx_conf);
 175
 176 int vmxnet3_dev_rxtx_init(struct rte_eth_dev *dev);
 177
 178 int vmxnet3_rss_configure(struct rte_eth_dev *dev);
 179
 180 uint16_t vmxnet3_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 181                 uint16_t nb_pkts);
 182 uint16_t vmxnet3_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 183                 uint16_t nb_pkts);
 184
 185 #endif /* _VMXNET3_ETHDEV_H_ */