History

ALSA: rawmidi: UMP support

This patch adds the support helpers for UMP (Universal MIDI Packet) in ALSA core. The basic design is that a rawmidi instance is assigned to each UMP Endpoint. A UMP Endpoint provides a UMP stream, typically bidirectional (but can be also uni-directional, too), which may hold up to 16 UMP Groups, where each UMP (input/output) Group corresponds to the traditional MIDI I/O Endpoint. Additionally, the ALSA UMP abstraction provides the multiple UMP Blocks that can be assigned to each UMP Endpoint. A UMP Block is a metadata to hold the UMP Group clusters, and can represent the functions assigned to each UMP Group. A typical implementation of UMP Block is the Group Terminal Blocks of USB MIDI 2.0 specification. For distinguishing from the legacy byte-stream MIDI device, a new device "umpC*D*" will be created, instead of the standard (MIDI 1.0) devices "midiC*D*". The UMP instance can be identified by the new rawmidi info bit SNDRV_RAWMIDI_INFO_UMP, too. A UMP rawmidi device reads/writes only in 4-bytes words alignment, stored in CPU native endianness. The transmit and receive functions take care of the input/out data alignment, and may return zero or aligned size, and the params ioctl may return -EINVAL when the given input/output buffer size isn't aligned. A few new UMP-specific ioctls are added for obtaining the new UMP endpoint and block information. As of this commit, no ALSA sequencer instance is attached to UMP devices yet. They will be supported by later patches. Along with those changes, the protocol version for rawmidi is bumped to 2.0.3.

Takashi Iwai committed 3 years ago

Commit e3a8a5b1 parent fb3bd128 files · +521 −41Browse files

Showing the changes to include/uapi (1 of 8 files). Show all

Unified · Split

include/uapi/sound/asound.h+56−1
@@ -708,7 +708,7 @@ enum { · 707 unmodified lines
708708 * Raw MIDI section - /dev/snd/midi??
709709 */
710710
711−#define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 2)
711+#define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 3)
712712
713713 enum {
714714 SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
@@ -719,6 +719,7 @@ enum { · 4 unmodified lines
719719 #define SNDRV_RAWMIDI_INFO_OUTPUT 0x00000001
720720 #define SNDRV_RAWMIDI_INFO_INPUT 0x00000002
721721 #define SNDRV_RAWMIDI_INFO_DUPLEX 0x00000004
722+#define SNDRV_RAWMIDI_INFO_UMP 0x00000008
722723
723724 struct snd_rawmidi_info {
724725 unsigned int device; /* RO/WR (control): device number */
@@ -779,6 +780,57 @@ struct snd_rawmidi_status { · 54 unmodified lines
779780 };
780781 #endif
781782
783+/* UMP EP Protocol / JRTS capability bits */
784+#define SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK 0x0300
785+#define SNDRV_UMP_EP_INFO_PROTO_MIDI1 0x0100 /* MIDI 1.0 */
786+#define SNDRV_UMP_EP_INFO_PROTO_MIDI2 0x0200 /* MIDI 2.0 */
787+#define SNDRV_UMP_EP_INFO_PROTO_JRTS_MASK 0x0003
788+#define SNDRV_UMP_EP_INFO_PROTO_JRTS_TX 0x0001 /* JRTS Transmit */
789+#define SNDRV_UMP_EP_INFO_PROTO_JRTS_RX 0x0002 /* JRTS Receive */
790+
791+/* UMP Endpoint information */
792+struct snd_ump_endpoint_info {
793+ int card; /* card number */
794+ int device; /* device number */
795+ unsigned int flags; /* additional info */
796+ unsigned int protocol_caps; /* protocol capabilities */
797+ unsigned int protocol; /* current protocol */
798+ unsigned int num_blocks; /* # of function blocks */
799+ unsigned short version; /* UMP major/minor version */
800+ unsigned short padding[7];
801+ unsigned char name[128]; /* endpoint name string */
802+ unsigned char product_id[128]; /* unique product id string */
803+ unsigned char reserved[32];
804+} __packed;
805+
806+/* UMP direction */
807+#define SNDRV_UMP_DIR_INPUT 0x01
808+#define SNDRV_UMP_DIR_OUTPUT 0x02
809+#define SNDRV_UMP_DIR_BIDIRECTION 0x03
810+
811+/* UMP block info flags */
812+#define SNDRV_UMP_BLOCK_IS_MIDI1 (1U << 0) /* MIDI 1.0 port w/o restrict */
813+#define SNDRV_UMP_BLOCK_IS_LOWSPEED (1U << 1) /* 31.25Kbps B/W MIDI1 port */
814+
815+/* UMP groups and blocks */
816+#define SNDRV_UMP_MAX_GROUPS 16
817+#define SNDRV_UMP_MAX_BLOCKS 32
818+
819+/* UMP Block information */
820+struct snd_ump_block_info {
821+ int card; /* card number */
822+ int device; /* device number */
823+ unsigned char block_id; /* block ID (R/W) */
824+ unsigned char direction; /* UMP direction */
825+ unsigned char active; /* Activeness */
826+ unsigned char first_group; /* first group ID */
827+ unsigned char num_groups; /* number of groups */
828+ unsigned char padding[3];
829+ unsigned int flags; /* various info flags */
830+ unsigned char name[128]; /* block name string */
831+ unsigned char reserved[32];
832+} __packed;
833+
782834 #define SNDRV_RAWMIDI_IOCTL_PVERSION _IOR('W', 0x00, int)
783835 #define SNDRV_RAWMIDI_IOCTL_INFO _IOR('W', 0x01, struct snd_rawmidi_info)
784836 #define SNDRV_RAWMIDI_IOCTL_USER_PVERSION _IOW('W', 0x02, int)
@@ -786,6 +838,9 @@ struct snd_rawmidi_status { · 1 unmodified line
786838 #define SNDRV_RAWMIDI_IOCTL_STATUS _IOWR('W', 0x20, struct snd_rawmidi_status)
787839 #define SNDRV_RAWMIDI_IOCTL_DROP _IOW('W', 0x30, int)
788840 #define SNDRV_RAWMIDI_IOCTL_DRAIN _IOW('W', 0x31, int)
841+/* Additional ioctls for UMP rawmidi devices */
842+#define SNDRV_UMP_IOCTL_ENDPOINT_INFO _IOR('W', 0x40, struct snd_ump_endpoint_info)
843+#define SNDRV_UMP_IOCTL_BLOCK_INFO _IOR('W', 0x41, struct snd_ump_block_info)
789844
790845 /*
791846 * Timer section - /dev/snd/timer

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t