4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _VMXNET3_ETHDEV_H_
35 #define _VMXNET3_ETHDEV_H_
37 #ifdef RTE_LIBRTE_VMXNET3_DEBUG_DRIVER
38 #define VMXNET3_ASSERT(x) do { \
39 if (!(x)) rte_panic("VMXNET3: x"); \
43 #define VMXNET3_MAX_MAC_ADDRS 1
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
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
58 #define VMXNET3_RSS_HASH_FUNC_NONE 0x0
59 #define VMXNET3_RSS_HASH_FUNC_TOEPLITZ 0x01
61 #define VMXNET3_RSS_MAX_KEY_SIZE 40
62 #define VMXNET3_RSS_MAX_IND_TABLE_SIZE 128
64 #define VMXNET3_RSS_OFFLOAD_ALL ( \
66 ETH_RSS_NONFRAG_IPV4_TCP | \
68 ETH_RSS_NONFRAG_IPV6_TCP)
70 /* RSS configuration structure - shared with device through GPA */
72 struct VMXNET3_RSSConf {
76 uint16_t indTableSize;
77 uint8_t hashKey[VMXNET3_RSS_MAX_KEY_SIZE];
79 * indTable is only element that can be changed without
80 * device quiesce-reset-update-activation cycle
82 uint8_t indTable[VMXNET3_RSS_MAX_IND_TABLE_SIZE];
86 struct vmxnet3_mf_table {
87 void *mfTableBase; /* Multicast addresses list */
88 uint64_t mfTablePA; /* Physical address of the list */
89 uint16_t num_addrs; /* number of multicast addrs */
94 uint8_t *hw_addr0; /* BAR0: PT-Passthrough Regs */
95 uint8_t *hw_addr1; /* BAR1: VD-Virtual Device Regs */
96 /* BAR2: MSI-X Regs */
102 uint16_t subsystem_device_id;
103 uint16_t subsystem_vendor_id;
104 bool adapter_stopped;
106 uint8_t perm_addr[ETHER_ADDR_LEN];
107 uint8_t num_tx_queues;
108 uint8_t num_rx_queues;
109 uint8_t bufs_per_pkt;
112 Vmxnet3_TxQueueDesc *tqd_start; /* start address of all tx queue desc */
113 Vmxnet3_RxQueueDesc *rqd_start; /* start address of all rx queue desc */
115 Vmxnet3_DriverShared *shared;
118 uint64_t queueDescPA;
119 uint16_t queue_desc_len;
121 VMXNET3_RSSConf *rss_conf;
123 vmxnet3_mf_table_t *mf_table;
126 #define VMXNET3_GET_ADDR_LO(reg) ((uint32_t)(reg))
127 #define VMXNET3_GET_ADDR_HI(reg) ((uint32_t)(((uint64_t)(reg)) >> 32))
129 /* Config space read/writes */
131 #define VMXNET3_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
133 static inline uint32_t vmxnet3_read_addr(volatile void *addr)
135 return VMXNET3_PCI_REG(addr);
138 #define VMXNET3_PCI_REG_WRITE(reg, value) do { \
139 VMXNET3_PCI_REG((reg)) = (value); \
142 #define VMXNET3_PCI_BAR0_REG_ADDR(hw, reg) \
143 ((volatile uint32_t *)((char *)(hw)->hw_addr0 + (reg)))
144 #define VMXNET3_READ_BAR0_REG(hw, reg) \
145 vmxnet3_read_addr(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)))
146 #define VMXNET3_WRITE_BAR0_REG(hw, reg, value) \
147 VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR0_REG_ADDR((hw), (reg)), (value))
149 #define VMXNET3_PCI_BAR1_REG_ADDR(hw, reg) \
150 ((volatile uint32_t *)((char *)(hw)->hw_addr1 + (reg)))
151 #define VMXNET3_READ_BAR1_REG(hw, reg) \
152 vmxnet3_read_addr(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)))
153 #define VMXNET3_WRITE_BAR1_REG(hw, reg, value) \
154 VMXNET3_PCI_REG_WRITE(VMXNET3_PCI_BAR1_REG_ADDR((hw), (reg)), (value))
157 * RX/TX function prototypes
160 void vmxnet3_dev_clear_queues(struct rte_eth_dev *dev);
162 void vmxnet3_dev_rx_queue_release(void *rxq);
163 void vmxnet3_dev_tx_queue_release(void *txq);
165 int vmxnet3_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
166 uint16_t nb_rx_desc, unsigned int socket_id,
167 const struct rte_eth_rxconf *rx_conf,
168 struct rte_mempool *mb_pool);
169 int vmxnet3_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
170 uint16_t nb_tx_desc, unsigned int socket_id,
171 const struct rte_eth_txconf *tx_conf);
173 int vmxnet3_dev_rxtx_init(struct rte_eth_dev *dev);
175 int vmxnet3_rss_configure(struct rte_eth_dev *dev);
176 int vmxnet3_vlan_configure(struct rte_eth_dev *dev);
178 uint16_t vmxnet3_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
180 uint16_t vmxnet3_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
183 #endif /* _VMXNET3_ETHDEV_H_ */