alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 04:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/create_l2tap_example' into 'master'

Browse Source 
Feature/create l2tap example

Closes IDF-4096

See merge request espressif/esp-idf!17641
This commit is contained in:
Ondrej Kosta
2022-04-13 18:58:43 +08:00
parent 3b3bfc1971 fcdb0306d0
commit 90829e64d5
11 changed files with 583 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/en/api-reference/network/esp_netif.rst
View File

@@ -182,6 +182,19 @@ All set configuration options have getter counterpart option to read the current
| **ENOSPC** - NETIF L2 receive hook is already taken by other function when trying to assign Network Interface to the file descriptor.
| **ENOSYS** - unsupported operation, passed configuration option does not exists.
fcntl()
^^^^^^^
``fcntl()`` is used to manipulate with properties of opened ESP-NETIF L2 TAP file descriptor.
The following commands manipulate the status flags associated with file descriptor:
* ``F_GETFD`` - the function returns the file descriptor flags, the third argument is ignored.
* ``F_SETFD`` - sets the file descriptor flags to the value specified by the third argument. Zero is returned.
| On error, -1 is returned, and ``errno`` is set to indicate the error.
| **EBADF** - not a valid file descriptor.
| **ENOSYS** - unsupported command.
read()
^^^^^^
Opened and configured ESP-NETIF L2 TAP file descriptor can be accessed by ``read()`` to get inbound frames. The read operation can be either blocking or non-blocking based on actual state of ``O_NONBLOCK`` file status flag. When the file status flag is set blocking, the read operation waits until a frame is received and context is switched to other task. When the file status flag is set non-blocking, the read operation returns immediately. In such case, either a frame is returned if it was already queued or the function indicates the queue is empty. The number of queued frames associated with one file descriptor is limited by :ref:`CONFIG_ESP_NETIF_L2_TAP_RX_QUEUE_SIZE` Kconfig option. Once the number of queued frames reach configured threshold, the newly arriving frames are dropped until the queue has enough room to accept incoming traffic (Tail Drop queue management).
@@ -230,6 +243,8 @@ Please refer to the example section for basic initialization of default interfac
- Ethernet: :example_file:`ethernet/basic/main/ethernet_example_main.c`
- L2 TAP: :example_file:`protocols/l2tap/main/l2tap_main.c`
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
- WiFi Access Point: :example_file:`wifi/getting_started/softAP/main/softap_example_main.c`