OVMS3-idf/docs/en/api-reference/ethernet/esp_eth.rst

ETHERNET
========

Application Example
-------------------

-   Ethernet basic example: :example:`ethernet/ethernet`.
-   Ethernet iperf example: :example:`ethernet/iperf`.

PHY Interfaces
--------------

The configured PHY model(s) are set in software by configuring the eth_config_t structure for the given PHY.

Headers include a default configuration structure. These default configurations will need some members overriden or re-set before they can be used for a particular PHY hardware configuration. Consult the Ethernet example to see how this is done.

  * :component_file:`ethernet/include/eth_phy/phy.h` (common)
  * :component_file:`ethernet/include/eth_phy/phy_tlk110.h`
  * :component_file:`ethernet/include/eth_phy/phy_lan8720.h`
  * :component_file:`ethernet/include/eth_phy/phy_ip101.h`

PHY Configuration Constants
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. doxygenvariable:: phy_tlk110_default_ethernet_config
.. doxygenvariable:: phy_lan8720_default_ethernet_config
.. doxygenvariable:: phy_ip101_default_ethernet_config


API Reference - Ethernet
------------------------

.. include:: /_build/inc/esp_eth.inc

API Reference - PHY Common
--------------------------

.. include:: /_build/inc/phy.inc

API Reference - PHY TLK110
--------------------------

.. include:: /_build/inc/phy_tlk110.inc

API Reference - PHY LAN8720
---------------------------

.. include:: /_build/inc/phy_lan8720.inc

API Reference - PHY IP101
-------------------------

.. include:: /_build/inc/phy_ip101.inc
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00			`ETHERNET`
			`========`

			`Application Example`
			`-------------------`

ethernet: support new PHY (IP101) 1. Add support for new PHY IP101. 2. Re-enable GPIO0 output mode. 3. Clean up some docs. 2019-01-28 12:29:58 +00:00			- Ethernet basic example: :example:`ethernet/ethernet`.
			- Ethernet iperf example: :example:`ethernet/iperf`.
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
ethernet: Refactor PHY support to be part of ethernet component Move generic PHY support into its own interface 2017-04-19 02:02:53 +00:00			`PHY Interfaces`
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`--------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
ethernet: Refactor PHY support to be part of ethernet component Move generic PHY support into its own interface 2017-04-19 02:02:53 +00:00			`The configured PHY model(s) are set in software by configuring the eth_config_t structure for the given PHY.`

			`Headers include a default configuration structure. These default configurations will need some members overriden or re-set before they can be used for a particular PHY hardware configuration. Consult the Ethernet example to see how this is done.`

docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			* :component_file:`ethernet/include/eth_phy/phy.h` (common)
			* :component_file:`ethernet/include/eth_phy/phy_tlk110.h`
			* :component_file:`ethernet/include/eth_phy/phy_lan8720.h`
ethernet: support new PHY (IP101) 1. Add support for new PHY IP101. 2. Re-enable GPIO0 output mode. 3. Clean up some docs. 2019-01-28 12:29:58 +00:00			* :component_file:`ethernet/include/eth_phy/phy_ip101.h`
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00
			`PHY Configuration Constants`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. doxygenvariable:: phy_tlk110_default_ethernet_config`
			`.. doxygenvariable:: phy_lan8720_default_ethernet_config`
ethernet: support new PHY (IP101) 1. Add support for new PHY IP101. 2. Re-enable GPIO0 output mode. 3. Clean up some docs. 2019-01-28 12:29:58 +00:00			`.. doxygenvariable:: phy_ip101_default_ethernet_config`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00

docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - Ethernet`
			`------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/esp_eth.inc`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - PHY Common`
			`--------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/phy.inc`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - PHY TLK110`
			`--------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/phy_tlk110.inc`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`API Reference - PHY LAN8720`
			`---------------------------`
ethernet: Refactor PHY support to be part of ethernet component Move generic PHY support into its own interface 2017-04-19 02:02:53 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/phy_lan8720.inc`
ethernet: Refactor PHY support to be part of ethernet component Move generic PHY support into its own interface 2017-04-19 02:02:53 +00:00
ethernet: support new PHY (IP101) 1. Add support for new PHY IP101. 2. Re-enable GPIO0 output mode. 3. Clean up some docs. 2019-01-28 12:29:58 +00:00			`API Reference - PHY IP101`
			`-------------------------`

			`.. include:: /_build/inc/phy_ip101.inc`
ethernet: Refactor PHY support to be part of ethernet component Move generic PHY support into its own interface 2017-04-19 02:02:53 +00:00