Green Ethernet API [OPENAPI_GREEN_ETHERNET]

Enumerations
enum	OPEN_GREEN_ETH_OPER_STATUS_t {   OPEN_GREENETHR_ADMIN_DOWN, OPEN_GREENETHR_FIBER_PORT, OPEN_GREENETHR_LINK_UP, OPEN_GREENETHR_LINK_DOWN,   OPEN_GREENETHR_LONG_CABLE, OPEN_GREENETHR_SHORT_CABLE, OPEN_GREENETHR_UNKWN_CABLE_LEN, OPEN_GREENETHR_NO_ENERGY,   OPEN_GREENETHR_FORCED, OPEN_GREENETHR_NOT1GIG, OPEN_GREENETHR_NOT_ATTACHED, OPEN_GREENETHR_INVALID_VAL }

Functions
open_error_t	openapiGreenEthrEnergyDetectAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode)
	Get the energy detect admin mode. More...
open_error_t	openapiGreenEthrEnergyDetectModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode)
	Set the energy-detect mode. More...
open_error_t	openapiGreenEthrEnergyDetectOprStatusGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, OPEN_GREEN_ETH_OPER_STATUS_t *reason)
	Get the energy-detect operational status and reason. More...
open_error_t	openapiGreenEthrEnergyDetectOprStatusStrGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, open_buffdesc *reasonStr)
	Get the energy-detect operational status and reason. More...
open_error_t	openapiGreenEthrGlobalEnergyDetectModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Get the global energy detect administrative mode. More...
open_error_t	openapiGreenEthrGlobalEnergyDetectModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Set the global energy detect administrative mode. More...
open_error_t	openapiGreenEthrGlobalShortReachModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Get the global auto short reach administrative mode. More...
open_error_t	openapiGreenEthrGlobalShortReachModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Set the global auto short reach administrative mode. More...
open_error_t	openapiGreenEthrIsIntfEEECapable (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
	Determine if the interface is EEE capable. More...
open_error_t	openapiGreenEthrIsValidIntfType (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
	Determine if the interface is valid for green ethernet operation. More...
open_error_t	openapiGreenEthrShrtRchAutoAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *mode)
	Get the short-reach auto admin mode. More...
open_error_t	openapiGreenEthrShrtRchAutoModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t mode)
	Set the short-reach auto mode. More...
open_error_t	openapiGreenEthrShrtRchForceAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *mode)
	Get the short-reach force admin mode. More...
open_error_t	openapiGreenEthrShrtRchForceModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t mode)
	Set the short-reach into force mode. More...
open_error_t	openapiGreenEthrShrtRchOprStatusGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, OPEN_GREEN_ETH_OPER_STATUS_t *reason)
	Get the short-reach operational status and reason. More...
open_error_t	openapiGreenEthrShrtRchOprStatusStrGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *oprStatus, open_buffdesc *bufd)
	Get the short-reach operational status and reason. More...
open_error_t	openapiGreenEthrValidIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
	Get the first interface that is valid for green ethernet. More...
open_error_t	openapiGreenEthrValidIntfNextGet (openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *intIfNum)
	Get the next interface that is valid for green ethernet. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_GREEN_ETH_OPER_STATUS_t

Enumerator
OPEN_GREENETHR_ADMIN_DOWN	Admin down.
OPEN_GREENETHR_FIBER_PORT	Fiber port.
OPEN_GREENETHR_LINK_UP	Link up.
OPEN_GREENETHR_LINK_DOWN	Link down.
OPEN_GREENETHR_LONG_CABLE	Long cable.
OPEN_GREENETHR_SHORT_CABLE	Short cable.
OPEN_GREENETHR_UNKWN_CABLE_LEN	Unknown cable length.
OPEN_GREENETHR_NO_ENERGY	No energy.
OPEN_GREENETHR_FORCED	Forced.
OPEN_GREENETHR_NOT1GIG	Not 1 gig.
OPEN_GREENETHR_NOT_ATTACHED	Not attached.
OPEN_GREENETHR_INVALID_VAL	Invalid val.

Definition at line 41 of file openapi_green_ethernet.h.

Function Documentation

open_error_t openapiGreenEthrEnergyDetectAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	mode
	)

Get the energy detect admin mode.

Parameters

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

green_ethernet_example.c.

open_error_t openapiGreenEthrEnergyDetectModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode
	)

Set the energy-detect mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	mode	energy detect 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:

green_ethernet_example.c.

open_error_t openapiGreenEthrEnergyDetectOprStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	oprStatus,
		OPEN_GREEN_ETH_OPER_STATUS_t *	reason
	)

Get the energy-detect operational status and reason.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	oprStatus	operational status
[out]	reason	reason

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_ethernet_example.c.

open_error_t openapiGreenEthrEnergyDetectOprStatusStrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	oprStatus,
		open_buffdesc *	reasonStr
	)

Get the energy-detect operational status and reason.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	oprStatus	operational status
[out]	reasonStr	reason string

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

open_error_t openapiGreenEthrGlobalEnergyDetectModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the global energy detect administrative mode.

Parameters

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

green_ethernet_example.c.

open_error_t openapiGreenEthrGlobalEnergyDetectModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Set the global energy detect administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	global energy detect 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:

green_ethernet_example.c.

open_error_t openapiGreenEthrGlobalShortReachModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the global auto short reach administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	global auto short reach 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:

green_ethernet_example.c.

open_error_t openapiGreenEthrGlobalShortReachModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Set the global auto short reach administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	global auto short reach 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:

green_ethernet_example.c.

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

Determine if the interface is EEE capable.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	valid	EEE capable or not

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_ethernet_example.c.

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

Determine if the interface is valid for green ethernet operation.

Parameters

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

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_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchAutoAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	mode
	)

Get the short-reach auto admin mode.

Parameters

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

green_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchAutoModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t	mode
	)

Set the short-reach auto mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	mode	short reach auto 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:

green_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchForceAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	mode
	)

Get the short-reach force admin mode.

Parameters

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

green_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchForceModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t	mode
	)

Set the short-reach into force mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	mode	force 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:

green_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchOprStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	oprStatus,
		OPEN_GREEN_ETH_OPER_STATUS_t *	reason
	)

Get the short-reach operational status and reason.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	oprStatus	operational status
[out]	reason	reason

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_ethernet_example.c.

open_error_t openapiGreenEthrShrtRchOprStatusStrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	oprStatus,
		open_buffdesc *	bufd
	)

Get the short-reach operational status and reason.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	oprStatus	operational status
[out]	bufd	reason string

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

open_error_t openapiGreenEthrValidIntfFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	intIfNum
	)

Get the first interface that is valid for green ethernet.

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:

green_ethernet_example.c.

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

Get the next interface that is valid for green ethernet.

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:

green_ethernet_example.c.