openapi_dot1as.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2020-2022 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_dot1as.h
*
* @purpose   This code implements the OpEN 801AS (dot1as) API(s)
*
* @component OPEN
*
* @create    04/08/2020
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_DOT1AS_H_INCLUDED
#define OPENAPI_DOT1AS_H_INCLUDED

#include "openapi_common.h" 

#define OPEN_DOT1AS_MIN_PRIORITY_VALUE 0
#define OPEN_DOT1AS_MAX_PRIORITY_VALUE 255

#define OPEN_DOT1AS_MIN_PDELAY_THRESHOLD  0           
#define OPEN_DOT1AS_MAX_PDELAY_THRESHOLD  1000000000  
#define OPEN_DOT1AS_MIN_ALLOWED_RESP_LOST 0
#define OPEN_DOT1AS_MAX_ALLOWED_RESP_LOST 65535

#define OPEN_DOT1AS_PDU_TX_INTL_LOG2_MAX    5       
#define OPEN_DOT1AS_PDU_TX_INTL_LOG2_MIN   -5       
#define OPEN_DOT1AS_MIN_PDU_RX_TIMEOUT      2
#define OPEN_DOT1AS_MAX_PDU_RX_TIMEOUT      255

#define OPEN_DOT1AS_CLOCK_ID_LEN   8 
typedef struct
{
  uint8_t id[OPEN_DOT1AS_CLOCK_ID_LEN];
} OPEN_DOT1AS_CLOCK_IDENTITY_t;

typedef enum
{
  OPEN_DOT1AS_CLOCK_PRIORITY1 = 0, 
  OPEN_DOT1AS_CLOCK_PRIORITY2      
} OPEN_DOT1AS_CLOCK_PRIORITY_t;

typedef enum
{
  OPEN_DOT1AS_ROLE_DISABLED = 0,   
  OPEN_DOT1AS_ROLE_MASTER,         
  OPEN_DOT1AS_ROLE_SLAVE,          
  OPEN_DOT1AS_ROLE_PASSIVE,        
} OPEN_DOT1AS_PORT_ROLE_t;

typedef enum
{
  OPEN_DOT1AS_INITIAL_SYNC_TX_INTERVAL = 0,
  OPEN_DOT1AS_CURRENT_SYNC_TX_INTERVAL,
  OPEN_DOT1AS_INITIAL_ANNOUNCE_TX_INTERVAL,
  OPEN_DOT1AS_CURRENT_ANNOUNCE_TX_INTERVAL,
  OPEN_DOT1AS_INITIAL_PDELAY_TX_INTERVAL,
  OPEN_DOT1AS_CURRENT_PDELAY_TX_INTERVAL,
  OPEN_DOT1AS_SYNC_RX_TIMEOUT,
  OPEN_DOT1AS_ANNOUNCE_RX_TIMEOUT,
  OPEN_DOT1AS_PDELAY_RX_TIMEOUT,
  OPEN_DOT1AS_SYNC_RX_TIMEOUT_INTERVAL,
} OPEN_DOT1AS_INTF_INTERVAL_t;

typedef enum
{
  OPEN_DOT1AS_SYNC_TX_COUNT = 1,
  OPEN_DOT1AS_SYNC_RX_COUNT,
  OPEN_DOT1AS_FOLLOWUP_TX_COUNT,
  OPEN_DOT1AS_FOLLOWUP_RX_COUNT,
  OPEN_DOT1AS_ANNOUNCE_TX_COUNT,
  OPEN_DOT1AS_ANNOUNCE_RX_COUNT,
  OPEN_DOT1AS_PDELAY_REQ_TX_COUNT,
  OPEN_DOT1AS_PDELAY_REQ_RX_COUNT,
  OPEN_DOT1AS_PDELAY_RESP_TX_COUNT,
  OPEN_DOT1AS_PDELAY_RESP_RX_COUNT,
  OPEN_DOT1AS_PDELAY_RESP_FOLLOWUP_TX_COUNT,
  OPEN_DOT1AS_PDELAY_RESP_FOLLOWUP_RX_COUNT,
  OPEN_DOT1AS_SIGNALING_TX_COUNT,
  OPEN_DOT1AS_SIGNALING_RX_COUNT,
  OPEN_DOT1AS_SYNC_RX_TIMEOUTS,
  OPEN_DOT1AS_SYNC_RX_DISCARDS,
  OPEN_DOT1AS_ANNOUNCE_RX_TIMEOUTS,
  OPEN_DOT1AS_ANNOUNCE_RX_DISCARDS,
  OPEN_DOT1AS_PDELAY_RX_TIMEOUTS,
  OPEN_DOT1AS_PDELAY_RX_DISCARDS,
  OPEN_DOT1AS_BAD_HEADER_COUNT,
  OPEN_DOT1AS_PTP_DISCARD_COUNT,
  OPEN_DOT1AS_PDELAY_LOST_RESP_EXCEEDED,
  OPEN_DOT1AS_COUNTER_LAST

} OPEN_DOT1AS_COUNTER_TYPE_t;

typedef enum
{
  OPEN_DOT1AS_GM_CHANGE_EVENT,
  OPEN_DOT1AS_GM_PHASE_CHANGE_EVENT,
  OPEN_DOT1AS_GM_FREQ_CHANGE_EVENT,
} OPEN_DOT1AS_GM_EVENT_TYPE_t;

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

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

/*************************************************************************/
open_error_t openapiDot1asIsGrandmasterPresentGet(openapiClientHandle_t *client_handle, OPEN_BOOL_t *grandmasterPresent);

/*************************************************************************/
open_error_t openapiDot1asGrandmasterCapableGet(openapiClientHandle_t *client_handle,                                                OPEN_BOOL_t *grandmasterCapable);

/*************************************************************************/
open_error_t openapiDot1asBestClkIdGet(openapiClientHandle_t *client_handle, 
                                       OPEN_DOT1AS_CLOCK_IDENTITY_t *bestClockId);

/*************************************************************************/
open_error_t openapiDot1asBestClkPriorityGet(openapiClientHandle_t *client_handle, 
                                             OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, 
               uint8_t *clockPriority);

/*************************************************************************/
open_error_t openapiDot1asBestClkStepsGet(openapiClientHandle_t *client_handle, 
                                          uint16_t *bestClkSteps);

/*************************************************************************/
open_error_t openapiDot1asBridgeClkIdGet(openapiClientHandle_t *client_handle, 
                                         OPEN_DOT1AS_CLOCK_IDENTITY_t *bridgeClkId);

/*************************************************************************/
open_error_t openapiDot1asBridgePriorityGet(openapiClientHandle_t *client_handle, 
                                            OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, 
              uint32_t *clockPriority);

/*************************************************************************/
open_error_t openapiDot1asBridgePrioritySet(openapiClientHandle_t *client_handle, 
                                            OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, 
              uint32_t  clockPriority);

/*************************************************************************/
open_error_t openapiDot1asGrandmasterChangeCountGet(openapiClientHandle_t *client_handle, uint32_t *gmChangeCount);

/*************************************************************************/
open_error_t openapiDot1asEventTimestampGet(openapiClientHandle_t *client_handle, 
                                            OPEN_DOT1AS_GM_EVENT_TYPE_t gmEventType, 
              uint32_t *timeStamp);

/*************************************************************************/
open_error_t openapiDot1asIntfModeGet(openapiClientHandle_t *client_handle, 
                                      uint32_t  intfNum, 
                                      OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiDot1asIntfModeSet(openapiClientHandle_t *client_handle, 
                                      uint32_t  intfNum, 
                                      OPEN_CONTROL_t  adminMode);

/*************************************************************************/
open_error_t openapiDot1asIntfIsCapableGet(openapiClientHandle_t *client_handle, 
                                           uint32_t  intfNum, 
                                           OPEN_BOOL_t *isCapable);

/*************************************************************************/
open_error_t openapiDot1asIntfIsMeasuringPdelayGet(openapiClientHandle_t *client_handle, 
                                                   uint32_t  intfNum, 
               OPEN_BOOL_t *isMeasuringPdelay);

/*************************************************************************/
open_error_t openapiDot1asIntfPdelayGet(openapiClientHandle_t *client_handle, 
                                        uint32_t  intfNum, uint32_t *pDelay);

/*************************************************************************/
open_error_t openapiDot1asIntfRoleGet(openapiClientHandle_t *client_handle, 
                                      uint32_t  intfNum, 
              OPEN_DOT1AS_PORT_ROLE_t *intfRole);

/*************************************************************************/
open_error_t openapiDot1asIntfPdelayThresholdGet(openapiClientHandle_t *client_handle, uint32_t  intfNum, uint32_t *threshold);

/*************************************************************************/
open_error_t openapiDot1asIntfPdelayThresholdSet(openapiClientHandle_t *client_handle, uint32_t  intfNum, uint32_t  threshold);

/*************************************************************************/
open_error_t openapiDot1asIntfAllowedLostRespGet(openapiClientHandle_t *client_handle, uint32_t  intfNum, uint32_t *numAllowedLostResp);

/*************************************************************************/
open_error_t openapiDot1asIntfAllowedLostRespSet(openapiClientHandle_t *client_handle, uint32_t  intfNum, uint32_t  numAllowedLostResp);

/*************************************************************************/
open_error_t openapiDot1asIntfNeighborRateRatioGet(openapiClientHandle_t *client_handle, 
                                                   uint32_t  intfNum, 
               uint32_t *rateRatio);

/*************************************************************************/
open_error_t openapiDot1asIntfIntervalGet(openapiClientHandle_t *client_handle, uint32_t  intfNum, OPEN_DOT1AS_INTF_INTERVAL_t  intervalType, int32_t *interval);

/*************************************************************************/
open_error_t openapiDot1asIntfIntervalSet(openapiClientHandle_t *client_handle, uint32_t  intfNum, OPEN_DOT1AS_INTF_INTERVAL_t  intervalType, int32_t  interval);

/*************************************************************************/
open_error_t openapiDot1asIntfStatsGet(openapiClientHandle_t *client_handle, 
                                       uint32_t  intfNum, 
               OPEN_DOT1AS_COUNTER_TYPE_t  CounterType, 
               uint32_t *counterValue);

/*************************************************************************/
open_error_t openapiDot1asIntfStatsReset(openapiClientHandle_t *client_handle, 
                                         uint32_t  intfNum);


#endif /* OPENAPI_DOT1AS_H_INCLUDED */