patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

mgmt: mcumgr: improve custom payload types

Browse source 
Use a flag in `c:struct:mgmt_handler` to skip the cbor start and end byte,
and instead use pure custom user defined payload.

Signed-off-by: Kuno Heltborg <kunoh@live.dk>
This commit is contained in:
Kuno Heltborg 2023-08-09 08:15:22 +02:00 committed by Carles Cufí
parent cdd4bc6a48
commit 220a57b0b1
4 changed files with 77 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
include/zephyr/mgmt/mcumgr/mgmt/mgmt.h
View file

@ -67,6 +67,7 @@ typedef int (*mgmt_handler_fn)(struct smp_streamer *ctxt);
/**
* @brief Read handler and write handler for a single command ID.
* Set use_custom_payload to true when using a user defined payload type
*/
struct mgmt_handler {
mgmt_handler_fn mh_read;
@ -96,6 +97,11 @@ struct mgmt_group {
*/
smp_translate_error_fn mg_translate_error;
#endif
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
/** Should be true when using user defined payload */
bool custom_payload;
#endif
};
/**
@ -126,13 +132,24 @@ const struct mgmt_handler *mgmt_find_handler(uint16_t group_id, uint16_t command
/**
* @brief Finds a registered command group.
*
* @param group_id The command group id to find.
* @param group_id The group id of the command group to find.
*
* @return The requested command group on success;
* @return The requested group on success;
* NULL on failure.
*/
const struct mgmt_group *mgmt_find_group(uint16_t group_id);
/**
* @brief Finds a registered command handler.
*
* @param group The group of the command to find.
* @param command_id The ID of the command to find.
*
* @return The requested command handler on success;
* NULL on failure.
*/
const struct mgmt_handler *mgmt_get_handler(const struct mgmt_group *group, uint16_t command_id);
#if IS_ENABLED(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)
/**
* @brief Finds a registered error translation function for converting from SMP

7
subsys/mgmt/mcumgr/mgmt/Kconfig
View file

@ -31,3 +31,10 @@ config MCUMGR_MGMT_HANDLER_USER_DATA
help
This will add an extra field to the struct mgmt_handler that will allow a user
to pass user_data when the defined handler is called.
config MCUMGR_MGMT_CUSTOM_PAYLOAD
bool "MCUmgr custom payload"
help
When this config is enabled, a user can use the field `custom_payload` in `mgmt_handler` to
skip the generation of the cbor start- and end byte in `smp_handle_single_payload` and
instead use a user defined payload in SMP messages.

23
subsys/mgmt/mcumgr/mgmt/src/mgmt.c
View file

@ -72,24 +72,35 @@ mgmt_find_handler(uint16_t group_id, uint16_t command_id)
const struct mgmt_group *
mgmt_find_group(uint16_t group_id)
{
struct mgmt_group *group = NULL;
sys_snode_t *snp, *sns;
/*
* Find the group with the specified group id
* from the registered group list, if one exists
* return the matching mgmt group pointer, otherwise return NULL
*/
SYS_SLIST_FOR_EACH_NODE_SAFE(&mgmt_group_list, snp, sns) {
struct mgmt_group *loop_group =
CONTAINER_OF(snp, struct mgmt_group, node);
if (loop_group->mg_group_id == group_id) {
group = loop_group;
break;
return loop_group;
}
}
return group;
return NULL;
}
const struct mgmt_handler *
mgmt_get_handler(const struct mgmt_group *group, uint16_t command_id)
{
if (command_id >= group->mg_handlers_count) {
return NULL;
}
if (!group->mg_handlers[command_id].mh_read &&
!group->mg_handlers[command_id].mh_write) {
return NULL;
}
return &group->mg_handlers[command_id];
}
#if IS_ENABLED(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)

51
subsys/mgmt/mcumgr/smp/src/smp.c
View file

@ -156,9 +156,9 @@ static int smp_build_err_rsp(struct smp_streamer *streamer, const struct smp_hdr
*
* @return A MGMT_ERR_[...] error code.
*/
static int smp_handle_single_payload(struct smp_streamer *cbuf, const struct smp_hdr *req_hdr,
bool *handler_found)
static int smp_handle_single_payload(struct smp_streamer *cbuf, const struct smp_hdr *req_hdr)
{
const struct mgmt_group *group;
const struct mgmt_handler *handler;
mgmt_handler_fn handler_fn;
int rc;
@ -169,7 +169,12 @@ static int smp_handle_single_payload(struct smp_streamer *cbuf, const struct smp
uint16_t err_group;
#endif
handler = mgmt_find_handler(req_hdr->nh_group, req_hdr->nh_id);
group = mgmt_find_group(req_hdr->nh_group);
if (group == NULL) {
return MGMT_ERR_ENOTSUP;
}
handler = mgmt_get_handler(group, req_hdr->nh_id);
if (handler == NULL) {
return MGMT_ERR_ENOTSUP;
}
@ -190,15 +195,20 @@ static int smp_handle_single_payload(struct smp_streamer *cbuf, const struct smp
if (handler_fn) {
bool ok;
*handler_found = true;
ok = zcbor_map_start_encode(cbuf->writer->zs,
CONFIG_MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES);
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
if (!group->custom_payload) {
#endif
ok = zcbor_map_start_encode(cbuf->writer->zs,
CONFIG_MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES);
MGMT_CTXT_SET_RC_RSN(cbuf, NULL);
MGMT_CTXT_SET_RC_RSN(cbuf, NULL);
if (!ok) {
return MGMT_ERR_EMSGSIZE;
if (!ok) {
return MGMT_ERR_EMSGSIZE;
}
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
}
#endif
#if defined(CONFIG_MCUMGR_SMP_COMMAND_STATUS_HOOKS)
cmd_recv.group = req_hdr->nh_group;
@ -231,12 +241,18 @@ static int smp_handle_single_payload(struct smp_streamer *cbuf, const struct smp
#if defined(CONFIG_MCUMGR_SMP_COMMAND_STATUS_HOOKS)
end:
#endif
/* End response payload. */
if (!zcbor_map_end_encode(cbuf->writer->zs,
CONFIG_MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES) &&
rc == 0) {
rc = MGMT_ERR_EMSGSIZE;
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
if (!group->custom_payload) {
#endif
/* End response payload. */
if (!zcbor_map_end_encode(cbuf->writer->zs,
CONFIG_MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES) &&
rc == 0) {
rc = MGMT_ERR_EMSGSIZE;
}
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
}
#endif
} else {
rc = MGMT_ERR_ENOTSUP;
}
@ -256,7 +272,7 @@ end:
* @return A MGMT_ERR_[...] error code.
*/
static int smp_handle_single_req(struct smp_streamer *streamer, const struct smp_hdr *req_hdr,
bool *handler_found, const char **rsn)
const char **rsn)
{
struct smp_hdr rsp_hdr;
struct cbor_nb_writer *nbw = streamer->writer;
@ -279,7 +295,7 @@ static int smp_handle_single_req(struct smp_streamer *streamer, const struct smp
}
/* Process the request and write the response payload. */
rc = smp_handle_single_payload(streamer, req_hdr, handler_found);
rc = smp_handle_single_payload(streamer, req_hdr);
if (rc != 0) {
*rsn = MGMT_CTXT_RC_RSN(streamer);
return rc;
@ -411,7 +427,8 @@ int smp_process_request_packet(struct smp_streamer *streamer, void *vreq)
cbor_nb_writer_init(streamer->writer, rsp);
/* Process the request payload and build the response. */
rc = smp_handle_single_req(streamer, &req_hdr, &handler_found, &rsn);
rc = smp_handle_single_req(streamer, &req_hdr, &rsn);
handler_found = (rc != MGMT_ERR_ENOTSUP);
if (rc != 0) {
break;
}