:orphan:
.. raw:: html
<!--
FIXME: do not limit page width until content uses another representation
format other than tables
-->
<style>.wy-nav-content { max-width: none; !important }</style>
.. dtcompatible:: digilent,pmod-header
.. _dtbinding_digilent_pmod_header:
digilent,pmod-header
####################
Vendor: :ref:`Digilent, Inc. <dt_vendor_digilent>`
Description
***********
.. code-block:: none
GPIO pins exposed on Digilent Pmod header.
The Pmod layout provides standard 100mil spaced, 25mil square,
pin-header style 6-pin (Spec A/C) or 12-pin (Spec B/D) connectors
with currently 7 pin assignments to support different use cases
for GPIO (Type 1), SPI, (Type 2), UART (Type 3), H-Bridge (Type 4),
Dual H-Bridge (Type 5), I2C (Type 6), I2S (Type 7).
The peripheral module board will have a male connector. This will
typically be a right-angle connector, at the board edge, for direct
connection to a host board. The host board will typically have a
12-pin right-angle female connector at the board edge for direct
connection of peripheral module boards.
The power pins of the interface (VCC) provide power from the host to
the peripheral. The complete interface requires that the host provide
the ability to switch the voltage on the power pins between 5V and
3.3V. A reduced functionality subset of the specification allows the
host to provide only 3.3V at the power supply pins, with no ability
to switch. On the 12-pin version of the interface, both power supply
pins switch together and always supply the same voltage. These pins
may be shorted together at either the host end or the peripheral side.
Pin assignment and all specifications can be found at:
https://digilent.com/reference/pmod/start
This binding provides a nexus mapping for 8 pins where parent
pins 0 through 7 correspond as depicted below depending on
related "Spec" and "Type":
(Spec B/D) 12-pin 6-pin (Spec A/C)
| \ /
| |
GPIO (Types 1/1A): IO5 4 0 IO1
(PWM) IO6 5 1 IO2 (PWM)
IO7 6 2 IO3
IO8 7 3 IO4
GND - - GND
VCC - - VCC
SPI (Types 2/2A): (INT) IO5 4 0 CS
(RESET) IO6 5 1 MOSI
(CS2) IO7 6 2 MISO
(CS3) IO8 7 3 SCK
GND - - GND
VCC - - VCC
UART (Types 3/3A): (INT) IO5 4 0 CTS (IO1)
(RESET) IO6 5 1 TXD
IO7 6 2 RXD
IO8 7 3 RTS (IO4)
GND - - GND
VCC - - VCC
H-Bridge (Types 4): 0 DIR
1 EN (PWM)
2 SA
3 SB
- GND
- VCC
Dual H-Bridge (Types 5): 0 DIR1
1 EN1
2 DIR2
3 EN2
- GND
- VCC
Dual H-Bridge (Types 5A): DIR2 4 0 DIR1
(PWM) EN2 5 1 EN1 (PWM)
S2A 6 2 S1A
S2B 7 3 S1B
GND - - GND
VCC - - VCC
I2C (Types 6/6A): IO5 4 0 N/C (IO1) (INT)
IO6 5 1 N/C (IO2) (RESET)
IO7 6 2 SCL
IO8 7 3 SDA
GND - - GND
VCC - - VCC
I2S (Types 7): IO5 4 0 LRCLK
IO6 5 1 DAC Data
(MCLK) IO7 6 2 ADC Data
IO8 7 3 BCLK
GND - - GND
VCC - - VCC
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 "digilent,pmod-header" 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 <u32> 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 <u32> 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.