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

[PATCH v8 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

---
Changes in v8:
	- Fixed indentation in document example (removed extra spaces)
- Link to v7: https://lore.kernel.org/r/20240704-adp5588_gpio_support-v7-0-e34eb7eba5ab@analog.com

Changes in v7:
	- Fixed commit subject for transported patch 
	- Driver now does not setup gpio_irq_chip if 
	  interrupt has not been provided
	- Fixed indentation for dtbinding example
- Link to v6: https://lore.kernel.org/r/20240704-adp5588_gpio_support-v6-0-cb65514d714b@analog.com

Changes in v6:
	- Restored functionality to register interrupts in GPIO
	  mode(i.e, these are optional but not exclusive to keypad mode
	  since even in pure gpio mode, they can be used as inputs via 
	  gpio-keys)
	- Updated dt-bindings such that each keypad property depends on
	  the others. Interrupts, although optional are now required by 
	  keypad mode but are not limited to it.
- Link to v5: https://lore.kernel.org/r/20240703-adp5588_gpio_support-v5-0-49fcead0d390@analog.com

---
Dmitry Torokhov (1):
      Input: 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     | 45 +++++++++--
 drivers/input/keyboard/adp5588-keys.c              | 86 +++++++++++++---------
 2 files changed, 90 insertions(+), 41 deletions(-)
---
base-commit: 1c52cf5e79d30ac996f34b64284f2c317004d641
change-id: 20240701-adp5588_gpio_support-65db2bd21a9f

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

[PATCH v8 1/3] Input: 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 v8 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 | 37 +++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)

diff --git a/drivers/input/keyboard/adp5588-keys.c b/drivers/input/keyboard/adp5588-keys.c
index 09bcfc6b9408..7c32f8b69a3e 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;
@@ -431,10 +432,12 @@ static int adp5588_gpio_add(struct adp5588_kpad *kpad)
 	kpad->gc.label = kpad->client->name;
 	kpad->gc.owner = THIS_MODULE;
 
-	girq = &kpad->gc.irq;
-	gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
-	girq->handler = handle_bad_irq;
-	girq->threaded = true;
+	if (kpad->client->irq) {
+		girq = &kpad->gc.irq;
+		gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
+		girq->handler = handle_bad_irq;
+		girq->threaded = true;
+	}
 
 	mutex_init(&kpad->gpio_lock);
 
@@ -632,6 +635,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 +793,11 @@ static int adp5588_probe(struct i2c_client *client)
 	if (error)
 		return error;
 
+	if (kpad->gpio_only && !client->irq) {
+		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,
@@ -785,6 +808,12 @@ static int adp5588_probe(struct i2c_client *client)
 		return error;
 	}
 
+	if (kpad->gpio_only) {
+		dev_info(&client->dev, "Rev.%d GPIO only, irq %d\n",
+				revid, client->irq);
+		return 0;
+	}
+
 	dev_info(&client->dev, "Rev.%d keypad, irq %d\n", revid, client->irq);
 	return 0;
 }

-- 
2.34.1

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

[Nuno Sá]

On Thu, 2024-07-04 at 15:26 +0100, Utsav Agarwal via B4 Relay wrote:
> 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>
> ---

Reviewed-by: Nuno Sa <nuno.sa@analog.com>

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

[Agarwal, Utsav]

> From: Nuno Sá <noname.nuno@gmail.com>
> Sent: Tuesday, July 9, 2024 7:37 AM
> To: Agarwal, Utsav <Utsav.Agarwal@analog.com>; 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>
> Cc: 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 v8 2/3] Input: adp5588-keys - add support for pure gpio
> 
> [External]
> 
> On Thu, 2024-07-04 at 15:26 +0100, Utsav Agarwal via B4 Relay wrote:
> > 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>
> > ---
> 
> Reviewed-by: Nuno Sa <nuno.sa@analog.com>
> 
Hi,

Since there have not been feedback comments on the same for some time, I wanted to check if any further changes/actions are required for it to be accepted.

Thanks,
Utsav

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

[Krzysztof Kozlowski]

On 22/07/2024 17:27, Agarwal, Utsav wrote:
>> From: Nuno Sá <noname.nuno@gmail.com>
>> Sent: Tuesday, July 9, 2024 7:37 AM
>> To: Agarwal, Utsav <Utsav.Agarwal@analog.com>; 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>
>> Cc: 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 v8 2/3] Input: adp5588-keys - add support for pure gpio
>>
>> [External]
>>
>> On Thu, 2024-07-04 at 15:26 +0100, Utsav Agarwal via B4 Relay wrote:
>>> 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>
>>> ---
>>
>> Reviewed-by: Nuno Sa <nuno.sa@analog.com>
>>
> Hi,
> 
> Since there have not been feedback comments on the same for some time, I wanted to check if any further changes/actions are required for it to be accepted.

Please observe merge window timeline.

Best regards,
Krzysztof

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

[Agarwal, Utsav]

> From: Krzysztof Kozlowski <krzk@kernel.org>
> Sent: Monday, July 22, 2024 4:47 PM
> To: Agarwal, Utsav <Utsav.Agarwal@analog.com>; Nuno Sá
> <noname.nuno@gmail.com>; 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>
> Cc: 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 v8 2/3] Input: adp5588-keys - add support for pure gpio
> 
> [External]
> 
> On 22/07/2024 17:27, Agarwal, Utsav wrote:
> >> From: Nuno Sá <noname.nuno@gmail.com>
> >> Sent: Tuesday, July 9, 2024 7:37 AM
> >> To: Agarwal, Utsav <Utsav.Agarwal@analog.com>; 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>
> >> Cc: 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 v8 2/3] Input: adp5588-keys - add support for pure
> gpio
> >>
> >> [External]
> >>
> >> On Thu, 2024-07-04 at 15:26 +0100, Utsav Agarwal via B4 Relay wrote:
> >>> 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>
> >>> ---
> >>
> >> Reviewed-by: Nuno Sa <nuno.sa@analog.com>
> >>
> > Hi,
> >
> > Since there have not been feedback comments on the same for some time,
> I wanted to check if any further changes/actions are required for it to be
> accepted.
> 
> Please observe merge window timeline.
> 
> Best regards,
> Krzysztof

I understand, thank you for pointing me to the same.

Thanks,
Utsav

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

[Dmitry Torokhov]

Hi Utsav,

On Thu, Jul 04, 2024 at 03:26:31PM +0100, Utsav Agarwal via B4 Relay wrote:
> 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 | 37 +++++++++++++++++++++++++++++++----
>  1 file changed, 33 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/input/keyboard/adp5588-keys.c b/drivers/input/keyboard/adp5588-keys.c
> index 09bcfc6b9408..7c32f8b69a3e 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;
> @@ -431,10 +432,12 @@ static int adp5588_gpio_add(struct adp5588_kpad *kpad)
>  	kpad->gc.label = kpad->client->name;
>  	kpad->gc.owner = THIS_MODULE;
>  
> -	girq = &kpad->gc.irq;
> -	gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> -	girq->handler = handle_bad_irq;
> -	girq->threaded = true;
> +	if (kpad->client->irq) {
> +		girq = &kpad->gc.irq;
> +		gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> +		girq->handler = handle_bad_irq;
> +		girq->threaded = true;
> +	}
>  
>  	mutex_init(&kpad->gpio_lock);
>  
> @@ -632,6 +635,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 +793,11 @@ static int adp5588_probe(struct i2c_client *client)
>  	if (error)
>  		return error;
>  
> +	if (kpad->gpio_only && !client->irq) {
> +		dev_info(&client->dev, "Rev.%d, started as GPIO only\n", revid);
> +		return 0;

I think we need more elaborate handling here (and probably more
elaborate binding yaml file): now that you are making interrupt optional
you should check if interrupt-controller functionality of the GPIO
block/gpiochip is requested. If it was, then we should not allow missing
interrupt. If only GPIO controller is needed, without interrupt
capabilities, tnen running without interrupt is fine.

Thanks.

-- 
Dmitry

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

[Nuno Sá]

On Fri, 2024-08-02 at 17:37 -0700, Dmitry Torokhov wrote:
> Hi Utsav,
> 
> On Thu, Jul 04, 2024 at 03:26:31PM +0100, Utsav Agarwal via B4 Relay wrote:
> > 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 | 37 +++++++++++++++++++++++++++++++-
> > ---
> >  1 file changed, 33 insertions(+), 4 deletions(-)
> > 
> > diff --git a/drivers/input/keyboard/adp5588-keys.c
> > b/drivers/input/keyboard/adp5588-keys.c
> > index 09bcfc6b9408..7c32f8b69a3e 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;
> > @@ -431,10 +432,12 @@ static int adp5588_gpio_add(struct adp5588_kpad *kpad)
> >  	kpad->gc.label = kpad->client->name;
> >  	kpad->gc.owner = THIS_MODULE;
> >  
> > -	girq = &kpad->gc.irq;
> > -	gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> > -	girq->handler = handle_bad_irq;
> > -	girq->threaded = true;
> > +	if (kpad->client->irq) {
> > +		girq = &kpad->gc.irq;
> > +		gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> > +		girq->handler = handle_bad_irq;
> > +		girq->threaded = true;
> > +	}
> >  
> >  	mutex_init(&kpad->gpio_lock);
> >  
> > @@ -632,6 +635,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 +793,11 @@ static int adp5588_probe(struct i2c_client *client)
> >  	if (error)
> >  		return error;
> >  
> > +	if (kpad->gpio_only && !client->irq) {
> > +		dev_info(&client->dev, "Rev.%d, started as GPIO only\n",
> > revid);
> > +		return 0;
> 
> I think we need more elaborate handling here (and probably more
> elaborate binding yaml file): now that you are making interrupt optional
> you should check if interrupt-controller functionality of the GPIO
> block/gpiochip is requested. If it was, then we should not allow missing
> interrupt. If only GPIO controller is needed, without interrupt
> capabilities, tnen running without interrupt is fine.
> 
Hi Dmitry,

I need to double check but I don't think we can act as an interrupt-controller
without the interrupt line connected. So, I think the only thing we could likely
add/improve is to express that dependency in the bindings.

- Nuno Sá

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

[Agarwal, Utsav]

> -----Original Message-----
> From: Nuno Sá <noname.nuno@gmail.com>
> Sent: Monday, August 5, 2024 7:44 AM
> To: Dmitry Torokhov <dmitry.torokhov@gmail.com>; Agarwal, Utsav
> <Utsav.Agarwal@analog.com>
> Cc: Hennerich, Michael <Michael.Hennerich@analog.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 v8 2/3] Input: adp5588-keys - add support for pure gpio
> 
> [External]
> 
> On Fri, 2024-08-02 at 17:37 -0700, Dmitry Torokhov wrote:
> > Hi Utsav,
> >
> > On Thu, Jul 04, 2024 at 03:26:31PM +0100, Utsav Agarwal via B4 Relay wrote:
> > > 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 | 37
> +++++++++++++++++++++++++++++++-
> > > ---
> > >  1 file changed, 33 insertions(+), 4 deletions(-)
> > >
> > > diff --git a/drivers/input/keyboard/adp5588-keys.c
> > > b/drivers/input/keyboard/adp5588-keys.c
> > > index 09bcfc6b9408..7c32f8b69a3e 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;
> > > @@ -431,10 +432,12 @@ static int adp5588_gpio_add(struct adp5588_kpad
> *kpad)
> > >  	kpad->gc.label = kpad->client->name;
> > >  	kpad->gc.owner = THIS_MODULE;
> > >
> > > -	girq = &kpad->gc.irq;
> > > -	gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> > > -	girq->handler = handle_bad_irq;
> > > -	girq->threaded = true;
> > > +	if (kpad->client->irq) {
> > > +		girq = &kpad->gc.irq;
> > > +		gpio_irq_chip_set_chip(girq, &adp5588_irq_chip);
> > > +		girq->handler = handle_bad_irq;
> > > +		girq->threaded = true;
> > > +	}
> > >
> > >  	mutex_init(&kpad->gpio_lock);
> > >
> > > @@ -632,6 +635,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 +793,11 @@ static int adp5588_probe(struct i2c_client *client)
> > >  	if (error)
> > >  		return error;
> > >
> > > +	if (kpad->gpio_only && !client->irq) {
> > > +		dev_info(&client->dev, "Rev.%d, started as GPIO only\n",
> > > revid);
> > > +		return 0;
> >
> > I think we need more elaborate handling here (and probably more
> > elaborate binding yaml file): now that you are making interrupt optional
> > you should check if interrupt-controller functionality of the GPIO
> > block/gpiochip is requested. If it was, then we should not allow missing
> > interrupt. If only GPIO controller is needed, without interrupt
> > capabilities, tnen running without interrupt is fine.
> >
> Hi Dmitry,
> 
> I need to double check but I don't think we can act as an interrupt-controller
> without the interrupt line connected. So, I think the only thing we could likely
> add/improve is to express that dependency in the bindings.
> 
> - Nuno Sá

Hi Dmitry,

Thank you for pointing out the dependency, I will add the same in the bindings.

Utsav
 

[PATCH v8 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 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.

Note that interrupts are optional, but required when the device has been
configured in keypad mode.

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

diff --git a/Documentation/devicetree/bindings/input/adi,adp5588.yaml b/Documentation/devicetree/bindings/input/adi,adp5588.yaml
index 26ea66834ae2..ccb24b8b7566 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 is optional if
+      keypad,num-rows or keypad,num-columns are not specified since the
+      device then acts as gpio only, during which interrupts may or may
+      not be utilized.
 
   '#interrupt-cells':
     const: 2
@@ -65,13 +68,28 @@ properties:
     minItems: 1
     maxItems: 2
 
+
+dependencies:
+  keypad,num-rows:
+    - linux,keymap
+    - keypad,num-columns
+  keypad,num-columns:
+    - linux,keymap
+    - keypad,num-rows
+  linux,keymap:
+    - keypad,num-rows
+    - keypad,num-columns
+
+if:
+  required:
+    - linux,keymap
+then:
+  required:
+    - interrupts
+
 required:
   - compatible
   - reg
-  - interrupts
-  - keypad,num-rows
-  - keypad,num-columns
-  - linux,keymap
 
 unevaluatedProperties: false
 
@@ -108,4 +126,21 @@ 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 v8 3/3] dt-bindings: input: Update dtbinding for adp5588

[Conor Dooley]

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

On Thu, Jul 04, 2024 at 03:26:32PM +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 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.
> 
> Note that interrupts are optional, but required when the device has been
> configured in keypad mode.
> 
> Signed-off-by: Utsav Agarwal <utsav.agarwal@analog.com>

Acked-by: Conor Dooley <conor.dooley@microchip.com>

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