net: lwm2m: add binaryappdatacontainer obj support

OMA LwM2M object 19 support for application specific binary data
Related issue #53340

Signed-off-by: romain pelletant <romainp@kickmaker.net>
This commit is contained in:
romain pelletant 2022-12-26 12:19:04 +01:00 committed by Carles Cufí
commit 5c14c56f2c
5 changed files with 156 additions and 0 deletions

View file

@ -48,6 +48,9 @@ zephyr_library_sources_ifdef(CONFIG_LWM2M_PORTFOLIO_OBJ_SUPPORT
zephyr_library_sources_ifdef(CONFIG_LWM2M_EVENT_LOG_OBJ_SUPPORT
lwm2m_obj_event_log.c
)
zephyr_library_sources_ifdef(CONFIG_LWM2M_BINARYAPPDATA_OBJ_SUPPORT
lwm2m_obj_binaryappdata.c
)
zephyr_library_sources_ifdef(CONFIG_LWM2M_ACCESS_CONTROL_ENABLE
lwm2m_obj_access_control.c
)

View file

@ -553,6 +553,11 @@ config LWM2M_EVENT_LOG_OBJ_SUPPORT
help
Include support for LWM2M Event Log Object (ID 20)
config LWM2M_BINARYAPPDATA_OBJ_SUPPORT
bool "LwM2M BinaryAppDataContainer Object (19)"
help
Include support for LWM2M BinaryAppDataContainer Object (ID 19)
if LWM2M_GATEWAY_OBJ_SUPPORT
config LWM2M_GATEWAY_MAX_INSTANCES

View file

@ -0,0 +1,125 @@
/**
* @file lwm2m_obj_binaryappdata.c
* @brief
*
* Copyright (c) 2022 Kickmaker
*
* SPDX-License-Identifier: Apache-2.0
*/
/*
* BinaryAppDataContainer
* https://raw.githubusercontent.com/OpenMobileAlliance/lwm2m-registry/prod/19.xml
*/
#define LOG_MODULE_NAME net_lwm2m_binaryappdata
#define LOG_LEVEL CONFIG_LWM2M_LOG_LEVEL
#include <zephyr/logging/log.h>
LOG_MODULE_REGISTER(LOG_MODULE_NAME);
#include <string.h>
#include <zephyr/init.h>
#include "lwm2m_object.h"
#include "lwm2m_engine.h"
#include "lwm2m_obj_binaryappdata.h"
#define BINARYAPPDATA_VERSION_MAJOR 1
#define BINARYAPPDATA_VERSION_MINOR 0
#define BINARYAPPDATA_MAX_ID 6
/* Support 2 instances of binary data in one object */
#define BINARYAPPDATA_DATA_INSTANCE_MAX 2
/* Support 2 multi instance object */
#define MAX_INSTANCE_COUNT 2
/*
* Calculate resource instances as follows:
* start with BINARYAPPDATA_MAX_ID
* subtract EXEC resources (0)
* add BINARYAPPDATA_DATA_INSTANCE_MAX resource instances
*/
#define RESOURCE_INSTANCE_COUNT (BINARYAPPDATA_MAX_ID - (0) + BINARYAPPDATA_DATA_INSTANCE_MAX)
static struct lwm2m_engine_obj lwm2m_binaryappdata;
static struct lwm2m_engine_obj_field fields[] = {
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_DATA_ID, RW, OPAQUE),
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_DATA_PRIORITY_ID, RW_OPT, U8),
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_DATA_CREATION_TIME_ID, RW_OPT, TIME),
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_DATA_DESCRIPTION_ID, RW_OPT, STRING),
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_DATA_FORMAT_ID, RW_OPT, STRING),
OBJ_FIELD_DATA(LWM2M_BINARYAPPDATA_APP_ID, RW_OPT, U16),
};
static struct lwm2m_engine_obj_inst inst[MAX_INSTANCE_COUNT];
static struct lwm2m_engine_res res[MAX_INSTANCE_COUNT][BINARYAPPDATA_MAX_ID];
static struct lwm2m_engine_res_inst res_inst[MAX_INSTANCE_COUNT][RESOURCE_INSTANCE_COUNT];
static struct lwm2m_engine_obj_inst *lwm2m_binaryappdata_create(uint16_t obj_inst_id)
{
int index, avail = -1, i = 0, j = 0;
/* Check that there is no other instance with this ID */
for (index = 0; index < ARRAY_SIZE(inst); index++) {
if (inst[index].obj && inst[index].obj_inst_id == obj_inst_id) {
LOG_ERR("Can not create instance - "
"already existing: %u",
obj_inst_id);
return NULL;
}
/* Save first available slot index */
if (avail < 0 && !inst[index].obj) {
avail = index;
}
}
if (avail < 0) {
LOG_ERR("Can not create instance - no more room: %u", obj_inst_id);
return NULL;
}
(void)memset(res[avail], 0, sizeof(res[avail][0]) * ARRAY_SIZE(res[avail]));
init_res_instance(res_inst[avail], ARRAY_SIZE(res_inst[avail]));
/* initialize instance resource data */
INIT_OBJ_RES_OPT(LWM2M_BINARYAPPDATA_DATA_ID, res[avail], i, res_inst[avail], j,
BINARYAPPDATA_DATA_INSTANCE_MAX, true, true, NULL, NULL, NULL, NULL, NULL);
INIT_OBJ_RES_OPTDATA(LWM2M_BINARYAPPDATA_DATA_PRIORITY_ID, res[avail], i,
res_inst[avail], j);
INIT_OBJ_RES_OPTDATA(LWM2M_BINARYAPPDATA_DATA_CREATION_TIME_ID, res[avail], i,
res_inst[avail], j);
INIT_OBJ_RES_OPTDATA(LWM2M_BINARYAPPDATA_DATA_DESCRIPTION_ID, res[avail], i,
res_inst[avail], j);
INIT_OBJ_RES_OPTDATA(LWM2M_BINARYAPPDATA_DATA_FORMAT_ID, res[avail], i, res_inst[avail], j);
INIT_OBJ_RES_OPTDATA(LWM2M_BINARYAPPDATA_APP_ID, res[avail], i, res_inst[avail], j);
inst[avail].resources = res[avail];
inst[avail].resource_count = i;
LOG_DBG("Created LWM2M binary app data container instance: %d", obj_inst_id);
return &inst[avail];
}
static int lwm2m_binaryappdata_init(const struct device *dev)
{
int ret = 0;
/* initialize the Event Log field data */
lwm2m_binaryappdata.obj_id = LWM2M_OBJECT_BINARYAPPDATACONTAINER_ID;
lwm2m_binaryappdata.version_major = BINARYAPPDATA_VERSION_MAJOR;
lwm2m_binaryappdata.version_minor = BINARYAPPDATA_VERSION_MINOR;
lwm2m_binaryappdata.is_core = false;
lwm2m_binaryappdata.fields = fields;
lwm2m_binaryappdata.field_count = ARRAY_SIZE(fields);
lwm2m_binaryappdata.max_instance_count = MAX_INSTANCE_COUNT;
lwm2m_binaryappdata.create_cb = lwm2m_binaryappdata_create;
lwm2m_register_obj(&lwm2m_binaryappdata);
return ret;
}
SYS_INIT(lwm2m_binaryappdata_init, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT);

View file

@ -0,0 +1,22 @@
/**
* @file lwm2m_obj_binaryappdata.h
* @brief
*
* Copyright (c) 2022 Kickmaker
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __LWM2M_OBJ_BINARYAPPDATA__
#define __LWM2M_OBJ_BINARYAPPDATA__
/* LwM2M BinaryAppDataContainer resource IDs */
/* clang-format off */
#define LWM2M_BINARYAPPDATA_DATA_ID 0
#define LWM2M_BINARYAPPDATA_DATA_PRIORITY_ID 1
#define LWM2M_BINARYAPPDATA_DATA_CREATION_TIME_ID 2
#define LWM2M_BINARYAPPDATA_DATA_DESCRIPTION_ID 3
#define LWM2M_BINARYAPPDATA_DATA_FORMAT_ID 4
#define LWM2M_BINARYAPPDATA_APP_ID 5
/* clang-format on */
#endif /* __LWM2M_OBJ_BINARYAPPDATA__ */