meshx_gen_client.c File Reference

Implementation of the MeshX generic client model for BLE mesh nodes. This file contains functions for registering, deregistering, and initializing the generic client model. More...

#include "stdlib.h"
#include "meshx_txcm.h"
#include "meshx_gen_client.h"

Include dependency graph for meshx_gen_client.c:

Go to the source code of this file.

Data Structures
struct	meshx_gen_cli_cb_reg
	Structure containing the model ID and callback function for generic client model registrations. More...
struct	meshx_gen_cli_resend_ctx
	Structure containing the model ID and parameter for generic client model message re-sending. More...
struct	meshx_gen_client_msg_ctx
	Structure containing the message context for generic client model messages. More...
struct	meshx_gen_cli_cb_reg_node
	Structure containing a node in the linked list of registered callbacks. More...

Macros
#define	MESHX_CLIENT_INIT_MAGIC_NO   0x1121

Typedefs
typedef struct meshx_gen_cli_cb_reg	meshx_gen_cli_cb_reg_t
typedef struct meshx_gen_cli_resend_ctx	meshx_gen_cli_resend_ctx
typedef struct meshx_gen_client_msg_ctx	meshx_gen_client_msg_ctx_t
typedef struct meshx_gen_cli_cb_reg_node	meshx_gen_cli_cb_reg_node_t

Functions
static meshx_err_t	meshx_gen_cli_cb_reg_add (meshx_gen_cli_cb_reg_t reg)
	Adds a new callback registration to the linked list of registered callbacks.
static meshx_err_t	meshx_is_gen_cli_get_opcode (uint16_t opcode)
	Checks if the given opcode corresponds to a GET request in the Generic Client group.
static meshx_err_t	meshx_is_gen_cli_model (uint32_t model_id)
	Checks if the given model ID corresponds to a Generic Client model.
static meshx_err_t	meshx_is_unack_opcode (uint32_t opcode)
	Checks if the given opcode corresponds to an unacknowledged (unack) message.
static meshx_err_t	meshx_gen_client_txcm_fn_model_send (meshx_gen_client_msg_ctx_t *msg_param, size_t msg_param_len)
	Transmit callback handler for sending Generic Client model messages.
static meshx_err_t	meshx_handle_txcm_msg (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_gen_cli_resend_ctx *param)
	Handles a control task message for a generic client model.
static meshx_err_t	meshx_gen_cli_handle_ack (uint16_t src_addr)
	Handles ack request for generic client messages.
static meshx_err_t	meshx_gen_cli_handle_resend (uint16_t model_id, const meshx_gen_cli_cb_param_t *param)
	Handles resend request for generic client messages.
static meshx_err_t	meshx_handle_gen_onoff_msg (dev_struct_t *pdev, control_task_msg_evt_t model_id, meshx_gen_cli_cb_param_t *param)
	Handle the Generic OnOff Client messages.
meshx_err_t	meshx_gen_client_init (void)
	Initialize the mesh fuction generic client.
meshx_err_t	meshx_gen_cli_send_msg (meshx_gen_client_send_params_t *params)
	Sends a Generic Client message over BLE Mesh.
meshx_err_t	meshx_gen_client_from_ble_reg_cb (uint32_t model_id, meshx_gen_client_cb_t cb)
	Registers a callback function for a specific generic server model.

Variables
struct {
uint16_t   client_init
meshx_gen_cli_cb_reg_node_t *   cli_cb_reg_head
}	g_meshx_client_control

Detailed Description

Implementation of the MeshX generic client model for BLE mesh nodes. This file contains functions for registering, deregistering, and initializing the generic client model.

Copyright (c) 2024 - 2025 MeshX

The MeshX generic client model provides an interface for handling BLE mesh client operations, including callback registration and initialization.

Author

Pranjal Chanda

Definition in file meshx_gen_client.c.

Macro Definition Documentation

MESHX_CLIENT_INIT_MAGIC_NO

#define MESHX_CLIENT_INIT_MAGIC_NO   0x1121

Definition at line 20 of file meshx_gen_client.c.

Typedef Documentation

meshx_gen_cli_cb_reg_node_t

typedef struct meshx_gen_cli_cb_reg_node meshx_gen_cli_cb_reg_node_t

meshx_gen_cli_cb_reg_t

typedef struct meshx_gen_cli_cb_reg meshx_gen_cli_cb_reg_t

meshx_gen_cli_resend_ctx

typedef struct meshx_gen_cli_resend_ctx meshx_gen_cli_resend_ctx

meshx_gen_client_msg_ctx_t

typedef struct meshx_gen_client_msg_ctx meshx_gen_client_msg_ctx_t

Function Documentation

meshx_gen_cli_cb_reg_add()

static meshx_err_t meshx_gen_cli_cb_reg_add ( meshx_gen_cli_cb_reg_t reg )

static

Adds a new callback registration to the linked list of registered callbacks.

This function allocates a new node in the linked list of registered callbacks and initializes it with the provided registration information.

Parameters

[in]

reg

The structure containing the model ID and callback function to add to the linked list.

Definition at line 91 of file meshx_gen_client.c.

{
    meshx_gen_cli_cb_reg_node_t *node = (meshx_gen_cli_cb_reg_node_t*) MESHX_MALLOC(sizeof(meshx_gen_cli_cb_reg_node_t));
    if (!node)
        return MESHX_NO_MEM;
 
    node->reg = reg;
    node->next = g_meshx_client_control.cli_cb_reg_head;
    g_meshx_client_control.cli_cb_reg_head = node;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_gen_cli_handle_ack()

static meshx_err_t meshx_gen_cli_handle_ack ( uint16_t src_addr )

static

Handles ack request for generic client messages.

This function requests the TXCM module to clear the last message by sending a ACK signal with null parameters.

Parameters

[in]

src_addr

The Source address of the message.

Returns

meshx_err_t Returns the error code from meshx_txcm_request_send().

Definition at line 293 of file meshx_gen_client.c.

{
    meshx_err_t err = MESHX_SUCCESS;
    err = meshx_txcm_request_send(MESHX_TXCM_SIG_ACK, src_addr, NULL, 0, NULL);
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_cli_handle_resend()

static meshx_err_t meshx_gen_cli_handle_resend ( uint16_t model_id, const meshx_gen_cli_cb_param_t * param )

static

Handles resend request for generic client messages.

This function requests the TXCM module to resend the last message by sending a RESEND signal with null parameters.

Returns

meshx_err_t Returns the error code from meshx_txcm_request_send().

Definition at line 308 of file meshx_gen_client.c.

{
    meshx_gen_cli_resend_ctx ctx = {
        .model_id = model_id
    };
    memcpy(&ctx.param, param, sizeof(meshx_gen_cli_cb_param_t));
 
    return meshx_txcm_request_send(
        MESHX_TXCM_SIG_RESEND,
        MESHX_ADDR_UNASSIGNED,
        &ctx,
        sizeof(meshx_gen_cli_resend_ctx),
        NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_cli_send_msg()

meshx_err_t meshx_gen_cli_send_msg

(

meshx_gen_client_send_params_t *

params

)

Sends a Generic Client message over BLE Mesh.

This function sends a message from a Generic Client model to a specified address within the BLE Mesh network, using the provided opcode and parameters.

Parameters

[in]

params

Pointer to the structure containing the message parameters to set.

Returns

meshx_err_t Result of the operation. Returns MESHX_OK on success or an error code on failure.

Definition at line 426 of file meshx_gen_client.c.

{
    if (!params || !params->model || !params->state)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    bool is_unack = meshx_is_unack_opcode(params->opcode) == MESHX_SUCCESS;
    /* Broadcast / Multicast will not be sending an ACK. Hence, it is not required to queue */
    meshx_txcm_sig_t req_type = (is_unack || (MESHX_ADDR_IS_UNICAST(params->addr) == false)) ?
                                MESHX_TXCM_SIG_DIRECT_SEND : MESHX_TXCM_SIG_ENQ_SEND;
 
    meshx_gen_client_msg_ctx_t send_msg =
    {
        .addr    = params->addr,
        .model   = params->model,
        .opcode  = params->opcode,
        .app_idx = params->app_idx,
        .net_idx = params->net_idx,
    };
    memcpy(&send_msg.state, params->state, sizeof(send_msg.state));
 
    err = meshx_txcm_request_send(
        req_type,
        send_msg.addr,
        &send_msg,
        sizeof(send_msg),
        (meshx_txcm_fn_model_send_t) &meshx_gen_client_txcm_fn_model_send
    );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to send message: %p", (meshx_ptr_t) err);
    }
    return err;
}

Here is the call graph for this function:

meshx_gen_client_from_ble_reg_cb()

meshx_err_t meshx_gen_client_from_ble_reg_cb	(	uint32_t	model_id,
		meshx_gen_client_cb_t	cb )

Registers a callback function for a specific generic server model.

This function associates a callback with the given model ID, allowing the server to handle events or messages related to that model.

Parameters

[in]	model_id	The unique identifier of the generic server model.
[in]	cb	The callback function to be registered for the model.

Returns

meshx_err_t Returns an error code indicating the result of the registration. Possible values include success or specific error codes.

Definition at line 475 of file meshx_gen_client.c.

{
    if (!cb || meshx_is_gen_cli_model(model_id) != MESHX_SUCCESS)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    meshx_gen_cli_cb_reg_t reg = { .model_id = (uint16_t)model_id, .cb = cb };
 
    err = meshx_gen_cli_cb_reg_add(reg);
    if (err != MESHX_SUCCESS)
    {
        return err;
    }
 
    return control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        model_id,
        (control_task_msg_handle_t) &meshx_handle_gen_onoff_msg
    );
}

Here is the call graph for this function:

meshx_gen_client_init()

meshx_err_t meshx_gen_client_init

(

void

)

Initialize the mesh fuction generic client.

Initialize the meshxuction generic client.

This function sets up the necessary configurations and initializes the meshxuction generic client for the BLE mesh node.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failed to initialize the client

Definition at line 404 of file meshx_gen_client.c.

{
    if (g_meshx_client_control.client_init == MESHX_CLIENT_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
    g_meshx_client_control.client_init = MESHX_CLIENT_INIT_MAGIC_NO;
 
    meshx_err_t err = meshx_txcm_event_cb_reg((meshx_txcm_cb_t) &meshx_handle_txcm_msg);
    if(err != MESHX_SUCCESS)
        return err;
    return meshx_plat_gen_cli_init();
}

Here is the call graph for this function:

meshx_gen_client_txcm_fn_model_send()

static meshx_err_t meshx_gen_client_txcm_fn_model_send ( meshx_gen_client_msg_ctx_t * msg_param, size_t msg_param_len )

static

Transmit callback handler for sending Generic Client model messages.

This function processes the generic client message context and forwards it to the platform-specific BLE Mesh generic client send function for transmission. It validates the input parameters before invoking the core send function.

Parameters

[in]	msg_param	Pointer to the message context structure (meshx_gen_client_msg_ctx_t). Must not be NULL.
[in]	msg_param_len	Length of the message parameter data in bytes. Must equal sizeof(meshx_gen_client_msg_ctx_t).

Returns

• MESHX_SUCCESS: Message sent successfully.
• MESHX_INVALID_ARG: Invalid argument.
• MESHX_FAIL: Failed to send message.

Definition at line 216 of file meshx_gen_client.c.

{
    if(msg_param == NULL || msg_param_len != sizeof(meshx_gen_client_msg_ctx_t))
    {
        return MESHX_INVALID_ARG;
    }
 
    return meshx_plat_gen_cli_send_msg(
        msg_param->model,
        &msg_param->state,
        msg_param->opcode,
        msg_param->addr,
        msg_param->net_idx,
        msg_param->app_idx,
        (meshx_is_gen_cli_get_opcode(msg_param->opcode) == MESHX_SUCCESS)
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_handle_gen_onoff_msg()

static meshx_err_t meshx_handle_gen_onoff_msg ( dev_struct_t * pdev, control_task_msg_evt_t model_id, meshx_gen_cli_cb_param_t * param )

static

Handle the Generic OnOff Client messages.

This function processes the incoming messages for the Generic OnOff Client and performs the necessary actions based on the message event and parameters.

Parameters

[in]	pdev	Pointer to the device structure containing device-specific information.
[in]	model_id	The model ID of the received message.
[in]	param	Pointer to the Generic Client callback parameter structure.

Returns

MESHX_SUCCESS on success, or an error code on failure.

Definition at line 335 of file meshx_gen_client.c.

{
    if(!param || !pdev)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid parameters");
        return MESHX_INVALID_ARG;
    }
    meshx_gen_cli_cb_reg_t const * reg_cb = NULL;
    meshx_err_t err = MESHX_SUCCESS;
 
    meshx_gen_cli_cb_reg_node_t *node = g_meshx_client_control.cli_cb_reg_head;
 
    while (node)
    {
        if (model_id == node->reg.model_id)
        {
            MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "op|src|dst:%04" PRIx32 "|%04x|%04x",
                       param->ctx.opcode, param->ctx.src_addr, param->ctx.dst_addr);
            reg_cb = &node->reg;
            if (param->evt == MESHX_GEN_CLI_TIMEOUT || param->err_code != MESHX_SUCCESS)
            {
                MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "Retrying to send the message");
                err = meshx_gen_cli_handle_resend((uint16_t)model_id, param);
                if(err != MESHX_SUCCESS)
                {
                    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Resend failed: %d", err);
                }
                else
                {
                    /* As the retry would callback shall be triggered by the TXCM */
                    MESHX_DO_NOTHING;
                }
            }
            else
            {
                /* We need to notify if the ack is from the same source as that of dest */
                err = meshx_gen_cli_handle_ack(param->ctx.src_addr);
                if(err != MESHX_SUCCESS)
                {
                    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Ack failed: %d", err);
                }
                err = reg_cb->cb(pdev, model_id, param);
            }
        }
        node = node->next;
    }
 
    if(reg_cb == NULL)
    {
        return MESHX_SUCCESS;
    }
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_handle_txcm_msg()

static meshx_err_t meshx_handle_txcm_msg ( dev_struct_t * pdev, control_task_msg_evt_t evt, meshx_gen_cli_resend_ctx * param )

static

Handles a control task message for a generic client model.

This function processes a control task message received from the control task module for a generic client model. It is responsible for handling messages such as Tx Control Module signals, and is called by the control task module when a control task message is received.

Parameters

[in]	pdev	Pointer to the device structure associated with the BLE Mesh node.
[in]	evt	Control task message event type, which represents the model ID of the generic client model associated with the message.
[in]	param	Pointer to a structure containing the control task message parameters. Must not be NULL.

Returns

meshx_err_t Error code from the control task message handling. Returns MESHX_SUCCESS on successful handling.

Definition at line 250 of file meshx_gen_client.c.

{
    MESHX_UNUSED(evt);
    meshx_err_t err = MESHX_SUCCESS;
    meshx_gen_cli_cb_reg_t const * reg_cb = NULL;
    const meshx_gen_cli_cb_reg_node_t *node = g_meshx_client_control.cli_cb_reg_head;
 
    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "TXCM Timeout for model 0x%x", param->model_id);
 
    while (node)
    {
        if (param->model_id == node->reg.model_id)
        {
            reg_cb                  = &node->reg;
            param->param.err_code   = MESHX_TIMEOUT;
            param->param.evt        = MESHX_GEN_CLI_TIMEOUT;
            err = reg_cb->cb(pdev, param->model_id, &param->param);
        }
        node = node->next;
    }
 
    if(reg_cb == NULL)
    {
        return MESHX_SUCCESS;
    }
 
    return err;
}

Here is the caller graph for this function:

meshx_is_gen_cli_get_opcode()

static meshx_err_t meshx_is_gen_cli_get_opcode ( uint16_t opcode )

static

Checks if the given opcode corresponds to a GET request in the Generic Client group.

This function determines whether the provided opcode is part of the set of GET requests defined for the Generic Client group in the MeshX protocol.

Parameters

[in]

opcode

The opcode to check.

Returns

meshx_err_t Returns an error code indicating whether the opcode is a GET request in the Generic Client group.

Definition at line 113 of file meshx_gen_client.c.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_GEN_ONOFF_GET:
        case MESHX_MODEL_OP_GEN_LEVEL_GET:
        case MESHX_MODEL_OP_GEN_ONPOWERUP_GET:
        case MESHX_MODEL_OP_GEN_POWER_LEVEL_GET:
        case MESHX_MODEL_OP_GEN_BATTERY_GET:
        case MESHX_MODEL_OP_GEN_LOC_GLOBAL_GET:
        case MESHX_MODEL_OP_GEN_LOC_LOCAL_GET:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_USER_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_USER_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_CLIENT_PROPERTIES_GET:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

meshx_is_gen_cli_model()

static meshx_err_t meshx_is_gen_cli_model ( uint32_t model_id )

static

Checks if the given model ID corresponds to a Generic Client model.

This function determines whether the specified model ID is associated with a Generic Client model in the MeshX framework.

Parameters

[in]

model_id

The model ID to be checked.

Returns

meshx_err_t Returns an error code indicating whether the model ID is a Generic Client model.

Definition at line 145 of file meshx_gen_client.c.

{
    switch (model_id)
    {
        case MESHX_MODEL_ID_GEN_ONOFF_CLI:
        case MESHX_MODEL_ID_GEN_LEVEL_CLI:
        case MESHX_MODEL_ID_GEN_POWER_ONOFF_CLI:
        case MESHX_MODEL_ID_GEN_POWER_LEVEL_CLI:
        case MESHX_MODEL_ID_GEN_BATTERY_CLI:
        case MESHX_MODEL_ID_GEN_LOCATION_CLI:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

meshx_is_unack_opcode()

static meshx_err_t meshx_is_unack_opcode ( uint32_t opcode )

static

Checks if the given opcode corresponds to an unacknowledged (unack) message.

This function determines whether the provided opcode represents a SET_UNACK operation for various Generic models in the BLE Mesh specification. It returns success if the opcode matches one of the defined unacknowledged set opcodes.

Parameters

[in]

opcode

The mesh model opcode to check (uint32_t).

Returns

MESHX_SUCCESS if the opcode is a recognized unacknowledged set opcode (e.g., Generic OnOff Set Unack, Generic Level Set Unack, etc.).

MESHX_FAIL if the opcode does not match any unacknowledged set opcode.

Note

This utility function is used internally for handling reliable vs. non-reliable messaging in Generic Client models. Unacknowledged messages do not expect a response from the server.

Aligns with Bluetooth SIG Mesh Generic models opcodes (e.g., 0x8201 for Generic OnOff Set Unacknowledged).

Definition at line 180 of file meshx_gen_client.c.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_GEN_ONOFF_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LEVEL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_ONPOWERUP_SET_UNACK:
        case MESHX_MODEL_OP_GEN_POWER_LEVEL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LOC_GLOBAL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LOC_LOCAL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTY_SET_UNACK:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTY_SET_UNACK:
        case MESHX_MODEL_OP_GEN_USER_PROPERTY_SET_UNACK:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

Variable Documentation

cli_cb_reg_head

meshx_gen_cli_cb_reg_node_t* cli_cb_reg_head

Pointer to the head of the linked list of registered callbacks.

Definition at line 80 of file meshx_gen_client.c.

client_init

uint16_t client_init

Flag indicating whether the mesh client has been initialized.

Definition at line 79 of file meshx_gen_client.c.

[struct]

struct { ... } g_meshx_client_control