Chapter 2. API Reference
• [in] phy_reg: PHY register index code
• [in] reg_value: PHY register value
Macros
ETH_DEFAULT_CONFIG(emac, ephy)
Default configuration for Ethernet driver.
Type Definitions
typedef void *esp_eth_handle_t
Handle of Ethernet driver.
Header File
• components/esp_eth/include/esp_eth_com.h
Functions
esp_err_t esp_eth_detect_phy_addr(esp_eth_mediator_t *eth, int *detected_addr)
Detect PHY address.
Return
• ESP_OK: detect phy address successfully
• ESP_ERR_INVALID_ARG: invalid parameter
• ESP_ERR_NOT_FOUND: can’t detect any PHY device
• ESP_FAIL: detect phy address failed because some error occurred
Parameters
• [in] eth: mediator of Ethernet driver
• [out] detected_addr: a valid address after detection
Structures
struct esp_eth_mediator_s
Ethernet mediator.
Public Members
esp_err_t (*phy_reg_read)(esp_eth_mediator_t *eth, uint32_t phy_addr, uint32_t phy_reg,
uint32_t *reg_value)
Read PHY register.
Return
• ESP_OK: read PHY register successfully
• ESP_FAIL: read PHY register failed because some error occurred
Parameters
• [in] eth: mediator of Ethernet driver
• [in] phy_addr: PHY Chip address (0~31)
• [in] phy_reg: PHY register index code
• [out] reg_value: PHY register value
esp_err_t (*phy_reg_write)(esp_eth_mediator_t *eth, uint32_t phy_addr, uint32_t phy_reg,
uint32_t reg_value)
Write PHY register.
Return
• ESP_OK: write PHY register successfully
• ESP_FAIL: write PHY register failed because some error occurred
Parameters
• [in] eth: mediator of Ethernet driver
• [in] phy_addr: PHY Chip address (0~31)
Espressif Systems 180
Submit Document Feedback
Release v4.4
To Next Page