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 /* structure for interrupt relative data */
  56 struct e1000_interrupt {
  57         uint32_t flags;
  58         uint32_t mask;
  59 };
  60
  61 /* local vfta copy */
  62 struct e1000_vfta {
  63         uint32_t vfta[IGB_VFTA_SIZE];
  64 };
  65
  66 /*
  67  * VF data which used by PF host only
  68  */
  69 #define E1000_MAX_VF_MC_ENTRIES         30
  70 struct e1000_vf_info {
  71         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
  72         uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
  73         uint16_t num_vf_mc_hashes;
  74         uint16_t default_vf_vlan_id;
  75         uint16_t vlans_enabled;
  76         uint16_t pf_qos;
  77         uint16_t vlan_count;
  78         uint16_t tx_rate;
  79 };
  80
  81 /*
  82  * Structure to store private data for each driver instance (for each port).
  83  */
  84 struct e1000_adapter {
  85         struct e1000_hw         hw;
  86         struct e1000_hw_stats   stats;
  87         struct e1000_interrupt  intr;
  88         struct e1000_vfta       shadow_vfta;
  89         struct e1000_vf_info    *vfdata;
  90 };
  91
  92 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
  93         (&((struct e1000_adapter *)adapter)->hw)
  94
  95 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
  96         (&((struct e1000_adapter *)adapter)->stats)
  97
  98 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
  99         (&((struct e1000_adapter *)adapter)->intr)
 100
 101 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
 102         (&((struct e1000_adapter *)adapter)->shadow_vfta)
 103
 104 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 105         (&((struct e1000_adapter *)adapter)->vfdata)
 106
 107 /*
 108  * RX/TX IGB function prototypes
 109  */
 110 void eth_igb_tx_queue_release(void *txq);
 111 void eth_igb_rx_queue_release(void *rxq);
 112 void igb_dev_clear_queues(struct rte_eth_dev *dev);
 113
 114 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 115                 uint16_t nb_rx_desc, unsigned int socket_id,
 116                 const struct rte_eth_rxconf *rx_conf,
 117                 struct rte_mempool *mb_pool);
 118
 119 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
 120                 uint16_t rx_queue_id);
 121
 122 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
 123
 124 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 125                 uint16_t nb_tx_desc, unsigned int socket_id,
 126                 const struct rte_eth_txconf *tx_conf);
 127
 128 int eth_igb_rx_init(struct rte_eth_dev *dev);
 129
 130 void eth_igb_tx_init(struct rte_eth_dev *dev);
 131
 132 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
 133                 uint16_t nb_pkts);
 134
 135 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
 136                 uint16_t nb_pkts);
 137
 138 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
 139                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 140
 141 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
 142
 143 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
 144
 145 /*
 146  * misc function prototypes
 147  */
 148 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
 149
 150 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
 151
 152 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
 153
 154 /*
 155  * RX/TX EM function prototypes
 156  */
 157 void eth_em_tx_queue_release(void *txq);
 158 void eth_em_rx_queue_release(void *rxq);
 159
 160 void em_dev_clear_queues(struct rte_eth_dev *dev);
 161
 162 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 163                 uint16_t nb_rx_desc, unsigned int socket_id,
 164                 const struct rte_eth_rxconf *rx_conf,
 165                 struct rte_mempool *mb_pool);
 166
 167 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
 168                 uint16_t rx_queue_id);
 169
 170 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
 171
 172 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 173                 uint16_t nb_tx_desc, unsigned int socket_id,
 174                 const struct rte_eth_txconf *tx_conf);
 175
 176 int eth_em_rx_init(struct rte_eth_dev *dev);
 177
 178 void eth_em_tx_init(struct rte_eth_dev *dev);
 179
 180 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 181                 uint16_t nb_pkts);
 182
 183 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 184                 uint16_t nb_pkts);
 185
 186 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 187                 uint16_t nb_pkts);
 188
 189 #endif /* _E1000_ETHDEV_H_ */