NXP S32 GPIO Controller 바인딩

: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,s32-gpio
.. _dtbinding_nxp_s32_gpio:

nxp,s32-gpio
############

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

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



.. code-block:: none

   NXP S32 GPIO controller.

   The GPIO controller provides the option to route external input pad interrupts
   to either the SIUL2 EIRQ interrupt controller or, when available on the SoC,
   the WKPU interrupt controller. By default, GPIO interrupts are routed to the
   SIUL2 EIRQ interrupt controller.

   To route external interrupts to the WKPU interrupt controller, the GPIO
   specifier must be supplied with the flag `NXP_S32_GPIO_INT_WKPU`. For example,
   the following snippet of devicetree source code instructs the GPIO controller
   to route the interrupt from pin 9 of `gpioa` to the WKPU interrupt controller:

     #include <zephyr/dt-bindings/gpio/nxp-s32-gpio.h>

     &device {
         gpios = <&gpioa 9 (NXP_S32_GPIO_INT_WKPU | GPIO_ACTIVE_HIGH)>;
     };

   Explicitly specifying the routing of a GPIO interrupt to a particular
   interrupt controller allows for the allocation of distinct interrupt
   priorities according to application-specific requirements. This is owing to
   the fact that each interrupt controller features its own interrupt vector.
   To illustrate, it is plausible to allocate the board's button interrupts to
   the interrupt controller configured with a lower priority compared to the one
   designated for the data-ready interrupt originating from a sensor. This
   decision is justified by the potentially higher importance of the latter
   interrupt to the overall system operation.

   The `NXP_S32_GPIO_INT_WKPU` flag is intended exclusively for specifying WKPU
   as the interrupt controller for the corresponding GPIO. It's worth noting that
   despite being named WKPU, the flag is not meant to configure GPIOs as wake-up
   sources.

Properties
**********

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


These property descriptions apply to "nxp,s32-gpio"
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.

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

         * - Name
           - Type
           - Details

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

                Convey's this node is a GPIO controller


             This property is **required**.

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

                Number of items to expect in a GPIO specifier


             This property is **required**.

             Constant value: ``2``

         * - ``ngpios``
           - ``int``
           - .. code-block:: none

                This property indicates the number of in-use slots of available slots
                for GPIOs. The typical example is something like this: the hardware
                register is 32 bits wide, but only 18 of the bits have a physical
                counterpart. The driver is generally written so that all 32 bits can
                be used, but the IP block is reused in a lot of designs, some using
                all 32 bits, some using 18 and some using 12. In this case, setting
                "ngpios = <18>;" informs the driver that only the first 18 GPIOs, at
                local offset 0 .. 17, are in use.  For cases in which there might be
                holes in the slot range, this value should be the max slot number+1.



             Default value: ``32``

         * - ``gpio-reserved-ranges``
           - ``array``
           - .. code-block:: none

                If not all the GPIOs at offsets 0...N-1 are usable for ngpios = <N>, then
                this property contains an additional set of tuples which specify which GPIOs
                are unusable. This property indicates the start and size of the GPIOs
                that can't be used.

                For example, setting "gpio-reserved-ranges = <3 2>, <10 1>;" means that
                GPIO offsets 3, 4, and 10 are not usable, even if ngpios = <18>.



         * - ``gpio-line-names``
           - ``string-array``
           - .. code-block:: none

                This is an array of strings defining the names of the GPIO lines
                going out of the GPIO controller



         * - ``nxp,wkpu``
           - ``phandle``
           - .. code-block:: none

                NXP WKPU controller associated to this GPIO port.



         * - ``nxp,wkpu-interrupts``
           - ``array``
           - .. code-block:: none

                Map between WKPU external interrupt sources and pins of this GPIO port,
                as in a tuple `<gpio-pin wkpu-interrupt-source>`.





   .. 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,s32-gpio" compatible.

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

         * - Name
           - Type
           - Details

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



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



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


             This property is **required**.

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

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

                name of each register space


             This property is **required**.

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

                For GPIO ports that have pins can be used for processing
                external interrupt signal, this is a list of GPIO pins and
                respective external interrupt lines (<gpio-pin eirq-line>).



             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


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().






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

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

   * - Name
     - Type
     - Details

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

          Conveys this node is a GPIO hog.



       This property is **required**.

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

          This is an array of GPIO specifiers (e.g. pin, flags) to be hogged. The number of array
          entries must be an integer multiple of the number of GPIO specifier cells for the parent
          GPIO controller.



       This property is **required**.

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

          If this property is set, the GPIO is configured as an input. This property takes
          precedence over the output-low and output-high properties.



   * - ``output-low``
     - ``boolean``
     - .. code-block:: none

          If this property is set, the GPIO is configured as an output set to logical low. This
          property takes precedence over the output-high property.



   * - ``output-high``
     - ``boolean``
     - .. code-block:: none

          If this property is set, the GPIO is configured as an output set to logical high.



   * - ``line-name``
     - ``string``
     - .. code-block:: none

          Optional GPIO line name.



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

- gpio cells: pin, flags