| Message ID | 20250113-mdb-max7360-support-v3-1-9519b4acb0b1@bootlin.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Add support for MAX7360 | expand |
On Mon, Jan 13, 2025 at 01:42:25PM +0100, Mathieu Dubois-Briand wrote: > + interrupt-controller: true > + > + "#interrupt-cells": > + const: 2 > + > + maxim,constant-current-disable: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: > Drop > > + 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 > + - ngpios > + allOf: here, so you won't re-indent it later. > +if: > + properties: > + compatible: > + contains: > + enum: > + - maxim,max7360-gpio > +then: > + required: > + - interrupt-controller > +else: > + properties: > + interrupt-controller: false > + maxim,constant-current-disable: false > + > + ngpios: > + maximum: 6 > + > +additionalProperties: false > + > +examples: > + - | > + gpio { > + compatible = "maxim,max7360-gpio"; > + > + gpio-controller; > + #gpio-cells = <2>; > + ngpios = <8>; > + maxim,constant-current-disable = <0x06>; > + > + interrupt-controller; > + #interrupt-cells = <2>; > + }; ... > + interrupt-names: > + items: > + - const: inti > + - const: intk > + > + keypad-debounce-delay-ms: > + description: Keypad debounce delay in ms > + minimum: 9 > + maximum: 40 > + default: 9 > + > + autorepeat: true Drop, not needed. > + > + 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. Missing type. I guess you wanted to reference rotary encoder schema, next to input and matrix-keymap? > + > + "#pwm-cells": > + const: 3 > + > + gpio: > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > + description: > Drop > > + PORT0 to PORT7 general purpose input/output pins configuration. > + > + gpo: > + $ref: /schemas/gpio/maxim,max7360-gpio.yaml# > + description: > Drop > > + 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. Value > + of ngpios must be coherent with the value of keypad,num-columns, as their > + sum must not exceed the number of physical lines. > + > +required: > + - compatible > + - reg > + - interrupts > + - interrupt-names > + - linux,keymap > + - linux,axis > + - "#pwm-cells" gpio and gpo nodes are optional? How would the driver behave? I assume you need to define the partition between GPIOs, especially that 'ngpios' are a required property in their schema. > + > +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>; > + ngpios = <8>; > + maxim,constant-current-disable = <0x06>; > + > + interrupt-controller; > + #interrupt-cells = <0x2>; > + }; > + > + max7360_gpo: gpo { > + compatible = "maxim,max7360-gpo"; > + > + gpio-controller; > + #gpio-cells = <2>; > + ngpios = <4>; > + }; > + }; > + }; > > -- > 2.39.5 >
On Tue Jan 14, 2025 at 9:11 AM CET, Krzysztof Kozlowski wrote: > On Mon, Jan 13, 2025 at 01:42:25PM +0100, Mathieu Dubois-Briand wrote: > > + > > + 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. > > Missing type. I guess you wanted to reference rotary encoder schema, > next to input and matrix-keymap? > I'm not sure I fully understood your suggestion. Do you mean adding a reference to rotary-encoder.yaml, at the root of the document? Like: allOf: - $ref: /schemas/input/matrix-keymap.yaml# - $ref: /schemas/input/input.yaml# - $ref: /schemas/input/rotary-encoder.yaml# I did base the schema of the rotary encoder part on rotary-encoder.yaml, but I believe we cannot reference it directly: it adds some properties that do not make sense here (gpios, rotary-encoder,steps...) and also some of them are mandatory. Yet I see that I'm not referring to any type here. Also I did not specify the default value. Would the following be OK? linux,axis: description: The input subsystem axis to map to the rotary encoder. $ref: /schemas/types.yaml#/definitions/uint32 default: 0 > > + 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. Value > > + of ngpios must be coherent with the value of keypad,num-columns, as their > > + sum must not exceed the number of physical lines. > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - interrupt-names > > + - linux,keymap > > + - linux,axis > > + - "#pwm-cells" > > gpio and gpo nodes are optional? How would the driver behave? I assume > you need to define the partition between GPIOs, especially that 'ngpios' > are a required property in their schema. > No, you are right. In my mind it was optional, but current driver implementation will complain if the gpo node is missing. I could make it optional in the code, but it's probably better to make it required in the device tree, so the hardware is correctly described. > > > > -- > > 2.39.5 > > I have fixed the other points listed in your mail. Thanks for your review.
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..95e9ccd455c2 --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/maxim,max7360-gpio.yaml @@ -0,0 +1,90 @@ +# 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. This partioning must be described + here using the ngpios property. + +properties: + compatible: + enum: + - maxim,max7360-gpio + - maxim,max7360-gpo + + gpio-controller: true + + "#gpio-cells": + const: 2 + + ngpios: + minimum: 0 + maximum: 8 + + 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. + +required: + - compatible + - gpio-controller + - ngpios + +if: + properties: + compatible: + contains: + enum: + - maxim,max7360-gpio +then: + required: + - interrupt-controller +else: + properties: + interrupt-controller: false + maxim,constant-current-disable: false + + ngpios: + maximum: 6 + +additionalProperties: false + +examples: + - | + gpio { + compatible = "maxim,max7360-gpio"; + + gpio-controller; + #gpio-cells = <2>; + ngpios = <8>; + 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..7c50bab8c6d6 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/maxim,max7360.yaml @@ -0,0 +1,140 @@ +# 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 + + autorepeat: true + + 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. Value + of ngpios must be coherent with the value of keypad,num-columns, as their + sum must not exceed the number of physical lines. + +required: + - compatible + - reg + - interrupts + - interrupt-names + - linux,keymap + - linux,axis + - "#pwm-cells" + +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>; + ngpios = <8>; + maxim,constant-current-disable = <0x06>; + + interrupt-controller; + #interrupt-cells = <0x2>; + }; + + max7360_gpo: gpo { + compatible = "maxim,max7360-gpo"; + + gpio-controller; + #gpio-cells = <2>; + ngpios = <4>; + }; + }; + };
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 | 90 +++++++++++++ .../devicetree/bindings/mfd/maxim,max7360.yaml | 140 +++++++++++++++++++++ 2 files changed, 230 insertions(+)