:orphan:
.. raw:: html
.. dtcompatible:: raspberrypi,rp1-pinctrl
.. _dtbinding_raspberrypi_rp1_pinctrl:
raspberrypi,rp1-pinctrl
#######################
.. sidebar:: Overview
:Name: ``raspberrypi,rp1-pinctrl``
:Vendor: :ref:`Raspberry Pi Foundation `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=raspberrypi,rp1-pinctrl>` using
this compatible
:Driver: :zephyr_file:`drivers/pinctrl/pinctrl_rp1.c`
Description
***********
.. code-block:: none
Raspberry Pi RP1 Pin Controller
RP1 I/O controller pinmux and pad configuration. The RP1 is the
peripheral controller used on the Raspberry Pi 5. Each controller bank
manages a group of GPIO pins and exposes the function selection and pad
control registers for those pins.
Properties
**********
Top level properties
====================
These property descriptions apply to "raspberrypi,rp1-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 "raspberrypi,rp1-pinctrl" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``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.
This property is **required**.
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"
This property is **required**.
* - ``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: ``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.
* - ``ranges``
- ``compound``
- .. code-block:: none
Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").
The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).
If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.
If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.
For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
* - ``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.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" 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.
* - ``dma-ranges``
- ``compound``
- .. code-block:: none
The dma-ranges provides a means of defining a mapping or translation between the
physical address space of the bus and the physical address space of the parent of the bus.
For details, see "2.3.9 dma-ranges" in Devicetree Specification v0.4.
* - ``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
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" 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
Pin mux selections, encoded using RP1_PINMUX() or signal-specific
macros such as RP1_UART0_TX_P14 defined in
:zephyr_file:`include/zephyr/dt-bindings/pinctrl/rp1-pinctrl.h`.
This property is **required**.
* - ``drive-strength``
- ``int``
- .. code-block:: none
Drive strength in mA. The value is encoded as an index in the
driver.
Default value: ``4``
Legal values: ``2``, ``4``, ``8``, ``12``
* - ``slew-rate``
- ``int``
- .. code-block:: none
Slew rate of a pin. 0 selects slow, 1 selects fast.
Default value: ``0``
Legal values: ``0``, ``1``
* - ``raspberrypi,f-m``
- ``int``
- .. code-block:: none
Value written to the RP1 GPIO control register F_M field.
Refer to the RP1 documentation for the meaning of each value.
Default value: ``4``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``raspberrypi,oe-override``
- ``int``
- .. code-block:: none
Override output-enable for a pin.
- 0 - drive output enable from selected peripheral signal.
- 1 - drive output enable from inverse of selected peripheral
signal.
- 2 - disable output.
- 3 - enable output.
The default value is 0, as this is the power on reset value.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``raspberrypi,out-override``
- ``int``
- .. code-block:: none
Override output for a pin.
- 0 - drive output from selected peripheral signal.
- 1 - drive output from inverse of selected peripheral signal.
- 2 - drive output low.
- 3 - drive output high.
The default value is 0, as this is the power on reset value.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``raspberrypi,in-override``
- ``int``
- .. code-block:: none
Override input for a pin.
- 0 - input comes from the selected pin.
- 1 - input comes from the inverse of the selected pin.
- 2 - force input low.
- 3 - force input high.
The default value is 0, as this is the power on reset value.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``raspberrypi,irq-override``
- ``int``
- .. code-block:: none
Override interrupt signal for a pin.
- 0 - interrupt signal from the selected pin.
- 1 - interrupt signal from the inverse of the selected pin.
- 2 - force interrupt low.
- 3 - force interrupt high.
The default value is 0, as this is the power on reset value.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``raspberrypi,irqmask-edge-low``
- ``boolean``
- .. code-block:: none
Enable interrupt on falling edge.
* - ``raspberrypi,irqmask-edge-high``
- ``boolean``
- .. code-block:: none
Enable interrupt on rising edge.
* - ``raspberrypi,irqmask-level-low``
- ``boolean``
- .. code-block:: none
Enable interrupt on low level.
* - ``raspberrypi,irqmask-level-high``
- ``boolean``
- .. code-block:: none
Enable interrupt on high level.
* - ``raspberrypi,irqmask-f-edge-low``
- ``boolean``
- .. code-block:: none
Enable filtered interrupt on falling edge.
* - ``raspberrypi,irqmask-f-edge-high``
- ``boolean``
- .. code-block:: none
Enable filtered interrupt on rising edge.
* - ``raspberrypi,irqmask-db-level-low``
- ``boolean``
- .. code-block:: none
Enable debounced interrupt on low level.
* - ``raspberrypi,irqmask-db-level-high``
- ``boolean``
- .. code-block:: none
Enable debounced interrupt on high level.
* - ``bias-disable``
- ``boolean``
- .. code-block:: none
disable any pin bias
* - ``bias-pull-up``
- ``boolean``
- .. code-block:: none
enable pull-up resistor
* - ``bias-pull-down``
- ``boolean``
- .. code-block:: none
enable pull-down resistor
* - ``input-enable``
- ``boolean``
- .. code-block:: none
enable input on pin (e.g. enable an input buffer, no effect on output)
* - ``input-schmitt-enable``
- ``boolean``
- .. code-block:: none
enable schmitt-trigger mode
* - ``output-disable``
- ``boolean``
- .. code-block:: none
disable output on a pin (e.g. disable an output buffer)