openapi_green_pwr_estimates.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_pwr_estimates.h
*
* @purpose   Green mode power savings estimates API
*
* @component OpEN
*
* @create    05/31/2023
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_GREEN_PWR_ESTIMATES_H
#define OPENAPI_GREEN_PWR_ESTIMATES_H

/*****************************************************************/
open_error_t openapiGreenPwrEstIntfCurPwrGet(openapiClientHandle_t *client_handle,
                                             uint32_t intIfNum,
                                             uint32_t *pwrConsumption);

/*****************************************************************/
open_error_t openapiGreenPwrEstGlobalCurPwrGet(openapiClientHandle_t *client_handle,
                                               uint32_t *pwrConsumption);

/*****************************************************************/
open_error_t openapiGreenPwrEstIntfCumSavingGet(openapiClientHandle_t *client_handle,
                                                uint32_t intIfNum,
                                                uint32_t *pwrSaving);

/*****************************************************************/
open_error_t openapiGreenPwrEstGlobalCumSavingGet(openapiClientHandle_t *client_handle,
                                                  uint32_t *pwrSaving);

/*****************************************************************/
open_error_t openapiGreenEthrPwrEstGlobalPwrSavingGet(openapiClientHandle_t *client_handle,
                                                      uint32_t *pwrSaving);

/*****************************************************************/
open_error_t openapiGreenEthrIntfStatisticsClear(openapiClientHandle_t *client_handle,
                                                 uint32_t intIfNum);
#endif /* OPENAPI_GREEN_PWR_ESTIMATES_H */