openapi_green_ethernet_eee_api.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-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_green_ethernet_eee_api.h
*
* @purpose   Green Mode EEE API
*
* @component OpEN
*
* @create    05/31/2023
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_GREEN_ETHERNET_EEE_API_H
#define OPENAPI_GREEN_ETHERNET_EEE_API_H

/*****************************************************************/
open_error_t openapiGreenEthrEeeIsValidIntf(openapiClientHandle_t *client_handle,
                                            uint32_t intIfNum, OPEN_BOOL_t *valid);

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

/*****************************************************************/
open_error_t openapiGreenEthrEeeValidIntfNextGet(openapiClientHandle_t *client_handle,
                                                 uint32_t prevIfNum, uint32_t *intIfNum);

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

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxIdleTimeGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t *eeeTxIdleTime);

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxWakeTimeGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t *eeeTxWakeTime);

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

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxIdleTimeSet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t eeeTxIdleTime);

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxWakeTimeSet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t eeeTxWakeTime);

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

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxEventsGet(openapiClientHandle_t *client_handle,
                                            uint32_t intIfNum, uint32_t *count);

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxDurationGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t *high,
                                              uint32_t *low);

/**********************************************************************/
open_error_t openapiGreenEthrEeeRxEventsGet(openapiClientHandle_t *client_handle,
                                            uint32_t intIfNum, uint32_t *count);

/**********************************************************************/
open_error_t openapiGreenEthrEeeRxDurationGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t *high,
                                              uint32_t *low);

/**********************************************************************/
open_error_t openapiGreenEthrEeeTxTwsysGet(openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t *txTwsys);

/**********************************************************************/
open_error_t openapiGreenEthrEeeRxTwsysGet(openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t *rxTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeFbTwsysGet(openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t *fbTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeEchoTxTwsysGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum, uint32_t *echoTxTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeEchoRxTwsysGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum, uint32_t *echoRxTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRemTxTwsysGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t remIndex,
                                              uint32_t timestamp, uint32_t *remTxTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRemTxTwsysEchoGet(openapiClientHandle_t *client_handle,
                                                  uint32_t intIfNum, uint32_t remIndex,
                                                  uint32_t timestamp, uint32_t *remTxTwsysEcho);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRemRxTwsysGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t remIndex,
                                              uint32_t timestamp, uint32_t *remRxTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRemRxTwsysEchoGet(openapiClientHandle_t *client_handle,
                                                  uint32_t intIfNum, uint32_t remIndex,
                                                  uint32_t timestamp, uint32_t *remRxTwsysEcho);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRemFbTwsysGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t remIndex,
                                              uint32_t timestamp, uint32_t *remFbTwsys);

/*****************************************************************/
open_error_t openapiGreenEthrEeeTxDllEnableGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum, OPEN_BOOL_t *enable);

/*****************************************************************/
open_error_t openapiGreenEthrEeeTxDllReadyGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, OPEN_BOOL_t *ready);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRxDllEnableGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum, OPEN_BOOL_t *enable);

/*****************************************************************/
open_error_t openapiGreenEthrEeeRxDllReadyGet(openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, OPEN_BOOL_t *ready);

/*****************************************************************/
open_error_t openapiGreenEthrEeeTimeSinceLastStatsResetGet(openapiClientHandle_t *client_handle,
                                                           uint32_t intIfNum, uint64_t *value);

/*****************************************************************/
open_error_t openapixGreenEthrEeeTimeSinceLastStatsResetGet(openapiClientHandle_t *client_handle,
                                                            uint32_t intIfNum, uint32_t *days,
                                                            uint32_t *hours, uint32_t *minutes,
                                                            uint32_t *seconds);

/**********************************************************************/
open_error_t openapiGreenEthrEeeTotalLpiTimeGet(openapiClientHandle_t *client_handle,
                                                uint32_t *lpiTotalTime);

/**********************************************************************/
open_error_t openapiGreenEthrEeeLocalSummaryGet(openapiClientHandle_t *client_handle,
                                                uint32_t intIfNum,
                                                uint32_t *twSysTx,
                                                uint32_t *twSysTxEcho,
                                                uint32_t *twSysRx,
                                                uint32_t *twSysRxEcho,
                                                uint32_t *twSysTxFallback,
                                                uint32_t *txDllEnabled,
                                                uint32_t *txDllReady,
                                                uint32_t *rxDllEnabled,
                                                uint32_t *rxDllReady);

/**********************************************************************/
open_error_t openapiGreenEthrEeeRemoteSummaryGet(openapiClientHandle_t *client_handle,
                                                 uint32_t intIfNum,
                                                 uint32_t *twSysTx,
                                                 uint32_t *twSysTxEcho,
                                                 uint32_t *twSysRx,
                                                 uint32_t *twSysRxEcho,
                                                 uint32_t *twSysTxFallback);

/*****************************************************************/
open_error_t openapiGreenEthrFeaturesSupportedGet(openapiClientHandle_t *client_handle,
                                                  uint32_t unit, open_buffdesc *featureString);

/**********************************************************************/
open_error_t openapiGreenEthrGlobalEeeAdminModeGet(openapiClientHandle_t *client_handle,
                                                   OPEN_CONTROL_t *adminMode);
 
/**********************************************************************/
open_error_t openapiGreenEthrGlobalEeeAdminModeSet(openapiClientHandle_t *client_handle,
                                                   OPEN_CONTROL_t adminMode);

#endif /* OPENAPI_GREEN_ETHERNET_EEE_API_H */