openapi_pfc.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2017-2018 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.
*
*  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_pfc.h
*
* @purpose   Priority-based Flow Control Configuration and Statistics APIs.
*
* @component OPEN
*
* @create    01/23/2017
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_PFC_H_INCLUDED
#define OPENAPI_PFC_H_INCLUDED

#include <stdio.h>
#include <stddef.h>
#include <sys/un.h>

#include "openapi_common.h"

typedef enum 
{
  OPEN_PFC_PRI_DROP_MODE = 0,           
  OPEN_PFC_PRI_NODROP_MODE = 1          
} OPEN_PFC_PRI_DROP_MODE_t; 

typedef enum 
{
  OPEN_PFC_ACTION_DROP = 0,             
  OPEN_PFC_ACTION_NO_DROP = 1           
} OPEN_PFC_ACTION_t; 

typedef enum
{
  OPEN_PFC_FEATURE_SUPPORTED = 0,       
  OPEN_PFC_PORT_PRIORITY_FLOW_CONTROL_FEATURE_ID = 1, 
  OPEN_PFC_TX_STATS_FEATURE_ID = 2,     
} OPEN_PFC_FEATURE_IDS_t;

typedef enum
{
  OPEN_PFC_MODE_DISABLE = 0,            
  OPEN_PFC_MODE_ENABLE = 1              
} OPEN_PFC_MODE_t;

typedef enum
{
  OPEN_PFC_STATUS_ACTIVE = 0,           
  OPEN_PFC_STATUS_INACTIVE = 1          
} OPEN_PFC_STATUS_t;

typedef enum
{
  OPEN_PFC_DDR_MODE_DISABLE = 0,        
  OPEN_PFC_DDR_MODE_ENABLE = 1          
} OPEN_PFC_DDR_MODE_t;

typedef enum
{
  OPEN_PFC_DDR_ACTION_TRANSMIT = 0,     
  OPEN_PFC_DDR_ACTION_DROP = 1          
} OPEN_PFC_DDR_ACTION_t;

typedef enum
{
  OPEN_PFC_DDR_DETECT_TIME_10MS = 0,    
  OPEN_PFC_DDR_DETECT_TIME_100MS = 1,   
} OPEN_PFC_DDR_DETECT_TIME_t;


#define OPEN_QOS_PFC_PRIORITY_ALL          8
#define OPEN_QOS_PFC_PRIORITY_MIN          0
#define OPEN_QOS_PFC_PRIORITY_MAX          (OPEN_QOS_PFC_PRIORITY_ALL-1)

#define OPEN_PFC_DEADLOCK_DETECT_TIME_MIN  0
#define OPEN_PFC_DEADLOCK_DETECT_TIME_MAX  1500

/*****************************************************************/
open_error_t openapiPfcPeerIncompatibleCfgCountGet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum,
                                                   uint32_t *incompatibleCfgCount);

/*****************************************************************/
open_error_t openapiPfcPeerWillingGet(openapiClientHandle_t *client_handle,
                                      uint32_t ifNum,
                                      OPEN_BOOL_t *willing);

/*****************************************************************/
open_error_t openapiPfcPeerMbcStatusGet(openapiClientHandle_t *client_handle,
                                        uint32_t ifNum,
                                        OPEN_BOOL_t *mbcStatus);

/*****************************************************************/
open_error_t openapiPfcPeerCapabilityGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum,
                                         uint32_t *numPfcCap);

/*****************************************************************/
open_error_t openapiPfcAdvPriorityModeGet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum,
                                          uint32_t priority,
                                          OPEN_PFC_PRI_DROP_MODE_t *mode);

/*****************************************************************/
open_error_t openapiPfcPeerPriorityModeGet(openapiClientHandle_t *client_handle,
                                           uint32_t ifNum,
                                           uint32_t priority,
                                           OPEN_PFC_PRI_DROP_MODE_t *mode);

/*****************************************************************/
open_error_t openapiIfPfcModeSet(openapiClientHandle_t *client_handle,
                                 uint32_t ifNum,
                                 OPEN_PFC_MODE_t mode);

/*****************************************************************/
open_error_t openapiIfPfcPriorityModeSet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum,
                                         uint32_t priority,
                                         OPEN_PFC_PRI_DROP_MODE_t dropMode);

/*****************************************************************/
open_error_t openapiPfcMinNoDropPriorityGet(openapiClientHandle_t *client_handle,
                                            uint32_t *minPrio);

/*****************************************************************/
open_error_t openapiPfcMaxNoDropPriorityGet(openapiClientHandle_t *client_handle,
                                            uint32_t *maxPrio);

/*****************************************************************/
open_error_t openapiIfPfcStatsClear(openapiClientHandle_t *client_handle,
                                    uint32_t ifNum);

/*****************************************************************/
open_error_t openapiIfPfcStatusGet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum,
                                   OPEN_PFC_STATUS_t *status);

/*****************************************************************/
open_error_t openapiIfPfcModeGet(openapiClientHandle_t *client_handle,
                                 uint32_t ifNum,
                                 OPEN_PFC_MODE_t *mode);

/*****************************************************************/
open_error_t openapiIfPfcPriorityModeGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum,
                                         uint32_t priority,
                                         OPEN_PFC_PRI_DROP_MODE_t *mode);

/*****************************************************************/
open_error_t openapiPfcOprPriorityModeGet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum,
                                          uint32_t priority,
                                          OPEN_PFC_PRI_DROP_MODE_t *mode);

/*****************************************************************/
open_error_t openapiPfcOperLinkDelayAllowanceGet(openapiClientHandle_t *client_handle,
                                                 uint32_t ifNum,
                                                 uint32_t *allowance);

/*****************************************************************/
open_error_t openapiPfcPeerCfgCompatibleGet(openapiClientHandle_t *client_handle,
                                            uint32_t ifNum,
                                            OPEN_BOOL_t *compatible);

/*****************************************************************/
open_error_t openapiPfcPeerCompatibleCfgCountGet(openapiClientHandle_t *client_handle,
                                                 uint32_t ifNum,
                                                 uint32_t *count);

/*****************************************************************/
open_error_t openapiIfPfcRxPriorityStatGet(openapiClientHandle_t *client_handle,
                                           uint32_t ifNum,
                                           uint32_t priority,
                                           uint32_t *stat);

/*****************************************************************/
open_error_t openapiPfcTxPriorityStatGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum,
                                         uint32_t priority,
                                         uint32_t *count);

/*****************************************************************/
open_error_t openapiIfPfcRxStatGet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum,
                                   uint32_t *count);

/*****************************************************************/
open_error_t openapiIfPfcTxStatGet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum,
                                   uint32_t *count);

/*****************************************************************/
open_error_t openapiIfPfcDeadlockConfigSet(openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t priority,
                                           OPEN_PFC_DDR_MODE_t mode);

/*****************************************************************/
open_error_t openapiIfPfcDeadlockConfigGet(openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t priority,
                                           OPEN_PFC_DDR_MODE_t *mode);

/*****************************************************************/
open_error_t openapiPfcDeadlockDetectIntervalSet(openapiClientHandle_t *client_handle,
                                                 OPEN_PFC_DDR_DETECT_TIME_t val);

/*****************************************************************/
open_error_t openapiPfcDeadlockDetectIntervalGet(openapiClientHandle_t *client_handle,
                                                 OPEN_PFC_DDR_DETECT_TIME_t *val);

/*****************************************************************/
open_error_t openapiPfcDeadlockRecoveryActionSet(openapiClientHandle_t *client_handle,
                                                 OPEN_PFC_DDR_ACTION_t val);

/*****************************************************************/
open_error_t openapiPfcDeadlockRecoveryActionGet(openapiClientHandle_t *client_handle,
                                                 OPEN_PFC_DDR_ACTION_t *val);

/*****************************************************************/
open_error_t openapiPfcDeadlockDetectTimeSet(openapiClientHandle_t *client_handle,
                                             uint32_t priority, uint32_t val);

/*****************************************************************/
open_error_t openapiPfcDeadlockRecoveryTimeSet(openapiClientHandle_t *client_handle,
                                               uint32_t priority, uint32_t val);

/*****************************************************************/
open_error_t openapiPfcDeadlockDetectTimeGet(openapiClientHandle_t *client_handle,
                                             uint32_t priority, uint32_t *det_time,
                                             uint32_t *rec_time);

#endif /* OPENAPI_PFC_H_INCLUDED */