: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:: nordic,nrf-sw-pwm
.. _dtbinding_nordic_nrf_sw_pwm:

nordic,nrf-sw-pwm
#################

Vendor: :ref:`Nordic Semiconductor <dt_vendor_nordic>`

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



.. code-block:: none

   nRFx S/W PWM

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

         * - ``generator``
           - ``phandle``
           - .. code-block:: none

                Reference to TIMER or RTC instance for generating PWM output signals



             This property is **required**.

         * - ``clock-prescaler``
           - ``int``
           - .. code-block:: none

                Clock prescaler for RTC or TIMER used for generating PWM output signals.

                RTC: needs to be set to 0, which gives 32768 Hz base clock for PWM
                generation.

                TIMER: 16 MHz / 2^prescaler base clock is used for PWM generation.



             This property is **required**.

         * - ``channel-gpios``
           - ``phandle-array``
           - .. code-block:: none

                An array of GPIOs assigned as outputs for the PWM channels. The number
                of items in this array determines the number of channels that this PWM
                will provide. This value is limited by the number of compare registers
                in the used RTC/TIMER instance minus 1.

                Example:

                  sw_pwm: sw-pwm {
                    compatible = "nordic,nrf-sw-pwm";
                    ...
                    channel-gpios = <&gpio0 20 GPIO_ACTIVE_HIGH>,
                                    <&gpio1 12 GPIO_ACTIVE_HIGH>;
                    ...
                  };

                The above will assign P0.20 as the output for channel 0 and P1.12 as
                the output for channel 1. Both outputs will be initially configured as
                active high.

                Please note that in the flags cell (the last component of each item
                of the array) only the GPIO flags that specify the active level are
                taken into account (any others are ignored), and they are used only
                when the initial (inactive) state of the outputs is set.
                After any PWM signal generation is requested for a given channel,
                the polarity of its output is determined by the flag specified
                in the request, i.e. PWM_POLARITY_INVERTED or PWM_POLARITY_NORMAL.



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



   .. 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 "nordic,nrf-sw-pwm" 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.






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

- pwm cells: channel, period, flags