: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:: usb-audio-hp
.. _dtbinding_usb_audio_hp:

usb-audio-hp
############

Vendor: :ref:`Generic or vendor-independent <dt_no_vendor>`

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



.. code-block:: none

   USB Audio headphones specific fields.

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

         * - ``resolution``
           - ``int``
           - Default value: ``16``

             Legal values: ``8``, ``16``, ``24``, ``32``

         * - ``sample-rate-hz``
           - ``int``
           - Default value: ``48000``

         * - ``polling-interval``
           - ``int``
           - Default value: ``1``

         * - ``channel-l``
           - ``boolean``
           - .. code-block:: none

                Enable (l) channel.


         * - ``channel-r``
           - ``boolean``
           - .. code-block:: none

                Enable (r) channel.


         * - ``channel-c``
           - ``boolean``
           - .. code-block:: none

                Enable (c) channel.


         * - ``channel-lfe``
           - ``boolean``
           - .. code-block:: none

                Enable (lfe) channel.


         * - ``channel-ls``
           - ``boolean``
           - .. code-block:: none

                Enable (ls) channel.


         * - ``channel-rs``
           - ``boolean``
           - .. code-block:: none

                Enable (rs) channel.


         * - ``channel-lc``
           - ``boolean``
           - .. code-block:: none

                Enable (lc) channel.


         * - ``channel-rc``
           - ``boolean``
           - .. code-block:: none

                Enable (rc) channel.


         * - ``channel-s``
           - ``boolean``
           - .. code-block:: none

                Enable (s) channel.


         * - ``channel-sl``
           - ``boolean``
           - .. code-block:: none

                Enable (sl) channel.


         * - ``channel-sr``
           - ``boolean``
           - .. code-block:: none

                Enable (sr) channel.


         * - ``channel-t``
           - ``boolean``
           - .. code-block:: none

                Enable (t) channel.


         * - ``channel-cfg``
           - ``boolean``
           - .. code-block:: none

                Enable (cfg) channel.


         * - ``feature-mute``
           - ``boolean``
           - .. code-block:: none

                Enable Mute feature.


             This property is **required**.

         * - ``feature-volume``
           - ``boolean``
           - .. code-block:: none

                Enable Volume feature.
                Currently not supported.



         * - ``feature-tone-control``
           - ``boolean``
           - .. code-block:: none

                Enable Tone Control (Bass, Mid, Treble) feature.
                Currently not supported.



         * - ``feature-graphic-equalizer``
           - ``boolean``
           - .. code-block:: none

                Enable  Graphic Equalizer feature.
                Currently not supported.



         * - ``feature-automatic-gain-control``
           - ``boolean``
           - .. code-block:: none

                Enable Autoamtic Gain Control feature.
                Currently not supported.



         * - ``feature-delay``
           - ``boolean``
           - .. code-block:: none

                Enable Delay feature.
                Currently not supported.



         * - ``feature-bass-boost``
           - ``boolean``
           - .. code-block:: none

                Enable Bass Boost feature.
                Currently not supported.



         * - ``feature-loudness``
           - ``boolean``
           - .. code-block:: none

                Enable Loudness feature.
                Currently not supported.



         * - ``volume-max``
           - ``int``
           - .. code-block:: none

                attention: this attribute is a signed value.
                This attribute represents the maximum volume level.
                The range from +127.9961 dB (0x7FFF) down to -127.9961 dB (0x8001).
                Valid range: 0 - 0xFFFF



             Default value: ``2560``

         * - ``volume-min``
           - ``int``
           - .. code-block:: none

                attention: this attribute is a signed value.
                This attribute represents the minimum volume level.
                The range from +127.9961 dB (0x7FFF) down to -127.9961 dB (0x8001).
                Valid range: 0 - 0xFFFF



             Default value: ``47616``

         * - ``volume-res``
           - ``int``
           - .. code-block:: none

                attention: this attribute can only take positive values.
                This attribute represents the volume resolution(step).
                1 = 1/256 dB or 0.00390625 dB.
                0x100(256) = 1dB.
                Valid range: 1 - 0x7FFF



             Default value: ``256``



   .. 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 "usb-audio-hp" compatible.

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

         * - Name
           - Type
           - Details

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

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

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

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

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

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

                register space


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

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

                name of each register space


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

                interrupts for device


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

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


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

                Human readable string describing the device (used as device_get_binding() argument)



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

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``wakeup-source``
           - ``boolean``
           - .. code-block:: none

                Property to identify that a device can be used as wake up source.

                When this property is provided a specific flag is set into the
                device that tells the system that the device is capable of
                wake up the system.

                Wake up capable devices are disabled (interruptions will not wake up
                the system) by default but they can be enabled at runtime if necessary.



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.