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 _E1000_ETHDEV_H_
35 #define _E1000_ETHDEV_H_
37 /* need update link, bit flag */
38 #define E1000_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
39 #define E1000_FLAG_MAILBOX (uint32_t)(1 << 1)
42 * Defines that were not part of e1000_hw.h as they are not used by the FreeBSD
45 #define E1000_ADVTXD_POPTS_TXSM 0x00000200 /* L4 Checksum offload request */
46 #define E1000_ADVTXD_POPTS_IXSM 0x00000100 /* IP Checksum offload request */
47 #define E1000_ADVTXD_TUCMD_L4T_RSV 0x00001800 /* L4 Packet TYPE of Reserved */
48 #define E1000_RXD_STAT_TMST 0x10000 /* Timestamped Packet indication */
49 #define E1000_RXD_ERR_CKSUM_BIT 29
50 #define E1000_RXD_ERR_CKSUM_MSK 3
51 #define E1000_ADVTXD_MACLEN_SHIFT 9 /* Bit shift for l2_len */
52 #define E1000_CTRL_EXT_EXTEND_VLAN (1<<26) /* EXTENDED VLAN */
53 #define IGB_VFTA_SIZE 128
55 #define IGB_MAX_RX_QUEUE_NUM 8
56 #define IGB_MAX_RX_QUEUE_NUM_82576 16
58 #define E1000_SYN_FILTER_ENABLE 0x00000001 /* syn filter enable field */
59 #define E1000_SYN_FILTER_QUEUE 0x0000000E /* syn filter queue field */
60 #define E1000_SYN_FILTER_QUEUE_SHIFT 1 /* syn filter queue field */
61 #define E1000_RFCTL_SYNQFP 0x00080000 /* SYNQFP in RFCTL register */
63 #define E1000_ETQF_ETHERTYPE 0x0000FFFF
64 #define E1000_ETQF_QUEUE 0x00070000
65 #define E1000_ETQF_QUEUE_SHIFT 16
66 #define E1000_MAX_ETQF_FILTERS 8
68 #define E1000_IMIR_DSTPORT 0x0000FFFF
69 #define E1000_IMIR_PRIORITY 0xE0000000
70 #define E1000_IMIR_EXT_SIZE_BP 0x00001000
71 #define E1000_IMIR_EXT_CTRL_UGR 0x00002000
72 #define E1000_IMIR_EXT_CTRL_ACK 0x00004000
73 #define E1000_IMIR_EXT_CTRL_PSH 0x00008000
74 #define E1000_IMIR_EXT_CTRL_RST 0x00010000
75 #define E1000_IMIR_EXT_CTRL_SYN 0x00020000
76 #define E1000_IMIR_EXT_CTRL_FIN 0x00040000
77 #define E1000_IMIR_EXT_CTRL_BP 0x00080000
78 #define E1000_MAX_TTQF_FILTERS 8
79 #define E1000_2TUPLE_MAX_PRI 7
81 #define E1000_MAX_FLEXIBLE_FILTERS 8
82 #define E1000_MAX_FHFT 4
83 #define E1000_MAX_FHFT_EXT 4
84 #define E1000_MAX_FLEX_FILTER_PRI 7
85 #define E1000_MAX_FLEX_FILTER_LEN 128
86 #define E1000_FHFT_QUEUEING_LEN 0x0000007F
87 #define E1000_FHFT_QUEUEING_QUEUE 0x00000700
88 #define E1000_FHFT_QUEUEING_PRIO 0x00070000
89 #define E1000_FHFT_QUEUEING_OFFSET 0xFC
90 #define E1000_FHFT_QUEUEING_QUEUE_SHIFT 8
91 #define E1000_FHFT_QUEUEING_PRIO_SHIFT 16
92 #define E1000_WUFC_FLEX_HQ 0x00004000
94 #define E1000_SPQF_SRCPORT 0x0000FFFF
96 #define E1000_MAX_FTQF_FILTERS 8
97 #define E1000_FTQF_PROTOCOL_MASK 0x000000FF
98 #define E1000_FTQF_5TUPLE_MASK_SHIFT 28
99 #define E1000_FTQF_PROTOCOL_COMP_MASK 0x10000000
100 #define E1000_FTQF_SOURCE_ADDR_MASK 0x20000000
101 #define E1000_FTQF_DEST_ADDR_MASK 0x40000000
102 #define E1000_FTQF_SOURCE_PORT_MASK 0x80000000
103 #define E1000_FTQF_VF_MASK_EN 0x00008000
104 #define E1000_FTQF_QUEUE_MASK 0x03ff0000
105 #define E1000_FTQF_QUEUE_SHIFT 16
106 #define E1000_FTQF_QUEUE_ENABLE 0x00000100
108 /* structure for interrupt relative data */
109 struct e1000_interrupt {
114 /* local vfta copy */
116 uint32_t vfta[IGB_VFTA_SIZE];
120 * VF data which used by PF host only
122 #define E1000_MAX_VF_MC_ENTRIES 30
123 struct e1000_vf_info {
124 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
125 uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
126 uint16_t num_vf_mc_hashes;
127 uint16_t default_vf_vlan_id;
128 uint16_t vlans_enabled;
135 * Structure to store filters' info.
137 struct e1000_filter_info {
138 uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
139 /* store used ethertype filters*/
140 uint16_t ethertype_filters[E1000_MAX_ETQF_FILTERS];
144 * Structure to store private data for each driver instance (for each port).
146 struct e1000_adapter {
148 struct e1000_hw_stats stats;
149 struct e1000_interrupt intr;
150 struct e1000_vfta shadow_vfta;
151 struct e1000_vf_info *vfdata;
152 struct e1000_filter_info filter;
155 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
156 (&((struct e1000_adapter *)adapter)->hw)
158 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
159 (&((struct e1000_adapter *)adapter)->stats)
161 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
162 (&((struct e1000_adapter *)adapter)->intr)
164 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
165 (&((struct e1000_adapter *)adapter)->shadow_vfta)
167 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
168 (&((struct e1000_adapter *)adapter)->vfdata)
170 #define E1000_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
171 (&((struct e1000_adapter *)adapter)->filter)
174 * RX/TX IGB function prototypes
176 void eth_igb_tx_queue_release(void *txq);
177 void eth_igb_rx_queue_release(void *rxq);
178 void igb_dev_clear_queues(struct rte_eth_dev *dev);
180 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
181 uint16_t nb_rx_desc, unsigned int socket_id,
182 const struct rte_eth_rxconf *rx_conf,
183 struct rte_mempool *mb_pool);
185 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
186 uint16_t rx_queue_id);
188 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
190 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
191 uint16_t nb_tx_desc, unsigned int socket_id,
192 const struct rte_eth_txconf *tx_conf);
194 int eth_igb_rx_init(struct rte_eth_dev *dev);
196 void eth_igb_tx_init(struct rte_eth_dev *dev);
198 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
201 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
204 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
205 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
207 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
208 struct rte_eth_rss_conf *rss_conf);
210 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
211 struct rte_eth_rss_conf *rss_conf);
213 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
215 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
218 * misc function prototypes
220 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
222 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
224 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
227 * RX/TX EM function prototypes
229 void eth_em_tx_queue_release(void *txq);
230 void eth_em_rx_queue_release(void *rxq);
232 void em_dev_clear_queues(struct rte_eth_dev *dev);
234 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
235 uint16_t nb_rx_desc, unsigned int socket_id,
236 const struct rte_eth_rxconf *rx_conf,
237 struct rte_mempool *mb_pool);
239 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
240 uint16_t rx_queue_id);
242 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
244 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
245 uint16_t nb_tx_desc, unsigned int socket_id,
246 const struct rte_eth_txconf *tx_conf);
248 int eth_em_rx_init(struct rte_eth_dev *dev);
250 void eth_em_tx_init(struct rte_eth_dev *dev);
252 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
255 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
258 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
261 #endif /* _E1000_ETHDEV_H_ */