:orphan:
.. raw:: html
.. dtcompatible:: ambiq-header
.. _dtbinding_ambiq_header:
ambiq-header
############
Vendor: :ref:`Generic or vendor-independent `
Description
***********
.. code-block:: none
GPIO pins exposed on Ambiq Apollo4p EVB headers
The Ambiq Apollo4p EVB layout provides 5x16 and 1x20 pin headers.
The binding provides a nexus mapping for these pins as depicted below.
J7 J12
VDD_MCU - VDD_MCU - GPIO22 22 GND -
VDD_EXT - VDD_EXT - GPIO23 23 GPIO24 24
nRST - GND - VDD_MCU - GND -
VDD_EXT - VDD_EXT - GND - GPIO64 64
VDD_5V - VDD_5V - GPIO61 61 GPIO65 65
GND - GND - GPIO63 63 GPIO66 66
GND - GPIO100 100 GPIO62 62 GPIO67 67
VDDH2 - GPIO97 97 GPIO47 47 GPIO68 68
GPIO49 49 GPIO69 69
J9 GPIO48 48 GPIO70 70
GPIO19 19 GPIO96 96 J11
GPIO18 18 GPIO95 95
GPIO17 17 GPIO98 98 GPIO53 53 GPIO71 71
GPIO16 16 GPIO99 99 GPIO52 52 GPIO72 72
GPIO15 15 GPIO102 102 GPIO91 91 GPIO73 73
GPIO14 14 GPIO34 34 GPIO90 90 GPIO93 93
GPIO13 13 GPIO35 35 GPIO11 11 GPIO92 92
GPIO12 12 GPIO36 36 GPIO10 10 GPIO33 33
GPIO8 8 GPIO32 32
GPIO9 9 GPIO31 31
J10
GPIO28 28 GPIO60 60
GPIO30 30 GPIO59 59
GPIO94 94 GPIO58 58
GPIO55 55 GPIO7 7
GPIO0 0 GPIO54 54
GPIO51 51 GPIO1 1
GPIO2 2 GPIO50 50
GPIO3 3 GPIO4 4
Voltage Header
VDD_EXT - VDD_5V -
GND - GND -
BIAS - BIAS -
GND - AUDA -
GND - GND -
D1P - DON -
D1N - DOP -
GND - GND -
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 "ambiq-header" 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.
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.