tlv_internals.h

Go to the documentation of this file.

/*****************************************************************************
 *   (c) 2025 Ledger SAS.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *****************************************************************************/
 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
// ─────────────────────────────────────────────────────────────────────────────
// TLV X macros
// Not intended for library users
// ─────────────────────────────────────────────────────────────────────────────
 
#define __X_DEFINE_TLV__TAG_ASSIGN(value, name, callback, unicity) name = value,
 
#define __X_DEFINE_TLV__TAG_INDEX(value, name, callback, unicity) name##_INDEX,
 
#define __X_DEFINE_TLV__TAG_FLAG(value, name, callback, unicity) \
    name##_FLAG = ((TLV_flag_t) 1 << name##_INDEX),
 
#define __X_DEFINE_TLV__TAG_TO_FLAG_CASE(value, name, callback, unicity) \
    case name:                                                           \
        return name##_FLAG;
 
#define __X_DEFINE_TLV__TAG_CALLBACKS(value, name, callback, unicity) \
    {.tag       = name,                                               \
     .func      = (tlv_handler_cb_t *) callback,                      \
     .is_unique = (unicity == ENFORCE_UNIQUE_TAG)},
 
// The generated TLV library will give the user a tag_to_flag function of the following type for
// his TLV use case
typedef uint32_t TLV_tag_t;
typedef uint64_t TLV_flag_t;
typedef TLV_flag_t(tag_to_flag_function_t)(TLV_tag_t tag);
 
// This structure is returned to the TLV parser caller and can be used in conjunction with the
// associated helper functions to get the status of received tags.
typedef struct {
    TLV_flag_t              flags;
    tag_to_flag_function_t *tag_to_flag_function;
} TLV_reception_internal_t;