saiipsec.h

Go to the documentation of this file.

 
#if !defined (__SAIIPSEC_H_)
#define __SAIIPSEC_H_
 
#include <saitypes.h>
 
typedef enum _sai_ipsec_direction_t
{
    SAI_IPSEC_DIRECTION_EGRESS,
    SAI_IPSEC_DIRECTION_INGRESS,
} sai_ipsec_direction_t;
 
typedef enum _sai_ipsec_cipher_t
{
    SAI_IPSEC_CIPHER_AES128_GCM16,
    SAI_IPSEC_CIPHER_AES256_GCM16,
    SAI_IPSEC_CIPHER_AES128_GMAC,
    SAI_IPSEC_CIPHER_AES256_GMAC,
} sai_ipsec_cipher_t;
 
typedef enum _sai_ipsec_sa_octet_count_status_t
{
    SAI_IPSEC_SA_OCTET_COUNT_STATUS_BELOW_LOW_WATERMARK,
 
    SAI_IPSEC_SA_OCTET_COUNT_STATUS_BELOW_HIGH_WATERMARK,
 
    SAI_IPSEC_SA_OCTET_COUNT_STATUS_ABOVE_HIGH_WATERMARK,
 
} sai_ipsec_sa_octet_count_status_t;
 
typedef struct _sai_ipsec_sa_status_notification_t
{
    sai_object_id_t ipsec_sa_id;
 
    sai_ipsec_sa_octet_count_status_t ipsec_sa_octet_count_status;
 
    bool ipsec_egress_sn_at_max_limit;
 
} sai_ipsec_sa_status_notification_t;
 
typedef enum _sai_ipsec_attr_t
{
    SAI_IPSEC_ATTR_START,
 
    SAI_IPSEC_ATTR_TERM_REMOTE_IP_MATCH_SUPPORTED = SAI_IPSEC_ATTR_START,
 
    SAI_IPSEC_ATTR_SWITCHING_MODE_CUT_THROUGH_SUPPORTED,
 
    SAI_IPSEC_ATTR_SWITCHING_MODE_STORE_AND_FORWARD_SUPPORTED,
 
    SAI_IPSEC_ATTR_STATS_MODE_READ_SUPPORTED,
 
    SAI_IPSEC_ATTR_STATS_MODE_READ_CLEAR_SUPPORTED,
 
    SAI_IPSEC_ATTR_SN_32BIT_SUPPORTED,
 
    SAI_IPSEC_ATTR_ESN_64BIT_SUPPORTED,
 
    SAI_IPSEC_ATTR_SUPPORTED_CIPHER_LIST,
 
    SAI_IPSEC_ATTR_SYSTEM_SIDE_MTU,
 
    SAI_IPSEC_ATTR_WARM_BOOT_SUPPORTED,
 
    SAI_IPSEC_ATTR_WARM_BOOT_ENABLE,
 
    SAI_IPSEC_ATTR_EXTERNAL_SA_INDEX_ENABLE,
 
    SAI_IPSEC_ATTR_CTAG_TPID,
 
    SAI_IPSEC_ATTR_STAG_TPID,
 
    SAI_IPSEC_ATTR_MAX_VLAN_TAGS_PARSED,
 
    SAI_IPSEC_ATTR_OCTET_COUNT_HIGH_WATERMARK,
 
    SAI_IPSEC_ATTR_OCTET_COUNT_LOW_WATERMARK,
 
    SAI_IPSEC_ATTR_STATS_MODE,
 
    SAI_IPSEC_ATTR_AVAILABLE_IPSEC_SA,
 
    SAI_IPSEC_ATTR_SA_LIST,
 
    SAI_IPSEC_ATTR_END,
 
    SAI_IPSEC_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_IPSEC_ATTR_CUSTOM_RANGE_END
} sai_ipsec_attr_t;
 
typedef enum _sai_ipsec_port_attr_t
{
    SAI_IPSEC_PORT_ATTR_START,
 
    SAI_IPSEC_PORT_ATTR_PORT_ID = SAI_IPSEC_PORT_ATTR_START,
 
    SAI_IPSEC_PORT_ATTR_CTAG_ENABLE,
 
    SAI_IPSEC_PORT_ATTR_STAG_ENABLE,
 
    SAI_IPSEC_PORT_ATTR_NATIVE_VLAN_ID,
 
    SAI_IPSEC_PORT_ATTR_VRF_FROM_PACKET_VLAN_ENABLE,
 
    SAI_IPSEC_PORT_ATTR_SWITCH_SWITCHING_MODE,
 
    SAI_IPSEC_PORT_ATTR_END,
 
    SAI_IPSEC_PORT_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_IPSEC_PORT_ATTR_CUSTOM_RANGE_END
} sai_ipsec_port_attr_t;
 
typedef enum _sai_ipsec_port_stat_t
{
    SAI_IPSEC_PORT_STAT_TX_ERROR_PKTS,
 
    SAI_IPSEC_PORT_STAT_TX_IPSEC_PKTS,
 
    SAI_IPSEC_PORT_STAT_TX_NON_IPSEC_PKTS,
 
    SAI_IPSEC_PORT_STAT_RX_ERROR_PKTS,
 
    SAI_IPSEC_PORT_STAT_RX_IPSEC_PKTS,
 
    SAI_IPSEC_PORT_STAT_RX_NON_IPSEC_PKTS,
} sai_ipsec_port_stat_t;
 
typedef enum _sai_ipsec_sa_attr_t
{
    SAI_IPSEC_SA_ATTR_START,
 
    SAI_IPSEC_SA_ATTR_IPSEC_DIRECTION = SAI_IPSEC_SA_ATTR_START,
 
    SAI_IPSEC_SA_ATTR_IPSEC_ID,
 
    SAI_IPSEC_SA_ATTR_OCTET_COUNT_STATUS,
 
    SAI_IPSEC_SA_ATTR_EXTERNAL_SA_INDEX,
 
    SAI_IPSEC_SA_ATTR_SA_INDEX,
 
    SAI_IPSEC_SA_ATTR_IPSEC_PORT_LIST,
 
    SAI_IPSEC_SA_ATTR_IPSEC_SPI,
 
    SAI_IPSEC_SA_ATTR_IPSEC_ESN_ENABLE,
 
    SAI_IPSEC_SA_ATTR_IPSEC_CIPHER,
 
    SAI_IPSEC_SA_ATTR_ENCRYPT_KEY,
 
    SAI_IPSEC_SA_ATTR_SALT,
 
    SAI_IPSEC_SA_ATTR_AUTH_KEY,
 
    SAI_IPSEC_SA_ATTR_IPSEC_REPLAY_PROTECTION_ENABLE,
 
    SAI_IPSEC_SA_ATTR_IPSEC_REPLAY_PROTECTION_WINDOW,
 
    SAI_IPSEC_SA_ATTR_TERM_DST_IP,
 
    SAI_IPSEC_SA_ATTR_TERM_VLAN_ID_ENABLE,
 
    SAI_IPSEC_SA_ATTR_TERM_VLAN_ID,
 
    SAI_IPSEC_SA_ATTR_TERM_SRC_IP_ENABLE,
 
    SAI_IPSEC_SA_ATTR_TERM_SRC_IP,
 
    SAI_IPSEC_SA_ATTR_EGRESS_ESN,
 
    SAI_IPSEC_SA_ATTR_MINIMUM_INGRESS_ESN,
 
    SAI_IPSEC_SA_ATTR_END,
 
    SAI_IPSEC_SA_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_IPSEC_SA_ATTR_CUSTOM_RANGE_END
} sai_ipsec_sa_attr_t;
 
typedef enum _sai_ipsec_sa_stat_t
{
    SAI_IPSEC_SA_STAT_PROTECTED_OCTETS,
 
    SAI_IPSEC_SA_STAT_PROTECTED_PKTS,
 
    SAI_IPSEC_SA_STAT_GOOD_PKTS,
 
    SAI_IPSEC_SA_STAT_BAD_HEADER_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_REPLAYED_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_LATE_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_BAD_TRAILER_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_AUTH_FAIL_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_DUMMY_DROPPED_PKTS_IN,
 
    SAI_IPSEC_SA_STAT_OTHER_DROPPED_PKTS,
} sai_ipsec_sa_stat_t;
 
typedef sai_status_t (*sai_create_ipsec_fn)(
        _Out_ sai_object_id_t *ipsec_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_remove_ipsec_fn)(
        _In_ sai_object_id_t ipsec_id);
 
typedef sai_status_t (*sai_set_ipsec_attribute_fn)(
        _In_ sai_object_id_t ipsec_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_ipsec_attribute_fn)(
        _In_ sai_object_id_t ipsec_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_create_ipsec_port_fn)(
        _Out_ sai_object_id_t *ipsec_port_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_remove_ipsec_port_fn)(
        _In_ sai_object_id_t ipsec_port_id);
 
typedef sai_status_t (*sai_set_ipsec_port_attribute_fn)(
        _In_ sai_object_id_t ipsec_port_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_ipsec_port_attribute_fn)(
        _In_ sai_object_id_t ipsec_port_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_get_ipsec_port_stats_fn)(
        _In_ sai_object_id_t ipsec_port_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_get_ipsec_port_stats_ext_fn)(
        _In_ sai_object_id_t ipsec_port_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _In_ sai_stats_mode_t mode,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_clear_ipsec_port_stats_fn)(
        _In_ sai_object_id_t ipsec_port_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids);
 
typedef sai_status_t (*sai_create_ipsec_sa_fn)(
        _Out_ sai_object_id_t *ipsec_sa_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_remove_ipsec_sa_fn)(
        _In_ sai_object_id_t ipsec_sa_id);
 
typedef sai_status_t (*sai_set_ipsec_sa_attribute_fn)(
        _In_ sai_object_id_t ipsec_sa_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_ipsec_sa_attribute_fn)(
        _In_ sai_object_id_t ipsec_sa_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_get_ipsec_sa_stats_fn)(
        _In_ sai_object_id_t ipsec_sa_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_get_ipsec_sa_stats_ext_fn)(
        _In_ sai_object_id_t ipsec_sa_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _In_ sai_stats_mode_t mode,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_clear_ipsec_sa_stats_fn)(
        _In_ sai_object_id_t ipsec_sa_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids);
 
typedef void (*sai_ipsec_sa_status_change_notification_fn)(
        _In_ uint32_t count,
        _In_ const sai_ipsec_sa_status_notification_t *data);
 
typedef struct _sai_ipsec_api_t
{
    sai_create_ipsec_fn                create_ipsec;
    sai_remove_ipsec_fn                remove_ipsec;
    sai_set_ipsec_attribute_fn         set_ipsec_attribute;
    sai_get_ipsec_attribute_fn         get_ipsec_attribute;
    sai_create_ipsec_port_fn           create_ipsec_port;
    sai_remove_ipsec_port_fn           remove_ipsec_port;
    sai_set_ipsec_port_attribute_fn    set_ipsec_port_attribute;
    sai_get_ipsec_port_attribute_fn    get_ipsec_port_attribute;
    sai_get_ipsec_port_stats_fn        get_ipsec_port_stats;
    sai_get_ipsec_port_stats_ext_fn    get_ipsec_port_stats_ext;
    sai_clear_ipsec_port_stats_fn      clear_ipsec_port_stats;
    sai_create_ipsec_sa_fn             create_ipsec_sa;
    sai_remove_ipsec_sa_fn             remove_ipsec_sa;
    sai_set_ipsec_sa_attribute_fn      set_ipsec_sa_attribute;
    sai_get_ipsec_sa_attribute_fn      get_ipsec_sa_attribute;
    sai_get_ipsec_sa_stats_fn          get_ipsec_sa_stats;
    sai_get_ipsec_sa_stats_ext_fn      get_ipsec_sa_stats_ext;
    sai_clear_ipsec_sa_stats_fn        clear_ipsec_sa_stats;
} sai_ipsec_api_t;
 
#endif