adi,max22190-gpio (on spi bus)

Vendor: Analog Devices, Inc.

Note

An implementation of a driver matching this compatible is available in drivers/gpio/gpio_max22190.c.

Description

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 = <CH0 CH1 CH2 ... CH7 >  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.

Properties not inherited from the base binding file.

Name

Type

Details

#gpio-cells

int

Number of items to expect in a GPIO specifier

This property is required.

Constant value: 2

ngpios

int

Number of gpios supported

This property is required.

Default value: 32

Constant value: 8

drdy-gpios

phandle-array

Ready pin which show when chip is ready

fault-gpios

phandle-array

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

Latch the data so it could be read (partially duplicate CS)

max22190-mode

int

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

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

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

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

Convey's this node is a GPIO controller

This property is required.

gpio-reserved-ranges

array

If not all the GPIOs at offsets 0...N-1 are usable for ngpios = <N>, 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

This is an array of strings defining the names of the GPIO lines
going out of the GPIO controller

spi-max-frequency

int

Maximum clock frequency of device's SPI interface in Hz

This property is required.

duplex

int

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

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

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

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

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

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

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.

Child node properties

Name

Type

Details

gpio-hog

boolean

Conveys this node is a GPIO hog.

This property is required.

gpios

array

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

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

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

If this property is set, the GPIO is configured as an output set to logical high.

line-name

string

Optional GPIO line name.

Specifier cell names

  • gpio cells: pin, flags