From bec90ce050ad57a21637be986d98cc0357a27941 Mon Sep 17 00:00:00 2001 From: Shu Chen Date: Wed, 24 Jan 2024 19:34:00 +0800 Subject: [PATCH] docs(ieee802154): add migration note for the receive done handler feature --- docs/conf_common.py | 4 ++++ .../migration-guides/release-5.x/5.1/ieee802154.rst | 13 +++++++++++++ docs/en/migration-guides/release-5.x/5.1/index.rst | 1 + .../migration-guides/release-5.x/5.2/ieee802154.rst | 9 +++++++++ docs/en/migration-guides/release-5.x/5.2/index.rst | 1 + .../migration-guides/release-5.x/5.1/ieee802154.rst | 13 +++++++++++++ .../migration-guides/release-5.x/5.1/index.rst | 1 + .../migration-guides/release-5.x/5.2/ieee802154.rst | 9 +++++++++ .../migration-guides/release-5.x/5.2/index.rst | 1 + 9 files changed, 52 insertions(+) create mode 100644 docs/en/migration-guides/release-5.x/5.1/ieee802154.rst create mode 100644 docs/en/migration-guides/release-5.x/5.2/ieee802154.rst create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.2/ieee802154.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index 5c696b8f70..1d8cab4e93 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -65,6 +65,9 @@ WIFI_DOCS = ['api-guides/wifi.rst', 'api-reference/network/esp_dpp.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'] WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst', @@ -187,6 +190,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_PSRAM_DMA_CAPABLE':MM_SYNC_DOCS, 'SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE':MM_SYNC_DOCS, diff --git a/docs/en/migration-guides/release-5.x/5.1/ieee802154.rst b/docs/en/migration-guides/release-5.x/5.1/ieee802154.rst new file mode 100644 index 0000000000..ac31b1cdd4 --- /dev/null +++ b/docs/en/migration-guides/release-5.x/5.1/ieee802154.rst @@ -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. diff --git a/docs/en/migration-guides/release-5.x/5.1/index.rst b/docs/en/migration-guides/release-5.x/5.1/index.rst index 4a3c4b65d7..55037853db 100644 --- a/docs/en/migration-guides/release-5.x/5.1/index.rst +++ b/docs/en/migration-guides/release-5.x/5.1/index.rst @@ -7,6 +7,7 @@ Migration from 5.0 to 5.1 :maxdepth: 1 gcc + :SOC_IEEE802154_SUPPORTED: ieee802154 peripherals storage networking diff --git a/docs/en/migration-guides/release-5.x/5.2/ieee802154.rst b/docs/en/migration-guides/release-5.x/5.2/ieee802154.rst new file mode 100644 index 0000000000..13c0f38d76 --- /dev/null +++ b/docs/en/migration-guides/release-5.x/5.2/ieee802154.rst @@ -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. diff --git a/docs/en/migration-guides/release-5.x/5.2/index.rst b/docs/en/migration-guides/release-5.x/5.2/index.rst index a4634a8ddb..b8d55b1ace 100644 --- a/docs/en/migration-guides/release-5.x/5.2/index.rst +++ b/docs/en/migration-guides/release-5.x/5.2/index.rst @@ -8,6 +8,7 @@ Migration from 5.1 to 5.2 bluetooth-classic gcc + :SOC_IEEE802154_SUPPORTED: ieee802154 peripherals protocols storage diff --git a/docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst b/docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst new file mode 100644 index 0000000000..e8d5672a4d --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.1/ieee802154.rst @@ -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 驱动层，否则这个数据空间将不会被释放。 diff --git a/docs/zh_CN/migration-guides/release-5.x/5.1/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.1/index.rst index c95cac366c..53a848060a 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.1/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.1/index.rst @@ -7,6 +7,7 @@ :maxdepth: 1 gcc + :SOC_IEEE802154_SUPPORTED: ieee802154 peripherals storage networking diff --git a/docs/zh_CN/migration-guides/release-5.x/5.2/ieee802154.rst b/docs/zh_CN/migration-guides/release-5.x/5.2/ieee802154.rst new file mode 100644 index 0000000000..46b1fe87d1 --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.2/ieee802154.rst @@ -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 驱动层，否则这个数据空间将不会被释放。 diff --git a/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst index 46f38b0d1e..acdbb5246e 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.2/index.rst @@ -8,6 +8,7 @@ bluetooth-classic gcc + :SOC_IEEE802154_SUPPORTED: ieee802154 peripherals protocols storage