:orphan:
.. raw:: html
.. dtcompatible:: adi,max22190-gpio
.. _dtbinding_adi_max22190_gpio:
adi,max22190-gpio (on spi bus)
##############################
Vendor: :ref:`Analog Devices, Inc. `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/gpio/gpio_max22190.c`.
Description
***********
.. code-block:: none
ADI MAX22190 octal industrial Input with advanced diagnostic
capabilities like Wire break and over/under volatage.
Fiter configuration could be done on per channel bases, which
mean WB functionality and filters could be set. Reffering to:
filter-wbes = for wire break
To enable wire break set 1 else 0. Same principle is followed for:
filter-fbps and filter-delays.
Sample binding
&sdp_spi {
status = "okay";
pinctrl-names = "default";
max22190_gpio0: max22190_gpio@0 {
compatible = "adi,max22190-gpio";
reg = <0>;
spi-max-frequency = <1000000>;
status = "okay";
gpio-controller;
#gpio-cells = <2>;
ngpios = <8>;
status = "okay";
max22190-mode = <1>; // modes range from 0-4
drdy-gpios = <&gpioj 12 GPIO_ACTIVE_LOW>; /* SDP-GPIO5 - PMOD-PIN8 */
fault-gpios = <&gpioc 11 GPIO_ACTIVE_LOW>; /* SDP-SERIAL_INT - PMOD-PIN7 */
latch-gpios = <&gpioj 13 GPIO_ACTIVE_LOW>; /* SDP-GPIO6 - PMOD-PIN9 */
filter-wbes = <1 0 0 0 0 0 0 0>; // wirebreak WBEx
filter-fbps = <0 0 0 0 0 0 0 0>; // programmable filter INx
filter-delays = <50 100 400 800 1600 3200 12800 20000>; // 1000 us == 1ms
};
};
Properties
**********
Top level properties
====================
These property descriptions apply to "adi,max22190-gpio"
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.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``#gpio-cells``
- ``int``
- .. code-block:: none
Number of items to expect in a GPIO specifier
This property is **required**.
Constant value: ``2``
* - ``ngpios``
- ``int``
- .. code-block:: none
Number of gpios supported
This property is **required**.
Default value: ``32``
Constant value: ``8``
* - ``drdy-gpios``
- ``phandle-array``
- .. code-block:: none
Ready pin which show when chip is ready
* - ``fault-gpios``
- ``phandle-array``
- .. code-block:: none
Fault pin indicates when there is Fault state in either FAULT1 or FAULT2
bothe of which are cleaned on read once problem is not persistent
* - ``latch-gpios``
- ``phandle-array``
- .. code-block:: none
Latch the data so it could be read (partially duplicate CS)
* - ``max22190-mode``
- ``int``
- .. code-block:: none
Default mode set to 1, because in MAX22190PMB devkit this is hardwired
mode set by manufacturer.
max22190 mode is configured from M0 and M1 pins with
pull up or down resistors.
MODE| M1| M0| FRAME | CRC | DAISY CHAIN
----+---+---+--------+-----+------------
0 | 0 | 0 | 24-bit | yes | no
1 | 0 | 1 | 16-bit | no | no
2 | 1 | 0 | 24-bit | yes | yes
3 | 1 | 1 | 16-bit | no | yes
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``filter-wbes``
- ``array``
- .. code-block:: none
The default value corresponds to the default value of the hardware.
Wire break is disabled in all channels.
WBE bit in all Filter registers stand for wire break enable on each
channel, so to enable WB functionality set 1.
If WB on specific channel is disabled , FAULT will not be rised in case
wire is cut.
- 1 wire break enable
- 0 wire break disable
channels indentation start from CH0...CH7
Default value: ``[0, 0, 0, 0, 0, 0, 0, 0]``
* - ``filter-fbps``
- ``array``
- .. code-block:: none
The default value corresponds to the default value of the hardware.
All channels are in bypass.
Enable or disable filter
- 1 mean bypass
- 0 mean filter is used
channels indentation start from CH0...CH7
Default value: ``[1, 1, 1, 1, 1, 1, 1, 1]``
* - ``filter-delays``
- ``array``
- .. code-block:: none
The default value corresponds to the default value of the hardware.
Used to setup filter delay. Values are set in us. Default value is 50 = 50 us.
Value : 50, 100, 400, 800, 1600, 3200, 12800, 20000
channels indentation start from CH0...CH7
Default value: ``[50, 50, 50, 50, 50, 50, 50, 50]``
* - ``gpio-controller``
- ``boolean``
- .. code-block:: none
Convey's this node is a GPIO controller
This property is **required**.
* - ``gpio-reserved-ranges``
- ``array``
- .. code-block:: none
If not all the GPIOs at offsets 0...N-1 are usable for ngpios = , then
this property contains an additional set of tuples which specify which GPIOs
are unusable. This property indicates the start and size of the GPIOs
that can't be used.
For example, setting "gpio-reserved-ranges = <3 2>, <10 1>;" means that
GPIO offsets 3, 4, and 10 are not usable, even if ngpios = <18>.
* - ``gpio-line-names``
- ``string-array``
- .. code-block:: none
This is an array of strings defining the names of the GPIO lines
going out of the GPIO controller
* - ``spi-max-frequency``
- ``int``
- .. code-block:: none
Maximum clock frequency of device's SPI interface in Hz
This property is **required**.
* - ``duplex``
- ``int``
- .. code-block:: none
Duplex mode, full or half. By default it's always full duplex thus 0
as this is, by far, the most common mode.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
0 SPI_FULL_DUPLEX
2048 SPI_HALF_DUPLEX
Legal values: ``0``, ``2048``
* - ``frame-format``
- ``int``
- .. code-block:: none
Motorola or TI frame format. By default it's always Motorola's,
thus 0 as this is, by far, the most common format.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
0 SPI_FRAME_FORMAT_MOTOROLA
32768 SPI_FRAME_FORMAT_TI
Legal values: ``0``, ``32768``
* - ``spi-cpol``
- ``boolean``
- .. code-block:: none
SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.
* - ``spi-cpha``
- ``boolean``
- .. code-block:: none
SPI clock phase that indicates on which edge data is sampled.
If it is used, data is sampled on the second edge; otherwise, on the first edge.
* - ``spi-hold-cs``
- ``boolean``
- .. code-block:: none
In some cases, it is necessary for the master to manage SPI chip select
under software control, so that multiple spi transactions can be performed
without releasing it. A typical use case is variable length SPI packets
where the first spi transaction reads the length and the second spi transaction
reads length bytes.
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO specifier that controls power to the device.
This property should be provided when the device has a dedicated
switch that controls power to the device. The supply state is
entirely the responsibility of the device driver.
Contrast with vin-supply.
* - ``vin-supply``
- ``phandle``
- .. code-block:: none
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.
This property should be provided when device power is supplied
by a shared regulator. The supply state is dependent on the
request status of all devices fed by the regulator.
Contrast with supply-gpios. If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.
.. 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 "adi,max22190-gpio" 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.
* - ``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-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.
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``gpio-hog``
- ``boolean``
- .. code-block:: none
Conveys this node is a GPIO hog.
This property is **required**.
* - ``gpios``
- ``array``
- .. code-block:: none
This is an array of GPIO specifiers (e.g. pin, flags) to be hogged. The number of array
entries must be an integer multiple of the number of GPIO specifier cells for the parent
GPIO controller.
This property is **required**.
* - ``input``
- ``boolean``
- .. code-block:: none
If this property is set, the GPIO is configured as an input. This property takes
precedence over the output-low and output-high properties.
* - ``output-low``
- ``boolean``
- .. code-block:: none
If this property is set, the GPIO is configured as an output set to logical low. This
property takes precedence over the output-high property.
* - ``output-high``
- ``boolean``
- .. code-block:: none
If this property is set, the GPIO is configured as an output set to logical high.
* - ``line-name``
- ``string``
- .. code-block:: none
Optional GPIO line name.
Specifier cell names
********************
- gpio cells: pin, flags