:orphan:
.. raw:: html
.. dtcompatible:: intel,gpio
.. _dtbinding_intel_gpio:
intel,gpio
##########
Vendor: :ref:`Intel Corporation `
Description
***********
.. code-block:: none
Intel GPIO node
Properties
**********
Top level properties
====================
These property descriptions apply to "intel,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
* - ``acpi-hid``
- ``string``
- .. code-block:: none
Used to supply OSPM with the device’s PNP ID or ACPI ID. A node is consder as acpi based or not based on whether this property is present or not.
* - ``acpi-uid``
- ``string``
- .. code-block:: none
Provides OSPM with a logical device ID that does not change
across reboots. This object is optional, but is required when the device
has no other way to report a persistent unique device ID. The _UID must be
unique across all devices with either a common _HID or _CID.
* - ``acpi-comp-id``
- ``string-array``
- .. code-block:: none
Used to supply OSPM with a device’s Plug and Play-Compatible Device ID
* - ``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
Number of pins for this GPIO entry
Default value: ``32``
* - ``gpio-reserved-ranges``
- ``array``
- .. code-block:: none
If not all the GPIOs at offsets 0...N-1 are usable for ngpios = , 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
* - ``group-index``
- ``int``
- .. code-block:: none
Group number for this GPIO entry
* - ``pin-offset``
- ``int``
- .. code-block:: none
Pin offset of this GPIO entry
.. 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 "intel,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:`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
reg properties not required if acpi enumerated
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 properties not required if acpi enumerated
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.
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