From 3042773b0c2cddfe2285abecfa6e78703e7ea5da Mon Sep 17 00:00:00 2001 From: Matias Elo Date: Wed, 6 Oct 2021 09:27:19 +0300 Subject: api: ipsec: add bit field usage clarification MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add comments about bit fields’ ‘all’ member intended usage. Signed-off-by: Matias Elo Reviewed-by: Petri Savolainen Reviewed-by: Jere Leppänen --- include/odp/api/spec/ipsec.h | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index 6e28e7fb4..f66758341 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -1296,7 +1296,10 @@ typedef struct odp_ipsec_warn_t { uint32_t soft_exp_packets : 1; }; - /** All warnings bits */ + /** All warning bits + * + * This field can be used to set/clear all bits, or to perform + * bitwise operations over those. */ uint32_t all; }; @@ -1335,7 +1338,10 @@ typedef struct odp_ipsec_op_flag_t { }; - /** All flag bits */ + /** All flag bits + * + * This field can be used to set/clear all flags, or to perform + * bitwise operations over those. */ uint32_t all; }; @@ -1373,7 +1379,10 @@ typedef struct odp_ipsec_out_opt_t { } flag; - /** All flag bits */ + /** All flag bits + * + * This field can be used to set/clear all flags, or to perform + * bitwise operations over those. */ uint32_t all_flags; }; -- cgit v1.2.3