mirror of
https://github.com/espressif/esp-idf.git
synced 2025-07-29 18:27:20 +02:00
docs(ieee802154): add migration note for the receive done handler feature
This commit is contained in:
@ -66,6 +66,8 @@ WIFI_DOCS = ['api-guides/wifi.rst',
|
||||
'api-reference/network/esp_wifi.rst',
|
||||
'api-reference/network/esp_dpp.rst']
|
||||
|
||||
IEEE802154_DOCS = ['migration-guides/release-5.x/5.1/ieee802154.rst']
|
||||
|
||||
NAN_DOCS = ['api-reference/network/esp_nan.rst']
|
||||
|
||||
WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst',
|
||||
@ -179,6 +181,7 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
|
||||
'SOC_BLUFI_SUPPORTED':BLUFI_DOCS,
|
||||
'SOC_WIFI_SUPPORTED':WIFI_DOCS,
|
||||
'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
|
||||
'SOC_IEEE802154_SUPPORTED':IEEE802154_DOCS,
|
||||
'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,
|
||||
'SOC_SDMMC_HOST_SUPPORTED':SDMMC_DOCS,
|
||||
'SOC_SDIO_SLAVE_SUPPORTED':SDIO_SLAVE_DOCS,
|
||||
|
13
docs/en/migration-guides/release-5.x/5.1/ieee802154.rst
Normal file
13
docs/en/migration-guides/release-5.x/5.1/ieee802154.rst
Normal file
@ -0,0 +1,13 @@
|
||||
IEEE 802.15.4
|
||||
=============
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Receive Handle Done
|
||||
-------------------
|
||||
|
||||
.. note::
|
||||
|
||||
It is required since IDF v5.1.3 release.
|
||||
|
||||
User must call the function :cpp:func:`esp_ieee802154_receive_handle_done` to notify 802.15.4 driver after the received frame is handled. Otherwise the frame buffer will not be freed for future use.
|
@ -7,6 +7,7 @@ Migration from 5.0 to 5.1
|
||||
:maxdepth: 1
|
||||
|
||||
gcc
|
||||
:SOC_IEEE802154_SUPPORTED: ieee802154
|
||||
peripherals
|
||||
storage
|
||||
networking
|
||||
|
13
docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst
Normal file
13
docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst
Normal file
@ -0,0 +1,13 @@
|
||||
IEEE 802.15.4
|
||||
=============
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
Receive Handle Done
|
||||
-------------------
|
||||
|
||||
.. note::
|
||||
|
||||
这个功能仅包括在 IDF v5.1.3 以及之后的发布中。
|
||||
|
||||
当收到的数据帧被处理后, 用户需要调用函数 :cpp:func:`esp_ieee802154_receive_handle_done` 通知 802.15.4 驱动层,否则这个数据空间将不会被释放。
|
@ -7,6 +7,7 @@
|
||||
:maxdepth: 1
|
||||
|
||||
gcc
|
||||
:SOC_IEEE802154_SUPPORTED: ieee802154
|
||||
peripherals
|
||||
storage
|
||||
networking
|
||||
|
Reference in New Issue
Block a user