:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: zephyr,midi2-device
.. _dtbinding_zephyr_midi2_device:

zephyr,midi2-device
###################

.. sidebar:: Overview

   :Name: ``zephyr,midi2-device``
   :Vendor: :ref:`The Zephyr Project <dt_vendor_zephyr>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=zephyr,midi2-device>` using
               this compatible
   :Driver: :zephyr_file:`subsys/usb/device_next/class/usbd_midi2.c`

Description
***********



.. code-block:: none

   MIDI2 device

Properties
**********

Top level properties
====================


These property descriptions apply to "zephyr,midi2-device"
nodes themselves. This page also describes child node
properties in the following sections.

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      (None)

   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "zephyr,midi2-device" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``#address-cells``
           - ``int``
           - Constant value: ``1``

         * - ``#size-cells``
           - ``int``
           - Constant value: ``1``

         * - ``label``
           - ``string``
           - .. code-block:: none

                Name of the UMP (MIDI 2.0) endpoint


             See :ref:`zephyr:dt-important-props` for more information.




Child node properties
=====================

.. list-table::
   :widths: 1 1 4
   :header-rows: 1

   * - Name
     - Type
     - Details

   * - ``label``
     - ``string``
     - .. code-block:: none

          Name of the corresponding UMP Function block


       See :ref:`zephyr:dt-important-props` for more information.

   * - ``reg``
     - ``array``
     - .. code-block:: none

          First MIDI2 Group number (address) and number of Group Terminals (size)
          in this MIDI2 Group Terminal Block.
          The MIDI2 Groups 1 to 16 corresponds to address 0x0 to 0xf. There are
          at most 16 addressable groups (of 16 chans each) per MIDI2 interface.



       This property is **required**.

       See :ref:`zephyr:dt-important-props` for more information.

   * - ``protocol``
     - ``string``
     - .. code-block:: none

          Default MIDI protocol of the Group Terminals in this Block.



       Legal values: ``'use-midi-ci'``, ``'midi1-up-to-64b'``, ``'midi1-up-to-128b'``, ``'midi2'``

   * - ``terminal-type``
     - ``string``
     - .. code-block:: none

          Type (data direction) of Group Terminals in this Block.



       Default value: ``bidirectional``

       Legal values: ``'bidirectional'``, ``'input-only'``, ``'output-only'``

   * - ``serial-31250bps``
     - ``boolean``
     - .. code-block:: none

          This represent a physical MIDI1 serial port, which is limited
          to a transmission speed of 31.25kb/s.