From 50e8757d79bbbf53b0c2fc7539af4e1918c5bdf5 Mon Sep 17 00:00:00 2001 From: Matthias Ringwald Date: Thu, 11 Jul 2024 17:42:03 +0200 Subject: [PATCH] Add TLV Builder for big endian data --- src/btstack_tlv_builder.c | 121 +++++++++++++++++++++++++++++++++ src/btstack_tlv_builder.h | 137 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 258 insertions(+) create mode 100644 src/btstack_tlv_builder.c create mode 100644 src/btstack_tlv_builder.h diff --git a/src/btstack_tlv_builder.c b/src/btstack_tlv_builder.c new file mode 100644 index 000000000..9eb0c0c08 --- /dev/null +++ b/src/btstack_tlv_builder.c @@ -0,0 +1,121 @@ +/* + * Copyright (C) 2024 BlueKitchen GmbH + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holders nor the names of + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * 4. Any redistribution, use, or modification is done solely for + * personal benefit and not for any commercial purpose or for + * monetary gain. + * + * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS + * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN + * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * Please inquire about commercial licensing options at + * contact@bluekitchen-gmbh.com + * + */ + +#define BTSTACK_FILE__ "btstack_tlv_builder.c" + +#include "btstack_tlv_builder.h" + +#include "btstack_bool.h" +#include "btstack_config.h" +#include "btstack_debug.h" +#include "btstack_util.h" + +#include +#include + +static void btstack_tlv_builder_increase_tag(btstack_tlv_builder_context_t * context, uint16_t size){ + btstack_assert((context->write_pos + size) < context->size); + context->write_pos += size; + btstack_assert((((uint16_t)context->buffer[context->len_pos]) + size) <= 255); + context->buffer[context->len_pos] += size; +} + +void btstack_tlv_builder_init(btstack_tlv_builder_context_t * context, uint8_t * buffer, uint16_t size){ + btstack_assert(buffer != NULL); + context->buffer = buffer; + context->size = size; + context->write_pos = 0; +} + +uint16_t btstack_tlv_builder_remaining_space(btstack_tlv_builder_context_t * context){ + return context->size - context->write_pos; +} + +uint16_t btstack_tlv_builder_get_length(btstack_tlv_builder_context_t * context){ + return context->write_pos; +} + +void btstack_tlv_builder_add_tag(btstack_tlv_builder_context_t * context, uint8_t tag){ + // update write pos + btstack_assert((context->write_pos + 2) < context->size); + // track len pos + context->buffer[context->write_pos++] = tag; + // add empty tag + context->len_pos = context->write_pos; + context->buffer[context->write_pos++] = 0; +} + +void btstack_tlv_builder_add_08(btstack_tlv_builder_context_t * context, uint8_t value){ + btstack_assert(context->write_pos != 0); + uint16_t write_pos = context->write_pos; + btstack_tlv_builder_increase_tag(context, 1); + context->buffer[write_pos] = value; +} + +void btstack_tlv_builder_add_big_endian_16(btstack_tlv_builder_context_t * context, uint16_t value) { + btstack_assert(context->write_pos != 0); + uint16_t write_pos = context->write_pos; + btstack_tlv_builder_increase_tag(context, 2); + big_endian_store_16(context->buffer, write_pos, value); +} + +void btstack_tlv_builder_add_big_endian_24(btstack_tlv_builder_context_t * context, uint32_t value) { + btstack_assert(context->write_pos != 0); + uint16_t write_pos = context->write_pos; + btstack_tlv_builder_increase_tag(context, 3); + big_endian_store_24(context->buffer, write_pos, value); +} + +void btstack_tlv_builder_add_big_endian_32(btstack_tlv_builder_context_t * context, uint32_t value) { + btstack_assert(context->write_pos != 0); + uint16_t write_pos = context->write_pos; + btstack_tlv_builder_increase_tag(context, 4); + big_endian_store_32(context->buffer, write_pos, value); +} + +void btstack_tlv_builder_add_bytes(btstack_tlv_builder_context_t * context, const uint8_t * data, uint16_t length) { + btstack_assert(context->write_pos != 0); + btstack_assert(data != NULL); + btstack_tlv_builder_increase_tag(context, length); + memcpy(&context->buffer[context->write_pos], data, length); + context->write_pos += length; +} + +void btstack_tlv_builder_add_string(btstack_tlv_builder_context_t * context, const char * text) { + uint16_t length = (uint16_t)strlen(text); + btstack_tlv_builder_add_bytes(context, (const uint8_t *) text, length); +} diff --git a/src/btstack_tlv_builder.h b/src/btstack_tlv_builder.h new file mode 100644 index 000000000..def93565e --- /dev/null +++ b/src/btstack_tlv_builder.h @@ -0,0 +1,137 @@ +/* + * Copyright (C) 2024 BlueKitchen GmbH + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holders nor the names of + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * 4. Any redistribution, use, or modification is done solely for + * personal benefit and not for any commercial purpose or for + * monetary gain. + * + * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS + * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN + * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * Please inquire about commercial licensing options at + * contact@bluekitchen-gmbh.com + * + */ + +/** + * @brief TODO + */ + +#ifndef BTSTACK_TLV_BUILDER_H +#define BTSTACK_TLV_BUILDER_H + +#include + +#if defined __cplusplus +extern "C" { +#endif + + +/* API_START */ + +typedef struct { + uint8_t * buffer; + uint16_t size; + uint16_t len_pos; + uint16_t write_pos; +} btstack_tlv_builder_context_t; + +/** + * @brief Initialize Length/Tag/Value builder with buffer and size for 8-bit tag and length fields + * + * @param context + * @param buffer + * @param size + */ +void btstack_ltv_builder_init(btstack_tlv_builder_context_t * context, uint8_t * buffer, uint16_t size); + +/** + * @brief Query remaining space in buffer + * + * @param context + * @return number of bytes that can be added + */ +uint16_t btstack_ltv_builder_remaining_space(btstack_tlv_builder_context_t * context); + +/** + * @brief Get constructed event length + * @param context + * @return number of bytes in event + */ +uint16_t btstack_ltv_builder_get_length(btstack_tlv_builder_context_t * context); + +/** + * @brief Add tag + * @param context + * @return number of bytes in event + */ +void btstack_ltv_builder_add_tag(btstack_tlv_builder_context_t * context, uint8_t tag); + +/** + * @bbrief Add uint8_t to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_08(btstack_tlv_builder_context_t * context, uint8_t value); + +/** + * @bbrief Add uint16_t value to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_bige_endian_16(btstack_tlv_builder_context_t * context, uint16_t value); + +/** + * @bbrief Add 24 bit from uint32_t byte to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_bige_endian_24(btstack_tlv_builder_context_t * context, uint32_t value); + +/** + * @bbrief Add uint32_t to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_bige_endian_32(btstack_tlv_builder_context_t * context, uint32_t value); + +/** + * @bbrief Add byte sequence to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_bytes(btstack_tlv_builder_context_t * context, const uint8_t * data, uint16_t length); + +/** + * @bbrief Add string to current tag + * @param context + * @param value + */ +void btstack_ltv_builder_add_string(btstack_tlv_builder_context_t * context, const char * text); + +#if defined __cplusplus +} +#endif +#endif // BTSTACK_TLV_BUILDER_H