Commit f5e38130 authored by Rodrigo Peixoto's avatar Rodrigo Peixoto Committed by Anas Nashif
Browse files

docs: Fix mailbox k_mbox_msg.tx_block documentation 



- Replace old tx_block.pool_id to tx_block.data;
- Fix code examples.

Signed-off-by: default avatarRodrigo Peixoto <rodrigopex@ayna.tech>
Signed-off-by: default avatarRodrigo Peixoto <rodrigopex@gmail.com>
Signed-off-by: default avatarAnas Nashif <anas.nashif@intel.com>
parent d62117e5

doc/kernel/data_passing/mailboxes.rst

+3 −2
Original line number Diff line number Diff line
@@ -166,7 +166,7 @@ internal mailbox use only. 
    Leave this field uninitialized when receiving a message.



*tx_block*

    The descriptor for the sending thread's memory block. Set tx_block.pool_id

    The descriptor for the sending thread's memory block. Set tx_block.data

    to :c:macro:`NULL` when sending an empty message. Leave this field

    uninitialized when sending a message buffer, or when receiving a message.
@@ -259,7 +259,7 @@ portion of the message isn't used. 
            send_msg.info = random_value;

            send_msg.size = 0;

            send_msg.tx_data = NULL;

            send_msg.tx_block.pool_id = NULL;

            send_msg.tx_block.data = NULL;

            send_msg.tx_target_thread = K_ANY;



            /* send message and wait until a consumer receives it */
@@ -295,6 +295,7 @@ the maximum size message buffer that each thread can handle. 
            send_msg.info = buffer_bytes_used;

            send_msg.size = buffer_bytes_used;

            send_msg.tx_data = buffer;

            send_msg.tx_block.data = NULL;

            send_msg.tx_target_thread = K_ANY;



            /* send message and wait until a consumer receives it */

CRA Git | Maintained and supported by SUSTech CRA and CCSE