: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,uac2-audio-streaming
.. _dtbinding_zephyr_uac2_audio_streaming:

zephyr,uac2-audio-streaming
###########################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

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



.. code-block:: none

   USB Audio Class 2 Audio Streaming interface

Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

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

         * - Name
           - Type
           - Details

         * - ``linked-terminal``
           - ``phandle``
           - .. code-block:: none

                Input or Output Terminal to which this interface is connected.



             This property is **required**.

         * - ``active-alternate-setting-control``
           - ``string``
           - .. code-block:: none

                Active Alternate Setting Control capabilities


             Legal values: ``'read-only'``

         * - ``valid-alternate-settings-control``
           - ``string``
           - .. code-block:: none

                Valid Alternate Settings Control capabilities


             Legal values: ``'read-only'``

         * - ``external-interface``
           - ``boolean``
           - .. code-block:: none

                Enable if audio stream is not transmitted over USB (Type IV Audio Stream).



         * - ``implicit-feedback``
           - ``boolean``
           - .. code-block:: none

                Enable implicit feedback on asynchronous endpoint. For IN endpoints this
                sets endpoint behaviour type to implicit feedback data endpoint. For OUT
                endpoints setting this property removes explicit feedback endpoint.



         * - ``pitch-control``
           - ``string``
           - .. code-block:: none

                Pitch Control capabilities


             Legal values: ``'read-only'``, ``'host-programmable'``

         * - ``data-overrun-control``
           - ``string``
           - .. code-block:: none

                Data Overrun capabilities


             Legal values: ``'read-only'``

         * - ``data-underrun-control``
           - ``string``
           - .. code-block:: none

                Data Underrun capabilities


             Legal values: ``'read-only'``

         * - ``lock-delay``
           - ``int``
           - .. code-block:: none

                Time it takes this endpoint to reliably lock its internal clock recovery
                circuitry. Units depend on the lock-delay-units field. Relevant only if
                linked-terminal's clock is sof-synchronized.



         * - ``lock-delay-units``
           - ``string``
           - .. code-block:: none

                Units for lock-delay parameter.


             Legal values: ``'milliseconds'``, ``'decoded-pcm-samples'``

         * - ``subslot-size``
           - ``int``
           - .. code-block:: none

                Number of bytes occupied by one audio subslot. Can be 1, 2, 3 or 4.



         * - ``bit-resolution``
           - ``int``
           - .. code-block:: none

                Number of effectively used bits in audio subslot.





   .. 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,uac2-audio-streaming" compatible.

      (None)