Skip to contentSkip to conversation

hwmon: Add WM835x PMIC hardware monitoring driver

PATCH In review Mark Brown 2 participants 5 messages Jul 17, 2009 – Jul 18, 2009

Subsystems (3)
lore
Share & tools
lore

Mark Brown

author
#0 lore raw

PATCH 1/1 hwmon: Add WM835x PMIC hardware monitoring driver

This driver provides reporting of the status supply voltage rails of the WM835x series of PMICs via the hwmon API.

---
 drivers/hwmon/Kconfig           |   10 +++
 drivers/hwmon/Makefile          |    1 +
 drivers/hwmon/wm8350-hwmon.c    |  149 +++++++++++++++++++++++++++++++++++++++
 drivers/mfd/wm8350-core.c       |    3 +
 include/linux/mfd/wm8350/core.h |    6 ++
 5 files changed, 169 insertions(+), 0 deletions(-)
 create mode 100644 drivers/hwmon/wm8350-hwmon.c
drivers/hwmon/Kconfig +10 -0
index 2d50166..c94d708 100644
@@ -920,6 +920,16 @@ config SENSORS_W83627EHF
 	  This driver can also be built as a module.  If so, the module
 	  will be called w83627ehf.
 
+config SENSORS_WM8350
+	tristate "Wolfson Microelectronics WM835x"
+	depends on MFD_WM8350
+	help
+	  If you say yes here you get support for the hardware
+	  monitoring features of the WM835x series of PMICs.
+
+	  This driver can also be built as a module.  If so, the module
+	  will be called wm8350-hwmon.
+
 config SENSORS_ULTRA45
 	tristate "Sun Ultra45 PIC16F747"
 	depends on SPARC64
drivers/hwmon/Makefile +1 -0
index b793dce..c02e90e 100644
@@ -89,6 +89,7 @@ obj-$(CONFIG_SENSORS_VT8231)	+= vt8231.o
 obj-$(CONFIG_SENSORS_W83627EHF)	+= w83627ehf.o
 obj-$(CONFIG_SENSORS_W83L785TS)	+= w83l785ts.o
 obj-$(CONFIG_SENSORS_W83L786NG)	+= w83l786ng.o
+obj-$(CONFIG_SENSORS_WM8350)	+= wm8350-hwmon.o
 
 ifeq ($(CONFIG_HWMON_DEBUG_CHIP),y)
 EXTRA_CFLAGS += -DDEBUG
drivers/hwmon/wm8350-hwmon.c new file +149 -0

149 lines not on this page · raw message

drivers/mfd/wm8350-core.c +3 -0
index fe24079..9d662a5 100644
@@ -1472,6 +1472,8 @@ int wm8350_device_init(struct wm8350 *wm8350, int irq,
 				   &(wm8350->codec.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-gpio",
 				   &(wm8350->gpio.pdev));
+	wm8350_client_dev_register(wm8350, "wm8350-hwmon",
+				   &(wm8350->hwmon.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-power",
 				   &(wm8350->power.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-rtc", &(wm8350->rtc.pdev));
@@ -1498,6 +1500,7 @@ void wm8350_device_exit(struct wm8350 *wm8350)
 	platform_device_unregister(wm8350->wdt.pdev);
 	platform_device_unregister(wm8350->rtc.pdev);
 	platform_device_unregister(wm8350->power.pdev);
+	platform_device_unregister(wm8350->hwmon.pdev);
 	platform_device_unregister(wm8350->gpio.pdev);
 	platform_device_unregister(wm8350->codec.pdev);
 
include/linux/mfd/wm8350/core.h +6 -0
index 42cca67..969b0b5 100644
@@ -605,6 +605,11 @@ struct wm8350_irq {
 	void *data;
 };
 
+struct wm8350_hwmon {
+	struct platform_device *pdev;
+	struct device *classdev;
+};
+
 struct wm8350 {
 	struct device *dev;
 
@@ -629,6 +634,7 @@ struct wm8350 {
 	/* Client devices */
 	struct wm8350_codec codec;
 	struct wm8350_gpio gpio;
+	struct wm8350_hwmon hwmon;
 	struct wm8350_pmic pmic;
 	struct wm8350_power power;
 	struct wm8350_rtc rtc;
Signature · 7 lines
1.6.3.3


_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
#1 lore raw

Hi Mark,

Sorry for the delay. Thanks Jonathan for the 1st review!

Quoted 4 lines · Mark Brown

This driver provides reporting of the status supply voltage rails of the WM835x series of PMICs via the hwmon API.

Quoted 8 lines
---
 drivers/hwmon/Kconfig           |   10 +++
 drivers/hwmon/Makefile          |    1 +
 drivers/hwmon/wm8350-hwmon.c    |  149 +++++++++++++++++++++++++++++++++++++++
 drivers/mfd/wm8350-core.c       |    3 +
 include/linux/mfd/wm8350/core.h |    6 ++
 5 files changed, 169 insertions(+), 0 deletions(-)
 create mode 100644 drivers/hwmon/wm8350-hwmon.c

Overall it looks very good and I really don't have much to say. Only minor things, see below.

Quoted 40 lines
drivers/hwmon/Kconfig +10 -0
index 2d50166..c94d708 100644
@@ -920,6 +920,16 @@ config SENSORS_W83627EHF
 	  This driver can also be built as a module.  If so, the module
 	  will be called w83627ehf.
 
+config SENSORS_WM8350
+	tristate "Wolfson Microelectronics WM835x"
+	depends on MFD_WM8350
+	help
+	  If you say yes here you get support for the hardware
+	  monitoring features of the WM835x series of PMICs.
+
+	  This driver can also be built as a module.  If so, the module
+	  will be called wm8350-hwmon.
+
 config SENSORS_ULTRA45
 	tristate "Sun Ultra45 PIC16F747"
 	depends on SPARC64
drivers/hwmon/Makefile +1 -0
index b793dce..c02e90e 100644
@@ -89,6 +89,7 @@ obj-$(CONFIG_SENSORS_VT8231)	+= vt8231.o
 obj-$(CONFIG_SENSORS_W83627EHF)	+= w83627ehf.o
 obj-$(CONFIG_SENSORS_W83L785TS)	+= w83l785ts.o
 obj-$(CONFIG_SENSORS_W83L786NG)	+= w83l786ng.o
+obj-$(CONFIG_SENSORS_WM8350)	+= wm8350-hwmon.o
 
 ifeq ($(CONFIG_HWMON_DEBUG_CHIP),y)
 EXTRA_CFLAGS += -DDEBUG
drivers/hwmon/wm8350-hwmon.c new file +0 -0
new file mode 100644
index 0000000..7387620

drivers/hwmon/wm8350-hwmon.c line 2

Quoted 2 lines
drivers/hwmon/wm8350-hwmon.c new file +2 -0
@@ -0,0 +1,149 @@
+/*
+ * drivers/hwmon/wm8350-hwmon.c - Wolfson Microelectroncis WM8350 PMIC

Typo: Microelectronics.

Quoted 26 lines
drivers/hwmon/wm8350-hwmon.c new file +26 -0
+ *                                  hardware monitoring features.
+ *
+ * Copyright (C) 2009 Wolfson Microelectronics plc
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License v2 as published by the
+ * Free Software Foundation.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/hwmon.h>
+#include <linux/hwmon-sysfs.h>
+
+#include <linux/mfd/wm8350/core.h>
+#include <linux/mfd/wm8350/comparator.h>

drivers/hwmon/wm8350-hwmon.c line 38

Quoted 10 lines
drivers/hwmon/wm8350-hwmon.c new file +10 -0
+
+static ssize_t show_name(struct device *dev,
+			 struct device_attribute *attr, char *buf)
+{
+	return sprintf(buf, "wm8350\n");
+}
+
+static const char *input_names[] = {
+	[WM8350_AUXADC_USB]  = "USB" ,
+	[WM8350_AUXADC_LINE] = "Line" ,

Coding-style: extra spaces before commas.

drivers/hwmon/wm8350-hwmon.c line 51

Quoted 13 lines
drivers/hwmon/wm8350-hwmon.c new file +13 -0
+	[WM8350_AUXADC_BATT] = "Battery",
+};
+
+
+static ssize_t show_voltage(struct device *dev,
+			    struct device_attribute *attr, char *buf)
+{
+	struct wm8350 *wm8350 = dev_get_drvdata(dev);
+	int channel = to_sensor_dev_attr(attr)->index;
+	int val;
+
+	val = wm8350_read_auxadc(wm8350, channel, 0, 0)
+		* WM8350_AUX_COEFF / 1000;

You may obtain more accurate values with DIV_ROUND_CLOSEST().

Quoted 13 lines
drivers/hwmon/wm8350-hwmon.c new file +13 -0
+
+	return sprintf(buf, "%d\n", val);
+}
+
+static ssize_t show_label(struct device *dev,
+			  struct device_attribute *attr, char *buf)
+{
+	int channel = to_sensor_dev_attr(attr)->index;
+
+	return sprintf(buf, "%s\n", input_names[channel]);
+}
+
+#define WM8350_NAMED_VOLTAGE(id, name) \

drivers/hwmon/wm8350-hwmon.c line 74

Quoted 10 lines
drivers/hwmon/wm8350-hwmon.c new file +10 -0
+	static SENSOR_DEVICE_ATTR(in##id##_input, S_IRUGO, show_voltage,\
+				  NULL, WM8350_AUXADC_##name);		\
+	static SENSOR_DEVICE_ATTR(in##id##_label, S_IRUGO, show_label,	\
+				  NULL, WM8350_AUXADC_##name)
+
+static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
+
+WM8350_NAMED_VOLTAGE(0, USB);
+WM8350_NAMED_VOLTAGE(1, BATT);
+WM8350_NAMED_VOLTAGE(2, LINE);

I would suggest passing the whole WM8350_AUXADC_USB, etc. string as the 2nd parameter. This makes grepping the source code for users (as LXR does for example) possible.

Quoted 46 lines
drivers/hwmon/wm8350-hwmon.c new file +46 -0
+
+static struct attribute *wm8350_attributes[] = {
+	&dev_attr_name.attr,
+
+	&sensor_dev_attr_in0_input.dev_attr.attr,
+	&sensor_dev_attr_in0_label.dev_attr.attr,
+	&sensor_dev_attr_in1_input.dev_attr.attr,
+	&sensor_dev_attr_in1_label.dev_attr.attr,
+	&sensor_dev_attr_in2_input.dev_attr.attr,
+	&sensor_dev_attr_in2_label.dev_attr.attr,
+
+	NULL,
+};
+
+static const struct attribute_group wm8350_attr_group = {
+	.attrs	= wm8350_attributes,
+};
+
+static int __devinit wm8350_hwmon_probe(struct platform_device *pdev)
+{
+	struct wm8350 *wm8350 = platform_get_drvdata(pdev);
+	int ret;
+
+	ret = sysfs_create_group(&pdev->dev.kobj, &wm8350_attr_group);
+	if (ret)
+		goto err;
+
+	wm8350->hwmon.classdev = hwmon_device_register(&pdev->dev);
+	if (IS_ERR(wm8350->hwmon.classdev)) {
+		ret = PTR_ERR(wm8350->hwmon.classdev);
+		goto err_group;
+	}
+
+	return 0;
+
+err_group:
+	sysfs_remove_group(&pdev->dev.kobj, &wm8350_attr_group);
+err:
+	return ret;
+}
+
+static int __devexit wm8350_hwmon_remove(struct platform_device *pdev)
+{
+	struct wm8350 *wm8350 = platform_get_drvdata(pdev);
+
+	hwmon_device_unregister(wm8350->hwmon.classdev);

drivers/hwmon/wm8350-hwmon.c line 130

Quoted 10 lines
drivers/hwmon/wm8350-hwmon.c new file +10 -0
+	sysfs_remove_group(&pdev->dev.kobj, &wm8350_attr_group);
+
+	return 0;
+}
+
+static struct platform_driver wm8350_hwmon_driver = {
+	.probe = wm8350_hwmon_probe,
+	.remove = __devexit_p(wm8350_hwmon_remove),
+	.driver = {
+		.name = "wm8350-hwmon",

I think you are supposed to set .owner to THIS_MODULE?

Quoted 6 lines
drivers/hwmon/wm8350-hwmon.c new file +6 -0
+	},
+};
+
+static int __init wm8350_hwmon_init(void)
+{
+	return platform_driver_register(&wm8350_hwmon_driver);

drivers/hwmon/wm8350-hwmon.c line 146

Quoted 10 lines
drivers/hwmon/wm8350-hwmon.c new file +10 -0
+}
+module_init(wm8350_hwmon_init);
+
+static void __exit wm8350_hwmon_exit(void)
+{
+	platform_driver_unregister(&wm8350_hwmon_driver);
+}
+module_exit(wm8350_hwmon_exit);
+
+MODULE_AUTHOR("Mark Brown");

No e-mail address?

Quoted 41 lines
drivers/hwmon/wm8350-hwmon.c new file +3 -0
+MODULE_DESCRIPTION("WM8350 Hardware Monitoring");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS("platform:wm8350-hwmon");
drivers/mfd/wm8350-core.c +3 -0
index fe24079..9d662a5 100644
@@ -1472,6 +1472,8 @@ int wm8350_device_init(struct wm8350 *wm8350, int irq,
 				   &(wm8350->codec.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-gpio",
 				   &(wm8350->gpio.pdev));
+	wm8350_client_dev_register(wm8350, "wm8350-hwmon",
+				   &(wm8350->hwmon.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-power",
 				   &(wm8350->power.pdev));
 	wm8350_client_dev_register(wm8350, "wm8350-rtc", &(wm8350->rtc.pdev));
@@ -1498,6 +1500,7 @@ void wm8350_device_exit(struct wm8350 *wm8350)
 	platform_device_unregister(wm8350->wdt.pdev);
 	platform_device_unregister(wm8350->rtc.pdev);
 	platform_device_unregister(wm8350->power.pdev);
+	platform_device_unregister(wm8350->hwmon.pdev);
 	platform_device_unregister(wm8350->gpio.pdev);
 	platform_device_unregister(wm8350->codec.pdev);
 
include/linux/mfd/wm8350/core.h +5 -0
index 42cca67..969b0b5 100644
@@ -605,6 +605,11 @@ struct wm8350_irq {
 	void *data;
 };
 
+struct wm8350_hwmon {
+	struct platform_device *pdev;
+	struct device *classdev;
+};
+
 struct wm8350 {
 	struct device *dev;
 

include/linux/mfd/wm8350/core.h struct wm8350 { · line 640

Quoted 7 lines
include/linux/mfd/wm8350/core.h +1 -0
@@ -629,6 +634,7 @@ struct wm8350 {
 	/* Client devices */
 	struct wm8350_codec codec;
 	struct wm8350_gpio gpio;
+	struct wm8350_hwmon hwmon;
 	struct wm8350_pmic pmic;
 	struct wm8350_power power;
 	struct wm8350_rtc rtc;

Bonus points if you also add a short text file at Documentation/hwmon/wm8350-hwmon, using the same format as the other files there, shortly explaining what hardware the driver is for, what it is capable of (e.g. measurement resolution, accuracy and range) and, if applicable, its limitations.

When you are done, what is your merge plan? I would be happy to take the patch in my unofficial hwmon tree and push it in 2.6.32, but due to wm8350-core dependencies, you may prefer it to be merged differently?

Signature · 6 lines
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
author
#2 lore raw
Quoted 7 lines · Jean Delvare

drivers/hwmon/wm8350-hwmon.c line 74

Quoted 3 lines
drivers/hwmon/wm8350-hwmon.c new file +3 -0
+WM8350_NAMED_VOLTAGE(0, USB);
+WM8350_NAMED_VOLTAGE(1, BATT);
+WM8350_NAMED_VOLTAGE(2, LINE);

I would suggest passing the whole WM8350_AUXADC_USB, etc. string as the 2nd parameter. This makes grepping the source code for users (as LXR does for example) possible.

The reason it's formatted like that is that the AUXADC input names match the names of the supplies that are being monitored so the second parameter is also used to provide a label to userspace.

Quoted 7 lines

drivers/hwmon/wm8350-hwmon.c line 130

Quoted 5 lines
drivers/hwmon/wm8350-hwmon.c new file +5 -0
+static struct platform_driver wm8350_hwmon_driver = {
+	.probe = wm8350_hwmon_probe,
+	.remove = __devexit_p(wm8350_hwmon_remove),
+	.driver = {
+		.name = "wm8350-hwmon",

I think you are supposed to set .owner to THIS_MODULE?

Hrm, yeah. I need to figure out where I cut'n'pasted this from since I suspect the error came along with that.

Quoted 3 lines

When you are done, what is your merge plan? I would be happy to take the patch in my unofficial hwmon tree and push it in 2.6.32, but due to wm8350-core dependencies, you may prefer it to be merged differently?

I'm happy to go with whatever is easiest for the people actually doing the merging. wm8350 is fairly static at the minute - it's much more likely that there would be merge issues from the build infrastructure. It might be a little easier to merge via mfd.

I'll fix the rest of your comments, thanks.

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors

#3 lore raw
Quoted 10 lines · Mark Brown
Quoted 7 lines · Jean Delvare

drivers/hwmon/wm8350-hwmon.c line 74

Quoted 3 lines
drivers/hwmon/wm8350-hwmon.c new file +3 -0
+WM8350_NAMED_VOLTAGE(0, USB);
+WM8350_NAMED_VOLTAGE(1, BATT);
+WM8350_NAMED_VOLTAGE(2, LINE);

I would suggest passing the whole WM8350_AUXADC_USB, etc. string as the 2nd parameter. This makes grepping the source code for users (as LXR does for example) possible.

Quoted 3 lines

The reason it's formatted like that is that the AUXADC input names match the names of the supplies that are being monitored so the second parameter is also used to provide a label to userspace.

This isn't how I read the code. I see a look-up table for labels, so the macro implementation is just a detail which shouldn't matter.

Quoted 10 lines
Quoted 7 lines

drivers/hwmon/wm8350-hwmon.c line 130

Quoted 5 lines
drivers/hwmon/wm8350-hwmon.c new file +5 -0
+static struct platform_driver wm8350_hwmon_driver = {
+	.probe = wm8350_hwmon_probe,
+	.remove = __devexit_p(wm8350_hwmon_remove),
+	.driver = {
+		.name = "wm8350-hwmon",

I think you are supposed to set .owner to THIS_MODULE?

Hrm, yeah. I need to figure out where I cut'n'pasted this from since I suspect the error came along with that.

Maybe from an i2c driver, where the owner is set at run-time. Back when this was implemented, I did object that it would cause confusion because it would make different subsystems have different requirements... Looks like I was right.

Quoted 8 lines
Quoted 3 lines

When you are done, what is your merge plan? I would be happy to take the patch in my unofficial hwmon tree and push it in 2.6.32, but due to wm8350-core dependencies, you may prefer it to be merged differently?

I'm happy to go with whatever is easiest for the people actually doing the merging. wm8350 is fairly static at the minute - it's much more likely that there would be merge issues from the build infrastructure. It might be a little easier to merge via mfd.

Fine with me.

Quoted 1 line

I'll fix the rest of your comments, thanks.

OK.

Signature · 6 lines
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
author
#4 lore raw
Quoted 8 lines · Jean Delvare
Quoted 3 lines · Mark Brown

The reason it's formatted like that is that the AUXADC input names match the names of the supplies that are being monitored so the second parameter is also used to provide a label to userspace.

This isn't how I read the code. I see a look-up table for labels, so the macro implementation is just a detail which shouldn't matter.

Oh, yes, you're right. Originally I'd implemented it the way I describe but changed the code later - I'd forgotten that I'd done so when replying to your mail.

I'll send a revised version out on Monday.

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors