: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-input-terminal
.. _dtbinding_zephyr_uac2_input_terminal:

zephyr,uac2-input-terminal
##########################

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

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



.. code-block:: none

   USB Audio Class 2 Input Terminal entity

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

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

                Terminal Type constant specified in USB Audio Terminal Types



             This property is **required**.

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

                Associated terminal for bi-directional terminal types.



         * - ``clock-source``
           - ``phandle``
           - .. code-block:: none

                Connected clock entity



             This property is **required**.

         * - ``copy-protect-control``
           - ``string``
           - .. code-block:: none

                Copy Protect Control capabilities


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

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

                Connector Control capabilities


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

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

                Overload Control capabilities


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

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

                Cluster Control capabilities


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

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

                Underflow Control capabilities


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

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

                Overflow Control capabilities


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

         * - ``front-left``
           - ``boolean``
           - .. code-block:: none

                Front Left channel present in the cluster


         * - ``front-right``
           - ``boolean``
           - .. code-block:: none

                Front Right channel present in the cluster


         * - ``front-center``
           - ``boolean``
           - .. code-block:: none

                Front Center channel present in the cluster


         * - ``low-frequency-effects``
           - ``boolean``
           - .. code-block:: none

                Low Frequency Effects channel present in the cluster


         * - ``back-left``
           - ``boolean``
           - .. code-block:: none

                Back Left channel present in the cluster


         * - ``back-right``
           - ``boolean``
           - .. code-block:: none

                Back Right channel present in the cluster


         * - ``front-left-of-center``
           - ``boolean``
           - .. code-block:: none

                Front Left of Center channel present in the cluster


         * - ``front-right-of-center``
           - ``boolean``
           - .. code-block:: none

                Front Right of Center channel present in the cluster


         * - ``back-center``
           - ``boolean``
           - .. code-block:: none

                Back Center channel present in the cluster


         * - ``side-left``
           - ``boolean``
           - .. code-block:: none

                Side Left channel present in the cluster


         * - ``side-right``
           - ``boolean``
           - .. code-block:: none

                Side Right channel present in the cluster


         * - ``top-center``
           - ``boolean``
           - .. code-block:: none

                Top Center channel present in the cluster


         * - ``top-front-left``
           - ``boolean``
           - .. code-block:: none

                Top Front Left channel present in the cluster


         * - ``top-front-center``
           - ``boolean``
           - .. code-block:: none

                Top Front Center channel present in the cluster


         * - ``top-front-right``
           - ``boolean``
           - .. code-block:: none

                Top Front Right channel present in the cluster


         * - ``top-back-left``
           - ``boolean``
           - .. code-block:: none

                Top Back Left channel present in the cluster


         * - ``top-back-center``
           - ``boolean``
           - .. code-block:: none

                Top Back Center channel present in the cluster


         * - ``top-back-right``
           - ``boolean``
           - .. code-block:: none

                Top Back Right channel present in the cluster


         * - ``top-front-left-of-center``
           - ``boolean``
           - .. code-block:: none

                Top Front Left of Center channel present in the cluster


         * - ``top-front-right-of-center``
           - ``boolean``
           - .. code-block:: none

                Top Front Right of Center channel present in the cluster


         * - ``left-low-frequency-effects``
           - ``boolean``
           - .. code-block:: none

                Left Low Frequency Effects channel present in the cluster


         * - ``right-low-frequency-effects``
           - ``boolean``
           - .. code-block:: none

                Right Low Frequency Effects channel present in the cluster


         * - ``top-side-left``
           - ``boolean``
           - .. code-block:: none

                Top Side Left channel present in the cluster


         * - ``top-side-right``
           - ``boolean``
           - .. code-block:: none

                Top Side Right channel present in the cluster


         * - ``bottom-center``
           - ``boolean``
           - .. code-block:: none

                Bottom Center channel present in the cluster


         * - ``back-left-of-center``
           - ``boolean``
           - .. code-block:: none

                Back Left of Center channel present in the cluster


         * - ``back-right-of-center``
           - ``boolean``
           - .. code-block:: none

                Back Right of Center channel present in the cluster


         * - ``raw-data``
           - ``boolean``
           - .. code-block:: none

                Raw Data, mutually exclusive with all other spatial locations




   .. 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-input-terminal" compatible.

      (None)