sound/designs/midi-2.0.rst

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.
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.
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).
199     Port   0 : "Midi Through Port-0" (RWe-)
203       Groups: 1-1
205       Groups: 2-2
206     UMP Block 2: ProtoZOA Ext OUT [Active]
207       Groups: 3-3
208     Port   0 : "MIDI 2.0" (RWeX) [In/Out]
209     Port   1 : "ProtoZOA Main" (RWeX) [In/Out]
210     Port   2 : "ProtoZOA Ext IN" (-We-) [Out]
211     Port   3 : "ProtoZOA Ext OUT" (R-e-) [In]
218 Ext OUT), and those are exposed as sequencer ports from 1 to 3.
221 the all ports on the device ("catch-all"), while each UMP Group port
243   % aseqdump -p 20:1
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,
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.
411   % mkdir functions/midi2.usb0
428   % echo "ACMESynth" > functions/midi2.usb0/iface_name
429   % echo "ACMESynth" > functions/midi2.usb0/ep.0/ep_name
430   % echo "ABCD12345" > functions/midi2.usb0/ep.0/product_id
431   % echo 0x0123 > functions/midi2.usb0/ep.0/family
432   % echo 0x4567 > functions/midi2.usb0/ep.0/model
433   % echo 0x123456 > functions/midi2.usb0/ep.0/manufacturer
434   % echo 0x12345678 > functions/midi2.usb0/ep.0/sw_revision
438   % echo 2 > functions/midi2.usb0/ep.0/protocol
443   % echo "Monosynth" > functions/midi2.usb0/ep.0/block.0/name
444   % echo 0 > functions/midi2.usb0/ep.0/block.0/first_group
445   % echo 1 > functions/midi2.usb0/ep.0/block.0/num_groups
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
493   % echo 2 > functions/midi2.usb0/ep.0/block.0/direction
494   % echo 2 > functions/midi2.usb0/ep.0/block.0/ui_hint
501   % mkdir functions/midi2.usb0/ep.0/block.1
502   % echo "Keyboard" > functions/midi2.usb0/ep.0/block.1/name
503   % echo 1 > functions/midi2.usb0/ep.0/block.1/first_group
504   % echo 1 > functions/midi2.usb0/ep.0/block.1/num_groups
505   % echo 1 > functions/midi2.usb0/ep.0/block.1/direction
506   % echo 1 > functions/midi2.usb0/ep.0/block.1/ui_hint
515   % echo 2 > functions/midi2.usb0/ep.0/block.1/is_midi1
518 driver, pass `0` to `process_ump` attribute in the top-level config::
520   % echo 0 > functions/midi2.usb0/process_ump
526 user-space over UMP rawmidi.
531   % echo 0 > functions/midi2.usb0/ep.0/block.0/midi1_first_group
532   % echo 1 > functions/midi2.usb0/ep.0/block.0/midi1_num_groups
540 `ep.1` (but under the card top-level config) to enable a new Endpoint::
542   % mkdir functions/midi2.usb0/ep.1
547   % mkdir functions/midi2.usb0/ep.1/block.0
548   % echo 4 > functions/midi2.usb0/ep.1/block.0/num_groups
558   % amixer -c1 cget iface=RAWMIDI,name='Operation Mode'
559   ; type=INTEGER,access=r--v----,values=1,min=0,max=2,step=0