SAI - GPE specific API definitions

Classes
struct	_sai_generic_programmable_api_t
	Generic extensions methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_generic_programmable_attr_t	sai_generic_programmable_attr_t
	Attribute Id for Generic Programmable extension.
typedef sai_status_t(*	sai_create_generic_programmable_fn) (_Out_ sai_object_id_t *generic_programmable_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create a Generic programmable entry.
typedef sai_status_t(*	sai_remove_generic_programmable_fn) (_In_ sai_object_id_t generic_programmable_id)
	Delete a Generic programmable entry.
typedef sai_status_t(*	sai_set_generic_programmable_attribute_fn) (_In_ sai_object_id_t generic_programmable_id, _In_ const sai_attribute_t *attr)
	Set Generic programmable Table entry attribute.
typedef sai_status_t(*	sai_get_generic_programmable_attribute_fn) (_In_ sai_object_id_t generic_programmable_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get Generic programmable entry attribute.
typedef struct _sai_generic_programmable_api_t	sai_generic_programmable_api_t
	Generic extensions methods table retrieved with sai_api_query()

Enumerations
enum	_sai_generic_programmable_attr_t {   SAI_GENERIC_PROGRAMMABLE_ATTR_START , SAI_GENERIC_PROGRAMMABLE_ATTR_OBJECT_NAME = SAI_GENERIC_PROGRAMMABLE_ATTR_START , SAI_GENERIC_PROGRAMMABLE_ATTR_ENTRY , SAI_GENERIC_PROGRAMMABLE_ATTR_COUNTER_ID ,   SAI_GENERIC_PROGRAMMABLE_ATTR_END , SAI_GENERIC_PROGRAMMABLE_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_GENERIC_PROGRAMMABLE_ATTR_CUSTOM_RANGE_END }
	Attribute Id for Generic Programmable extension. More...

Detailed Description

Typedef Documentation

sai_create_generic_programmable_fn

typedef sai_status_t(* sai_create_generic_programmable_fn) (_Out_ sai_object_id_t *generic_programmable_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create a Generic programmable entry.

Parameters

[out]	generic_programmable_id	The OID returned per entry per HW block
[in]	switch_id	The Switch Object 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 99 of file saigenericprogrammable.h.

sai_get_generic_programmable_attribute_fn

typedef sai_status_t(* sai_get_generic_programmable_attribute_fn) (_In_ sai_object_id_t generic_programmable_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get Generic programmable entry attribute.

Parameters

[in]	generic_programmable_id	The table 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 136 of file saigenericprogrammable.h.

sai_remove_generic_programmable_fn

typedef sai_status_t(* sai_remove_generic_programmable_fn) (_In_ sai_object_id_t generic_programmable_id)

Delete a Generic programmable entry.

Parameters

[in]

generic_programmable_id

The table id

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 112 of file saigenericprogrammable.h.

sai_set_generic_programmable_attribute_fn

typedef sai_status_t(* sai_set_generic_programmable_attribute_fn) (_In_ sai_object_id_t generic_programmable_id, _In_ const sai_attribute_t *attr)

Set Generic programmable Table entry attribute.

Parameters

[in]	generic_programmable_id	The table id
[in]	attr	Attribute

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 123 of file saigenericprogrammable.h.

Enumeration Type Documentation

_sai_generic_programmable_attr_t

enum _sai_generic_programmable_attr_t

Attribute Id for Generic Programmable extension.

Enumerator
SAI_GENERIC_PROGRAMMABLE_ATTR_START	Start of attributes.
SAI_GENERIC_PROGRAMMABLE_ATTR_OBJECT_NAME	HW block name to program the entry. Value Type: sai_s8_list_t Flags: MANDATORY_ON_CREATE | CREATE_ONLY
SAI_GENERIC_PROGRAMMABLE_ATTR_ENTRY	JSON string carrying HW block entry information. Value Type: sai_json_t Flags: CREATE_AND_SET Default value: vendor
SAI_GENERIC_PROGRAMMABLE_ATTR_COUNTER_ID	Attach a counter. When it is empty, then packet hits won't be counted Value Type: sai_object_id_t Flags: CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_COUNTER Allows NULL object ID true Default value: SAI_NULL_OBJECT_ID
SAI_GENERIC_PROGRAMMABLE_ATTR_END	End of attributes.
SAI_GENERIC_PROGRAMMABLE_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_GENERIC_PROGRAMMABLE_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 39 of file saigenericprogrammable.h.