Commit 24c1aa8587922ba1a3ca4fa58748e94f13b97fab

Authored by Neelesh Gupta
Committed by Guenter Roeck
1 parent a8bfeceb0c

hwmon: (powerpc/powernv) hwmon driver for power, fan rpm, voltage and temperature

This patch adds basic kernel support for reading power values, fan
speed rpm, voltage and temperature data on powernv platforms which
will be exported to user space through sysfs interface.

Test results:
-------------
[root@tul163p1 ~]# sensors
ibmpowernv-isa-0000
Adapter: ISA adapter
fan1:        5465 RPM  (min =    0 RPM)
fan2:        5152 RPM  (min =    0 RPM)
fan3:        5521 RPM  (min =    0 RPM)
fan4:        4891 RPM  (min =    0 RPM)
fan5:           0 RPM  (min =    0 RPM)
fan6:           0 RPM  (min =    0 RPM)
fan7:        7480 RPM  (min =    0 RPM)
fan8:        7944 RPM  (min =    0 RPM)
temp1:        +39.0°C  (high =  +0.0°C)
power1:      190.00 W

[root@tul163p1 ~]# ls /sys/devices/platform/
alarmtimer  ibmpowernv.0  power  rtc-generic  serial8250  uevent
[root@tul163p1 ~]# ls /sys/devices/platform/ibmpowernv.0/hwmon/hwmon0/
device	    fan2_min	fan4_min    fan6_min	fan8_min   power
fan1_fault  fan3_fault	fan5_fault  fan7_fault	in1_fault  power1_input
fan1_input  fan3_input	fan5_input  fan7_input	in2_fault  subsystem
fan1_min    fan3_min	fan5_min    fan7_min	in3_fault  temp1_input
fan2_fault  fan4_fault	fan6_fault  fan8_fault	in4_fault  temp1_max
fan2_input  fan4_input	fan6_input  fan8_input	name	   uevent
[root@tul163p1 ~]# ls /sys/class/hwmon/hwmon0/
device	    fan2_min	fan4_min    fan6_min	fan8_min   power
fan1_fault  fan3_fault	fan5_fault  fan7_fault	in1_fault  power1_input
fan1_input  fan3_input	fan5_input  fan7_input	in2_fault  subsystem
fan1_min    fan3_min	fan5_min    fan7_min	in3_fault  temp1_input
fan2_fault  fan4_fault	fan6_fault  fan8_fault	in4_fault  temp1_max
fan2_input  fan4_input	fan6_input  fan8_input	name	   uevent
[root@tul163p1 ~]#

Signed-off-by: Neelesh Gupta <neelegup@linux.vnet.ibm.com>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>

Showing 5 changed files with 440 additions and 0 deletions Side-by-side Diff

Documentation/devicetree/bindings/hwmon/ibmpowernv.txt
  1 +IBM POWERNV platform sensors
  2 +----------------------------
  3 +
  4 +Required node properties:
  5 +- compatible: must be one of
  6 + "ibm,opal-sensor-cooling-fan"
  7 + "ibm,opal-sensor-amb-temp"
  8 + "ibm,opal-sensor-power-supply"
  9 + "ibm,opal-sensor-power"
  10 +- sensor-id: an opaque id provided by the firmware to the kernel, identifies a
  11 + given sensor and its attribute data
  12 +
  13 +Example sensors node:
  14 +
  15 +cooling-fan#8-data {
  16 + sensor-id = <0x7052107>;
  17 + compatible = "ibm,opal-sensor-cooling-fan";
  18 +};
  19 +
  20 +amb-temp#1-thrs {
  21 + sensor-id = <0x5096000>;
  22 + compatible = "ibm,opal-sensor-amb-temp";
  23 +};
Documentation/hwmon/ibmpowernv
  1 +Kernel Driver IBMPOWERNV
  2 +========================
  3 +
  4 +Supported systems:
  5 + * Any recent IBM P servers based on POWERNV platform
  6 +
  7 +Author: Neelesh Gupta
  8 +
  9 +Description
  10 +-----------
  11 +
  12 +This driver implements reading the platform sensors data like temperature/fan/
  13 +voltage/power for 'POWERNV' platform.
  14 +
  15 +The driver uses the platform device infrastructure. It probes the device tree
  16 +for sensor devices during the __init phase and registers them with the 'hwmon'.
  17 +'hwmon' populates the 'sysfs' tree having attribute files, each for a given
  18 +sensor type and its attribute data.
  19 +
  20 +All the nodes in the DT appear under "/ibm,opal/sensors" and each valid node in
  21 +the DT maps to an attribute file in 'sysfs'. The node exports unique 'sensor-id'
  22 +which the driver uses to make an OPAL call to the firmware.
  23 +
  24 +Usage notes
  25 +-----------
  26 +The driver is built statically with the kernel by enabling the config
  27 +CONFIG_SENSORS_IBMPOWERNV. It can also be built as module 'ibmpowernv'.
  28 +
  29 +Sysfs attributes
  30 +----------------
  31 +
  32 +fanX_input Measured RPM value.
  33 +fanX_min Threshold RPM for alert generation.
  34 +fanX_fault 0: No fail condition
  35 + 1: Failing fan
  36 +tempX_input Measured ambient temperature.
  37 +tempX_max Threshold ambient temperature for alert generation.
  38 +inX_input Measured power supply voltage
  39 +inX_fault 0: No fail condition.
  40 + 1: Failing power supply.
  41 +power1_input System power consumption (microWatt)
drivers/hwmon/Kconfig
... ... @@ -554,6 +554,17 @@
554 554 This driver can also be built as a module. If so, the module
555 555 will be called ibmpex.
556 556  
  557 +config SENSORS_IBMPOWERNV
  558 + tristate "IBM POWERNV platform sensors"
  559 + depends on PPC_POWERNV
  560 + default y
  561 + help
  562 + If you say yes here you get support for the temperature/fan/power
  563 + sensors on your PowerNV platform.
  564 +
  565 + This driver can also be built as a module. If so, the module
  566 + will be called ibmpowernv.
  567 +
557 568 config SENSORS_IIO_HWMON
558 569 tristate "Hwmon driver that uses channels specified via iio maps"
559 570 depends on IIO
drivers/hwmon/Makefile
... ... @@ -71,6 +71,7 @@
71 71 obj-$(CONFIG_SENSORS_I5K_AMB) += i5k_amb.o
72 72 obj-$(CONFIG_SENSORS_IBMAEM) += ibmaem.o
73 73 obj-$(CONFIG_SENSORS_IBMPEX) += ibmpex.o
  74 +obj-$(CONFIG_SENSORS_IBMPOWERNV)+= ibmpowernv.o
74 75 obj-$(CONFIG_SENSORS_IIO_HWMON) += iio_hwmon.o
75 76 obj-$(CONFIG_SENSORS_INA209) += ina209.o
76 77 obj-$(CONFIG_SENSORS_INA2XX) += ina2xx.o
drivers/hwmon/ibmpowernv.c
  1 +/*
  2 + * IBM PowerNV platform sensors for temperature/fan/voltage/power
  3 + * Copyright (C) 2014 IBM
  4 + *
  5 + * This program is free software; you can redistribute it and/or modify
  6 + * it under the terms of the GNU General Public License as published by
  7 + * the Free Software Foundation; either version 2 of the License, or
  8 + * (at your option) any later version.
  9 + *
  10 + * This program is distributed in the hope that it will be useful,
  11 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 + * GNU General Public License for more details.
  14 + *
  15 + * You should have received a copy of the GNU General Public License
  16 + * along with this program.
  17 + */
  18 +
  19 +#define DRVNAME "ibmpowernv"
  20 +#define pr_fmt(fmt) DRVNAME ": " fmt
  21 +
  22 +#include <linux/init.h>
  23 +#include <linux/module.h>
  24 +#include <linux/kernel.h>
  25 +#include <linux/hwmon.h>
  26 +#include <linux/hwmon-sysfs.h>
  27 +#include <linux/of.h>
  28 +#include <linux/slab.h>
  29 +
  30 +#include <linux/platform_device.h>
  31 +#include <asm/opal.h>
  32 +#include <linux/err.h>
  33 +
  34 +#define MAX_ATTR_LEN 32
  35 +
  36 +/* Sensor suffix name from DT */
  37 +#define DT_FAULT_ATTR_SUFFIX "faulted"
  38 +#define DT_DATA_ATTR_SUFFIX "data"
  39 +#define DT_THRESHOLD_ATTR_SUFFIX "thrs"
  40 +
  41 +/*
  42 + * Enumerates all the types of sensors in the POWERNV platform and does index
  43 + * into 'struct sensor_group'
  44 + */
  45 +enum sensors {
  46 + FAN,
  47 + AMBIENT_TEMP,
  48 + POWER_SUPPLY,
  49 + POWER_INPUT,
  50 + MAX_SENSOR_TYPE,
  51 +};
  52 +
  53 +static struct sensor_group {
  54 + const char *name;
  55 + const char *compatible;
  56 + struct attribute_group group;
  57 + u32 attr_count;
  58 +} sensor_groups[] = {
  59 + {"fan", "ibm,opal-sensor-cooling-fan"},
  60 + {"temp", "ibm,opal-sensor-amb-temp"},
  61 + {"in", "ibm,opal-sensor-power-supply"},
  62 + {"power", "ibm,opal-sensor-power"}
  63 +};
  64 +
  65 +struct sensor_data {
  66 + u32 id; /* An opaque id of the firmware for each sensor */
  67 + enum sensors type;
  68 + char name[MAX_ATTR_LEN];
  69 + struct device_attribute dev_attr;
  70 +};
  71 +
  72 +struct platform_data {
  73 + const struct attribute_group *attr_groups[MAX_SENSOR_TYPE + 1];
  74 + u32 sensors_count; /* Total count of sensors from each group */
  75 +};
  76 +
  77 +/* Platform device representing all the ibmpowernv sensors */
  78 +static struct platform_device *pdevice;
  79 +
  80 +static ssize_t show_sensor(struct device *dev, struct device_attribute *devattr,
  81 + char *buf)
  82 +{
  83 + struct sensor_data *sdata = container_of(devattr, struct sensor_data,
  84 + dev_attr);
  85 + ssize_t ret;
  86 + u32 x;
  87 +
  88 + ret = opal_get_sensor_data(sdata->id, &x);
  89 + if (ret)
  90 + return ret;
  91 +
  92 + /* Convert temperature to milli-degrees */
  93 + if (sdata->type == AMBIENT_TEMP)
  94 + x *= 1000;
  95 + /* Convert power to micro-watts */
  96 + else if (sdata->type == POWER_INPUT)
  97 + x *= 1000000;
  98 +
  99 + return sprintf(buf, "%u\n", x);
  100 +}
  101 +
  102 +static int __init get_sensor_index_attr(const char *name, u32 *index,
  103 + char *attr)
  104 +{
  105 + char *hash_pos = strchr(name, '#');
  106 + char buf[8] = { 0 };
  107 + char *dash_pos;
  108 + u32 copy_len;
  109 + int err;
  110 +
  111 + if (!hash_pos)
  112 + return -EINVAL;
  113 +
  114 + dash_pos = strchr(hash_pos, '-');
  115 + if (!dash_pos)
  116 + return -EINVAL;
  117 +
  118 + copy_len = dash_pos - hash_pos - 1;
  119 + if (copy_len >= sizeof(buf))
  120 + return -EINVAL;
  121 +
  122 + strncpy(buf, hash_pos + 1, copy_len);
  123 +
  124 + err = kstrtou32(buf, 10, index);
  125 + if (err)
  126 + return err;
  127 +
  128 + strncpy(attr, dash_pos + 1, MAX_ATTR_LEN);
  129 +
  130 + return 0;
  131 +}
  132 +
  133 +/*
  134 + * This function translates the DT node name into the 'hwmon' attribute name.
  135 + * IBMPOWERNV device node appear like cooling-fan#2-data, amb-temp#1-thrs etc.
  136 + * which need to be mapped as fan2_input, temp1_max respectively before
  137 + * populating them inside hwmon device class.
  138 + */
  139 +static int __init create_hwmon_attr_name(struct device *dev, enum sensors type,
  140 + const char *node_name,
  141 + char *hwmon_attr_name)
  142 +{
  143 + char attr_suffix[MAX_ATTR_LEN];
  144 + char *attr_name;
  145 + u32 index;
  146 + int err;
  147 +
  148 + err = get_sensor_index_attr(node_name, &index, attr_suffix);
  149 + if (err) {
  150 + dev_err(dev, "Sensor device node name '%s' is invalid\n",
  151 + node_name);
  152 + return err;
  153 + }
  154 +
  155 + if (!strcmp(attr_suffix, DT_FAULT_ATTR_SUFFIX)) {
  156 + attr_name = "fault";
  157 + } else if (!strcmp(attr_suffix, DT_DATA_ATTR_SUFFIX)) {
  158 + attr_name = "input";
  159 + } else if (!strcmp(attr_suffix, DT_THRESHOLD_ATTR_SUFFIX)) {
  160 + if (type == AMBIENT_TEMP)
  161 + attr_name = "max";
  162 + else if (type == FAN)
  163 + attr_name = "min";
  164 + else
  165 + return -ENOENT;
  166 + } else {
  167 + return -ENOENT;
  168 + }
  169 +
  170 + snprintf(hwmon_attr_name, MAX_ATTR_LEN, "%s%d_%s",
  171 + sensor_groups[type].name, index, attr_name);
  172 + return 0;
  173 +}
  174 +
  175 +static int __init populate_attr_groups(struct platform_device *pdev)
  176 +{
  177 + struct platform_data *pdata = platform_get_drvdata(pdev);
  178 + const struct attribute_group **pgroups = pdata->attr_groups;
  179 + struct device_node *opal, *np;
  180 + enum sensors type;
  181 +
  182 + opal = of_find_node_by_path("/ibm,opal/sensors");
  183 + if (!opal) {
  184 + dev_err(&pdev->dev, "Opal node 'sensors' not found\n");
  185 + return -ENODEV;
  186 + }
  187 +
  188 + for_each_child_of_node(opal, np) {
  189 + if (np->name == NULL)
  190 + continue;
  191 +
  192 + for (type = 0; type < MAX_SENSOR_TYPE; type++)
  193 + if (of_device_is_compatible(np,
  194 + sensor_groups[type].compatible)) {
  195 + sensor_groups[type].attr_count++;
  196 + break;
  197 + }
  198 + }
  199 +
  200 + of_node_put(opal);
  201 +
  202 + for (type = 0; type < MAX_SENSOR_TYPE; type++) {
  203 + sensor_groups[type].group.attrs = devm_kzalloc(&pdev->dev,
  204 + sizeof(struct attribute *) *
  205 + (sensor_groups[type].attr_count + 1),
  206 + GFP_KERNEL);
  207 + if (!sensor_groups[type].group.attrs)
  208 + return -ENOMEM;
  209 +
  210 + pgroups[type] = &sensor_groups[type].group;
  211 + pdata->sensors_count += sensor_groups[type].attr_count;
  212 + sensor_groups[type].attr_count = 0;
  213 + }
  214 +
  215 + return 0;
  216 +}
  217 +
  218 +/*
  219 + * Iterate through the device tree for each child of 'sensors' node, create
  220 + * a sysfs attribute file, the file is named by translating the DT node name
  221 + * to the name required by the higher 'hwmon' driver like fan1_input, temp1_max
  222 + * etc..
  223 + */
  224 +static int __init create_device_attrs(struct platform_device *pdev)
  225 +{
  226 + struct platform_data *pdata = platform_get_drvdata(pdev);
  227 + const struct attribute_group **pgroups = pdata->attr_groups;
  228 + struct device_node *opal, *np;
  229 + struct sensor_data *sdata;
  230 + const __be32 *sensor_id;
  231 + enum sensors type;
  232 + u32 count = 0;
  233 + int err = 0;
  234 +
  235 + opal = of_find_node_by_path("/ibm,opal/sensors");
  236 + sdata = devm_kzalloc(&pdev->dev, pdata->sensors_count * sizeof(*sdata),
  237 + GFP_KERNEL);
  238 + if (!sdata) {
  239 + err = -ENOMEM;
  240 + goto exit_put_node;
  241 + }
  242 +
  243 + for_each_child_of_node(opal, np) {
  244 + if (np->name == NULL)
  245 + continue;
  246 +
  247 + for (type = 0; type < MAX_SENSOR_TYPE; type++)
  248 + if (of_device_is_compatible(np,
  249 + sensor_groups[type].compatible))
  250 + break;
  251 +
  252 + if (type == MAX_SENSOR_TYPE)
  253 + continue;
  254 +
  255 + sensor_id = of_get_property(np, "sensor-id", NULL);
  256 + if (!sensor_id) {
  257 + dev_info(&pdev->dev,
  258 + "'sensor-id' missing in the node '%s'\n",
  259 + np->name);
  260 + continue;
  261 + }
  262 +
  263 + sdata[count].id = be32_to_cpup(sensor_id);
  264 + sdata[count].type = type;
  265 + err = create_hwmon_attr_name(&pdev->dev, type, np->name,
  266 + sdata[count].name);
  267 + if (err)
  268 + goto exit_put_node;
  269 +
  270 + sysfs_attr_init(&sdata[count].dev_attr.attr);
  271 + sdata[count].dev_attr.attr.name = sdata[count].name;
  272 + sdata[count].dev_attr.attr.mode = S_IRUGO;
  273 + sdata[count].dev_attr.show = show_sensor;
  274 +
  275 + pgroups[type]->attrs[sensor_groups[type].attr_count++] =
  276 + &sdata[count++].dev_attr.attr;
  277 + }
  278 +
  279 +exit_put_node:
  280 + of_node_put(opal);
  281 + return err;
  282 +}
  283 +
  284 +static int __init ibmpowernv_probe(struct platform_device *pdev)
  285 +{
  286 + struct platform_data *pdata;
  287 + struct device *hwmon_dev;
  288 + int err;
  289 +
  290 + pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
  291 + if (!pdata)
  292 + return -ENOMEM;
  293 +
  294 + platform_set_drvdata(pdev, pdata);
  295 + pdata->sensors_count = 0;
  296 + err = populate_attr_groups(pdev);
  297 + if (err)
  298 + return err;
  299 +
  300 + /* Create sysfs attribute data for each sensor found in the DT */
  301 + err = create_device_attrs(pdev);
  302 + if (err)
  303 + return err;
  304 +
  305 + /* Finally, register with hwmon */
  306 + hwmon_dev = devm_hwmon_device_register_with_groups(&pdev->dev, DRVNAME,
  307 + pdata,
  308 + pdata->attr_groups);
  309 +
  310 + return PTR_ERR_OR_ZERO(hwmon_dev);
  311 +}
  312 +
  313 +static struct platform_driver ibmpowernv_driver = {
  314 + .driver = {
  315 + .owner = THIS_MODULE,
  316 + .name = DRVNAME,
  317 + },
  318 +};
  319 +
  320 +static int __init ibmpowernv_init(void)
  321 +{
  322 + int err;
  323 +
  324 + pdevice = platform_device_alloc(DRVNAME, 0);
  325 + if (!pdevice) {
  326 + pr_err("Device allocation failed\n");
  327 + err = -ENOMEM;
  328 + goto exit;
  329 + }
  330 +
  331 + err = platform_device_add(pdevice);
  332 + if (err) {
  333 + pr_err("Device addition failed (%d)\n", err);
  334 + goto exit_device_put;
  335 + }
  336 +
  337 + err = platform_driver_probe(&ibmpowernv_driver, ibmpowernv_probe);
  338 + if (err) {
  339 + pr_err("Platfrom driver probe failed\n");
  340 + goto exit_device_del;
  341 + }
  342 +
  343 + return 0;
  344 +
  345 +exit_device_del:
  346 + platform_device_del(pdevice);
  347 +exit_device_put:
  348 + platform_device_put(pdevice);
  349 +exit:
  350 + return err;
  351 +}
  352 +
  353 +static void __exit ibmpowernv_exit(void)
  354 +{
  355 + platform_driver_unregister(&ibmpowernv_driver);
  356 + platform_device_unregister(pdevice);
  357 +}
  358 +
  359 +MODULE_AUTHOR("Neelesh Gupta <neelegup@linux.vnet.ibm.com>");
  360 +MODULE_DESCRIPTION("IBM POWERNV platform sensors");
  361 +MODULE_LICENSE("GPL");
  362 +
  363 +module_init(ibmpowernv_init);
  364 +module_exit(ibmpowernv_exit);