lib/librte_pmd_e1000/e1000_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 #ifndef _E1000_ETHDEV_H_
  36 #define _E1000_ETHDEV_H_
  37
  38 /* need update link, bit flag */
  39 #define E1000_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
  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 };
  59
  60 /* local vfta copy */
  61 struct e1000_vfta {
  62         uint32_t vfta[IGB_VFTA_SIZE];
  63 };
  64
  65 /*
  66  * Structure to store private data for each driver instance (for each port).
  67  */
  68 struct e1000_adapter {
  69         struct e1000_hw         hw;
  70         struct e1000_hw_stats   stats;
  71         struct e1000_interrupt  intr;
  72         struct e1000_vfta       shadow_vfta;
  73 };
  74
  75 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
  76         (&((struct e1000_adapter *)adapter)->hw)
  77
  78 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
  79         (&((struct e1000_adapter *)adapter)->stats)
  80
  81 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
  82         (&((struct e1000_adapter *)adapter)->intr)
  83
  84 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
  85         (&((struct e1000_adapter *)adapter)->shadow_vfta)
  86
  87 /*
  88  * RX/TX IGB function prototypes
  89  */
  90 void eth_igb_tx_queue_release(void *txq);
  91 void eth_igb_rx_queue_release(void *rxq);
  92 void igb_dev_clear_queues(struct rte_eth_dev *dev);
  93
  94 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
  95                 uint16_t nb_rx_desc, unsigned int socket_id,
  96                 const struct rte_eth_rxconf *rx_conf,
  97                 struct rte_mempool *mb_pool);
  98
  99 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 100                 uint16_t nb_tx_desc, unsigned int socket_id,
 101                 const struct rte_eth_txconf *tx_conf);
 102
 103 int eth_igb_rx_init(struct rte_eth_dev *dev);
 104
 105 void eth_igb_tx_init(struct rte_eth_dev *dev);
 106
 107 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
 108                 uint16_t nb_pkts);
 109
 110 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
 111                 uint16_t nb_pkts);
 112
 113 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
 114                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 115
 116 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
 117
 118 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
 119
 120 /*
 121  * RX/TX EM function prototypes
 122  */
 123 void eth_em_tx_queue_release(void *txq);
 124 void eth_em_rx_queue_release(void *rxq);
 125
 126 void em_dev_clear_queues(struct rte_eth_dev *dev);
 127
 128 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 129                 uint16_t nb_rx_desc, unsigned int socket_id,
 130                 const struct rte_eth_rxconf *rx_conf,
 131                 struct rte_mempool *mb_pool);
 132
 133 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 134                 uint16_t nb_tx_desc, unsigned int socket_id,
 135                 const struct rte_eth_txconf *tx_conf);
 136
 137 int eth_em_rx_init(struct rte_eth_dev *dev);
 138
 139 void eth_em_tx_init(struct rte_eth_dev *dev);
 140
 141 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 142                 uint16_t nb_pkts);
 143
 144 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 145                 uint16_t nb_pkts);
 146
 147 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 148                 uint16_t nb_pkts);
 149
 150
 151 #endif /* _E1000_ETHDEV_H_ */