openapi_event_notify.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2024 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_event_notify.h
*
* @purpose   This code implements the APIs required for OpEN Event Notifications
*
* @component OPEN
*
* @create    04/10/2024
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_EVENT_NOTIFY_H_INCLUDED
#define OPENAPI_EVENT_NOTIFY_H_INCLUDED

#include "openapi_common.h" 
#include "openapi_fdb.h"
#include "openapi_if.h"
#include "openapi_poe.h"
#include "openapi_flow_control.h"
#include "openapi_routing_arptable.h"
#include "openapi_dhcp_client.h"

typedef enum
{
  OPEN_NOTIFY_EVENT_IP_INFO                = 1,  
  OPEN_NOTIFY_EVENT_ARP                    = 2,  
  OPEN_NOTIFY_EVENT_IPV4_ROUTE             = 3,  
  OPEN_NOTIFY_EVENT_PORT_INFO              = 4,  
  OPEN_NOTIFY_EVENT_LLDP_NEIGHBORS         = 5,  
  OPEN_NOTIFY_EVENT_POE_STATUS             = 6,  
  OPEN_NOTIFY_EVENT_FDB_ENTRY              = 7,  
  OPEN_NOTIFY_EVENT_LAST                   = 8   
} OPEN_NOTIFY_EVENT_t;


#define OPEN_EVENT_CREATE     1 
#define OPEN_EVENT_DELETE     2 
#define OPEN_EVENT_UPDATE     3 
#define  OPEN_PORT_MDIX_AUTO         0  
#define  OPEN_PORT_MDIX_FORCE_AUTO   1  
#define  OPEN_PORT_MDIX_NORMAL       2  
#define  OPEN_PORT_MDIX_XOVER        3  
#define  OPEN_PORT_MDIX_UNKNOWN      4  
#define OPEN_IP_INFO_MIN_EVENTS                  1    
#define OPEN_IP_INFO_MAX_EVENTS                  32   
#define OPEN_ARP_MIN_EVENTS                      16   
#define OPEN_ARP_MAX_EVENTS                      256  
#define OPEN_IPV4_ROUTE_MIN_EVENTS               16   
#define OPEN_IPV4_ROUTE_MAX_EVENTS               256  
#define OPEN_PORT_INFO_MIN_EVENTS                1    
#define OPEN_PORT_INFO_MAX_EVENTS                256  
#define OPEN_LLDP_NEIGHBORS_MIN_EVENTS           1    
#define OPEN_LLDP_NEIGHBORS_MAX_EVENTS           8    
#define OPEN_POE_STATUS_MIN_EVENTS               1    
#define OPEN_POE_STATUS_MAX_EVENTS               256  
#define OPEN_FDB_ENTRY_MIN_EVENTS                16   
#define OPEN_FDB_ENTRY_MAX_EVENTS                512  
#define OPEN_IP_INFO_MIN_TIMEOUT                10    
#define OPEN_IP_INFO_MAX_TIMEOUT                600   
#define OPEN_ARP_MIN_TIMEOUT                    10   
#define OPEN_ARP_MAX_TIMEOUT                    600  
#define OPEN_IPV4_ROUTE_MIN_TIMEOUT             10   
#define OPEN_IPV4_ROUTE_MAX_TIMEOUT             600  
#define OPEN_PORT_INFO_MIN_TIMEOUT              10   
#define OPEN_PORT_INFO_MAX_TIMEOUT              600  
#define OPEN_LLDP_NEIGHBORS_MIN_TIMEOUT         10   
#define OPEN_LLDP_NEIGHBORS_MAX_TIMEOUT         600  
#define OPEN_POE_STATUS_MIN_TIMEOUT             10   
#define OPEN_POE_STATUS_MAX_TIMEOUT             600  
#define OPEN_FDB_ENTRY_MIN_TIMEOUT              20   
#define OPEN_FDB_ENTRY_MAX_TIMEOUT              600  
#define OPEN_EVENT_NOTIFY_MAX_STR_LEN       256     
#define OPEN_EVENT_NOTIFY_DATA_MAX_SIZE     16384   
#define OPEN_EVENT_NOTIFY_SOCK_NAME  "/tmp/event_notify/sockets/client-notify-sock-%d"  
typedef struct
{
  uint32_t                      ifNum;         
  OPEN_PORT_STATE_t             portState;     
  OPEN_LINK_STATE_t             linkState;     
  OPEN_FLOWCONTROL_OPER_t       flowControl;   
  OPEN_DISABLE_REASON_t         disableReason; 
  OPEN_PORT_SPEEDS_t            ifSpeed;       
  OPEN_PORT_AUTO_NEG_t          autoneg;       
  OPEN_PORT_DUPLEX_t            duplex;        
  uint8_t                       mdixMode;      
  OPEN_PORT_CABLE_MEDIA_TYPE_t  medium;        
} OPEN_PORT_INFO_EVENT_t;

typedef struct 
{
  uint32_t                         eventChangeType;  
  uint32_t                         ifNum;            
  /* The unique values to identify an interface remote entry
   * are ifNum, remote index and timestamp. Any details about
   * the entry can be fetched using OpENAPI once we have the indices.
   *
   * For add and update info can be fetched.
   * For delete use srcMac as additional info to clean up
   * Future: if there is usecase we should consider providing
   * chassis id, port id ( lldpRemDataKey_s ).
   */
  uint32_t                   remIndex;     
  uint32_t                   timestamp;    
  unsigned char              srcMac[OPEN_MAC_ADDR_LEN]; 
} OPEN_LLDP_NEIGHBOR_EVENT_t;

typedef enum
{
  OPEN_POE_PORT_ON              = 1,  
  OPEN_POE_PORT_OFF             = 2,  
  OPEN_POE_PORT_ADMIN_DISABLE   = 3,  
  OPEN_POE_PORT_ADMIN_ENABLE    = 4   
} OPEN_POE_TRAP_PORT_CHANGE_t;

typedef struct 
{
  uint32_t                      ifNum;             
  OPEN_POE_TRAP_PORT_CHANGE_t   state;             
  OPEN_POE_DETECTION_t          detectionStatus;   
  OPEN_POE_PORT_FAULT_STATUS_t  status;            
  uint32_t                      powerLimit;        
  uint32_t                      maxPower;          
  OPEN_POE_PORT_POWER_CLASS_t   pdClass;           
  OPEN_POE_TYPE_t               pdType;            
} OPEN_POE_PORT_STATUS_EVENT_t;

typedef struct 
{
  uint8_t                    eventChangeType;         
  unsigned char              mac[OPEN_MAC_ADDR_LEN];  
  uint32_t                   vlanId;                  
  OPEN_FDB_ADDR_FLAG_t       entryType;               
  uint32_t                   ifNum;                   
} OPEN_FDB_EVENT_t;

typedef struct 
{
  OPEN_ARP_ENTRY_t    arpEntry;         
  uint8_t             eventChangeType;  
} OPEN_ARP_EVENT_t;

typedef struct 
{
  OPEN_MGMT_PORT_TYPE_t mgmtPortType;                     
  uint32_t intIfNum;                                      
  uint32_t ipAddr;                                        
  uint32_t netMask;                                       
  uint32_t gateway;                                       
  uint32_t dnsServerIpAddr[OPEN_DNS_NAME_SERVER_ENTRIES]; 
  unsigned char hostName[OPEN_HOSTNAME_MAX_LEN + 1];      
  uint8_t  eventChangeType;                               
} OPEN_IP_INFO_EVENT_t;

typedef struct 
{
  uint8_t        eventChangeType;  
  uint32_t       routeDest;        
  uint32_t       routeMask;        
  uint16_t       vrfId;            
  uint32_t       routeProto;       
  uint32_t       routePref;        
} OPEN_IPV4_ROUTE_EVENT_t;

typedef struct 
{
  uint32_t            eventSeqNum;      
  uint32_t            globalSeqNum;     
  OPEN_NOTIFY_EVENT_t eventType;        
  uint32_t            eventCount;       
  OPEN_BOOL_t         eventMissFlag;    
  /* buffdesc should be last field in this structure */
  open_buffdesc       eventData;        
} OPEN_DEVICE_EVENT_t;

typedef struct
{
  OPEN_NOTIFY_EVENT_t eventType;   
  uint32_t            timeout;     
  uint32_t            eventCount;  
} openEventNotifyConfig_t;


/*************************************************************************/
open_error_t openapiEventNotifyClientRegister (openapiClientHandle_t *client_handle,
                                               open_buffdesc *clientDescription);

/*************************************************************************/
open_error_t openapiEventNotifyClientDeregister (openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiEventNotifyEventRegister (openapiClientHandle_t *client_handle,
                                              uint32_t numOfNotifyEvents,
                                              open_buffdesc *eventNotifyCfg);

/*************************************************************************/
open_error_t openapiEventNotifyEventDeregister (openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiEventNotifyDataReceive (openapiClientHandle_t *client_handle,
                                            open_error_t (*callBack) (OPEN_DEVICE_EVENT_t *eventInfo));

#endif /* OPENAPI_EVENT_NOTIFY_H_INCLUDED */