SAI - STP specific public APIs and data structures

Classes
struct	_sai_stp_api_t
	STP method table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_stp_port_state_t	sai_stp_port_state_t
	Data structure for STP port state.
typedef enum _sai_stp_attr_t	sai_stp_attr_t
	SAI attributes for STP.
typedef enum _sai_stp_port_attr_t	sai_stp_port_attr_t
	SAI attributes for STP.
typedef sai_status_t(*	sai_create_stp_fn) (_Out_ sai_object_id_t *stp_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create STP instance with default port state as blocking.
typedef sai_status_t(*	sai_remove_stp_fn) (_In_ sai_object_id_t stp_id)
	Remove STP instance.
typedef sai_status_t(*	sai_set_stp_attribute_fn) (_In_ sai_object_id_t stp_id, _In_ const sai_attribute_t *attr)
	Set the attribute of STP instance.
typedef sai_status_t(*	sai_get_stp_attribute_fn) (_In_ sai_object_id_t stp_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get the attribute of STP instance.
typedef sai_status_t(*	sai_create_stp_port_fn) (_Out_ sai_object_id_t *stp_port_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create STP port object.
typedef sai_status_t(*	sai_remove_stp_port_fn) (_In_ sai_object_id_t stp_port_id)
	Remove STP port object.
typedef sai_status_t(*	sai_set_stp_port_attribute_fn) (_In_ sai_object_id_t stp_port_id, _In_ const sai_attribute_t *attr)
	Set the attribute of STP port.
typedef sai_status_t(*	sai_get_stp_port_attribute_fn) (_In_ sai_object_id_t stp_port_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get the attribute of STP port.
typedef struct _sai_stp_api_t	sai_stp_api_t
	STP method table retrieved with sai_api_query()

Enumerations
enum	_sai_stp_port_state_t { SAI_STP_PORT_STATE_LEARNING , SAI_STP_PORT_STATE_FORWARDING , SAI_STP_PORT_STATE_BLOCKING }
	Data structure for STP port state. More...
enum	_sai_stp_attr_t {   SAI_STP_ATTR_START , SAI_STP_ATTR_VLAN_LIST = SAI_STP_ATTR_START , SAI_STP_ATTR_BRIDGE_ID , SAI_STP_ATTR_PORT_LIST ,   SAI_STP_ATTR_END , SAI_STP_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_STP_ATTR_CUSTOM_RANGE_END }
	SAI attributes for STP. More...
enum	_sai_stp_port_attr_t {   SAI_STP_PORT_ATTR_START , SAI_STP_PORT_ATTR_STP = SAI_STP_PORT_ATTR_START , SAI_STP_PORT_ATTR_BRIDGE_PORT , SAI_STP_PORT_ATTR_STATE ,   SAI_STP_PORT_ATTR_END , SAI_STP_PORT_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_STP_PORT_ATTR_CUSTOM_RANGE_END }
	SAI attributes for STP. More...

Detailed Description

Typedef Documentation

sai_create_stp_fn

typedef sai_status_t(* sai_create_stp_fn) (_Out_ sai_object_id_t *stp_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create STP instance with default port state as blocking.

Parameters

[out]	stp_id	STP instance id
[in]	switch_id	Switch id
[in]	attr_count	Number of attributes
[in]	attr_list	Value of attributes

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 163 of file saistp.h.

sai_create_stp_port_fn

typedef sai_status_t(* sai_create_stp_port_fn) (_Out_ sai_object_id_t *stp_port_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create STP port object.

Parameters

[out]	stp_port_id	STP port id
[in]	switch_id	Switch ID
[in]	attr_count	Number of attributes
[in]	attr_list	Value of attributes

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 219 of file saistp.h.

sai_get_stp_attribute_fn

typedef sai_status_t(* sai_get_stp_attribute_fn) (_In_ sai_object_id_t stp_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get the attribute of STP instance.

Parameters

[in]	stp_id	STP instance id
[in]	attr_count	Number of the attribute
[in,out]	attr_list	Attribute value

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 203 of file saistp.h.

sai_get_stp_port_attribute_fn

typedef sai_status_t(* sai_get_stp_port_attribute_fn) (_In_ sai_object_id_t stp_port_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get the attribute of STP port.

Parameters

[in]	stp_port_id	STP port id
[in]	attr_count	Number of the attribute
[in,out]	attr_list	Attribute value

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 259 of file saistp.h.

sai_remove_stp_fn

typedef sai_status_t(* sai_remove_stp_fn) (_In_ sai_object_id_t stp_id)

Remove STP instance.

Parameters

[in]

stp_id

STP instance id

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 177 of file saistp.h.

sai_remove_stp_port_fn

typedef sai_status_t(* sai_remove_stp_port_fn) (_In_ sai_object_id_t stp_port_id)

Remove STP port object.

Parameters

[in]

stp_port_id

STP object id

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 233 of file saistp.h.

sai_set_stp_attribute_fn

typedef sai_status_t(* sai_set_stp_attribute_fn) (_In_ sai_object_id_t stp_id, _In_ const sai_attribute_t *attr)

Set the attribute of STP instance.

Parameters

[in]	stp_id	STP instance id
[in]	attr	Attribute value

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 189 of file saistp.h.

sai_set_stp_port_attribute_fn

typedef sai_status_t(* sai_set_stp_port_attribute_fn) (_In_ sai_object_id_t stp_port_id, _In_ const sai_attribute_t *attr)

Set the attribute of STP port.

Parameters

[in]	stp_port_id	STP port id
[in]	attr	Attribute value

Returns

SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 245 of file saistp.h.

Enumeration Type Documentation

_sai_stp_attr_t

enum _sai_stp_attr_t

SAI attributes for STP.

Enumerator
SAI_STP_ATTR_START	Start of attributes.
SAI_STP_ATTR_VLAN_LIST	VLANs attached to STP instance. Value Type: sai_vlan_list_t Flags: READ_ONLY
SAI_STP_ATTR_BRIDGE_ID	Bridge attached to STP instance. Value Type: sai_object_id_t Flags: READ_ONLY Allowed object types SAI_OBJECT_TYPE_BRIDGE
SAI_STP_ATTR_PORT_LIST	Port member list. When a STP is created, this list is empty, all ports state as blocking. Value Type: sai_object_list_t Flags: READ_ONLY Allowed object types SAI_OBJECT_TYPE_STP_PORT
SAI_STP_ATTR_END	End of attributes.
SAI_STP_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_STP_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 55 of file saistp.h.

_sai_stp_port_attr_t

enum _sai_stp_port_attr_t

SAI attributes for STP.

Enumerator
SAI_STP_PORT_ATTR_START	Start of attributes.
SAI_STP_PORT_ATTR_STP	STP id. Value Type: sai_object_id_t Flags: MANDATORY_ON_CREATE | CREATE_ONLY Allowed object types SAI_OBJECT_TYPE_STP
SAI_STP_PORT_ATTR_BRIDGE_PORT	Bridge Port id. Value Type: sai_object_id_t Flags: MANDATORY_ON_CREATE | CREATE_ONLY Allowed object types SAI_OBJECT_TYPE_BRIDGE_PORT
SAI_STP_PORT_ATTR_STATE	STP port state. Value Type: sai_stp_port_state_t Flags: MANDATORY_ON_CREATE | CREATE_AND_SET
SAI_STP_PORT_ATTR_END	End of attributes.
SAI_STP_PORT_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_STP_PORT_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 106 of file saistp.h.

_sai_stp_port_state_t

enum _sai_stp_port_state_t

Data structure for STP port state.

Enumerator
SAI_STP_PORT_STATE_LEARNING	Port is in Learning mode
SAI_STP_PORT_STATE_FORWARDING	Port is in Forwarding mode
SAI_STP_PORT_STATE_BLOCKING	Port is in Blocking mode

Definition at line 39 of file saistp.h.