alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docfix/eth_events_4.2' into 'release/v4.2'

Browse Source 
Added warning when to init user Eth handlers (release/v4.2)

See merge request espressif/esp-idf!14952
This commit is contained in:
Ondrej Kosta 2021-08-27 09:15:40 +00:00
commit 436517fb7f
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/api-reference/network/esp_eth.rst
View File

@ -313,6 +313,9 @@ More information about network interface, please refer to :doc:`Network Interfac
esp_netif_attach(eth_netif, esp_eth_new_netif_glue(eth_handle)); // attach Ethernet driver to TCP/IP stack
esp_eth_start(eth_handle); // start Ethernet driver state machine
.. warning::
User's Ethernet/IP event handlers need to be registered after registration of default handlers (i.e. after :cpp:func:`esp_eth_set_default_handlers`). General recommendation is to fully initialize Ethernet driver and network interface prior registering user's Ethernet/IP event handlers, i.e. register the user event handlers as the last thing prior starting the Ethernet driver. Such approach ensures that Ethernet/IP events get executed first by the Ethernet driver or network interface and so the system is in expected state when executing user's handlers.
.. _misc-operation-of-driver:
Misc control of Ethernet driver