sound/designs/midi-2.0.rst

9 more fine controls over the legacy MIDI 1.0.  The fundamental changes
12 - Support of Universal MIDI Packet (UMP)
13 - Support of MIDI 2.0 protocol messages
14 - Transparent conversions between UMP and legacy MIDI 1.0 byte stream
15 - MIDI-CI for property and profile configurations
26 MIDI-CI is a high-level protocol that can talk with the MIDI device
31 the encoding/decoding of MIDI protocols on UMP, while MIDI-CI is
32 supported in user-space over the standard SysEx.
59 support for the legacy raw MIDI device for UMP Endpoints.
65 When a device supports MIDI 2.0, the USB-audio driver probes and uses
69 `midi2_enable=0` option to snd-usb-audio driver module, too.
78 option to snd-usb-audio driver for skipping the UMP v1.1 inquiries.
84 legacy applications accessing mistakenly to UMP devices.
91   % hexdump -C /dev/snd/umpC0D0
98 The 32-bit words in the UMP packet payload are always in CPU native
106 (0-based) UMP Group.  Legacy applications can access to the specified
139     Groups: 1-1
145     Groups: 2-2
150 1-based UMP Group numbers (from-to).
175 either the legacy, UMP MIDI 1.0 or UMP MIDI 2.0 device, respectively.
176 The first, legacy client is the one that sends/receives the old
183 flag is set, the event has 16 byte (128 bit) data payload for holding
185 is treated as a legacy event as it was (with max 12 byte data
198   Client  14 : "Midi Through" [Kernel Legacy]
199     Port   0 : "Midi Through Port-0" (RWe-)
203       Groups: 1-1
205       Groups: 2-2
207       Groups: 3-3
210     Port   2 : "ProtoZOA Ext IN" (-We-) [Out]
211     Port   3 : "ProtoZOA Ext OUT" (R-e-) [In]
213 Here you can find two types of kernel clients, "Legacy" for client 14,
217 In this example, the device has three active groups (Main, Ext IN and
221 the all ports on the device ("catch-all"), while each UMP Group port
238 only between the legacy and the UMP MIDI 1.0/2.0 types, but also
240 `aseqdump` program on the ProtoZOA Main port in the legacy mode will
243   % aseqdump -p 20:1
250 When you run `aseqdump` in MIDI 2.0 mode, it'll receive the high
253   % aseqdump -u 2 -p 20:1
282   `SNDRV_UMP_IOCTL_BLOCK_INFO`.  The block ID number (0-based) has to
285   (0-based) and the number of groups, the name string of the block,
302   `SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE` queries only the legacy
330   to have a larger payload of 16 bytes instead of the legacy 12
334   indicates the port being UMP-capable.
342   For example, the kernel pass-through client (`snd-seq-dummy`) sets
350   which specifies the associated UMP Group Number (1-based).
351   When it's non-zero, the UMP group field in the UMP packet updated
352   upon delivery to the specified group (corrected to be 0-based).
357   `group_filter` bitmap.  The filter consists of bitmap from 1-based
362 * Two new ioctls are added for UMP-capable clients:
368   user-space client may provide its own data via `*_SET` ioctl.
449   % ln -s functions/midi2.usb0 configs/c.1
465   1 [Gadget         ]: f_midi2 - MIDI 2.0 Gadget
473   2 [ACMESynth      ]: USB-Audio - ACMESynth
474                        ACME Enterprises ACMESynth at usb-dummy_hcd.0-1, high speed
478   % aplaymidi -p 20:1 to_host.mid
483   % aseqdump -p 20:0 -u 2
488 Each Function Block may have different direction and UI-hint,
490 Passing `1` is for input-only, `2` for out-only and `3` for
518 driver, pass `0` to `process_ump` attribute in the top-level config::
526 user-space over UMP rawmidi.
540 `ep.1` (but under the card top-level config) to enable a new Endpoint::
552 legacy MIDI 1.0 rawmidi devices corresponding to both EP 0 and EP 1.
555 element "Operation Mode" with `RAWMIDI` iface.  e.g. you can read it
558   % amixer -c1 cget iface=RAWMIDI,name='Operation Mode'
559   ; type=INTEGER,access=r--v----,values=1,min=0,max=2,step=0