[PATCH alsa-lib 0/3] ALSA-lib updates for UMP 1.1

[PATCH alsa-lib 0/3] ALSA-lib updates for UMP 1.1

[Takashi Iwai]

Hi,

this is a patch set for updating alsa-lib to catch up the changes for
MIDI 2.0 UMP v1.1 features.  The basic functionality remains, while
the uapi header is updated a few API functions for the new features
are added.


Takashi

===

Takashi Iwai (3):
  uapi: Update rawmidi API to 2.0.4
  ump: Add UMP 1.1 features
  seq: Add UMP 1.1 features

 include/seq.h                   |  3 ++
 include/sound/uapi/asequencer.h |  5 ++-
 include/sound/uapi/asound.h     | 21 ++++++++--
 include/ump.h                   | 22 +++++++++++
 include/ump_msg.h               | 67 +++++++++++++++++++++++++++++++
 src/Versions.in                 |  2 +
 src/rawmidi/ump.c               | 70 +++++++++++++++++++++++++++++++++
 src/seq/seq.c                   | 32 +++++++++++++++
 8 files changed, 218 insertions(+), 4 deletions(-)

-- 
2.35.3

[PATCH alsa-lib 1/3] uapi: Update rawmidi API to 2.0.4

[Takashi Iwai]

Sync with the kernel change of rawmidi API for supporting UMP 1.1
features.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 include/sound/uapi/asound.h | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/include/sound/uapi/asound.h b/include/sound/uapi/asound.h
index 80cd57e968e5..32095ef79cab 100644
--- a/include/sound/uapi/asound.h
+++ b/include/sound/uapi/asound.h
@@ -706,7 +706,7 @@ enum {
  *  Raw MIDI section - /dev/snd/midi??
  */
 
-#define SNDRV_RAWMIDI_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 3)
+#define SNDRV_RAWMIDI_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 4)
 
 enum {
 	SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
@@ -776,6 +776,9 @@ struct snd_rawmidi_status {
 	unsigned char reserved[16];	/* reserved for future use */
 };
 
+/* UMP EP info flags */
+#define SNDRV_UMP_EP_INFO_STATIC_BLOCKS		0x01
+
 /* UMP EP Protocol / JRTS capability bits */
 #define SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK	0x0300
 #define SNDRV_UMP_EP_INFO_PROTO_MIDI1		0x0100 /* MIDI 1.0 */
@@ -793,7 +796,11 @@ struct snd_ump_endpoint_info {
 	unsigned int protocol;		/* current protocol */
 	unsigned int num_blocks;	/* # of function blocks */
 	unsigned short version;		/* UMP major/minor version */
-	unsigned short padding[7];
+	unsigned short family_id;	/* MIDI device family ID */
+	unsigned short model_id;	/* MIDI family model ID */
+	unsigned int manufacturer_id;	/* MIDI manufacturer ID */
+	unsigned char sw_revision[4];	/* software revision */
+	unsigned short padding;
 	unsigned char name[128];	/* endpoint name string */
 	unsigned char product_id[128];	/* unique product id string */
 	unsigned char reserved[32];
@@ -808,6 +815,12 @@ struct snd_ump_endpoint_info {
 #define SNDRV_UMP_BLOCK_IS_MIDI1	(1U << 0) /* MIDI 1.0 port w/o restrict */
 #define SNDRV_UMP_BLOCK_IS_LOWSPEED	(1U << 1) /* 31.25Kbps B/W MIDI1 port */
 
+/* UMP block user-interface hint */
+#define SNDRV_UMP_BLOCK_UI_HINT_UNKNOWN		0x00
+#define SNDRV_UMP_BLOCK_UI_HINT_RECEIVER	0x01
+#define SNDRV_UMP_BLOCK_UI_HINT_SENDER		0x02
+#define SNDRV_UMP_BLOCK_UI_HINT_BOTH		0x03
+
 /* UMP groups and blocks */
 #define SNDRV_UMP_MAX_GROUPS		16
 #define SNDRV_UMP_MAX_BLOCKS		32
@@ -821,7 +834,9 @@ struct snd_ump_block_info {
 	unsigned char active;		/* Activeness */
 	unsigned char first_group;	/* first group ID */
 	unsigned char num_groups;	/* number of groups */
-	unsigned char padding[3];
+	unsigned char midi_ci_version;	/* MIDI-CI support version */
+	unsigned char sysex8_streams;	/* max number of sysex8 streams */
+	unsigned char ui_hint;		/* user interface hint */
 	unsigned int flags;		/* various info flags */
 	unsigned char name[128];	/* block name string */
 	unsigned char reserved[32];
-- 
2.35.3

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

[Takashi Iwai]

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 --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
-- 
2.35.3

[PATCH alsa-lib 3/3] seq: Add UMP 1.1 features

[Takashi Iwai]

Add APIs for groupless message filtering.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 include/seq.h                   |  3 +++
 include/sound/uapi/asequencer.h |  5 ++++-
 src/Versions.in                 |  2 ++
 src/seq/seq.c                   | 32 ++++++++++++++++++++++++++++++++
 4 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/include/seq.h b/include/seq.h
index 7faf4367df3d..68934037cb88 100644
--- a/include/seq.h
+++ b/include/seq.h
@@ -159,6 +159,7 @@ int snd_seq_client_info_get_event_lost(const snd_seq_client_info_t *info);
 int snd_seq_client_info_get_midi_version(const snd_seq_client_info_t *info);
 int snd_seq_client_info_get_ump_group_enabled(const snd_seq_client_info_t *info,
 					      int group);
+int snd_seq_client_info_get_ump_groupless_enabled(const snd_seq_client_info_t *info);
 int snd_seq_client_info_get_ump_conversion(const snd_seq_client_info_t *info);
 void snd_seq_client_info_set_client(snd_seq_client_info_t *info, int client);
 void snd_seq_client_info_set_name(snd_seq_client_info_t *info, const char *name);
@@ -168,6 +169,8 @@ void snd_seq_client_info_set_event_filter(snd_seq_client_info_t *info, unsigned
 void snd_seq_client_info_set_midi_version(snd_seq_client_info_t *info, int midi_version);
 void snd_seq_client_info_set_ump_group_enabled(snd_seq_client_info_t *info,
 					       int group, int enable);
+void snd_seq_client_info_set_ump_groupless_enabled(snd_seq_client_info_t *info,
+						   int enable);
 void snd_seq_client_info_set_ump_conversion(snd_seq_client_info_t *info, int enable);
 
 void snd_seq_client_info_event_filter_clear(snd_seq_client_info_t *info);
diff --git a/include/sound/uapi/asequencer.h b/include/sound/uapi/asequencer.h
index 3653a3f33778..b913f31daa2d 100644
--- a/include/sound/uapi/asequencer.h
+++ b/include/sound/uapi/asequencer.h
@@ -378,7 +378,10 @@ struct snd_seq_client_info {
 	int card;			/* RO: card number[kernel] */
 	int pid;			/* RO: pid[user] */
 	unsigned int midi_version;	/* MIDI version */
-	unsigned int group_filter;	/* UMP group filter bitmap */
+	unsigned int group_filter;	/* UMP group filter bitmap
+					 * (bit 0 = groupless messages,
+					 *  bit 1-16 = messages for groups 1-16)
+					 */
 	char reserved[48];		/* for future use */
 };
 
diff --git a/src/Versions.in b/src/Versions.in
index 0c2837305039..c8ac1c8277a3 100644
--- a/src/Versions.in
+++ b/src/Versions.in
@@ -159,9 +159,11 @@ ALSA_1.2.10 {
     @SYMBOL_PREFIX@snd_seq_ump_*;
     @SYMBOL_PREFIX@snd_seq_client_info_get_midi_version;
     @SYMBOL_PREFIX@snd_seq_seq_client_info_get_ump_group_enabled;
+    @SYMBOL_PREFIX@snd_seq_client_info_get_ump_groupless_enabled;
     @SYMBOL_PREFIX@snd_seq_seq_client_get_ump_conversion;
     @SYMBOL_PREFIX@snd_seq_client_info_set_midi_version;
     @SYMBOL_PREFIX@snd_seq_seq_client_info_set_ump_group_enabled;
+    @SYMBOL_PREFIX@snd_seq_client_info_set_ump_groupless_enabled;
     @SYMBOL_PREFIX@snd_seq_seq_client_set_ump_conversion;
     @SYMBOL_PREFIX@snd_seq_get_ump_endpoint_info;
     @SYMBOL_PREFIX@snd_seq_get_ump_block_info;
diff --git a/src/seq/seq.c b/src/seq/seq.c
index 65ccaaed5896..9d3a18d3ea99 100644
--- a/src/seq/seq.c
+++ b/src/seq/seq.c
@@ -1763,6 +1763,21 @@ int snd_seq_client_info_get_ump_group_enabled(const snd_seq_client_info_t *info,
 	return !(info->group_filter & (1U << group));
 }
 
+#define UMP_GROUPLESS_FILTER	(1U << 0)
+
+/**
+ * \brief Get the UMP groupless message handling status
+ * \param info client_info container
+ * \return 1 if UMP groupless messages is processed, 0 if filtered/disabled
+ *
+ * \sa snd_seq_get_client_info()
+ */
+int snd_seq_client_info_get_ump_groupless_enabled(const snd_seq_client_info_t *info)
+{
+	assert(info);
+	return !(info->group_filter & UMP_GROUPLESS_FILTER);
+}
+
 /**
  * \brief Get the automatic conversion mode for UMP
  * \param info client_info container
@@ -1850,6 +1865,23 @@ void snd_seq_client_info_set_ump_group_enabled(snd_seq_client_info_t *info,
 		info->group_filter |= (1U << group);
 }
 
+/**
+ * \brief Enable/disable the UMP groupless message handling
+ * \param info client_info container
+ * \param enable enable the UMP groupless messages
+ *
+ * \sa snd_seq_set_client_info(), snd_seq_client_info_get_ump_groupless_enabled()
+ */
+void snd_seq_client_info_set_ump_groupless_enabled(snd_seq_client_info_t *info,
+						   int enable)
+{
+	assert(info);
+	if (enable)
+		info->group_filter &= ~UMP_GROUPLESS_FILTER;
+	else
+		info->group_filter |= UMP_GROUPLESS_FILTER;
+}
+
 /**
  * \brief Set the automatic conversion mode for UMP
  * \param info client_info container
-- 
2.35.3