:orphan:
.. raw:: html
.. dtcompatible:: sparkfun,micromod-gpio
.. _dtbinding_sparkfun_micromod_gpio:
sparkfun,micromod-gpio
######################
Vendor: :ref:`SparkFun Electronics, Inc. `
Description
***********
.. code-block:: none
GPIO pins exposed on micromod headers.
The micromod standard leverages the M.2 connector with 76 pins for
swap between a myriad of supported boards and carriers.
The micromod standard consists of two lanes with the following
supported buses:
* An 6-pin Power Supply header. No pins on this header are exposed
by this binding.
* Reset, Boot pins and SWD pins not exposed by this binding.
* 2 UART buses. First with RTS and CTS pins, while the 2nd with only
RX and TX pins. Neither of them are exposed by this binding.
* 2 i2c buses. Only the corresponding interrupt pin is exposed by
this binding.
* 2 SPI buses not exposed by this binding. Only SPI CS control pin
is exposed by this binding.
* Audio line not exposed by this binding.
* 2 analog pins (A0 and A1).
* 2 digital pins (D0 and D1).
* 12 General purpose pins (G0 - G11).
This binding provides a nexus mapping for the analog, digital and
general purpose gpios in the order depicted below:
- 00 -> A0 PIN 34
- 01 -> A1 PIN 38
- 02 -> D0 PIN 10
- 03 -> D1/CAM_TRIG PIN 18
- 04 -> I2C_INT# PIN 16
- 05 -> G0/BUS0 PIN 40
- 06 -> G1/BUS1 PIN 42
- 07 -> G2/BUS2 PIN 44
- 08 -> G3/BUS3 PIN 46
- 09 -> G4/BUS4 PIN 48
- 10 -> G5/BUS5 PIN 73
- 11 -> G6/BUS6 PIN 71
- 12 -> G7/BUS7 PIN 69
- 13 -> G8 PIN 67
- 14 -> G9/ADC_D-/CAM_HSYNC PIN 65
- 15 -> G10/ADC_D+/CAM_VSYNC PIN 63
- 16 -> G11/SWO PIN 8
- 17 -> SPI_CS PIN 55
Properties
**********
.. 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-map``
- ``compound``
- This property is **required**.
* - ``gpio-map-mask``
- ``compound``
-
* - ``gpio-map-pass-thru``
- ``compound``
-
* - ``#gpio-cells``
- ``int``
- .. code-block:: none
Number of items to expect in a GPIO specifier
This property is **required**.
.. 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 "sparkfun,micromod-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
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.
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().