New upstream version 18.11-rc1

[deb_dpdk.git] / lib / librte_ethdev / rte_ethdev_core.h

diff --git a/lib/librte_ethdev/rte_ethdev_core.h b/lib/librte_ethdev/rte_ethdev_core.h
index 33d12b3..8f03f83 100644 (file)
--- a/lib/librte_ethdev/rte_ethdev_core.h
+++ b/lib/librte_ethdev/rte_ethdev_core.h
@@ -539,7 +539,13 @@ struct rte_eth_dev {
        eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
        eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
        eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
-       struct rte_eth_dev_data *data;  /**< Pointer to device data */
+       /**
+        * Next two fields are per-device data but *data is shared between
+        * primary and secondary processes and *process_private is per-process
+        * private. The second one is managed by PMDs if necessary.
+        */
+       struct rte_eth_dev_data *data;  /**< Pointer to device data. */
+       void *process_private; /**< Pointer to per-process device data. */
        const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
        struct rte_device *device; /**< Backing device */
        struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
@@ -579,24 +585,30 @@ struct rte_eth_dev_data {
 
        struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
-       void *dev_private;              /**< PMD-specific private data */
-
-       struct rte_eth_link dev_link;
-       /**< Link-level information & status */
+       void *dev_private;
+                       /**< PMD-specific private data.
+                        *   @see rte_eth_dev_release_port()
+                        */
 
+       struct rte_eth_link dev_link;   /**< Link-level information & status. */
        struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
        uint16_t mtu;                   /**< Maximum Transmission Unit. */
-
        uint32_t min_rx_buf_size;
-       /**< Common rx buffer size handled by all queues */
+                       /**< Common RX buffer size handled by all queues. */
 
        uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
-       struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
+       struct ether_addr *mac_addrs;
+                       /**< Device Ethernet link address.
+                        *   @see rte_eth_dev_release_port()
+                        */
        uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
-       /** bitmap array of associating Ethernet MAC addresses to pools */
-       struct ether_addr* hash_mac_addrs;
-       /** Device Ethernet MAC addresses of hash filtering. */
+                       /**< Bitmap associating MAC addresses to pools. */
+       struct ether_addr *hash_mac_addrs;
+                       /**< Device Ethernet MAC addresses of hash filtering.
+                        *   @see rte_eth_dev_release_port()
+                        */
        uint16_t port_id;           /**< Device [external] port identifier. */
+
        __extension__
        uint8_t promiscuous   : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
                scattered_rx : 1,  /**< RX of scattered packets is ON(1) / OFF(0) */
@@ -604,15 +616,19 @@ struct rte_eth_dev_data {
                dev_started : 1,   /**< Device state: STARTED(1) / STOPPED(0). */
                lro         : 1;   /**< RX LRO is ON(1) / OFF(0) */
        uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-       /** Queues state: STARTED(1) / STOPPED(0) */
+                       /**< Queues state: STARTED(1) / STOPPED(0). */
        uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-       /** Queues state: STARTED(1) / STOPPED(0) */
-       uint32_t dev_flags; /**< Capabilities */
-       enum rte_kernel_driver kdrv;    /**< Kernel driver passthrough */
-       int numa_node;  /**< NUMA node connection */
+                       /**< Queues state: STARTED(1) / STOPPED(0). */
+       uint32_t dev_flags;             /**< Capabilities. */
+       enum rte_kernel_driver kdrv;    /**< Kernel driver passthrough. */
+       int numa_node;                  /**< NUMA node connection. */
        struct rte_vlan_filter_conf vlan_filter_conf;
-       /**< VLAN filter configuration. */
+                       /**< VLAN filter configuration. */
        struct rte_eth_dev_owner owner; /**< The port owner. */
+       uint16_t representor_id;
+                       /**< Switch-specific identifier.
+                        *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+                        */
 } __rte_cache_aligned;
 
 /**