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

docs(ieee802154): add migration note for the receive done handler feature

Browse Source
This commit is contained in:
Shu Chen 2024-01-24 19:34:00 +08:00
parent aab24b0dd7
commit 6bc666064a
9 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf_common.py
View File

@ -71,6 +71,9 @@ WIFI_DOCS = ['api-guides/wifi.rst',
'api-reference/provisioning/wifi_provisioning.rst', 'api-reference/provisioning/wifi_provisioning.rst',
'migration-guides/release-5.x/5.2/wifi.rst'] 'migration-guides/release-5.x/5.2/wifi.rst']
IEEE802154_DOCS = ['migration-guides/release-5.x/5.1/ieee802154.rst',
'migration-guides/release-5.x/5.2/ieee802154.rst']
NAN_DOCS = ['api-reference/network/esp_nan.rst'] NAN_DOCS = ['api-reference/network/esp_nan.rst']
WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst', WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst',
@ -194,6 +197,7 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
'SOC_BLUFI_SUPPORTED':BLUFI_DOCS, 'SOC_BLUFI_SUPPORTED':BLUFI_DOCS,
'SOC_WIFI_SUPPORTED':WIFI_DOCS, 'SOC_WIFI_SUPPORTED':WIFI_DOCS,
'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS, 'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
'SOC_IEEE802154_SUPPORTED':IEEE802154_DOCS,
'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS, 'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,
'SOC_PSRAM_DMA_CAPABLE':MM_SYNC_DOCS, 'SOC_PSRAM_DMA_CAPABLE':MM_SYNC_DOCS,
'SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE':MM_SYNC_DOCS, 'SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE':MM_SYNC_DOCS,

13
docs/en/migration-guides/release-5.x/5.1/ieee802154.rst Normal file
View 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.

1
docs/en/migration-guides/release-5.x/5.1/index.rst
View File

@ -7,6 +7,7 @@ Migration from 5.0 to 5.1
:maxdepth: 1 :maxdepth: 1
gcc gcc
:SOC_IEEE802154_SUPPORTED: ieee802154
peripherals peripherals
storage storage
networking networking

9
docs/en/migration-guides/release-5.x/5.2/ieee802154.rst Normal file
View File

@ -0,0 +1,9 @@
IEEE 802.15.4
=============
:link_to_translation:`zh_CN:[中文]`
Receive Handle Done
-------------------
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.

1
docs/en/migration-guides/release-5.x/5.2/index.rst
View File

@ -8,6 +8,7 @@ Migration from 5.1 to 5.2
bluetooth-classic bluetooth-classic
gcc gcc
:SOC_IEEE802154_SUPPORTED: ieee802154
peripherals peripherals
protocols protocols
storage storage

13
docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst Normal file
View 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 驱动层，否则这个数据空间将不会被释放。

1
docs/zh_CN/migration-guides/release-5.x/5.1/index.rst
View File

@ -7,6 +7,7 @@
:maxdepth: 1 :maxdepth: 1
gcc gcc
:SOC_IEEE802154_SUPPORTED: ieee802154
peripherals peripherals
storage storage
networking networking

9
docs/zh_CN/migration-guides/release-5.x/5.2/ieee802154.rst Normal file
View File

@ -0,0 +1,9 @@
IEEE 802.15.4
=============
:link_to_translation:`en:[English]`
Receive Handle Done
-------------------
当收到的数据帧被处理后， 用户需要调用函数 :cpp:func:`esp_ieee802154_receive_handle_done` 通知 802.15.4 驱动层，否则这个数据空间将不会被释放。

1
docs/zh_CN/migration-guides/release-5.x/5.2/index.rst
View File

@ -8,6 +8,7 @@
bluetooth-classic bluetooth-classic
gcc gcc
:SOC_IEEE802154_SUPPORTED: ieee802154
peripherals peripherals
protocols protocols
storage storage