: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-mic
.. _dtbinding_usb_audio_mic:

usb-audio-mic
#############

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

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



.. code-block:: none

   USB Audio microphone 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``

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

                Type of endpoint synchronization for IN devices.
                Default value is Sychronous.
                Adaptive is not supported.



             Default value: ``Synchronous``

             Legal values: ``'No Synchronization'``, ``'Asynchronous'``, ``'Adaptive'``, ``'Synchronous'``

         * - ``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.





   .. 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-mic" compatible.

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

         * - Name
           - Type
           - Details

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

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


             This property is **required**.

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