openapi_flow_control.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_flow_control.h
*
* @purpose   This code implements the OpEN Flow Control API
*
* @component OPEN
*
* @create    06/08/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_FLOWCONTROL_H_INCLUDED
#define OPENAPI_FLOWCONTROL_H_INCLUDED

#include "openapi_common.h" 

typedef enum
{
  OPEN_FLOWCTRL_OFF = 0,  
  OPEN_FLOWCTRL_SYMM,     
  OPEN_FLOWCTRL_ASYMM,    
} OPEN_FLOWCONTROL_t;

typedef enum
{
  OPEN_FLOWCTRL_INACTIVE = 0, 
  OPEN_FLOWCTRL_ACTIVE,       
} OPEN_FLOWCONTROL_OPER_t;

/*************************************************************************/
open_error_t openapiFlowControlModeGet(openapiClientHandle_t *client_handle, 
                                       OPEN_FLOWCONTROL_t *mode);

/*************************************************************************/
open_error_t openapiFlowControlModeSet(openapiClientHandle_t *client_handle, 
                                       OPEN_FLOWCONTROL_t mode);

/*************************************************************************/
open_error_t openapiFlowControlIfModeGet(openapiClientHandle_t *client_handle, 
                                         uint32_t ifNum, OPEN_FLOWCONTROL_t *mode);

/*************************************************************************/
open_error_t openapiFlowControlIfModeSet(openapiClientHandle_t *client_handle, 
                                         uint32_t ifNum, OPEN_FLOWCONTROL_t mode);

/*************************************************************************/
open_error_t openapiFlowControlIfOperModeGet(openapiClientHandle_t *client_handle, 
                                             uint32_t ifNum, 
                                             OPEN_FLOWCONTROL_OPER_t *mode);

/*************************************************************************/
open_error_t openapiFlowControlIfPauseFramesRxGet(openapiClientHandle_t *client_handle, 
                                                  uint32_t ifNum, uint32_t *rxCount);

/*************************************************************************/
open_error_t openapiFlowControlIfPauseFramesTxGet(openapiClientHandle_t *client_handle, 
                                                  uint32_t ifNum, uint32_t *txCount);


#endif /* OPENAPI_FLOWCONTROL_H_INCLUDED */