Documentation/devicetree/bindings/sound/serial-midi.yaml

   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
   8 title: Generic Serial MIDI Interface
   9
  10 maintainers:
  11   - Daniel Kaehn <kaehndan@gmail.com>
  12
  13 description:
  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   resuts in the standard MIDI baud rate, and set the 'current-speed' property to 38400 (default)
  24
  25 properties:
  26   compatible:
  27     const: serial-midi
  28
  29   current-speed:
  30     description: Baudrate to set the serial port to when this MIDI device is opened.
  31     default: 38400
  32
  33 required:
  34   - compatible
  35
  36 additionalProperties: false
  37
  38 examples:
  39   - |
  40     serial {
  41         midi {
  42             compatible = "serial-midi";
  43         };
  44     };
  45   - |
  46     serial {
  47         midi {
  48             compatible = "serial-midi";
  49             current-speed = <115200>;
  50         };
  51     };