saitwamp.h

Go to the documentation of this file.

 
#if !defined (__SAITWAMP_H_)
#define __SAITWAMP_H_
 
#include <saitypes.h>
 
typedef enum _sai_twamp_session_auth_mode_t
{
    SAI_TWAMP_SESSION_AUTH_MODE_UNAUTHENTICATED = 0,
 
    SAI_TWAMP_SESSION_AUTH_MODE_AUTHENTICATED,
 
    SAI_TWAMP_SESSION_AUTH_MODE_ENCRYPTED
 
} sai_twamp_session_auth_mode_t;
 
typedef enum _sai_twamp_session_role_t
{
    SAI_TWAMP_SESSION_ROLE_SENDER = 0,
 
    SAI_TWAMP_SESSION_ROLE_REFLECTOR
 
} sai_twamp_session_role_t;
 
typedef enum _sai_twamp_mode_t
{
    SAI_TWAMP_MODE_FULL = 0,
 
    SAI_TWAMP_MODE_LIGHT
 
} sai_twamp_mode_t;
 
typedef enum _sai_twamp_pkt_tx_mode_t
{
    SAI_TWAMP_PKT_TX_MODE_CONTINUOUS = 0,
 
    SAI_TWAMP_PKT_TX_MODE_PACKET_COUNT,
 
    SAI_TWAMP_PKT_TX_MODE_PERIOD
 
} sai_twamp_pkt_tx_mode_t;
 
typedef enum _sai_twamp_timestamp_format_t
{
    SAI_TWAMP_TIMESTAMP_FORMAT_NTP = 0,
 
    SAI_TWAMP_TIMESTAMP_FORMAT_PTP
 
} sai_twamp_timestamp_format_t;
 
typedef enum _sai_twamp_encapsulation_type_t
{
    SAI_TWAMP_ENCAPSULATION_TYPE_IP = 0,
 
    SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN,
 
    SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN,
 
    SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
 
} sai_twamp_encapsulation_type_t;
 
typedef enum _sai_twamp_session_attr_t
{
    SAI_TWAMP_SESSION_ATTR_START,
 
    SAI_TWAMP_SESSION_ATTR_TWAMP_MODE = SAI_TWAMP_SESSION_ATTR_START,
 
    SAI_TWAMP_SESSION_ATTR_SESSION_ROLE,
 
    SAI_TWAMP_SESSION_ATTR_AUTH_MODE,
 
    SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID,
 
    SAI_TWAMP_SESSION_ATTR_VIRTUAL_ROUTER,
 
    SAI_TWAMP_SESSION_ATTR_SRC_MAC,
 
    SAI_TWAMP_SESSION_ATTR_DST_MAC,
 
    SAI_TWAMP_SESSION_ATTR_VLAN_ID,
 
    SAI_TWAMP_SESSION_ATTR_VLAN_PRI,
 
    SAI_TWAMP_SESSION_ATTR_VLAN_CFI,
 
    SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID,
 
    SAI_TWAMP_SESSION_ATTR_SRC_IP,
 
    SAI_TWAMP_SESSION_ATTR_DST_IP,
 
    SAI_TWAMP_SESSION_ATTR_UDP_SRC_PORT,
 
    SAI_TWAMP_SESSION_ATTR_UDP_DST_PORT,
 
    SAI_TWAMP_SESSION_ATTR_DSCP,
 
    SAI_TWAMP_SESSION_ATTR_TTL,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_MAC,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_MAC,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_ID,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_PRI,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_CFI,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_LABELSTACK,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_IP,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_IP,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_VNI,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_SRC_PORT,
 
    SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_DST_PORT,
 
    SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE,
 
    SAI_TWAMP_SESSION_ATTR_TWAMP_TIMESTAMP_FORMAT,
 
    SAI_TWAMP_SESSION_ATTR_SESSION_ENABLE_TRANSMIT,
 
    SAI_TWAMP_SESSION_ATTR_PACKET_LENGTH,
 
    SAI_TWAMP_SESSION_ATTR_PORT,
 
    SAI_TWAMP_SESSION_ATTR_TRANSMIT_PORT,
 
    SAI_TWAMP_SESSION_ATTR_RECEIVE_PORT,
 
    SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE,
 
    SAI_TWAMP_SESSION_ATTR_TX_PKT_CNT,
 
    SAI_TWAMP_SESSION_ATTR_TX_PKT_PERIOD,
 
    SAI_TWAMP_SESSION_ATTR_TX_INTERVAL,
 
    SAI_TWAMP_SESSION_ATTR_TIMEOUT,
 
    SAI_TWAMP_SESSION_ATTR_STATISTICS_INTERVAL,
 
    SAI_TWAMP_SESSION_ATTR_END,
 
    SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_START = 0x10000000,
 
    SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_END
 
} sai_twamp_session_attr_t;
 
typedef enum _sai_twamp_session_stat_t
{
    SAI_TWAMP_SESSION_STAT_RX_PACKETS,
 
    SAI_TWAMP_SESSION_STAT_RX_BYTE,
 
    SAI_TWAMP_SESSION_STAT_TX_PACKETS,
 
    SAI_TWAMP_SESSION_STAT_TX_BYTE,
 
    SAI_TWAMP_SESSION_STAT_DROP_PACKETS,
 
    SAI_TWAMP_SESSION_STAT_MAX_LATENCY,
 
    SAI_TWAMP_SESSION_STAT_MIN_LATENCY,
 
    SAI_TWAMP_SESSION_STAT_AVG_LATENCY,
 
    SAI_TWAMP_SESSION_STAT_MAX_JITTER,
 
    SAI_TWAMP_SESSION_STAT_MIN_JITTER,
 
    SAI_TWAMP_SESSION_STAT_AVG_JITTER,
 
    SAI_TWAMP_SESSION_STAT_FIRST_TS,
 
    SAI_TWAMP_SESSION_STAT_LAST_TS,
 
    SAI_TWAMP_SESSION_STAT_DURATION_TS
 
} sai_twamp_session_stat_t;
 
typedef enum _sai_twamp_session_state_t
{
    SAI_TWAMP_SESSION_STATE_INACTIVE,
 
    SAI_TWAMP_SESSION_STATE_ACTIVE
 
} sai_twamp_session_state_t;
 
typedef struct _sai_twamp_session_stats_data_t
{
    uint32_t index;
 
    uint32_t number_of_counters;
 
    sai_twamp_session_stat_t *counters_ids;
 
    uint64_t *counters;
 
} sai_twamp_session_stats_data_t;
 
typedef struct _sai_twamp_session_event_notification_data_t
{
    sai_object_id_t twamp_session_id;
 
    sai_twamp_session_state_t session_state;
 
    sai_twamp_session_stats_data_t session_stats;
 
} sai_twamp_session_event_notification_data_t;
 
typedef sai_status_t (*sai_create_twamp_session_fn)(
        _Out_ sai_object_id_t *twamp_session_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_twamp_session_fn)(
        _In_ sai_object_id_t twamp_session_id);
 
typedef sai_status_t (*sai_set_twamp_session_attribute_fn)(
        _In_ sai_object_id_t twamp_session_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_get_twamp_session_attribute_fn)(
        _In_ sai_object_id_t twamp_session_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_get_twamp_session_stats_fn)(
        _In_ sai_object_id_t twamp_session_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_twamp_session_stats_ext_fn)(
        _In_ sai_object_id_t twamp_session_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_twamp_session_stats_fn)(
        _In_ sai_object_id_t twamp_session_id,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids);
 
typedef void (*sai_twamp_session_event_notification_fn)(
        _In_ uint32_t count,
        _In_ const sai_twamp_session_event_notification_data_t *data);
 
typedef struct _sai_twamp_api_t
{
    sai_create_twamp_session_fn            create_twamp_session;
    sai_remove_twamp_session_fn            remove_twamp_session;
    sai_set_twamp_session_attribute_fn     set_twamp_session_attribute;
    sai_get_twamp_session_attribute_fn     get_twamp_session_attribute;
    sai_get_twamp_session_stats_fn         get_twamp_session_stats;
    sai_get_twamp_session_stats_ext_fn     get_twamp_session_stats_ext;
    sai_clear_twamp_session_stats_fn       clear_twamp_session_stats;
 
} sai_twamp_api_t;
 
#endif