UMP Stream Responder

Respond to UMP Stream message Endpoint or Function Block discovery. More...

Data Structures
struct	ump_block_dt_spec
	UMP Function Block specification. More...
struct	ump_endpoint_dt_spec
	UMP endpoint specification. More...
struct	ump_stream_responder_cfg
	Configuration for the UMP Stream responder. More...

Macros
#define	UMP_STREAM_RESPONDER(_dev, _send, _ep_spec)
	Initialize a configuration for the UMP Stream responder.
#define	UMP_BLOCK_DT_SPEC_GET(_node)
	Get a Universal MIDI Packet endpoint function block from its device-tree representation.
#define	UMP_BLOCK_SEP_IF_OKAY(_node)
#define	UMP_ENDPOINT_DT_SPEC_GET(_node)
	Get a Universal MIDI Packet endpoint description from the device-tree representation of a midi2 device.

Typedefs
typedef void(*	ump_send_func) (const void *, const struct midi_ump)
	A function to send a UMP.

Functions
int	ump_stream_respond (const struct ump_stream_responder_cfg *cfg, const struct midi_ump pkt)
	Respond to an UMP Stream message.
const char *	ump_product_instance_id (void)

Detailed Description

Respond to UMP Stream message Endpoint or Function Block discovery.

Since

4.3

Version

0.1.0

See also

Universal MIDI Packet (UMP) Format and MIDI 2.0 Protocol 7.1: UMP Stream Messages

Macro Definition Documentation

UMP_BLOCK_DT_SPEC_GET

#define UMP_BLOCK_DT_SPEC_GET

(

_node

)

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Value:

{                                                                          \
        .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),                     \
}

Get a Universal MIDI Packet endpoint function block from its device-tree representation.

Parameters

_node

The device tree node representing the midi2 block

UMP_BLOCK_SEP_IF_OKAY

#define UMP_BLOCK_SEP_IF_OKAY

(

_node

)

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Value:

        COND_CODE_1(DT_NODE_HAS_STATUS_OKAY(_node),   \
                    (UMP_BLOCK_DT_SPEC_GET(_node),),       \
                    ())

UMP_ENDPOINT_DT_SPEC_GET

#define UMP_ENDPOINT_DT_SPEC_GET

(

_node

)

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Value:

{                                                                               \
        .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)},                \
}

Get a Universal MIDI Packet endpoint description from the device-tree representation of a midi2 device.

Parameters

_node

The device tree node representing a midi2 device

UMP_STREAM_RESPONDER

#define UMP_STREAM_RESPONDER	(		_dev,
			_send,
			_ep_spec )

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Value:

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

Initialize a configuration for the UMP Stream responder.

Parameters

_dev	The device to send reply packets
_send	The send function
_ep_spec	The UMP endpoint specification

Typedef Documentation

ump_send_func

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

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

A function to send a UMP.

Function Documentation

ump_product_instance_id()

const char * ump_product_instance_id

(

void

)

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Returns

The UMP Product Instance ID of this device, based on the device hwinfo if available, otherwise an empty string

ump_stream_respond()

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

#include </__w/zephyr/zephyr/lib/midi2/ump_stream_responder.h>

Respond to an UMP Stream message.

Parameters

[in]	cfg	The responder configuration
[in]	pkt	The message to respond to

Returns

The number of UMP packets sent as reply, or -errno in case of error