: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:: nuvoton,npcx-pinctrl
.. _dtbinding_nuvoton_npcx_pinctrl:

nuvoton,npcx-pinctrl
####################

Vendor: :ref:`Nuvoton Technology Corporation <dt_vendor_nuvoton>`

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



.. code-block:: none

   The Nuvoton pin controller is a singleton node responsible for controlling
   pin function selection and pin properties. For example, you can use these
   nodes to select peripheral pin functions.

   Here is a list of supported standard pin properties:
     - bias-pull-down: Enable pull-down resistor.
     - bias-pull-up: Enable pull-up resistor.
     - drive-open-drain: Output driver is open-drain.

   Custom pin properties for npcx series are available also:
     - pinmux-locked: Lock pinmux configuration for peripheral device
     - pinmux-gpio: Inverse pinmux back to gpio

   An example for NPCX7 family, include the chip level pinctrl DTSI file in the
   board level DTS:

     #include <nuvoton/npcx/npcx7/npcx7-pinctrl.dtsi>

   We want to use the I2C0_0 port of the NPCX7M6FB controller and enable the
   internal 3.3V pull-up if its i2c frequency won't exceed 400kHz.

   To change a pin's pinctrl default properties, add a reference to the
   pin in the board's DTS file and set the properties as below:

     &i2c0_0_sda_scl_gpb4_b5 {
       bias-pull-up; /* Enable internal pull-up for i2c0_0 */
       pinmux-locked; /* Lock pinmuxing */
     };

     &i2c0_0 {
       pinctrl-0 = <&i2c0_0_sda_scl_gpb4_b5>;
       pinctrl-names = "default";
     }

Properties
**********

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


These property descriptions apply to "nuvoton,npcx-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 "nuvoton,npcx-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:`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``
           - ``array``
           - .. code-block:: none

                register space


             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.

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






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

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

   * - Name
     - Type
     - Details

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

          Configurations of pinmux selection


   * - ``periph-pupd``
     - ``array``
     - .. code-block:: none

          A map to PUPD_ENn register/bit that enable pull-up/down of NPCX peripheral devices.
          Please don't overwrite this property in the board-level DT driver.



   * - ``pinmux-locked``
     - ``boolean``
     - .. code-block:: none

          Lock pinmux selection


   * - ``pinmux-gpio``
     - ``boolean``
     - .. code-block:: none

          Inverse pinmux selection to GPIO


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