lan8720 advance driver function

lan8720 advance driver modules More...

Collaboration diagram for lan8720 advance driver function:

Data Structures
struct	lan8720_handle_s
	lan8720 handle structure definition More...
struct	lan8720_info_s
	lan8720 information structure definition More...

Typedefs
typedef struct lan8720_handle_s	lan8720_handle_t
	lan8720 handle structure definition
typedef struct lan8720_info_s	lan8720_info_t
	lan8720 information structure definition

Enumerations
enum	lan8720_pause_t { LAN8720_PAUSE_NO = 0x00 , LAN8720_PAUSE_SYMMETRIC = 0x01 , LAN8720_PAUSE_ASYMMETRIC = 0x02 , LAN8720_PAUSE_BOTH = 0x03 }
	lan8720 pause enumeration definition More...
enum	lan8720_mode_t {   LAN8720_MODE_10BASE_T_HALF_DUPLEX = 0x00 , LAN8720_MODE_10BASE_T_FULL_DUPLEX = 0x01 , LAN8720_MODE_100BASE_TX_HALF_DUPLEX = 0x02 , LAN8720_MODE_100BASE_TX_FULL_DUPLEX = 0x03 ,   LAN8720_MODE_100BASE_TX_HALF_DUPLEX_ADVERTISED = 0x04 , LAN8720_MODE_REPEATER_MODE = 0x05 , LAN8720_MODE_POWER_DOWN_MODE = 0x06 , LAN8720_MODE_ALL_CAPABLE = 0x07 }
	lan8720 mode enumeration definition More...
enum	lan8720_manual_channel_select_t { LAN8720_MANUAL_CHANNEL_SELECT_MDI = 0x00 , LAN8720_MANUAL_CHANNEL_SELECT_MDIX = 0x01 }
	lan8720 manual channel select enumeration definition More...
enum	lan8720_polarity_t { LAN8720_POLARITY_NORMAL = 0x00 , LAN8720_POLARITY_REVERSED = 0x01 }
	lan8720 polarity enumeration definition More...
enum	lan8720_interrupt_t {   LAN8720_INTERRUPT_ENERGY_ON = 7 , LAN8720_INTERRUPT_AUTO_NEGOTIATION_COMPLETE = 6 , LAN8720_INTERRUPT_REMOTE_FAULT = 5 , LAN8720_INTERRUPT_LINK_DOWN = 4 ,   LAN8720_INTERRUPT_AUTO_NEGOTIATION_LP_ACK = 3 , LAN8720_INTERRUPT_PARALLEL_DETECTION_FAULT = 2 , LAN8720_INTERRUPT_AUTO_NEGOTIATION_PAGE_RECEIVED = 1 }
	lan8720 interrupt enumeration definition More...
enum	lan8720_speed_indication_t { LAN8720_SPEED_INDICATION_10BASE_T_HALF_DUPLEX = 0x01 , LAN8720_SPEED_INDICATION_10BASE_T_FULL_DUPLEX = 0x05 , LAN8720_SPEED_INDICATION_100BASE_TX_HALF_DUPLEX = 0x02 , LAN8720_SPEED_INDICATION_100BASE_TX_FULL_DUPLEX = 0x06 }
	lan8720 speed indication enumeration definition More...

Functions
uint8_t	lan8720_set_identifier (lan8720_handle_t *handle, uint32_t phy_id, uint8_t model_number, uint8_t revision_number)
	set identifier
uint8_t	lan8720_get_identifier (lan8720_handle_t *handle, uint32_t *phy_id, uint8_t *model_number, uint8_t *revision_number)
	get identifier
uint8_t	lan8720_set_auto_negotiation_advertisement_remote_fault (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto negotiation advertisement remote fault
uint8_t	lan8720_get_auto_negotiation_advertisement_remote_fault (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation advertisement remote fault status
uint8_t	lan8720_set_auto_negotiation_advertisement_pause (lan8720_handle_t *handle, lan8720_pause_t pause)
	set auto negotiation advertisement pause
uint8_t	lan8720_get_auto_negotiation_advertisement_pause (lan8720_handle_t *handle, lan8720_pause_t *pause)
	get auto negotiation advertisement pause
uint8_t	lan8720_set_auto_negotiation_advertisement_100base_tx_full_duplex (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto negotiation advertisement 100base tx full duplex
uint8_t	lan8720_get_auto_negotiation_advertisement_100base_tx_full_duplex (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation advertisement 100base tx full duplex status
uint8_t	lan8720_set_auto_negotiation_advertisement_100base_tx (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto negotiation advertisement 100base tx
uint8_t	lan8720_get_auto_negotiation_advertisement_100base_tx (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation advertisement 100base tx status
uint8_t	lan8720_set_auto_negotiation_advertisement_10base_t_full_duplex (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto negotiation advertisement 10base t full duplex
uint8_t	lan8720_get_auto_negotiation_advertisement_10base_t_full_duplex (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation advertisement 10base t full duplex status
uint8_t	lan8720_set_auto_negotiation_advertisement_10base_t (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto negotiation advertisement 10base t
uint8_t	lan8720_get_auto_negotiation_advertisement_10base_t (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation advertisement 10base t status
uint8_t	lan8720_set_auto_negotiation_advertisement_selector_field (lan8720_handle_t *handle, uint8_t selector)
	set auto negotiation advertisement selector field
uint8_t	lan8720_get_auto_negotiation_advertisement_selector_field (lan8720_handle_t *handle, uint8_t *selector)
	get auto negotiation advertisement selector field
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_next_page (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability next page status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_acknowledge (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability acknowledge status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_remote_fault (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability remote fault status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_pause (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability pause status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_100base_t4 (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability 100base t4 status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_100base_tx_full_duplex (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability 100base tx full duplex status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_100base_tx (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability 100base tx status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_10base_t_full_duplex (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability 10base t full duplex status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_10base_t (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation link partner ability 10base t status
uint8_t	lan8720_get_auto_negotiation_link_partner_ability_selector_field (lan8720_handle_t *handle, uint8_t *selector)
	get auto negotiation link partner ability selector field
uint8_t	lan8720_get_auto_negotiation_expansion_parallel_detection_fault (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation expansion parallel detection fault status
uint8_t	lan8720_get_auto_negotiation_expansion_link_partner_next_page_able (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation expansion link partner next page able status
uint8_t	lan8720_get_auto_negotiation_expansion_next_page_able (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation expansion next page able status
uint8_t	lan8720_get_auto_negotiation_expansion_page_received (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation expansion page received status
uint8_t	lan8720_get_auto_negotiation_expansion_link_partner_auto_negotiation_able (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation expansion link partner auto negotiation able status
uint8_t	lan8720_set_energy_detect_power_down_mode (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable energy detect power down mode
uint8_t	lan8720_get_energy_detect_power_down_mode (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get energy detect power down mode status
uint8_t	lan8720_set_far_loop_back (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable far loop back
uint8_t	lan8720_get_far_loop_back (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get far loop back status
uint8_t	lan8720_set_alternate_interrupt_mode (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable alternate interrupt mode
uint8_t	lan8720_get_alternate_interrupt_mode (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get alternate interrupt mode status
uint8_t	lan8720_get_energy_detected (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get energy detected status
uint8_t	lan8720_set_mode (lan8720_handle_t *handle, lan8720_mode_t mode)
	set mode
uint8_t	lan8720_get_mode (lan8720_handle_t *handle, lan8720_mode_t *mode)
	get mode
uint8_t	lan8720_set_phy_address (lan8720_handle_t *handle, uint8_t addr)
	set phy address
uint8_t	lan8720_get_phy_address (lan8720_handle_t *handle, uint8_t *addr)
	get phy address
uint8_t	lan8720_get_symbol_error_counter (lan8720_handle_t *handle, uint16_t *cnt)
	get symbol error counter
uint8_t	lan8720_set_auto_mdix (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable auto mdix
uint8_t	lan8720_get_auto_mdix (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto mdix status
uint8_t	lan8720_set_manual_channel_select (lan8720_handle_t *handle, lan8720_manual_channel_select_t select)
	set manual channel select
uint8_t	lan8720_get_manual_channel_select (lan8720_handle_t *handle, lan8720_manual_channel_select_t *select)
	get manual channel select
uint8_t	lan8720_set_sqe_test_off (lan8720_handle_t *handle, lan8720_bool_t enable)
	enable or disable sqe test off
uint8_t	lan8720_get_sqe_test_off (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get sqe test off status
uint8_t	lan8720_set_polarity (lan8720_handle_t *handle, lan8720_polarity_t polarity)
	set polarity
uint8_t	lan8720_get_polarity (lan8720_handle_t *handle, lan8720_polarity_t *polarity)
	get polarity
uint8_t	lan8720_get_interrupt_flag (lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t *enable)
	get interrupt flag status
uint8_t	lan8720_set_interrupt_mask (lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t enable)
	set interrupt mask
uint8_t	lan8720_get_interrupt_mask (lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t *enable)
	get interrupt mask status
uint8_t	lan8720_get_auto_negotiation_done (lan8720_handle_t *handle, lan8720_bool_t *enable)
	get auto negotiation done status
uint8_t	lan8720_get_speed_indication (lan8720_handle_t *handle, lan8720_speed_indication_t *speed)
	get speed indication

Detailed Description

lan8720 advance driver modules

Typedef Documentation

lan8720_handle_t

typedef struct lan8720_handle_s lan8720_handle_t

lan8720 handle structure definition

lan8720_info_t

typedef struct lan8720_info_s lan8720_info_t

lan8720 information structure definition

Enumeration Type Documentation

lan8720_interrupt_t

enum lan8720_interrupt_t

lan8720 interrupt enumeration definition

Enumerator
LAN8720_INTERRUPT_ENERGY_ON	energy on generated
LAN8720_INTERRUPT_AUTO_NEGOTIATION_COMPLETE	auto negotiation complete
LAN8720_INTERRUPT_REMOTE_FAULT	remote fault detected
LAN8720_INTERRUPT_LINK_DOWN	link down(link status negated)
LAN8720_INTERRUPT_AUTO_NEGOTIATION_LP_ACK	auto negotiation lp acknowledge
LAN8720_INTERRUPT_PARALLEL_DETECTION_FAULT	parallel detection fault
LAN8720_INTERRUPT_AUTO_NEGOTIATION_PAGE_RECEIVED	auto negotiation page received

Definition at line 152 of file driver_lan8720.h.

lan8720_manual_channel_select_t

enum lan8720_manual_channel_select_t

lan8720 manual channel select enumeration definition

Enumerator
LAN8720_MANUAL_CHANNEL_SELECT_MDI	tx transmits, rx receives
LAN8720_MANUAL_CHANNEL_SELECT_MDIX	tx receives, rx transmits

Definition at line 134 of file driver_lan8720.h.

lan8720_mode_t

enum lan8720_mode_t

lan8720 mode enumeration definition

Enumerator
LAN8720_MODE_10BASE_T_HALF_DUPLEX	10base-t half duplex
LAN8720_MODE_10BASE_T_FULL_DUPLEX	10base-t full duplex
LAN8720_MODE_100BASE_TX_HALF_DUPLEX	100base-tx half duplex
LAN8720_MODE_100BASE_TX_FULL_DUPLEX	100base-tx full duplex
LAN8720_MODE_100BASE_TX_HALF_DUPLEX_ADVERTISED	100base-tx half duplex is advertised
LAN8720_MODE_REPEATER_MODE	repeater mode
LAN8720_MODE_POWER_DOWN_MODE	power down mode
LAN8720_MODE_ALL_CAPABLE	all capable, auto-negotiation enabled

Definition at line 119 of file driver_lan8720.h.

lan8720_pause_t

enum lan8720_pause_t

lan8720 pause enumeration definition

Enumerator
LAN8720_PAUSE_NO	no pause
LAN8720_PAUSE_SYMMETRIC	symmetric pause
LAN8720_PAUSE_ASYMMETRIC	asymmetric pause toward link partner
LAN8720_PAUSE_BOTH	advertise support for both symmetric pause and asymmetric pause toward local device

Definition at line 107 of file driver_lan8720.h.

lan8720_polarity_t

enum lan8720_polarity_t

lan8720 polarity enumeration definition

Enumerator
LAN8720_POLARITY_NORMAL	normal polarity
LAN8720_POLARITY_REVERSED	reversed polarity

Definition at line 143 of file driver_lan8720.h.

lan8720_speed_indication_t

enum lan8720_speed_indication_t

lan8720 speed indication enumeration definition

Enumerator
LAN8720_SPEED_INDICATION_10BASE_T_HALF_DUPLEX	10base-t half duplex
LAN8720_SPEED_INDICATION_10BASE_T_FULL_DUPLEX	10base-t full duplex
LAN8720_SPEED_INDICATION_100BASE_TX_HALF_DUPLEX	100base-tx half duplex
LAN8720_SPEED_INDICATION_100BASE_TX_FULL_DUPLEX	100bae-tx full duplex

Definition at line 166 of file driver_lan8720.h.

Function Documentation

lan8720_get_alternate_interrupt_mode()

uint8_t lan8720_get_alternate_interrupt_mode	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get alternate interrupt mode status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get alternate interrupt mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3009 of file driver_lan8720.c.

lan8720_get_auto_mdix()

uint8_t lan8720_get_auto_mdix	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto mdix status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto mdix failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3336 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_100base_tx()

uint8_t lan8720_get_auto_negotiation_advertisement_100base_tx	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation advertisement 100base tx status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement 100base tx failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1955 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_100base_tx_full_duplex()

uint8_t lan8720_get_auto_negotiation_advertisement_100base_tx_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation advertisement 100base tx full duplex status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement 100base tx full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1873 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_10base_t()

uint8_t lan8720_get_auto_negotiation_advertisement_10base_t	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation advertisement 10base t status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement 10base t failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2119 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_10base_t_full_duplex()

uint8_t lan8720_get_auto_negotiation_advertisement_10base_t_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation advertisement 10base t full duplex status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement 10base t full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2037 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_pause()

uint8_t lan8720_get_auto_negotiation_advertisement_pause	(	lan8720_handle_t *	handle,
		lan8720_pause_t *	pause )

get auto negotiation advertisement pause

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*pause	pointer to a pause buffer

Returns

status code

• 0 success
• 1 get_auto negotiation advertisement pause failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1791 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_remote_fault()

uint8_t lan8720_get_auto_negotiation_advertisement_remote_fault	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation advertisement remote fault status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement remote fault failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1709 of file driver_lan8720.c.

lan8720_get_auto_negotiation_advertisement_selector_field()

uint8_t lan8720_get_auto_negotiation_advertisement_selector_field	(	lan8720_handle_t *	handle,
		uint8_t *	selector )

get auto negotiation advertisement selector field

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*selector	pointer to a selector buffer

Returns

status code

• 0 success
• 1 get auto negotiation advertisement selector field failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2208 of file driver_lan8720.c.

lan8720_get_auto_negotiation_done()

uint8_t lan8720_get_auto_negotiation_done	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation done status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation done failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3696 of file driver_lan8720.c.

lan8720_get_auto_negotiation_expansion_link_partner_auto_negotiation_able()

uint8_t lan8720_get_auto_negotiation_expansion_link_partner_auto_negotiation_able	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation expansion link partner auto negotiation able status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation expansion link partner auto negotiation able failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2763 of file driver_lan8720.c.

lan8720_get_auto_negotiation_expansion_link_partner_next_page_able()

uint8_t lan8720_get_auto_negotiation_expansion_link_partner_next_page_able	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation expansion link partner next page able status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation expansion link partner next page able failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2652 of file driver_lan8720.c.

lan8720_get_auto_negotiation_expansion_next_page_able()

uint8_t lan8720_get_auto_negotiation_expansion_next_page_able	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation expansion next page able status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation expansion next page able failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2689 of file driver_lan8720.c.

lan8720_get_auto_negotiation_expansion_page_received()

uint8_t lan8720_get_auto_negotiation_expansion_page_received	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation expansion page received status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation expansion page received failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2726 of file driver_lan8720.c.

lan8720_get_auto_negotiation_expansion_parallel_detection_fault()

uint8_t lan8720_get_auto_negotiation_expansion_parallel_detection_fault	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation expansion parallel detection fault status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation expansion parallel detection fault failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2615 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_100base_t4()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_t4	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability 100base t4 status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability 100base t4 failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2393 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_100base_tx()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_tx	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability 100base tx status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability 100base tx failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2467 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_100base_tx_full_duplex()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_tx_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability 100base tx full duplex status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability 100base tx full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2430 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_10base_t()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_10base_t	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability 10base t status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability 10base t failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2541 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_10base_t_full_duplex()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_10base_t_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability 10base t full duplex status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability 10base t full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2504 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_acknowledge()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_acknowledge	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability acknowledge status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability acknowledge failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2282 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_next_page()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_next_page	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability next page status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability next page failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2245 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_pause()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_pause	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability pause status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability pause failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2356 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_remote_fault()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_remote_fault	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get auto negotiation link partner ability remote fault status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability remote fault failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2319 of file driver_lan8720.c.

lan8720_get_auto_negotiation_link_partner_ability_selector_field()

uint8_t lan8720_get_auto_negotiation_link_partner_ability_selector_field	(	lan8720_handle_t *	handle,
		uint8_t *	selector )

get auto negotiation link partner ability selector field

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*selector	pointer to a selector buffer

Returns

status code

• 0 success
• 1 get auto negotiation link partner ability selector field failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2578 of file driver_lan8720.c.

lan8720_get_energy_detect_power_down_mode()

uint8_t lan8720_get_energy_detect_power_down_mode	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get energy detect power down mode status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get energy detect power down mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2845 of file driver_lan8720.c.

lan8720_get_energy_detected()

uint8_t lan8720_get_energy_detected	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get energy detected status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get energy detected failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3046 of file driver_lan8720.c.

lan8720_get_far_loop_back()

uint8_t lan8720_get_far_loop_back	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get far loop back status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get far loop back failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2927 of file driver_lan8720.c.

lan8720_get_identifier()

uint8_t lan8720_get_identifier	(	lan8720_handle_t *	handle,
		uint32_t *	phy_id,
		uint8_t *	model_number,
		uint8_t *	revision_number )

get identifier

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*phy_id	pointer to a phy id buffer
[out]	*model_number	pointer to an model number buffer
[out]	*revision_number	pointer to a revision number buffer

Returns

status code

• 0 success
• 1 get identifier failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1616 of file driver_lan8720.c.

lan8720_get_interrupt_flag()

uint8_t lan8720_get_interrupt_flag	(	lan8720_handle_t *	handle,
		lan8720_interrupt_t	interrupt,
		lan8720_bool_t *	enable )

get interrupt flag status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	interrupt	set interrupt
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get interrupt flag failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3575 of file driver_lan8720.c.

lan8720_get_interrupt_mask()

uint8_t lan8720_get_interrupt_mask	(	lan8720_handle_t *	handle,
		lan8720_interrupt_t	interrupt,
		lan8720_bool_t *	enable )

get interrupt mask status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	interrupt	set interrupt
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get interrupt mask failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3659 of file driver_lan8720.c.

lan8720_get_manual_channel_select()

uint8_t lan8720_get_manual_channel_select	(	lan8720_handle_t *	handle,
		lan8720_manual_channel_select_t *	select )

get manual channel select

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*select	pointer to a manual channel select buffer

Returns

status code

• 0 success
• 1 get manual channel select failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3418 of file driver_lan8720.c.

lan8720_get_mode()

uint8_t lan8720_get_mode	(	lan8720_handle_t *	handle,
		lan8720_mode_t *	mode )

get mode

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*mode	pointer to a mode buffer

Returns

status code

• 0 success
• 1 get mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3128 of file driver_lan8720.c.

lan8720_get_phy_address()

uint8_t lan8720_get_phy_address	(	lan8720_handle_t *	handle,
		uint8_t *	addr )

get phy address

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*addr	pointer to a phy address buffer

Returns

status code

• 0 success
• 1 get phy address failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3217 of file driver_lan8720.c.

lan8720_get_polarity()

uint8_t lan8720_get_polarity	(	lan8720_handle_t *	handle,
		lan8720_polarity_t *	polarity )

get polarity

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*polarity	pointer to a polarity buffer

Returns

status code

• 0 success
• 1 get polarity failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3537 of file driver_lan8720.c.

lan8720_get_speed_indication()

uint8_t lan8720_get_speed_indication	(	lan8720_handle_t *	handle,
		lan8720_speed_indication_t *	speed )

get speed indication

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*speed	pointer to a speed buffer

Returns

status code

• 0 success
• 1 get speed indication failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3733 of file driver_lan8720.c.

lan8720_get_sqe_test_off()

uint8_t lan8720_get_sqe_test_off	(	lan8720_handle_t *	handle,
		lan8720_bool_t *	enable )

get sqe test off status

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

• 0 success
• 1 get sqe test off failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3500 of file driver_lan8720.c.

lan8720_get_symbol_error_counter()

uint8_t lan8720_get_symbol_error_counter	(	lan8720_handle_t *	handle,
		uint16_t *	cnt )

get symbol error counter

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[out]	*cnt	pointer to a counter buffer

Returns

status code

• 0 success
• 1 get symbol error counter failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3254 of file driver_lan8720.c.

lan8720_set_alternate_interrupt_mode()

uint8_t lan8720_set_alternate_interrupt_mode	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable alternate interrupt mode

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set alternate interrupt mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2964 of file driver_lan8720.c.

lan8720_set_auto_mdix()

uint8_t lan8720_set_auto_mdix	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto mdix

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto mdix failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3291 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_100base_tx()

uint8_t lan8720_set_auto_negotiation_advertisement_100base_tx	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto negotiation advertisement 100base tx

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto negotiation advertisement 100base tx failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1910 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_100base_tx_full_duplex()

uint8_t lan8720_set_auto_negotiation_advertisement_100base_tx_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto negotiation advertisement 100base tx full duplex

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto negotiation advertisement 100base tx full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1828 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_10base_t()

uint8_t lan8720_set_auto_negotiation_advertisement_10base_t	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto negotiation advertisement 10base t

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto negotiation advertisement 10base t failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2074 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_10base_t_full_duplex()

uint8_t lan8720_set_auto_negotiation_advertisement_10base_t_full_duplex	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto negotiation advertisement 10base t full duplex

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto negotiation advertisement 10base t full duplex failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1992 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_pause()

uint8_t lan8720_set_auto_negotiation_advertisement_pause	(	lan8720_handle_t *	handle,
		lan8720_pause_t	pause )

set auto negotiation advertisement pause

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	pause	set pause

Returns

status code

• 0 success
• 1 set_auto negotiation advertisement pause failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1746 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_remote_fault()

uint8_t lan8720_set_auto_negotiation_advertisement_remote_fault	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable auto negotiation advertisement remote fault

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set auto negotiation advertisement remote fault failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1664 of file driver_lan8720.c.

lan8720_set_auto_negotiation_advertisement_selector_field()

uint8_t lan8720_set_auto_negotiation_advertisement_selector_field	(	lan8720_handle_t *	handle,
		uint8_t	selector )

set auto negotiation advertisement selector field

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	selector	set selector

Returns

status code

• 0 success
• 1 set auto negotiation advertisement selector field failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 selector > 0x1F

Note

none

Definition at line 2157 of file driver_lan8720.c.

lan8720_set_energy_detect_power_down_mode()

uint8_t lan8720_set_energy_detect_power_down_mode	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable energy detect power down mode

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set energy detect power down mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2800 of file driver_lan8720.c.

lan8720_set_far_loop_back()

uint8_t lan8720_set_far_loop_back	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable far loop back

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set far loop back failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 2882 of file driver_lan8720.c.

lan8720_set_identifier()

uint8_t lan8720_set_identifier	(	lan8720_handle_t *	handle,
		uint32_t	phy_id,
		uint8_t	model_number,
		uint8_t	revision_number )

set identifier

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	phy_id	physical id
[in]	model_number	model number
[in]	revision_number	revision number

Returns

status code

• 0 success
• 1 set identifier failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 phy_id > 0x3FFFFF
• 5 model_number > 0x3F
• 6 revision_number > 0xF

Note

none

Definition at line 1548 of file driver_lan8720.c.

lan8720_set_interrupt_mask()

uint8_t lan8720_set_interrupt_mask	(	lan8720_handle_t *	handle,
		lan8720_interrupt_t	interrupt,
		lan8720_bool_t	enable )

set interrupt mask

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	interrupt	set interrupt
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set interrupt mask failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3613 of file driver_lan8720.c.

lan8720_set_manual_channel_select()

uint8_t lan8720_set_manual_channel_select	(	lan8720_handle_t *	handle,
		lan8720_manual_channel_select_t	select )

set manual channel select

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	select	manual channel select

Returns

status code

• 0 success
• 1 set manual channel select failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3373 of file driver_lan8720.c.

lan8720_set_mode()

uint8_t lan8720_set_mode	(	lan8720_handle_t *	handle,
		lan8720_mode_t	mode )

set mode

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	mode	set mode

Returns

status code

• 0 success
• 1 set mode failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3083 of file driver_lan8720.c.

lan8720_set_phy_address()

uint8_t lan8720_set_phy_address	(	lan8720_handle_t *	handle,
		uint8_t	addr )

set phy address

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	addr	physical address

Returns

status code

• 0 success
• 1 set phy address failed
• 2 handle is NULL
• 3 handle is not initialized
• 4 addr > 0x1F

Note

none

Definition at line 3166 of file driver_lan8720.c.

lan8720_set_polarity()

uint8_t lan8720_set_polarity	(	lan8720_handle_t *	handle,
		lan8720_polarity_t	polarity )

set polarity

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	polarity	set polarity

Returns

status code

• 0 success
• 1 set polarity failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

lan8720_set_sqe_test_off()

uint8_t lan8720_set_sqe_test_off	(	lan8720_handle_t *	handle,
		lan8720_bool_t	enable )

enable or disable sqe test off

Parameters

[in]	*handle	pointer to an lan8720 handle structure
[in]	enable	bool value

Returns

status code

• 0 success
• 1 set sqe test off failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 3455 of file driver_lan8720.c.