Green Mode Power Savings History API [OPENAPI_GREEN_PWR_SAV_HISTORY]

Data Structures
struct	openGreenPwrHistoryIntfEntry_t

Functions
open_error_t	openapiGreenEthrEeeLpiHistoryIntfMaxSamplesGet (openapiClientHandle_t *client_handle, uint32_t *maxSamples)
	Get green mode power saving history max samples to keep. More...
open_error_t	openapiGreenEthrEeeLpiHistoryIntfMaxSamplesSet (openapiClientHandle_t *client_handle, uint32_t maxSamples)
	Set green mode power saving history max samples to keep. More...
open_error_t	openapiGreenEthrEeeLpiHistoryIntfSampleIntervalGet (openapiClientHandle_t *client_handle, uint32_t *sampleInterval)
	Get green mode power saving history sampling interval. More...
open_error_t	openapiGreenEthrEeeLpiHistoryIntfSampleIntervalSet (openapiClientHandle_t *client_handle, uint32_t sampleInterval)
	Set green mode power saving history sampling interval. More...
open_error_t	openapiGreenEthrPwrSavHistoryIntfStatisticsClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear green mode power saving history statistics for the given interface. More...
open_error_t	openapix2GreenEthrPwrSavHistoryIntfFirstEntryGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, openGreenPwrHistoryIntfEntry_t *entry)
	Get first valid entry of green mode power savings history on given interface - latest sample first. More...
open_error_t	openapix2GreenEthrPwrSavHistoryIntfNextEntryGet (openapiClientHandle_t *client_handle, openGreenPwrHistoryIntfEntry_t *entry)
	Get next valid entry of green mode power savings history on given interface. More...
open_error_t	openapix2GreenEthrPwrSavHistoryIntfNextSampleGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint16_t curSample, openGreenPwrHistoryIntfEntry_t *entry)
	Get next entry of green mode power savings history on given interface with current sample number as input - get entries in reverse order. More...

Detailed Description

Function Documentation

open_error_t openapiGreenEthrEeeLpiHistoryIntfMaxSamplesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxSamples
	)

Get green mode power saving history max samples to keep.

Parameters

[in]	client_handle	client handle from registration API
[out]	maxSamples	max samples

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

open_error_t openapiGreenEthrEeeLpiHistoryIntfMaxSamplesSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxSamples
	)

Set green mode power saving history max samples to keep.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxSamples	max samples

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

open_error_t openapiGreenEthrEeeLpiHistoryIntfSampleIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	sampleInterval
	)

Get green mode power saving history sampling interval.

Parameters

[in]	client_handle	client handle from registration API
[out]	sampleInterval	sampling interval

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

open_error_t openapiGreenEthrEeeLpiHistoryIntfSampleIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	sampleInterval
	)

Set green mode power saving history sampling interval.

Parameters

[in]	client_handle	client handle from registration API
[in]	sampleInterval	sampling interval

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

open_error_t openapiGreenEthrPwrSavHistoryIntfStatisticsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear green mode power saving history statistics for the given interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

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

Get first valid entry of green mode power savings history on given interface - latest sample first.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	entry	first valid history entry on the interface

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

Note

To get the time since the sample was recorded, subtract the entry->sampleTime from the system up time

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

open_error_t openapix2GreenEthrPwrSavHistoryIntfNextEntryGet	(	openapiClientHandle_t *	client_handle,
		openGreenPwrHistoryIntfEntry_t *	entry
	)

Get next valid entry of green mode power savings history on given interface.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	entry	current entry on the interface

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

Note

To get the time since the sample was recorded, subtract the entry->sampleTime from the system up time

OpEN API Version: 1.26

Examples:

green_pwr_sav_history_example.c.

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

Get next entry of green mode power savings history on given interface with current sample number as input - get entries in reverse order.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	curSample	current Sample Number on the interface
[out]	entry	next entry

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Not available.

OpEN API Version: 1.26