net/txgbe: add Rx and Tx start and stop
[dpdk.git] / lib / librte_ethdev / rte_tm.h
index c80c0bc..175417a 100644 (file)
@@ -251,6 +251,23 @@ struct rte_tm_capabilities {
         */
        uint64_t shaper_private_rate_max;
 
+       /** Shaper private packet mode supported. When non-zero, this parameter
+        * indicates that there is at least one node that can be configured
+        * with packet mode in its private shaper. When shaper is configured
+        * in packet mode, committed/peak rate provided is interpreted
+        * in packets per second.
+        */
+       int shaper_private_packet_mode_supported;
+
+       /** Shaper private byte mode supported. When non-zero, this parameter
+        * indicates that there is at least one node that can be configured
+        * with byte mode in its private shaper. When shaper is configured
+        * in byte mode, committed/peak rate provided is interpreted in
+        * bytes per second.
+        */
+       int shaper_private_byte_mode_supported;
+
+
        /** Maximum number of shared shapers. The value of zero indicates that
         * shared shapers are not supported.
         */
@@ -285,6 +302,21 @@ struct rte_tm_capabilities {
         */
        uint64_t shaper_shared_rate_max;
 
+       /** Shaper shared packet mode supported. When non-zero, this parameter
+        * indicates a shared shaper can be configured with packet mode.
+        * When shared shaper is configured in packet mode, committed/peak rate
+        * provided is interpreted in packets per second.
+        */
+       int shaper_shared_packet_mode_supported;
+
+       /** Shaper shared byte mode supported. When non-zero, this parameter
+        * indicates that a shared shaper can be configured with byte mode.
+        * When shared shaper is configured in byte mode, committed/peak rate
+        * provided is interpreted in bytes per second.
+        */
+       int shaper_shared_byte_mode_supported;
+
+
        /** Minimum value allowed for packet length adjustment for any private
         * or shared shaper.
         */
@@ -340,6 +372,22 @@ struct rte_tm_capabilities {
         */
        uint32_t sched_wfq_weight_max;
 
+       /** WFQ packet mode supported. When non-zero, this parameter indicates
+        * that there is at least one non-leaf node that supports packet mode
+        * for WFQ among its children. WFQ weights will be applied against
+        * packet count for scheduling children when a non-leaf node
+        * is configured appropriately.
+        */
+       int sched_wfq_packet_mode_supported;
+
+       /** WFQ byte mode supported. When non-zero, this parameter indicates
+        * that there is at least one non-leaf node that supports byte mode
+        * for WFQ among its children. WFQ weights will be applied against
+        * bytes for scheduling children when a non-leaf node is configured
+        * appropriately.
+        */
+       int sched_wfq_byte_mode_supported;
+
        /** WRED packet mode support. When non-zero, this parameter indicates
         * that there is at least one leaf node that supports the WRED packet
         * mode, which might not be true for all the leaf nodes. In packet
@@ -486,6 +534,24 @@ struct rte_tm_level_capabilities {
                         */
                        uint64_t shaper_private_rate_max;
 
+                       /** Shaper private packet mode supported. When non-zero,
+                        * this parameter indicates there is at least one
+                        * non-leaf node at this level that can be configured
+                        * with packet mode in its private shaper. When private
+                        * shaper is configured in packet mode, committed/peak
+                        * rate provided is interpreted in packets per second.
+                        */
+                       int shaper_private_packet_mode_supported;
+
+                       /** Shaper private byte mode supported. When non-zero,
+                        * this parameter indicates there is at least one
+                        * non-leaf node at this level that can be configured
+                        * with byte mode in its private shaper. When private
+                        * shaper is configured in byte mode, committed/peak
+                        * rate provided is interpreted in bytes per second.
+                        */
+                       int shaper_private_byte_mode_supported;
+
                        /** Maximum number of shared shapers that any non-leaf
                         * node on this level can be part of. The value of zero
                         * indicates that shared shapers are not supported by
@@ -496,6 +562,20 @@ struct rte_tm_level_capabilities {
                         */
                        uint32_t shaper_shared_n_max;
 
+                       /** Shaper shared packet mode supported. When non-zero,
+                        * this parameter indicates that there is at least one
+                        * non-leaf node on this level that can be part of
+                        * shared shapers which work in packet mode.
+                        */
+                       int shaper_shared_packet_mode_supported;
+
+                       /** Shaper shared byte mode supported. When non-zero,
+                        * this parameter indicates that there is at least one
+                        * non-leaf node on this level that can be part of
+                        * shared shapers which work in byte mode.
+                        */
+                       int shaper_shared_byte_mode_supported;
+
                        /** Maximum number of children nodes. This parameter
                         * indicates that there is at least one non-leaf node on
                         * this level that can be configured with this many
@@ -555,6 +635,25 @@ struct rte_tm_level_capabilities {
                         */
                        uint32_t sched_wfq_weight_max;
 
+                       /** WFQ packet mode supported. When non-zero, this
+                        * parameter indicates that there is at least one
+                        * non-leaf node at this level that supports packet
+                        * mode for WFQ among its children. WFQ weights will
+                        * be applied against packet count for scheduling
+                        * children when a non-leaf node is configured
+                        * appropriately.
+                        */
+                       int sched_wfq_packet_mode_supported;
+
+                       /** WFQ byte mode supported. When non-zero, this
+                        * parameter indicates that there is at least one
+                        * non-leaf node at this level that supports byte
+                        * mode for WFQ among its children. WFQ weights will
+                        * be applied against bytes for scheduling children
+                        * when a non-leaf node is configured appropriately.
+                        */
+                       int sched_wfq_byte_mode_supported;
+
                        /** Mask of statistics counter types supported by the
                         * non-leaf nodes on this level. Every supported
                         * statistics counter type is supported by at least one
@@ -597,6 +696,24 @@ struct rte_tm_level_capabilities {
                         */
                        uint64_t shaper_private_rate_max;
 
+                       /** Shaper private packet mode supported. When non-zero,
+                        * this parameter indicates there is at least one leaf
+                        * node at this level that can be configured with
+                        * packet mode in its private shaper. When private
+                        * shaper is configured in packet mode, committed/peak
+                        * rate provided is interpreted in packets per second.
+                        */
+                       int shaper_private_packet_mode_supported;
+
+                       /** Shaper private byte mode supported. When non-zero,
+                        * this parameter indicates there is at least one leaf
+                        * node at this level that can be configured with
+                        * byte mode in its private shaper. When private shaper
+                        * is configured in byte mode, committed/peak rate
+                        * provided is interpreted in bytes per second.
+                        */
+                       int shaper_private_byte_mode_supported;
+
                        /** Maximum number of shared shapers that any leaf node
                         * on this level can be part of. The value of zero
                         * indicates that shared shapers are not supported by
@@ -607,6 +724,20 @@ struct rte_tm_level_capabilities {
                         */
                        uint32_t shaper_shared_n_max;
 
+                       /** Shaper shared packet mode supported. When non-zero,
+                        * this parameter indicates that there is at least one
+                        * leaf node on this level that can be part of
+                        * shared shapers which work in packet mode.
+                        */
+                       int shaper_shared_packet_mode_supported;
+
+                       /** Shaper shared byte mode supported. When non-zero,
+                        * this parameter indicates that there is at least one
+                        * leaf node on this level that can be part of
+                        * shared shapers which work in byte mode.
+                        */
+                       int shaper_shared_byte_mode_supported;
+
                        /** WRED packet mode support. When non-zero, this
                         * parameter indicates that there is at least one leaf
                         * node on this level that supports the WRED packet
@@ -687,12 +818,38 @@ struct rte_tm_node_capabilities {
         */
        uint64_t shaper_private_rate_max;
 
+       /** Shaper private packet mode supported. When non-zero, this parameter
+        * indicates private shaper of current node can be configured with
+        * packet mode. When configured in packet mode, committed/peak rate
+        * provided is interpreted in packets per second.
+        */
+       int shaper_private_packet_mode_supported;
+
+       /** Shaper private byte mode supported. When non-zero, this parameter
+        * indicates private shaper of current node can be configured with
+        * byte mode. When configured in byte mode, committed/peak rate
+        * provided is interpreted in bytes per second.
+        */
+       int shaper_private_byte_mode_supported;
+
        /** Maximum number of shared shapers the current node can be part of.
         * The value of zero indicates that shared shapers are not supported by
         * the current node.
         */
        uint32_t shaper_shared_n_max;
 
+       /** Shaper shared packet mode supported. When non-zero,
+        * this parameter indicates that current node can be part of
+        * shared shapers which work in packet mode.
+        */
+       int shaper_shared_packet_mode_supported;
+
+       /** Shaper shared byte mode supported. When non-zero,
+        * this parameter indicates that current node can be part of
+        * shared shapers which work in byte mode.
+        */
+       int shaper_shared_byte_mode_supported;
+
        RTE_STD_C11
        union {
                /** Items valid only for non-leaf nodes. */
@@ -736,6 +893,23 @@ struct rte_tm_node_capabilities {
                         * WFQ weight, so WFQ is reduced to FQ.
                         */
                        uint32_t sched_wfq_weight_max;
+
+                       /** WFQ packet mode supported. When non-zero, this
+                        * parameter indicates that current node supports packet
+                        * mode for WFQ among its children. WFQ weights will be
+                        * applied against packet count for scheduling children
+                        * when configured appropriately.
+                        */
+                       int sched_wfq_packet_mode_supported;
+
+                       /** WFQ byte mode supported. When non-zero, this
+                        * parameter indicates that current node supports byte
+                        * mode for WFQ among its children. WFQ weights will be
+                        * applied against  bytes for scheduling children when
+                        * configured appropriately.
+                        */
+                       int sched_wfq_byte_mode_supported;
+
                } nonleaf;
 
                /** Items valid only for leaf nodes. */
@@ -837,10 +1011,10 @@ struct rte_tm_wred_params {
  * Token bucket
  */
 struct rte_tm_token_bucket {
-       /** Token bucket rate (bytes per second) */
+       /** Token bucket rate (bytes per second or packets per second) */
        uint64_t rate;
 
-       /** Token bucket size (bytes), a.k.a. max burst size */
+       /** Token bucket size (bytes or packets), a.k.a. max burst size */
        uint64_t size;
 };
 
@@ -861,6 +1035,11 @@ struct rte_tm_token_bucket {
  * Dual rate shapers use both the committed and the peak token buckets. The
  * rate of the peak bucket has to be bigger than zero, as well as greater than
  * or equal to the rate of the committed bucket.
+ *
+ * @see struct rte_tm_capabilities::shaper_private_packet_mode_supported
+ * @see struct rte_tm_capabilities::shaper_private_byte_mode_supported
+ * @see struct rte_tm_capabilities::shaper_shared_packet_mode_supported
+ * @see struct rte_tm_capabilities::shaper_shared_byte_mode_supported
  */
 struct rte_tm_shaper_params {
        /** Committed token bucket */
@@ -873,8 +1052,19 @@ struct rte_tm_shaper_params {
         * purpose of shaping. Can be used to correct the packet length with
         * the framing overhead bytes that are also consumed on the wire (e.g.
         * RTE_TM_ETH_FRAMING_OVERHEAD_FCS).
+        * This field is ignored when the profile enables packet mode.
         */
        int32_t pkt_length_adjust;
+
+       /** When zero, the byte mode is enabled for the current profile, so the
+        * *rate* and *size* fields in both the committed and peak token buckets
+        * are specified in bytes per second and bytes, respectively.
+        * When non-zero, the packet mode is enabled for the current profile,
+        * so the *rate* and *size* fields in both the committed and peak token
+        * buckets are specified in packets per second and packets,
+        * respectively.
+        */
+       int packet_mode;
 };
 
 /**
@@ -926,6 +1116,8 @@ struct rte_tm_node_params {
                         * When non-NULL, it points to a pre-allocated array of
                         * *n_sp_priorities* values, with non-zero value for
                         * byte-mode and zero for packet-mode.
+                        * @see struct rte_tm_node_capabilities::sched_wfq_packet_mode_supported
+                        * @see struct rte_tm_node_capabilities::sched_wfq_byte_mode_supported
                         */
                        int *wfq_weight_mode;
 
@@ -998,6 +1190,7 @@ enum rte_tm_error_type {
        RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PEAK_RATE,
        RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PEAK_SIZE,
        RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PKT_ADJUST_LEN,
+       RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PACKET_MODE,
        RTE_TM_ERROR_TYPE_SHAPER_PROFILE_ID,
        RTE_TM_ERROR_TYPE_SHARED_SHAPER_ID,
        RTE_TM_ERROR_TYPE_NODE_PARENT_NODE_ID,