:orphan:
.. raw:: html
.. dtcompatible:: ambiq,apollo5-pinctrl
.. _dtbinding_ambiq_apollo5_pinctrl:
ambiq,apollo5-pinctrl
#####################
Vendor: :ref:`Ambiq Micro, Inc. `
Description
***********
.. code-block:: none
Ambiq Apollo5 Pin Controller
Singleton node responsible for controlling pin function selection and pin
properties, such as routing a UART0 TX to pin 60 and enabling the pullup
resistor on that pin.
The node has the 'pinctrl' node label set in your SoC's devicetree,
so you can modify it like this:
&pinctrl {
/* your modifications go here */
};
All device pin configurations should be placed in child nodes of the
'pinctrl' node, as shown in this example:
/* You can put this in places like a board-pinctrl.dtsi file in
* your board directory, or a devicetree overlay in your application.
*/
/* include pre-defined combinations for the SoC variant used by the board */
#include
&pinctrl {
uart0_default: uart0_default {
group1 {
pinmux = ;
};
group2 {
pinmux = ;
input-enable;
};
};
};
The 'uart0_default' child node encodes the pin configurations for a
particular state of a device; in this case, the default (that is, active)
state.
As shown, pin configurations are organized in groups within each child node.
Each group can specify a list of pin function selections in the 'pinmux'
property.
A group can also specify shared pin properties common to all the specified
pins, such as the 'input-enable' property in group 2.
Properties
**********
Top level properties
====================
These property descriptions apply to "ambiq,apollo5-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 "ambiq,apollo5-pinctrl" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``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.
* - ``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.
Grandchild node properties
==========================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``pinmux``
- ``array``
- .. code-block:: none
An array of pins sharing the same group properties. Each
element of the array is an integer constructed from the
pin number and the alternative function of the pin.
This property is **required**.
* - ``drive-strength``
- ``string``
- .. code-block:: none
The drive strength of a pin, relative to full-driver strength.
The default value is 0.1, which is the reset value.
Default value: ``0.1``
Legal values: ``'0.1'``, ``'0.5'``, ``'0.75'``, ``'1.0'``
* - ``ambiq,pull-up-ohms``
- ``int``
- .. code-block:: none
The pullup resistor value. The default value is 1500 ohms.
Default value: ``1500``
Legal values: ``1500``, ``6000``, ``12000``, ``24000``, ``50000``, ``100000``
* - ``ambiq,nce-src``
- ``int``
- .. code-block:: none
IOM0CE0 = 0x0 - IOM 0 NCE 0 module
IOM0CE1 = 0x1 - IOM 0 NCE 1 module
IOM0CE2 = 0x2 - IOM 0 NCE 2 module
IOM0CE3 = 0x3 - IOM 0 NCE 3 module
IOM1CE0 = 0x4 - IOM 1 NCE 0 module
IOM1CE1 = 0x5 - IOM 1 NCE 1 module
IOM1CE2 = 0x6 - IOM 1 NCE 2 module
IOM1CE3 = 0x7 - IOM 1 NCE 3 module
IOM2CE0 = 0x8 - IOM 2 NCE 0 module
IOM2CE1 = 0x9 - IOM 2 NCE 1 module
IOM2CE2 = 0xA - IOM 2 NCE 2 module
IOM2CE3 = 0xB - IOM 2 NCE 3 module
IOM3CE0 = 0xC - IOM 3 NCE 0 module
IOM3CE1 = 0xD - IOM 3 NCE 1 module
IOM3CE2 = 0xE - IOM 3 NCE 2 module
IOM3CE3 = 0xF - IOM 3 NCE 3 module
IOM4CE0 = 0x10 - IOM 4 NCE 0 module
IOM4CE1 = 0x11 - IOM 4 NCE 1 module
IOM4CE2 = 0x12 - IOM 4 NCE 2 module
IOM4CE3 = 0x13 - IOM 4 NCE 3 module
IOM5CE0 = 0x14 - IOM 5 NCE 0 module
IOM5CE1 = 0x15 - IOM 5 NCE 1 module
IOM5CE2 = 0x16 - IOM 5 NCE 2 module
IOM5CE3 = 0x17 - IOM 5 NCE 3 module
IOM6CE0 = 0x18 - IOM 6 NCE 0 module
IOM6CE1 = 0x19 - IOM 6 NCE 1 module
IOM6CE2 = 0x1A - IOM 6 NCE 2 module
IOM6CE3 = 0x1B - IOM 6 NCE 3 module
IOM7CE0 = 0x1C - IOM 7 NCE 0 module
IOM7CE1 = 0x1D - IOM 7 NCE 1 module
IOM7CE2 = 0x1E - IOM 7 NCE 2 module
IOM7CE3 = 0x1F - IOM 7 NCE 3 module
DC_DPI_DE = 0x30 - DC DPI DE module
DISP_CONT_CSX = 0x31 - DISP CONT CSX module
DC_SPI_CS_N = 0x32 - DC SPI CS_N module
DC_QSPI_CS_N = 0x33 - DC QSPI CS_N module
DC_RESX = 0x34 - DC module RESX
* - ``ambiq,nce-pol``
- ``int``
- .. code-block:: none
Polarity select for NCE
LOW = 0x0 - Polarity is active low
HIGH = 0x1 - Polarity is active high
* - ``ambiq,sdif-cdwp``
- ``int``
- .. code-block:: none
Configure SD Card Detection and Write Protection pin
0x0 - Not SDIF pin
0x1 - SDIF0CD
0x2 - SDIF0WP
0x3 - SDIF1CD
0x4 - SDIF1WP
* - ``bias-high-impedance``
- ``boolean``
- .. code-block:: none
high impedance mode ("third-state", "floating")
* - ``bias-pull-up``
- ``boolean``
- .. code-block:: none
enable pull-up resistor
* - ``bias-pull-down``
- ``boolean``
- .. code-block:: none
enable pull-down resistor
* - ``drive-push-pull``
- ``boolean``
- .. code-block:: none
drive actively high and low
* - ``drive-open-drain``
- ``boolean``
- .. code-block:: none
drive with open drain (hardware AND)
* - ``input-enable``
- ``boolean``
- .. code-block:: none
enable input on pin (e.g. enable an input buffer, no effect on output)