Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/api-reference/ethernet/esp_eth.rst

75 lines
1.9 KiB
ReStructuredText
Raw Normal View History

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
API Reference
-------------
Header Files
^^^^^^^^^^^^
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
* :component_file:`ethernet/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
* :component_file:`ethernet/include/phy/phy.h`
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
^^^^^^^^^^^^^^
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.
* :component_file:`ethernet/include/phy/phy_tlk110.h`
* :component_file:`ethernet/include/phy/phy_lan8720.h`
ethernet: add first version of ethernet driver
2016-11-08 09:45:17 +00:00
Type Definitions
^^^^^^^^^^^^^^^^
ethernet: update docs
2017-01-06 06:16:34 +00:00
.. doxygentypedef:: eth_phy_check_link_func
.. doxygentypedef:: eth_phy_check_init_func
.. doxygentypedef:: eth_phy_get_speed_mode_func
.. doxygentypedef:: eth_phy_get_duplex_mode_func
.. doxygentypedef:: eth_phy_func
.. doxygentypedef:: eth_tcpip_input_func
ethernet: add first version of ethernet driver
2016-11-08 09:45:17 +00:00
.. doxygentypedef:: eth_gpio_config_func
ethernet: support flow control
2017-01-06 05:49:42 +00:00
.. doxygentypedef:: eth_phy_get_partner_pause_enable_func
ethernet: add first version of ethernet driver
2016-11-08 09:45:17 +00:00
Enumerations
^^^^^^^^^^^^
.. doxygenenum:: eth_mode_t
ethernet: update docs
2017-01-06 06:16:34 +00:00
.. doxygenenum:: eth_speed_mode_t
.. doxygenenum:: eth_duplex_mode_t
ethernet: add first version of ethernet driver
2016-11-08 09:45:17 +00:00
.. doxygenenum:: eth_phy_base_t
Structures
^^^^^^^^^^
.. doxygenstruct:: eth_config_t
:members:
Functions
^^^^^^^^^
.. doxygenfunction:: esp_eth_init
.. doxygenfunction:: esp_eth_tx
.. doxygenfunction:: esp_eth_enable
.. doxygenfunction:: esp_eth_disable
.. doxygenfunction:: esp_eth_get_mac
.. doxygenfunction:: esp_eth_smi_write
.. doxygenfunction:: esp_eth_smi_read
ethernet: Add convenience functions esp_eth_smi_wait_value() & esp_eth_smi_wait_set() Covers the common case of waiting for a particular PHY register to have a particular value.
2017-04-19 03:43:25 +00:00
.. doxygenfunction:: esp_eth_smi_wait_value
.. doxygenfunction:: esp_eth_smi_wait_set
ethernet: update docs
2017-01-06 06:16:34 +00:00
.. doxygenfunction:: esp_eth_free_rx_buf
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 Configuration Constants
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenvariable:: phy_tlk110_default_ethernet_config
.. doxygenvariable:: phy_lan8720_default_ethernet_config
Reference in a new issue Copy permalink