: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,imx8mp-pinctrl
.. _dtbinding_nxp_imx8mp_pinctrl:

nxp,imx8mp-pinctrl
##################

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

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



.. code-block:: none

   The node has the 'pinctrl' node label set in MCUX SoC's devicetree. These
   nodes can be autogenerated using the MCUXpresso config tools combined with
   the imx_dts_gen.py script in NXP's HAL. The mux, mode, input, daisy, and cfg
   fields in a group select the pins to be configured, and the remaining
   devicetree properties set configuration values for those pins
   for example, here is an group configuring LPUART1 pins:

   group0 {
     pinmux = <&iomuxc_uart4_rxd_uart_rx_uart4_rx:,
       &iomuxc_uart4_txd_uart_tx_uart4_tx>;
       bias-pull-up;
       slew-rate = "slow";
       drive-strength = "x1";
   };

   This will select UART4_RXD as UART4 rx, and UART4_TXD as UART4 tx.
   Both pins will be configured with a slow slew rate, and minimum drive
   strength.
   Note that the soc level iomuxc dts file can be examined to find the possible
   pinmux options. Here are the affects of each property on the
   IOMUXC SW_PAD_CTL register:
   input-schmitt-enable: HYS=1
   bias-pull-up: PUE=1, PE=1
   bias-pull-down: PUE=0, PE=1
   drive-open-drain: ODE=1
   slew-rate: FSEL=<enum_idx>
   drive-strength: DSE=<enum_idx>
   input-enable: SION=1 (in SW_MUX_CTL_PAD register)

   If only required properties are supplied, the pin will have the following
   configuration:
   HYS=0,
   PE=0
   PUE=0
   ODE=0,
   SRE=<slew-rate>,
   DSE=<drive-strength>,
   SION=0,

Properties
**********

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


These property descriptions apply to "nxp,imx8mp-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,imx8mp-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``
     - ``phandles``
     - .. code-block:: none

          Pin mux selections for this group. See the soc level iomuxc DTSI file
          for a defined list of these options.



       This property is **required**.

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

          Pin output drive strength. Sets the DSE field in the IOMUXC peripheral.
          00 X1- low drive strength
          01 X4- high drive strength
          10 X2- medium drive strength
          11 X6- max drive strength



       This property is **required**.

       Legal values: ``'x1'``, ``'x4'``, ``'x2'``, ``'x6'``

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

          Select slew rate for pin. Corresponds to SRE field in IOMUXC peripheral
          0 SLOW — Slow Frequency Slew Rate
          1 FAST — Fast Frequency Slew Rate



       This property is **required**.

       Legal values: ``'slow'``, ``'fast'``

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



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

          enable schmitt-trigger mode