: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:: infineon,xmc4xxx-ccu4-pwm
.. _dtbinding_infineon_xmc4xxx_ccu4_pwm:

infineon,xmc4xxx-ccu4-pwm
#########################

Vendor: :ref:`Infineon Technologies <dt_vendor_infineon>`

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



.. code-block:: none

   Infineon XMC4XXX PWM Capture Compare Unit 4 (CCU4) module

   The are four CCU4 modules with dts node labels:
   pwm_ccu40, pwm_ccu41, pwm_ccu42, pwm_ccu43.
   Each module has four slices and each slice has one channel.
   A channel is connected to a particular gpio pin, which are defined
   using pinctrl in:
   dts/arm/infineon/xmc4xxx_xxx-pinctrl.dtsi

   The CCU4 modules uses the CCU clock source. Each slice applies a separate
   prescalar which divides the clock.

   Device tree example:
   A node can define a 'pwm' field, usually referenced in a 'pwms'
   property, where the entries include the PWM module phandle,
   channel number, pulse period (in nanoseconds or set using
   PWM_XX() macros), and a channela
   flag (PWM_POLARITY_NORMAL/PWM_POLARITY_INVERTED).

   The pwm ccu4 node must define the slice-prescaler values and the pinctrl nodes:
   &pwm_ccu40 {
       slice-prescaler = <15 15 15 15>;
       pinctrl-0 = <&pwm_out_p1_1_ccu40_ch2>;
       pinctrl-names = "default";
   };

   Another node can reference the PWM as follows:
   &test_node {
      ...
      pwms = <&pwm_ccu40 0 PWM_SEC(1) PWM_POLARITY_NORMAL>;
      ...
   };

   The user must also explicitly set pinctrl properties.
   The pin should be configured with drive-push-pull bool option and hwctrl should be set
   to disabled. The drive-strength field can be set to any of the supported values:
   &pwm_out_p1_1_ccu40_ch2 {
       drive-strength = "strong-medium-edge";
       drive-push-pull;
       hwctrl = "disabled";
   };

   The CCU4 pinctrl nodes have a node labels in the format
   pwm_out_p{PORT}_{PIN}_ccu4{MODULE_IDX}_ch{CHANNEL_IDX}, where MODULE_IDX and
   CHANNEL_IDX refers to specific pwm_ccu4x module and channel, respectively.
   PORT/PIN pair defines what gpio the channel connects to.

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

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

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



             This property is **required**.

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

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



             This property is **required**.

         * - ``slice-prescaler``
           - ``array``
           - .. code-block:: none

                Defines the clock divider for each channel.
                The entry in the array will divide CCU clock by (2 << value).
                The range for the prescaler values is [0, 15].
                Reducing prescaler value will improve resolution but decrease the maximum period.



             This property is **required**.

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

                Number of items to expect in a pwm specifier


             This property is **required**.

             Constant value: ``3``

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





   .. 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 "infineon,xmc4xxx-ccu4-pwm" compatible.

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

         * - Name
           - Type
           - Details

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

                register space


             This property is **required**.

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

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

                indicates the operational status of a device


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

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

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

                compatible strings


             This property is **required**.

             See :ref:`zephyr: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:`zephyr: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:`zephyr: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.






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

- pwm cells: channel, period, flags