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

Ethernet
========

:link_to_translation:`zh_CN:[中文]`

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

-   Ethernet basic example: :example:`ethernet/basic`.
-   Ethernet iperf example: :example:`ethernet/iperf`.
-   Ethernet to Wi-Fi AP "router": :example:`ethernet/eth2ap`.

Ethernet Driver Model
---------------------

  * :component_file:`esp_eth/include/esp_eth.h`

Ethernet Common Interface
-------------------------

  * :component_file:`esp_eth/include/esp_eth_com.h`

Ethernet MAC Interface
----------------------

  * :component_file:`esp_eth/include/esp_eth_mac.h`

Ethernet PHY Interface
----------------------

  * :component_file:`esp_eth/include/esp_eth_phy.h`

Ethernet PHY Common Registers
-----------------------------

  * :component_file:`esp_eth/include/eth_phy_regs_struct.h`

API Reference - Driver Model
----------------------------

.. include-build-file:: inc/esp_eth.inc

API Reference - Common Interface
--------------------------------

.. include-build-file:: inc/esp_eth_com.inc

API Reference - MAC Interface
-----------------------------

.. include-build-file:: inc/esp_eth_mac.inc

API Reference - PHY Interface
-----------------------------

.. include-build-file:: inc/esp_eth_phy.inc

API Reference - Glue for esp_netif
----------------------------------

.. include-build-file:: inc/esp_eth_netif_glue.inc
doc: Rearrange wifi & ethernet docs into a common "network" doc 2018-12-03 07:11:31 +00:00			`Ethernet`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00			`========`

Add translation for Network files 2019-12-31 06:53:55 +00:00			:link_to_translation:`zh_CN:[中文]`

ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00			`Application Example`
			`-------------------`

docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-10 08:52:41 +00:00			- Ethernet basic example: :example:`ethernet/basic`.
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 iperf example: :example:`ethernet/iperf`.
docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-10 08:52:41 +00:00			- Ethernet to Wi-Fi AP "router": :example:`ethernet/eth2ap`.
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			`Ethernet Driver Model`
			`---------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			* :component_file:`esp_eth/include/esp_eth.h`
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
add esp_eth component 2019-04-10 08:24:50 +00:00			`Ethernet Common Interface`
			`-------------------------`
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
add esp_eth component 2019-04-10 08:24:50 +00:00			* :component_file:`esp_eth/include/esp_eth_com.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
add esp_eth component 2019-04-10 08:24:50 +00:00			`Ethernet MAC Interface`
			`----------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			* :component_file:`esp_eth/include/esp_eth_mac.h`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			`Ethernet PHY Interface`
			`----------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			* :component_file:`esp_eth/include/esp_eth_phy.h`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			`Ethernet PHY Common Registers`
			`-----------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			* :component_file:`esp_eth/include/eth_phy_regs_struct.h`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			`API Reference - Driver Model`
			`----------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_eth.inc`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
add esp_eth component 2019-04-10 08:24:50 +00:00			`API Reference - Common Interface`
			`--------------------------------`
ethernet: add first version of ethernet driver 2016-11-08 09:45:17 +00:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_eth_com.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
add esp_eth component 2019-04-10 08:24:50 +00:00			`API Reference - MAC Interface`
			`-----------------------------`
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: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_eth_mac.inc`
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
add esp_eth component 2019-04-10 08:24:50 +00:00			`API Reference - PHY Interface`
			`-----------------------------`
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: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_eth_phy.inc`
ethernet: move netif glue && add ref counter 1. move netif glue into single file 2. add reference counter for Ethernet driver 2019-11-26 09:48:38 +00:00
			`API Reference - Glue for esp_netif`
			`----------------------------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_eth_netif_glue.inc`