xref: /linux/Documentation/devicetree/bindings/sound/serial-midi.yaml (revision 3a39d672e7f48b8d6b91a09afa4b55352773b4b5) 
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/sound/serial-midi.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Generic Serial MIDI Interface
9
10maintainers:
11  - Daniel Kaehn <kaehndan@gmail.com>
12
13description:
14  Generic MIDI interface using a serial device. This denotes that a serial device is
15  dedicated to MIDI communication, either to an external MIDI device through a DIN5
16  or other connector, or to a known hardwired MIDI controller. This device must be a
17  child node of a serial node.
18
19  Can only be set to use standard baud rates corresponding to supported rates of the
20  parent serial device. If the standard MIDI baud of 31.25 kBaud is needed
21  (as would be the case if interfacing with arbitrary external MIDI devices),
22  configure the clocks of the parent serial device so that a requested baud of 38.4 kBaud
23  results in the standard MIDI baud rate, and set the 'current-speed' property to 38400 (default)
24
25allOf:
26  - $ref: /schemas/serial/serial-peripheral-props.yaml#
27
28properties:
29  compatible:
30    const: serial-midi
31
32  current-speed:
33    description: Baudrate to set the serial port to when this MIDI device is opened.
34    default: 38400
35
36required:
37  - compatible
38
39additionalProperties: false
40
41examples:
42  - |
43    serial {
44        midi {
45            compatible = "serial-midi";
46        };
47    };
48  - |
49    serial {
50        midi {
51            compatible = "serial-midi";
52            current-speed = <115200>;
53        };
54    };
55