xref: /linux/Documentation/devicetree/bindings/gpio/maxim,max31910.yaml (revision 205a7309cccd34ad49c2b6b1b59b907c12395d6c) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/gpio/maxim,max31910.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Maxim MAX3191x GPIO serializer
8
9maintainers:
10  - Lukas Wunner <lukas@wunner.de>
11
12properties:
13  compatible:
14    enum:
15      - maxim,max31910
16      - maxim,max31911
17      - maxim,max31912
18      - maxim,max31913
19      - maxim,max31953
20      - maxim,max31963
21
22  reg:
23    maxItems: 1
24
25  gpio-controller: true
26
27  '#gpio-cells':
28    const: 2
29
30  '#daisy-chained-devices':
31    description: Number of chips in the daisy-chain.
32    default: 1
33
34  maxim,modesel-gpios:
35    description:
36      GPIO pins to configure modesel of each chip. The number of GPIOs must
37      equal "#daisy-chained-devices" (if each chip is driven by a separate pin)
38      or 1 (if all chips are wired to the same pin).
39
40  maxim,fault-gpios:
41    description:
42      GPIO pins to read fault of each chip. The number of GPIOs must equal
43      "#daisy-chained-devices" or 1.
44
45  maxim,db0-gpios:
46    description:
47      GPIO pins to configure debounce of each chip. The number of GPIOs must
48      equal "#daisy-chained-devices" or 1.
49
50  maxim,db1-gpios:
51    description:
52      GPIO pins to configure debounce of each chip. The number of GPIOs must
53      equal "maxim,db0-gpios".
54
55  maxim,modesel-8bit:
56    description:
57      Boolean whether the modesel pin of the chips is pulled high (8-bit mode).
58      Use this if the modesel pin is hardwired and consequently
59      "maxim,modesel-gpios" cannot be specified. By default if neither this nor
60      "maxim,modesel-gpios" is given, the driver assumes that modesel is pulled
61      low (16-bit mode).
62    type: boolean
63
64  maxim,ignore-undervoltage:
65    description:
66      Boolean whether to ignore undervoltage alarms signaled by the
67      "maxim,fault-gpios" or by the status byte (in 16-bit mode). Use this if
68      the chips are powered through 5VOUT instead of VCC24V, in which case they
69      will constantly signal undervoltage.
70    type: boolean
71
72required:
73  - compatible
74  - reg
75  - gpio-controller
76  - '#gpio-cells'
77
78allOf:
79  - $ref: /schemas/spi/spi-peripheral-props.yaml#
80
81unevaluatedProperties: false
82
83examples:
84  - |
85    #include <dt-bindings/gpio/gpio.h>
86
87    spi {
88        #address-cells = <1>;
89        #size-cells = <0>;
90
91        gpio@0 {
92            compatible = "maxim,max31913";
93            reg = <0>;
94            gpio-controller;
95            #gpio-cells = <2>;
96
97            maxim,modesel-gpios = <&gpio2 23>;
98            maxim,fault-gpios   = <&gpio2 24 GPIO_ACTIVE_LOW>;
99            maxim,db0-gpios     = <&gpio2 25>;
100            maxim,db1-gpios     = <&gpio2 26>;
101
102            spi-max-frequency = <25000000>;
103        };
104    };
105