diff options
| author | Peter Mitsis <peter.mitsis@windriver.com> | 2016-10-06 11:36:59 -0400 |
|---|---|---|
| committer | Benjamin Walsh <benjamin.walsh@windriver.com> | 2016-10-19 14:54:44 +0000 |
| commit | 1da807e7a8bb61a8eea1052075037b402335674d (patch) | |
| tree | 5da23c84a2e03fb76d6038cf07a97a377ba19e61 /doc | |
| parent | 67be24909dbf272f39d51b92d0289a9df10f520d (diff) | |
unified: Tweak msgq API parameters
- Reorders parameters where necessary
- Adds alignment parameter to K_MSGQ_DEFINE() for buffer alignment
- Renames parameters where necessary so they are more intuitive
Change-Id: I0b53105c04109127897bf4790e6908082f82da4e
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/kernel_v2/data_passing/message_queues.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/kernel_v2/data_passing/message_queues.rst b/doc/kernel_v2/data_passing/message_queues.rst index 84155035f..4fb08a46e 100644 --- a/doc/kernel_v2/data_passing/message_queues.rst +++ b/doc/kernel_v2/data_passing/message_queues.rst @@ -73,10 +73,10 @@ that is capable of holding 10 items. ... }; - char my_msgq_buffer[10 * sizeof(data_item_type)]; + char __aligned(4) my_msgq_buffer[10 * sizeof(data_item_type)]; struct k_msgq my_msgq; - k_msgq_init(&my_msgq, 10, sizeof(data_item_type), my_msgq_buffer); + k_msgq_init(&my_msgq, my_msgq_buffer, sizeof(data_item_type), 10); Alternatively, a message queue can be defined and initialized at compile time by calling :c:macro:`K_MSGQ_DEFINE()`. @@ -86,7 +86,7 @@ that the macro defines both the message queue and its buffer. .. code-block:: c - K_MSGQ_DEFINE(my_msgq, 10, sizeof(data_item_type)); + K_MSGQ_DEFINE(my_msgq, sizeof(data_item_type), 10, 4); Writing to a Message Queue ========================== |