ethdev: add vlan offload support
[dpdk.git] / lib / librte_ether / rte_ethdev.h
index afcd240..55a4e42 100644 (file)
@@ -240,7 +240,18 @@ struct rte_eth_thresh {
  */
 enum rte_eth_rx_mq_mode {
        ETH_RSS     = 0,     /**< Default to RSS mode */
-       ETH_VMDQ_DCB         /**< Use VMDQ+DCB to route traffic to queues */
+       ETH_VMDQ_DCB,        /**< Use VMDQ+DCB to route traffic to queues */
+       ETH_DCB_RX           /**< For RX side,only DCB is on. */
+};
+
+/**
+ * A set of values to identify what method is to be used to transmit 
+ * packets using multi-TCs.
+ */
+enum rte_eth_tx_mq_mode {
+       ETH_DCB_NONE    = 0,    /**< It is not in DCB mode. */
+       ETH_VMDQ_DCB_TX,        /**< For TX side,both DCB and VT is on. */
+       ETH_DCB_TX              /**< For TX side,only DCB is on. */
 };
 
 /**
@@ -254,6 +265,8 @@ struct rte_eth_rxmode {
        uint8_t header_split : 1, /**< Header Split enable. */
                hw_ip_checksum   : 1, /**< IP/UDP/TCP checksum offload enable. */
                hw_vlan_filter   : 1, /**< VLAN filter enable. */
+               hw_vlan_strip    : 1, /**< VLAN strip enable. */
+               hw_vlan_extend   : 1, /**< Extended VLAN enable. */
                jumbo_frame      : 1, /**< Jumbo Frame Receipt enable. */
                hw_strip_crc     : 1; /**< Enable CRC stripping by hardware. */
 };
@@ -290,6 +303,30 @@ struct rte_eth_rss_conf {
 #define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
+#define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
+
+/* DCB capability defines */
+#define ETH_DCB_PG_SUPPORT      0x00000001 /**< Priority Group(ETS) support. */
+#define ETH_DCB_PFC_SUPPORT     0x00000002 /**< Priority Flow Control support. */ 
+
+/* Definitions used for VLAN Offload functionality */
+#define ETH_VLAN_STRIP_OFFLOAD   0x0001 /**< VLAN Strip  On/Off */
+#define ETH_VLAN_FILTER_OFFLOAD  0x0002 /**< VLAN Filter On/Off */
+#define ETH_VLAN_EXTEND_OFFLOAD  0x0004 /**< VLAN Extend On/Off */
+
+/* Definitions used for mask VLAN setting */
+#define ETH_VLAN_STRIP_MASK   0x0001 /**< VLAN Strip  setting mask */
+#define ETH_VLAN_FILTER_MASK  0x0002 /**< VLAN Filter  setting mask*/
+#define ETH_VLAN_EXTEND_MASK  0x0004 /**< VLAN Extend  setting mask*/
+
+/**
+ * This enum indicates the possible number of traffic classes
+ * in DCB configratioins
+ */
+enum rte_eth_nb_tcs {
+       ETH_4_TCS = 4, /**< 4 TCs with DCB. */
+       ETH_8_TCS = 8  /**< 8 TCs with DCB. */
+};
 
 /**
  * This enum indicates the possible number of queue pools
@@ -300,6 +337,25 @@ enum rte_eth_nb_pools {
        ETH_32_POOLS = 32  /**< 32 pools with DCB. */
 };
 
+/* This structure may be extended in future. */
+struct rte_eth_dcb_rx_conf {
+       enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
+       uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
+       /**< Possible DCB queue,4 or 8. */
+};
+struct rte_eth_vmdq_dcb_tx_conf {
+       enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
+       uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
+       /**< Possible DCB queue,4 or 8. */
+};
+struct rte_eth_dcb_tx_conf {
+       enum rte_eth_nb_tcs nb_tcs; /**< possible DCB TCs, 4 or 8 TCs. */
+       uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
+       /**< Possible DCB queue,4 or 8. */
+};
+
 /**
  * A structure used to configure the VMDQ+DCB feature
  * of an Ethernet port.
@@ -326,9 +382,9 @@ struct rte_eth_vmdq_dcb_conf {
 
 /**
  * A structure used to configure the TX features of an Ethernet port.
- * For future extensions.
  */
 struct rte_eth_txmode {
+       enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
 };
 
 /**
@@ -337,8 +393,19 @@ struct rte_eth_txmode {
 struct rte_eth_rxconf {
        struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
        uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
+       uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
 };
 
+#define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
+#define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
+#define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
+#define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
+#define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
+#define ETH_TXQ_FLAGS_NOXSUMUDP  0x0400 /**< disable UDP checksum offload */
+#define ETH_TXQ_FLAGS_NOXSUMTCP  0x0800 /**< disable TCP checksum offload */
+#define ETH_TXQ_FLAGS_NOOFFLOADS \
+               (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
+                ETH_TXQ_FLAGS_NOXSUMUDP  | ETH_TXQ_FLAGS_NOXSUMTCP)
 /**
  * A structure used to configure a TX ring of an Ethernet port.
  */
@@ -346,6 +413,7 @@ struct rte_eth_txconf {
        struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
        uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
        uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
+       uint32_t txq_flags; /**< Set flags for the Tx queue */
 };
 
 /**
@@ -538,7 +606,18 @@ struct rte_eth_conf {
                struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
                struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
                /**< Port vmdq+dcb configuration. */
+               struct rte_eth_dcb_rx_conf dcb_rx_conf;
+               /**< Port dcb RX configuration. */
        } rx_adv_conf; /**< Port RX filtering configuration (union). */
+       union {
+               struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
+               /**< Port vmdq+dcb TX configuration. */
+               struct rte_eth_dcb_tx_conf dcb_tx_conf;
+               /**< Port dcb TX configuration. */
+       } tx_adv_conf; /**< Port TX DCB configuration (union). */
+       /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC 
+           is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */ 
+       uint32_t dcb_capability_en; 
        struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
        struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
 };
@@ -559,8 +638,6 @@ struct rte_eth_dev_info {
 };
 
 struct rte_eth_dev;
-struct igb_rx_queue;
-struct igb_tx_queue;
 
 struct rte_eth_dev_callback;
 /** @internal Structure to keep track of registered callbacks */
@@ -572,8 +649,7 @@ TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
  * structure associated with an Ethernet device.
  */
 
-typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev, uint16_t nb_rx_q,
-                                   uint16_t nb_tx_q);
+typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
 /**< @internal Ethernet device configuration. */
 
 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
@@ -633,17 +709,32 @@ typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
                                    const struct rte_eth_txconf *tx_conf);
 /**< @internal Setup a transmit queue of an Ethernet device. */
 
-typedef void (*vlan_filter_set_t)(struct rte_eth_dev *dev,
+typedef void (*eth_queue_release_t)(void *queue);
+/**< @internal Release memory resources allocated by given RX/TX queue. */
+
+typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
                                  uint16_t vlan_id,
                                  int on);
 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 
-typedef uint16_t (*eth_rx_burst_t)(struct igb_rx_queue *rxq,
+typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
+                                 uint16_t tpid);
+/**< @internal set the outer VLAN-TPID by an Ethernet device. */
+
+typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
+/**< @internal set VLAN offload function by an Ethernet device. */
+
+typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
+                                 uint16_t rx_queue_id,
+                                 int on);
+/**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
+
+typedef uint16_t (*eth_rx_burst_t)(void *rxq,
                                   struct rte_mbuf **rx_pkts,
                                   uint16_t nb_pkts);
 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
 
-typedef uint16_t (*eth_tx_burst_t)(struct igb_tx_queue *txq,
+typedef uint16_t (*eth_tx_burst_t)(void *txq,
                                   struct rte_mbuf **tx_pkts,
                                   uint16_t nb_pkts);
 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
@@ -725,8 +816,13 @@ struct eth_dev_ops {
        /**< Configure per queue stat counter mapping. */
        eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
        vlan_filter_set_t          vlan_filter_set;  /**< Filter VLAN Setup. */
+       vlan_tpid_set_t            vlan_tpid_set;      /**< Outer VLAN TPID Setup. */
+       vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
+       vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
        eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue.*/
+       eth_queue_release_t        rx_queue_release;/**< Release RX queue.*/
        eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue.*/
+       eth_queue_release_t        tx_queue_release;/**< Release TX queue.*/
        eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
        eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
        flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
@@ -779,8 +875,8 @@ struct rte_eth_dev {
  * processes in a multi-process configuration.
  */
 struct rte_eth_dev_data {
-       struct igb_rx_queue **rx_queues; /**< Array of pointers to RX queues. */
-       struct igb_tx_queue **tx_queues; /**< Array of pointers to TX queues. */
+       void **rx_queues; /**< Array of pointers to RX queues. */
+       void **tx_queues; /**< Array of pointers to TX queues. */
        uint16_t nb_rx_queues; /**< Number of RX queues. */
        uint16_t nb_tx_queues; /**< Number of TX queues. */
 
@@ -1092,6 +1188,9 @@ extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
  *     The *tx_rs_thresh* value should be less or equal then
  *     *tx_free_thresh* value, and both of them should be less then
  *     *nb_tx_desc* - 3.
+ *   - The *txq_flags* member contains flags to pass to the TX queue setup
+ *     function to configure the behavior of the TX queue. This should be set
+ *     to 0 if no special configuration is required.
  *
  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
  *     the transmit function to use default values.
@@ -1328,7 +1427,81 @@ extern void rte_eth_dev_info_get(uint8_t port_id,
  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
  *   - (-EINVAL) if *vlan_id* > 4095.
  */
-extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
+extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
+
+/**
+ * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
+ * 82599/X540 can support VLAN stripping at the rx queue level
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param rx_queue_id
+ *   The index of the receive queue for which a queue stats mapping is required.
+ *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
+ *   to rte_eth_dev_configure().
+ * @param on
+ *   If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
+ *   If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if *rx_queue_id* invalid.
+ */
+extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
+               uint16_t rx_queue_id, int on);
+
+/**
+ * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
+ * the VLAN Header. This is a register setup available on some Intel NIC, not
+ * but all, please check the data sheet for availability.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param tag_type
+ *   The Tag Protocol ID
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
+ *   - (-ENODEV) if *port_id* invalid.
+ */
+extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
+
+/**
+ * Set VLAN offload configuration on an Ethernet device
+ * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
+ * available on some Intel NIC, not but all, please check the data sheet for
+ * availability.
+ * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
+ * the configuration is applied on the port level.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param offload_mask
+ *   The VLAN Offload bit mask can be mixed use with "OR"
+ *       ETH_VLAN_STRIP_OFFLOAD
+ *       ETH_VLAN_FILTER_OFFLOAD
+ *       ETH_VLAN_EXTEND_OFFLOAD
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
+ *   - (-ENODEV) if *port_id* invalid.
+ */
+extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
+
+/**
+ * Read VLAN Offload configuration from an Ethernet device
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @return
+ *   - (>0) if successful. Bit mask to indicate
+ *       ETH_VLAN_STRIP_OFFLOAD
+ *       ETH_VLAN_FILTER_OFFLOAD
+ *       ETH_VLAN_EXTEND_OFFLOAD
+ *   - (-ENODEV) if *port_id* invalid.
+ */
+extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
 
 /**
  *