Skip to content

Commit

Permalink
Merge branch 'docfix/eth_events_4.2' into 'release/v4.2'
Browse files Browse the repository at this point in the history
Added warning when to init user Eth handlers (release/v4.2)

See merge request espressif/esp-idf!14952
  • Loading branch information
kostaond committed Aug 27, 2021
2 parents df21394 + 933567d commit 436517f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/en/api-reference/network/esp_eth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 436517f

Please sign in to comment.