openapi_msrp.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2020 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_msrp.h
*
* @purpose   Multiple Stream Reservation Protocol (MSRP). 
*
* @component OPEN
*
* @create    05/15/2020
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_MSRP_H_INCLUDED
#define OPENAPI_MSRP_H_INCLUDED

#include "openapi_common.h" 

#define OPEN_MSRP_INTF_MAX_COUNT    1024

typedef enum 
{
  OPEN_MSRP_QAV_STREAM_CLASS_A = 0,  
  OPEN_MSRP_QAV_STREAM_CLASS_B,      
} OPEN_MSRP_QAV_STREAMCLASS_t;

typedef struct
{
  uint32_t       streamID;                          
  uint8_t        streamMacAddr[OPEN_MAC_ADDR_LEN];  
  OPEN_BOOL_t    listenerRegistered;
  OPEN_BOOL_t    listenerDeclared;
  OPEN_BOOL_t    talkerRegistered;
  OPEN_BOOL_t    talkerDeclared;
  uint32_t       listenerDeclType;                  
  uint32_t       talkerDeclType;                    
  uint32_t       accLatency;
  uint8_t        failIntf;                          
  uint8_t        failCode;                          
  uint8_t        failMacAddr[OPEN_MAC_ADDR_LEN];
  uint32_t       age;                               
} OPEN_MSRP_RESERVATION_INFO_t;

typedef struct
{
  uint32_t        streamID;                           
  uint8_t         sourceMacAddr[OPEN_MAC_ADDR_LEN];   
  uint32_t        accLatency;                          
  uint8_t         trafficClass;                       
  uint8_t         rank;                               
  uint32_t        maxFrameSize;
  uint32_t        maxIntervalFrames;
  uint16_t        vlanId;                            
  uint8_t         destMacAddr[OPEN_MAC_ADDR_LEN];    
  uint8_t         failIntf;                          
  uint8_t         failCode;                          
  uint8_t         failMacAddr[OPEN_MAC_ADDR_LEN];    
  uint8_t         talkerIntf;
  uint32_t        listeners[OPEN_MSRP_INTF_MAX_COUNT - 1];
} OPEN_MSRP_STEAM_INFO_t;

typedef enum
{      
  OPEN_MSRP_DECTYPE_INVALID = 0,     
  OPEN_MSRP_DECTYPE_ADVERTISE,       
  OPEN_MSRP_DECTYPE_FAILED,          
  OPEN_MSRP_DECTYPE_ASKING_FAILED,   
  OPEN_MSRP_DECTYPE_READY,           
  OPEN_MSRP_DECTYPE_READY_FAILED,    
  OPEN_MSRP_DECTYPE_DOMAIN,          
} OPEN_MSRP_DECLARATION_t;

typedef enum 
{
  OPEN_MSRP_STATS_RX = 0,        
  OPEN_MSRP_STATS_RX_BAD_HEADER, 
  OPEN_MSRP_STATS_RX_BAD_FORMAT, 
  OPEN_MSRP_STATS_TX,            
  OPEN_MSRP_STATS_TX_FAILURE,    
  OPEN_MSRP_STATS_MSG            
} OPEN_MSRP_STATS_t;


/*************************************************************************/
open_error_t openapiMsrpModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiMsrpModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMsrpBoundaryPropagateModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiMsrpBoundaryPropagateModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMsrpIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiMsrpIntfModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMsrpSrQavPriorityGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t *priority);

/*************************************************************************/
open_error_t openapiMsrpSrQavPrioritySet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t priority);

/*************************************************************************/
open_error_t openapiMsrpSrQavRePriorityGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t *remap);

/*************************************************************************/
open_error_t openapiMsrpSrQavRePrioritySet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t remap);

/*************************************************************************/
open_error_t openapiMsrpTalkerPruningModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiMsrpTalkerPruningModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMsrpMaxFanInPortsGet(openapiClientHandle_t *client_handle, uint32_t *maxFanInPorts);

/*************************************************************************/
open_error_t openapiMsrpMaxFanInPortsSet(openapiClientHandle_t *client_handle, uint32_t maxFanInPorts);

/*************************************************************************/
open_error_t openapiMsrpSRclassPVIDGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pvid);

/*************************************************************************/
open_error_t openapiMsrpSRclassPVIDSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t pvid);

/*************************************************************************/
open_error_t openapiMsrpQavDeltaBandwidthGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *deltaClassA, uint32_t *deltaClassB);

/*************************************************************************/
open_error_t openapiMsrpQavDeltaBandwidthSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trafficClass, uint32_t deltaBandwidth);

/*************************************************************************/
open_error_t openapiMsrpQavMaxRateGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint64_t *trClassA, uint64_t *trClassB, uint64_t *total);

/*************************************************************************/
open_error_t openapiMsrpQavCurrentBandwidthGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint64_t *trClassA, uint64_t *trClassB, uint64_t *total);

/*************************************************************************/
open_error_t openapiMsrpIsBoundaryPortGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, OPEN_BOOL_t *isBoundary);

/*************************************************************************/
open_error_t openapiMsrpStreamIndexedNextGet(openapiClientHandle_t *client_handle, uint16_t currentIndex, uint16_t *nextIndex);

/*************************************************************************/
open_error_t openapiMsrpReservationInformationGet(openapiClientHandle_t *client_handle, uint32_t streamId, uint32_t intIfNum, open_buffdesc *reservationInfo);

/*************************************************************************/
open_error_t openapiMsrpTrafficPduCounterGet(openapiClientHandle_t *client_handle, OPEN_MSRP_STATS_t type, uint32_t *counter);

/*************************************************************************/
open_error_t openapiMsrpIntfTrafficPduCounterGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_STATS_t type, uint32_t *counter);

/*************************************************************************/
open_error_t openapiMsrpFailedRegistrationCounterGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *counter);

/*************************************************************************/
open_error_t openapiMsrpStreamInformationGet(openapiClientHandle_t *client_handle, uint32_t streamId, open_buffdesc *streamInfo);

/*************************************************************************/
open_error_t openapiMsrpTrafficCountersPerIfClear(openapiClientHandle_t *client_handle, uint32_t intIfNum);

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


#endif /* OPENAPI_MSRP_H_INCLUDED */