Chapter 2. API Reference
Structures
struct esp_eth_phy_s
Ethernet PHY.
Public Members
esp_err_t (*set_mediator)(esp_eth_phy_t *phy, esp_eth_mediator_t *mediator)
Set mediator for PHY.
Return
• ESP_OK: set mediator for Ethernet PHY instance successfully
• ESP_ERR_INVALID_ARG: set mediator for Ethernet PHY instance failed because of some
invalid arguments
Parameters
• [in] phy: Ethernet PHY instance
• [in] mediator: mediator of Ethernet driver
esp_err_t (*reset)(esp_eth_phy_t *phy)
Software Reset Ethernet PHY.
Return
• ESP_OK: reset Ethernet PHY successfully
• ESP_FAIL: reset Ethernet PHY failed because some error occurred
Parameters
• [in] phy: Ethernet PHY instance
esp_err_t (*reset_hw)(esp_eth_phy_t *phy)
Hardware Reset Ethernet PHY.
Note Hardware reset is mostly done by pull down and up PHY’s nRST pin
Return
• ESP_OK: reset Ethernet PHY successfully
• ESP_FAIL: reset Ethernet PHY failed because some error occurred
Parameters
• [in] phy: Ethernet PHY instance
esp_err_t (*init)(esp_eth_phy_t *phy)
Initialize Ethernet PHY.
Return
• ESP_OK: initialize Ethernet PHY successfully
• ESP_FAIL: initialize Ethernet PHY failed because some error occurred
Parameters
• [in] phy: Ethernet PHY instance
esp_err_t (*deinit)(esp_eth_phy_t *phy)
Deinitialize Ethernet PHY.
Return
• ESP_OK: deinitialize Ethernet PHY successfully
• ESP_FAIL: deinitialize Ethernet PHY failed because some error occurred
Parameters
• [in] phyL: Ethernet PHY instance
esp_err_t (*negotiate)(esp_eth_phy_t *phy)
Start auto negotiation.
Return
• ESP_OK: restart auto negotiation successfully
• ESP_FAIL: restart auto negotiation failed because some error occurred
Parameters
• [in] phy: Ethernet PHY instance
Espressif Systems 189
Submit Document Feedback
Release v4.4
To Next Page