aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatias Elo <matias.elo@nokia.com>2023-01-09 13:44:53 +0200
committerMatias Elo <matias.elo@nokia.com>2023-02-07 16:25:36 +0200
commit495a9f770480cdbe9e6ed7b0bff6194b0f1f29dd (patch)
treee46873521b4fde2896c66a90693fd77c99b78aa8
parent03e204911bb9ad80d2f2eab56461a2d9efd54722 (diff)
api: packet: clarify packer has vlan and vlan q-in-q specifications
Clarify odp_packet_has_vlan() and odp_packet_has_vlan_qinq() specifications. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Kiran Kumar K <kirankumark@marvell.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
-rw-r--r--include/odp/api/spec/packet_flags.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/include/odp/api/spec/packet_flags.h b/include/odp/api/spec/packet_flags.h
index c6ff11054..c62e50885 100644
--- a/include/odp/api/spec/packet_flags.h
+++ b/include/odp/api/spec/packet_flags.h
@@ -179,6 +179,8 @@ int odp_packet_has_jumbo(odp_packet_t pkt);
/**
* Check for VLAN
*
+ * Check if packet contains normal or QinQ VLAN header.
+ *
* @param pkt Packet handle
*
* @retval non-zero Packet contains a VLAN header
@@ -189,6 +191,8 @@ int odp_packet_has_vlan(odp_packet_t pkt);
/**
* Check for VLAN QinQ (stacked VLAN)
*
+ * Check if packet contains QinQ VLAN header.
+ *
* @param pkt Packet handle
*
* @retval non-zero Packet contains a VLAN QinQ header
@@ -408,7 +412,8 @@ void odp_packet_has_jumbo_set(odp_packet_t pkt, int val);
/**
* Set flag for VLAN
*
- * Only one VLAN flag (VLAN/VLAN QinQ) can be set simultaneously.
+ * Set when packet contains normal VLAN header. Only one VLAN flag
+ * (VLAN/VLAN QinQ) can be set simultaneously.
*
* @param pkt Packet handle
* @param val Value
@@ -418,7 +423,8 @@ void odp_packet_has_vlan_set(odp_packet_t pkt, int val);
/**
* Set flag for VLAN QinQ (stacked VLAN)
*
- * Only one VLAN flag (VLAN/VLAN QinQ) can be set simultaneously.
+ * Set when packet contains QinQ VLAN header. Only one VLAN flag
+ * (VLAN/VLAN QinQ) can be set simultaneously.
*
* @param pkt Packet handle
* @param val Value