Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / configfs-usb-gadget-midi2
1 What:           /config/usb-gadget/gadget/functions/midi2.name
2 Date:           Jul 2023
3 KernelVersion:  6.6
4 Description:
5                 The attributes:
6
7                 ============    ===============================================
8                 process_ump     Flag to process UMP Stream messages (0 or 1)
9                 static_block    Flag for static blocks (0 or 1)
10                 iface_name      MIDI interface name string
11                 ============    ===============================================
12
13 What:           /config/usb-gadget/gadget/functions/midi2.name/ep.number
14 Date:           Jul 2023
15 KernelVersion:  6.6
16 Description:
17                 This group contains a UMP Endpoint configuration.
18                 A new Endpoint starts from 0, and can be up to 3.
19
20                 The attributes:
21
22                 =============   ===============================================
23                 protocol_caps   MIDI protocol capabilities (1, 2 or 3 for both)
24                 protocol        Default MIDI protocol (1 or 2)
25                 ep_name         UMP Endpoint name string
26                 product_id      Product ID string
27                 manufacturer    Manufacture ID (24 bit)
28                 family          Device family ID (16 bit)
29                 model           Device model ID (16 bit)
30                 sw_revision     Software Revision (32 bit)
31                 =============   ===============================================
32
33 What:           /config/usb-gadget/gadget/functions/midi2.name/ep.number/block.number
34 Date:           Jul 2023
35 KernelVersion:  6.6
36 Description:
37                 This group contains a UMP Function Block configuration.
38                 A new block starts from 0, and can be up to 31.
39
40                 The attributes:
41
42                 =================       ==============================================
43                 name                    Function Block name string
44                 direction               1: input, 2: output, 3: bidirectional
45                 first_group             The first UMP Group number (0-15)
46                 num_groups              The number of groups in this FB (1-16)
47                 midi1_first_group       The first UMP Group number for MIDI 1.0 (0-15)
48                 midi1_num_groups        The number of groups for MIDI 1.0 (0-16)
49                 ui_hint                 0: unknown, 1: receiver, 2: sender, 3: both
50                 midi_ci_verison         Supported MIDI-CI version number (8 bit)
51                 is_midi1                Legacy MIDI 1.0 device (0, 1 or 2)
52                 sysex8_streams          Max number of SysEx8 streams (8 bit)
53                 active                  Active FB flag (0 or 1)
54                 =================       ==============================================