diff mbox

[V8] input: add onkey support to 88PM80X PMIC

Message ID 1341997504-23522-2-git-send-email-zhouqiao@marvell.com (mailing list archive)
State New, archived
Headers show

Commit Message

Qiao Zhou July 11, 2012, 9:05 a.m. UTC 
add onkey support to MARVELL 88PM80X PMIC.

Signed-off-by: Qiao Zhou <zhouqiao@marvell.com>
---
 drivers/input/misc/88pm80x_onkey.c |  169 ++++++++++++++++++++++++++++++++++++
 drivers/input/misc/Kconfig         |   10 ++
 drivers/input/misc/Makefile        |    1 +
 3 files changed, 180 insertions(+), 0 deletions(-)
 create mode 100644 drivers/input/misc/88pm80x_onkey.c

Comments

Dmitry Torokhov July 13, 2012, 7:34 a.m. UTC | #1 
Hi Qiao,

On Wed, Jul 11, 2012 at 05:05:04PM +0800, Qiao Zhou wrote:
> +
> +static int __devinit pm80x_onkey_probe(struct platform_device *pdev)
> +{
> +
> +	struct pm80x_chip *chip = dev_get_drvdata(pdev->dev.parent);
> +	struct pm80x_onkey_info *info;
> +	int err;
> +
> +	info =
> +	    devm_kzalloc(&pdev->dev, sizeof(struct pm80x_onkey_info),
> +			 GFP_KERNEL);

Please switch to normal kzalloc/kfree, because:

1. You are not using devm_* API correctly - it was designed so that you
do not need to explicitly call devm_free as resources will be freed when
device is unbound from the driver (or if binf fails). But since you are
explicitly calling devm_free() in error paths and in
pm80x_onkey_remove() there is no point in even using this API.

2. At this time I prefer not use devm_ API in input drivers are it
causes mixed resource tracking strategy (automatic vs manual) which is
confusing.

> +	if (!info)
> +		return -ENOMEM;
> +
> +	info->pm80x = chip;
> +
> +	info->irq = platform_get_irq(pdev, 0);
> +	if (info->irq < 0) {
> +		dev_err(&pdev->dev, "No IRQ resource!\n");
> +		err = -EINVAL;
> +		goto out;
> +	}
> +
> +	info->map = info->pm80x->regmap;
> +	if (!info->map) {
> +		dev_err(&pdev->dev, "no regmap!\n");
> +		err = -EINVAL;
> +		goto out;
> +	}
> +
> +	err = pm80x_request_irq(info->pm80x, info->irq, pm80x_onkey_handler,
> +					    IRQF_ONESHOT, "onkey", info);
> +	if (err < 0) {
> +		dev_err(&pdev->dev, "Failed to request IRQ: #%d: %d\n",
> +			info->irq, err);
> +		goto out;
> +	}
> 

If we get IRQ here we'll OOPS. Please allocate input device before
requesting IRQ (but register like you do now, as the last action, after
requesting IRQ).

+
> +	info->idev = input_allocate_device();
> +	if (!info->idev) {
> +		dev_err(&pdev->dev, "Failed to allocate input dev\n");
> +		err = -ENOMEM;
> +		goto out_irq;
> +	}
> +
> +	info->idev->name = "88pm80x_on";
> +	info->idev->phys = "88pm80x_on/input0";
> +	info->idev->id.bustype = BUS_I2C;
> +	info->idev->dev.parent = &pdev->dev;
> +	info->idev->evbit[0] = BIT_MASK(EV_KEY);
> +	info->idev->keybit[BIT_WORD(KEY_POWER)] = BIT_MASK(KEY_POWER);

	__set_bit(KEY_POWER, info->idev->keybit);

> +
> +	err = input_register_device(info->idev);
> +	if (err) {
> +		dev_err(&pdev->dev, "Can't register input device: %d\n", err);
> +		goto out_reg;
> +	}
> +
> +	platform_set_drvdata(pdev, info);
> +
> +	/* Enable long onkey detection */
> +	regmap_update_bits(info->map, PM800_RTC_MISC4, PM800_LONG_ONKEY_EN,
> +			   PM800_LONG_ONKEY_EN);
> +	/* Set 8-second interval */
> +	regmap_update_bits(info->map, PM800_RTC_MISC3,
> +			   PM800_LONKEY_PRESS_TIME_MASK,
> +			   PM800_LONKEY_PRESS_TIME);
> +
> +	device_init_wakeup(&pdev->dev, 1);
> +	return 0;
> +
> +out_reg:
> +	input_free_device(info->idev);
> +out_irq:
> +	pm80x_free_irq(info->pm80x, info->irq, info);
> +out:
> +	devm_kfree(&pdev->dev, info);

	kfree(info);

> +	return err;
> +}
> +
> +static int __devexit pm80x_onkey_remove(struct platform_device *pdev)
> +{
> +	struct pm80x_onkey_info *info = platform_get_drvdata(pdev);
> +
> +	input_unregister_device(info->idev);

If interrupt comes here we'll OOPS. You need to free IRQ first.

> +	pm80x_free_irq(info->pm80x, info->irq, info);
> +	devm_kfree(&pdev->dev, info);
	kfree(info);
> +	return 0;
> +}
> +
> +static struct platform_driver pm80x_onkey_driver = {
> +	.driver = {
> +		   .name = "88pm80x-onkey",
> +		   .owner = THIS_MODULE,
> +		   .pm = &pm80x_onkey_pm_ops,
> +		   },
> +	.probe = pm80x_onkey_probe,
> +	.remove = __devexit_p(pm80x_onkey_remove),
> +};
> +
> +module_platform_driver(pm80x_onkey_driver);
> +
> +MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Marvell 88PM80x ONKEY driver");
> +MODULE_AUTHOR("Qiao Zhou <zhouqiao@marvell.com>");
> +MODULE_ALIAS("platform:88pm80x-onkey");
> diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
> index 7faf4a7..7c0f1ec 100644
> --- a/drivers/input/misc/Kconfig
> +++ b/drivers/input/misc/Kconfig
> @@ -22,6 +22,16 @@ config INPUT_88PM860X_ONKEY
>  	  To compile this driver as a module, choose M here: the module
>  	  will be called 88pm860x_onkey.
>  
> +config INPUT_88PM80X_ONKEY
> +	tristate "88PM80x ONKEY support"
> +	depends on MFD_88PM800
> +	help
> +	  Support the ONKEY of Marvell 88PM80x PMICs as an input device
> +	  reporting power button status.
> +
> +	  To compile this driver as a module, choose M here: the module
> +	  will be called 88pm80x_onkey.
> +
>  config INPUT_AB8500_PONKEY
>  	tristate "AB8500 Pon (PowerOn) Key"
>  	depends on AB8500_CORE
> diff --git a/drivers/input/misc/Makefile b/drivers/input/misc/Makefile
> index f55cdf4..83fe6f5 100644
> --- a/drivers/input/misc/Makefile
> +++ b/drivers/input/misc/Makefile
> @@ -5,6 +5,7 @@
>  # Each configuration option enables a list of files.
>  
>  obj-$(CONFIG_INPUT_88PM860X_ONKEY)	+= 88pm860x_onkey.o
> +obj-$(CONFIG_INPUT_88PM80X_ONKEY)	+= 88pm80x_onkey.o
>  obj-$(CONFIG_INPUT_AB8500_PONKEY)	+= ab8500-ponkey.o
>  obj-$(CONFIG_INPUT_AD714X)		+= ad714x.o
>  obj-$(CONFIG_INPUT_AD714X_I2C)		+= ad714x-i2c.o
> -- 
> 1.7.0.4
> 

Thanks!
Qiao Zhou July 13, 2012, 7:39 a.m. UTC | #2 
On 07/13/2012 03:34 PM, Dmitry Torokhov wrote:
> Hi Qiao,
>
> On Wed, Jul 11, 2012 at 05:05:04PM +0800, Qiao Zhou wrote:
>> +
>> +static int __devinit pm80x_onkey_probe(struct platform_device *pdev)
>> +{
>> +
>> +	struct pm80x_chip *chip = dev_get_drvdata(pdev->dev.parent);
>> +	struct pm80x_onkey_info *info;
>> +	int err;
>> +
>> +	info =
>> +	    devm_kzalloc(&pdev->dev, sizeof(struct pm80x_onkey_info),
>> +			 GFP_KERNEL);
>
> Please switch to normal kzalloc/kfree, because:
>
> 1. You are not using devm_* API correctly - it was designed so that you
> do not need to explicitly call devm_free as resources will be freed when
> device is unbound from the driver (or if binf fails). But since you are
> explicitly calling devm_free() in error paths and in
> pm80x_onkey_remove() there is no point in even using this API.
>
> 2. At this time I prefer not use devm_ API in input drivers are it
> causes mixed resource tracking strategy (automatic vs manual) which is
> confusing.
thanks for advise. would update.
>
>> +	if (!info)
>> +		return -ENOMEM;
>> +
>> +	info->pm80x = chip;
>> +
>> +	info->irq = platform_get_irq(pdev, 0);
>> +	if (info->irq < 0) {
>> +		dev_err(&pdev->dev, "No IRQ resource!\n");
>> +		err = -EINVAL;
>> +		goto out;
>> +	}
>> +
>> +	info->map = info->pm80x->regmap;
>> +	if (!info->map) {
>> +		dev_err(&pdev->dev, "no regmap!\n");
>> +		err = -EINVAL;
>> +		goto out;
>> +	}
>> +
>> +	err = pm80x_request_irq(info->pm80x, info->irq, pm80x_onkey_handler,
>> +					    IRQF_ONESHOT, "onkey", info);
>> +	if (err < 0) {
>> +		dev_err(&pdev->dev, "Failed to request IRQ: #%d: %d\n",
>> +			info->irq, err);
>> +		goto out;
>> +	}
>>
>
> If we get IRQ here we'll OOPS. Please allocate input device before
> requesting IRQ (but register like you do now, as the last action, after
> requesting IRQ).
would fix it.
>
> +
>> +	info->idev = input_allocate_device();
>> +	if (!info->idev) {
>> +		dev_err(&pdev->dev, "Failed to allocate input dev\n");
>> +		err = -ENOMEM;
>> +		goto out_irq;
>> +	}
>> +
>> +	info->idev->name = "88pm80x_on";
>> +	info->idev->phys = "88pm80x_on/input0";
>> +	info->idev->id.bustype = BUS_I2C;
>> +	info->idev->dev.parent = &pdev->dev;
>> +	info->idev->evbit[0] = BIT_MASK(EV_KEY);
>> +	info->idev->keybit[BIT_WORD(KEY_POWER)] = BIT_MASK(KEY_POWER);
>
> 	__set_bit(KEY_POWER, info->idev->keybit);
would update.
>
>> +
>> +	err = input_register_device(info->idev);
>> +	if (err) {
>> +		dev_err(&pdev->dev, "Can't register input device: %d\n", err);
>> +		goto out_reg;
>> +	}
>> +
>> +	platform_set_drvdata(pdev, info);
>> +
>> +	/* Enable long onkey detection */
>> +	regmap_update_bits(info->map, PM800_RTC_MISC4, PM800_LONG_ONKEY_EN,
>> +			   PM800_LONG_ONKEY_EN);
>> +	/* Set 8-second interval */
>> +	regmap_update_bits(info->map, PM800_RTC_MISC3,
>> +			   PM800_LONKEY_PRESS_TIME_MASK,
>> +			   PM800_LONKEY_PRESS_TIME);
>> +
>> +	device_init_wakeup(&pdev->dev, 1);
>> +	return 0;
>> +
>> +out_reg:
>> +	input_free_device(info->idev);
>> +out_irq:
>> +	pm80x_free_irq(info->pm80x, info->irq, info);
>> +out:
>> +	devm_kfree(&pdev->dev, info);
>
> 	kfree(info);
>
would update.
>> +	return err;
>> +}
>> +
>> +static int __devexit pm80x_onkey_remove(struct platform_device *pdev)
>> +{
>> +	struct pm80x_onkey_info *info = platform_get_drvdata(pdev);
>> +
>> +	input_unregister_device(info->idev);
>
> If interrupt comes here we'll OOPS. You need to free IRQ first.
would update.
>
>> +	pm80x_free_irq(info->pm80x, info->irq, info);
>> +	devm_kfree(&pdev->dev, info);
> 	kfree(info);
would update.
>> +	return 0;
>> +}
>> +
>> +static struct platform_driver pm80x_onkey_driver = {
>> +	.driver = {
>> +		   .name = "88pm80x-onkey",
>> +		   .owner = THIS_MODULE,
>> +		   .pm = &pm80x_onkey_pm_ops,
>> +		   },
>> +	.probe = pm80x_onkey_probe,
>> +	.remove = __devexit_p(pm80x_onkey_remove),
>> +};
>> +
>> +module_platform_driver(pm80x_onkey_driver);
>> +
>> +MODULE_LICENSE("GPL");
>> +MODULE_DESCRIPTION("Marvell 88PM80x ONKEY driver");
>> +MODULE_AUTHOR("Qiao Zhou <zhouqiao@marvell.com>");
>> +MODULE_ALIAS("platform:88pm80x-onkey");
>> diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
>> index 7faf4a7..7c0f1ec 100644
>> --- a/drivers/input/misc/Kconfig
>> +++ b/drivers/input/misc/Kconfig
>> @@ -22,6 +22,16 @@ config INPUT_88PM860X_ONKEY
>>   	  To compile this driver as a module, choose M here: the module
>>   	  will be called 88pm860x_onkey.
>>
>> +config INPUT_88PM80X_ONKEY
>> +	tristate "88PM80x ONKEY support"
>> +	depends on MFD_88PM800
>> +	help
>> +	  Support the ONKEY of Marvell 88PM80x PMICs as an input device
>> +	  reporting power button status.
>> +
>> +	  To compile this driver as a module, choose M here: the module
>> +	  will be called 88pm80x_onkey.
>> +
>>   config INPUT_AB8500_PONKEY
>>   	tristate "AB8500 Pon (PowerOn) Key"
>>   	depends on AB8500_CORE
>> diff --git a/drivers/input/misc/Makefile b/drivers/input/misc/Makefile
>> index f55cdf4..83fe6f5 100644
>> --- a/drivers/input/misc/Makefile
>> +++ b/drivers/input/misc/Makefile
>> @@ -5,6 +5,7 @@
>>   # Each configuration option enables a list of files.
>>
>>   obj-$(CONFIG_INPUT_88PM860X_ONKEY)	+= 88pm860x_onkey.o
>> +obj-$(CONFIG_INPUT_88PM80X_ONKEY)	+= 88pm80x_onkey.o
>>   obj-$(CONFIG_INPUT_AB8500_PONKEY)	+= ab8500-ponkey.o
>>   obj-$(CONFIG_INPUT_AD714X)		+= ad714x.o
>>   obj-$(CONFIG_INPUT_AD714X_I2C)		+= ad714x-i2c.o
>> --
>> 1.7.0.4
>>
>
> Thanks!
>
Dmitry,

thanks a lot for the correction.
diff mbox

Patch

diff --git a/drivers/input/misc/88pm80x_onkey.c b/drivers/input/misc/88pm80x_onkey.c
new file mode 100644
index 0000000..964aec6
--- /dev/null
+++ b/drivers/input/misc/88pm80x_onkey.c
@@ -0,0 +1,169 @@ 
+/*
+ * Marvell 88PM80x ONKEY driver
+ *
+ * Copyright (C) 2012 Marvell International Ltd.
+ * Haojian Zhuang <haojian.zhuang@marvell.com>
+ * Qiao Zhou <zhouqiao@marvell.com>
+ *
+ * This file is subject to the terms and conditions of the GNU General
+ * Public License. See the file "COPYING" in the main directory of this
+ * archive for more details.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/input.h>
+#include <linux/mfd/88pm80x.h>
+#include <linux/regmap.h>
+#include <linux/slab.h>
+
+#define PM800_LONG_ONKEY_EN		(1 << 0)
+#define PM800_LONG_KEY_DELAY		(8)	/* 1 .. 16 seconds */
+#define PM800_LONKEY_PRESS_TIME		((PM800_LONG_KEY_DELAY-1) << 4)
+#define PM800_LONKEY_PRESS_TIME_MASK	(0xF0)
+#define PM800_SW_PDOWN			(1 << 5)
+
+struct pm80x_onkey_info {
+	struct input_dev *idev;
+	struct pm80x_chip *pm80x;
+	struct regmap *map;
+	int irq;
+};
+
+/* 88PM80x gives us an interrupt when ONKEY is held */
+static irqreturn_t pm80x_onkey_handler(int irq, void *data)
+{
+	struct pm80x_onkey_info *info = data;
+	int ret = 0;
+	unsigned int val;
+
+	ret = regmap_read(info->map, PM800_STATUS_1, &val);
+	if (ret < 0) {
+		pr_err("%s: failed to read status: %d\n", __func__, ret);
+		return IRQ_NONE;
+	}
+	val &= PM800_ONKEY_STS1;
+
+	input_report_key(info->idev, KEY_POWER, val);
+	input_sync(info->idev);
+
+	return IRQ_HANDLED;
+}
+
+static SIMPLE_DEV_PM_OPS(pm80x_onkey_pm_ops, pm80x_dev_suspend,
+			 pm80x_dev_resume);
+
+static int __devinit pm80x_onkey_probe(struct platform_device *pdev)
+{
+
+	struct pm80x_chip *chip = dev_get_drvdata(pdev->dev.parent);
+	struct pm80x_onkey_info *info;
+	int err;
+
+	info =
+	    devm_kzalloc(&pdev->dev, sizeof(struct pm80x_onkey_info),
+			 GFP_KERNEL);
+	if (!info)
+		return -ENOMEM;
+
+	info->pm80x = chip;
+
+	info->irq = platform_get_irq(pdev, 0);
+	if (info->irq < 0) {
+		dev_err(&pdev->dev, "No IRQ resource!\n");
+		err = -EINVAL;
+		goto out;
+	}
+
+	info->map = info->pm80x->regmap;
+	if (!info->map) {
+		dev_err(&pdev->dev, "no regmap!\n");
+		err = -EINVAL;
+		goto out;
+	}
+
+	err = pm80x_request_irq(info->pm80x, info->irq, pm80x_onkey_handler,
+					    IRQF_ONESHOT, "onkey", info);
+	if (err < 0) {
+		dev_err(&pdev->dev, "Failed to request IRQ: #%d: %d\n",
+			info->irq, err);
+		goto out;
+	}
+
+	info->idev = input_allocate_device();
+	if (!info->idev) {
+		dev_err(&pdev->dev, "Failed to allocate input dev\n");
+		err = -ENOMEM;
+		goto out_irq;
+	}
+
+	info->idev->name = "88pm80x_on";
+	info->idev->phys = "88pm80x_on/input0";
+	info->idev->id.bustype = BUS_I2C;
+	info->idev->dev.parent = &pdev->dev;
+	info->idev->evbit[0] = BIT_MASK(EV_KEY);
+	info->idev->keybit[BIT_WORD(KEY_POWER)] = BIT_MASK(KEY_POWER);
+
+	err = input_register_device(info->idev);
+	if (err) {
+		dev_err(&pdev->dev, "Can't register input device: %d\n", err);
+		goto out_reg;
+	}
+
+	platform_set_drvdata(pdev, info);
+
+	/* Enable long onkey detection */
+	regmap_update_bits(info->map, PM800_RTC_MISC4, PM800_LONG_ONKEY_EN,
+			   PM800_LONG_ONKEY_EN);
+	/* Set 8-second interval */
+	regmap_update_bits(info->map, PM800_RTC_MISC3,
+			   PM800_LONKEY_PRESS_TIME_MASK,
+			   PM800_LONKEY_PRESS_TIME);
+
+	device_init_wakeup(&pdev->dev, 1);
+	return 0;
+
+out_reg:
+	input_free_device(info->idev);
+out_irq:
+	pm80x_free_irq(info->pm80x, info->irq, info);
+out:
+	devm_kfree(&pdev->dev, info);
+	return err;
+}
+
+static int __devexit pm80x_onkey_remove(struct platform_device *pdev)
+{
+	struct pm80x_onkey_info *info = platform_get_drvdata(pdev);
+
+	input_unregister_device(info->idev);
+	pm80x_free_irq(info->pm80x, info->irq, info);
+	devm_kfree(&pdev->dev, info);
+	return 0;
+}
+
+static struct platform_driver pm80x_onkey_driver = {
+	.driver = {
+		   .name = "88pm80x-onkey",
+		   .owner = THIS_MODULE,
+		   .pm = &pm80x_onkey_pm_ops,
+		   },
+	.probe = pm80x_onkey_probe,
+	.remove = __devexit_p(pm80x_onkey_remove),
+};
+
+module_platform_driver(pm80x_onkey_driver);
+
+MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Marvell 88PM80x ONKEY driver");
+MODULE_AUTHOR("Qiao Zhou <zhouqiao@marvell.com>");
+MODULE_ALIAS("platform:88pm80x-onkey");
diff --git a/drivers/input/misc/Kconfig b/drivers/input/misc/Kconfig
index 7faf4a7..7c0f1ec 100644
--- a/drivers/input/misc/Kconfig
+++ b/drivers/input/misc/Kconfig
@@ -22,6 +22,16 @@  config INPUT_88PM860X_ONKEY
 	  To compile this driver as a module, choose M here: the module
 	  will be called 88pm860x_onkey.
 
+config INPUT_88PM80X_ONKEY
+	tristate "88PM80x ONKEY support"
+	depends on MFD_88PM800
+	help
+	  Support the ONKEY of Marvell 88PM80x PMICs as an input device
+	  reporting power button status.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called 88pm80x_onkey.
+
 config INPUT_AB8500_PONKEY
 	tristate "AB8500 Pon (PowerOn) Key"
 	depends on AB8500_CORE
diff --git a/drivers/input/misc/Makefile b/drivers/input/misc/Makefile
index f55cdf4..83fe6f5 100644
--- a/drivers/input/misc/Makefile
+++ b/drivers/input/misc/Makefile
@@ -5,6 +5,7 @@ 
 # Each configuration option enables a list of files.
 
 obj-$(CONFIG_INPUT_88PM860X_ONKEY)	+= 88pm860x_onkey.o
+obj-$(CONFIG_INPUT_88PM80X_ONKEY)	+= 88pm80x_onkey.o
 obj-$(CONFIG_INPUT_AB8500_PONKEY)	+= ab8500-ponkey.o
 obj-$(CONFIG_INPUT_AD714X)		+= ad714x.o
 obj-$(CONFIG_INPUT_AD714X_I2C)		+= ad714x-i2c.o