openapi_diffserv_class_conf.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2023 Broadcom.
*
*  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
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_diffserv_class_conf.h
*
* @purpose   DiffServ Class Configuration and Status 
*
* @component OpEN
*
* @create    17/05/2023
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_DIFFSERV_CLASS_CONF_H_INCLUDED
#define OPENAPI_DIFFSERV_CLASS_CONF_H_INCLUDED

#include "openapi_common.h"
#include "openapi_routing.h"

typedef enum                     
{   
  OPEN_DIFFSERV_CLASS_TYPE_ALL = 1,              
  OPEN_DIFFSERV_CLASS_TYPE_ANY                   
} OPEN_DIFFSERV_CLASS_TYPE_t;

typedef enum
{
  OPEN_DIFFSERV_CLASS_L3PROTOCOL_IPV4 = 1,       
  OPEN_DIFFSERV_CLASS_L3PROTOCOL_IPV6            
} OPEN_DIFFSERV_CLASS_L3PROTOCOL_t;

typedef enum
{
  OPEN_DIFFSERV_CLASS_RULE_TYPE_COS = 1,           
  OPEN_DIFFSERV_CLASS_RULE_TYPE_COS2,              
  OPEN_DIFFSERV_CLASS_RULE_TYPE_DSTIP,             
  OPEN_DIFFSERV_CLASS_RULE_TYPE_DSTIPV6,           
  OPEN_DIFFSERV_CLASS_RULE_TYPE_DSTL4PORT,         
  OPEN_DIFFSERV_CLASS_RULE_TYPE_DSTMAC,            
  OPEN_DIFFSERV_CLASS_RULE_TYPE_ETYPE,             
  OPEN_DIFFSERV_CLASS_RULE_TYPE_EVERY,             
  OPEN_DIFFSERV_CLASS_RULE_TYPE_FLOWLBLV6,         
  OPEN_DIFFSERV_CLASS_RULE_TYPE_IPDSCP,            
  OPEN_DIFFSERV_CLASS_RULE_TYPE_IPPRECEDENCE,      
  OPEN_DIFFSERV_CLASS_RULE_TYPE_IPTOS,             
  OPEN_DIFFSERV_CLASS_RULE_TYPE_PROTOCOL,          
  OPEN_DIFFSERV_CLASS_RULE_TYPE_REFCLASS,          
  OPEN_DIFFSERV_CLASS_RULE_TYPE_SRCIP,             
  OPEN_DIFFSERV_CLASS_RULE_TYPE_SRCIPV6,           
  OPEN_DIFFSERV_CLASS_RULE_TYPE_SRCL4PORT,         
  OPEN_DIFFSERV_CLASS_RULE_TYPE_SRCMAC,            
  OPEN_DIFFSERV_CLASS_RULE_TYPE_VLANID,            
  OPEN_DIFFSERV_CLASS_RULE_TYPE_VLANID2            
} OPEN_DIFFSERV_CLASS_RULE_TYPE_t;

typedef enum
{ 
  OPEN_QOS_ETYPE_KEYID_CUSTOM = 1,                          
  OPEN_QOS_ETYPE_KEYID_APPLETALK,                           
  OPEN_QOS_ETYPE_KEYID_ARP,                                 
  OPEN_QOS_ETYPE_KEYID_IBMSNA,                              
  OPEN_QOS_ETYPE_KEYID_IPV4,                                
  OPEN_QOS_ETYPE_KEYID_IPV6,                                
  OPEN_QOS_ETYPE_KEYID_IPX,                                 
  OPEN_QOS_ETYPE_KEYID_MPLSMCAST,                           
  OPEN_QOS_ETYPE_KEYID_MPLSUCAST,                           
  OPEN_QOS_ETYPE_KEYID_NETBIOS,                             
  OPEN_QOS_ETYPE_KEYID_NOVELL,                              
  OPEN_QOS_ETYPE_KEYID_PPPOE,                               
  OPEN_QOS_ETYPE_KEYID_RARP                                 
} OPEN_QOS_ETYPE_KEYID_t;

#define OPEN_DIFFSERV_CLASS_NAME_MAX    31
#define OPEN_RULE_VAL_MAX_STRING_LENGTH    129

/* User Keyword Translations for Layer 4 Port Numbers */
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_DOMAIN     53
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_ECHO       7
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_FTP        21
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_FTPDATA    20
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_HTTP       80
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_SMTP       25
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_SNMP       161
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_TELNET     23
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_TFTP       69
#define OPEN_DIFFSERV_LAYER_4_PORT_NUM_WWW        80

/* User Keyword Translations for IP DSCP Values */
#define OPEN_DIFFSERV_IP_DSCP_AF11                10 
#define OPEN_DIFFSERV_IP_DSCP_AF12                12 
#define OPEN_DIFFSERV_IP_DSCP_AF13                14 
#define OPEN_DIFFSERV_IP_DSCP_AF21                18 
#define OPEN_DIFFSERV_IP_DSCP_AF22                20 
#define OPEN_DIFFSERV_IP_DSCP_AF23                22 
#define OPEN_DIFFSERV_IP_DSCP_AF31                26 
#define OPEN_DIFFSERV_IP_DSCP_AF32                28 
#define OPEN_DIFFSERV_IP_DSCP_AF33                30 
#define OPEN_DIFFSERV_IP_DSCP_AF41                34 
#define OPEN_DIFFSERV_IP_DSCP_AF42                36 
#define OPEN_DIFFSERV_IP_DSCP_AF43                38 
#define OPEN_DIFFSERV_IP_DSCP_BE                  0  
#define OPEN_DIFFSERV_IP_DSCP_CS0                 0  
#define OPEN_DIFFSERV_IP_DSCP_CS1                 8  
#define OPEN_DIFFSERV_IP_DSCP_CS2                 16 
#define OPEN_DIFFSERV_IP_DSCP_CS3                 24 
#define OPEN_DIFFSERV_IP_DSCP_CS4                 32 
#define OPEN_DIFFSERV_IP_DSCP_CS5                 40 
#define OPEN_DIFFSERV_IP_DSCP_CS6                 48 
#define OPEN_DIFFSERV_IP_DSCP_CS7                 56 
#define OPEN_DIFFSERV_IP_DSCP_EF                  46 

/* User Keyword Translations for Layer 4 Protocols */
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_ICMP       1
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_IGMP       2
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_IP         255
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_TCP        6
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_UDP        17
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_GRE        47
#define OPEN_DIFFSERV_LAYER_4_PROTOCOL_IPV6       254
#define OPEN_DIFFSERV_LAYER_6_PROTOCOL_ICMP       58

/*****************************************************************/
open_error_t openapiDiffServClassCreate(openapiClientHandle_t *client_handle,
                                        open_buffdesc *className,
                                        OPEN_DIFFSERV_CLASS_TYPE_t classType,
                                        OPEN_DIFFSERV_CLASS_L3PROTOCOL_t classL3Protocol);

/*****************************************************************/
open_error_t openapiDiffServClassDelete(openapiClientHandle_t *client_handle,
                                        uint32_t classIndex);

/*****************************************************************/
open_error_t openapiDiffServClassNameToIndex(openapiClientHandle_t *client_handle,
                                             open_buffdesc *className, uint32_t *classIndex);

/*****************************************************************/
open_error_t openapiDiffServClassGetNext(openapiClientHandle_t *client_handle,
                                         uint32_t classIndex, uint32_t *classIndexNext); 

/*****************************************************************/
open_error_t openapiDiffServClassNameGet(openapiClientHandle_t *client_handle,
                                         uint32_t classIndex, open_buffdesc *className);

/*****************************************************************/
open_error_t openapiDiffServClassTypeGet(openapiClientHandle_t *client_handle,
                                         uint32_t classIndex, OPEN_DIFFSERV_CLASS_TYPE_t *classType);

/*****************************************************************/
open_error_t openapiDiffServClassL3ProtoGet(openapiClientHandle_t *client_handle,
                                            uint32_t classIndex, OPEN_DIFFSERV_CLASS_L3PROTOCOL_t *classProtoType);

/*****************************************************************/
open_error_t openapiDiffServClassRuleCreate(openapiClientHandle_t *client_handle,
                                            uint32_t classIndex, 
                                            OPEN_DIFFSERV_CLASS_RULE_TYPE_t ruleType,
                                            open_buffdesc *ruleVal1,
                                            open_buffdesc *ruleVal2); 

/*****************************************************************/
open_error_t openapiDiffServClassRuleMatchRefClassRemove(openapiClientHandle_t *client_handle,
                                            uint32_t classIndex, open_buffdesc *refClassName);

/*****************************************************************/
open_error_t openapiDiffServClassRuleGetNext(openapiClientHandle_t *client_handle,
                                             uint32_t classIndex,
                                             uint32_t classRuleIndex,
                                             uint32_t *nextClassIndex,
                                             uint32_t *nextClassRuleIndex);

/*****************************************************************/
open_error_t openapiDiffServClassRuleCountGet(openapiClientHandle_t *client_handle,
                                             uint32_t classIndex,
                                             uint32_t *ruleCount);

/*****************************************************************/
open_error_t openapiDiffServClassRuleMatchEntryTypeGet(openapiClientHandle_t *client_handle,
                                                  uint32_t classIndex,
                                                  uint32_t classRuleIndex,
                                                  OPEN_DIFFSERV_CLASS_RULE_TYPE_t *ruleType);

/*****************************************************************/
open_error_t openapiDiffServClassRuleMatchEntryValueGet(openapiClientHandle_t *client_handle,
                                                   uint32_t classIndex,
                                                   uint32_t classRuleIndex,
                                                   OPEN_DIFFSERV_CLASS_RULE_TYPE_t ruleType,
                                                   open_buffdesc *ruleVal1,
                                                   open_buffdesc *ruleVal2);

#endif