[PATCH RFC V1 0/3] da9062: Add DA9062 OnKey support using the existing DA9063 OnKey driver

[PATCH RFC V1 0/3] da9062: Add DA9062 OnKey support using the existing DA9063 OnKey driver

[S Twiss]

From: S Twiss <stwiss.opensource@diasemi.com>

This patch set adds OnKey support for the Dialog DA9062 Power Management IC.
Changes are made to the existing DA9063 OnKey component so that functionality
in this device driver can be re-used to support the DA9062 OnKey.

This following patch set is the proposed method for re-using the existing
kernel OnKey drivers for chips whose OnKey blocks are functionally similar
to the DA9063 OnKey.

The main points for the MFD core and device tree changes are as follows.

- Alteration of the DA9063 OnKey Kconfig needs to be updated to depend on
  both MFD_DA9063 "or" MFD_DA9062. There is no explicit DA9062 OnKey Kconfig.
- The DA9062 MFD core should add a new OnKey resource as usual and an entry
  in the mfd_cell to support a component name and of_compatible for
  "da9062-onkey" and "dlg,da9062-onkey".
- The device tree binding support should include a compatible string for
  "dlg,da9062-onkey"

The main points for the OnKey changes are as follows:

A generic structure is used (called da9063_compatible_onkey_regmap) to hold
all generic registers and bitmasks for use with this type of OnKey component.

Functions in the DA9063 OnKey will be refactored to use this compatibility
struct and all accesses to generic registers/masks will be made through
this table look-up instead of using defines from the register header files
directly

Linkage between the DA9062 MFD and the DA9063 OnKey driver is created through
the use of an of_match_table entry in the platform_driver structure.
A re-work of da9063_onkey_probe() is necessary to use the of_match_node() and
dev_get_regmap() functions: this will provide initialisation of the generic
registers and masks and allow access to the regmap according to the correct
device tree specification.

The addition of a of_device_id table for DA9063 and DA9062 default data
is created. 

In this patch set the following is provided:
 - [PATCH V1 1/3]: MFD changes in DA9062 to support OnKey
 - [PATCH V1 2/3]: Update existing DA9063 OnKey to add DA9062 support
 - [PATCH V1 3/3]: Device tree bindings for DA9062 OnKey component

This patch applies against linux-next and next-20150708 

Thank you,
Steve Twiss, Dialog Semiconductor Ltd.

S Twiss (3):
  mfd: da9062: Support for the DA9063 OnKey in the DA9062 core
  onkey: da9063: Add DA9062 OnKey capability to DA9063 OnKey driver
  devicetree: da9062: Add device tree bindings for DA9062 OnKey

 Documentation/devicetree/bindings/mfd/da9062.txt |  18 +++
 drivers/input/misc/Kconfig                       |   6 +-
 drivers/input/misc/da9063_onkey.c                | 139 ++++++++++++++++++-----
 drivers/mfd/da9062-core.c                        |  11 ++
 4 files changed, 141 insertions(+), 33 deletions(-)

-- 
end-of-patch for PATCH RFC V1

[PATCH RFC V1 1/3] mfd: da9062: Support for the DA9063 OnKey in the DA9062 core

[S Twiss]

From: S Twiss <stwiss.opensource@diasemi.com>

Add MFD core driver support for a OnKey component

- MFD core adds the resource da9062_onkey_resources[] for the OnKey
- An appropriate value has been added into mfd_cell da9062_devs[] to
  support component .name = "da9062-onkey" and
  .of_compatible  = "dlg,da9062-onkey"

Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>

---
Checks performed with linux-next/next-20150708/scripts/checkpatch.pl
 da9062-core.c             total: 0 errors, 0 warnings, 523 lines checked
This patch applies against linux-next and next-20150708 


 drivers/mfd/da9062-core.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/drivers/mfd/da9062-core.c b/drivers/mfd/da9062-core.c
index 4cf0643..0732977 100644
--- a/drivers/mfd/da9062-core.c
+++ b/drivers/mfd/da9062-core.c
@@ -118,6 +118,10 @@ static struct resource da9062_wdt_resources[] = {
 	DEFINE_RES_NAMED(DA9062_IRQ_WDG_WARN, 1, "WD_WARN", IORESOURCE_IRQ),
 };
 
+static struct resource da9062_onkey_resources[] = {
+	DEFINE_RES_NAMED(DA9062_IRQ_ONKEY, 1, "ONKEY", IORESOURCE_IRQ),
+};
+
 static const struct mfd_cell da9062_devs[] = {
 	{
 		.name		= "da9062-core",
@@ -141,6 +145,13 @@ static const struct mfd_cell da9062_devs[] = {
 		.resources	= da9062_thermal_resources,
 		.of_compatible  = "dlg,da9062-thermal",
 	},
+	{
+		.name		= "da9062-onkey",
+		.num_resources	= ARRAY_SIZE(da9062_onkey_resources),
+		.resources	= da9062_onkey_resources,
+		.of_compatible = "dlg,da9062-onkey",
+	},
+
 };
 
 static int da9062_clear_fault_log(struct da9062 *chip)
-- 
end-of-patch for PATCH RFC V1

[PATCH RFC V1 3/3] devicetree: da9062: Add device tree bindings for DA9062 OnKey

[S Twiss]

From: S Twiss <stwiss.opensource@diasemi.com>

Add device tree bindings for the DA9062 OnKey driver component

Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>

---
Checks performed with linux-next/next-20150708/scripts/checkpatch.pl
 da9062.txt                total: 0 errors, 0 warnings, 97 lines checked
This patch applies against linux-next and next-20150708 


 Documentation/devicetree/bindings/mfd/da9062.txt | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Documentation/devicetree/bindings/mfd/da9062.txt b/Documentation/devicetree/bindings/mfd/da9062.txt
index 5765ed9..7752093 100644
--- a/Documentation/devicetree/bindings/mfd/da9062.txt
+++ b/Documentation/devicetree/bindings/mfd/da9062.txt
@@ -5,6 +5,7 @@ DA9062 consists of a large and varied group of sub-devices:
 Device                   Supply Names    Description
 ------                   ------------    -----------
 da9062-regulator        :               : LDOs & BUCKs
+da9062-onkey            :               : On Key
 da9062-watchdog         :               : Watchdog Timer
 
 ======
@@ -41,6 +42,18 @@ Sub-nodes:
   Documentation/devicetree/bindings/regulator/regulator.txt
 
 
+- onkey : This node defines the OnKey settings for controlling the key
+  functionality of the device. The node should contain the compatible property
+  with the value "dlg,da9063-onkey".
+
+  Optional onkey properties:
+
+  - dlg,disable-key-power : Disable power-down using a long key-press. If this
+    entry exists the OnKey driver will remove support for the KEY_POWER key
+    press. If this entry does not exist then by default the key-press
+    triggered power down is enabled and the OnKey will support both KEY_POWER
+    and KEY_SLEEP.
+
 - watchdog: This node defines the settings for the watchdog driver associated
   with the DA9062 PMIC. The compatible = "dlg,da9062-watchdog" should be added
   if a node is created.
@@ -59,6 +72,11 @@ Example:
 			compatible = "dlg,da9062-watchdog";
 		};
 
+		onkey {
+			compatible = "dlg,da9063-onkey";
+			dlg,disable-key-power;
+		};
+
 		regulators {
 			DA9062_BUCK1: buck1 {
 				regulator-name = "BUCK1";
-- 
end-of-patch for PATCH RFC V1

[PATCH RFC V1 2/3] onkey: da9063: Add DA9062 OnKey capability to DA9063 OnKey driver

[S Twiss]

From: S Twiss <stwiss.opensource@diasemi.com>

Add DA9062 OnKey support into the existing DA9063 OnKey driver component by
using generic access tables for common register and bit mask definitions.

The following change will add generic register and bit mask support to the
DA9063 OnKey.

The following alterations have been made to the DA9063 OnKey:

- Addition of a da9063_compatible_onkey_regmap structure to hold all
  generic registers and bitmasks for this type of OnKey component.
- Addition of an struct of_device_id table for DA9063 and DA9062
  defaults
- Refactoring functions to use struct da9063_compatible_onkey accesses
  to generic registers/masks instead of using defines from registers.h
- Re-work of da9063_onkey_probe() to use of_match_node() and
  dev_get_regmap() to provide initialisation of generic registers and
  masks and access to regmap

Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>

---
Checks performed with linux-next/next-20150708/scripts/checkpatch.pl
 Kconfig                   total: 0 errors, 14 warnings, 810 lines checked
 da9063_onkey.c            total: 0 errors, 2 warnings, 305 lines checked
This patch applies against linux-next and next-20150708 


 drivers/input/misc/Kconfig        |   6 +-
 drivers/input/misc/da9063_onkey.c | 139 ++++++++++++++++++++++++++++++--------
 2 files changed, 112 insertions(+), 33 deletions(-)

diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
index d4f0a81..42860f9 100644
--- a/drivers/input/misc/Kconfig
+++ b/drivers/input/misc/Kconfig
@@ -612,10 +612,10 @@ config INPUT_DA9055_ONKEY
 
 config INPUT_DA9063_ONKEY
 	tristate "Dialog DA9063 OnKey"
-	depends on MFD_DA9063
+	depends on MFD_DA9063 || MFD_DA9062
 	help
-	  Support the ONKEY of Dialog DA9063 Power Management IC as an
-	  input device reporting power button statue.
+	  Support the ONKEY of Dialog DA9063 and DA9062 Power Management ICs
+	  as an input device capable for reporting the power button status.
 
 	  To compile this driver as a module, choose M here: the module
 	  will be called da9063_onkey.
diff --git a/drivers/input/misc/da9063_onkey.c b/drivers/input/misc/da9063_onkey.c
index f577585..308de2e 100644
--- a/drivers/input/misc/da9063_onkey.c
+++ b/drivers/input/misc/da9063_onkey.c
@@ -1,5 +1,5 @@
 /*
- * OnKey device driver for DA9063
+ * OnKey device driver for DA9063 and DA9062 PMICs
  * Copyright (C) 2015  Dialog Semiconductor Ltd.
  *
  * This program is free software; you can redistribute it and/or
@@ -24,36 +24,96 @@
 #include <linux/mfd/da9063/core.h>
 #include <linux/mfd/da9063/pdata.h>
 #include <linux/mfd/da9063/registers.h>
+#include <linux/mfd/da9062/core.h>
+#include <linux/mfd/da9062/registers.h>
 
-struct da9063_onkey {
-	struct da9063 *hw;
+struct da9063_compatible_onkey_regmap {
+	/* REGS */
+	int onkey_status;
+	int onkey_pwr_signalling;
+	int onkey_fault_log;
+	int onkey_shutdown;
+	/* MASKS */
+	int onkey_nonkey_mask;
+	int onkey_nonkey_lock_mask;
+	int onkey_key_reset_mask;
+	int onkey_shutdown_mask;
+	/* NAMES */
+	char *name;
+};
+
+struct da9063_compatible_onkey {
 	struct delayed_work work;
 	struct input_dev *input;
 	struct device *dev;
+	struct regmap *regmap;
+	const struct da9063_compatible_onkey_regmap *config;
+	char phys[32];
 	bool key_power;
 };
 
+static const struct da9063_compatible_onkey_regmap da9063_regs = {
+	/* REGS */
+	.onkey_status = DA9063_REG_STATUS_A,
+	.onkey_pwr_signalling = DA9063_REG_CONTROL_B,
+	.onkey_fault_log = DA9063_REG_FAULT_LOG,
+	.onkey_shutdown = DA9063_REG_CONTROL_F,
+	/* MASKS */
+	.onkey_nonkey_mask = DA9063_NONKEY,
+	.onkey_nonkey_lock_mask = DA9063_NONKEY_LOCK,
+	.onkey_key_reset_mask = DA9063_KEY_RESET,
+	.onkey_shutdown_mask = DA9063_SHUTDOWN,
+	/* NAMES */
+	.name = DA9063_DRVNAME_ONKEY,
+};
+
+static const struct da9063_compatible_onkey_regmap da9062_regs = {
+	/* REGS */
+	.onkey_status = DA9062AA_STATUS_A,
+	.onkey_pwr_signalling = DA9062AA_CONTROL_B,
+	.onkey_fault_log = DA9062AA_FAULT_LOG,
+	.onkey_shutdown = DA9062AA_CONTROL_F,
+	/* MASKS */
+	.onkey_nonkey_mask = DA9062AA_NONKEY_MASK,
+	.onkey_nonkey_lock_mask = DA9062AA_NONKEY_LOCK_MASK,
+	.onkey_key_reset_mask = DA9062AA_KEY_RESET_MASK,
+	.onkey_shutdown_mask = DA9062AA_SHUTDOWN_MASK,
+	/* NAMES */
+	.name = "da9062-onkey",
+};
+
+static const struct of_device_id da9063_compatible_reg_id_table[] = {
+	{ .compatible = "dlg,da9063-onkey", .data = &da9063_regs },
+	{ .compatible = "dlg,da9062-onkey", .data = &da9062_regs },
+	{ },
+};
+
 static void da9063_poll_on(struct work_struct *work)
 {
-	struct da9063_onkey *onkey = container_of(work, struct da9063_onkey,
-						  work.work);
+	struct da9063_compatible_onkey *onkey = container_of(work,
+						struct da9063_compatible_onkey,
+						work.work);
+	const struct da9063_compatible_onkey_regmap *config = onkey->config;
 	unsigned int val;
 	int fault_log = 0;
 	bool poll = true;
 	int error;
 
 	/* Poll to see when the pin is released */
-	error = regmap_read(onkey->hw->regmap, DA9063_REG_STATUS_A, &val);
+	error = regmap_read(onkey->regmap,
+			    config->onkey_status,
+			    &val);
 	if (error) {
 		dev_err(onkey->dev,
 			"Failed to read ON status: %d\n", error);
 		goto err_poll;
 	}
 
-	if (!(val & DA9063_NONKEY)) {
-		error = regmap_update_bits(onkey->hw->regmap,
-					   DA9063_REG_CONTROL_B,
-					   DA9063_NONKEY_LOCK, 0);
+	if (!(val & config->onkey_nonkey_mask)) {
+		error = regmap_update_bits(onkey->regmap,
+					   config->onkey_pwr_signalling,
+					   config->onkey_nonkey_lock_mask,
+					   0);
 		if (error) {
 			dev_err(onkey->dev,
 				"Failed to reset the Key Delay %d\n", error);
@@ -70,15 +130,16 @@ static void da9063_poll_on(struct work_struct *work)
 	 * If the fault log KEY_RESET is detected, then clear it
 	 * and shut down the system.
 	 */
-	error = regmap_read(onkey->hw->regmap,
-			    DA9063_REG_FAULT_LOG, &fault_log);
+	error = regmap_read(onkey->regmap,
+			    config->onkey_fault_log,
+			    &fault_log);
 	if (error) {
 		dev_warn(&onkey->input->dev,
 			 "Cannot read FAULT_LOG: %d\n", error);
-	} else if (fault_log & DA9063_KEY_RESET) {
-		error = regmap_write(onkey->hw->regmap,
-				     DA9063_REG_FAULT_LOG,
-				     DA9063_KEY_RESET);
+	} else if (fault_log & config->onkey_key_reset_mask) {
+		error = regmap_write(onkey->regmap,
+				     config->onkey_fault_log,
+				     config->onkey_key_reset_mask);
 		if (error) {
 			dev_warn(&onkey->input->dev,
 				 "Cannot reset KEY_RESET fault log: %d\n",
@@ -88,10 +149,10 @@ static void da9063_poll_on(struct work_struct *work)
 			 * and then send shutdown command
 			 */
 			dev_dbg(&onkey->input->dev,
-				 "Sending SHUTDOWN to DA9063 ...\n");
-			error = regmap_write(onkey->hw->regmap,
-					     DA9063_REG_CONTROL_F,
-					     DA9063_SHUTDOWN);
+				"Sending SHUTDOWN to DA9063 ...\n");
+			error = regmap_write(onkey->regmap,
+					     config->onkey_shutdown,
+					     config->onkey_shutdown_mask);
 			if (error)
 				dev_err(&onkey->input->dev,
 					"Cannot SHUTDOWN DA9063: %d\n",
@@ -106,12 +167,15 @@ err_poll:
 
 static irqreturn_t da9063_onkey_irq_handler(int irq, void *data)
 {
-	struct da9063_onkey *onkey = data;
+	struct da9063_compatible_onkey *onkey = data;
+	const struct da9063_compatible_onkey_regmap *config = onkey->config;
 	unsigned int val;
 	int error;
 
-	error = regmap_read(onkey->hw->regmap, DA9063_REG_STATUS_A, &val);
-	if (onkey->key_power && !error && (val & DA9063_NONKEY)) {
+	error = regmap_read(onkey->regmap,
+			    config->onkey_status,
+			    &val);
+	if (onkey->key_power && !error && (val & config->onkey_nonkey_mask)) {
 		input_report_key(onkey->input, KEY_POWER, 1);
 		input_sync(onkey->input);
 		schedule_delayed_work(&onkey->work, 0);
@@ -129,7 +193,7 @@ static irqreturn_t da9063_onkey_irq_handler(int irq, void *data)
 
 static void da9063_cancel_poll(void *data)
 {
-	struct da9063_onkey *onkey = data;
+	struct da9063_compatible_onkey *onkey = data;
 
 	cancel_delayed_work_sync(&onkey->work);
 }
@@ -138,19 +202,31 @@ static int da9063_onkey_probe(struct platform_device *pdev)
 {
 	struct da9063 *da9063 = dev_get_drvdata(pdev->dev.parent);
 	struct da9063_pdata *pdata = dev_get_platdata(da9063->dev);
-	struct da9063_onkey *onkey;
+	struct da9063_compatible_onkey *onkey;
+	const struct of_device_id *match;
 	int irq;
 	int error;
 
-	onkey = devm_kzalloc(&pdev->dev, sizeof(struct da9063_onkey),
+	match = of_match_node(da9063_compatible_reg_id_table,
+			      pdev->dev.of_node);
+	if (!match)
+		return -ENXIO;
+
+	onkey = devm_kzalloc(&pdev->dev, sizeof(struct da9063_compatible_onkey),
 			     GFP_KERNEL);
 	if (!onkey) {
 		dev_err(&pdev->dev, "Failed to allocate memory.\n");
 		return -ENOMEM;
 	}
 
+	onkey->config = match->data;
 	onkey->dev = &pdev->dev;
-	onkey->hw = da9063;
+
+	onkey->regmap = dev_get_regmap(pdev->dev.parent, NULL);
+	if (!onkey->regmap) {
+		dev_err(&pdev->dev, "Parent regmap unavailable.\n");
+		return -ENXIO;
+	}
 
 	if (pdata)
 		onkey->key_power = pdata->key_power;
@@ -165,8 +241,10 @@ static int da9063_onkey_probe(struct platform_device *pdev)
 		return -ENOMEM;
 	}
 
-	onkey->input->name = DA9063_DRVNAME_ONKEY;
-	onkey->input->phys = DA9063_DRVNAME_ONKEY "/input0";
+	onkey->input->name = onkey->config->name;
+	snprintf(onkey->phys, sizeof(onkey->phys), "%s/input0",
+		 onkey->config->name);
+	onkey->input->phys = onkey->phys;
 	onkey->input->dev.parent = &pdev->dev;
 
 	if (onkey->key_power)
@@ -216,11 +294,12 @@ static struct platform_driver da9063_onkey_driver = {
 	.probe	= da9063_onkey_probe,
 	.driver	= {
 		.name	= DA9063_DRVNAME_ONKEY,
+		.of_match_table = da9063_compatible_reg_id_table,
 	},
 };
 module_platform_driver(da9063_onkey_driver);
 
 MODULE_AUTHOR("S Twiss <stwiss.opensource@diasemi.com>");
-MODULE_DESCRIPTION("Onkey device driver for Dialog DA9063");
+MODULE_DESCRIPTION("Onkey device driver for Dialog DA9063 and DA9062");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS("platform:" DA9063_DRVNAME_ONKEY);
-- 
end-of-patch for PATCH RFC V1

Re: [PATCH RFC V1 2/3] onkey: da9063: Add DA9062 OnKey capability to DA9063 OnKey driver

[Dmitry Torokhov]

Hi Steve,

On Tue, Jul 14, 2015 at 02:07:50PM +0100, S Twiss wrote:
> From: S Twiss <stwiss.opensource@diasemi.com>
> 
> Add DA9062 OnKey support into the existing DA9063 OnKey driver component by
> using generic access tables for common register and bit mask definitions.
> 
> The following change will add generic register and bit mask support to the
> DA9063 OnKey.
> 
> The following alterations have been made to the DA9063 OnKey:
> 
> - Addition of a da9063_compatible_onkey_regmap structure to hold all
>   generic registers and bitmasks for this type of OnKey component.
> - Addition of an struct of_device_id table for DA9063 and DA9062
>   defaults
> - Refactoring functions to use struct da9063_compatible_onkey accesses
>   to generic registers/masks instead of using defines from registers.h
> - Re-work of da9063_onkey_probe() to use of_match_node() and
>   dev_get_regmap() to provide initialisation of generic registers and
>   masks and access to regmap
> 
> Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>

Looks generally good, just a few comments.

> 
> ---
> Checks performed with linux-next/next-20150708/scripts/checkpatch.pl
>  Kconfig                   total: 0 errors, 14 warnings, 810 lines checked
>  da9063_onkey.c            total: 0 errors, 2 warnings, 305 lines checked
> This patch applies against linux-next and next-20150708 
> 
> 
>  drivers/input/misc/Kconfig        |   6 +-
>  drivers/input/misc/da9063_onkey.c | 139 ++++++++++++++++++++++++++++++--------
>  2 files changed, 112 insertions(+), 33 deletions(-)
> 
> diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
> index d4f0a81..42860f9 100644
> --- a/drivers/input/misc/Kconfig
> +++ b/drivers/input/misc/Kconfig
> @@ -612,10 +612,10 @@ config INPUT_DA9055_ONKEY
>  
>  config INPUT_DA9063_ONKEY
>  	tristate "Dialog DA9063 OnKey"

"Dialog DA9062/63 OnKey" maybe?

> -	depends on MFD_DA9063
> +	depends on MFD_DA9063 || MFD_DA9062
>  	help
> -	  Support the ONKEY of Dialog DA9063 Power Management IC as an
> -	  input device reporting power button statue.
> +	  Support the ONKEY of Dialog DA9063 and DA9062 Power Management ICs
> +	  as an input device capable for reporting the power button status.
>  
>  	  To compile this driver as a module, choose M here: the module
>  	  will be called da9063_onkey.
> diff --git a/drivers/input/misc/da9063_onkey.c b/drivers/input/misc/da9063_onkey.c
> index f577585..308de2e 100644
> --- a/drivers/input/misc/da9063_onkey.c
> +++ b/drivers/input/misc/da9063_onkey.c
> @@ -1,5 +1,5 @@
>  /*
> - * OnKey device driver for DA9063
> + * OnKey device driver for DA9063 and DA9062 PMICs
>   * Copyright (C) 2015  Dialog Semiconductor Ltd.
>   *
>   * This program is free software; you can redistribute it and/or
> @@ -24,36 +24,96 @@
>  #include <linux/mfd/da9063/core.h>
>  #include <linux/mfd/da9063/pdata.h>
>  #include <linux/mfd/da9063/registers.h>
> +#include <linux/mfd/da9062/core.h>
> +#include <linux/mfd/da9062/registers.h>
>  
> -struct da9063_onkey {
> -	struct da9063 *hw;
> +struct da9063_compatible_onkey_regmap {

Maybe call it da906x_chip_config?

> +	/* REGS */
> +	int onkey_status;
> +	int onkey_pwr_signalling;
> +	int onkey_fault_log;
> +	int onkey_shutdown;
> +	/* MASKS */
> +	int onkey_nonkey_mask;
> +	int onkey_nonkey_lock_mask;
> +	int onkey_key_reset_mask;
> +	int onkey_shutdown_mask;
> +	/* NAMES */
> +	char *name;

const char *?

> +};
> +
> +struct da9063_compatible_onkey {

If you did not rename the structure your diff would be smaller.

>  	struct delayed_work work;
>  	struct input_dev *input;
>  	struct device *dev;
> +	struct regmap *regmap;
> +	const struct da9063_compatible_onkey_regmap *config;
> +	char phys[32];
>  	bool key_power;
>  };
>  
> +static const struct da9063_compatible_onkey_regmap da9063_regs = {
> +	/* REGS */
> +	.onkey_status = DA9063_REG_STATUS_A,
> +	.onkey_pwr_signalling = DA9063_REG_CONTROL_B,
> +	.onkey_fault_log = DA9063_REG_FAULT_LOG,
> +	.onkey_shutdown = DA9063_REG_CONTROL_F,
> +	/* MASKS */
> +	.onkey_nonkey_mask = DA9063_NONKEY,
> +	.onkey_nonkey_lock_mask = DA9063_NONKEY_LOCK,
> +	.onkey_key_reset_mask = DA9063_KEY_RESET,
> +	.onkey_shutdown_mask = DA9063_SHUTDOWN,
> +	/* NAMES */
> +	.name = DA9063_DRVNAME_ONKEY,
> +};
> +
> +static const struct da9063_compatible_onkey_regmap da9062_regs = {
> +	/* REGS */
> +	.onkey_status = DA9062AA_STATUS_A,
> +	.onkey_pwr_signalling = DA9062AA_CONTROL_B,
> +	.onkey_fault_log = DA9062AA_FAULT_LOG,
> +	.onkey_shutdown = DA9062AA_CONTROL_F,
> +	/* MASKS */
> +	.onkey_nonkey_mask = DA9062AA_NONKEY_MASK,
> +	.onkey_nonkey_lock_mask = DA9062AA_NONKEY_LOCK_MASK,
> +	.onkey_key_reset_mask = DA9062AA_KEY_RESET_MASK,
> +	.onkey_shutdown_mask = DA9062AA_SHUTDOWN_MASK,
> +	/* NAMES */
> +	.name = "da9062-onkey",
> +};
> +
> +static const struct of_device_id da9063_compatible_reg_id_table[] = {
> +	{ .compatible = "dlg,da9063-onkey", .data = &da9063_regs },
> +	{ .compatible = "dlg,da9062-onkey", .data = &da9062_regs },
> +	{ },
> +};
> +
>  static void da9063_poll_on(struct work_struct *work)
>  {
> -	struct da9063_onkey *onkey = container_of(work, struct da9063_onkey,
> -						  work.work);
> +	struct da9063_compatible_onkey *onkey = container_of(work,
> +						struct da9063_compatible_onkey,
> +						work.work);
> +	const struct da9063_compatible_onkey_regmap *config = onkey->config;
>  	unsigned int val;
>  	int fault_log = 0;
>  	bool poll = true;
>  	int error;
>  
>  	/* Poll to see when the pin is released */
> -	error = regmap_read(onkey->hw->regmap, DA9063_REG_STATUS_A, &val);
> +	error = regmap_read(onkey->regmap,
> +			    config->onkey_status,
> +			    &val);
>  	if (error) {
>  		dev_err(onkey->dev,
>  			"Failed to read ON status: %d\n", error);
>  		goto err_poll;
>  	}
>  
> -	if (!(val & DA9063_NONKEY)) {
> -		error = regmap_update_bits(onkey->hw->regmap,
> -					   DA9063_REG_CONTROL_B,
> -					   DA9063_NONKEY_LOCK, 0);
> +	if (!(val & config->onkey_nonkey_mask)) {
> +		error = regmap_update_bits(onkey->regmap,
> +					   config->onkey_pwr_signalling,
> +					   config->onkey_nonkey_lock_mask,
> +					   0);
>  		if (error) {
>  			dev_err(onkey->dev,
>  				"Failed to reset the Key Delay %d\n", error);
> @@ -70,15 +130,16 @@ static void da9063_poll_on(struct work_struct *work)
>  	 * If the fault log KEY_RESET is detected, then clear it
>  	 * and shut down the system.
>  	 */
> -	error = regmap_read(onkey->hw->regmap,
> -			    DA9063_REG_FAULT_LOG, &fault_log);
> +	error = regmap_read(onkey->regmap,
> +			    config->onkey_fault_log,
> +			    &fault_log);
>  	if (error) {
>  		dev_warn(&onkey->input->dev,
>  			 "Cannot read FAULT_LOG: %d\n", error);
> -	} else if (fault_log & DA9063_KEY_RESET) {
> -		error = regmap_write(onkey->hw->regmap,
> -				     DA9063_REG_FAULT_LOG,
> -				     DA9063_KEY_RESET);
> +	} else if (fault_log & config->onkey_key_reset_mask) {
> +		error = regmap_write(onkey->regmap,
> +				     config->onkey_fault_log,
> +				     config->onkey_key_reset_mask);
>  		if (error) {
>  			dev_warn(&onkey->input->dev,
>  				 "Cannot reset KEY_RESET fault log: %d\n",
> @@ -88,10 +149,10 @@ static void da9063_poll_on(struct work_struct *work)
>  			 * and then send shutdown command
>  			 */
>  			dev_dbg(&onkey->input->dev,
> -				 "Sending SHUTDOWN to DA9063 ...\n");
> -			error = regmap_write(onkey->hw->regmap,
> -					     DA9063_REG_CONTROL_F,
> -					     DA9063_SHUTDOWN);
> +				"Sending SHUTDOWN to DA9063 ...\n");
> +			error = regmap_write(onkey->regmap,
> +					     config->onkey_shutdown,
> +					     config->onkey_shutdown_mask);
>  			if (error)
>  				dev_err(&onkey->input->dev,
>  					"Cannot SHUTDOWN DA9063: %d\n",
> @@ -106,12 +167,15 @@ err_poll:
>  
>  static irqreturn_t da9063_onkey_irq_handler(int irq, void *data)
>  {
> -	struct da9063_onkey *onkey = data;
> +	struct da9063_compatible_onkey *onkey = data;
> +	const struct da9063_compatible_onkey_regmap *config = onkey->config;
>  	unsigned int val;
>  	int error;
>  
> -	error = regmap_read(onkey->hw->regmap, DA9063_REG_STATUS_A, &val);
> -	if (onkey->key_power && !error && (val & DA9063_NONKEY)) {
> +	error = regmap_read(onkey->regmap,
> +			    config->onkey_status,
> +			    &val);
> +	if (onkey->key_power && !error && (val & config->onkey_nonkey_mask)) {
>  		input_report_key(onkey->input, KEY_POWER, 1);
>  		input_sync(onkey->input);
>  		schedule_delayed_work(&onkey->work, 0);
> @@ -129,7 +193,7 @@ static irqreturn_t da9063_onkey_irq_handler(int irq, void *data)
>  
>  static void da9063_cancel_poll(void *data)
>  {
> -	struct da9063_onkey *onkey = data;
> +	struct da9063_compatible_onkey *onkey = data;
>  
>  	cancel_delayed_work_sync(&onkey->work);
>  }
> @@ -138,19 +202,31 @@ static int da9063_onkey_probe(struct platform_device *pdev)
>  {
>  	struct da9063 *da9063 = dev_get_drvdata(pdev->dev.parent);
>  	struct da9063_pdata *pdata = dev_get_platdata(da9063->dev);
> -	struct da9063_onkey *onkey;
> +	struct da9063_compatible_onkey *onkey;
> +	const struct of_device_id *match;
>  	int irq;
>  	int error;
>  
> -	onkey = devm_kzalloc(&pdev->dev, sizeof(struct da9063_onkey),
> +	match = of_match_node(da9063_compatible_reg_id_table,
> +			      pdev->dev.of_node);
> +	if (!match)
> +		return -ENXIO;
> +
> +	onkey = devm_kzalloc(&pdev->dev, sizeof(struct da9063_compatible_onkey),
>  			     GFP_KERNEL);
>  	if (!onkey) {
>  		dev_err(&pdev->dev, "Failed to allocate memory.\n");
>  		return -ENOMEM;
>  	}
>  
> +	onkey->config = match->data;
>  	onkey->dev = &pdev->dev;
> -	onkey->hw = da9063;
> +
> +	onkey->regmap = dev_get_regmap(pdev->dev.parent, NULL);
> +	if (!onkey->regmap) {
> +		dev_err(&pdev->dev, "Parent regmap unavailable.\n");
> +		return -ENXIO;
> +	}
>  
>  	if (pdata)
>  		onkey->key_power = pdata->key_power;
> @@ -165,8 +241,10 @@ static int da9063_onkey_probe(struct platform_device *pdev)
>  		return -ENOMEM;
>  	}
>  
> -	onkey->input->name = DA9063_DRVNAME_ONKEY;
> -	onkey->input->phys = DA9063_DRVNAME_ONKEY "/input0";
> +	onkey->input->name = onkey->config->name;
> +	snprintf(onkey->phys, sizeof(onkey->phys), "%s/input0",
> +		 onkey->config->name);
> +	onkey->input->phys = onkey->phys;
>  	onkey->input->dev.parent = &pdev->dev;
>  
>  	if (onkey->key_power)
> @@ -216,11 +294,12 @@ static struct platform_driver da9063_onkey_driver = {
>  	.probe	= da9063_onkey_probe,
>  	.driver	= {
>  		.name	= DA9063_DRVNAME_ONKEY,
> +		.of_match_table = da9063_compatible_reg_id_table,
>  	},
>  };
>  module_platform_driver(da9063_onkey_driver);
>  
>  MODULE_AUTHOR("S Twiss <stwiss.opensource@diasemi.com>");
> -MODULE_DESCRIPTION("Onkey device driver for Dialog DA9063");
> +MODULE_DESCRIPTION("Onkey device driver for Dialog DA9063 and DA9062");
>  MODULE_LICENSE("GPL");
>  MODULE_ALIAS("platform:" DA9063_DRVNAME_ONKEY);
> -- 
> end-of-patch for PATCH RFC V1
> 

Thanks.

-- 
Dmitry

RE: [PATCH RFC V1 2/3] onkey: da9063: Add DA9062 OnKey capability to DA9063 OnKey driver

[Opensource [Steve Twiss]]

On 17 July 2015 23:51, Dmitry Torokhov wrote:

> Hi Steve,
> On Tue, Jul 14, 2015 at 02:07:50PM +0100, S Twiss wrote:
> > From: S Twiss <stwiss.opensource@diasemi.com>
> > Add DA9062 OnKey support into the existing DA9063 OnKey driver component by
> > using generic access tables for common register and bit mask definitions.
> >
> > The following change will add generic register and bit mask support to the
> > DA9063 OnKey.
> >
> > The following alterations have been made to the DA9063 OnKey:
> >
> > - Addition of a da9063_compatible_onkey_regmap structure to hold all
> >   generic registers and bitmasks for this type of OnKey component.
> > - Addition of an struct of_device_id table for DA9063 and DA9062
> >   defaults
> > - Refactoring functions to use struct da9063_compatible_onkey accesses
> >   to generic registers/masks instead of using defines from registers.h
> > - Re-work of da9063_onkey_probe() to use of_match_node() and
> >   dev_get_regmap() to provide initialisation of generic registers and
> >   masks and access to regmap
> >
> > Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>
> 
> Looks generally good, just a few comments.
> 

Hi Dmitry,

Thanks for taking the time to review this.

[...]

> > diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
> > index d4f0a81..42860f9 100644
> > --- a/drivers/input/misc/Kconfig
> > +++ b/drivers/input/misc/Kconfig
> > @@ -612,10 +612,10 @@ config INPUT_DA9055_ONKEY
> >
> >  config INPUT_DA9063_ONKEY
> >  	tristate "Dialog DA9063 OnKey"
> 
> "Dialog DA9062/63 OnKey" maybe?

Yep.
I can do that.

[...]
> >
> > -struct da9063_onkey {
> > -	struct da9063 *hw;
> > +struct da9063_compatible_onkey_regmap {
> 
> Maybe call it da906x_chip_config?

I will do this.

> > +	/* REGS */
> > +	int onkey_status;
> > +	int onkey_pwr_signalling;
> > +	int onkey_fault_log;
> > +	int onkey_shutdown;
> > +	/* MASKS */
> > +	int onkey_nonkey_mask;
> > +	int onkey_nonkey_lock_mask;
> > +	int onkey_key_reset_mask;
> > +	int onkey_shutdown_mask;
> > +	/* NAMES */
> > +	char *name;
> 
> const char *?
> 

Sure -- I'll change that.

> > +};
> > +
> > +struct da9063_compatible_onkey {
> 
> If you did not rename the structure your diff would be smaller.

Yep. I can rename this back to what it was previously.
[...]

I'll submit a PATCH V2 with those changes.

Regards,
Steve