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

ETHERNET
========

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

Ethernet example: :example:`ethernet/ethernet`.

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`

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

.. doxygenvariable:: phy_tlk110_default_ethernet_config
.. doxygenvariable:: phy_lan8720_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
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00			`ETHERNET`
			`========`

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

docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 08:16:06 +00:00			Ethernet example: :example:`ethernet/ethernet`.
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`

			`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: 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