tlv.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2023 Intel Corporation. All rights reserved.
 *
 * Author: Tomasz Leman <tomasz.m.leman@intel.com>
 */
 
#ifndef __SOF_TLV_H__
#define __SOF_TLV_H__
 
#include <stdint.h>
#include <string.h>
#include <sof/compiler_attributes.h>

struct sof_tlv {
    uint32_t type;
    uint32_t length;
    char value[];
} __packed __aligned(4);
 
struct sof_tl {
    uint32_t type;
    uint32_t max_length;
} __packed __aligned(4);

static inline struct sof_tlv *tlv_next(const struct sof_tlv *tlv)
{
    if (tlv->length % sizeof(uint32_t) != 0)
        return NULL;
 
    return (struct sof_tlv *)((char *)(tlv) + sizeof(*tlv) + tlv->length);
}

static inline void tlv_value_uint32_set(struct sof_tlv *tlv, uint32_t type, uint32_t value)
{
    tlv->type = type;
    tlv->length = sizeof(uint32_t);
    memcpy_s(tlv->value, tlv->length, &value, tlv->length);
}

static inline void tlv_value_set(struct sof_tlv *tlv, uint32_t type, uint32_t length, void *value)
{
    tlv->type = type;
    tlv->length = length;
    memcpy_s(tlv->value, length, value, length);
}

static inline void tlv_value_get(const void *data,
                 uint32_t size,
                 uint32_t type,
                 void **value,
                 uint32_t *length)
{
    const struct sof_tlv *tlv = (const struct sof_tlv *)data;
    const uint32_t end_addr = (uint32_t)data + size;
 
    while (tlv && (uint32_t)tlv < end_addr) {
        if (tlv->type == type) {
            *value = (void *)tlv->value;
            *length = tlv->length;
            break;
        }
 
        tlv = tlv_next(tlv);
    }
}

static inline void *tlv_value_ptr_get(struct sof_tlv *tlv, uint32_t type)
{
    if ((uintptr_t)tlv % sizeof(uint32_t) != 0)
        return NULL;
 
    if (tlv->type != type)
        return NULL;
 
    return (void *)tlv->value;
}
 
#endif /* __SOF_TLV_H__ */