[v2,01/11] doc: add Traffic Manager feature

Message ID 20231128124106.18711-2-lihuisong@huawei.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series add Traffic Manager feature |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

lihuisong (C) Nov. 28, 2023, 12:40 p.m. UTC
  Add Traffic Manager feature.

Fixes: 5d109deffa87 ("ethdev: add traffic management API")
Cc: stable@dpdk.org

Signed-off-by: Huisong Li <lihuisong@huawei.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Cristian Dumitrescu <cristian.dumitrescu@yahoo.com>
---
 doc/guides/nics/features.rst         | 13 +++++++++++++
 doc/guides/nics/features/default.ini |  1 +
 2 files changed, 14 insertions(+)
  

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index 1a1dc16c1e..e93b97a5b8 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -740,6 +740,19 @@  Supports congestion management.
   ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
 
 
+.. _nic_features_traffic_manager:
+
+Traffic manager
+---------------
+
+Supports Traffic manager.
+
+* **[implements] rte_tm_ops**: ``capabilities_get``, ``shaper_profile_add``,
+  ``hierarchy_commit`` and so on.
+* **[related]    API**: ``rte_tm_capabilities_get()``, ``rte_tm_shaper_profile_add()``,
+  ``rte_tm_hierarchy_commit()`` and so on.
+
+
 .. _nic_features_fw_version:
 
 FW version
diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
index 806cb033ff..64ee0f8c2f 100644
--- a/doc/guides/nics/features/default.ini
+++ b/doc/guides/nics/features/default.ini
@@ -42,6 +42,7 @@  VLAN filter          =
 Flow control         =
 Rate limitation      =
 Congestion management =
+Traffic manager      =
 Inline crypto        =
 Inline protocol      =
 CRC offload          =