From: Dmitry Eremin-Solenikov <dmitry.ereminsoleni...@linaro.org> Document usage of IPv4/IPv6 flags on inbound packets. Provide special case for TFC dummy packets, which are marked by both flags being cleared.
Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsoleni...@linaro.org> --- /** Email created from pull request 329 (lumag:ipsec-tfc) ** https://github.com/Linaro/odp/pull/329 ** Patch: https://github.com/Linaro/odp/pull/329.patch ** Base sha: e77675624b9cfcd6ea83d11804ed0715b7fad2ec ** Merge commit sha: 826bb522f15d045761edd504aebd310a81b4b238 **/ include/odp/api/spec/ipsec.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index bf278d73e..b44320137 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -1217,9 +1217,12 @@ typedef struct odp_ipsec_status_t { * Each successfully transformed packet has a valid value for these metadata * regardless of the inner packet parse configuration * (odp_ipsec_inbound_config_t): - * - L3 offset: Offset to the first byte of the (outmost) IP header - * - pktio: For inline IPSEC processed packets, original packet input - * interface + * - L3 offset: Offset to the first byte of the (outmost) IP header + * - IPv4/IPv6 flags: These flags can be used to determine packet contents. + * If neither IPv4 nor IPv6 flag are set, received packet is + * TFC dummy packet and should be dropped by an application + * - pktio: For inline IPSEC processed packets, original packet input + * interface * * Other metadata for parse results and error checks depend on configuration * (selected parse and error check levels).