-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
openthread: Add support for platform message management #18564
base: main
Are you sure you want to change the base?
Conversation
adigie
commented
Nov 5, 2024
- doc: openthread: add section on message pool configuration
- doc: matter: add note on openthread memory configuration
- manifest: sdk-zephyr:
- [nrf fromlist] net: openthread: Add platform message management
The following west manifest projects have been modified in this Pull Request:
Note: This message is automatically posted and updated by the Manifest GitHub Action. |
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: 6e47660d94b3d1ff40c57a19c4708d38a0949afd more detailssdk-nrf:
zephyr:
Github labels
List of changed files detected by CI (238)
Outputs:ToolchainVersion: b44b7a08c9 Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publishing GitHub Action. |
Add section on openthread message pool configuration. Signed-off-by: Adrian Gielniewski <[email protected]>
Mention openthread memory configuration in matter docs. Signed-off-by: Adrian Gielniewski <[email protected]>
* [nrf fromlist] net: openthread: Add platform message management Signed-off-by: Adrian Gielniewski <[email protected]>
cb0149b
to
6e47660
Compare
The Thread protocol has separate configuration for memory allocation. See the :ref:`thread_ot_memory_configuration` documentation for more | ||
information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Thread protocol has separate configuration for memory allocation. See the :ref:`thread_ot_memory_configuration` documentation for more | |
information. | |
The Thread protocol has a separate configuration for memory allocation. | |
See :ref:`thread_configuring_messagepool` in the Thread documentation for more information. |
.. _thread_ot_memory_configuration: | ||
|
||
Message pool configuration | ||
************************** | ||
|
||
OpenThread uses a message pool to manage memory for message buffers. | ||
Memory for the message pool can be statically allocated by the OpenThread stack or managed by the platform. | ||
The :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` Kconfig option can be used to | ||
enable platform message management. | ||
|
||
Message buffer size and number of message buffers in the pool can be configured with :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` | ||
and :kconfig:option:`CONFIG_OPENTHREAD_NUM_MESSAGE_BUFFERS` Kconfig options, respecitvely. By | ||
default, both options are set to ``128``. | ||
|
||
.. important:: | ||
|
||
Please note, that when using :ref:`thread_ug_prebuilt`, changing :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` | ||
will have no effect. Additionally, :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` Kconfig option have to be set | ||
to the same value, as in the pre-built library. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would move this section to doc/nrf/protocols/thread/configuring.rst
instead, under the Additional configuration options heading, after Thread Specification options.
.. _thread_ot_memory_configuration: | |
Message pool configuration | |
************************** | |
OpenThread uses a message pool to manage memory for message buffers. | |
Memory for the message pool can be statically allocated by the OpenThread stack or managed by the platform. | |
The :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` Kconfig option can be used to | |
enable platform message management. | |
Message buffer size and number of message buffers in the pool can be configured with :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` | |
and :kconfig:option:`CONFIG_OPENTHREAD_NUM_MESSAGE_BUFFERS` Kconfig options, respecitvely. By | |
default, both options are set to ``128``. | |
.. important:: | |
Please note, that when using :ref:`thread_ug_prebuilt`, changing :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` | |
will have no effect. Additionally, :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` Kconfig option have to be set | |
to the same value, as in the pre-built library. | |
.. _thread_configuring_messagepool: | |
Message pool configuration | |
************************** | |
OpenThread uses a message pool to manage memory for message buffers. | |
Memory for the message pool can be statically allocated by the OpenThread stack or managed by the platform. | |
You can use the :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` Kconfig option to enable platform message management. | |
Message buffer size and number of message buffers in the pool are be configured with the :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` and :kconfig:option:`CONFIG_OPENTHREAD_NUM_MESSAGE_BUFFERS` Kconfig options, respectively. | |
By default, both options are set to ``128``. | |
.. note:: | |
When using :ref:`thread_ug_prebuilt`, changing the :kconfig:option:`CONFIG_OPENTHREAD_PLATFORM_MESSAGE_MANAGEMENT` Kconfig option will have no effect. | |
Additionally, the :kconfig:option:`CONFIG_OPENTHREAD_MESSAGE_BUFFER_SIZE` Kconfig option has to be set to the same value that is used in the pre-built library. |