Green Mode EEE API [OPENAPI_GREEN_ETHERNET_EEE_API]

Functions
open_error_t	openapiGreenEthrEeeAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *adminMode)
	Get EEE admin mode. More...
open_error_t	openapiGreenEthrEeeAdminModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t adminMode)
	Set EEE administrative mode. More...
open_error_t	openapiGreenEthrEeeEchoRxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *echoRxTwsys)
	Get the port's EEE echo receive Twsys. More...
open_error_t	openapiGreenEthrEeeEchoTxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *echoTxTwsys)
	Get the port's EEE echo transmit Twsys. More...
open_error_t	openapiGreenEthrEeeFbTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *fbTwsys)
	Get the port's EEE fallback receive Twsys. More...
open_error_t	openapiGreenEthrEeeIsValidIntf (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
	Determine if the interface is valid. More...
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)
	Get some common green ethernet eee counters for the given local interface. More...
open_error_t	openapiGreenEthrEeeRemFbTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t remIndex, uint32_t timestamp, uint32_t *remFbTwsys)
	Get the remote port's EEE fallback Twsys. More...
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)
	Get some common green ethernet eee counters for the given remote interface. More...
open_error_t	openapiGreenEthrEeeRemRxTwsysEchoGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t remIndex, uint32_t timestamp, uint32_t *remRxTwsysEcho)
	Get the remote port's EEE receive Twsys echo. More...
open_error_t	openapiGreenEthrEeeRemRxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t remIndex, uint32_t timestamp, uint32_t *remRxTwsys)
	Get the remote port's EEE receive Twsys. More...
open_error_t	openapiGreenEthrEeeRemTxTwsysEchoGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t remIndex, uint32_t timestamp, uint32_t *remTxTwsysEcho)
	Get the remote port's EEE transmit Twsys echo. More...
open_error_t	openapiGreenEthrEeeRemTxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t remIndex, uint32_t timestamp, uint32_t *remTxTwsys)
	Get the remote port's EEE transmit Twsys. More...
open_error_t	openapiGreenEthrEeeRxDllEnableGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *enable)
	Get the receive DLL enable status. More...
open_error_t	openapiGreenEthrEeeRxDllReadyGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *ready)
	Get the receive DLL ready status. More...
open_error_t	openapiGreenEthrEeeRxDurationGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *high, uint32_t *low)
	Get EEE receive LPI duration (counts in 10usec increments) More...
open_error_t	openapiGreenEthrEeeRxEventsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *count)
	Get EEE receive LPI event count. More...
open_error_t	openapiGreenEthrEeeRxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *rxTwsys)
	Get EEE receive Tw_sys (uSec) More...
open_error_t	openapiGreenEthrEeeStatisticsClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear EEE statistics counters. More...
open_error_t	openapiGreenEthrEeeTimeSinceLastStatsResetGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint64_t *value)
	Determine time of last stats reset. More...
open_error_t	openapiGreenEthrEeeTotalLpiTimeGet (openapiClientHandle_t *client_handle, uint32_t *lpiTotalTime)
	Get percentage of total LPI time spent for all interfaces in stack. More...
open_error_t	openapiGreenEthrEeeTxDllEnableGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *enable)
	Get the transmit DLL enable status. More...
open_error_t	openapiGreenEthrEeeTxDllReadyGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *ready)
	Get the transmit DLL ready status. More...
open_error_t	openapiGreenEthrEeeTxDurationGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *high, uint32_t *low)
	Get EEE transmit LPI duration (counts in 10usec increments) More...
open_error_t	openapiGreenEthrEeeTxEventsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *count)
	Get EEE transmit LPI event count. More...
open_error_t	openapiGreenEthrEeeTxIdleTimeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eeeTxIdleTime)
	Get EEE transmit Idle Time. More...
open_error_t	openapiGreenEthrEeeTxIdleTimeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t eeeTxIdleTime)
	Set EEE transmit idle time. More...
open_error_t	openapiGreenEthrEeeTxTwsysGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *txTwsys)
	Get EEE transmit Tw_sys (uSec) More...
open_error_t	openapiGreenEthrEeeTxWakeTimeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eeeTxWakeTime)
	Get EEE transmit Wake Time. More...
open_error_t	openapiGreenEthrEeeTxWakeTimeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t eeeTxWakeTime)
	Set EEE transmit wake time. More...
open_error_t	openapiGreenEthrEeeValidIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
	Get the first interface that is valid for green Ethernet EEE. More...
open_error_t	openapiGreenEthrEeeValidIntfNextGet (openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *intIfNum)
	Get the next interface that is valid for Green Ethernet EEE. More...
open_error_t	openapiGreenEthrFeaturesSupportedGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *featureString)
	Get the port's green feature list supported. More...
open_error_t	openapiGreenEthrGlobalEeeAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Get the global EEE administrative mode. More...
open_error_t	openapiGreenEthrGlobalEeeAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Set the global EEE administrative mode. More...
open_error_t	openapixGreenEthrEeeTimeSinceLastStatsResetGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *days, uint32_t *hours, uint32_t *minutes, uint32_t *seconds)
	Determine time of last stats reset. More...

Detailed Description

Function Documentation

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

Get EEE admin mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	adminMode	admin mode

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:

eee_example.c.

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

Set EEE administrative mode.

Parameters

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

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:

eee_example.c.

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

Get the port's EEE echo receive Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	echoRxTwsys	echo receive Twsys

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:

eee_example.c.

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

Get the port's EEE echo transmit Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	echoTxTwsys	echo transmit Twsys

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:

eee_example.c.

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

Get the port's EEE fallback receive Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	fbTwsys	fallback receive Twsys

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:

eee_example.c.

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

Determine if the interface is valid.

Parameters

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

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:

eee_example.c.

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
	)

Get some common green ethernet eee counters for the given local interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	twSysTx	transmit Twsys
[out]	twSysTxEcho	echo transmit Twsys
[out]	twSysRx	receive Twsys
[out]	twSysRxEcho	echo receive Twsys
[out]	twSysTxFallback	fallback Twsys
[out]	txDllEnabled	transmit dll enable
[out]	txDllReady	transmit dll ready
[out]	rxDllEnabled	receive dll enable
[out]	rxDllReady	receive dll ready

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:

eee_example.c.

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

Get the remote port's EEE fallback Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	remIndex	index associated with this remote entry
[in]	timestamp	time stamp associated with this entry
[out]	remFbTwsys	remote fallback Twsys

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:

eee_example.c.

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
	)

Get some common green ethernet eee counters for the given remote interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	twSysTx	transmit Twsys
[out]	twSysTxEcho	echo transmit Twsys
[out]	twSysRx	receive Twsys
[out]	twSysRxEcho	echo receive Twsys
[out]	twSysTxFallback	fallback Twsys

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:

eee_example.c.

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

Get the remote port's EEE receive Twsys echo.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	remIndex	index associated with this remote entry
[in]	timestamp	time stamp associated with this entry
[out]	remRxTwsysEcho	remote receive Twsys echo

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:

eee_example.c.

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

Get the remote port's EEE receive Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Internal Interface Number
[in]	remIndex	index associated with this remote entry
[in]	timestamp	time stamp associated with this entry
[out]	remRxTwsys	remote receive Twsys

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:

eee_example.c.

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

Get the remote port's EEE transmit Twsys echo.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	time stamp associated with this entry
[out]	remTxTwsysEcho	remote transmit Twsys echo

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:

eee_example.c.

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

Get the remote port's EEE transmit Twsys.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	remIndex	index associated with this remote entry
[in]	timestamp	time stamp associated with this entry
[out]	remTxTwsys	remote transmit Twsys

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:

eee_example.c.

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

Get the receive DLL enable status.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	enable	OPEN_TRUE if DLL is enabled OPEN_FALSE otherwise

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:

eee_example.c.

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

Get the receive DLL ready status.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	ready	OPEN_TRUE if DLL is enabled OPEN_FALSE otherwise

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:

eee_example.c.

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

Get EEE receive LPI duration (counts in 10usec increments)

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	high	high word of duration in uSec
[out]	low	low word of duration in uSec

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:

eee_example.c.

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

Get EEE receive LPI event count.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	count	EEE Recieve event count

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:

eee_example.c.

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

Get EEE receive Tw_sys (uSec)

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	rxTwsys	receive twsys

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:

eee_example.c.

open_error_t openapiGreenEthrEeeStatisticsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear EEE statistics counters.

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_E_UNAVAIL	Not available.

OpEN API Version: 1.26

Examples:

eee_example.c.

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

Determine time of last stats reset.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	value	time in seconds

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:

eee_example.c.

open_error_t openapiGreenEthrEeeTotalLpiTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	lpiTotalTime
	)

Get percentage of total LPI time spent for all interfaces in stack.

Parameters

[in]	client_handle	client handle from registration API
[out]	lpiTotalTime	LPI total time

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:

eee_example.c.

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

Get the transmit DLL enable status.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	enable	OPEN_TRUE if DLL is enabled OPEN_FALSE otherwise

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:

eee_example.c.

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

Get the transmit DLL ready status.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	ready	OPEN_TRUE if DLL is enabled OPEN_FALSE otherwise

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:

eee_example.c.

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

Get EEE transmit LPI duration (counts in 10usec increments)

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	high	high word of duration in uSec
[out]	low	low word of duration in uSec

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:

eee_example.c.

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

Get EEE transmit LPI event count.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	count	EEE Transmit LPI event count

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:

eee_example.c.

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

Get EEE transmit Idle Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eeeTxIdleTime	EEE Transmit Idle Time

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:

eee_example.c.

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

Set EEE transmit idle time.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	eeeTxIdleTime	EEE Transmit Idle Time

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:

eee_example.c.

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

Get EEE transmit Tw_sys (uSec)

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	txTwsys	transmit twsys

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:

eee_example.c.

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

Get EEE transmit Wake Time.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eeeTxWakeTime	EEE Transmit Wake Time

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:

eee_example.c.

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

Set EEE transmit wake time.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	eeeTxWakeTime	EEE Transmit Wake Time

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:

eee_example.c.

open_error_t openapiGreenEthrEeeValidIntfFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	intIfNum
	)

Get the first interface that is valid for green Ethernet EEE.

Parameters

[in]	client_handle	client handle from registration API
[out]	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:

eee_example.c.

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

Get the next interface that is valid for Green Ethernet EEE.

Parameters

[in]	client_handle	client handle from registration API
[in]	prevIfNum	previous interface number
[out]	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:

eee_example.c.

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

Get the port's green feature list supported.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	featureString	feature string

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

open_error_t openapiGreenEthrGlobalEeeAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the global EEE administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	global EEE admin mode

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:

eee_example.c.

open_error_t openapiGreenEthrGlobalEeeAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Set the global EEE administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	global EEE admin mode

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:

eee_example.c.

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

Determine time of last stats reset.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	days	Pointer to days
[out]	hours	Pointer to hours
[out]	minutes	Pointer to minutes
[out]	seconds	Pointer to seconds

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:

eee_example.c.