diff --git a/experimental/saiexperimentaldashacl.h b/experimental/saiexperimentaldashacl.h index 5ed42f802..69df0c00d 100644 --- a/experimental/saiexperimentaldashacl.h +++ b/experimental/saiexperimentaldashacl.h @@ -20,15 +20,17 @@ * @file saiexperimentaldashacl.h * * @brief This module defines SAI extensions for DASH ACL + * + * @warning This module is a SAI experimental module */ #if !defined (__SAIEXPERIMENTALDASHACL_H_) #define __SAIEXPERIMENTALDASHACL_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_ACL SAI - Experimental: DASH ACL specific API definitions + * @defgroup SAIEXPERIMENTALDASHACL SAI - Experimental: DASH ACL specific API definitions * * @{ */ @@ -49,7 +51,7 @@ typedef enum _sai_dash_acl_rule_action_t } sai_dash_acl_rule_action_t; /** - * @brief Attribute ID for dash_acl_dash_acl_group + * @brief Attribute ID for DASH ACL group */ typedef enum _sai_dash_acl_group_attr_t { @@ -59,7 +61,7 @@ typedef enum _sai_dash_acl_group_attr_t SAI_DASH_ACL_GROUP_ATTR_START, /** - * @brief Action set_acl_group_attrs parameter IP_ADDR_FAMILY + * @brief Action parameter IP address family * * @type sai_ip_addr_family_t * @flags CREATE_AND_SET @@ -82,7 +84,7 @@ typedef enum _sai_dash_acl_group_attr_t } sai_dash_acl_group_attr_t; /** - * @brief Attribute ID for dash_acl_dash_acl_rule + * @brief Attribute ID for DASH ACL rule */ typedef enum _sai_dash_acl_rule_attr_t { @@ -151,9 +153,7 @@ typedef enum _sai_dash_acl_rule_attr_t SAI_DASH_ACL_RULE_ATTR_DST_PORT, /** - * @brief Attach a counter - * - * When it is empty, then packet hits won't be counted + * @brief Attach a counter. When it is empty, then packet hits won't be counted. * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -194,7 +194,7 @@ typedef enum _sai_dash_acl_rule_attr_t } sai_dash_acl_rule_attr_t; /** - * @brief Create dash_acl_dash_acl_group + * @brief Create DASH ACL group * * @param[out] dash_acl_group_id Entry id * @param[in] switch_id Switch id @@ -210,7 +210,7 @@ typedef sai_status_t (*sai_create_dash_acl_group_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_acl_dash_acl_group + * @brief Remove DASH ACL group * * @param[in] dash_acl_group_id Entry id * @@ -220,7 +220,7 @@ typedef sai_status_t (*sai_remove_dash_acl_group_fn)( _In_ sai_object_id_t dash_acl_group_id); /** - * @brief Set attribute for dash_acl_dash_acl_group + * @brief Set attribute for DASH ACL group * * @param[in] dash_acl_group_id Entry id * @param[in] attr Attribute @@ -232,7 +232,7 @@ typedef sai_status_t (*sai_set_dash_acl_group_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_acl_dash_acl_group + * @brief Get attribute for DASH ACL group * * @param[in] dash_acl_group_id Entry id * @param[in] attr_count Number of attributes @@ -246,7 +246,7 @@ typedef sai_status_t (*sai_get_dash_acl_group_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Create dash_acl_dash_acl_rule + * @brief Create DASH ACL rule * * @param[out] dash_acl_rule_id Entry id * @param[in] switch_id Switch id @@ -262,7 +262,7 @@ typedef sai_status_t (*sai_create_dash_acl_rule_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_acl_dash_acl_rule + * @brief Remove DASH ACL rule * * @param[in] dash_acl_rule_id Entry id * @@ -272,7 +272,7 @@ typedef sai_status_t (*sai_remove_dash_acl_rule_fn)( _In_ sai_object_id_t dash_acl_rule_id); /** - * @brief Set attribute for dash_acl_dash_acl_rule + * @brief Set attribute for DASH ACL rule * * @param[in] dash_acl_rule_id Entry id * @param[in] attr Attribute @@ -284,7 +284,7 @@ typedef sai_status_t (*sai_set_dash_acl_rule_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_acl_dash_acl_rule + * @brief Get attribute for DASH ACL rule * * @param[in] dash_acl_rule_id Entry id * @param[in] attr_count Number of attributes diff --git a/experimental/saiexperimentaldashdirectionlookup.h b/experimental/saiexperimentaldashdirectionlookup.h index c482dc84e..8f93a8728 100644 --- a/experimental/saiexperimentaldashdirectionlookup.h +++ b/experimental/saiexperimentaldashdirectionlookup.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHDIRECTIONLOOKUP_H_) #define __SAIEXPERIMENTALDASHDIRECTIONLOOKUP_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_DIRECTION_LOOKUP SAI - Experimental: DASH direction lookup specific API definitions + * @defgroup SAIEXPERIMENTALDASHDIRECTIONLOOKUP SAI - Experimental: DASH direction lookup specific API definitions * * @{ */ @@ -64,7 +64,7 @@ typedef struct _sai_direction_lookup_entry_t } sai_direction_lookup_entry_t; /** - * @brief Attribute ID for dash_direction_lookup_direction_lookup_entry + * @brief Attribute ID for direction lookup entry */ typedef enum _sai_direction_lookup_entry_attr_t { @@ -96,7 +96,7 @@ typedef enum _sai_direction_lookup_entry_attr_t } sai_direction_lookup_entry_attr_t; /** - * @brief Create dash_direction_lookup_direction_lookup_entry + * @brief Create direction lookup entry * * @param[in] direction_lookup_entry Entry * @param[in] attr_count Number of attributes @@ -110,7 +110,7 @@ typedef sai_status_t (*sai_create_direction_lookup_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_direction_lookup_direction_lookup_entry + * @brief Remove direction lookup entry * * @param[in] direction_lookup_entry Entry * @@ -120,7 +120,7 @@ typedef sai_status_t (*sai_remove_direction_lookup_entry_fn)( _In_ const sai_direction_lookup_entry_t *direction_lookup_entry); /** - * @brief Set attribute for dash_direction_lookup_direction_lookup_entry + * @brief Set attribute for direction lookup entry * * @param[in] direction_lookup_entry Entry * @param[in] attr Attribute @@ -132,7 +132,7 @@ typedef sai_status_t (*sai_set_direction_lookup_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_direction_lookup_direction_lookup_entry + * @brief Get attribute for direction lookup entry * * @param[in] direction_lookup_entry Entry * @param[in] attr_count Number of attributes @@ -146,7 +146,7 @@ typedef sai_status_t (*sai_get_direction_lookup_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_direction_lookup_direction_lookup_entry + * @brief Bulk create direction lookup entry * * @param[in] object_count Number of objects to create * @param[in] direction_lookup_entry List of object to create @@ -171,7 +171,7 @@ typedef sai_status_t (*sai_bulk_create_direction_lookup_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_direction_lookup_direction_lookup_entry + * @brief Bulk remove direction lookup entry * * @param[in] object_count Number of objects to remove * @param[in] direction_lookup_entry List of objects to remove diff --git a/experimental/saiexperimentaldasheni.h b/experimental/saiexperimentaldasheni.h index 475064071..c41119448 100644 --- a/experimental/saiexperimentaldasheni.h +++ b/experimental/saiexperimentaldasheni.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHENI_H_) #define __SAIEXPERIMENTALDASHENI_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_ENI SAI - Experimental: DASH ENI specific API definitions + * @defgroup SAIEXPERIMENTALDASHENI SAI - Experimental: DASH ENI specific API definitions * * @{ */ @@ -64,7 +64,7 @@ typedef struct _sai_eni_ether_address_map_entry_t } sai_eni_ether_address_map_entry_t; /** - * @brief Attribute ID for dash_eni_eni_ether_address_map_entry + * @brief Attribute ID for ENI ether address map entry */ typedef enum _sai_eni_ether_address_map_entry_attr_t { @@ -83,7 +83,7 @@ typedef enum _sai_eni_ether_address_map_entry_attr_t SAI_ENI_ETHER_ADDRESS_MAP_ENTRY_ATTR_ACTION = SAI_ENI_ETHER_ADDRESS_MAP_ENTRY_ATTR_START, /** - * @brief Action set_eni parameter ENI_ID + * @brief Action parameter ENI id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -107,7 +107,7 @@ typedef enum _sai_eni_ether_address_map_entry_attr_t } sai_eni_ether_address_map_entry_attr_t; /** - * @brief Attribute ID for dash_eni_eni + * @brief Attribute ID for ENI */ typedef enum _sai_eni_attr_t { @@ -117,7 +117,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_START, /** - * @brief Action set_eni_attrs parameter CPS + * @brief Action parameter CPS * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -126,7 +126,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_CPS = SAI_ENI_ATTR_START, /** - * @brief Action set_eni_attrs parameter PPS + * @brief Action parameter PPS * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -135,7 +135,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_PPS, /** - * @brief Action set_eni_attrs parameter FLOWS + * @brief Action parameter flows * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -144,7 +144,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_FLOWS, /** - * @brief Action set_eni_attrs parameter ADMIN_STATE + * @brief Action parameter admin state * * @type bool * @flags CREATE_AND_SET @@ -153,7 +153,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_ADMIN_STATE, /** - * @brief Action set_eni_attrs parameter HA_SCOPE_ID + * @brief Action parameter HA scope id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -164,7 +164,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_HA_SCOPE_ID, /** - * @brief Action set_eni_attrs parameter VM_UNDERLAY_DIP + * @brief Action parameter underlay dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -173,7 +173,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_VM_UNDERLAY_DIP, /** - * @brief Action set_eni_attrs parameter VM_VNI + * @brief Action parameter VNI * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -182,7 +182,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_VM_VNI, /** - * @brief Action set_eni_attrs parameter VNET_ID + * @brief Action parameter VNET id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -193,7 +193,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_VNET_ID, /** - * @brief Action set_eni_attrs parameter PL_SIP + * @brief Action parameter PL sip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -202,7 +202,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_PL_SIP, /** - * @brief Action set_eni_attrs parameter PL_SIP_MASK + * @brief Action parameter PL sip mask * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -211,7 +211,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_PL_SIP_MASK, /** - * @brief Action set_eni_attrs parameter PL_UNDERLAY_SIP + * @brief Action parameter PL underlay sip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -220,7 +220,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_PL_UNDERLAY_SIP, /** - * @brief Action set_eni_attrs parameter V4_METER_POLICY_ID + * @brief Action parameter v4 meter policy id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -231,7 +231,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_V4_METER_POLICY_ID, /** - * @brief Action set_eni_attrs parameter V6_METER_POLICY_ID + * @brief Action parameter v6 meter policy id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -242,7 +242,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_V6_METER_POLICY_ID, /** - * @brief Action set_eni_attrs parameter DASH_TUNNEL_DSCP_MODE + * @brief Action parameter DASH tunnel DSCP mode * * @type sai_dash_tunnel_dscp_mode_t * @flags CREATE_AND_SET @@ -251,7 +251,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_DASH_TUNNEL_DSCP_MODE, /** - * @brief Action set_eni_attrs parameter DSCP + * @brief Action parameter DSCP * * @type sai_uint8_t * @flags CREATE_AND_SET @@ -261,7 +261,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_DSCP, /** - * @brief Action set_eni_attrs parameter INBOUND_V4_STAGE1_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v4 stage1 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -272,7 +272,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V4_STAGE1_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V4_STAGE2_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v4 stage2 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -283,7 +283,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V4_STAGE2_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V4_STAGE3_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v4 stage3 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -294,7 +294,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V4_STAGE3_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V4_STAGE4_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v4 stage4 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -305,7 +305,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V4_STAGE4_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V4_STAGE5_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v4 stage5 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -316,7 +316,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V4_STAGE5_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V6_STAGE1_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v6 stage1 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -327,7 +327,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V6_STAGE1_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V6_STAGE2_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v6 stage2 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -338,7 +338,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V6_STAGE2_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V6_STAGE3_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v6 stage3 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -349,7 +349,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V6_STAGE3_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V6_STAGE4_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v6 stage4 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -360,7 +360,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V6_STAGE4_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter INBOUND_V6_STAGE5_DASH_ACL_GROUP_ID + * @brief Action parameter inbound v6 stage5 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -371,7 +371,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_INBOUND_V6_STAGE5_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V4_STAGE1_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v4 stage1 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -382,7 +382,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V4_STAGE1_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V4_STAGE2_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v4 stage2 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -393,7 +393,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V4_STAGE2_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V4_STAGE3_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v4 stage3 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -404,7 +404,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V4_STAGE3_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V4_STAGE4_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v4 stage4 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -415,7 +415,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V4_STAGE4_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V4_STAGE5_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v4 stage5 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -426,7 +426,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V4_STAGE5_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V6_STAGE1_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v6 stage1 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -437,7 +437,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V6_STAGE1_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V6_STAGE2_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v6 stage2 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -448,7 +448,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V6_STAGE2_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V6_STAGE3_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v6 stage3 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -459,7 +459,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V6_STAGE3_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V6_STAGE4_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v6 stage4 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -470,7 +470,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V6_STAGE4_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter OUTBOUND_V6_STAGE5_DASH_ACL_GROUP_ID + * @brief Action parameter outbound v6 stage5 DASH ACL group id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -481,7 +481,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_OUTBOUND_V6_STAGE5_DASH_ACL_GROUP_ID, /** - * @brief Action set_eni_attrs parameter DISABLE_FAST_PATH_ICMP_FLOW_REDIRECTION + * @brief Action parameter disable fast path ICMP flow redirection * * @type bool * @flags CREATE_AND_SET @@ -490,7 +490,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_DISABLE_FAST_PATH_ICMP_FLOW_REDIRECTION, /** - * @brief Action set_eni_attrs parameter FULL_FLOW_RESIMULATION_REQUESTED + * @brief Action parameter full flow re-simulation requested * * @type bool * @flags CREATE_AND_SET @@ -499,7 +499,7 @@ typedef enum _sai_eni_attr_t SAI_ENI_ATTR_FULL_FLOW_RESIMULATION_REQUESTED, /** - * @brief Action set_eni_attrs parameter MAX_RESIMULATED_FLOW_PER_SECOND + * @brief Action parameter max re-simulated flow per second * * @type sai_uint64_t * @flags CREATE_AND_SET @@ -532,7 +532,7 @@ typedef enum _sai_eni_attr_t } sai_eni_attr_t; /** - * @brief Counter IDs for ENI in sai_get_eni_stats() call + * @brief Counter IDs for ENI */ typedef enum _sai_eni_stat_t { @@ -686,11 +686,11 @@ typedef enum _sai_eni_stat_t /** DASH ENI INLINE_FLOW_UPDATE_ACK_RECV stat count */ SAI_ENI_STAT_INLINE_FLOW_UPDATE_ACK_RECV, - /** DASH ENI INLINE_FLOW_UPDATE_ACK_FAILED_RECV stat count */ - SAI_ENI_STAT_INLINE_FLOW_UPDATE_ACK_FAILED_RECV, + /** DASH ENI INLINE_FLOW_UPDATE_ACK_FAILED stat count */ + SAI_ENI_STAT_INLINE_FLOW_UPDATE_ACK_FAILED, - /** DASH ENI INLINE_FLOW_UPDATE_ACK_IGNORED_RECV stat count */ - SAI_ENI_STAT_INLINE_FLOW_UPDATE_ACK_IGNORED_RECV, + /** DASH ENI INLINE_FLOW_UPDATE_ACK_IGNORED stat count */ + SAI_ENI_STAT_INLINE_FLOW_UPDATE_ACK_IGNORED, /** DASH ENI TIMED_FLOW_UPDATE_REQ_SENT stat count */ SAI_ENI_STAT_TIMED_FLOW_UPDATE_REQ_SENT, @@ -707,11 +707,11 @@ typedef enum _sai_eni_stat_t /** DASH ENI TIMED_FLOW_UPDATE_ACK_RECV stat count */ SAI_ENI_STAT_TIMED_FLOW_UPDATE_ACK_RECV, - /** DASH ENI TIMED_FLOW_UPDATE_ACK_FAILED_RECV stat count */ - SAI_ENI_STAT_TIMED_FLOW_UPDATE_ACK_FAILED_RECV, + /** DASH ENI TIMED_FLOW_UPDATE_ACK_FAILED stat count */ + SAI_ENI_STAT_TIMED_FLOW_UPDATE_ACK_FAILED, - /** DASH ENI TIMED_FLOW_UPDATE_ACK_IGNORED_RECV stat count */ - SAI_ENI_STAT_TIMED_FLOW_UPDATE_ACK_IGNORED_RECV, + /** DASH ENI TIMED_FLOW_UPDATE_ACK_IGNORED stat count */ + SAI_ENI_STAT_TIMED_FLOW_UPDATE_ACK_IGNORED, /** DASH ENI INLINE_FLOW_DELETE_REQ_SENT stat count */ SAI_ENI_STAT_INLINE_FLOW_DELETE_REQ_SENT, @@ -728,11 +728,11 @@ typedef enum _sai_eni_stat_t /** DASH ENI INLINE_FLOW_DELETE_ACK_RECV stat count */ SAI_ENI_STAT_INLINE_FLOW_DELETE_ACK_RECV, - /** DASH ENI INLINE_FLOW_DELETE_ACK_FAILED_RECV stat count */ - SAI_ENI_STAT_INLINE_FLOW_DELETE_ACK_FAILED_RECV, + /** DASH ENI INLINE_FLOW_DELETE_ACK_FAILED stat count */ + SAI_ENI_STAT_INLINE_FLOW_DELETE_ACK_FAILED, - /** DASH ENI INLINE_FLOW_DELETE_ACK_IGNORED_RECV stat count */ - SAI_ENI_STAT_INLINE_FLOW_DELETE_ACK_IGNORED_RECV, + /** DASH ENI INLINE_FLOW_DELETE_ACK_IGNORED stat count */ + SAI_ENI_STAT_INLINE_FLOW_DELETE_ACK_IGNORED, /** DASH ENI TIMED_FLOW_DELETE_REQ_SENT stat count */ SAI_ENI_STAT_TIMED_FLOW_DELETE_REQ_SENT, @@ -749,8 +749,8 @@ typedef enum _sai_eni_stat_t /** DASH ENI TIMED_FLOW_DELETE_ACK_RECV stat count */ SAI_ENI_STAT_TIMED_FLOW_DELETE_ACK_RECV, - /** DASH ENI TIMED_FLOW_DELETE_ACK_FAILED_RECV stat count */ - SAI_ENI_STAT_TIMED_FLOW_DELETE_ACK_FAILED_RECV, + /** DASH ENI TIMED_FLOW_DELETE_ACK_FAILED stat count */ + SAI_ENI_STAT_TIMED_FLOW_DELETE_ACK_FAILED, /** DASH ENI TIMED_FLOW_DELETE_ACK_IGNORED stat count */ SAI_ENI_STAT_TIMED_FLOW_DELETE_ACK_IGNORED, @@ -773,7 +773,7 @@ typedef enum _sai_eni_stat_t } sai_eni_stat_t; /** - * @brief Create dash_eni_eni_ether_address_map_entry + * @brief Create ENI ether address map entry * * @param[in] eni_ether_address_map_entry Entry * @param[in] attr_count Number of attributes @@ -787,7 +787,7 @@ typedef sai_status_t (*sai_create_eni_ether_address_map_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_eni_eni_ether_address_map_entry + * @brief Remove ENI ether address map entry * * @param[in] eni_ether_address_map_entry Entry * @@ -797,7 +797,7 @@ typedef sai_status_t (*sai_remove_eni_ether_address_map_entry_fn)( _In_ const sai_eni_ether_address_map_entry_t *eni_ether_address_map_entry); /** - * @brief Set attribute for dash_eni_eni_ether_address_map_entry + * @brief Set attribute for ENI ether address map entry * * @param[in] eni_ether_address_map_entry Entry * @param[in] attr Attribute @@ -809,7 +809,7 @@ typedef sai_status_t (*sai_set_eni_ether_address_map_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_eni_eni_ether_address_map_entry + * @brief Get attribute for ENI ether address map entry * * @param[in] eni_ether_address_map_entry Entry * @param[in] attr_count Number of attributes @@ -823,7 +823,7 @@ typedef sai_status_t (*sai_get_eni_ether_address_map_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_eni_eni_ether_address_map_entry + * @brief Bulk create ENI ether address map entry * * @param[in] object_count Number of objects to create * @param[in] eni_ether_address_map_entry List of object to create @@ -848,7 +848,7 @@ typedef sai_status_t (*sai_bulk_create_eni_ether_address_map_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_eni_eni_ether_address_map_entry + * @brief Bulk remove ENI ether address map entry * * @param[in] object_count Number of objects to remove * @param[in] eni_ether_address_map_entry List of objects to remove @@ -868,7 +868,7 @@ typedef sai_status_t (*sai_bulk_remove_eni_ether_address_map_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Create dash_eni_eni + * @brief Create ENI * * @param[out] eni_id Entry id * @param[in] switch_id Switch id @@ -884,7 +884,7 @@ typedef sai_status_t (*sai_create_eni_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_eni_eni + * @brief Remove ENI * * @param[in] eni_id Entry id * @@ -894,7 +894,7 @@ typedef sai_status_t (*sai_remove_eni_fn)( _In_ sai_object_id_t eni_id); /** - * @brief Set attribute for dash_eni_eni + * @brief Set attribute for ENI * * @param[in] eni_id Entry id * @param[in] attr Attribute @@ -906,7 +906,7 @@ typedef sai_status_t (*sai_set_eni_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_eni_eni + * @brief Get attribute for ENI * * @param[in] eni_id Entry id * @param[in] attr_count Number of attributes diff --git a/experimental/saiexperimentaldashha.h b/experimental/saiexperimentaldashha.h index 16d44ce3c..75332a27a 100644 --- a/experimental/saiexperimentaldashha.h +++ b/experimental/saiexperimentaldashha.h @@ -19,7 +19,9 @@ * * @file saiexperimentaldashha.h * - * @brief This module defines SAI P4 extension interface + * @brief This module defines SAI extensions for DASH HA + * + * @warning This module is a SAI experimental module */ #if !defined (__SAIEXPERIMENTALDASHHA_H_) @@ -28,13 +30,13 @@ #include /** - * @defgroup SAIEXPERIMENTALDASH_HA SAI - Extension specific API definitions + * @defgroup SAIEXPERIMENTALDASHHA SAI - Experimental: DASH HA specific API definitions * * @{ */ /** - * @brief Attribute ID for dash_ha_ha_set + * @brief Attribute ID for HA set */ typedef enum _sai_ha_set_attr_t { @@ -44,7 +46,7 @@ typedef enum _sai_ha_set_attr_t SAI_HA_SET_ATTR_START, /** - * @brief Action set_ha_set_attr parameter LOCAL_IP + * @brief Action parameter local IP * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -53,7 +55,7 @@ typedef enum _sai_ha_set_attr_t SAI_HA_SET_ATTR_LOCAL_IP = SAI_HA_SET_ATTR_START, /** - * @brief Action set_ha_set_attr parameter PEER_IP + * @brief Action parameter peer IP * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -62,47 +64,47 @@ typedef enum _sai_ha_set_attr_t SAI_HA_SET_ATTR_PEER_IP, /** - * @brief Action set_ha_set_attr parameter CP_DATA_CHANNEL_PORT + * @brief Action parameter control plane data channel port * * @type sai_uint16_t * @flags CREATE_AND_SET - * @isvlan false + * @isvlan true * @default 0 */ SAI_HA_SET_ATTR_CP_DATA_CHANNEL_PORT, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_DST_PORT + * @brief Action parameter data plane channel dst port * * @type sai_uint16_t * @flags CREATE_AND_SET - * @isvlan false + * @isvlan true * @default 0 */ SAI_HA_SET_ATTR_DP_CHANNEL_DST_PORT, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_MIN_SRC_PORT + * @brief Action parameter data plane channel min src port * * @type sai_uint16_t * @flags CREATE_AND_SET - * @isvlan false + * @isvlan true * @default 0 */ SAI_HA_SET_ATTR_DP_CHANNEL_MIN_SRC_PORT, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_MAX_SRC_PORT + * @brief Action parameter data plane channel max src port * * @type sai_uint16_t * @flags CREATE_AND_SET - * @isvlan false + * @isvlan true * @default 0 */ SAI_HA_SET_ATTR_DP_CHANNEL_MAX_SRC_PORT, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_PROBE_INTERVAL_MS + * @brief Action parameter data plane channel probe interval ms * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -111,7 +113,7 @@ typedef enum _sai_ha_set_attr_t SAI_HA_SET_ATTR_DP_CHANNEL_PROBE_INTERVAL_MS, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_PROBE_FAIL_THRESHOLD + * @brief Action parameter data plane channel probe fail threshold * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -120,7 +122,7 @@ typedef enum _sai_ha_set_attr_t SAI_HA_SET_ATTR_DP_CHANNEL_PROBE_FAIL_THRESHOLD, /** - * @brief Action set_ha_set_attr parameter DP_CHANNEL_IS_ALIVE + * @brief Action parameter data plane channel is alive * * @type bool * @flags READ_ONLY @@ -141,7 +143,7 @@ typedef enum _sai_ha_set_attr_t } sai_ha_set_attr_t; /** - * @brief Counter IDs for HA_SET in sai_get_ha_set_stats() call + * @brief Counter IDs for HA SET */ typedef enum _sai_ha_set_stat_t { @@ -208,7 +210,7 @@ typedef enum _sai_ha_set_stat_t } sai_ha_set_stat_t; /** - * @brief Attribute ID for dash_ha_ha_scope + * @brief Attribute ID for HA scope */ typedef enum _sai_ha_scope_attr_t { @@ -218,17 +220,17 @@ typedef enum _sai_ha_scope_attr_t SAI_HA_SCOPE_ATTR_START, /** - * @brief Action set_ha_scope_attr parameter HA_SET_ID + * @brief Action parameter HA set id * * @type sai_uint16_t * @flags CREATE_AND_SET - * @isvlan false + * @isvlan true * @default 0 */ SAI_HA_SCOPE_ATTR_HA_SET_ID = SAI_HA_SCOPE_ATTR_START, /** - * @brief Action set_ha_scope_attr parameter DASH_HA_ROLE + * @brief Action parameter DASH HA role * * @type sai_dash_ha_role_t * @flags CREATE_AND_SET @@ -237,7 +239,7 @@ typedef enum _sai_ha_scope_attr_t SAI_HA_SCOPE_ATTR_DASH_HA_ROLE, /** - * @brief Action set_ha_scope_attr parameter FLOW_VERSION + * @brief Action parameter flow version * * @type sai_uint32_t * @flags READ_ONLY @@ -245,7 +247,7 @@ typedef enum _sai_ha_scope_attr_t SAI_HA_SCOPE_ATTR_FLOW_VERSION, /** - * @brief Action set_ha_scope_attr parameter FLOW_RECONCILE_REQUESTED + * @brief Action parameter flow reconcile requested * * @type bool * @flags CREATE_AND_SET @@ -254,7 +256,7 @@ typedef enum _sai_ha_scope_attr_t SAI_HA_SCOPE_ATTR_FLOW_RECONCILE_REQUESTED, /** - * @brief Action set_ha_scope_attr parameter FLOW_RECONCILE_NEEDED + * @brief Action parameter flow reconcile needed * * @type bool * @flags READ_ONLY @@ -275,7 +277,7 @@ typedef enum _sai_ha_scope_attr_t } sai_ha_scope_attr_t; /** - * @brief Create dash_ha_ha_set + * @brief Create HA set * * @param[out] ha_set_id Entry id * @param[in] switch_id Switch id @@ -291,7 +293,7 @@ typedef sai_status_t (*sai_create_ha_set_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_ha_ha_set + * @brief Remove HA set * * @param[in] ha_set_id Entry id * @@ -301,7 +303,7 @@ typedef sai_status_t (*sai_remove_ha_set_fn)( _In_ sai_object_id_t ha_set_id); /** - * @brief Set attribute for dash_ha_ha_set + * @brief Set attribute for HA set * * @param[in] ha_set_id Entry id * @param[in] attr Attribute @@ -313,7 +315,7 @@ typedef sai_status_t (*sai_set_ha_set_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_ha_ha_set + * @brief Get attribute for HA set * * @param[in] ha_set_id Entry id * @param[in] attr_count Number of attributes @@ -375,7 +377,7 @@ typedef sai_status_t (*sai_clear_ha_set_stats_fn)( _In_ const sai_stat_id_t *counter_ids); /** - * @brief Create dash_ha_ha_scope + * @brief Create HA scope * * @param[out] ha_scope_id Entry id * @param[in] switch_id Switch id @@ -391,7 +393,7 @@ typedef sai_status_t (*sai_create_ha_scope_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_ha_ha_scope + * @brief Remove HA scope * * @param[in] ha_scope_id Entry id * @@ -401,7 +403,7 @@ typedef sai_status_t (*sai_remove_ha_scope_fn)( _In_ sai_object_id_t ha_scope_id); /** - * @brief Set attribute for dash_ha_ha_scope + * @brief Set attribute for HA scope * * @param[in] ha_scope_id Entry id * @param[in] attr Attribute @@ -413,7 +415,7 @@ typedef sai_status_t (*sai_set_ha_scope_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_ha_ha_scope + * @brief Get attribute for HA scope * * @param[in] ha_scope_id Entry id * @param[in] attr_count Number of attributes diff --git a/experimental/saiexperimentaldashinboundrouting.h b/experimental/saiexperimentaldashinboundrouting.h index cb406683e..0ef00f5d1 100644 --- a/experimental/saiexperimentaldashinboundrouting.h +++ b/experimental/saiexperimentaldashinboundrouting.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHINBOUNDROUTING_H_) #define __SAIEXPERIMENTALDASHINBOUNDROUTING_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_INBOUND_ROUTING SAI - Experimental: DASH inbound routing specific API definitions + * @defgroup SAIEXPERIMENTALDASHINBOUNDROUTING SAI - Experimental: DASH inbound routing specific API definitions * * @{ */ @@ -80,7 +80,7 @@ typedef struct _sai_inbound_routing_entry_t sai_ip_address_t sip; /** - * @brief Ternary key sip mask + * @brief Ternary matched key sip mask */ sai_ip_address_t sip_mask; @@ -92,7 +92,7 @@ typedef struct _sai_inbound_routing_entry_t } sai_inbound_routing_entry_t; /** - * @brief Attribute ID for dash_inbound_routing_inbound_routing_entry + * @brief Attribute ID for inbound routing entry */ typedef enum _sai_inbound_routing_entry_attr_t { @@ -111,7 +111,7 @@ typedef enum _sai_inbound_routing_entry_attr_t SAI_INBOUND_ROUTING_ENTRY_ATTR_ACTION = SAI_INBOUND_ROUTING_ENTRY_ATTR_START, /** - * @brief Action tunnel_decap, tunnel_decap_pa_validate parameter METER_CLASS_OR + * @brief Action parameter meter class or * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -121,7 +121,7 @@ typedef enum _sai_inbound_routing_entry_attr_t SAI_INBOUND_ROUTING_ENTRY_ATTR_METER_CLASS_OR, /** - * @brief Action tunnel_decap, tunnel_decap_pa_validate parameter METER_CLASS_AND + * @brief Action parameter meter class and * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -131,7 +131,7 @@ typedef enum _sai_inbound_routing_entry_attr_t SAI_INBOUND_ROUTING_ENTRY_ATTR_METER_CLASS_AND, /** - * @brief Action tunnel_decap_pa_validate parameter SRC_VNET_ID + * @brief Action parameter src VNET id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -165,7 +165,7 @@ typedef enum _sai_inbound_routing_entry_attr_t } sai_inbound_routing_entry_attr_t; /** - * @brief Create dash_inbound_routing_inbound_routing_entry + * @brief Create inbound routing entry * * @param[in] inbound_routing_entry Entry * @param[in] attr_count Number of attributes @@ -179,7 +179,7 @@ typedef sai_status_t (*sai_create_inbound_routing_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_inbound_routing_inbound_routing_entry + * @brief Remove inbound routing entry * * @param[in] inbound_routing_entry Entry * @@ -189,7 +189,7 @@ typedef sai_status_t (*sai_remove_inbound_routing_entry_fn)( _In_ const sai_inbound_routing_entry_t *inbound_routing_entry); /** - * @brief Set attribute for dash_inbound_routing_inbound_routing_entry + * @brief Set attribute for inbound routing entry * * @param[in] inbound_routing_entry Entry * @param[in] attr Attribute @@ -201,7 +201,7 @@ typedef sai_status_t (*sai_set_inbound_routing_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_inbound_routing_inbound_routing_entry + * @brief Get attribute for inbound routing entry * * @param[in] inbound_routing_entry Entry * @param[in] attr_count Number of attributes @@ -215,7 +215,7 @@ typedef sai_status_t (*sai_get_inbound_routing_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_inbound_routing_inbound_routing_entry + * @brief Bulk create inbound routing entry * * @param[in] object_count Number of objects to create * @param[in] inbound_routing_entry List of object to create @@ -240,7 +240,7 @@ typedef sai_status_t (*sai_bulk_create_inbound_routing_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_inbound_routing_inbound_routing_entry + * @brief Bulk remove inbound routing entry * * @param[in] object_count Number of objects to remove * @param[in] inbound_routing_entry List of objects to remove diff --git a/experimental/saiexperimentaldashmeter.h b/experimental/saiexperimentaldashmeter.h index 6802baa98..44ec940f3 100644 --- a/experimental/saiexperimentaldashmeter.h +++ b/experimental/saiexperimentaldashmeter.h @@ -27,16 +27,16 @@ #if !defined (__SAIEXPERIMENTALDASHMETER_H_) #define __SAIEXPERIMENTALDASHMETER_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_METER SAI - Experimental: DASH meter specific API definitions + * @defgroup SAIEXPERIMENTALDASHMETER SAI - Experimental: DASH meter specific API definitions * * @{ */ /** - * @brief Attribute ID for dash_meter_meter_bucket + * @brief Attribute ID for meter bucket */ typedef enum _sai_meter_bucket_attr_t { @@ -76,7 +76,7 @@ typedef enum _sai_meter_bucket_attr_t } sai_meter_bucket_attr_t; /** - * @brief Counter IDs for meter_bucket in sai_get_meter_bucket_stats() call + * @brief Counter IDs for METER BUCKET */ typedef enum _sai_meter_bucket_stat_t { @@ -89,7 +89,7 @@ typedef enum _sai_meter_bucket_stat_t } sai_meter_bucket_stat_t; /** - * @brief Attribute ID for dash_meter_meter_policy + * @brief Attribute ID for meter policy */ typedef enum _sai_meter_policy_attr_t { @@ -99,7 +99,7 @@ typedef enum _sai_meter_policy_attr_t SAI_METER_POLICY_ATTR_START, /** - * @brief Action check_ip_addr_family parameter IP_ADDR_FAMILY + * @brief Action parameter IP address family * * @type sai_ip_addr_family_t * @flags CREATE_AND_SET @@ -122,7 +122,7 @@ typedef enum _sai_meter_policy_attr_t } sai_meter_policy_attr_t; /** - * @brief Attribute ID for dash_meter_meter_rule + * @brief Attribute ID for meter rule */ typedef enum _sai_meter_rule_attr_t { @@ -150,7 +150,7 @@ typedef enum _sai_meter_rule_attr_t SAI_METER_RULE_ATTR_DIP, /** - * @brief Ternary matched mask dip + * @brief Ternary matched key dip mask * * @type sai_ip_address_t * @flags MANDATORY_ON_CREATE | CREATE_ONLY @@ -158,7 +158,7 @@ typedef enum _sai_meter_rule_attr_t SAI_METER_RULE_ATTR_DIP_MASK, /** - * @brief Action set_policy_meter_class parameter METER_CLASS + * @brief Action parameter meter class * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -197,7 +197,7 @@ typedef enum _sai_meter_rule_attr_t } sai_meter_rule_attr_t; /** - * @brief Create dash_meter_meter_bucket + * @brief Create meter bucket * * @param[out] meter_bucket_id Entry id * @param[in] switch_id Switch id @@ -213,7 +213,7 @@ typedef sai_status_t (*sai_create_meter_bucket_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_meter_meter_bucket + * @brief Remove meter bucket * * @param[in] meter_bucket_id Entry id * @@ -223,7 +223,7 @@ typedef sai_status_t (*sai_remove_meter_bucket_fn)( _In_ sai_object_id_t meter_bucket_id); /** - * @brief Set attribute for dash_meter_meter_bucket + * @brief Set attribute for meter bucket * * @param[in] meter_bucket_id Entry id * @param[in] attr Attribute @@ -235,7 +235,7 @@ typedef sai_status_t (*sai_set_meter_bucket_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_meter_meter_bucket + * @brief Get attribute for meter bucket * * @param[in] meter_bucket_id Entry id * @param[in] attr_count Number of attributes @@ -249,7 +249,7 @@ typedef sai_status_t (*sai_get_meter_bucket_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Get meter_bucket statistics counters. Deprecated for backward compatibility. + * @brief Get METER_BUCKET statistics counters. Deprecated for backward compatibility. * * @param[in] meter_bucket_id Entry id * @param[in] number_of_counters Number of counters in the array @@ -265,7 +265,7 @@ typedef sai_status_t (*sai_get_meter_bucket_stats_fn)( _Out_ uint64_t *counters); /** - * @brief Get meter_bucket statistics counters extended. + * @brief Get METER_BUCKET statistics counters extended. * * @param[in] meter_bucket_id Entry id * @param[in] number_of_counters Number of counters in the array @@ -283,7 +283,7 @@ typedef sai_status_t (*sai_get_meter_bucket_stats_ext_fn)( _Out_ uint64_t *counters); /** - * @brief Clear meter_bucket statistics counters. + * @brief Clear METER_BUCKET statistics counters. * * @param[in] meter_bucket_id Entry id * @param[in] number_of_counters Number of counters in the array @@ -297,7 +297,7 @@ typedef sai_status_t (*sai_clear_meter_bucket_stats_fn)( _In_ const sai_stat_id_t *counter_ids); /** - * @brief Create dash_meter_meter_policy + * @brief Create meter policy * * @param[out] meter_policy_id Entry id * @param[in] switch_id Switch id @@ -313,7 +313,7 @@ typedef sai_status_t (*sai_create_meter_policy_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_meter_meter_policy + * @brief Remove meter policy * * @param[in] meter_policy_id Entry id * @@ -323,7 +323,7 @@ typedef sai_status_t (*sai_remove_meter_policy_fn)( _In_ sai_object_id_t meter_policy_id); /** - * @brief Set attribute for dash_meter_meter_policy + * @brief Set attribute for meter policy * * @param[in] meter_policy_id Entry id * @param[in] attr Attribute @@ -335,7 +335,7 @@ typedef sai_status_t (*sai_set_meter_policy_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_meter_meter_policy + * @brief Get attribute for meter policy * * @param[in] meter_policy_id Entry id * @param[in] attr_count Number of attributes @@ -349,7 +349,7 @@ typedef sai_status_t (*sai_get_meter_policy_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Create dash_meter_meter_rule + * @brief Create meter rule * * @param[out] meter_rule_id Entry id * @param[in] switch_id Switch id @@ -365,7 +365,7 @@ typedef sai_status_t (*sai_create_meter_rule_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_meter_meter_rule + * @brief Remove meter rule * * @param[in] meter_rule_id Entry id * @@ -375,7 +375,7 @@ typedef sai_status_t (*sai_remove_meter_rule_fn)( _In_ sai_object_id_t meter_rule_id); /** - * @brief Set attribute for dash_meter_meter_rule + * @brief Set attribute for meter rule * * @param[in] meter_rule_id Entry id * @param[in] attr Attribute @@ -387,7 +387,7 @@ typedef sai_status_t (*sai_set_meter_rule_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_meter_meter_rule + * @brief Get attribute for meter rule * * @param[in] meter_rule_id Entry id * @param[in] attr_count Number of attributes diff --git a/experimental/saiexperimentaldashoutboundcatopa.h b/experimental/saiexperimentaldashoutboundcatopa.h index f497229f8..7ee2c309f 100644 --- a/experimental/saiexperimentaldashoutboundcatopa.h +++ b/experimental/saiexperimentaldashoutboundcatopa.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHOUTBOUNDCATOPA_H_) #define __SAIEXPERIMENTALDASHOUTBOUNDCATOPA_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_OUTBOUND_CA_TO_PA SAI - Experimental: DASH outbound CA to PA specific API definitions + * @defgroup SAIEXPERIMENTALDASHOUTBOUNDCATOPA SAI - Experimental: DASH outbound CA to PA specific API definitions * * @{ */ @@ -73,7 +73,7 @@ typedef struct _sai_outbound_ca_to_pa_entry_t } sai_outbound_ca_to_pa_entry_t; /** - * @brief Attribute ID for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Attribute ID for outbound CA to PA entry */ typedef enum _sai_outbound_ca_to_pa_entry_attr_t { @@ -92,7 +92,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION = SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_START, /** - * @brief Action set_tunnel_mapping, set_private_link_mapping parameter UNDERLAY_DIP + * @brief Action parameter underlay dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -102,17 +102,17 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_UNDERLAY_DIP, /** - * @brief Action set_tunnel_mapping parameter OVERLAY_DMAC + * @brief Action parameter overlay destination MAC * * @type sai_mac_t * @flags CREATE_AND_SET - * @default 00:00:00:00:00:00 + * @default vendor * @validonly SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING */ SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DMAC, /** - * @brief Action set_tunnel_mapping parameter USE_DST_VNET_VNI + * @brief Action parameter use dst VNET VNI * * @type bool * @flags CREATE_AND_SET @@ -122,7 +122,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_USE_DST_VNET_VNI, /** - * @brief Action set_tunnel_mapping, set_private_link_mapping parameter METER_CLASS_OR + * @brief Action parameter meter class or * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -132,7 +132,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_METER_CLASS_OR, /** - * @brief Action set_tunnel_mapping, set_private_link_mapping parameter DASH_TUNNEL_ID + * @brief Action parameter DASH tunnel id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -144,7 +144,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_DASH_TUNNEL_ID, /** - * @brief Action set_tunnel_mapping, set_private_link_mapping parameter FLOW_RESIMULATION_REQUESTED + * @brief Action parameter flow re-simulation requested * * @type bool * @flags CREATE_AND_SET @@ -154,7 +154,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_FLOW_RESIMULATION_REQUESTED, /** - * @brief Action set_tunnel_mapping, set_private_link_mapping parameter ROUTING_ACTIONS_DISABLED_IN_FLOW_RESIMULATION + * @brief Action parameter routing actions disabled in flow re-simulation * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -164,7 +164,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ROUTING_ACTIONS_DISABLED_IN_FLOW_RESIMULATION, /** - * @brief Action set_private_link_mapping parameter OVERLAY_SIP + * @brief Action parameter overlay sip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -174,7 +174,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_SIP, /** - * @brief Action set_private_link_mapping parameter OVERLAY_SIP_MASK + * @brief Action parameter overlay sip mask * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -184,7 +184,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_SIP_MASK, /** - * @brief Action set_private_link_mapping parameter OVERLAY_DIP + * @brief Action parameter overlay dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -194,7 +194,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DIP, /** - * @brief Action set_private_link_mapping parameter OVERLAY_DIP_MASK + * @brief Action parameter overlay dip mask * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -204,7 +204,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DIP_MASK, /** - * @brief Action set_private_link_mapping parameter DASH_ENCAPSULATION + * @brief Action parameter DASH encapsulation * * @type sai_dash_encapsulation_t * @flags CREATE_AND_SET @@ -214,7 +214,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_DASH_ENCAPSULATION, /** - * @brief Action set_private_link_mapping parameter TUNNEL_KEY + * @brief Action parameter tunnel key * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -224,9 +224,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_TUNNEL_KEY, /** - * @brief Attach a counter - * - * When it is empty, then packet hits won't be counted + * @brief Attach a counter. When it is empty, then packet hits won't be counted. * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -259,7 +257,7 @@ typedef enum _sai_outbound_ca_to_pa_entry_attr_t } sai_outbound_ca_to_pa_entry_attr_t; /** - * @brief Create dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Create outbound CA to PA entry * * @param[in] outbound_ca_to_pa_entry Entry * @param[in] attr_count Number of attributes @@ -273,7 +271,7 @@ typedef sai_status_t (*sai_create_outbound_ca_to_pa_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Remove outbound CA to PA entry * * @param[in] outbound_ca_to_pa_entry Entry * @@ -283,7 +281,7 @@ typedef sai_status_t (*sai_remove_outbound_ca_to_pa_entry_fn)( _In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry); /** - * @brief Set attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Set attribute for outbound CA to PA entry * * @param[in] outbound_ca_to_pa_entry Entry * @param[in] attr Attribute @@ -295,7 +293,7 @@ typedef sai_status_t (*sai_set_outbound_ca_to_pa_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Get attribute for outbound CA to PA entry * * @param[in] outbound_ca_to_pa_entry Entry * @param[in] attr_count Number of attributes @@ -309,7 +307,7 @@ typedef sai_status_t (*sai_get_outbound_ca_to_pa_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Bulk create outbound CA to PA entry * * @param[in] object_count Number of objects to create * @param[in] outbound_ca_to_pa_entry List of object to create @@ -334,7 +332,7 @@ typedef sai_status_t (*sai_bulk_create_outbound_ca_to_pa_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry + * @brief Bulk remove outbound CA to PA entry * * @param[in] object_count Number of objects to remove * @param[in] outbound_ca_to_pa_entry List of objects to remove diff --git a/experimental/saiexperimentaldashoutboundrouting.h b/experimental/saiexperimentaldashoutboundrouting.h index fa0d1e206..6915ddb45 100644 --- a/experimental/saiexperimentaldashoutboundrouting.h +++ b/experimental/saiexperimentaldashoutboundrouting.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHOUTBOUNDROUTING_H_) #define __SAIEXPERIMENTALDASHOUTBOUNDROUTING_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_OUTBOUND_ROUTING SAI - Experimental: DASH outbound routing specific API definitions + * @defgroup SAIEXPERIMENTALDASHOUTBOUNDROUTING SAI - Experimental: DASH outbound routing specific API definitions * * @{ */ @@ -79,7 +79,7 @@ typedef struct _sai_outbound_routing_entry_t } sai_outbound_routing_entry_t; /** - * @brief Attribute ID for dash_outbound_routing_outbound_routing_entry + * @brief Attribute ID for outbound routing entry */ typedef enum _sai_outbound_routing_entry_attr_t { @@ -98,7 +98,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_ACTION = SAI_OUTBOUND_ROUTING_ENTRY_ATTR_START, /** - * @brief Action route_vnet, route_vnet_direct parameter DST_VNET_ID + * @brief Action parameter dst VNET id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -110,7 +110,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_DST_VNET_ID, /** - * @brief Action route_vnet, route_vnet_direct, route_direct, route_service_tunnel parameter DASH_TUNNEL_ID + * @brief Action parameter DASH tunnel id * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -122,7 +122,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_DASH_TUNNEL_ID, /** - * @brief Action route_vnet, route_vnet_direct, route_direct, route_service_tunnel parameter METER_CLASS_OR + * @brief Action parameter meter class or * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -132,7 +132,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_METER_CLASS_OR, /** - * @brief Action route_vnet, route_vnet_direct, route_direct, route_service_tunnel parameter METER_CLASS_AND + * @brief Action parameter meter class and * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -142,7 +142,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_METER_CLASS_AND, /** - * @brief Action route_vnet, route_vnet_direct, route_direct, route_service_tunnel parameter ROUTING_ACTIONS_DISABLED_IN_FLOW_RESIMULATION + * @brief Action parameter routing actions disabled in flow re-simulation * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -152,7 +152,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_ROUTING_ACTIONS_DISABLED_IN_FLOW_RESIMULATION, /** - * @brief Action route_vnet_direct parameter OVERLAY_IP + * @brief Action parameter overlay IP * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -162,7 +162,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_OVERLAY_IP, /** - * @brief Action route_service_tunnel parameter OVERLAY_DIP + * @brief Action parameter overlay dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -172,7 +172,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_OVERLAY_DIP, /** - * @brief Action route_service_tunnel parameter OVERLAY_DIP_MASK + * @brief Action parameter overlay dip mask * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -192,7 +192,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_OVERLAY_SIP, /** - * @brief Action route_service_tunnel parameter OVERLAY_SIP_MASK + * @brief Action parameter overlay sip mask * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -202,7 +202,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_OVERLAY_SIP_MASK, /** - * @brief Action route_service_tunnel parameter UNDERLAY_DIP + * @brief Action parameter underlay dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -212,7 +212,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_UNDERLAY_DIP, /** - * @brief Action route_service_tunnel parameter UNDERLAY_SIP + * @brief Action parameter underlay sip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -222,7 +222,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_UNDERLAY_SIP, /** - * @brief Action route_service_tunnel parameter DASH_ENCAPSULATION + * @brief Action parameter DASH encapsulation * * @type sai_dash_encapsulation_t * @flags CREATE_AND_SET @@ -232,7 +232,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_DASH_ENCAPSULATION, /** - * @brief Action route_service_tunnel parameter TUNNEL_KEY + * @brief Action parameter tunnel key * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -242,9 +242,7 @@ typedef enum _sai_outbound_routing_entry_attr_t SAI_OUTBOUND_ROUTING_ENTRY_ATTR_TUNNEL_KEY, /** - * @brief Attach a counter - * - * When it is empty, then packet hits won't be counted + * @brief Attach a counter. When it is empty, then packet hits won't be counted. * * @type sai_object_id_t * @flags CREATE_AND_SET @@ -323,7 +321,7 @@ typedef sai_status_t (*sai_create_outbound_routing_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_outbound_routing_outbound_routing_entry + * @brief Remove outbound routing entry * * @param[in] outbound_routing_entry Entry * @@ -333,7 +331,7 @@ typedef sai_status_t (*sai_remove_outbound_routing_entry_fn)( _In_ const sai_outbound_routing_entry_t *outbound_routing_entry); /** - * @brief Set attribute for dash_outbound_routing_outbound_routing_entry + * @brief Set attribute for outbound routing entry * * @param[in] outbound_routing_entry Entry * @param[in] attr Attribute @@ -345,7 +343,7 @@ typedef sai_status_t (*sai_set_outbound_routing_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_outbound_routing_outbound_routing_entry + * @brief Get attribute for outbound routing entry * * @param[in] outbound_routing_entry Entry * @param[in] attr_count Number of attributes @@ -359,7 +357,7 @@ typedef sai_status_t (*sai_get_outbound_routing_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_outbound_routing_outbound_routing_entry + * @brief Bulk create outbound routing entry * * @param[in] object_count Number of objects to create * @param[in] outbound_routing_entry List of object to create @@ -384,7 +382,7 @@ typedef sai_status_t (*sai_bulk_create_outbound_routing_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_outbound_routing_outbound_routing_entry + * @brief Bulk remove outbound routing entry * * @param[in] object_count Number of objects to remove * @param[in] outbound_routing_entry List of objects to remove diff --git a/experimental/saiexperimentaldashpavalidation.h b/experimental/saiexperimentaldashpavalidation.h index dd4985a71..885d6c542 100644 --- a/experimental/saiexperimentaldashpavalidation.h +++ b/experimental/saiexperimentaldashpavalidation.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHPAVALIDATION_H_) #define __SAIEXPERIMENTALDASHPAVALIDATION_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_PA_VALIDATION SAI - Experimental: DASH PA validation specific API definitions + * @defgroup SAIEXPERIMENTALDASHPAVALIDATION SAI - Experimental: DASH PA validation specific API definitions * * @{ */ @@ -71,7 +71,7 @@ typedef struct _sai_pa_validation_entry_t } sai_pa_validation_entry_t; /** - * @brief Attribute ID for dash_pa_validation_pa_validation_entry + * @brief Attribute ID for PA validation entry */ typedef enum _sai_pa_validation_entry_attr_t { @@ -112,7 +112,7 @@ typedef enum _sai_pa_validation_entry_attr_t } sai_pa_validation_entry_attr_t; /** - * @brief Create dash_pa_validation_pa_validation_entry + * @brief Create PA validation entry * * @param[in] pa_validation_entry Entry * @param[in] attr_count Number of attributes @@ -126,7 +126,7 @@ typedef sai_status_t (*sai_create_pa_validation_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_pa_validation_pa_validation_entry + * @brief Remove PA validation entry * * @param[in] pa_validation_entry Entry * @@ -136,7 +136,7 @@ typedef sai_status_t (*sai_remove_pa_validation_entry_fn)( _In_ const sai_pa_validation_entry_t *pa_validation_entry); /** - * @brief Set attribute for dash_pa_validation_pa_validation_entry + * @brief Set attribute for PA validation entry * * @param[in] pa_validation_entry Entry * @param[in] attr Attribute @@ -148,7 +148,7 @@ typedef sai_status_t (*sai_set_pa_validation_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_pa_validation_pa_validation_entry + * @brief Get attribute for PA validation entry * * @param[in] pa_validation_entry Entry * @param[in] attr_count Number of attributes @@ -162,7 +162,7 @@ typedef sai_status_t (*sai_get_pa_validation_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_pa_validation_pa_validation_entry + * @brief Bulk create PA validation entry * * @param[in] object_count Number of objects to create * @param[in] pa_validation_entry List of object to create @@ -187,7 +187,7 @@ typedef sai_status_t (*sai_bulk_create_pa_validation_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_pa_validation_pa_validation_entry + * @brief Bulk remove PA validation entry * * @param[in] object_count Number of objects to remove * @param[in] pa_validation_entry List of objects to remove diff --git a/experimental/saiexperimentaldashtunnel.h b/experimental/saiexperimentaldashtunnel.h index a7a7adffa..3702c077b 100644 --- a/experimental/saiexperimentaldashtunnel.h +++ b/experimental/saiexperimentaldashtunnel.h @@ -19,7 +19,7 @@ * * @file saiexperimentaldashtunnel.h * - * @brief This module defines SAI extensions for DASH TUNNEL + * @brief This module defines SAI extensions for DASH tunnel * * @warning This module is a SAI experimental module */ @@ -30,13 +30,13 @@ #include /** - * @defgroup SAIEXPERIMENTALDASH_TUNNEL SAI - Experimental: DASH TUNNEL specific API definitions + * @defgroup SAIEXPERIMENTALDASHTUNNEL SAI - Experimental: DASH tunnel specific API definitions * * @{ */ /** - * @brief Attribute ID for dash_tunnel_dash_tunnel + * @brief Attribute ID for DASH tunnel */ typedef enum _sai_dash_tunnel_attr_t { @@ -46,7 +46,7 @@ typedef enum _sai_dash_tunnel_attr_t SAI_DASH_TUNNEL_ATTR_START, /** - * @brief Action set_tunnel_attrs parameter DIP + * @brief Action parameter dip * * @type sai_ip_address_t * @flags CREATE_AND_SET @@ -55,7 +55,7 @@ typedef enum _sai_dash_tunnel_attr_t SAI_DASH_TUNNEL_ATTR_DIP = SAI_DASH_TUNNEL_ATTR_START, /** - * @brief Action set_tunnel_attrs parameter DASH_ENCAPSULATION + * @brief Action parameter DASH encapsulation * * @type sai_dash_encapsulation_t * @flags CREATE_AND_SET @@ -64,7 +64,7 @@ typedef enum _sai_dash_tunnel_attr_t SAI_DASH_TUNNEL_ATTR_DASH_ENCAPSULATION, /** - * @brief Action set_tunnel_attrs parameter TUNNEL_KEY + * @brief Action parameter tunnel key * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -86,7 +86,7 @@ typedef enum _sai_dash_tunnel_attr_t } sai_dash_tunnel_attr_t; /** - * @brief Create dash_tunnel_dash_tunnel + * @brief Create DASH tunnel * * @param[out] dash_tunnel_id Entry id * @param[in] switch_id Switch id @@ -102,7 +102,7 @@ typedef sai_status_t (*sai_create_dash_tunnel_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_tunnel_dash_tunnel + * @brief Remove DASH tunnel * * @param[in] dash_tunnel_id Entry id * @@ -112,7 +112,7 @@ typedef sai_status_t (*sai_remove_dash_tunnel_fn)( _In_ sai_object_id_t dash_tunnel_id); /** - * @brief Set attribute for dash_tunnel_dash_tunnel + * @brief Set attribute for DASH tunnel * * @param[in] dash_tunnel_id Entry id * @param[in] attr Attribute @@ -124,7 +124,7 @@ typedef sai_status_t (*sai_set_dash_tunnel_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_tunnel_dash_tunnel + * @brief Get attribute for DASH tunnel * * @param[in] dash_tunnel_id Entry id * @param[in] attr_count Number of attributes diff --git a/experimental/saiexperimentaldashvip.h b/experimental/saiexperimentaldashvip.h index cebac63cd..701081c82 100644 --- a/experimental/saiexperimentaldashvip.h +++ b/experimental/saiexperimentaldashvip.h @@ -27,10 +27,10 @@ #if !defined (__SAIEXPERIMENTALDASHVIP_H_) #define __SAIEXPERIMENTALDASHVIP_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_VIP SAI - Experimental: DASH VIP specific API definitions + * @defgroup SAIEXPERIMENTALDASHVIP SAI - Experimental: DASH VIP specific API definitions * * @{ */ @@ -64,7 +64,7 @@ typedef struct _sai_vip_entry_t } sai_vip_entry_t; /** - * @brief Attribute ID for dash_vip_vip_entry + * @brief Attribute ID for VIP entry */ typedef enum _sai_vip_entry_attr_t { @@ -105,7 +105,7 @@ typedef enum _sai_vip_entry_attr_t } sai_vip_entry_attr_t; /** - * @brief Create dash_vip_vip_entry + * @brief Create VIP entry * * @param[in] vip_entry Entry * @param[in] attr_count Number of attributes @@ -119,7 +119,7 @@ typedef sai_status_t (*sai_create_vip_entry_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_vip_vip_entry + * @brief Remove VIP entry * * @param[in] vip_entry Entry * @@ -129,7 +129,7 @@ typedef sai_status_t (*sai_remove_vip_entry_fn)( _In_ const sai_vip_entry_t *vip_entry); /** - * @brief Set attribute for dash_vip_vip_entry + * @brief Set attribute for VIP entry * * @param[in] vip_entry Entry * @param[in] attr Attribute @@ -141,7 +141,7 @@ typedef sai_status_t (*sai_set_vip_entry_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_vip_vip_entry + * @brief Get attribute for VIP entry * * @param[in] vip_entry Entry * @param[in] attr_count Number of attributes @@ -155,7 +155,7 @@ typedef sai_status_t (*sai_get_vip_entry_attribute_fn)( _Inout_ sai_attribute_t *attr_list); /** - * @brief Bulk create dash_vip_vip_entry + * @brief Bulk create VIP entry * * @param[in] object_count Number of objects to create * @param[in] vip_entry List of object to create @@ -180,7 +180,7 @@ typedef sai_status_t (*sai_bulk_create_vip_entry_fn)( _Out_ sai_status_t *object_statuses); /** - * @brief Bulk remove dash_vip_vip_entry + * @brief Bulk remove VIP entry * * @param[in] object_count Number of objects to remove * @param[in] vip_entry List of objects to remove diff --git a/experimental/saiexperimentaldashvnet.h b/experimental/saiexperimentaldashvnet.h index 00c1b1774..75e9ef919 100644 --- a/experimental/saiexperimentaldashvnet.h +++ b/experimental/saiexperimentaldashvnet.h @@ -27,16 +27,16 @@ #if !defined (__SAIEXPERIMENTALDASHVNET_H_) #define __SAIEXPERIMENTALDASHVNET_H_ -#include +#include /** - * @defgroup SAIEXPERIMENTALDASH_VNET SAI - Experimental: DASH VNET specific API definitions + * @defgroup SAIEXPERIMENTALDASHVNET SAI - Experimental: DASH VNET specific API definitions * * @{ */ /** - * @brief Attribute ID for dash_vnet_vnet + * @brief Attribute ID for VNET */ typedef enum _sai_vnet_attr_t { @@ -46,7 +46,7 @@ typedef enum _sai_vnet_attr_t SAI_VNET_ATTR_START, /** - * @brief Action set_vnet_attrs parameter VNI + * @brief Action parameter VNI * * @type sai_uint32_t * @flags CREATE_AND_SET @@ -68,7 +68,7 @@ typedef enum _sai_vnet_attr_t } sai_vnet_attr_t; /** - * @brief Create dash_vnet_vnet + * @brief Create VNET * * @param[out] vnet_id Entry id * @param[in] switch_id Switch id @@ -84,7 +84,7 @@ typedef sai_status_t (*sai_create_vnet_fn)( _In_ const sai_attribute_t *attr_list); /** - * @brief Remove dash_vnet_vnet + * @brief Remove VNET * * @param[in] vnet_id Entry id * @@ -94,7 +94,7 @@ typedef sai_status_t (*sai_remove_vnet_fn)( _In_ sai_object_id_t vnet_id); /** - * @brief Set attribute for dash_vnet_vnet + * @brief Set attribute for VNET * * @param[in] vnet_id Entry id * @param[in] attr Attribute @@ -106,7 +106,7 @@ typedef sai_status_t (*sai_set_vnet_attribute_fn)( _In_ const sai_attribute_t *attr); /** - * @brief Get attribute for dash_vnet_vnet + * @brief Get attribute for VNET * * @param[in] vnet_id Entry id * @param[in] attr_count Number of attributes