: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:: espressif,esp32-ledc
.. _dtbinding_espressif_esp32_ledc:

espressif,esp32-ledc
####################

Vendor: :ref:`Espressif Systems <dt_vendor_espressif>`

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



.. code-block:: none

   Espressif's LEDC controller Node

   The LEDC controller is primarily designed to control the intensity of LEDs, although it can be
   used to generate PWM signals for other purposes as well.

   The mapping between the channel and GPIO is done through pinctrl

     &ledc0 {
       pinctrl-0 = <&ledc0_default>;
       pinctrl-names = "default";
     }

   The 'ledc0_default' node state is defined in <board>-pinctrl.dtsi.

     ledc0_default: ledc0_default {
             group1 {
                     pinmux = <LEDC_CH0_GPIO0>,
                              <LEDC_CH1_GPIO2>,
                              <LEDC_CH2_GPIO4>;
                     output-enable;
             };
     };

   If another GPIO mapping is desired, check if <board>-pinctrl.dtsi already have it defined,
   otherwise, define the required mapping at your own application folder into a custom
   <board>.overlay file.
   The 'pinmux' property uses a macro defined in
   https://github.com/zephyrproject-rtos/hal_espressif/tree/zephyr/include/dt-bindings/pinctrl
   Before including a new node, check if the desired mapping is available according to the SoC.

   As an example, the 'ledc0_custom' state below illustrates an alternate mapping using another set
   of channels and pins in a custom overlay file.

     &pinctrl {

             ledc0_custom:  ledc0_custom {
                     group1 {
                             pinmux = <LEDC_CH0_GPIO0>,
                                      <LEDC_CH9_GPIO2>,
                                      <LEDC_CH10_GPIO4>;
                             output-enable;
                     };
              };

     };

   Use the child bindings to configure the desired channel:

     &ledc0 {
       pinctrl-0 = <&ledc0_custom>;
       pinctrl-names = "default";
       status = "okay";
       #address-cells = <1>;
       #size-cells = <0>;
       channel0@0 {
         reg = <0x0>;
         timer = <0>;
       };
       channel9@9 {
         reg = <0x9>;
         timer = <0>;
       };
       channel10@a {
         reg = <0xa>;
         timer = <1>;
       };
     };

     Note: The channel's 'reg' property defines the ID of the channel. It must match the channel used
       in the 'pinmux'.

Properties
**********

Top level properties
====================


These property descriptions apply to "espressif,esp32-ledc"
nodes themselves. This page also describes child node
properties in the following sections.

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

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

                Number of items to expect in a pwm specifier


             This property is **required**.

             Constant value: ``3``

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



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

                Names for the provided states. The number of names needs to match the
                number of states.





   .. 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 "espressif,esp32-ledc" 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.






Child node properties
=====================

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

   * - Name
     - Type
     - Details

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

          The ESP32 has 8 low speed channel and 8 high speed channels.
          The low speed channel are mapped from channel 0 to 7, and the high speed are mapped from
          channel 8 to 15.

          High speed channels are only available in the ESP32 SoC. ESP32S2 and ESP32S3 have 8
          available channels, and ESP32C3 has 6. In these SoCs there is no differentiation between
          low or high speed.



       This property is **required**.

       Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``

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

   * - ``timer``
     - ``int``
     - .. code-block:: none

          Timer selection.
          For maximum flexibility, the high-speed as well as the low-speed channels can be driven from
          one of four high-speed/low-speed timers.



       This property is **required**.

       Legal values: ``0``, ``1``, ``2``, ``3``

Specifier cell names
********************

- pwm cells: channel, period, flags