:orphan:
.. raw:: html
.. dtcompatible:: digilent,pmod-header
.. _dtbinding_digilent_pmod_header:
digilent,pmod-header
####################
Vendor: :ref:`Diglent, Inc. `
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 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.