ump_stream_responder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Titouan Christophe
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_LIB_MIDI2_UMP_STREAM_RESPONDER_H_
#define ZEPHYR_LIB_MIDI2_UMP_STREAM_RESPONDER_H_

 
#include <zephyr/kernel.h>
#include <zephyr/audio/midi.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct ump_block_dt_spec {
        const char *name;
        uint8_t first_group;
        uint8_t groups_spanned;
        bool is_input;
        bool is_output;
        bool is_midi1;
        bool is_31250bps;
};

struct ump_endpoint_dt_spec {
        const char *name;
        size_t n_blocks;
        struct ump_block_dt_spec blocks[];
};

typedef void (*ump_send_func)(const void *, const struct midi_ump);

#define UMP_STREAM_RESPONDER(_dev, _send, _ep_spec)                             \
        {                                                                       \
                .dev = _dev,                                                    \
                .send = (ump_send_func) _send,  \
                .ep_spec = _ep_spec,                                            \
        }

struct ump_stream_responder_cfg {
        const void *dev;
        ump_send_func send;
        const struct ump_endpoint_dt_spec *ep_spec;
};

#define UMP_BLOCK_DT_SPEC_GET(_node)                                       \
{                                                                          \
        .name = DT_PROP_OR(_node, label, NULL),                            \
        .first_group = DT_REG_ADDR(_node),                                 \
        .groups_spanned = DT_REG_SIZE(_node),                              \
        .is_input = !DT_ENUM_HAS_VALUE(_node, terminal_type, output_only), \
        .is_output = !DT_ENUM_HAS_VALUE(_node, terminal_type, input_only), \
        .is_midi1 = !DT_ENUM_HAS_VALUE(_node, protocol, midi2),            \
        .is_31250bps = DT_PROP(_node, serial_31250bps),                    \
}
 
#define UMP_BLOCK_SEP_IF_OKAY(_node)                    \
        COND_CODE_1(DT_NODE_HAS_STATUS_OKAY(_node),     \
                    (UMP_BLOCK_DT_SPEC_GET(_node),),    \
                    ())

#define UMP_ENDPOINT_DT_SPEC_GET(_node)                                         \
{                                                                               \
        .name = DT_PROP_OR(_node, label, NULL),                                 \
        .n_blocks = DT_FOREACH_CHILD_SEP(_node, DT_NODE_HAS_STATUS_OKAY, (+)),  \
        .blocks = {DT_FOREACH_CHILD(_node, UMP_BLOCK_SEP_IF_OKAY)},             \
}

int ump_stream_respond(const struct ump_stream_responder_cfg *cfg,
                       const struct midi_ump pkt);

const char *ump_product_instance_id(void);

 
#ifdef __cplusplus
}
#endif
 
#endif