ethdev: clarify MARK and FLAG actions in flow API

[dpdk.git] / lib / librte_ether / rte_flow.h

diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h
index 98084ac..c2b9fc5 100644 (file)
--- a/lib/librte_ether/rte_flow.h
+++ b/lib/librte_ether/rte_flow.h
@@ -556,7 +556,8 @@ enum rte_flow_action_type {
        /**
         * [META]
         *
-        * Attaches a 32 bit value to packets.
+        * Attaches an integer value to packets and sets PKT_RX_FDIR and
+        * PKT_RX_FDIR_ID mbuf flags.
         *
         * See struct rte_flow_action_mark.
         */
@@ -565,9 +566,8 @@ enum rte_flow_action_type {
        /**
         * [META]
         *
-        * Flag packets. Similar to MARK but only affects ol_flags.
-        *
-        * Note: a distinctive flag must be defined for it.
+        * Flags packets. Similar to MARK without a specific value; only
+        * sets the PKT_RX_FDIR mbuf flag.
         *
         * No associated configuration structure.
         */
@@ -640,14 +640,15 @@ enum rte_flow_action_type {
 /**
  * RTE_FLOW_ACTION_TYPE_MARK
  *
- * Attaches a 32 bit value to packets.
+ * Attaches an integer value to packets and sets PKT_RX_FDIR and
+ * PKT_RX_FDIR_ID mbuf flags.
  *
- * This value is arbitrary and application-defined. For compatibility with
- * FDIR it is returned in the hash.fdir.hi mbuf field. PKT_RX_FDIR_ID is
- * also set in ol_flags.
+ * This value is arbitrary and application-defined. Maximum allowed value
+ * depends on the underlying implementation. It is returned in the
+ * hash.fdir.hi mbuf field.
  */
 struct rte_flow_action_mark {
-       uint32_t id; /**< 32 bit value to return with packets. */
+       uint32_t id; /**< Integer value to return with packets. */
 };
 
 /**