uuid.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2020 Intel Corporation. All rights reserved.
 *
 * Author: Marcin Maka <marcin.maka@linux.intel.com>
 */
 
#ifndef __SOF_LIB_UUID_H__
#define __SOF_LIB_UUID_H__
 
#include <sof/common.h>
#include <uuid-registry.h>
 
#ifdef __ZEPHYR__
#include <zephyr/sys/iterable_sections.h>
#endif
 
#include <stdint.h>


#define UUID_SIZE 16

#define UUID_NAME_MAX_LEN 32

struct sof_uuid {
    uint32_t a;
    uint16_t b;
    uint16_t c;
    uint8_t  d[8];
} __packed;
 
#define _UUID_INIT(va, vb, vc, d0, d1, d2, d3, d4, d5, d6, d7) \
    { va, vb, vc, { d0, d1, d2, d3, d4, d5, d6, d7 } }

struct sof_uuid_entry {
    struct sof_uuid id;
    const char name[UUID_NAME_MAX_LEN];
};
 
#ifdef __ZEPHYR__
/* Zephyr puts all the UUID structs into the firmware .rodata as an
 * ITERABLE array.  Note the alias emitted to get the typing correct,
 * Zephyr defines the full suf_uuid_entry struct, where the API
 * demands that the symbol name refer to a struct sof_uuid.
 */
#define _UUID(uuid_name)    (&_##uuid_name)
#define _RT_UUID(uuid_name) (&uuid_name)
#define _DEF_UUID(entity_name, uuid_name, initializer)          \
    const STRUCT_SECTION_ITERABLE(sof_uuid_entry, _##uuid_name) =   \
        { .id = initializer, .name = entity_name };     \
    extern const struct sof_uuid                    \
        __attribute__((alias("_" #uuid_name))) uuid_name
 
#else
/* XTOS SOF emits two definitions, one into the runtime (which may not
 * be linked if unreferenced) and a separate one that goes into a
 * special section via handling in the linker script.
 */
#define _UUID(uuid_name)    (&(uuid_name ## _ldc))
#define _RT_UUID(uuid_name) (&(uuid_name))
#define _DEF_UUID(entity_name, uuid_name, initializer)      \
    __section(".static_uuids")              \
    static const struct sof_uuid_entry uuid_name ## _ldc    \
        = { .id = initializer, .name = entity_name };   \
    const struct sof_uuid uuid_name = initializer
 
#endif /* __ZEPHYR__ */

#define SOF_DEFINE_UUID(entity_name, uuid_name, va, vb, vc, \
            vd0, vd1, vd2, vd3, vd4, vd5, vd6, vd7) \
    _DEF_UUID(entity_name, uuid_name,           \
          _UUID_INIT(va, vb, vc, vd0, vd1, vd2, vd3, vd4, vd5, vd6, vd7))

#define SOF_REG_UUID(name) _UUIDREG_##name

#define SOF_DEFINE_REG_UUID(name) _DEF_UUID(#name, name##_uuid, SOF_REG_UUID(name))

#define SOF_UUID(uuid_name) _UUID(uuid_name)

#define SOF_RT_UUID(uuid_name) _RT_UUID(uuid_name)

 
#endif /* __SOF_LIB_UUID_H__ */