1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * IBM PowerNV platform sensors for temperature/fan/voltage/power
4 * Copyright (C) 2014 IBM
7 #define DRVNAME "ibmpowernv"
8 #define pr_fmt(fmt) DRVNAME ": " fmt
10 #include <linux/init.h>
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/hwmon.h>
14 #include <linux/hwmon-sysfs.h>
16 #include <linux/slab.h>
18 #include <linux/platform_device.h>
20 #include <linux/err.h>
21 #include <asm/cputhreads.h>
24 #define MAX_ATTR_LEN 32
25 #define MAX_LABEL_LEN 64
27 /* Sensor suffix name from DT */
28 #define DT_FAULT_ATTR_SUFFIX "faulted"
29 #define DT_DATA_ATTR_SUFFIX "data"
30 #define DT_THRESHOLD_ATTR_SUFFIX "thrs"
33 * Enumerates all the types of sensors in the POWERNV platform and does index
34 * into 'struct sensor_group'
46 #define INVALID_INDEX (-1U)
49 * 'compatible' string properties for sensor types as defined in old
50 * PowerNV firmware (skiboot). These are ordered as 'enum sensors'.
52 static const char * const legacy_compatibles[] = {
53 "ibm,opal-sensor-cooling-fan",
54 "ibm,opal-sensor-amb-temp",
55 "ibm,opal-sensor-power-supply",
56 "ibm,opal-sensor-power"
59 static struct sensor_group {
60 const char *name; /* matches property 'sensor-type' */
61 struct attribute_group group;
74 u32 id; /* An opaque id of the firmware for each sensor */
78 char label[MAX_LABEL_LEN];
79 char name[MAX_ATTR_LEN];
80 struct device_attribute dev_attr;
81 struct sensor_group_data *sgrp_data;
84 struct sensor_group_data {
90 struct platform_data {
91 const struct attribute_group *attr_groups[MAX_SENSOR_TYPE + 1];
92 struct sensor_group_data *sgrp_data;
93 u32 sensors_count; /* Total count of sensors from each group */
94 u32 nr_sensor_groups; /* Total number of sensor groups */
97 static ssize_t show_sensor(struct device *dev, struct device_attribute *devattr,
100 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
105 if (sdata->sgrp_data && !sdata->sgrp_data->enable)
108 ret = opal_get_sensor_data_u64(sdata->id, &x);
113 /* Convert temperature to milli-degrees */
114 if (sdata->type == TEMP)
116 /* Convert power to micro-watts */
117 else if (sdata->type == POWER_INPUT)
120 return sprintf(buf, "%llu\n", x);
123 static ssize_t show_enable(struct device *dev,
124 struct device_attribute *devattr, char *buf)
126 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
129 return sprintf(buf, "%u\n", sdata->sgrp_data->enable);
132 static ssize_t store_enable(struct device *dev,
133 struct device_attribute *devattr,
134 const char *buf, size_t count)
136 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
138 struct sensor_group_data *sgrp_data = sdata->sgrp_data;
142 ret = kstrtobool(buf, &data);
146 ret = mutex_lock_interruptible(&sgrp_data->mutex);
150 if (data != sgrp_data->enable) {
151 ret = sensor_group_enable(sgrp_data->gid, data);
153 sgrp_data->enable = data;
159 mutex_unlock(&sgrp_data->mutex);
163 static ssize_t show_label(struct device *dev, struct device_attribute *devattr,
166 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
169 return sprintf(buf, "%s\n", sdata->label);
172 static int get_logical_cpu(int hwcpu)
176 for_each_possible_cpu(cpu)
177 if (get_hard_smp_processor_id(cpu) == hwcpu)
183 static void make_sensor_label(struct device_node *np,
184 struct sensor_data *sdata, const char *label)
189 n = scnprintf(sdata->label, sizeof(sdata->label), "%s", label);
192 * Core temp pretty print
194 if (!of_property_read_u32(np, "ibm,pir", &id)) {
195 int cpuid = get_logical_cpu(id);
199 * The digital thermal sensors are associated
202 n += scnprintf(sdata->label + n,
203 sizeof(sdata->label) - n, " %d",
206 n += scnprintf(sdata->label + n,
207 sizeof(sdata->label) - n, " phy%d", id);
211 * Membuffer pretty print
213 if (!of_property_read_u32(np, "ibm,chip-id", &id))
214 n += scnprintf(sdata->label + n, sizeof(sdata->label) - n,
218 static int get_sensor_index_attr(const char *name, u32 *index, char *attr)
220 char *hash_pos = strchr(name, '#');
229 dash_pos = strchr(hash_pos, '-');
233 copy_len = dash_pos - hash_pos - 1;
234 if (copy_len >= sizeof(buf))
237 strncpy(buf, hash_pos + 1, copy_len);
239 err = kstrtou32(buf, 10, index);
243 strscpy(attr, dash_pos + 1, MAX_ATTR_LEN);
248 static const char *convert_opal_attr_name(enum sensors type,
249 const char *opal_attr)
251 const char *attr_name = NULL;
253 if (!strcmp(opal_attr, DT_FAULT_ATTR_SUFFIX)) {
255 } else if (!strcmp(opal_attr, DT_DATA_ATTR_SUFFIX)) {
257 } else if (!strcmp(opal_attr, DT_THRESHOLD_ATTR_SUFFIX)) {
260 else if (type == FAN)
268 * This function translates the DT node name into the 'hwmon' attribute name.
269 * IBMPOWERNV device node appear like cooling-fan#2-data, amb-temp#1-thrs etc.
270 * which need to be mapped as fan2_input, temp1_max respectively before
271 * populating them inside hwmon device class.
273 static const char *parse_opal_node_name(const char *node_name,
274 enum sensors type, u32 *index)
276 char attr_suffix[MAX_ATTR_LEN];
277 const char *attr_name;
280 err = get_sensor_index_attr(node_name, index, attr_suffix);
284 attr_name = convert_opal_attr_name(type, attr_suffix);
286 return ERR_PTR(-ENOENT);
291 static int get_sensor_type(struct device_node *np)
296 for (type = 0; type < ARRAY_SIZE(legacy_compatibles); type++) {
297 if (of_device_is_compatible(np, legacy_compatibles[type]))
302 * Let's check if we have a newer device tree
304 if (!of_device_is_compatible(np, "ibm,opal-sensor"))
305 return MAX_SENSOR_TYPE;
307 if (of_property_read_string(np, "sensor-type", &str))
308 return MAX_SENSOR_TYPE;
310 for (type = 0; type < MAX_SENSOR_TYPE; type++)
311 if (!strcmp(str, sensor_groups[type].name))
314 return MAX_SENSOR_TYPE;
317 static u32 get_sensor_hwmon_index(struct sensor_data *sdata,
318 struct sensor_data *sdata_table, int count)
323 * We don't use the OPAL index on newer device trees
325 if (sdata->opal_index != INVALID_INDEX) {
326 for (i = 0; i < count; i++)
327 if (sdata_table[i].opal_index == sdata->opal_index &&
328 sdata_table[i].type == sdata->type)
329 return sdata_table[i].hwmon_index;
331 return ++sensor_groups[sdata->type].hwmon_index;
334 static int init_sensor_group_data(struct platform_device *pdev,
335 struct platform_data *pdata)
337 struct sensor_group_data *sgrp_data;
338 struct device_node *groups, *sgrp;
339 int count = 0, ret = 0;
342 groups = of_find_compatible_node(NULL, NULL, "ibm,opal-sensor-group");
346 for_each_child_of_node(groups, sgrp) {
347 type = get_sensor_type(sgrp);
348 if (type != MAX_SENSOR_TYPE)
349 pdata->nr_sensor_groups++;
352 if (!pdata->nr_sensor_groups)
355 sgrp_data = devm_kcalloc(&pdev->dev, pdata->nr_sensor_groups,
356 sizeof(*sgrp_data), GFP_KERNEL);
362 for_each_child_of_node(groups, sgrp) {
365 type = get_sensor_type(sgrp);
366 if (type == MAX_SENSOR_TYPE)
369 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
372 if (of_count_phandle_with_args(sgrp, "sensors", NULL) <= 0)
375 sensor_groups[type].attr_count++;
376 sgrp_data[count].gid = gid;
377 mutex_init(&sgrp_data[count].mutex);
378 sgrp_data[count++].enable = false;
381 pdata->sgrp_data = sgrp_data;
387 static struct sensor_group_data *get_sensor_group(struct platform_data *pdata,
388 struct device_node *node,
391 struct sensor_group_data *sgrp_data = pdata->sgrp_data;
392 struct device_node *groups, *sgrp;
394 groups = of_find_compatible_node(NULL, NULL, "ibm,opal-sensor-group");
398 for_each_child_of_node(groups, sgrp) {
399 struct of_phandle_iterator it;
404 type = get_sensor_type(sgrp);
408 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
411 of_for_each_phandle(&it, rc, sgrp, "sensors", NULL, 0)
412 if (it.phandle == node->phandle) {
413 of_node_put(it.node);
420 for (i = 0; i < pdata->nr_sensor_groups; i++)
421 if (gid == sgrp_data[i].gid) {
424 return &sgrp_data[i];
432 static int populate_attr_groups(struct platform_device *pdev)
434 struct platform_data *pdata = platform_get_drvdata(pdev);
435 const struct attribute_group **pgroups = pdata->attr_groups;
436 struct device_node *opal, *np;
440 ret = init_sensor_group_data(pdev, pdata);
444 opal = of_find_node_by_path("/ibm,opal/sensors");
445 for_each_child_of_node(opal, np) {
448 type = get_sensor_type(np);
449 if (type == MAX_SENSOR_TYPE)
452 sensor_groups[type].attr_count++;
455 * add attributes for labels, min and max
457 if (!of_property_read_string(np, "label", &label))
458 sensor_groups[type].attr_count++;
459 if (of_property_present(np, "sensor-data-min"))
460 sensor_groups[type].attr_count++;
461 if (of_property_present(np, "sensor-data-max"))
462 sensor_groups[type].attr_count++;
467 for (type = 0; type < MAX_SENSOR_TYPE; type++) {
468 sensor_groups[type].group.attrs = devm_kcalloc(&pdev->dev,
469 sensor_groups[type].attr_count + 1,
470 sizeof(struct attribute *),
472 if (!sensor_groups[type].group.attrs)
475 pgroups[type] = &sensor_groups[type].group;
476 pdata->sensors_count += sensor_groups[type].attr_count;
477 sensor_groups[type].attr_count = 0;
483 static void create_hwmon_attr(struct sensor_data *sdata, const char *attr_name,
484 ssize_t (*show)(struct device *dev,
485 struct device_attribute *attr,
487 ssize_t (*store)(struct device *dev,
488 struct device_attribute *attr,
489 const char *buf, size_t count))
491 snprintf(sdata->name, MAX_ATTR_LEN, "%s%d_%s",
492 sensor_groups[sdata->type].name, sdata->hwmon_index,
495 sysfs_attr_init(&sdata->dev_attr.attr);
496 sdata->dev_attr.attr.name = sdata->name;
497 sdata->dev_attr.show = show;
499 sdata->dev_attr.store = store;
500 sdata->dev_attr.attr.mode = 0664;
502 sdata->dev_attr.attr.mode = 0444;
506 static void populate_sensor(struct sensor_data *sdata, int od, int hd, int sid,
507 const char *attr_name, enum sensors type,
508 const struct attribute_group *pgroup,
509 struct sensor_group_data *sgrp_data,
510 ssize_t (*show)(struct device *dev,
511 struct device_attribute *attr,
513 ssize_t (*store)(struct device *dev,
514 struct device_attribute *attr,
515 const char *buf, size_t count))
519 sdata->opal_index = od;
520 sdata->hwmon_index = hd;
521 create_hwmon_attr(sdata, attr_name, show, store);
522 pgroup->attrs[sensor_groups[type].attr_count++] = &sdata->dev_attr.attr;
523 sdata->sgrp_data = sgrp_data;
526 static char *get_max_attr(enum sensors type)
530 return "input_highest";
536 static char *get_min_attr(enum sensors type)
540 return "input_lowest";
547 * Iterate through the device tree for each child of 'sensors' node, create
548 * a sysfs attribute file, the file is named by translating the DT node name
549 * to the name required by the higher 'hwmon' driver like fan1_input, temp1_max
552 static int create_device_attrs(struct platform_device *pdev)
554 struct platform_data *pdata = platform_get_drvdata(pdev);
555 const struct attribute_group **pgroups = pdata->attr_groups;
556 struct device_node *opal, *np;
557 struct sensor_data *sdata;
559 u32 group_attr_id[MAX_SENSOR_TYPE] = {0};
561 sdata = devm_kcalloc(&pdev->dev,
562 pdata->sensors_count, sizeof(*sdata),
567 opal = of_find_node_by_path("/ibm,opal/sensors");
568 for_each_child_of_node(opal, np) {
569 struct sensor_group_data *sgrp_data;
570 const char *attr_name;
571 u32 opal_index, hw_id;
576 type = get_sensor_type(np);
577 if (type == MAX_SENSOR_TYPE)
581 * Newer device trees use a "sensor-data" property
584 if (of_property_read_u32(np, "sensor-id", &sensor_id) &&
585 of_property_read_u32(np, "sensor-data", &sensor_id)) {
587 "'sensor-id' missing in the node '%pOFn'\n",
592 sdata[count].id = sensor_id;
593 sdata[count].type = type;
596 * If we can not parse the node name, it means we are
597 * running on a newer device tree. We can just forget
598 * about the OPAL index and use a defaut value for the
599 * hwmon attribute name
601 attr_name = parse_opal_node_name(np->name, type, &opal_index);
602 if (IS_ERR(attr_name)) {
604 opal_index = INVALID_INDEX;
607 hw_id = get_sensor_hwmon_index(&sdata[count], sdata, count);
608 sgrp_data = get_sensor_group(pdata, np, type);
609 populate_sensor(&sdata[count], opal_index, hw_id, sensor_id,
610 attr_name, type, pgroups[type], sgrp_data,
614 if (!of_property_read_string(np, "label", &label)) {
616 * For the label attribute, we can reuse the
617 * "properties" of the previous "input"
618 * attribute. They are related to the same
622 make_sensor_label(np, &sdata[count], label);
623 populate_sensor(&sdata[count], opal_index, hw_id,
624 sensor_id, "label", type, pgroups[type],
625 NULL, show_label, NULL);
629 if (!of_property_read_u32(np, "sensor-data-max", &sensor_id)) {
630 attr_name = get_max_attr(type);
631 populate_sensor(&sdata[count], opal_index, hw_id,
632 sensor_id, attr_name, type,
633 pgroups[type], sgrp_data, show_sensor,
638 if (!of_property_read_u32(np, "sensor-data-min", &sensor_id)) {
639 attr_name = get_min_attr(type);
640 populate_sensor(&sdata[count], opal_index, hw_id,
641 sensor_id, attr_name, type,
642 pgroups[type], sgrp_data, show_sensor,
647 if (sgrp_data && !sgrp_data->enable) {
648 sgrp_data->enable = true;
649 hw_id = ++group_attr_id[type];
650 populate_sensor(&sdata[count], opal_index, hw_id,
651 sgrp_data->gid, "enable", type,
652 pgroups[type], sgrp_data, show_enable,
662 static int ibmpowernv_probe(struct platform_device *pdev)
664 struct platform_data *pdata;
665 struct device *hwmon_dev;
668 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
672 platform_set_drvdata(pdev, pdata);
673 pdata->sensors_count = 0;
674 pdata->nr_sensor_groups = 0;
675 err = populate_attr_groups(pdev);
679 /* Create sysfs attribute data for each sensor found in the DT */
680 err = create_device_attrs(pdev);
684 /* Finally, register with hwmon */
685 hwmon_dev = devm_hwmon_device_register_with_groups(&pdev->dev, DRVNAME,
689 return PTR_ERR_OR_ZERO(hwmon_dev);
692 static const struct platform_device_id opal_sensor_driver_ids[] = {
694 .name = "opal-sensor",
698 MODULE_DEVICE_TABLE(platform, opal_sensor_driver_ids);
700 static const struct of_device_id opal_sensor_match[] = {
701 { .compatible = "ibm,opal-sensor" },
704 MODULE_DEVICE_TABLE(of, opal_sensor_match);
706 static struct platform_driver ibmpowernv_driver = {
707 .probe = ibmpowernv_probe,
708 .id_table = opal_sensor_driver_ids,
711 .of_match_table = opal_sensor_match,
715 module_platform_driver(ibmpowernv_driver);
717 MODULE_AUTHOR("Neelesh Gupta <neelegup@linux.vnet.ibm.com>");
718 MODULE_DESCRIPTION("IBM POWERNV platform sensors");
719 MODULE_LICENSE("GPL");