: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-clock-source
.. _dtbinding_zephyr_uac2_clock_source:

zephyr,uac2-clock-source
########################

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

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



.. code-block:: none

   USB Audio Class 2 Clock Source 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

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

                Clock Type indicating whether the Clock Source represents an external
                clock or an internal clock with either fixed frequency, variable
                frequency, or programmable frequency.



             This property is **required**.

             Legal values: ``'external'``, ``'internal-fixed'``, ``'internal-variable'``, ``'internal-programmable'``

         * - ``sof-synchronized``
           - ``boolean``
           - .. code-block:: none

                True if clock is synchronized to USB Start of Frame. False if clock is
                free running. External clock must be free running.



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

                Clock Frequency Control capabilities


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

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

                Clock Validity Control capabilities


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

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

                Input or Output Terminal associated with this Clock Source. Set if clock
                is derived from USB OUT data endpoint (point the handle to respective
                Input Terminal) or from input signal on S/PDIF connector.



         * - ``sampling-frequencies``
           - ``array``
           - .. code-block:: none

                Sampling Frequencies, in Hz, this Clock Source Entity can generate.



             This property is **required**.



   .. 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-clock-source" compatible.

      (None)