openapi_boxs.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2016-2019 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_boxs.h
*
* @purpose   Box Services Configuration and Status
*
* @component OPEN
*
* @create    11/09/2012
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_BOXS_H_INCLUDED
#define OPENAPI_BOXS_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_ITEMSTATE_NONE           = 0, /* N/A */
  OPEN_ITEMSTATE_NOT_PRESENT    = 1,
  OPEN_ITEMSTATE_OPERATIONAL    = 2,
  OPEN_ITEMSTATE_FAILED         = 3,
  OPEN_ITEMSTATE_POWERING       = 4,
  OPEN_ITEMSTATE_NOPOWER        = 5,
  OPEN_ITEMSTATE_NOT_POWERING   = 6,
  OPEN_ITEMSTATE_INCOMPATIBLE   = 7,  /* This state is possible on boards capable of pluggable Power supplies */
  OPEN_ITEMSTATE_WARNING        = 8,
  OPEN_ITEMSTATE_PRESENT        = 9   /* Added for detecting Xcvr inserted state */ 
} OPEN_BOXS_ITEM_STATE_t;

typedef enum
{
  OPEN_TEMPSENSOR_STATE_NONE            = 0, /* N/A */
  OPEN_TEMPSENSOR_STATE_LOW             = 1, 
  OPEN_TEMPSENSOR_STATE_NORMAL          = 2,
  OPEN_TEMPSENSOR_STATE_WARNING         = 3,
  OPEN_TEMPSENSOR_STATE_CRITICAL        = 4,
  OPEN_TEMPSENSOR_STATE_SHUTDOWN        = 5,
  OPEN_TEMPSENSOR_STATE_NOTPRESENT      = 6,
  OPEN_TEMPSENSOR_STATE_NOTOPERATIONAL  = 7
} OPEN_BOXS_TEMPSENSOR_STATE_t;

typedef enum
{
  OPEN_TYPE_NONE        = 0, /* N/A */
  OPEN_TYPE_FIXED       = 1,
  OPEN_TYPE_REMOVABLE   = 2
} OPEN_BOXS_ITEM_TYPE_t;

typedef enum
{
  OPEN_MODULE_NONE      = 0, 
  OPEN_MODULE_SFP       = 1, 
  OPEN_MODULE_SFPPLUS   = 2, 
  OPEN_MODULE_QSFP      = 3, 
  OPEN_MODULE_DAC       = 4, 
  OPEN_MODULE_AX741     = 5, 
  OPEN_MODULE_AX742     = 6, 
  OPEN_MODULE_AX743     = 7, 
  OPEN_MODULE_AX744     = 8, 
  OPEN_MODULE_AX745     = 9, 
  OPEN_MODULE_HDMI      = 10  
}OPEN_SFP_MODULE_TYPE_t;

typedef enum
{
  OPEN_LED_CMD_OFF = 0,
  OPEN_LED_CMD_ON = 1
}OPEN_LED_CMD_t;

typedef enum
{
  OPEN_LED_STATUS_OFF = 0,
  OPEN_LED_STATUS_ON = 1
}OPEN_LED_STATUS_t;      

#define OPEN_BXS_STR_BUFFER_SIZE 128    
/******************************************************************************/
open_error_t openapiFiberPortsOpticsFaultStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
                                                   uint32_t *localFaultStatus, uint32_t *remoteFaultStatus);

/******************************************************************************/
open_error_t openapiFiberPortsOpticsGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
                                        uint32_t *temperature, uint32_t *voltage, uint32_t *current,
                                        uint64_t *powerIn, uint64_t *powerOut,
                                        OPEN_BOOL_t *txFault, OPEN_BOOL_t *los);

/******************************************************************************/
open_error_t openapiFiberPortsLaneOpticsGet(openapiClientHandle_t *client_handle, uint32_t ifNum,  uint32_t lane,
                                            uint32_t *temperature, uint32_t *voltage, uint32_t *current,
                                            open_buffdesc *powerIn, open_buffdesc *powerOut,
                                            OPEN_BOOL_t *txFault, OPEN_BOOL_t *los);

/*****************************************************************/
open_error_t openapiFiberPortsTransceiverPresenceGet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum, OPEN_BOOL_t *present);

/*****************************************************************/
open_error_t openapiBoxsiGeneralFanSpeedGet (openapiClientHandle_t * client_handle,
                                             uint32_t * genFanSpeed);

/*****************************************************************/
open_error_t openapiBoxsiGeneralFanDutyLevelGet (openapiClientHandle_t * client_handle,
                                                 uint32_t * genFanDutyLevel);

/******************************************************************************/
open_error_t openapiBoxsNumOfFansGet (openapiClientHandle_t * client_handle,
                                     uint32_t * numFans);

/*****************************************************************/
open_error_t openapiBoxsFanSpeedGet (openapiClientHandle_t * client_handle,
             uint32_t fanNum, uint32_t * fanSpeed);


/*****************************************************************/
open_error_t openapiBoxsFanStateGet (openapiClientHandle_t * client_handle,
            uint32_t fanNum,
            OPEN_BOXS_ITEM_STATE_t * fanState);

/*****************************************************************/
open_error_t openapiBoxsFanTypeGet (openapiClientHandle_t * client_handle,
            uint32_t fanNum,
            OPEN_BOXS_ITEM_TYPE_t * fanType);

/*****************************************************************/
open_error_t openapiBoxsFanDutyCycleGet (openapiClientHandle_t * client_handle,
          uint32_t fanNum, uint32_t * fanDuty);

/*****************************************************************************************/
open_error_t openapiBoxsFanDescripSizeGet (openapiClientHandle_t *
                                           client_handle,
                                           uint32_t * descripSize);

/*****************************************************************************************/
open_error_t openapiBoxsFanDescripGet (openapiClientHandle_t *
                                       client_handle,
                                       uint32_t fanNum,
                                       open_buffdesc * descrip);

/*****************************************************************/
open_error_t openapiBoxsNumOfPowSuppliesGet (openapiClientHandle_t *
              client_handle,
              uint32_t * numPowSuplies);

/*****************************************************************/
open_error_t openapiBoxsPowSupplyStateGet (openapiClientHandle_t *
            client_handle, uint32_t psNo,
            OPEN_BOXS_ITEM_STATE_t * psState);

/*****************************************************************/
open_error_t openapiBoxsPowSupplyTypeGet (openapiClientHandle_t *
            client_handle, uint32_t psNo,
            OPEN_BOXS_ITEM_TYPE_t * psType);

/*****************************************************************************************/
open_error_t openapiBoxsPowSupplyDescripSizeGet (openapiClientHandle_t *
                                                 client_handle,
                                                 uint32_t * descripSize);

/*****************************************************************************************/
open_error_t openapiBoxsPowSupplyDescripGet (openapiClientHandle_t *
                                             client_handle,
                                             uint32_t psNum,
                                             open_buffdesc * descrip);

/*****************************************************************/
open_error_t openapiBoxsTempRangeGet (openapiClientHandle_t *
                                      client_handle,
                                      uint32_t * minTemp,
                                      uint32_t * maxTemp);

/************************************************************************************/
open_error_t openapiBoxsGeneralTempGet (openapiClientHandle_t *
                                        client_handle,
                                        uint32_t * genTemp);

/*****************************************************************/
open_error_t openapiBoxsNumOfTempSensorsGet (openapiClientHandle_t *
              client_handle,
              uint32_t * numOfTempSemsors);

/*****************************************************************************************/
open_error_t openapiBoxsTempSensorDescripSizeGet (openapiClientHandle_t *
             client_handle,
             uint32_t * descripSize);

/*****************************************************************************************/
open_error_t openapiBoxsTempSensorDescripGet (openapiClientHandle_t *
               client_handle,
               uint32_t sensorNum,
               open_buffdesc * descrip);

/************************************************************************************/
open_error_t openapiBoxsTempGet (openapiClientHandle_t * client_handle,
        uint32_t sensorNum, uint32_t * temperature);

/*****************************************************************/
open_error_t openapiBoxsTempSensorStatusGet (openapiClientHandle_t *
              client_handle, uint32_t sensorNum,
              OPEN_BOXS_TEMPSENSOR_STATE_t *
              state);

/*******************************************************************************/
open_error_t openapiBoxsTempSensorMaxTempGet (openapiClientHandle_t *
                                              client_handle,
                                              uint32_t sensorNum,
                                              uint32_t * maxTemperature);

/*****************************************************************/
open_error_t openapiBoxsSfpTypeGet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum, OPEN_SFP_MODULE_TYPE_t *moduleType);

/*****************************************************************/
open_error_t openapiBoxsSfpVendorNameGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum, open_buffdesc *vendorNameDesc);

/*****************************************************************/
open_error_t openapiBoxsSfpSerialNumberGet(openapiClientHandle_t *client_handle,
                                           uint32_t ifNum, open_buffdesc *serialNumberDesc);

/*****************************************************************/
open_error_t openapiBoxsSfpPartNumberGet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, open_buffdesc *partNumberDesc);


/*****************************************************************/
open_error_t openapiBoxsSfpVendorRevisionGet(openapiClientHandle_t *client_handle,
                                             uint32_t ifNum, open_buffdesc *vendorRevDesc);

/*****************************************************************/
open_error_t openapiBoxsSfpLinkLength50umGet(openapiClientHandle_t *client_handle,
                                             uint32_t ifNum, uint32_t *linkLength50um);

/*****************************************************************/
open_error_t openapiBoxsSfpLinkLength62_5umGet(openapiClientHandle_t *client_handle,
                                               uint32_t ifNum, uint32_t *linkLength62_5um);

/*****************************************************************/
open_error_t openapiBoxsSfpNominalSignalRate(openapiClientHandle_t *client_handle,
                                             uint32_t ifNum, uint32_t *nominalSigRate);

/*****************************************************************/
open_error_t openapiBoxsSfpComplianceGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum, open_buffdesc *complianceDesc);

/*****************************************************************/
open_error_t openapiBoxsSfpVendorNameSizeGet(openapiClientHandle_t *client_handle,
                                             uint32_t *vendorNameSize);

/*****************************************************************/
open_error_t openapiBoxsSfpSerialNumberSizeGet(openapiClientHandle_t *client_handle,
                                               uint32_t *serialNumberSize);

/*****************************************************************/
open_error_t openapiBoxsSfpPartNumberSizeGet(openapiClientHandle_t *client_handle,
                                             uint32_t *partNumberSize);

/*****************************************************************/
open_error_t openapiBoxsSfpVendorRevSizeGet(openapiClientHandle_t *client_handle,
                                            uint32_t *vendorRevSize);

/*****************************************************************/
open_error_t openapiBoxsSfpComplianceSizeGet(openapiClientHandle_t *client_handle,
                                             uint32_t *complianceSize);

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

/*****************************************************************/
open_error_t openapiPortLocatorInterfaceEnable(openapiClientHandle_t *client_handle, 
                                               uint32_t interface, 
                                               OPEN_CONTROL_t enable);

/*****************************************************************/
open_error_t openapiCpldVersionGet(openapiClientHandle_t *client_handle,
                                   open_buffdesc         *cpldVersion);

/******************************************************************************/
open_error_t openapiBoxsHwVersionGet(openapiClientHandle_t *client_handle,
                                     uint32_t *version);

/*****************************************************************/
open_error_t openapiBoxsPortLedsModeSet(openapiClientHandle_t *client_handle,
                                        OPEN_LED_CMD_t val);

/*****************************************************************/
open_error_t openapiBoxsPortLedsModeGet(openapiClientHandle_t *client_handle,
                                        OPEN_LED_STATUS_t *val);

/*****************************************************************/
open_error_t openapiBoxsSystemLedModeSet(openapiClientHandle_t *client_handle,
                                         OPEN_LED_CMD_t val);

/*****************************************************************/
open_error_t openapiBoxsSystemLedModeGet(openapiClientHandle_t *client_handle,
                                         OPEN_LED_STATUS_t *val);
#endif /* OPENAPI_BOXS_H_INCLUDED */