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 |
---|---|---|
|
|
Number of items to expect in a GPIO specifier
This property is required. Constant value: |
|
|
Number of gpios supported
This property is required. Default value: Constant value: |
|
|
Ready pin which show when chip is ready
|
|
|
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 the data so it could be read (partially duplicate CS)
|
|
|
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: |
|
|
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: |
|
|
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: |
|
|
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: |
|
|
Convey's this node is a GPIO controller
This property is required. |
|
|
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>.
|
|
|
This is an array of strings defining the names of the GPIO lines
going out of the GPIO controller
|
|
|
Maximum clock frequency of device's SPI interface in Hz
This property is required. |
|
|
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: |
|
|
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: |
|
|
SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
Deprecated properties not inherited from the base binding file.
(None)
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.
Name |
Type |
Details |
---|---|---|
|
|
register space
This property is required. See Important properties for more information. |
|
|
indicates the operational status of a device
Legal values: See Important properties for more information. |
|
|
compatible strings
This property is required. See Important properties for more information. |
|
|
name of each register space
|
|
|
interrupts for device
See Important properties for more information. |
|
|
extended interrupt specifier for device
|
|
|
name of each interrupt
|
|
|
phandle to interrupt controller node
|
|
|
No description provided for this label
See Important properties for more information. |
|
|
Clock gate information
|
|
|
name of each clock
|
|
|
number of address cells in reg property
|
|
|
number of size cells in reg property
|
|
|
DMA channels specifiers
|
|
|
Provided names of DMA channel specifiers
|
|
|
IO channels specifiers
|
|
|
Provided names of IO channel specifiers
|
|
|
mailbox / IPM channels specifiers
|
|
|
Provided names of mailbox / IPM channel specifiers
|
|
|
Power domain specifiers
|
|
|
Provided names of power domain specifiers
|
|
|
Number of cells in power-domains property
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
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.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|
Child node properties
Name |
Type |
Details |
---|---|---|
|
|
Conveys this node is a GPIO hog.
This property is required. |
|
|
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. |
|
|
If this property is set, the GPIO is configured as an input. This property takes
precedence over the output-low and output-high properties.
|
|
|
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.
|
|
|
If this property is set, the GPIO is configured as an output set to logical high.
|
|
|
Optional GPIO line name.
|
Specifier cell names
gpio cells: pin, flags