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_MAX_TTQF_FILTERS         8
  71 #define E1000_2TUPLE_MAX_PRI           7
  72
  73 #define E1000_MAX_FLEX_FILTERS           8
  74 #define E1000_MAX_FHFT                   4
  75 #define E1000_MAX_FHFT_EXT               4
  76 #define E1000_FHFT_SIZE_IN_DWD           64
  77 #define E1000_MAX_FLEX_FILTER_PRI        7
  78 #define E1000_MAX_FLEX_FILTER_LEN        128
  79 #define E1000_MAX_FLEX_FILTER_DWDS \
  80         (E1000_MAX_FLEX_FILTER_LEN / sizeof(uint32_t))
  81 #define E1000_FLEX_FILTERS_MASK_SIZE \
  82         (E1000_MAX_FLEX_FILTER_DWDS / 4)
  83 #define E1000_FHFT_QUEUEING_LEN          0x0000007F
  84 #define E1000_FHFT_QUEUEING_QUEUE        0x00000700
  85 #define E1000_FHFT_QUEUEING_PRIO         0x00070000
  86 #define E1000_FHFT_QUEUEING_OFFSET       0xFC
  87 #define E1000_FHFT_QUEUEING_QUEUE_SHIFT  8
  88 #define E1000_FHFT_QUEUEING_PRIO_SHIFT   16
  89 #define E1000_WUFC_FLEX_HQ               0x00004000
  90
  91 #define E1000_SPQF_SRCPORT               0x0000FFFF
  92
  93 #define E1000_MAX_FTQF_FILTERS           8
  94 #define E1000_FTQF_PROTOCOL_MASK         0x000000FF
  95 #define E1000_FTQF_5TUPLE_MASK_SHIFT     28
  96 #define E1000_FTQF_QUEUE_MASK            0x03ff0000
  97 #define E1000_FTQF_QUEUE_SHIFT           16
  98 #define E1000_FTQF_QUEUE_ENABLE          0x00000100
  99
 100 #define IGB_RSS_OFFLOAD_ALL ( \
 101         ETH_RSS_IPV4 | \
 102         ETH_RSS_NONFRAG_IPV4_TCP | \
 103         ETH_RSS_NONFRAG_IPV4_UDP | \
 104         ETH_RSS_IPV6 | \
 105         ETH_RSS_NONFRAG_IPV6_TCP | \
 106         ETH_RSS_NONFRAG_IPV6_UDP | \
 107         ETH_RSS_IPV6_EX | \
 108         ETH_RSS_IPV6_TCP_EX | \
 109         ETH_RSS_IPV6_UDP_EX)
 110
 111 /* structure for interrupt relative data */
 112 struct e1000_interrupt {
 113         uint32_t flags;
 114         uint32_t mask;
 115 };
 116
 117 /* local vfta copy */
 118 struct e1000_vfta {
 119         uint32_t vfta[IGB_VFTA_SIZE];
 120 };
 121
 122 /*
 123  * VF data which used by PF host only
 124  */
 125 #define E1000_MAX_VF_MC_ENTRIES         30
 126 struct e1000_vf_info {
 127         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 128         uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
 129         uint16_t num_vf_mc_hashes;
 130         uint16_t default_vf_vlan_id;
 131         uint16_t vlans_enabled;
 132         uint16_t pf_qos;
 133         uint16_t vlan_count;
 134         uint16_t tx_rate;
 135 };
 136
 137 TAILQ_HEAD(e1000_flex_filter_list, e1000_flex_filter);
 138
 139 struct e1000_flex_filter_info {
 140         uint16_t len;
 141         uint32_t dwords[E1000_MAX_FLEX_FILTER_DWDS]; /* flex bytes in dword. */
 142         /* if mask bit is 1b, do not compare corresponding byte in dwords. */
 143         uint8_t mask[E1000_FLEX_FILTERS_MASK_SIZE];
 144         uint8_t priority;
 145 };
 146
 147 /* Flex filter structure */
 148 struct e1000_flex_filter {
 149         TAILQ_ENTRY(e1000_flex_filter) entries;
 150         uint16_t index; /* index of flex filter */
 151         struct e1000_flex_filter_info filter_info;
 152         uint16_t queue; /* rx queue assigned to */
 153 };
 154
 155 TAILQ_HEAD(e1000_5tuple_filter_list, e1000_5tuple_filter);
 156 TAILQ_HEAD(e1000_2tuple_filter_list, e1000_2tuple_filter);
 157
 158 struct e1000_5tuple_filter_info {
 159         uint32_t dst_ip;
 160         uint32_t src_ip;
 161         uint16_t dst_port;
 162         uint16_t src_port;
 163         uint8_t proto;           /* l4 protocol. */
 164         /* the packet matched above 5tuple and contain any set bit will hit this filter. */
 165         uint8_t tcp_flags;
 166         uint8_t priority;        /* seven levels (001b-111b), 111b is highest,
 167                                       used when more than one filter matches. */
 168         uint8_t dst_ip_mask:1,   /* if mask is 1b, do not compare dst ip. */
 169                 src_ip_mask:1,   /* if mask is 1b, do not compare src ip. */
 170                 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
 171                 src_port_mask:1, /* if mask is 1b, do not compare src port. */
 172                 proto_mask:1;    /* if mask is 1b, do not compare protocol. */
 173 };
 174
 175 struct e1000_2tuple_filter_info {
 176         uint16_t dst_port;
 177         uint8_t proto;           /* l4 protocol. */
 178         /* the packet matched above 2tuple and contain any set bit will hit this filter. */
 179         uint8_t tcp_flags;
 180         uint8_t priority;        /* seven levels (001b-111b), 111b is highest,
 181                                       used when more than one filter matches. */
 182         uint8_t dst_ip_mask:1,   /* if mask is 1b, do not compare dst ip. */
 183                 src_ip_mask:1,   /* if mask is 1b, do not compare src ip. */
 184                 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
 185                 src_port_mask:1, /* if mask is 1b, do not compare src port. */
 186                 proto_mask:1;    /* if mask is 1b, do not compare protocol. */
 187 };
 188
 189 /* 5tuple filter structure */
 190 struct e1000_5tuple_filter {
 191         TAILQ_ENTRY(e1000_5tuple_filter) entries;
 192         uint16_t index;       /* the index of 5tuple filter */
 193         struct e1000_5tuple_filter_info filter_info;
 194         uint16_t queue;       /* rx queue assigned to */
 195 };
 196
 197 /* 2tuple filter structure */
 198 struct e1000_2tuple_filter {
 199         TAILQ_ENTRY(e1000_2tuple_filter) entries;
 200         uint16_t index;         /* the index of 2tuple filter */
 201         struct e1000_2tuple_filter_info filter_info;
 202         uint16_t queue;       /* rx queue assigned to */
 203 };
 204
 205 /*
 206  * Structure to store filters' info.
 207  */
 208 struct e1000_filter_info {
 209         uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
 210         /* store used ethertype filters*/
 211         uint16_t ethertype_filters[E1000_MAX_ETQF_FILTERS];
 212         uint8_t flex_mask;      /* Bit mask for every used flex filter */
 213         struct e1000_flex_filter_list flex_list;
 214         /* Bit mask for every used 5tuple filter */
 215         uint8_t fivetuple_mask;
 216         struct e1000_5tuple_filter_list fivetuple_list;
 217         /* Bit mask for every used 2tuple filter */
 218         uint8_t twotuple_mask;
 219         struct e1000_2tuple_filter_list twotuple_list;
 220 };
 221
 222 /*
 223  * Structure to store private data for each driver instance (for each port).
 224  */
 225 struct e1000_adapter {
 226         struct e1000_hw         hw;
 227         struct e1000_hw_stats   stats;
 228         struct e1000_interrupt  intr;
 229         struct e1000_vfta       shadow_vfta;
 230         struct e1000_vf_info    *vfdata;
 231         struct e1000_filter_info filter;
 232 };
 233
 234 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
 235         (&((struct e1000_adapter *)adapter)->hw)
 236
 237 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
 238         (&((struct e1000_adapter *)adapter)->stats)
 239
 240 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
 241         (&((struct e1000_adapter *)adapter)->intr)
 242
 243 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
 244         (&((struct e1000_adapter *)adapter)->shadow_vfta)
 245
 246 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 247         (&((struct e1000_adapter *)adapter)->vfdata)
 248
 249 #define E1000_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
 250         (&((struct e1000_adapter *)adapter)->filter)
 251
 252 /*
 253  * RX/TX IGB function prototypes
 254  */
 255 void eth_igb_tx_queue_release(void *txq);
 256 void eth_igb_rx_queue_release(void *rxq);
 257 void igb_dev_clear_queues(struct rte_eth_dev *dev);
 258
 259 int eth_igb_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_igb_rx_queue_count(struct rte_eth_dev *dev,
 265                 uint16_t rx_queue_id);
 266
 267 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
 268
 269 int eth_igb_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_igb_rx_init(struct rte_eth_dev *dev);
 274
 275 void eth_igb_tx_init(struct rte_eth_dev *dev);
 276
 277 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
 278                 uint16_t nb_pkts);
 279
 280 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
 281                 uint16_t nb_pkts);
 282
 283 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
 284                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 285
 286 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
 287                             struct rte_eth_rss_conf *rss_conf);
 288
 289 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
 290                               struct rte_eth_rss_conf *rss_conf);
 291
 292 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
 293
 294 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
 295
 296 /*
 297  * misc function prototypes
 298  */
 299 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
 300
 301 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
 302
 303 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
 304
 305 /*
 306  * RX/TX EM function prototypes
 307  */
 308 void eth_em_tx_queue_release(void *txq);
 309 void eth_em_rx_queue_release(void *rxq);
 310
 311 void em_dev_clear_queues(struct rte_eth_dev *dev);
 312
 313 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 314                 uint16_t nb_rx_desc, unsigned int socket_id,
 315                 const struct rte_eth_rxconf *rx_conf,
 316                 struct rte_mempool *mb_pool);
 317
 318 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
 319                 uint16_t rx_queue_id);
 320
 321 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
 322
 323 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 324                 uint16_t nb_tx_desc, unsigned int socket_id,
 325                 const struct rte_eth_txconf *tx_conf);
 326
 327 int eth_em_rx_init(struct rte_eth_dev *dev);
 328
 329 void eth_em_tx_init(struct rte_eth_dev *dev);
 330
 331 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 332                 uint16_t nb_pkts);
 333
 334 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 335                 uint16_t nb_pkts);
 336
 337 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 338                 uint16_t nb_pkts);
 339
 340 #endif /* _E1000_ETHDEV_H_ */