SAI - QOS Maps specific API definitions.

Classes
struct	_sai_qos_map_api_t
	QOS Map methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_qos_map_type_t	sai_qos_map_type_t
	Enum defining QOS map types.
typedef enum _sai_qos_map_attr_t	sai_qos_map_attr_t
	Enum defining attributes for QOS Maps.
typedef sai_status_t(*	sai_create_qos_map_fn) (_Out_ sai_object_id_t *qos_map_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create QOS Map.
typedef sai_status_t(*	sai_remove_qos_map_fn) (_In_ sai_object_id_t qos_map_id)
	Remove QOS Map.
typedef sai_status_t(*	sai_set_qos_map_attribute_fn) (_In_ sai_object_id_t qos_map_id, _In_ const sai_attribute_t *attr)
	Set attributes for QOS map.
typedef sai_status_t(*	sai_get_qos_map_attribute_fn) (_In_ sai_object_id_t qos_map_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get attributes of QOS map.
typedef struct _sai_qos_map_api_t	sai_qos_map_api_t
	QOS Map methods table retrieved with sai_api_query()

Enumerations
enum	_sai_qos_map_type_t {   SAI_QOS_MAP_TYPE_DOT1P_TO_TC = 0x00000000 , SAI_QOS_MAP_TYPE_DOT1P_TO_COLOR = 0x00000001 , SAI_QOS_MAP_TYPE_DSCP_TO_TC = 0x00000002 , SAI_QOS_MAP_TYPE_DSCP_TO_COLOR = 0x00000003 ,   SAI_QOS_MAP_TYPE_TC_TO_QUEUE = 0x00000004 , SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_DSCP = 0x00000005 , SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_DOT1P = 0x00000006 , SAI_QOS_MAP_TYPE_TC_TO_PRIORITY_GROUP = 0x00000007 ,   SAI_QOS_MAP_TYPE_PFC_PRIORITY_TO_PRIORITY_GROUP = 0x00000008 , SAI_QOS_MAP_TYPE_PFC_PRIORITY_TO_QUEUE = 0x00000009 , SAI_QOS_MAP_TYPE_MPLS_EXP_TO_TC = 0x0000000a , SAI_QOS_MAP_TYPE_MPLS_EXP_TO_COLOR = 0x0000000b ,   SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_MPLS_EXP = 0x0000000c , SAI_QOS_MAP_TYPE_DSCP_TO_FORWARDING_CLASS = 0x0000000d , SAI_QOS_MAP_TYPE_MPLS_EXP_TO_FORWARDING_CLASS = 0x0000000e , SAI_QOS_MAP_TYPE_CUSTOM_RANGE_BASE = 0x10000000 }
	Enum defining QOS map types. More...
enum	_sai_qos_map_attr_t {   SAI_QOS_MAP_ATTR_START , SAI_QOS_MAP_ATTR_TYPE = SAI_QOS_MAP_ATTR_START , SAI_QOS_MAP_ATTR_MAP_TO_VALUE_LIST = 0x00000001 , SAI_QOS_MAP_ATTR_END ,   SAI_QOS_MAP_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_QOS_MAP_ATTR_CUSTOM_RANGE_END }
	Enum defining attributes for QOS Maps. More...

Detailed Description

Typedef Documentation

sai_create_qos_map_fn

typedef sai_status_t(* sai_create_qos_map_fn) (_Out_ sai_object_id_t *qos_map_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create QOS Map.

Parameters

[out]	qos_map_id	QOS Map Id
[in]	switch_id	Switch id
[in]	attr_count	Number of attributes
[in]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 145 of file saiqosmap.h.

sai_get_qos_map_attribute_fn

typedef sai_status_t(* sai_get_qos_map_attribute_fn) (_In_ sai_object_id_t qos_map_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get attributes of QOS map.

Parameters

[in]	qos_map_id	Map id
[in]	attr_count	Number of attributes
[in,out]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 182 of file saiqosmap.h.

sai_remove_qos_map_fn

typedef sai_status_t(* sai_remove_qos_map_fn) (_In_ sai_object_id_t qos_map_id)

Remove QOS Map.

Parameters

[in]

qos_map_id

QOS Map id to be removed.

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 158 of file saiqosmap.h.

sai_set_qos_map_attribute_fn

typedef sai_status_t(* sai_set_qos_map_attribute_fn) (_In_ sai_object_id_t qos_map_id, _In_ const sai_attribute_t *attr)

Set attributes for QOS map.

Parameters

[in]	qos_map_id	QOS Map Id
[in]	attr	Attribute to set

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 169 of file saiqosmap.h.

Enumeration Type Documentation

_sai_qos_map_attr_t

enum _sai_qos_map_attr_t

Enum defining attributes for QOS Maps.

Enumerator
SAI_QOS_MAP_ATTR_START	Start of attributes.
SAI_QOS_MAP_ATTR_TYPE	QOS Map type. Value Type: sai_qos_map_type_t Flags: MANDATORY_ON_CREATE | CREATE_ONLY
SAI_QOS_MAP_ATTR_MAP_TO_VALUE_LIST	Dot1p to TC Mapping. Defaults: All Dot1p/DSCP maps to traffic class 0 All Dot1p/DSCP maps to color SAI_PACKET_COLOR_GREEN All traffic class maps to queue 0 Value Type: sai_qos_map_list_t Flags: MANDATORY_ON_CREATE | CREATE_AND_SET
SAI_QOS_MAP_ATTR_END	End of attributes.
SAI_QOS_MAP_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_QOS_MAP_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 94 of file saiqosmap.h.

_sai_qos_map_type_t

enum _sai_qos_map_type_t

Enum defining QOS map types.

Enumerator
SAI_QOS_MAP_TYPE_DOT1P_TO_TC	QOS Map to set DOT1P to Traffic class
SAI_QOS_MAP_TYPE_DOT1P_TO_COLOR	QOS Map to set DOT1P to color
SAI_QOS_MAP_TYPE_DSCP_TO_TC	QOS Map to set DSCP to Traffic class
SAI_QOS_MAP_TYPE_DSCP_TO_COLOR	QOS Map to set DSCP to color
SAI_QOS_MAP_TYPE_TC_TO_QUEUE	QOS Map to set traffic class to queue
SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_DSCP	QOS Map to set traffic class and color to DSCP
SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_DOT1P	QOS Map to set traffic class and color to DSCP
SAI_QOS_MAP_TYPE_TC_TO_PRIORITY_GROUP	QOS Map to set traffic class to priority group
SAI_QOS_MAP_TYPE_PFC_PRIORITY_TO_PRIORITY_GROUP	QOS Map to set PFC priority to priority group
SAI_QOS_MAP_TYPE_PFC_PRIORITY_TO_QUEUE	QOS Map to set PFC priority to queue
SAI_QOS_MAP_TYPE_MPLS_EXP_TO_TC	QOS Map to set EXP to Traffic class
SAI_QOS_MAP_TYPE_MPLS_EXP_TO_COLOR	QOS Map to set EXP to color
SAI_QOS_MAP_TYPE_TC_AND_COLOR_TO_MPLS_EXP	QOS Map to set traffic class and color to EXP
SAI_QOS_MAP_TYPE_DSCP_TO_FORWARDING_CLASS	QOS Map to set DSCP to Forwarding class
SAI_QOS_MAP_TYPE_MPLS_EXP_TO_FORWARDING_CLASS	QOS Map to set EXP to Forwarding class
SAI_QOS_MAP_TYPE_CUSTOM_RANGE_BASE	Custom range base value

Definition at line 39 of file saiqosmap.h.