diff mbox series

[alsa-lib,2/3] ump: Add UMP 1.1 features

Message ID 20230612081948.18346-3-tiwai@suse.de
State New
Headers show
Series ALSA-lib updates for UMP 1.1 | expand

Commit Message

Takashi Iwai June 12, 2023, 8:19 a.m. UTC
Add a few new features for UMP 1.1:
- New attributes in UMP Endpoint and Block info
- Static block bit flag for EP info

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 include/ump.h     | 22 +++++++++++++++
 include/ump_msg.h | 67 +++++++++++++++++++++++++++++++++++++++++++++
 src/rawmidi/ump.c | 70 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 159 insertions(+)
diff mbox series

Patch

diff --git a/include/ump.h b/include/ump.h
index c79b2335aeff..1e5e053454b3 100644
--- a/include/ump.h
+++ b/include/ump.h
@@ -53,6 +53,9 @@  enum _snd_ump_direction {
 	SND_UMP_DIR_BIDIRECTION	=	0x03,
 };
 
+/** UMP EP holds only static blocks */
+#define SND_UMP_EP_INFO_STATIC_BLOCKS		0x01
+
 /** Bitmask for UMP EP MIDI protocols */
 #define SND_UMP_EP_INFO_PROTO_MIDI_MASK		0x0300
 /** Bit flag for MIDI 1.0 protocol */
@@ -82,6 +85,10 @@  unsigned int snd_ump_endpoint_info_get_protocol_caps(const snd_ump_endpoint_info
 unsigned int snd_ump_endpoint_info_get_protocol(const snd_ump_endpoint_info_t *info);
 unsigned int snd_ump_endpoint_info_get_num_blocks(const snd_ump_endpoint_info_t *info);
 unsigned int snd_ump_endpoint_info_get_version(const snd_ump_endpoint_info_t *info);
+unsigned int snd_ump_endpoint_info_get_manufacturer_id(const snd_ump_endpoint_info_t *info);
+unsigned int snd_ump_endpoint_info_get_family_id(const snd_ump_endpoint_info_t *info);
+unsigned int snd_ump_endpoint_info_get_model_id(const snd_ump_endpoint_info_t *info);
+const unsigned char *snd_ump_endpoint_info_get_sw_revision(const snd_ump_endpoint_info_t *info);
 const char *snd_ump_endpoint_info_get_name(const snd_ump_endpoint_info_t *info);
 const char *snd_ump_endpoint_info_get_product_id(const snd_ump_endpoint_info_t *info);
 int snd_ump_endpoint_info(snd_ump_t *ump, snd_ump_endpoint_info_t *info);
@@ -91,6 +98,18 @@  int snd_ump_endpoint_info(snd_ump_t *ump, snd_ump_endpoint_info_t *info);
 /** Bit flag for 31.25Kbps B/W MIDI1 port in UMP Block info flags */
 #define SND_UMP_BLOCK_IS_LOWSPEED	(1U << 1)
 
+/** UMP block user-interface hint */
+enum _snd_ump_block_ui_hint {
+	/** Unknown or undeclared */
+	SND_UMP_BLOCK_UI_HINT_UNKNOWN	=	0x00,
+	/** Primarily a receiver or a destination for MIDI messages */
+	SND_UMP_BLOCK_UI_HINT_RECEIVER =	0x01,
+	/** Primarily a sender or a source of MIDI messages */
+	SND_UMP_BLOCK_UI_HINT_SENDER =		0x02,
+	/** Both a sender and receiver of MIDI messages */
+	SND_UMP_BLOCK_UI_HINT_BOTH =		0x03,
+};
+
 size_t snd_ump_block_info_sizeof(void);
 /** \hideinitializer
  * \brief allocate an invalid #snd_ump_block_info_t using standard alloca
@@ -109,6 +128,9 @@  unsigned int snd_ump_block_info_get_flags(const snd_ump_block_info_t *info);
 unsigned int snd_ump_block_info_get_direction(const snd_ump_block_info_t *info);
 unsigned int snd_ump_block_info_get_first_group(const snd_ump_block_info_t *info);
 unsigned int snd_ump_block_info_get_num_groups(const snd_ump_block_info_t *info);
+unsigned int snd_ump_block_info_get_midi_ci_version(const snd_ump_block_info_t *info);
+unsigned int snd_ump_block_info_get_sysex8_streams(const snd_ump_block_info_t *info);
+unsigned int snd_ump_block_info_get_ui_hint(const snd_ump_block_info_t *info);
 const char *snd_ump_block_info_get_name(const snd_ump_block_info_t *info);
 int snd_ump_block_info(snd_ump_t *ump, snd_ump_block_info_t *info);
 
diff --git a/include/ump_msg.h b/include/ump_msg.h
index 4ccce546f8d5..e0264f6ecd00 100644
--- a/include/ump_msg.h
+++ b/include/ump_msg.h
@@ -453,11 +453,14 @@  typedef union _snd_ump_msg_midi2 {
  * UMP message type
  */
 enum {
+	SND_UMP_MSG_TYPE_UTILITY		= 0x00,	/* Utility messages */
 	SND_UMP_MSG_TYPE_SYSTEM			= 0x01,	/* System messages */
 	SND_UMP_MSG_TYPE_MIDI1_CHANNEL_VOICE	= 0x02,	/* MIDI 1.0 messages */
 	SND_UMP_MSG_TYPE_DATA			= 0x03,	/* 7bit SysEx messages */
 	SND_UMP_MSG_TYPE_MIDI2_CHANNEL_VOICE	= 0x04,	/* MIDI 2.0 messages */
 	SND_UMP_MSG_TYPE_EXTENDED_DATA		= 0x05,	/* 8bit data message */
+	SND_UMP_MSG_TYPE_FLEX_DATA		= 0x0d,	/* Flexible data messages */
+	SND_UMP_MSG_TYPE_STREAM			= 0x0f,	/* Stream messages */
 };
 
 /**
@@ -508,6 +511,62 @@  enum {
 	SND_UMP_SYSEX_STATUS_END	= 3,
 };
 
+/** UMP Utility Type Status (type 0x0) **/
+enum {
+	SND_UMP_UTILITY_MSG_STATUS_NOOP		= 0x00,
+	SND_UMP_UTILITY_MSG_STATUS_JR_CLOCK	= 0x01,
+	SND_UMP_UTILITY_MSG_STATUS_JR_TSTAMP	= 0x02,
+	SND_UMP_UTILITY_MSG_STATUS_DCTPQ	= 0x03,
+	SND_UMP_UTILITY_MSG_STATUS_DC		= 0x04,
+};
+
+/** UMP Stream Message Status (type 0xf) */
+enum {
+	SND_UMP_STREAM_MSG_STATUS_EP_DISCOVERY	= 0x00,
+	SND_UMP_STREAM_MSG_STATUS_EP_INFO	= 0x01,
+	SND_UMP_STREAM_MSG_STATUS_DEVICE_INFO	= 0x02,
+	SND_UMP_STREAM_MSG_STATUS_EP_NAME	= 0x03,
+	SND_UMP_STREAM_MSG_STATUS_PRODUCT_ID	= 0x04,
+	SND_UMP_STREAM_MSG_STATUS_STREAM_CFG_REQUEST = 0x05,
+	SND_UMP_STREAM_MSG_STATUS_STREAM_CFG	= 0x06,
+	SND_UMP_STREAM_MSG_STATUS_FB_DISCOVERY	= 0x10,
+	SND_UMP_STREAM_MSG_STATUS_FB_INFO	= 0x11,
+	SND_UMP_STREAM_MSG_STATUS_FB_NAME	= 0x12,
+	SND_UMP_STREAM_MSG_STATUS_START_CLIP	= 0x20,
+	SND_UMP_STREAM_MSG_STATUS_END_CLIP	= 0x21,
+};
+
+/** UMP Endpoint Discovery filter bitmap */
+enum {
+	SND_UMP_STREAM_MSG_REQUEST_EP_INFO	= (1U << 0),
+	SND_UMP_STREAM_MSG_REQUEST_DEVICE_INFO	= (1U << 1),
+	SND_UMP_STREAM_MSG_REQUEST_EP_NAME	= (1U << 2),
+	SND_UMP_STREAM_MSG_REQUEST_PRODUCT_ID	= (1U << 3),
+	SND_UMP_STREAM_MSG_REQUEST_STREAM_CFG	= (1U << 4),
+};
+
+/** UMP Function Block Discovery filter bitmap */
+enum {
+	SND_UMP_STREAM_MSG_REQUEST_FB_INFO	= (1U << 0),
+	SND_UMP_STREAM_MSG_REQUEST_FB_NAME	= (1U << 1),
+};
+
+/** UMP Endpoint Info capability bits (used for protocol request/notify, too) */
+enum {
+	SND_UMP_STREAM_MSG_EP_INFO_CAP_TXJR	= (1U << 0), /* Sending JRTS */
+	SND_UMP_STREAM_MSG_EP_INFO_CAP_RXJR	= (1U << 1), /* Receiving JRTS */
+	SND_UMP_STREAM_MSG_EP_INFO_CAP_MIDI1	= (1U << 8), /* MIDI 1.0 */
+	SND_UMP_STREAM_MSG_EP_INFO_CAP_MIDI2	= (1U << 9), /* MIDI 2.0 */
+};
+
+/** UMP Endpoint / Function Block name string format bits */
+enum {
+	SND_UMP_STREAM_MSG_FORMAT_SINGLE	= 0,
+	SND_UMP_STREAM_MSG_FORMAT_START		= 1,
+	SND_UMP_STREAM_MSG_FORMAT_CONTINUE	= 2,
+	SND_UMP_STREAM_MSG_FORMAT_END		= 3,
+};
+
 /**
  * \brief get UMP status (4bit) from 32bit UMP message header
  */
@@ -532,6 +591,14 @@  static inline uint8_t snd_ump_msg_hdr_type(uint32_t ump)
 	return (ump >> 28);
 }
 
+/**
+ * \brief check if the given UMP type is a groupless message
+ */
+static inline int snd_ump_msg_type_is_groupless(uint8_t type)
+{
+	return type == SND_UMP_MSG_TYPE_UTILITY || type == SND_UMP_MSG_TYPE_STREAM;
+}
+
 /**
  * \brief get UMP group (4bit) from 32bit UMP message header
  */
diff --git a/src/rawmidi/ump.c b/src/rawmidi/ump.c
index 2482884f2661..80fa514003a7 100644
--- a/src/rawmidi/ump.c
+++ b/src/rawmidi/ump.c
@@ -422,6 +422,46 @@  unsigned int snd_ump_endpoint_info_get_version(const snd_ump_endpoint_info_t *in
 	return info->version;
 }
 
+/**
+ * \brief get UMP manufacturer ID
+ * \param info pointer to a snd_ump_endpoint_info_t structure
+ * \return UMP manufacturer ID
+ */
+unsigned int snd_ump_endpoint_info_get_manufacturer_id(const snd_ump_endpoint_info_t *info)
+{
+	return info->manufacturer_id;
+}
+
+/**
+ * \brief get UMP family ID
+ * \param info pointer to a snd_ump_endpoint_info_t structure
+ * \return UMP family ID
+ */
+unsigned int snd_ump_endpoint_info_get_family_id(const snd_ump_endpoint_info_t *info)
+{
+	return info->family_id;
+}
+
+/**
+ * \brief get UMP model ID
+ * \param info pointer to a snd_ump_endpoint_info_t structure
+ * \return UMP model ID
+ */
+unsigned int snd_ump_endpoint_info_get_model_id(const snd_ump_endpoint_info_t *info)
+{
+	return info->model_id;
+}
+
+/**
+ * \brief get UMP software revision
+ * \param info pointer to a snd_ump_endpoint_info_t structure
+ * \return UMP software revision
+ */
+const unsigned char *snd_ump_endpoint_info_get_sw_revision(const snd_ump_endpoint_info_t *info)
+{
+	return info->sw_revision;
+}
+
 /**
  * \brief get UMP endpoint name string
  * \param info pointer to a snd_ump_endpoint_info_t structure
@@ -592,6 +632,36 @@  unsigned int snd_ump_block_info_get_num_groups(const snd_ump_block_info_t *info)
 	return info->num_groups;
 }
 
+/**
+ * \brief get MIDI-CI version number
+ * \param info pointer to a snd_ump_block_info_t structure
+ * \return MIDI-CI version number
+ */
+unsigned int snd_ump_block_info_get_midi_ci_version(const snd_ump_block_info_t *info)
+{
+	return info->midi_ci_version;
+}
+
+/**
+ * \brief get number of supported SysEx8 streams
+ * \param info pointer to a snd_ump_block_info_t structure
+ * \return number of supported SysEx8 streams
+ */
+unsigned int snd_ump_block_info_get_sysex8_streams(const snd_ump_block_info_t *info)
+{
+	return info->sysex8_streams;
+}
+
+/**
+ * \brief get UI hint of the given UMP block
+ * \param info pointer to a snd_ump_block_info_t structure
+ * \return the hint bits
+ */
+unsigned int snd_ump_block_info_get_ui_hint(const snd_ump_block_info_t *info)
+{
+	return info->ui_hint;
+}
+
 /**
  * \brief get the name string of UMP block
  * \param info pointer to a snd_ump_block_info_t structure