: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:: nxp,rt-iocon-pinctrl
.. _dtbinding_nxp_rt_iocon_pinctrl:

nxp,rt-iocon-pinctrl
####################

Vendor: :ref:`NXP Semiconductors <dt_vendor_nxp>`

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



.. code-block:: none

   RT600/RT500 pin control node. This node defines pin configurations in pin
   groups, and has the 'pinctrl' node identifier in the SOC's devicetree. Each
   group within the pin configuration defines a peripheral's pin configuration.
   Each numbered subgroup represents pins with shared configuration for that
   peripheral. The 'pinmux' property of each group selects the pins to be
   configured with these properties. For example, here is a configuration
   for FLEXCOMM0 pins:

   pinmux_flexcomm0_usart: pinmux_flexcomm0_usart {
     group0 {
       pinmux = <FC0_TXD_SCL_MISO_WS_PIO0_1>,
               <FC0_RXD_SDA_MOSI_DATA_PIO0_2>;
       slew-rate = "normal";
       drive-strength = "normal";
     };
   };

   If only the required properties are supplied, the ICON_PIO register will
   be assigned the following values:
   IOCON_FUNC=<pin mux selection>,
   IOCON_PUPDENA = 0,
   IOCON_PUPDSEL = 0,
   IOCON_IBENA = 0,
   IOCON_SLEWRATE = <slew-rate selection>,
   IOCON_FULLDRIVE = <drive-strength selection>,
   IOCON_AMENA = 0,
   IOCON_ODENA = 0,
   IOCON_IIENA = 0,

   Note the inherited pinctrl properties defined below have the following effects:
   drive-open-drain: IOCON_ODENA=1
   bias-pull-up: IOCON_PUPDENA=1, IOCON_PUPSEL=1
   bias-pull-down: IOCON_PUPDENA=1, IOCON_PUPSEL=0
   input-enable: IOCON_IBENA=1

Properties
**********

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


These property descriptions apply to "nxp,rt-iocon-pinctrl"
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.

      (None)

   .. 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 "nxp,rt-iocon-pinctrl" 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.






Grandchild node properties
==========================

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

   * - Name
     - Type
     - Details

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

          Pin mux selection for this group. See the SOC level pinctrl header
          file in NXP's HAL for a defined list of these options.



       This property is **required**.

   * - ``slew-rate``
     - ``string``
     - .. code-block:: none

          Pin output slew rate. Sets the SLEWRATE field in the IOCON register.
          0 SLEWRATE_0- normal mode, output slew rate is standard
          1 SLEWRATE_1- slow mode, output slew rate is slower



       This property is **required**.

       Legal values: ``'normal'``, ``'slow'``

   * - ``drive-strength``
     - ``string``
     - .. code-block:: none

          Pin output drive strength. Sets the FULLDRIVE field in the
          IOCON register.
          0 FULLDRIVE_0- Normal output drive mode
          1 FULLDRIVE_1- Full output drive mode, output strength is twice
          the drive strength of normal drive mode.



       This property is **required**.

       Legal values: ``'normal'``, ``'high'``

   * - ``nxp,invert``
     - ``boolean``
     - .. code-block:: none

          Invert the pin input logic level



   * - ``nxp,analog-mode``
     - ``boolean``
     - .. code-block:: none

          Set the pin to analog mode. Sets AMENA=1



   * - ``bias-pull-up``
     - ``boolean``
     - .. code-block:: none

          enable pull-up resistor


   * - ``bias-pull-down``
     - ``boolean``
     - .. code-block:: none

          enable pull-down resistor


   * - ``drive-open-drain``
     - ``boolean``
     - .. code-block:: none

          drive with open drain (hardware AND)


   * - ``input-enable``
     - ``boolean``
     - .. code-block:: none

          enable input on pin (e.g. enable an input buffer, no effect on output)