[PATCH v5 0/3] adp5588-keys: Support for dedicated gpio operation

[PATCH v5 0/3] adp5588-keys: Support for dedicated gpio operation

[Utsav Agarwal via B4 Relay]

Current state of the driver for the ADP5588/87 only allows partial
I/O to be used as GPIO. This support was previously present as a
separate gpio driver, which was dropped with the commit
5ddc896088b0 ("gpio: gpio-adp5588: drop the driver") since the
functionality was deemed to have been merged with adp5588-keys.

This series of patches re-enables this support by allowing the driver to 
relax the requirement for registering a keymap and enable pure GPIO 
operation. 

Changelog
==========

V2: 
	-  Changed gpio_only from a local variable to a member of struct
	adp5588_kpad
	-  Removed condition from adp5588_probe() to skip adp5588_fw_parse() if 
	gpio-only specified. adp558_fw_parse() now handles and returns
	0 if gpio-only has been specified.
	-  Added a check in adp5588_fw_parse() to make sure keypad 
	properties(keypad,num-columns and keypad,num-rows) were not defined when 
	gpio-only specified

V3:
	-  Moved device_property_present() for reading "gpio-only" into 
	adp558_fw_parse()
	-  Added print statements in case of error

V4:
	- Added dt-bindings patch

Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
---
V5:
	- Removed extra property "gpio-only", now pure gpio mode is
	  detected via the adbsence of keypad specific properties.
	- Added dependencies for keypad properties to preserve
	  the original requirements in case a pure gpio mode is not
	  being used.
	- Added additional description for why the "interrupts" property
	  was made optional
	- Rebased current work based on https://lore.kernel.org/linux-input/ZoLt_qBCQS-tG8Ar@google.com/
- Link to v4: https://lore.kernel.org/r/20240701-adp5588_gpio_support-v4-0-44bba0445e90@analog.com

---
Dmitry Torokhov (1):
      iInput: adp5588-keys - use guard notation when acquiring mutexes

Utsav Agarwal (2):
      Input: adp5588-keys - add support for pure gpio
      dt-bindings: input: Update dtbinding for adp5588

 .../devicetree/bindings/input/adi,adp5588.yaml     | 33 ++++++++--
 drivers/input/keyboard/adp5588-keys.c              | 70 ++++++++++++----------
 2 files changed, 66 insertions(+), 37 deletions(-)
---
base-commit: 1c52cf5e79d30ac996f34b64284f2c317004d641
change-id: 20240701-adp5588_gpio_support-65db2bd21a9f

Best regards,
-- 
Utsav Agarwal <utsav.agarwal@analog.com>

[PATCH v5 1/3] iInput: adp5588-keys - use guard notation when acquiring mutexes

[Utsav Agarwal via B4 Relay]

From: Dmitry Torokhov <dmitry.torokhov@gmail.com>

This makes the code more compact and error handling more robust.

Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Acked-by: Michael Hennerich <michael.hennerich@analog.com>
---
 drivers/input/keyboard/adp5588-keys.c | 49 ++++++++++++-----------------------
 1 file changed, 17 insertions(+), 32 deletions(-)

diff --git a/drivers/input/keyboard/adp5588-keys.c b/drivers/input/keyboard/adp5588-keys.c
index 1b0279393df4..09bcfc6b9408 100644
--- a/drivers/input/keyboard/adp5588-keys.c
+++ b/drivers/input/keyboard/adp5588-keys.c
@@ -221,15 +221,13 @@ static int adp5588_gpio_get_value(struct gpio_chip *chip, unsigned int off)
 	unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
 	int val;
 
-	mutex_lock(&kpad->gpio_lock);
+	guard(mutex)(&kpad->gpio_lock);
 
 	if (kpad->dir[bank] & bit)
 		val = kpad->dat_out[bank];
 	else
 		val = adp5588_read(kpad->client, GPIO_DAT_STAT1 + bank);
 
-	mutex_unlock(&kpad->gpio_lock);
-
 	return !!(val & bit);
 }
 
@@ -240,7 +238,7 @@ static void adp5588_gpio_set_value(struct gpio_chip *chip,
 	unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
 	unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
 
-	mutex_lock(&kpad->gpio_lock);
+	guard(mutex)(&kpad->gpio_lock);
 
 	if (val)
 		kpad->dat_out[bank] |= bit;
@@ -248,8 +246,6 @@ static void adp5588_gpio_set_value(struct gpio_chip *chip,
 		kpad->dat_out[bank] &= ~bit;
 
 	adp5588_write(kpad->client, GPIO_DAT_OUT1 + bank, kpad->dat_out[bank]);
-
-	mutex_unlock(&kpad->gpio_lock);
 }
 
 static int adp5588_gpio_set_config(struct gpio_chip *chip,  unsigned int off,
@@ -259,7 +255,6 @@ static int adp5588_gpio_set_config(struct gpio_chip *chip,  unsigned int off,
 	unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
 	unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
 	bool pull_disable;
-	int ret;
 
 	switch (pinconf_to_config_param(config)) {
 	case PIN_CONFIG_BIAS_PULL_UP:
@@ -272,19 +267,15 @@ static int adp5588_gpio_set_config(struct gpio_chip *chip,  unsigned int off,
 		return -ENOTSUPP;
 	}
 
-	mutex_lock(&kpad->gpio_lock);
+	guard(mutex)(&kpad->gpio_lock);
 
 	if (pull_disable)
 		kpad->pull_dis[bank] |= bit;
 	else
 		kpad->pull_dis[bank] &= bit;
 
-	ret = adp5588_write(kpad->client, GPIO_PULL1 + bank,
-			    kpad->pull_dis[bank]);
-
-	mutex_unlock(&kpad->gpio_lock);
-
-	return ret;
+	return adp5588_write(kpad->client, GPIO_PULL1 + bank,
+			     kpad->pull_dis[bank]);
 }
 
 static int adp5588_gpio_direction_input(struct gpio_chip *chip, unsigned int off)
@@ -292,16 +283,11 @@ static int adp5588_gpio_direction_input(struct gpio_chip *chip, unsigned int off
 	struct adp5588_kpad *kpad = gpiochip_get_data(chip);
 	unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
 	unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
-	int ret;
 
-	mutex_lock(&kpad->gpio_lock);
+	guard(mutex)(&kpad->gpio_lock);
 
 	kpad->dir[bank] &= ~bit;
-	ret = adp5588_write(kpad->client, GPIO_DIR1 + bank, kpad->dir[bank]);
-
-	mutex_unlock(&kpad->gpio_lock);
-
-	return ret;
+	return adp5588_write(kpad->client, GPIO_DIR1 + bank, kpad->dir[bank]);
 }
 
 static int adp5588_gpio_direction_output(struct gpio_chip *chip,
@@ -310,9 +296,9 @@ static int adp5588_gpio_direction_output(struct gpio_chip *chip,
 	struct adp5588_kpad *kpad = gpiochip_get_data(chip);
 	unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
 	unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
-	int ret;
+	int error;
 
-	mutex_lock(&kpad->gpio_lock);
+	guard(mutex)(&kpad->gpio_lock);
 
 	kpad->dir[bank] |= bit;
 
@@ -321,17 +307,16 @@ static int adp5588_gpio_direction_output(struct gpio_chip *chip,
 	else
 		kpad->dat_out[bank] &= ~bit;
 
-	ret = adp5588_write(kpad->client, GPIO_DAT_OUT1 + bank,
-			    kpad->dat_out[bank]);
-	if (ret)
-		goto out_unlock;
-
-	ret = adp5588_write(kpad->client, GPIO_DIR1 + bank, kpad->dir[bank]);
+	error = adp5588_write(kpad->client, GPIO_DAT_OUT1 + bank,
+			      kpad->dat_out[bank]);
+	if (error)
+		return error;
 
-out_unlock:
-	mutex_unlock(&kpad->gpio_lock);
+	error = adp5588_write(kpad->client, GPIO_DIR1 + bank, kpad->dir[bank]);
+	if (error)
+		return error;
 
-	return ret;
+	return 0;
 }
 
 static int adp5588_build_gpiomap(struct adp5588_kpad *kpad)

-- 
2.34.1

[PATCH v5 2/3] Input: adp5588-keys - add support for pure gpio

[Utsav Agarwal via B4 Relay]

From: Utsav Agarwal <utsav.agarwal@analog.com>

Keypad specific setup is relaxed if no keypad rows/columns are specified,
enabling a purely gpio operation.

Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
---
 drivers/input/keyboard/adp5588-keys.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/drivers/input/keyboard/adp5588-keys.c b/drivers/input/keyboard/adp5588-keys.c
index 09bcfc6b9408..691f5790bc81 100644
--- a/drivers/input/keyboard/adp5588-keys.c
+++ b/drivers/input/keyboard/adp5588-keys.c
@@ -188,6 +188,7 @@ struct adp5588_kpad {
 	u32 cols;
 	u32 unlock_keys[2];
 	int nkeys_unlock;
+	bool gpio_only;
 	unsigned short keycode[ADP5588_KEYMAPSIZE];
 	unsigned char gpiomap[ADP5588_MAXGPIO];
 	struct gpio_chip gc;
@@ -632,6 +633,21 @@ static int adp5588_fw_parse(struct adp5588_kpad *kpad)
 	struct i2c_client *client = kpad->client;
 	int ret, i;
 
+	/*
+	 * Check if the device is to be operated purely in GPIO mode. To do
+	 * so, check that no keypad rows or columns have been specified,
+	 * since all GPINS should be configured as GPIO.
+	 */
+	ret = device_property_present(&client->dev,
+			"keypad,num-rows");
+	ret |= device_property_present(&client->dev,
+			"keypad,num-columns");
+	/* If purely GPIO, skip keypad setup */
+	if (!ret) {
+		kpad->gpio_only = true;
+		return 0;
+	}
+
 	ret = matrix_keypad_parse_properties(&client->dev, &kpad->rows,
 					     &kpad->cols);
 	if (ret)
@@ -775,6 +791,11 @@ static int adp5588_probe(struct i2c_client *client)
 	if (error)
 		return error;
 
+	if (kpad->gpio_only) {
+		dev_info(&client->dev, "Rev.%d, started as GPIO only\n", revid);
+		return 0;
+	}
+
 	error = devm_request_threaded_irq(&client->dev, client->irq,
 					  adp5588_hard_irq, adp5588_thread_irq,
 					  IRQF_TRIGGER_FALLING | IRQF_ONESHOT,

-- 
2.34.1

[PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Utsav Agarwal via B4 Relay]

From: Utsav Agarwal <utsav.agarwal@analog.com>

Updating dt bindings for adp5588. Since the device can now function in a
purely gpio mode, the following keypad specific properties are now made
optional:
	- interrupts
	- keypad,num-rows
	- keypad,num-columns
	- linux,keymap

However since the above properties are required to be specified when
configuring the device as a keypad, dependencies have been added
such that specifying either one would require the remaining as well.

Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
---
 .../devicetree/bindings/input/adi,adp5588.yaml     | 33 ++++++++++++++++++----
 1 file changed, 28 insertions(+), 5 deletions(-)

diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
index 26ea66834ae2..6c06464f822b 100644
--- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
+++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
@@ -49,7 +49,10 @@ properties:
   interrupt-controller:
     description:
       This property applies if either keypad,num-rows lower than 8 or
-      keypad,num-columns lower than 10.
+      keypad,num-columns lower than 10. This property does not apply if
+      keypad,num-rows or keypad,num-columns are not specified since the
+      device then acts as gpio only, during which interrupts are not
+      utilized.
 
   '#interrupt-cells':
     const: 2
@@ -65,13 +68,15 @@ properties:
     minItems: 1
     maxItems: 2
 
+dependencies:
+  keypad,num-rows: ["keypad,num-columns"]
+  keypad,num-cols: ["keypad,num-rows"]
+  linux,keymap: ["keypad,num-rows"]
+  interrupts: ["linux,keymap"]
+
 required:
   - compatible
   - reg
-  - interrupts
-  - keypad,num-rows
-  - keypad,num-columns
-  - linux,keymap
 
 unevaluatedProperties: false
 
@@ -108,4 +113,22 @@ examples:
             >;
         };
     };
+
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/input/input.h>
+    #include <dt-bindings/gpio/gpio.h>
+
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+        gpio@34 {
+            compatible = "adi,adp5588";
+            reg = <0x34>;
+
+            #gpio-cells = <2>;
+            gpio-controller;
+            };
+        };
+
 ...

-- 
2.34.1

Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 3186 bytes --]

On Wed, Jul 03, 2024 at 11:58:16AM +0100, Utsav Agarwal via B4 Relay wrote:
> From: Utsav Agarwal <utsav.agarwal@analog.com>
> 
> Updating dt bindings for adp5588. Since the device can now function in a
> purely gpio mode, the following keypad specific properties are now made
> optional:
> 	- interrupts
> 	- keypad,num-rows
> 	- keypad,num-columns
> 	- linux,keymap
> 
> However since the above properties are required to be specified when
> configuring the device as a keypad, dependencies have been added
> such that specifying either one would require the remaining as well.
> 
> Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
> ---
>  .../devicetree/bindings/input/adi,adp5588.yaml     | 33 ++++++++++++++++++----
>  1 file changed, 28 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> index 26ea66834ae2..6c06464f822b 100644
> --- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> +++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> @@ -49,7 +49,10 @@ properties:
>    interrupt-controller:
>      description:
>        This property applies if either keypad,num-rows lower than 8 or
> -      keypad,num-columns lower than 10.
> +      keypad,num-columns lower than 10. This property does not apply if
> +      keypad,num-rows or keypad,num-columns are not specified since the
> +      device then acts as gpio only, during which interrupts are not
> +      utilized.
>  
>    '#interrupt-cells':
>      const: 2
> @@ -65,13 +68,15 @@ properties:
>      minItems: 1
>      maxItems: 2
>  
> +dependencies:
> +  keypad,num-rows: ["keypad,num-columns"]
> +  keypad,num-cols: ["keypad,num-rows"]
> +  linux,keymap: ["keypad,num-rows"]

Is what you've got here sufficient? Adding "keypad,num-rows" won't
mandate "linux,keymap" which I think is wrong. I think all 3 entries
here need to contain both of the other two.

> +  interrupts: ["linux,keymap"]

I still don't understand why interrupts are only allowed when the keymap
is present. I'd cover the interrupts with something like

if:
  required:
    - linux,keymap
  then:
    required:
      - interrupts

so that interrupts can be used while not in keypad mode. Unless of
course there's something (unmentioned in this patch) that prevents that.

Thanks,
Conor.

> +
>  required:
>    - compatible
>    - reg
> -  - interrupts
> -  - keypad,num-rows
> -  - keypad,num-columns
> -  - linux,keymap
>  
>  unevaluatedProperties: false
>  
> @@ -108,4 +113,22 @@ examples:
>              >;
>          };
>      };
> +
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/input/input.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +        gpio@34 {
> +            compatible = "adi,adp5588";
> +            reg = <0x34>;
> +
> +            #gpio-cells = <2>;
> +            gpio-controller;
> +            };
> +        };
> +
>  ...
> 
> -- 
> 2.34.1
> 
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

RE: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Agarwal, Utsav]

Hi Conor,

Thank you for your feedback.
> -----Original Message-----
> From: Conor Dooley <conor@kernel.org>
> Sent: Wednesday, July 3, 2024 4:20 PM
> To: Agarwal, Utsav <Utsav.Agarwal@analog.com>
> Cc: Hennerich, Michael <Michael.Hennerich@analog.com>; Dmitry Torokhov
> <dmitry.torokhov@gmail.com>; Rob Herring <robh@kernel.org>; Krzysztof
> Kozlowski <krzk+dt@kernel.org>; Conor Dooley <conor+dt@kernel.org>; Sa,
> Nuno <Nuno.Sa@analog.com>; linux-input@vger.kernel.org;
> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org; Artamonovs,
> Arturs <Arturs.Artamonovs@analog.com>; Bimpikas, Vasileios
> <Vasileios.Bimpikas@analog.com>; Gaskell, Oliver
> <Oliver.Gaskell@analog.com>
> Subject: Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588
> 
> On Wed, Jul 03, 2024 at 11:58:16AM +0100, Utsav Agarwal via B4 Relay
> wrote:
> > From: Utsav Agarwal <utsav.agarwal@analog.com>
> >
> > Updating dt bindings for adp5588. Since the device can now function in a
> > purely gpio mode, the following keypad specific properties are now made
> > optional:
> > 	- interrupts
> > 	- keypad,num-rows
> > 	- keypad,num-columns
> > 	- linux,keymap
> >
> > However since the above properties are required to be specified when
> > configuring the device as a keypad, dependencies have been added
> > such that specifying either one would require the remaining as well.
> >
> > Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
> > ---
> >  .../devicetree/bindings/input/adi,adp5588.yaml     | 33
> ++++++++++++++++++----
> >  1 file changed, 28 insertions(+), 5 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > index 26ea66834ae2..6c06464f822b 100644
> > --- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > +++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > @@ -49,7 +49,10 @@ properties:
> >    interrupt-controller:
> >      description:
> >        This property applies if either keypad,num-rows lower than 8 or
> > -      keypad,num-columns lower than 10.
> > +      keypad,num-columns lower than 10. This property does not apply if
> > +      keypad,num-rows or keypad,num-columns are not specified since the
> > +      device then acts as gpio only, during which interrupts are not
> > +      utilized.
> >
> >    '#interrupt-cells':
> >      const: 2
> > @@ -65,13 +68,15 @@ properties:
> >      minItems: 1
> >      maxItems: 2
> >
> > +dependencies:
> > +  keypad,num-rows: ["keypad,num-columns"]
> > +  keypad,num-cols: ["keypad,num-rows"]
> > +  linux,keymap: ["keypad,num-rows"]
> 
> Is what you've got here sufficient? Adding "keypad,num-rows" won't
> mandate "linux,keymap" which I think is wrong. I think all 3 entries
> here need to contain both of the other two.
> 

Ah, I can see the issue, thank you for pointing it out - I will be correcting that.

> > +  interrupts: ["linux,keymap"]
> 
> I still don't understand why interrupts are only allowed when the keymap
> is present. I'd cover the interrupts with something like
> 
> if:
>   required:
>     - linux,keymap
>   then:
>     required:
>       - interrupts
> 
> so that interrupts can be used while not in keypad mode. Unless of
> course there's something (unmentioned in this patch) that prevents that.

In case when the device is not in keypad mode, i.e, is purely using gpio - it doesn't trigger the interrupt.
Due to this, I had restricted the same to keypad mode only(as a requirement). This was mentioned 
here:
https://lore.kernel.org/all/d4661ddc1d253678fd62be4c7e19eb0cff4174f6.camel@gmail.com/

Moreover, this was also included in one of the earlier feedback comments that I had received:
https://lore.kernel.org/all/1fc545709ad2aee0b70a8d1c561516d94cb6fb1e.camel@gmail.com/

Thanks,
Utsav 

Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 4153 bytes --]

On Wed, Jul 03, 2024 at 03:55:11PM +0000, Agarwal, Utsav wrote:
> Hi Conor,
> 
> Thank you for your feedback.
> > -----Original Message-----
> > From: Conor Dooley <conor@kernel.org>
> > Sent: Wednesday, July 3, 2024 4:20 PM
> > To: Agarwal, Utsav <Utsav.Agarwal@analog.com>
> > Cc: Hennerich, Michael <Michael.Hennerich@analog.com>; Dmitry Torokhov
> > <dmitry.torokhov@gmail.com>; Rob Herring <robh@kernel.org>; Krzysztof
> > Kozlowski <krzk+dt@kernel.org>; Conor Dooley <conor+dt@kernel.org>; Sa,
> > Nuno <Nuno.Sa@analog.com>; linux-input@vger.kernel.org;
> > devicetree@vger.kernel.org; linux-kernel@vger.kernel.org; Artamonovs,
> > Arturs <Arturs.Artamonovs@analog.com>; Bimpikas, Vasileios
> > <Vasileios.Bimpikas@analog.com>; Gaskell, Oliver
> > <Oliver.Gaskell@analog.com>
> > Subject: Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588
> > 
> > On Wed, Jul 03, 2024 at 11:58:16AM +0100, Utsav Agarwal via B4 Relay
> > wrote:
> > > From: Utsav Agarwal <utsav.agarwal@analog.com>
> > >
> > > Updating dt bindings for adp5588. Since the device can now function in a
> > > purely gpio mode, the following keypad specific properties are now made
> > > optional:
> > > 	- interrupts
> > > 	- keypad,num-rows
> > > 	- keypad,num-columns
> > > 	- linux,keymap
> > >
> > > However since the above properties are required to be specified when
> > > configuring the device as a keypad, dependencies have been added
> > > such that specifying either one would require the remaining as well.
> > >
> > > Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
> > > ---
> > >  .../devicetree/bindings/input/adi,adp5588.yaml     | 33
> > ++++++++++++++++++----
> > >  1 file changed, 28 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > index 26ea66834ae2..6c06464f822b 100644
> > > --- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > +++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > @@ -49,7 +49,10 @@ properties:
> > >    interrupt-controller:
> > >      description:
> > >        This property applies if either keypad,num-rows lower than 8 or
> > > -      keypad,num-columns lower than 10.
> > > +      keypad,num-columns lower than 10. This property does not apply if
> > > +      keypad,num-rows or keypad,num-columns are not specified since the
> > > +      device then acts as gpio only, during which interrupts are not
> > > +      utilized.
> > >
> > >    '#interrupt-cells':
> > >      const: 2
> > > @@ -65,13 +68,15 @@ properties:
> > >      minItems: 1
> > >      maxItems: 2
> > >
> > > +dependencies:
> > > +  keypad,num-rows: ["keypad,num-columns"]
> > > +  keypad,num-cols: ["keypad,num-rows"]
> > > +  linux,keymap: ["keypad,num-rows"]
> > 
> > Is what you've got here sufficient? Adding "keypad,num-rows" won't
> > mandate "linux,keymap" which I think is wrong. I think all 3 entries
> > here need to contain both of the other two.
> > 
> 
> Ah, I can see the issue, thank you for pointing it out - I will be correcting that.
> 
> > > +  interrupts: ["linux,keymap"]
> > 
> > I still don't understand why interrupts are only allowed when the keymap
> > is present. I'd cover the interrupts with something like
> > 
> > if:
> >   required:
> >     - linux,keymap
> >   then:
> >     required:
> >       - interrupts
> > 
> > so that interrupts can be used while not in keypad mode. Unless of
> > course there's something (unmentioned in this patch) that prevents that.
> 
> In case when the device is not in keypad mode, i.e, is purely using gpio - it doesn't trigger the interrupt.
> Due to this, I had restricted the same to keypad mode only(as a requirement). This was mentioned 
> here:
> https://lore.kernel.org/all/d4661ddc1d253678fd62be4c7e19eb0cff4174f6.camel@gmail.com/

This says "not required", not "not functional". How come generating
interrupts becomes impossible when not in keypad mode? That's what needs
to be explained.

Thanks,
Conor.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Nuno Sá]

On Wed, 2024-07-03 at 16:57 +0100, Conor Dooley wrote:
> On Wed, Jul 03, 2024 at 03:55:11PM +0000, Agarwal, Utsav wrote:
> > Hi Conor,
> > 
> > Thank you for your feedback.
> > > -----Original Message-----
> > > From: Conor Dooley <conor@kernel.org>
> > > Sent: Wednesday, July 3, 2024 4:20 PM
> > > To: Agarwal, Utsav <Utsav.Agarwal@analog.com>
> > > Cc: Hennerich, Michael <Michael.Hennerich@analog.com>; Dmitry Torokhov
> > > <dmitry.torokhov@gmail.com>; Rob Herring <robh@kernel.org>; Krzysztof
> > > Kozlowski <krzk+dt@kernel.org>; Conor Dooley <conor+dt@kernel.org>; Sa,
> > > Nuno <Nuno.Sa@analog.com>; linux-input@vger.kernel.org;
> > > devicetree@vger.kernel.org; linux-kernel@vger.kernel.org; Artamonovs,
> > > Arturs <Arturs.Artamonovs@analog.com>; Bimpikas, Vasileios
> > > <Vasileios.Bimpikas@analog.com>; Gaskell, Oliver
> > > <Oliver.Gaskell@analog.com>
> > > Subject: Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for
> > > adp5588
> > > 
> > > On Wed, Jul 03, 2024 at 11:58:16AM +0100, Utsav Agarwal via B4 Relay
> > > wrote:
> > > > From: Utsav Agarwal <utsav.agarwal@analog.com>
> > > > 
> > > > Updating dt bindings for adp5588. Since the device can now function in a
> > > > purely gpio mode, the following keypad specific properties are now made
> > > > optional:
> > > > 	- interrupts
> > > > 	- keypad,num-rows
> > > > 	- keypad,num-columns
> > > > 	- linux,keymap
> > > > 
> > > > However since the above properties are required to be specified when
> > > > configuring the device as a keypad, dependencies have been added
> > > > such that specifying either one would require the remaining as well.
> > > > 
> > > > Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
> > > > ---
> > > >  .../devicetree/bindings/input/adi,adp5588.yaml     | 33
> > > ++++++++++++++++++----
> > > >  1 file changed, 28 insertions(+), 5 deletions(-)
> > > > 
> > > > diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > index 26ea66834ae2..6c06464f822b 100644
> > > > --- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > +++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > @@ -49,7 +49,10 @@ properties:
> > > >    interrupt-controller:
> > > >      description:
> > > >        This property applies if either keypad,num-rows lower than 8 or
> > > > -      keypad,num-columns lower than 10.
> > > > +      keypad,num-columns lower than 10. This property does not apply if
> > > > +      keypad,num-rows or keypad,num-columns are not specified since the
> > > > +      device then acts as gpio only, during which interrupts are not
> > > > +      utilized.
> > > > 
> > > >    '#interrupt-cells':
> > > >      const: 2
> > > > @@ -65,13 +68,15 @@ properties:
> > > >      minItems: 1
> > > >      maxItems: 2
> > > > 
> > > > +dependencies:
> > > > +  keypad,num-rows: ["keypad,num-columns"]
> > > > +  keypad,num-cols: ["keypad,num-rows"]
> > > > +  linux,keymap: ["keypad,num-rows"]
> > > 
> > > Is what you've got here sufficient? Adding "keypad,num-rows" won't
> > > mandate "linux,keymap" which I think is wrong. I think all 3 entries
> > > here need to contain both of the other two.
> > > 
> > 
> > Ah, I can see the issue, thank you for pointing it out - I will be
> > correcting that.
> > 
> > > > +  interrupts: ["linux,keymap"]
> > > 
> > > I still don't understand why interrupts are only allowed when the keymap
> > > is present. I'd cover the interrupts with something like
> > > 
> > > if:
> > >   required:
> > >     - linux,keymap
> > >   then:
> > >     required:
> > >       - interrupts
> > > 
> > > so that interrupts can be used while not in keypad mode. Unless of
> > > course there's something (unmentioned in this patch) that prevents that.
> > 
> > In case when the device is not in keypad mode, i.e, is purely using gpio -
> > it doesn't trigger the interrupt.
> > Due to this, I had restricted the same to keypad mode only(as a
> > requirement). This was mentioned 
> > here:
> > https://lore.kernel.org/all/d4661ddc1d253678fd62be4c7e19eb0cff4174f6.camel@gmail.com/
> 
> This says "not required", not "not functional". How come generating
> interrupts becomes impossible when not in keypad mode? That's what needs
> to be explained.
> 

I should have read the patch before replying in v4. Yes, I agree with Conor that
what we need is to make the interrupt __required__ when using the keypad. In the
case we have gpios, it's optional but it does not mean we should remove it. One
usecase would be to use gpios still as inputs through gpio-keys.

- Nuno Sá

RE: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588

[Agarwal, Utsav]

Hi Conor,

> -----Original Message-----
> From: Nuno Sá <noname.nuno@gmail.com>
> Sent: Thursday, July 4, 2024 8:19 AM
> To: Conor Dooley <conor@kernel.org>; Agarwal, Utsav
> <Utsav.Agarwal@analog.com>
> Cc: Hennerich, Michael <Michael.Hennerich@analog.com>; Dmitry Torokhov
> <dmitry.torokhov@gmail.com>; Rob Herring <robh@kernel.org>; Krzysztof
> Kozlowski <krzk+dt@kernel.org>; Conor Dooley <conor+dt@kernel.org>; Sa,
> Nuno <Nuno.Sa@analog.com>; linux-input@vger.kernel.org;
> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org; Artamonovs,
> Arturs <Arturs.Artamonovs@analog.com>; Bimpikas, Vasileios
> <Vasileios.Bimpikas@analog.com>; Gaskell, Oliver
> <Oliver.Gaskell@analog.com>
> Subject: Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for adp5588
> 
> [External]
> 
> On Wed, 2024-07-03 at 16:57 +0100, Conor Dooley wrote:
> > On Wed, Jul 03, 2024 at 03:55:11PM +0000, Agarwal, Utsav wrote:
> > > Hi Conor,
> > >
> > > Thank you for your feedback.
> > > > -----Original Message-----
> > > > From: Conor Dooley <conor@kernel.org>
> > > > Sent: Wednesday, July 3, 2024 4:20 PM
> > > > To: Agarwal, Utsav <Utsav.Agarwal@analog.com>
> > > > Cc: Hennerich, Michael <Michael.Hennerich@analog.com>; Dmitry
> Torokhov
> > > > <dmitry.torokhov@gmail.com>; Rob Herring <robh@kernel.org>;
> Krzysztof
> > > > Kozlowski <krzk+dt@kernel.org>; Conor Dooley
> <conor+dt@kernel.org>; Sa,
> > > > Nuno <Nuno.Sa@analog.com>; linux-input@vger.kernel.org;
> > > > devicetree@vger.kernel.org; linux-kernel@vger.kernel.org;
> Artamonovs,
> > > > Arturs <Arturs.Artamonovs@analog.com>; Bimpikas, Vasileios
> > > > <Vasileios.Bimpikas@analog.com>; Gaskell, Oliver
> > > > <Oliver.Gaskell@analog.com>
> > > > Subject: Re: [PATCH v5 3/3] dt-bindings: input: Update dtbinding for
> > > > adp5588
> > > >
> > > > On Wed, Jul 03, 2024 at 11:58:16AM +0100, Utsav Agarwal via B4 Relay
> > > > wrote:
> > > > > From: Utsav Agarwal <utsav.agarwal@analog.com>
> > > > >
> > > > > Updating dt bindings for adp5588. Since the device can now function
> in a
> > > > > purely gpio mode, the following keypad specific properties are now
> made
> > > > > optional:
> > > > > 	- interrupts
> > > > > 	- keypad,num-rows
> > > > > 	- keypad,num-columns
> > > > > 	- linux,keymap
> > > > >
> > > > > However since the above properties are required to be specified
> when
> > > > > configuring the device as a keypad, dependencies have been added
> > > > > such that specifying either one would require the remaining as well.
> > > > >
> > > > > Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>
> > > > > ---
> > > > >  .../devicetree/bindings/input/adi,adp5588.yaml     | 33
> > > > ++++++++++++++++++----
> > > > >  1 file changed, 28 insertions(+), 5 deletions(-)
> > > > >
> > > > > diff --git
> a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > > index 26ea66834ae2..6c06464f822b 100644
> > > > > --- a/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > > +++ b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
> > > > > @@ -49,7 +49,10 @@ properties:
> > > > >    interrupt-controller:
> > > > >      description:
> > > > >        This property applies if either keypad,num-rows lower than 8 or
> > > > > -      keypad,num-columns lower than 10.
> > > > > +      keypad,num-columns lower than 10. This property does not
> apply if
> > > > > +      keypad,num-rows or keypad,num-columns are not specified
> since the
> > > > > +      device then acts as gpio only, during which interrupts are not
> > > > > +      utilized.
> > > > >
> > > > >    '#interrupt-cells':
> > > > >      const: 2
> > > > > @@ -65,13 +68,15 @@ properties:
> > > > >      minItems: 1
> > > > >      maxItems: 2
> > > > >
> > > > > +dependencies:
> > > > > +  keypad,num-rows: ["keypad,num-columns"]
> > > > > +  keypad,num-cols: ["keypad,num-rows"]
> > > > > +  linux,keymap: ["keypad,num-rows"]
> > > >
> > > > Is what you've got here sufficient? Adding "keypad,num-rows" won't
> > > > mandate "linux,keymap" which I think is wrong. I think all 3 entries
> > > > here need to contain both of the other two.
> > > >
> > >
> > > Ah, I can see the issue, thank you for pointing it out - I will be
> > > correcting that.
> > >
> > > > > +  interrupts: ["linux,keymap"]
> > > >
> > > > I still don't understand why interrupts are only allowed when the
> keymap
> > > > is present. I'd cover the interrupts with something like
> > > >
> > > > if:
> > > >   required:
> > > >     - linux,keymap
> > > >   then:
> > > >     required:
> > > >       - interrupts
> > > >
> > > > so that interrupts can be used while not in keypad mode. Unless of
> > > > course there's something (unmentioned in this patch) that prevents
> that.
> > >
> > > In case when the device is not in keypad mode, i.e, is purely using gpio -
> > > it doesn't trigger the interrupt.
> > > Due to this, I had restricted the same to keypad mode only(as a
> > > requirement). This was mentioned
> > > here:
> > >
> https://urldefense.com/v3/__https://lore.kernel.org/all/d4661ddc1d253678f
> d62be4c7e19eb0cff4174f6.camel@gmail.com/__;!!A3Ni8CS0y2Y!8MV0PPuz1
> XKzaNus-NtAS3oXtrcgaUWHi4sf7zsPFS5zH_NUaNz-qBqUXPBTbTE09wRTVa-
> zYLaSdTte8ymnPyRB$
> >
> > This says "not required", not "not functional". How come generating
> > interrupts becomes impossible when not in keypad mode? That's what
> needs
> > to be explained.
> >
> 
> I should have read the patch before replying in v4. Yes, I agree with Conor
> that
> what we need is to make the interrupt __required__ when using the keypad.
> In the
> case we have gpios, it's optional but it does not mean we should remove it.
> One
> usecase would be to use gpios still as inputs through gpio-keys.
> 
> - Nuno Sá

I see the issue, thank you for highlighting the same. I will make the changes now.

Thanks,
Utsav