This module defines SAI UDF (User Defined Field) interface. More...

#include <saitypes.h>

Classes
struct	_sai_udf_api_t
	UDF methods, retrieved via sai_api_query() More...

Typedefs
typedef enum _sai_udf_base_t	sai_udf_base_t
	UDF base enum.

typedef enum _sai_udf_attr_t	sai_udf_attr_t
	Attribute id for UDF.

typedef enum _sai_udf_match_attr_t	sai_udf_match_attr_t
	Attribute id for UDF match.

typedef enum _sai_udf_group_type_t	sai_udf_group_type_t
	UDF group type.

typedef enum _sai_udf_group_attr_t	sai_udf_group_attr_t
	Attribute id for UDF group.

typedef sai_status_t(*	sai_create_udf_fn) (_Out_ sai_object_id_t udf_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create UDF.

typedef sai_status_t(*	sai_remove_udf_fn) (_In_ sai_object_id_t udf_id)
	Remove UDF.

typedef sai_status_t(*	sai_set_udf_attribute_fn) (_In_ sai_object_id_t udf_id, _In_ const sai_attribute_t *attr)
	Set UDF attribute.

typedef sai_status_t(*	sai_get_udf_attribute_fn) (_In_ sai_object_id_t udf_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get UDF attribute value.

typedef sai_status_t(*	sai_create_udf_match_fn) (_Out_ sai_object_id_t udf_match_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create UDF match.

typedef sai_status_t(*	sai_remove_udf_match_fn) (_In_ sai_object_id_t udf_match_id)
	Remove UDF match.

typedef sai_status_t(*	sai_set_udf_match_attribute_fn) (_In_ sai_object_id_t udf_match_id, _In_ const sai_attribute_t *attr)
	Set UDF match attribute.

typedef sai_status_t(*	sai_get_udf_match_attribute_fn) (_In_ sai_object_id_t udf_match_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get UDF match attribute value.

typedef sai_status_t(*	sai_create_udf_group_fn) (_Out_ sai_object_id_t udf_group_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create UDF group.

typedef sai_status_t(*	sai_remove_udf_group_fn) (_In_ sai_object_id_t udf_group_id)
	Remove UDF group.

typedef sai_status_t(*	sai_set_udf_group_attribute_fn) (_In_ sai_object_id_t udf_group_id, _In_ const sai_attribute_t *attr)
	Set UDF group attribute.

typedef sai_status_t(*	sai_get_udf_group_attribute_fn) (_In_ sai_object_id_t udf_group_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get UDF group attribute value.

typedef struct _sai_udf_api_t	sai_udf_api_t
	UDF methods, retrieved via sai_api_query()

Enumerations
enum	_sai_udf_base_t { SAI_UDF_BASE_L2 , SAI_UDF_BASE_L3 , SAI_UDF_BASE_L4 }
	UDF base enum. More...

enum	_sai_udf_attr_t { SAI_UDF_ATTR_START , SAI_UDF_ATTR_MATCH_ID = SAI_UDF_ATTR_START , SAI_UDF_ATTR_GROUP_ID , SAI_UDF_ATTR_BASE , SAI_UDF_ATTR_OFFSET , SAI_UDF_ATTR_HASH_MASK , SAI_UDF_ATTR_END , SAI_UDF_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_UDF_ATTR_CUSTOM_RANGE_END }
	Attribute id for UDF. More...

enum	_sai_udf_match_attr_t { SAI_UDF_MATCH_ATTR_START , SAI_UDF_MATCH_ATTR_L2_TYPE = SAI_UDF_MATCH_ATTR_START , SAI_UDF_MATCH_ATTR_L3_TYPE , SAI_UDF_MATCH_ATTR_GRE_TYPE , SAI_UDF_MATCH_ATTR_PRIORITY , SAI_UDF_MATCH_ATTR_L4_DST_PORT_TYPE , SAI_UDF_MATCH_ATTR_END , SAI_UDF_MATCH_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_UDF_MATCH_ATTR_CUSTOM_RANGE_END }
	Attribute id for UDF match. More...

enum	_sai_udf_group_type_t { SAI_UDF_GROUP_TYPE_START , SAI_UDF_GROUP_TYPE_GENERIC = SAI_UDF_GROUP_TYPE_START , SAI_UDF_GROUP_TYPE_HASH , SAI_UDF_GROUP_TYPE_END }
	UDF group type. More...

enum	_sai_udf_group_attr_t { SAI_UDF_GROUP_ATTR_START , SAI_UDF_GROUP_ATTR_UDF_LIST = SAI_UDF_GROUP_ATTR_START , SAI_UDF_GROUP_ATTR_TYPE , SAI_UDF_GROUP_ATTR_LENGTH , SAI_UDF_GROUP_ATTR_END , SAI_UDF_GROUP_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_UDF_GROUP_ATTR_CUSTOM_RANGE_END }
	Attribute id for UDF group. More...

Detailed Description

This module defines SAI UDF (User Defined Field) interface.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

THIS CODE IS PROVIDED ON AN AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.

See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.

Microsoft would like to thank the following companies for their review and assistance with these files: Intel Corporation, Mellanox Technologies Ltd, Dell Products, L.P., Facebook, Inc., Marvell International Ltd.

Definition in file saiudf.h.

Classes

Typedefs

Enumerations

Detailed Description