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_FLEX_FILTERS           8
  82 #define E1000_MAX_FHFT                   4
  83 #define E1000_MAX_FHFT_EXT               4
  84 #define E1000_FHFT_SIZE_IN_DWD           64
  85 #define E1000_MAX_FLEX_FILTER_PRI        7
  86 #define E1000_MAX_FLEX_FILTER_LEN        128
  87 #define E1000_MAX_FLEX_FILTER_DWDS \
  88         (E1000_MAX_FLEX_FILTER_LEN / sizeof(uint32_t))
  89 #define E1000_FLEX_FILTERS_MASK_SIZE \
  90         (E1000_MAX_FLEX_FILTER_DWDS / 4)
  91 #define E1000_FHFT_QUEUEING_LEN          0x0000007F
  92 #define E1000_FHFT_QUEUEING_QUEUE        0x00000700
  93 #define E1000_FHFT_QUEUEING_PRIO         0x00070000
  94 #define E1000_FHFT_QUEUEING_OFFSET       0xFC
  95 #define E1000_FHFT_QUEUEING_QUEUE_SHIFT  8
  96 #define E1000_FHFT_QUEUEING_PRIO_SHIFT   16
  97 #define E1000_WUFC_FLEX_HQ               0x00004000
  98
  99 #define E1000_SPQF_SRCPORT               0x0000FFFF
 100
 101 #define E1000_MAX_FTQF_FILTERS           8
 102 #define E1000_FTQF_PROTOCOL_MASK         0x000000FF
 103 #define E1000_FTQF_5TUPLE_MASK_SHIFT     28
 104 #define E1000_FTQF_PROTOCOL_COMP_MASK    0x10000000
 105 #define E1000_FTQF_SOURCE_ADDR_MASK      0x20000000
 106 #define E1000_FTQF_DEST_ADDR_MASK        0x40000000
 107 #define E1000_FTQF_SOURCE_PORT_MASK      0x80000000
 108 #define E1000_FTQF_VF_MASK_EN            0x00008000
 109 #define E1000_FTQF_QUEUE_MASK            0x03ff0000
 110 #define E1000_FTQF_QUEUE_SHIFT           16
 111 #define E1000_FTQF_QUEUE_ENABLE          0x00000100
 112
 113 /* structure for interrupt relative data */
 114 struct e1000_interrupt {
 115         uint32_t flags;
 116         uint32_t mask;
 117 };
 118
 119 /* local vfta copy */
 120 struct e1000_vfta {
 121         uint32_t vfta[IGB_VFTA_SIZE];
 122 };
 123
 124 /*
 125  * VF data which used by PF host only
 126  */
 127 #define E1000_MAX_VF_MC_ENTRIES         30
 128 struct e1000_vf_info {
 129         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 130         uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
 131         uint16_t num_vf_mc_hashes;
 132         uint16_t default_vf_vlan_id;
 133         uint16_t vlans_enabled;
 134         uint16_t pf_qos;
 135         uint16_t vlan_count;
 136         uint16_t tx_rate;
 137 };
 138
 139 TAILQ_HEAD(e1000_flex_filter_list, e1000_flex_filter);
 140
 141 struct e1000_flex_filter_info {
 142         uint16_t len;
 143         uint32_t dwords[E1000_MAX_FLEX_FILTER_DWDS]; /* flex bytes in dword. */
 144         /* if mask bit is 1b, do not compare corresponding byte in dwords. */
 145         uint8_t mask[E1000_FLEX_FILTERS_MASK_SIZE];
 146         uint8_t priority;
 147 };
 148
 149 /* Flex filter structure */
 150 struct e1000_flex_filter {
 151         TAILQ_ENTRY(e1000_flex_filter) entries;
 152         uint16_t index; /* index of flex filter */
 153         struct e1000_flex_filter_info filter_info;
 154         uint16_t queue; /* rx queue assigned to */
 155 };
 156
 157 /*
 158  * Structure to store filters' info.
 159  */
 160 struct e1000_filter_info {
 161         uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
 162         /* store used ethertype filters*/
 163         uint16_t ethertype_filters[E1000_MAX_ETQF_FILTERS];
 164         uint8_t flex_mask;      /* Bit mask for every used flex filter */
 165         struct e1000_flex_filter_list flex_list;
 166 };
 167
 168 /*
 169  * Structure to store private data for each driver instance (for each port).
 170  */
 171 struct e1000_adapter {
 172         struct e1000_hw         hw;
 173         struct e1000_hw_stats   stats;
 174         struct e1000_interrupt  intr;
 175         struct e1000_vfta       shadow_vfta;
 176         struct e1000_vf_info    *vfdata;
 177         struct e1000_filter_info filter;
 178 };
 179
 180 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
 181         (&((struct e1000_adapter *)adapter)->hw)
 182
 183 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
 184         (&((struct e1000_adapter *)adapter)->stats)
 185
 186 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
 187         (&((struct e1000_adapter *)adapter)->intr)
 188
 189 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
 190         (&((struct e1000_adapter *)adapter)->shadow_vfta)
 191
 192 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 193         (&((struct e1000_adapter *)adapter)->vfdata)
 194
 195 #define E1000_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
 196         (&((struct e1000_adapter *)adapter)->filter)
 197
 198 /*
 199  * RX/TX IGB function prototypes
 200  */
 201 void eth_igb_tx_queue_release(void *txq);
 202 void eth_igb_rx_queue_release(void *rxq);
 203 void igb_dev_clear_queues(struct rte_eth_dev *dev);
 204
 205 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 206                 uint16_t nb_rx_desc, unsigned int socket_id,
 207                 const struct rte_eth_rxconf *rx_conf,
 208                 struct rte_mempool *mb_pool);
 209
 210 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
 211                 uint16_t rx_queue_id);
 212
 213 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
 214
 215 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 216                 uint16_t nb_tx_desc, unsigned int socket_id,
 217                 const struct rte_eth_txconf *tx_conf);
 218
 219 int eth_igb_rx_init(struct rte_eth_dev *dev);
 220
 221 void eth_igb_tx_init(struct rte_eth_dev *dev);
 222
 223 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
 224                 uint16_t nb_pkts);
 225
 226 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
 227                 uint16_t nb_pkts);
 228
 229 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
 230                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 231
 232 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
 233                             struct rte_eth_rss_conf *rss_conf);
 234
 235 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
 236                               struct rte_eth_rss_conf *rss_conf);
 237
 238 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
 239
 240 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
 241
 242 /*
 243  * misc function prototypes
 244  */
 245 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
 246
 247 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
 248
 249 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
 250
 251 /*
 252  * RX/TX EM function prototypes
 253  */
 254 void eth_em_tx_queue_release(void *txq);
 255 void eth_em_rx_queue_release(void *rxq);
 256
 257 void em_dev_clear_queues(struct rte_eth_dev *dev);
 258
 259 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 260                 uint16_t nb_rx_desc, unsigned int socket_id,
 261                 const struct rte_eth_rxconf *rx_conf,
 262                 struct rte_mempool *mb_pool);
 263
 264 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
 265                 uint16_t rx_queue_id);
 266
 267 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
 268
 269 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 270                 uint16_t nb_tx_desc, unsigned int socket_id,
 271                 const struct rte_eth_txconf *tx_conf);
 272
 273 int eth_em_rx_init(struct rte_eth_dev *dev);
 274
 275 void eth_em_tx_init(struct rte_eth_dev *dev);
 276
 277 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 278                 uint16_t nb_pkts);
 279
 280 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 281                 uint16_t nb_pkts);
 282
 283 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 284                 uint16_t nb_pkts);
 285
 286 #endif /* _E1000_ETHDEV_H_ */