2 * IBM PowerNV platform sensors for temperature/fan/voltage/power
3 * Copyright (C) 2014 IBM
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.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program.
19 #define DRVNAME "ibmpowernv"
20 #define pr_fmt(fmt) DRVNAME ": " fmt
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>
28 #include <linux/slab.h>
30 #include <linux/platform_device.h>
32 #include <linux/err.h>
33 #include <asm/cputhreads.h>
36 #define MAX_ATTR_LEN 32
37 #define MAX_LABEL_LEN 64
39 /* Sensor suffix name from DT */
40 #define DT_FAULT_ATTR_SUFFIX "faulted"
41 #define DT_DATA_ATTR_SUFFIX "data"
42 #define DT_THRESHOLD_ATTR_SUFFIX "thrs"
45 * Enumerates all the types of sensors in the POWERNV platform and does index
46 * into 'struct sensor_group'
58 #define INVALID_INDEX (-1U)
61 * 'compatible' string properties for sensor types as defined in old
62 * PowerNV firmware (skiboot). These are ordered as 'enum sensors'.
64 static const char * const legacy_compatibles[] = {
65 "ibm,opal-sensor-cooling-fan",
66 "ibm,opal-sensor-amb-temp",
67 "ibm,opal-sensor-power-supply",
68 "ibm,opal-sensor-power"
71 static struct sensor_group {
72 const char *name; /* matches property 'sensor-type' */
73 struct attribute_group group;
86 u32 id; /* An opaque id of the firmware for each sensor */
90 char label[MAX_LABEL_LEN];
91 char name[MAX_ATTR_LEN];
92 struct device_attribute dev_attr;
93 struct sensor_group_data *sgrp_data;
96 struct sensor_group_data {
102 struct platform_data {
103 const struct attribute_group *attr_groups[MAX_SENSOR_TYPE + 1];
104 struct sensor_group_data *sgrp_data;
105 u32 sensors_count; /* Total count of sensors from each group */
106 u32 nr_sensor_groups; /* Total number of sensor groups */
109 static ssize_t show_sensor(struct device *dev, struct device_attribute *devattr,
112 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
117 if (sdata->sgrp_data && !sdata->sgrp_data->enable)
120 ret = opal_get_sensor_data_u64(sdata->id, &x);
125 /* Convert temperature to milli-degrees */
126 if (sdata->type == TEMP)
128 /* Convert power to micro-watts */
129 else if (sdata->type == POWER_INPUT)
132 return sprintf(buf, "%llu\n", x);
135 static ssize_t show_enable(struct device *dev,
136 struct device_attribute *devattr, char *buf)
138 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
141 return sprintf(buf, "%u\n", sdata->sgrp_data->enable);
144 static ssize_t store_enable(struct device *dev,
145 struct device_attribute *devattr,
146 const char *buf, size_t count)
148 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
150 struct sensor_group_data *sgrp_data = sdata->sgrp_data;
154 ret = kstrtobool(buf, &data);
158 ret = mutex_lock_interruptible(&sgrp_data->mutex);
162 if (data != sgrp_data->enable) {
163 ret = sensor_group_enable(sgrp_data->gid, data);
165 sgrp_data->enable = data;
171 mutex_unlock(&sgrp_data->mutex);
175 static ssize_t show_label(struct device *dev, struct device_attribute *devattr,
178 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
181 return sprintf(buf, "%s\n", sdata->label);
184 static int get_logical_cpu(int hwcpu)
188 for_each_possible_cpu(cpu)
189 if (get_hard_smp_processor_id(cpu) == hwcpu)
195 static void make_sensor_label(struct device_node *np,
196 struct sensor_data *sdata, const char *label)
201 n = snprintf(sdata->label, sizeof(sdata->label), "%s", label);
204 * Core temp pretty print
206 if (!of_property_read_u32(np, "ibm,pir", &id)) {
207 int cpuid = get_logical_cpu(id);
211 * The digital thermal sensors are associated
214 n += snprintf(sdata->label + n,
215 sizeof(sdata->label) - n, " %d",
218 n += snprintf(sdata->label + n,
219 sizeof(sdata->label) - n, " phy%d", id);
223 * Membuffer pretty print
225 if (!of_property_read_u32(np, "ibm,chip-id", &id))
226 n += snprintf(sdata->label + n, sizeof(sdata->label) - n,
230 static int get_sensor_index_attr(const char *name, u32 *index, char *attr)
232 char *hash_pos = strchr(name, '#');
241 dash_pos = strchr(hash_pos, '-');
245 copy_len = dash_pos - hash_pos - 1;
246 if (copy_len >= sizeof(buf))
249 strncpy(buf, hash_pos + 1, copy_len);
251 err = kstrtou32(buf, 10, index);
255 strncpy(attr, dash_pos + 1, MAX_ATTR_LEN);
260 static const char *convert_opal_attr_name(enum sensors type,
261 const char *opal_attr)
263 const char *attr_name = NULL;
265 if (!strcmp(opal_attr, DT_FAULT_ATTR_SUFFIX)) {
267 } else if (!strcmp(opal_attr, DT_DATA_ATTR_SUFFIX)) {
269 } else if (!strcmp(opal_attr, DT_THRESHOLD_ATTR_SUFFIX)) {
272 else if (type == FAN)
280 * This function translates the DT node name into the 'hwmon' attribute name.
281 * IBMPOWERNV device node appear like cooling-fan#2-data, amb-temp#1-thrs etc.
282 * which need to be mapped as fan2_input, temp1_max respectively before
283 * populating them inside hwmon device class.
285 static const char *parse_opal_node_name(const char *node_name,
286 enum sensors type, u32 *index)
288 char attr_suffix[MAX_ATTR_LEN];
289 const char *attr_name;
292 err = get_sensor_index_attr(node_name, index, attr_suffix);
296 attr_name = convert_opal_attr_name(type, attr_suffix);
298 return ERR_PTR(-ENOENT);
303 static int get_sensor_type(struct device_node *np)
308 for (type = 0; type < ARRAY_SIZE(legacy_compatibles); type++) {
309 if (of_device_is_compatible(np, legacy_compatibles[type]))
314 * Let's check if we have a newer device tree
316 if (!of_device_is_compatible(np, "ibm,opal-sensor"))
317 return MAX_SENSOR_TYPE;
319 if (of_property_read_string(np, "sensor-type", &str))
320 return MAX_SENSOR_TYPE;
322 for (type = 0; type < MAX_SENSOR_TYPE; type++)
323 if (!strcmp(str, sensor_groups[type].name))
326 return MAX_SENSOR_TYPE;
329 static u32 get_sensor_hwmon_index(struct sensor_data *sdata,
330 struct sensor_data *sdata_table, int count)
335 * We don't use the OPAL index on newer device trees
337 if (sdata->opal_index != INVALID_INDEX) {
338 for (i = 0; i < count; i++)
339 if (sdata_table[i].opal_index == sdata->opal_index &&
340 sdata_table[i].type == sdata->type)
341 return sdata_table[i].hwmon_index;
343 return ++sensor_groups[sdata->type].hwmon_index;
346 static int init_sensor_group_data(struct platform_device *pdev,
347 struct platform_data *pdata)
349 struct sensor_group_data *sgrp_data;
350 struct device_node *groups, *sgrp;
351 int count = 0, ret = 0;
354 groups = of_find_compatible_node(NULL, NULL, "ibm,opal-sensor-group");
358 for_each_child_of_node(groups, sgrp) {
359 type = get_sensor_type(sgrp);
360 if (type != MAX_SENSOR_TYPE)
361 pdata->nr_sensor_groups++;
364 if (!pdata->nr_sensor_groups)
367 sgrp_data = devm_kcalloc(&pdev->dev, pdata->nr_sensor_groups,
368 sizeof(*sgrp_data), GFP_KERNEL);
374 for_each_child_of_node(groups, sgrp) {
377 type = get_sensor_type(sgrp);
378 if (type == MAX_SENSOR_TYPE)
381 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
384 if (of_count_phandle_with_args(sgrp, "sensors", NULL) <= 0)
387 sensor_groups[type].attr_count++;
388 sgrp_data[count].gid = gid;
389 mutex_init(&sgrp_data[count].mutex);
390 sgrp_data[count++].enable = false;
393 pdata->sgrp_data = sgrp_data;
399 static struct sensor_group_data *get_sensor_group(struct platform_data *pdata,
400 struct device_node *node,
403 struct sensor_group_data *sgrp_data = pdata->sgrp_data;
404 struct device_node *groups, *sgrp;
406 groups = of_find_compatible_node(NULL, NULL, "ibm,opal-sensor-group");
410 for_each_child_of_node(groups, sgrp) {
411 struct of_phandle_iterator it;
416 type = get_sensor_type(sgrp);
420 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
423 of_for_each_phandle(&it, rc, sgrp, "sensors", NULL, 0)
424 if (it.phandle == node->phandle) {
425 of_node_put(it.node);
432 for (i = 0; i < pdata->nr_sensor_groups; i++)
433 if (gid == sgrp_data[i].gid) {
436 return &sgrp_data[i];
444 static int populate_attr_groups(struct platform_device *pdev)
446 struct platform_data *pdata = platform_get_drvdata(pdev);
447 const struct attribute_group **pgroups = pdata->attr_groups;
448 struct device_node *opal, *np;
452 ret = init_sensor_group_data(pdev, pdata);
456 opal = of_find_node_by_path("/ibm,opal/sensors");
457 for_each_child_of_node(opal, np) {
460 type = get_sensor_type(np);
461 if (type == MAX_SENSOR_TYPE)
464 sensor_groups[type].attr_count++;
467 * add attributes for labels, min and max
469 if (!of_property_read_string(np, "label", &label))
470 sensor_groups[type].attr_count++;
471 if (of_find_property(np, "sensor-data-min", NULL))
472 sensor_groups[type].attr_count++;
473 if (of_find_property(np, "sensor-data-max", NULL))
474 sensor_groups[type].attr_count++;
479 for (type = 0; type < MAX_SENSOR_TYPE; type++) {
480 sensor_groups[type].group.attrs = devm_kcalloc(&pdev->dev,
481 sensor_groups[type].attr_count + 1,
482 sizeof(struct attribute *),
484 if (!sensor_groups[type].group.attrs)
487 pgroups[type] = &sensor_groups[type].group;
488 pdata->sensors_count += sensor_groups[type].attr_count;
489 sensor_groups[type].attr_count = 0;
495 static void create_hwmon_attr(struct sensor_data *sdata, const char *attr_name,
496 ssize_t (*show)(struct device *dev,
497 struct device_attribute *attr,
499 ssize_t (*store)(struct device *dev,
500 struct device_attribute *attr,
501 const char *buf, size_t count))
503 snprintf(sdata->name, MAX_ATTR_LEN, "%s%d_%s",
504 sensor_groups[sdata->type].name, sdata->hwmon_index,
507 sysfs_attr_init(&sdata->dev_attr.attr);
508 sdata->dev_attr.attr.name = sdata->name;
509 sdata->dev_attr.show = show;
511 sdata->dev_attr.store = store;
512 sdata->dev_attr.attr.mode = 0664;
514 sdata->dev_attr.attr.mode = 0444;
518 static void populate_sensor(struct sensor_data *sdata, int od, int hd, int sid,
519 const char *attr_name, enum sensors type,
520 const struct attribute_group *pgroup,
521 struct sensor_group_data *sgrp_data,
522 ssize_t (*show)(struct device *dev,
523 struct device_attribute *attr,
525 ssize_t (*store)(struct device *dev,
526 struct device_attribute *attr,
527 const char *buf, size_t count))
531 sdata->opal_index = od;
532 sdata->hwmon_index = hd;
533 create_hwmon_attr(sdata, attr_name, show, store);
534 pgroup->attrs[sensor_groups[type].attr_count++] = &sdata->dev_attr.attr;
535 sdata->sgrp_data = sgrp_data;
538 static char *get_max_attr(enum sensors type)
542 return "input_highest";
548 static char *get_min_attr(enum sensors type)
552 return "input_lowest";
559 * Iterate through the device tree for each child of 'sensors' node, create
560 * a sysfs attribute file, the file is named by translating the DT node name
561 * to the name required by the higher 'hwmon' driver like fan1_input, temp1_max
564 static int create_device_attrs(struct platform_device *pdev)
566 struct platform_data *pdata = platform_get_drvdata(pdev);
567 const struct attribute_group **pgroups = pdata->attr_groups;
568 struct device_node *opal, *np;
569 struct sensor_data *sdata;
571 u32 group_attr_id[MAX_SENSOR_TYPE] = {0};
573 sdata = devm_kcalloc(&pdev->dev,
574 pdata->sensors_count, sizeof(*sdata),
579 opal = of_find_node_by_path("/ibm,opal/sensors");
580 for_each_child_of_node(opal, np) {
581 struct sensor_group_data *sgrp_data;
582 const char *attr_name;
583 u32 opal_index, hw_id;
588 type = get_sensor_type(np);
589 if (type == MAX_SENSOR_TYPE)
593 * Newer device trees use a "sensor-data" property
596 if (of_property_read_u32(np, "sensor-id", &sensor_id) &&
597 of_property_read_u32(np, "sensor-data", &sensor_id)) {
599 "'sensor-id' missing in the node '%pOFn'\n",
604 sdata[count].id = sensor_id;
605 sdata[count].type = type;
608 * If we can not parse the node name, it means we are
609 * running on a newer device tree. We can just forget
610 * about the OPAL index and use a defaut value for the
611 * hwmon attribute name
613 attr_name = parse_opal_node_name(np->name, type, &opal_index);
614 if (IS_ERR(attr_name)) {
616 opal_index = INVALID_INDEX;
619 hw_id = get_sensor_hwmon_index(&sdata[count], sdata, count);
620 sgrp_data = get_sensor_group(pdata, np, type);
621 populate_sensor(&sdata[count], opal_index, hw_id, sensor_id,
622 attr_name, type, pgroups[type], sgrp_data,
626 if (!of_property_read_string(np, "label", &label)) {
628 * For the label attribute, we can reuse the
629 * "properties" of the previous "input"
630 * attribute. They are related to the same
634 make_sensor_label(np, &sdata[count], label);
635 populate_sensor(&sdata[count], opal_index, hw_id,
636 sensor_id, "label", type, pgroups[type],
637 NULL, show_label, NULL);
641 if (!of_property_read_u32(np, "sensor-data-max", &sensor_id)) {
642 attr_name = get_max_attr(type);
643 populate_sensor(&sdata[count], opal_index, hw_id,
644 sensor_id, attr_name, type,
645 pgroups[type], sgrp_data, show_sensor,
650 if (!of_property_read_u32(np, "sensor-data-min", &sensor_id)) {
651 attr_name = get_min_attr(type);
652 populate_sensor(&sdata[count], opal_index, hw_id,
653 sensor_id, attr_name, type,
654 pgroups[type], sgrp_data, show_sensor,
659 if (sgrp_data && !sgrp_data->enable) {
660 sgrp_data->enable = true;
661 hw_id = ++group_attr_id[type];
662 populate_sensor(&sdata[count], opal_index, hw_id,
663 sgrp_data->gid, "enable", type,
664 pgroups[type], sgrp_data, show_enable,
674 static int ibmpowernv_probe(struct platform_device *pdev)
676 struct platform_data *pdata;
677 struct device *hwmon_dev;
680 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
684 platform_set_drvdata(pdev, pdata);
685 pdata->sensors_count = 0;
686 pdata->nr_sensor_groups = 0;
687 err = populate_attr_groups(pdev);
691 /* Create sysfs attribute data for each sensor found in the DT */
692 err = create_device_attrs(pdev);
696 /* Finally, register with hwmon */
697 hwmon_dev = devm_hwmon_device_register_with_groups(&pdev->dev, DRVNAME,
701 return PTR_ERR_OR_ZERO(hwmon_dev);
704 static const struct platform_device_id opal_sensor_driver_ids[] = {
706 .name = "opal-sensor",
710 MODULE_DEVICE_TABLE(platform, opal_sensor_driver_ids);
712 static const struct of_device_id opal_sensor_match[] = {
713 { .compatible = "ibm,opal-sensor" },
716 MODULE_DEVICE_TABLE(of, opal_sensor_match);
718 static struct platform_driver ibmpowernv_driver = {
719 .probe = ibmpowernv_probe,
720 .id_table = opal_sensor_driver_ids,
723 .of_match_table = opal_sensor_match,
727 module_platform_driver(ibmpowernv_driver);
730 MODULE_DESCRIPTION("IBM POWERNV platform sensors");
731 MODULE_LICENSE("GPL");