openapi_green_pwr_sav_history.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_sav_history.h
*
* @purpose   Green mode power savings history API
*
* @component OpEN
*
* @create    05/31/2023
*
* @end
*
**********************************************************************/
#ifndef _OPENAPI_GREEN_PWR_SAV_HISTORY_H_
#define _OPENAPI_GREEN_PWR_SAV_HISTORY_H_

#include "openapi_common.h"

typedef struct
{
  uint16_t sampleNo;            
  uint32_t sampleTime;          
  uint16_t percentLpiTime;      
  uint16_t percentLpiTimeTotal; 
  void     *nextEntry;          
}openGreenPwrHistoryIntfEntry_t;

/*****************************************************************/
open_error_t openapiGreenEthrEeeLpiHistoryIntfSampleIntervalSet(openapiClientHandle_t *client_handle,
                                                                uint32_t sampleInterval);

/*****************************************************************/
open_error_t openapiGreenEthrEeeLpiHistoryIntfSampleIntervalGet(openapiClientHandle_t *client_handle,
                                                                uint32_t *sampleInterval);

/*****************************************************************/
open_error_t openapiGreenEthrEeeLpiHistoryIntfMaxSamplesSet(openapiClientHandle_t *client_handle,
                                                            uint32_t maxSamples);

/*****************************************************************/
open_error_t openapiGreenEthrEeeLpiHistoryIntfMaxSamplesGet(openapiClientHandle_t *client_handle,
                                                            uint32_t *maxSamples);

/*****************************************************************/
open_error_t openapix2GreenEthrPwrSavHistoryIntfFirstEntryGet(openapiClientHandle_t *client_handle,
                                                              uint32_t intIfNum,
                                                              openGreenPwrHistoryIntfEntry_t *entry);

/*****************************************************************/
open_error_t openapix2GreenEthrPwrSavHistoryIntfNextEntryGet(openapiClientHandle_t *client_handle,
                                                             openGreenPwrHistoryIntfEntry_t *entry);

/*****************************************************************/
open_error_t openapix2GreenEthrPwrSavHistoryIntfNextSampleGet(openapiClientHandle_t *client_handle,
                                                              uint32_t intIfNum,
                                                              uint16_t curSample,
                                                              openGreenPwrHistoryIntfEntry_t *entry);

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

#endif /* OPENAPI_GREEN_PWR_SAV_HISTORY_H */