meshx_txcm.h File Reference

MeshX Tx Control Module This header file contains the definitions and function prototypes for the MeshX Tx Control Module, which is responsible for managing transmission control in the MeshX BLE Mesh stack. More...

#include <stdint.h>
#include <stddef.h>
#include "meshx_err.h"
#include "meshx_common.h"
#include "meshx_control_task.h"
#include "interface/ble_mesh/meshx_ble_mesh_cmn_def.h"

Go to the source code of this file.

Data Structures
struct	meshx_txcm_request
	Structure for Tx Control module requests. More...

Macros
#define	MESHX_TXCM_MSG_RETRY_MAX   3
	Maximum number of retries for a message.
#define	MESHX_TXCM_MSG_PARAM_MAX_LEN   64
	Maximum length of the message parameters in bytes.
#define	MESHX_TXCM_TX_Q_LEN   10
	Maximum number of transmission items in the Tx queue.
#define	MESHX_TXCM_TX_Q_DEPTH   sizeof(meshx_txcm_tx_q_t)
	Depth (size) of each transmission queue entry.

Typedefs
typedef control_task_msg_handle_t	meshx_txcm_cb_t
typedef meshx_err_t(*	meshx_txcm_fn_model_send_t) (meshx_cptr_t msg_param, size_t msg_param_len)
	Function pointer the Model client layer needs to provide for the msg to be sent for both MESHX_TXCM_SIG_ENQ_SEND and MESHX_TXCM_SIG_DIRECT_SEND.
typedef struct meshx_txcm_request	meshx_txcm_request_t
	Structure for Tx Control module requests.

Enumerations
enum	meshx_txcm_sig_t {   MESHX_TXCM_SIG_ENQ_SEND = 0 ,   MESHX_TXCM_SIG_DIRECT_SEND = 1 ,   MESHX_TXCM_SIG_RESEND = 2 ,   MESHX_TXCM_SIG_ACK = 3 ,   MESHX_TXCM_SIG_MAX }
	Enumeration of signal types for the Tx Control Module. More...
enum	meshx_txcm_msg_state_t {   MESHX_TXCM_MSG_STATE_NONE = 0 ,   MESHX_TXCM_MSG_STATE_NEW = 1 ,   MESHX_TXCM_MSG_STATE_SENDING = 2 ,   MESHX_TXCM_MSG_STATE_WAITING_ACK = 3 ,   MESHX_TXCM_MSG_STATE_ACK = 4 ,   MESHX_TXCM_MSG_STATE_NACK = 5 ,   MESHX_TXCM_MSG_STATE_MAX }
	Enumeration of message states for the Tx Control Module. More...
enum	meshx_txcm_msg_type_t {   MESHX_TXCM_MSG_TYPE_ACKED ,   MESHX_TXCM_MSG_TYPE_UNACKED ,   MESHX_TXCM_MSG_TYPE_MAX }

Functions
meshx_err_t	meshx_txcm_init (dev_struct_t *pdev)
	Initializes the MeshX Tx Control Module.
meshx_err_t	meshx_txcm_request_send (meshx_txcm_sig_t request_type, uint16_t dest_addr, meshx_cptr_t msg_param, uint16_t msg_param_len, meshx_txcm_fn_model_send_t send_fn)
	Sends a request to the Tx Control module.
meshx_err_t	meshx_txcm_event_cb_reg (meshx_txcm_cb_t event_cb)
	Registers a callback function for handling Tx Control module events.

Detailed Description

MeshX Tx Control Module This header file contains the definitions and function prototypes for the MeshX Tx Control Module, which is responsible for managing transmission control in the MeshX BLE Mesh stack.

Copyright

Copyright © 2024 - 2025 MeshX

Author

Pranjal Chanda

Macro Definition Documentation

MESHX_TXCM_MSG_PARAM_MAX_LEN

#define MESHX_TXCM_MSG_PARAM_MAX_LEN   64

Maximum length of the message parameters in bytes.

MESHX_TXCM_MSG_RETRY_MAX

#define MESHX_TXCM_MSG_RETRY_MAX   3

Maximum number of retries for a message.

MESHX_TXCM_TX_Q_DEPTH

#define MESHX_TXCM_TX_Q_DEPTH   sizeof(meshx_txcm_tx_q_t)

Depth (size) of each transmission queue entry.

MESHX_TXCM_TX_Q_LEN

#define MESHX_TXCM_TX_Q_LEN   10

Maximum number of transmission items in the Tx queue.

Typedef Documentation

meshx_txcm_cb_t

typedef control_task_msg_handle_t meshx_txcm_cb_t

meshx_txcm_fn_model_send_t

typedef meshx_err_t(* meshx_txcm_fn_model_send_t) (meshx_cptr_t msg_param, size_t msg_param_len)

Function pointer the Model client layer needs to provide for the msg to be sent for both MESHX_TXCM_SIG_ENQ_SEND and MESHX_TXCM_SIG_DIRECT_SEND.

Parameters

[in]	msg_param	Pointer to the model specific parameter structure
[in]	msg_param_len	Length of the msg_param

meshx_txcm_request_t

typedef struct meshx_txcm_request meshx_txcm_request_t

Structure for Tx Control module requests.

This structure holds the details of a transmission request, including the type of signal, the send function callback, and parameters for the message to be transmitted.

Enumeration Type Documentation

meshx_txcm_msg_state_t

enum meshx_txcm_msg_state_t

Enumeration of message states for the Tx Control Module.

This enumeration defines the different states a message can be in during transmission, including new messages, waiting for acknowledgment, acknowledged messages, and the maximum state value.

Enumerator
MESHX_TXCM_MSG_STATE_NONE	0	New message state
MESHX_TXCM_MSG_STATE_NEW	1	New message state
MESHX_TXCM_MSG_STATE_SENDING	2	Message sending state
MESHX_TXCM_MSG_STATE_WAITING_ACK	3	Message waiting for acknowledgment state
MESHX_TXCM_MSG_STATE_ACK	4	Message acknowledged state
MESHX_TXCM_MSG_STATE_NACK	5	Message not acknowledged state
MESHX_TXCM_MSG_STATE_MAX

{
    MESHX_TXCM_MSG_STATE_NONE        = 0,   /**< New message state */
    MESHX_TXCM_MSG_STATE_NEW         = 1,   /**< New message state */
    MESHX_TXCM_MSG_STATE_SENDING     = 2,   /**< Message sending state */
    MESHX_TXCM_MSG_STATE_WAITING_ACK = 3,   /**< Message waiting for acknowledgment state */
    MESHX_TXCM_MSG_STATE_ACK         = 4,   /**< Message acknowledged state */
    MESHX_TXCM_MSG_STATE_NACK        = 5,   /**< Message not acknowledged state */
    MESHX_TXCM_MSG_STATE_MAX,
} meshx_txcm_msg_state_t;

meshx_txcm_msg_type_t

enum meshx_txcm_msg_type_t

Enumerator
MESHX_TXCM_MSG_TYPE_ACKED
MESHX_TXCM_MSG_TYPE_UNACKED
MESHX_TXCM_MSG_TYPE_MAX

{
    MESHX_TXCM_MSG_TYPE_ACKED,
    MESHX_TXCM_MSG_TYPE_UNACKED,
    MESHX_TXCM_MSG_TYPE_MAX
}meshx_txcm_msg_type_t;

meshx_txcm_sig_t

enum meshx_txcm_sig_t

Enumeration of signal types for the Tx Control Module.

This enumeration defines the different types of signals that can be sent to the Tx Control Module, each representing a different type of transmission command.

Enumerator
MESHX_TXCM_SIG_ENQ_SEND	0	Signal to enqueue a transmission command
MESHX_TXCM_SIG_DIRECT_SEND	1	Signal to directly send a transmission command without queuing
MESHX_TXCM_SIG_RESEND	2	Signal to resend the last transmission queued message
MESHX_TXCM_SIG_ACK	3	Signal to acknowledge the last transmission message
MESHX_TXCM_SIG_MAX		Maximum signal type value

{
    MESHX_TXCM_SIG_ENQ_SEND     = 0,  /**< Signal to enqueue a transmission command */
    MESHX_TXCM_SIG_DIRECT_SEND  = 1,  /**< Signal to directly send a transmission command without queuing */
    MESHX_TXCM_SIG_RESEND       = 2,  /**< Signal to resend the last transmission queued message */
    MESHX_TXCM_SIG_ACK          = 3,  /**< Signal to acknowledge the last transmission message */
    MESHX_TXCM_SIG_MAX,               /**< Maximum signal type value */
} meshx_txcm_sig_t;

Function Documentation

meshx_txcm_event_cb_reg()

meshx_err_t meshx_txcm_event_cb_reg

(

meshx_txcm_cb_t

event_cb

)

Registers a callback function for handling Tx Control module events.

This function registers a callback function to handle specific events from the Tx Control module. The callback will be invoked when the specified event occurs.

Parameters

[in]

event_cb

Pointer to the callback function to be registered for event handling.

Returns

meshx_err_t

• MESHX_SUCCESS on successful registration.
• Error code (meshx_err_t) if registration fails.

{
    return control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_TXCM,
        CONTROL_TASK_MSG_EVT_TXCM_MSG_TIMEOUT,
        event_cb);
}

meshx_txcm_init()

meshx_err_t meshx_txcm_init

(

dev_struct_t *

pdev

)

Initializes the MeshX Tx Control Module.

This function sets up the transmission control module for MeshX. It checks if the module has already been initialized using an initialization magic value. If not initialized, it sets the magic value, assigns the provided device structure to the task argument, and creates the Tx Control task.

Parameters

[in]

pdev

Pointer to the device structure to be used by the Tx Control Module.

Returns

• MESHX_SUCCESS on successful initialization or if already initialized.
• Error code (meshx_err_t) if task creation fails.

{
    MESHX_LOGD(MODULE_ID_TXCM, "Initializing MeshX Tx Control Module");
    if(g_txcm.init_magic == MESHX_TXCM_INIT_MAGIC)
    {
        return MESHX_SUCCESS;
    }
    meshx_err_t err = MESHX_SUCCESS;
    g_txcm.init_magic = MESHX_TXCM_INIT_MAGIC;
    g_txcm.txcm_task.arg = pdev;
 
    /* Create Control Signal Queue */
    err = meshx_msg_q_create(&g_txcm.txcm_sig_queue);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_TXCM, "Failed to create Tx Control Signal Queue: %p", (void *)err);
        return err;
    }
 
    err = meshx_task_create(&g_txcm.txcm_task);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_TXCM, "Failed to create Tx Control task: %p", (void *)err);
        return err;
    }
 
    return MESHX_SUCCESS;
}

meshx_txcm_request_send()

meshx_err_t meshx_txcm_request_send	(	meshx_txcm_sig_t	request_type,
		uint16_t	dest_addr,
		meshx_cptr_t	msg_param,
		uint16_t	msg_param_len,
		meshx_txcm_fn_model_send_t	send_fn )

Sends a request to the Tx Control module.

This function sends a request to the Tx Control module with the specified parameters. It creates a new request structure, copies the message parameters, and sends the request to the signal queue of the Tx Control module.

Parameters

[in]	request_type	Type of the request (ACK, RESEND, ENQ_SEND, DIRECT_SEND)
[in]	dest_addr	Destination address of the message
[in]	msg_param	Pointer to the message parameters
[in]	msg_param_len	Length of the message parameters
[in]	send_fn	Function pointer to the send function to be used for the request

Returns

meshx_err_t

{
    meshx_err_t err = MESHX_SUCCESS;
    meshx_txcm_request_t new_req;
    memset(&new_req, 0, sizeof(meshx_txcm_request_t));
 
    /* Prepare request message */
    new_req.dest_addr     = dest_addr;
    new_req.send_fn       = send_fn;
    new_req.request_type  = request_type;
    new_req.msg_param_len = msg_param_len;
 
    /* Auto-downgrade Group/Broadcast addresses to DIRECT_SEND */
    if (dest_addr >= MESHX_ADDR_GROUP_START && new_req.request_type == MESHX_TXCM_SIG_ENQ_SEND)
    {
        MESHX_LOGW(MODULE_ID_TXCM, "Auto-downgrading multicast/broadcast (0x%X) to DIRECT_SEND", dest_addr);
        new_req.request_type = MESHX_TXCM_SIG_DIRECT_SEND;
    }
 
    if(msg_param_len != 0 && msg_param != NULL)
    {
        /* Retain message context */
        err = meshx_rtos_malloc(&new_req.msg_param, msg_param_len);
        if (err)
        {
            MESHX_LOGE(MODULE_ID_TXCM, "Malloc Failure: %p", (void *)err);
            return err;
        }
        memcpy(new_req.msg_param, msg_param, msg_param_len);
    }
    else
    {
        new_req.msg_param = NULL;
    }
    err = meshx_msg_q_send(&g_txcm.txcm_sig_queue, &new_req, sizeof(meshx_txcm_request_t), 0);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_TXCM, "TXCM Signal failed: %p", (void *)err);
        meshx_rtos_free(&new_req.msg_param);
        return err;
    }
    return err;
}