hpm_lan8720.h File Reference

LAN8720 Ethernet PHY driver header file. More...

#include "hpm_enet_phy.h"
#include "hpm_common.h"
#include "hpm_enet_regs.h"

Go to the source code of this file.

Data Structures
struct	lan8720_config_t
	LAN8720 PHY configuration structure. More...

Macros
#define	LAN8720_ADDR   (0U)
	Default PHY address for LAN8720. More...
#define	LAN8720_ID1   (0x0007U)
	LAN8720 PHY ID register 1 value (OUI MSB) More...
#define	LAN8720_ID2   (0x30U)
	LAN8720 PHY ID register 2 value (OUI LSB) More...

Enumerations
enum	lan8720_config_refclk_direction_t { lan8720_config_refclk_output = 0 , lan8720_config_refclk_input }
	LAN8720 reference clock direction configuration. More...

Functions
bool	lan8720_reset (ENET_Type *ptr, uint32_t phy_addr)
	Reset LAN8720 PHY chip. More...
void	lan8720_basic_mode_default_config (ENET_Type *ptr, lan8720_config_t *config)
	Set default configuration for LAN8720 PHY basic mode. More...
bool	lan8720_basic_mode_init (ENET_Type *ptr, uint32_t phy_addr, lan8720_config_t *config)
	Initialize LAN8720 PHY chip in basic mode. More...
void	lan8720_get_phy_status (ENET_Type *ptr, uint32_t phy_addr, enet_phy_status_t *status)
	Get LAN8720 PHY status. More...

Detailed Description

LAN8720 Ethernet PHY driver header file.

This file provides the API definitions for the LAN8720 Ethernet PHY chip driver. The LAN8720 is a single-port 10/100-Mbps Ethernet physical layer transceiver.

Macro Definition Documentation

LAN8720_ADDR

#define LAN8720_ADDR   (0U)

Default PHY address for LAN8720.

LAN8720_ID1

#define LAN8720_ID1   (0x0007U)

LAN8720 PHY ID register 1 value (OUI MSB)

LAN8720_ID2

#define LAN8720_ID2   (0x30U)

LAN8720 PHY ID register 2 value (OUI LSB)

Enumeration Type Documentation

lan8720_config_refclk_direction_t

enum lan8720_config_refclk_direction_t

LAN8720 reference clock direction configuration.

Enumerator
lan8720_config_refclk_output	Reference clock output mode
lan8720_config_refclk_input	Reference clock input mode

Function Documentation

lan8720_basic_mode_default_config()

void lan8720_basic_mode_default_config	(	ENET_Type *	ptr,
		lan8720_config_t *	config
	)

Set default configuration for LAN8720 PHY basic mode.

Parameters

[in]	ptr	Pointer to the ENET peripheral base address
[out]	config	Pointer to the configuration structure to be initialized

This function initializes the configuration structure with default values:

• Loopback: disabled
• Auto-negotiation: enabled (unless __DISABLE_AUTO_NEGO is defined)
• Speed: 100 Mbps (when auto-negotiation is disabled)
• Duplex: full duplex (when auto-negotiation is disabled)

lan8720_basic_mode_init()

bool lan8720_basic_mode_init	(	ENET_Type *	ptr,
		uint32_t	phy_addr,
		lan8720_config_t *	config
	)

Initialize LAN8720 PHY chip in basic mode.

Parameters

[in]	ptr	Pointer to the ENET peripheral base address
[in]	phy_addr	PHY address
[in]	config	Pointer to the PHY configuration structure

Return values

true	Initialization completed successfully
false	Initialization failed (PHY ID check failed)

This function performs the following operations:

• Verifies the PHY ID to ensure it's a LAN8720 chip
• Configures the PHY according to the provided configuration
• Sets up loopback mode, auto-negotiation, speed, and duplex settings

lan8720_get_phy_status()

void lan8720_get_phy_status	(	ENET_Type *	ptr,
		uint32_t	phy_addr,
		enet_phy_status_t *	status
	)

Get LAN8720 PHY status.

Parameters

[in]	ptr	Pointer to the ENET peripheral base address
[in]	phy_addr	PHY address
[out]	status	Pointer to the status structure to store PHY status

This function reads the PHY status register and extracts:

• Link status (up/down)
• Port speed (10 Mbps or 100 Mbps)
• Duplex mode (half or full)

lan8720_reset()

bool lan8720_reset	(	ENET_Type *	ptr,
		uint32_t	phy_addr
	)

Reset LAN8720 PHY chip.

Parameters

[in]	ptr	Pointer to the ENET peripheral base address
[in]	phy_addr	PHY address

Return values

true	Reset operation completed successfully
false	Reset operation failed (timeout)