| Message ID | 20250318-mdb-max7360-support-v5-1-fb20baf97da0@bootlin.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Add support for MAX7360 | expand |
On Tue, Mar 18, 2025 at 05:26:17PM +0100, Mathieu Dubois-Briand wrote: > Add device tree bindings for Maxim Integrated MAX7360 device with > support for keypad, rotary, gpios and pwm functionalities. > > Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> > --- > .../bindings/gpio/maxim,max7360-gpio.yaml | 83 ++++++++++ > .../devicetree/bindings/mfd/maxim,max7360.yaml | 170 +++++++++++++++++++++ > 2 files changed, 253 insertions(+) > > diff --git a/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml > new file mode 100644 > index 000000000000..21d603d9504c > --- /dev/null > +++ b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml > @@ -0,0 +1,83 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/gpio/maxim,max7360-gpio.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Maxim MAX7360 GPIO controller > + > +maintainers: > + - Kamel Bouhara <kamel.bouhara@bootlin.com> > + - Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> > + > +description: | > + Maxim MAX7360 GPIO controller, in MAX7360 chipset > + https://www.analog.com/en/products/max7360.html > + > + The device provide two series of GPIOs, referred here as GPIOs and GPOs. > + > + PORT0 to PORT7 pins can be used as GPIOs, with support for interrupts and > + constant-current mode. These pins will also be used by the torary encoder and > + PWM functionalities. > + > + COL2 to COL7 pins can be used as GPOs, there is no input capability. COL pins > + will be partitionned, with the first pins being affected to the keypad > + functionality and the last ones as GPOs. > + > +properties: > + compatible: > + enum: > + - maxim,max7360-gpio > + - maxim,max7360-gpo > + > + gpio-controller: true > + > + "#gpio-cells": > + const: 2 > + > + interrupt-controller: true > + > + "#interrupt-cells": > + const: 2 > + > + maxim,constant-current-disable: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: > + Bit field, each bit disables constant-current output of the associated > + GPIO, starting from the least significant bit for the first GPIO. > + maximum: 0xff > + > +required: > + - compatible > + - gpio-controller > + > +allOf: > + - if: > + properties: > + compatible: > + contains: > + enum: > + - maxim,max7360-gpio > + ngpios: false > + then: > + required: > + - interrupt-controller > + else: > + properties: > + interrupt-controller: false > + maxim,constant-current-disable: false > + > +additionalProperties: false > + > +examples: > + - | > + gpio { > + compatible = "maxim,max7360-gpio"; > + > + gpio-controller; > + #gpio-cells = <2>; > + maxim,constant-current-disable = <0x06>; > + > + interrupt-controller; > + #interrupt-cells = <2>; > + }; > diff --git a/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml b/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml > new file mode 100644 > index 000000000000..d3c09531dc5c > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml > @@ -0,0 +1,170 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/maxim,max7360.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Maxim MAX7360 Keypad, Rotary encoder, PWM and GPIO controller > + > +maintainers: > + - Kamel Bouhara <kamel.bouhara@bootlin.com> > + - Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> > + > +description: | > + Maxim MAX7360 device, with following functions: > + - keypad controller > + - rotary controller > + - GPIO and GPO controller > + - PWM controller > + > + https://www.analog.com/en/products/max7360.html > + > +allOf: > + - $ref: /schemas/input/matrix-keymap.yaml# > + - $ref: /schemas/input/input.yaml# > + > +properties: > + compatible: > + enum: > + - maxim,max7360 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 2 > + > + interrupt-names: > + items: > + - const: inti > + - const: intk > + > + keypad-debounce-delay-ms: The existing debounce-delay-ms or poll-interval properties don't work for you? > + description: Keypad debounce delay in ms > + minimum: 9 > + maximum: 40 > + default: 9 > + > + rotary-debounce-delay-ms: > + description: Rotary encoder debounce delay in ms > + minimum: 0 > + maximum: 15 > + default: 0 > + > + linux,axis: > + description: The input subsystem axis to map to this rotary encoder. You should have a $ref to rotary-encoder.yaml too. None of the other properties in it are needed? > + > + "#pwm-cells": > + const: 3 > + > + gpio: > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > + description: > + PORT0 to PORT7 general purpose input/output pins configuration. > + > + gpo: > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > + description: > > + COL2 to COL7 general purpose output pins configuration. > + Allows to use unused keypad columns as outputs. Are these paragraphs? If so, add a blank line between paragraphs. If not, re-wrap the lines. > + The MAX7360 has 8 column lines and 6 of them can be used as GPOs. GPIOs > + numbers used for this gpio-controller node do correspond to the column > + numbers: values 0 and 1 are never valid, values from 2 to 7 might be valid > + depending on the value of the keypad,num-column property. > + > +patternProperties: > + '-pins$': > + type: object > + description: > + Pinctrl node's client devices use subnodes for desired pin configuration. > + Client device subnodes use below standard properties. > + $ref: /schemas/pinctrl/pincfg-node.yaml > + > + properties: > + pins: > + description: > + List of gpio pins affected by the properties specified in this > + subnode. > + items: > + pattern: '^PORT[0-7]|ROTARY$' Don't you need ()?: ^(PORT[0-7]|ROTARY)$' > + minItems: 1 > + maxItems: 8 > + > + function: > + description: > + Specify the alternative function to be configured for the specified > + pins. > + enum: [gpio, pwm, rotary] > + > + additionalProperties: false > + > +required: > + - compatible > + - reg > + - interrupts > + - interrupt-names > + - linux,keymap > + - linux,axis > + - "#pwm-cells" > + - gpio > + - gpo > + > +unevaluatedProperties: false > + > +examples: > + - | > + #include <dt-bindings/input/input.h> > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + > + io-expander@38 { > + compatible = "maxim,max7360"; > + reg = <0x38>; > + > + interrupt-parent = <&gpio1>; > + interrupts = <23 IRQ_TYPE_LEVEL_LOW>, > + <24 IRQ_TYPE_LEVEL_LOW>; > + interrupt-names = "inti", "intk"; > + > + keypad,num-rows = <8>; > + keypad,num-columns = <4>; > + linux,keymap = < > + MATRIX_KEY(0x00, 0x00, KEY_F5) > + MATRIX_KEY(0x01, 0x00, KEY_F4) > + MATRIX_KEY(0x02, 0x01, KEY_F6) > + >; > + keypad-debounce-delay-ms = <10>; > + autorepeat; > + > + rotary-debounce-delay-ms = <2>; > + linux,axis = <0>; /* REL_X */ > + > + #pwm-cells = <3>; > + > + max7360_gpio: gpio { > + compatible = "maxim,max7360-gpio"; > + > + gpio-controller; > + #gpio-cells = <2>; > + maxim,constant-current-disable = <0x06>; > + > + interrupt-controller; > + #interrupt-cells = <0x2>; > + }; > + > + max7360_gpo: gpo { > + compatible = "maxim,max7360-gpo"; > + > + gpio-controller; > + #gpio-cells = <2>; > + }; > + > + backlight_pins: backlight-pins { > + pins = "PORT2"; > + function = "pwm"; > + }; > + }; > + }; > > -- > 2.39.5 >
On Tue Mar 18, 2025 at 6:39 PM CET, Rob Herring wrote: > On Tue, Mar 18, 2025 at 05:26:17PM +0100, Mathieu Dubois-Briand wrote: > > Add device tree bindings for Maxim Integrated MAX7360 device with > > support for keypad, rotary, gpios and pwm functionalities. > > > > Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> > > --- > > .../bindings/gpio/maxim,max7360-gpio.yaml | 83 ++++++++++ > > .../devicetree/bindings/mfd/maxim,max7360.yaml | 170 +++++++++++++++++++++ > > 2 files changed, 253 insertions(+) > > > > diff --git a/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml > > new file mode 100644 > > index 000000000000..21d603d9504c > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml > > @@ -0,0 +1,83 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) ... > > + > > + keypad-debounce-delay-ms: > > The existing debounce-delay-ms or poll-interval properties don't work > for you? > The issue is this node also describes the rotary encoder (just below), so I feel using only debounce-delay-ms is a bit misleading. > > + description: Keypad debounce delay in ms > > + minimum: 9 > > + maximum: 40 > > + default: 9 > > + > > + rotary-debounce-delay-ms: > > + description: Rotary encoder debounce delay in ms > > + minimum: 0 > > + maximum: 15 > > + default: 0 > > + > > + linux,axis: > > + description: The input subsystem axis to map to this rotary encoder. > > You should have a $ref to rotary-encoder.yaml too. None of the other > properties in it are needed? Makes sense, thanks! And no, I believe this is the only property we need. > > > + > > + "#pwm-cells": > > + const: 3 > > + > > + gpio: > > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > > + description: > > + PORT0 to PORT7 general purpose input/output pins configuration. > > + > > + gpo: > > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > > + description: > > > + COL2 to COL7 general purpose output pins configuration. > > + Allows to use unused keypad columns as outputs. > > Are these paragraphs? If so, add a blank line between paragraphs. If > not, re-wrap the lines. > OK > > + The MAX7360 has 8 column lines and 6 of them can be used as GPOs. GPIOs > > + numbers used for this gpio-controller node do correspond to the column > > + numbers: values 0 and 1 are never valid, values from 2 to 7 might be valid > > + depending on the value of the keypad,num-column property. > > + > > +patternProperties: > > + '-pins$': > > + type: object > > + description: > > + Pinctrl node's client devices use subnodes for desired pin configuration. > > + Client device subnodes use below standard properties. > > + $ref: /schemas/pinctrl/pincfg-node.yaml > > + > > + properties: > > + pins: > > + description: > > + List of gpio pins affected by the properties specified in this > > + subnode. > > + items: > > + pattern: '^PORT[0-7]|ROTARY$' > > Don't you need ()?: > > ^(PORT[0-7]|ROTARY)$' > Yes! Thanks for your review. Mathieu
diff --git a/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml new file mode 100644 index 000000000000..21d603d9504c --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml @@ -0,0 +1,83 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/gpio/maxim,max7360-gpio.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Maxim MAX7360 GPIO controller + +maintainers: + - Kamel Bouhara <kamel.bouhara@bootlin.com> + - Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> + +description: | + Maxim MAX7360 GPIO controller, in MAX7360 chipset + https://www.analog.com/en/products/max7360.html + + The device provide two series of GPIOs, referred here as GPIOs and GPOs. + + PORT0 to PORT7 pins can be used as GPIOs, with support for interrupts and + constant-current mode. These pins will also be used by the torary encoder and + PWM functionalities. + + COL2 to COL7 pins can be used as GPOs, there is no input capability. COL pins + will be partitionned, with the first pins being affected to the keypad + functionality and the last ones as GPOs. + +properties: + compatible: + enum: + - maxim,max7360-gpio + - maxim,max7360-gpo + + gpio-controller: true + + "#gpio-cells": + const: 2 + + interrupt-controller: true + + "#interrupt-cells": + const: 2 + + maxim,constant-current-disable: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Bit field, each bit disables constant-current output of the associated + GPIO, starting from the least significant bit for the first GPIO. + maximum: 0xff + +required: + - compatible + - gpio-controller + +allOf: + - if: + properties: + compatible: + contains: + enum: + - maxim,max7360-gpio + ngpios: false + then: + required: + - interrupt-controller + else: + properties: + interrupt-controller: false + maxim,constant-current-disable: false + +additionalProperties: false + +examples: + - | + gpio { + compatible = "maxim,max7360-gpio"; + + gpio-controller; + #gpio-cells = <2>; + maxim,constant-current-disable = <0x06>; + + interrupt-controller; + #interrupt-cells = <2>; + }; diff --git a/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml b/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml new file mode 100644 index 000000000000..d3c09531dc5c --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml @@ -0,0 +1,170 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/maxim,max7360.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Maxim MAX7360 Keypad, Rotary encoder, PWM and GPIO controller + +maintainers: + - Kamel Bouhara <kamel.bouhara@bootlin.com> + - Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> + +description: | + Maxim MAX7360 device, with following functions: + - keypad controller + - rotary controller + - GPIO and GPO controller + - PWM controller + + https://www.analog.com/en/products/max7360.html + +allOf: + - $ref: /schemas/input/matrix-keymap.yaml# + - $ref: /schemas/input/input.yaml# + +properties: + compatible: + enum: + - maxim,max7360 + + reg: + maxItems: 1 + + interrupts: + maxItems: 2 + + interrupt-names: + items: + - const: inti + - const: intk + + keypad-debounce-delay-ms: + description: Keypad debounce delay in ms + minimum: 9 + maximum: 40 + default: 9 + + rotary-debounce-delay-ms: + description: Rotary encoder debounce delay in ms + minimum: 0 + maximum: 15 + default: 0 + + linux,axis: + description: The input subsystem axis to map to this rotary encoder. + + "#pwm-cells": + const: 3 + + gpio: + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# + description: + PORT0 to PORT7 general purpose input/output pins configuration. + + gpo: + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# + description: > + COL2 to COL7 general purpose output pins configuration. + Allows to use unused keypad columns as outputs. + The MAX7360 has 8 column lines and 6 of them can be used as GPOs. GPIOs + numbers used for this gpio-controller node do correspond to the column + numbers: values 0 and 1 are never valid, values from 2 to 7 might be valid + depending on the value of the keypad,num-column property. + +patternProperties: + '-pins$': + type: object + description: + Pinctrl node's client devices use subnodes for desired pin configuration. + Client device subnodes use below standard properties. + $ref: /schemas/pinctrl/pincfg-node.yaml + + properties: + pins: + description: + List of gpio pins affected by the properties specified in this + subnode. + items: + pattern: '^PORT[0-7]|ROTARY$' + minItems: 1 + maxItems: 8 + + function: + description: + Specify the alternative function to be configured for the specified + pins. + enum: [gpio, pwm, rotary] + + additionalProperties: false + +required: + - compatible + - reg + - interrupts + - interrupt-names + - linux,keymap + - linux,axis + - "#pwm-cells" + - gpio + - gpo + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/input/input.h> + #include <dt-bindings/interrupt-controller/arm-gic.h> + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + io-expander@38 { + compatible = "maxim,max7360"; + reg = <0x38>; + + interrupt-parent = <&gpio1>; + interrupts = <23 IRQ_TYPE_LEVEL_LOW>, + <24 IRQ_TYPE_LEVEL_LOW>; + interrupt-names = "inti", "intk"; + + keypad,num-rows = <8>; + keypad,num-columns = <4>; + linux,keymap = < + MATRIX_KEY(0x00, 0x00, KEY_F5) + MATRIX_KEY(0x01, 0x00, KEY_F4) + MATRIX_KEY(0x02, 0x01, KEY_F6) + >; + keypad-debounce-delay-ms = <10>; + autorepeat; + + rotary-debounce-delay-ms = <2>; + linux,axis = <0>; /* REL_X */ + + #pwm-cells = <3>; + + max7360_gpio: gpio { + compatible = "maxim,max7360-gpio"; + + gpio-controller; + #gpio-cells = <2>; + maxim,constant-current-disable = <0x06>; + + interrupt-controller; + #interrupt-cells = <0x2>; + }; + + max7360_gpo: gpo { + compatible = "maxim,max7360-gpo"; + + gpio-controller; + #gpio-cells = <2>; + }; + + backlight_pins: backlight-pins { + pins = "PORT2"; + function = "pwm"; + }; + }; + };
Add device tree bindings for Maxim Integrated MAX7360 device with support for keypad, rotary, gpios and pwm functionalities. Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> --- .../bindings/gpio/maxim,max7360-gpio.yaml | 83 ++++++++++ .../devicetree/bindings/mfd/maxim,max7360.yaml | 170 +++++++++++++++++++++ 2 files changed, 253 insertions(+)