lib/librte_pmd_e1000/e1000_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 _E1000_ETHDEV_H_
  35 #define _E1000_ETHDEV_H_
  36
  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)
  40
  41 /*
  42  * Defines that were not part of e1000_hw.h as they are not used by the FreeBSD
  43  * driver.
  44  */
  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
  54
  55 #define IGB_MAX_RX_QUEUE_NUM           8
  56 #define IGB_MAX_RX_QUEUE_NUM_82576     16
  57
  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 */
  62
  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
  67
  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
  80
  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
  93
  94 #define E1000_SPQF_SRCPORT               0x0000FFFF
  95
  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
 107
 108 /* structure for interrupt relative data */
 109 struct e1000_interrupt {
 110         uint32_t flags;
 111         uint32_t mask;
 112 };
 113
 114 /* local vfta copy */
 115 struct e1000_vfta {
 116         uint32_t vfta[IGB_VFTA_SIZE];
 117 };
 118
 119 /*
 120  * VF data which used by PF host only
 121  */
 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;
 129         uint16_t pf_qos;
 130         uint16_t vlan_count;
 131         uint16_t tx_rate;
 132 };
 133
 134 /*
 135  * Structure to store private data for each driver instance (for each port).
 136  */
 137 struct e1000_adapter {
 138         struct e1000_hw         hw;
 139         struct e1000_hw_stats   stats;
 140         struct e1000_interrupt  intr;
 141         struct e1000_vfta       shadow_vfta;
 142         struct e1000_vf_info    *vfdata;
 143 };
 144
 145 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
 146         (&((struct e1000_adapter *)adapter)->hw)
 147
 148 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
 149         (&((struct e1000_adapter *)adapter)->stats)
 150
 151 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
 152         (&((struct e1000_adapter *)adapter)->intr)
 153
 154 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
 155         (&((struct e1000_adapter *)adapter)->shadow_vfta)
 156
 157 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 158         (&((struct e1000_adapter *)adapter)->vfdata)
 159
 160 /*
 161  * RX/TX IGB function prototypes
 162  */
 163 void eth_igb_tx_queue_release(void *txq);
 164 void eth_igb_rx_queue_release(void *rxq);
 165 void igb_dev_clear_queues(struct rte_eth_dev *dev);
 166
 167 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 168                 uint16_t nb_rx_desc, unsigned int socket_id,
 169                 const struct rte_eth_rxconf *rx_conf,
 170                 struct rte_mempool *mb_pool);
 171
 172 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
 173                 uint16_t rx_queue_id);
 174
 175 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
 176
 177 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 178                 uint16_t nb_tx_desc, unsigned int socket_id,
 179                 const struct rte_eth_txconf *tx_conf);
 180
 181 int eth_igb_rx_init(struct rte_eth_dev *dev);
 182
 183 void eth_igb_tx_init(struct rte_eth_dev *dev);
 184
 185 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
 186                 uint16_t nb_pkts);
 187
 188 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
 189                 uint16_t nb_pkts);
 190
 191 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
 192                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 193
 194 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
 195                             struct rte_eth_rss_conf *rss_conf);
 196
 197 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
 198                               struct rte_eth_rss_conf *rss_conf);
 199
 200 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
 201
 202 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
 203
 204 /*
 205  * misc function prototypes
 206  */
 207 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
 208
 209 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
 210
 211 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
 212
 213 /*
 214  * RX/TX EM function prototypes
 215  */
 216 void eth_em_tx_queue_release(void *txq);
 217 void eth_em_rx_queue_release(void *rxq);
 218
 219 void em_dev_clear_queues(struct rte_eth_dev *dev);
 220
 221 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 222                 uint16_t nb_rx_desc, unsigned int socket_id,
 223                 const struct rte_eth_rxconf *rx_conf,
 224                 struct rte_mempool *mb_pool);
 225
 226 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
 227                 uint16_t rx_queue_id);
 228
 229 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
 230
 231 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 232                 uint16_t nb_tx_desc, unsigned int socket_id,
 233                 const struct rte_eth_txconf *tx_conf);
 234
 235 int eth_em_rx_init(struct rte_eth_dev *dev);
 236
 237 void eth_em_tx_init(struct rte_eth_dev *dev);
 238
 239 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 240                 uint16_t nb_pkts);
 241
 242 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 243                 uint16_t nb_pkts);
 244
 245 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 246                 uint16_t nb_pkts);
 247
 248 #endif /* _E1000_ETHDEV_H_ */