SAI - System Port specific API definitions

Classes
struct	_sai_system_port_api_t
	Port methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_system_port_type_t	sai_system_port_type_t
	Attribute data for SAI_SYSTEM_PORT_ATTR_TYPE.
typedef enum _sai_system_port_attr_t	sai_system_port_attr_t
	Attribute Id in sai_set_system_port_attribute() and sai_get_system_port_attribute() calls.
typedef sai_status_t(*	sai_create_system_port_fn) (_Out_ sai_object_id_t *system_port_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create system port.
typedef sai_status_t(*	sai_remove_system_port_fn) (_In_ sai_object_id_t system_port_id)
	Remove system port.
typedef sai_status_t(*	sai_set_system_port_attribute_fn) (_In_ sai_object_id_t system_port_id, _In_ const sai_attribute_t *attr)
	Set system port attribute value.
typedef sai_status_t(*	sai_get_system_port_attribute_fn) (_In_ sai_object_id_t system_port_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get system port attribute value.
typedef struct _sai_system_port_api_t	sai_system_port_api_t
	Port methods table retrieved with sai_api_query()

Enumerations
enum	_sai_system_port_type_t { SAI_SYSTEM_PORT_TYPE_LOCAL , SAI_SYSTEM_PORT_TYPE_REMOTE }
	Attribute data for SAI_SYSTEM_PORT_ATTR_TYPE. More...
enum	_sai_system_port_attr_t {   SAI_SYSTEM_PORT_ATTR_START , SAI_SYSTEM_PORT_ATTR_TYPE = SAI_SYSTEM_PORT_ATTR_START , SAI_SYSTEM_PORT_ATTR_QOS_NUMBER_OF_VOQS , SAI_SYSTEM_PORT_ATTR_QOS_VOQ_LIST ,   SAI_SYSTEM_PORT_ATTR_PORT , SAI_SYSTEM_PORT_ATTR_ADMIN_STATE , SAI_SYSTEM_PORT_ATTR_CONFIG_INFO , SAI_SYSTEM_PORT_ATTR_QOS_TC_TO_QUEUE_MAP ,   SAI_SYSTEM_PORT_ATTR_END , SAI_SYSTEM_PORT_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_SYSTEM_PORT_ATTR_CUSTOM_RANGE_END }
	Attribute Id in sai_set_system_port_attribute() and sai_get_system_port_attribute() calls. More...

Detailed Description

Typedef Documentation

sai_create_system_port_fn

typedef sai_status_t(* sai_create_system_port_fn) (_Out_ sai_object_id_t *system_port_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create system port.

Parameters

[out]	system_port_id	System Port 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 154 of file saisystemport.h.

sai_get_system_port_attribute_fn

typedef sai_status_t(* sai_get_system_port_attribute_fn) (_In_ sai_object_id_t system_port_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get system port attribute value.

Parameters

[in]	system_port_id	System Port 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 191 of file saisystemport.h.

sai_remove_system_port_fn

typedef sai_status_t(* sai_remove_system_port_fn) (_In_ sai_object_id_t system_port_id)

Remove system port.

Parameters

[in]

system_port_id

System Port id

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 167 of file saisystemport.h.

sai_set_system_port_attribute_fn

typedef sai_status_t(* sai_set_system_port_attribute_fn) (_In_ sai_object_id_t system_port_id, _In_ const sai_attribute_t *attr)

Set system port attribute value.

Parameters

[in]	system_port_id	System Port id
[in]	attr	Attribute

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 178 of file saisystemport.h.

Enumeration Type Documentation

_sai_system_port_attr_t

enum _sai_system_port_attr_t

Attribute Id in sai_set_system_port_attribute() and sai_get_system_port_attribute() calls.

Enumerator
SAI_SYSTEM_PORT_ATTR_START	Start of attributes.
SAI_SYSTEM_PORT_ATTR_TYPE	System Port Type. Value Type: sai_system_port_type_t Flags: READ_ONLY
SAI_SYSTEM_PORT_ATTR_QOS_NUMBER_OF_VOQS	Number of Virtual output queues on port. Value Type: sai_uint32_t Flags: READ_ONLY
SAI_SYSTEM_PORT_ATTR_QOS_VOQ_LIST	List of Virtual output Queues for the port. Value Type: sai_object_list_t Flags: READ_ONLY Allowed object types SAI_OBJECT_TYPE_QUEUE
SAI_SYSTEM_PORT_ATTR_PORT	Local port for the system port. Only valid for system ports which are mapped to local ports. Value Type: sai_object_id_t Flags: READ_ONLY Allowed object types SAI_OBJECT_TYPE_PORT
SAI_SYSTEM_PORT_ATTR_ADMIN_STATE	Admin Mode. Value Type: bool Flags: CREATE_AND_SET Default value: false
SAI_SYSTEM_PORT_ATTR_CONFIG_INFO	System Port Configuration Information. Value Type: sai_system_port_config_t Flags: MANDATORY_ON_CREATE | CREATE_ONLY
SAI_SYSTEM_PORT_ATTR_QOS_TC_TO_QUEUE_MAP	Enable TC -> VOQ MAP on system port. Map id = SAI_NULL_OBJECT_ID to disable map on system port. Default no map, i.e. all packets to VOQ 0. Value Type: sai_object_id_t Flags: CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_QOS_MAP Allows NULL object ID true Default value: SAI_NULL_OBJECT_ID
SAI_SYSTEM_PORT_ATTR_END	End of attributes.
SAI_SYSTEM_PORT_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_SYSTEM_PORT_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 53 of file saisystemport.h.

_sai_system_port_type_t

enum _sai_system_port_type_t

Attribute data for SAI_SYSTEM_PORT_ATTR_TYPE.

Enumerator
SAI_SYSTEM_PORT_TYPE_LOCAL	Local to switch
SAI_SYSTEM_PORT_TYPE_REMOTE	Remote switch

Definition at line 39 of file saisystemport.h.