Linux 4.19.133
[linux/fpc-iii.git] / drivers / hwmon / ibmpowernv.c
blob64d05edff130470d4d85c0c429cfdb5312124e3f
1 /*
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>
27 #include <linux/of.h>
28 #include <linux/slab.h>
30 #include <linux/platform_device.h>
31 #include <asm/opal.h>
32 #include <linux/err.h>
33 #include <asm/cputhreads.h>
34 #include <asm/smp.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'
48 enum sensors {
49 FAN,
50 TEMP,
51 POWER_SUPPLY,
52 POWER_INPUT,
53 CURRENT,
54 ENERGY,
55 MAX_SENSOR_TYPE,
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;
74 u32 attr_count;
75 u32 hwmon_index;
76 } sensor_groups[] = {
77 { "fan" },
78 { "temp" },
79 { "in" },
80 { "power" },
81 { "curr" },
82 { "energy" },
85 struct sensor_data {
86 u32 id; /* An opaque id of the firmware for each sensor */
87 u32 hwmon_index;
88 u32 opal_index;
89 enum sensors type;
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 {
97 struct mutex mutex;
98 u32 gid;
99 bool enable;
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,
110 char *buf)
112 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
113 dev_attr);
114 ssize_t ret;
115 u64 x;
117 if (sdata->sgrp_data && !sdata->sgrp_data->enable)
118 return -ENODATA;
120 ret = opal_get_sensor_data_u64(sdata->id, &x);
122 if (ret)
123 return ret;
125 /* Convert temperature to milli-degrees */
126 if (sdata->type == TEMP)
127 x *= 1000;
128 /* Convert power to micro-watts */
129 else if (sdata->type == POWER_INPUT)
130 x *= 1000000;
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,
139 dev_attr);
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,
149 dev_attr);
150 struct sensor_group_data *sgrp_data = sdata->sgrp_data;
151 int ret;
152 bool data;
154 ret = kstrtobool(buf, &data);
155 if (ret)
156 return ret;
158 ret = mutex_lock_interruptible(&sgrp_data->mutex);
159 if (ret)
160 return ret;
162 if (data != sgrp_data->enable) {
163 ret = sensor_group_enable(sgrp_data->gid, data);
164 if (!ret)
165 sgrp_data->enable = data;
168 if (!ret)
169 ret = count;
171 mutex_unlock(&sgrp_data->mutex);
172 return ret;
175 static ssize_t show_label(struct device *dev, struct device_attribute *devattr,
176 char *buf)
178 struct sensor_data *sdata = container_of(devattr, struct sensor_data,
179 dev_attr);
181 return sprintf(buf, "%s\n", sdata->label);
184 static int get_logical_cpu(int hwcpu)
186 int cpu;
188 for_each_possible_cpu(cpu)
189 if (get_hard_smp_processor_id(cpu) == hwcpu)
190 return cpu;
192 return -ENOENT;
195 static void make_sensor_label(struct device_node *np,
196 struct sensor_data *sdata, const char *label)
198 u32 id;
199 size_t n;
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);
209 if (cpuid >= 0)
211 * The digital thermal sensors are associated
212 * with a core.
214 n += snprintf(sdata->label + n,
215 sizeof(sdata->label) - n, " %d",
216 cpuid);
217 else
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,
227 " %d", id & 0xffff);
230 static int get_sensor_index_attr(const char *name, u32 *index, char *attr)
232 char *hash_pos = strchr(name, '#');
233 char buf[8] = { 0 };
234 char *dash_pos;
235 u32 copy_len;
236 int err;
238 if (!hash_pos)
239 return -EINVAL;
241 dash_pos = strchr(hash_pos, '-');
242 if (!dash_pos)
243 return -EINVAL;
245 copy_len = dash_pos - hash_pos - 1;
246 if (copy_len >= sizeof(buf))
247 return -EINVAL;
249 strncpy(buf, hash_pos + 1, copy_len);
251 err = kstrtou32(buf, 10, index);
252 if (err)
253 return err;
255 strncpy(attr, dash_pos + 1, MAX_ATTR_LEN);
257 return 0;
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)) {
266 attr_name = "fault";
267 } else if (!strcmp(opal_attr, DT_DATA_ATTR_SUFFIX)) {
268 attr_name = "input";
269 } else if (!strcmp(opal_attr, DT_THRESHOLD_ATTR_SUFFIX)) {
270 if (type == TEMP)
271 attr_name = "max";
272 else if (type == FAN)
273 attr_name = "min";
276 return attr_name;
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;
290 int err;
292 err = get_sensor_index_attr(node_name, index, attr_suffix);
293 if (err)
294 return ERR_PTR(err);
296 attr_name = convert_opal_attr_name(type, attr_suffix);
297 if (!attr_name)
298 return ERR_PTR(-ENOENT);
300 return attr_name;
303 static int get_sensor_type(struct device_node *np)
305 enum sensors type;
306 const char *str;
308 for (type = 0; type < ARRAY_SIZE(legacy_compatibles); type++) {
309 if (of_device_is_compatible(np, legacy_compatibles[type]))
310 return 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))
324 return type;
326 return MAX_SENSOR_TYPE;
329 static u32 get_sensor_hwmon_index(struct sensor_data *sdata,
330 struct sensor_data *sdata_table, int count)
332 int i;
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;
352 enum sensors type;
354 groups = of_find_compatible_node(NULL, NULL, "ibm,opal-sensor-group");
355 if (!groups)
356 return ret;
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)
365 goto out;
367 sgrp_data = devm_kcalloc(&pdev->dev, pdata->nr_sensor_groups,
368 sizeof(*sgrp_data), GFP_KERNEL);
369 if (!sgrp_data) {
370 ret = -ENOMEM;
371 goto out;
374 for_each_child_of_node(groups, sgrp) {
375 u32 gid;
377 type = get_sensor_type(sgrp);
378 if (type == MAX_SENSOR_TYPE)
379 continue;
381 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
382 continue;
384 if (of_count_phandle_with_args(sgrp, "sensors", NULL) <= 0)
385 continue;
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;
394 out:
395 of_node_put(groups);
396 return ret;
399 static struct sensor_group_data *get_sensor_group(struct platform_data *pdata,
400 struct device_node *node,
401 enum sensors gtype)
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");
407 if (!groups)
408 return NULL;
410 for_each_child_of_node(groups, sgrp) {
411 struct of_phandle_iterator it;
412 u32 gid;
413 int rc, i;
414 enum sensors type;
416 type = get_sensor_type(sgrp);
417 if (type != gtype)
418 continue;
420 if (of_property_read_u32(sgrp, "sensor-group-id", &gid))
421 continue;
423 of_for_each_phandle(&it, rc, sgrp, "sensors", NULL, 0)
424 if (it.phandle == node->phandle) {
425 of_node_put(it.node);
426 break;
429 if (rc)
430 continue;
432 for (i = 0; i < pdata->nr_sensor_groups; i++)
433 if (gid == sgrp_data[i].gid) {
434 of_node_put(sgrp);
435 of_node_put(groups);
436 return &sgrp_data[i];
440 of_node_put(groups);
441 return NULL;
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;
449 enum sensors type;
450 int ret;
452 ret = init_sensor_group_data(pdev, pdata);
453 if (ret)
454 return ret;
456 opal = of_find_node_by_path("/ibm,opal/sensors");
457 for_each_child_of_node(opal, np) {
458 const char *label;
460 if (np->name == NULL)
461 continue;
463 type = get_sensor_type(np);
464 if (type == MAX_SENSOR_TYPE)
465 continue;
467 sensor_groups[type].attr_count++;
470 * add attributes for labels, min and max
472 if (!of_property_read_string(np, "label", &label))
473 sensor_groups[type].attr_count++;
474 if (of_find_property(np, "sensor-data-min", NULL))
475 sensor_groups[type].attr_count++;
476 if (of_find_property(np, "sensor-data-max", NULL))
477 sensor_groups[type].attr_count++;
480 of_node_put(opal);
482 for (type = 0; type < MAX_SENSOR_TYPE; type++) {
483 sensor_groups[type].group.attrs = devm_kcalloc(&pdev->dev,
484 sensor_groups[type].attr_count + 1,
485 sizeof(struct attribute *),
486 GFP_KERNEL);
487 if (!sensor_groups[type].group.attrs)
488 return -ENOMEM;
490 pgroups[type] = &sensor_groups[type].group;
491 pdata->sensors_count += sensor_groups[type].attr_count;
492 sensor_groups[type].attr_count = 0;
495 return 0;
498 static void create_hwmon_attr(struct sensor_data *sdata, const char *attr_name,
499 ssize_t (*show)(struct device *dev,
500 struct device_attribute *attr,
501 char *buf),
502 ssize_t (*store)(struct device *dev,
503 struct device_attribute *attr,
504 const char *buf, size_t count))
506 snprintf(sdata->name, MAX_ATTR_LEN, "%s%d_%s",
507 sensor_groups[sdata->type].name, sdata->hwmon_index,
508 attr_name);
510 sysfs_attr_init(&sdata->dev_attr.attr);
511 sdata->dev_attr.attr.name = sdata->name;
512 sdata->dev_attr.show = show;
513 if (store) {
514 sdata->dev_attr.store = store;
515 sdata->dev_attr.attr.mode = 0664;
516 } else {
517 sdata->dev_attr.attr.mode = 0444;
521 static void populate_sensor(struct sensor_data *sdata, int od, int hd, int sid,
522 const char *attr_name, enum sensors type,
523 const struct attribute_group *pgroup,
524 struct sensor_group_data *sgrp_data,
525 ssize_t (*show)(struct device *dev,
526 struct device_attribute *attr,
527 char *buf),
528 ssize_t (*store)(struct device *dev,
529 struct device_attribute *attr,
530 const char *buf, size_t count))
532 sdata->id = sid;
533 sdata->type = type;
534 sdata->opal_index = od;
535 sdata->hwmon_index = hd;
536 create_hwmon_attr(sdata, attr_name, show, store);
537 pgroup->attrs[sensor_groups[type].attr_count++] = &sdata->dev_attr.attr;
538 sdata->sgrp_data = sgrp_data;
541 static char *get_max_attr(enum sensors type)
543 switch (type) {
544 case POWER_INPUT:
545 return "input_highest";
546 default:
547 return "highest";
551 static char *get_min_attr(enum sensors type)
553 switch (type) {
554 case POWER_INPUT:
555 return "input_lowest";
556 default:
557 return "lowest";
562 * Iterate through the device tree for each child of 'sensors' node, create
563 * a sysfs attribute file, the file is named by translating the DT node name
564 * to the name required by the higher 'hwmon' driver like fan1_input, temp1_max
565 * etc..
567 static int create_device_attrs(struct platform_device *pdev)
569 struct platform_data *pdata = platform_get_drvdata(pdev);
570 const struct attribute_group **pgroups = pdata->attr_groups;
571 struct device_node *opal, *np;
572 struct sensor_data *sdata;
573 u32 count = 0;
574 u32 group_attr_id[MAX_SENSOR_TYPE] = {0};
576 sdata = devm_kcalloc(&pdev->dev,
577 pdata->sensors_count, sizeof(*sdata),
578 GFP_KERNEL);
579 if (!sdata)
580 return -ENOMEM;
582 opal = of_find_node_by_path("/ibm,opal/sensors");
583 for_each_child_of_node(opal, np) {
584 struct sensor_group_data *sgrp_data;
585 const char *attr_name;
586 u32 opal_index, hw_id;
587 u32 sensor_id;
588 const char *label;
589 enum sensors type;
591 if (np->name == NULL)
592 continue;
594 type = get_sensor_type(np);
595 if (type == MAX_SENSOR_TYPE)
596 continue;
599 * Newer device trees use a "sensor-data" property
600 * name for input.
602 if (of_property_read_u32(np, "sensor-id", &sensor_id) &&
603 of_property_read_u32(np, "sensor-data", &sensor_id)) {
604 dev_info(&pdev->dev,
605 "'sensor-id' missing in the node '%s'\n",
606 np->name);
607 continue;
610 sdata[count].id = sensor_id;
611 sdata[count].type = type;
614 * If we can not parse the node name, it means we are
615 * running on a newer device tree. We can just forget
616 * about the OPAL index and use a defaut value for the
617 * hwmon attribute name
619 attr_name = parse_opal_node_name(np->name, type, &opal_index);
620 if (IS_ERR(attr_name)) {
621 attr_name = "input";
622 opal_index = INVALID_INDEX;
625 hw_id = get_sensor_hwmon_index(&sdata[count], sdata, count);
626 sgrp_data = get_sensor_group(pdata, np, type);
627 populate_sensor(&sdata[count], opal_index, hw_id, sensor_id,
628 attr_name, type, pgroups[type], sgrp_data,
629 show_sensor, NULL);
630 count++;
632 if (!of_property_read_string(np, "label", &label)) {
634 * For the label attribute, we can reuse the
635 * "properties" of the previous "input"
636 * attribute. They are related to the same
637 * sensor.
640 make_sensor_label(np, &sdata[count], label);
641 populate_sensor(&sdata[count], opal_index, hw_id,
642 sensor_id, "label", type, pgroups[type],
643 NULL, show_label, NULL);
644 count++;
647 if (!of_property_read_u32(np, "sensor-data-max", &sensor_id)) {
648 attr_name = get_max_attr(type);
649 populate_sensor(&sdata[count], opal_index, hw_id,
650 sensor_id, attr_name, type,
651 pgroups[type], sgrp_data, show_sensor,
652 NULL);
653 count++;
656 if (!of_property_read_u32(np, "sensor-data-min", &sensor_id)) {
657 attr_name = get_min_attr(type);
658 populate_sensor(&sdata[count], opal_index, hw_id,
659 sensor_id, attr_name, type,
660 pgroups[type], sgrp_data, show_sensor,
661 NULL);
662 count++;
665 if (sgrp_data && !sgrp_data->enable) {
666 sgrp_data->enable = true;
667 hw_id = ++group_attr_id[type];
668 populate_sensor(&sdata[count], opal_index, hw_id,
669 sgrp_data->gid, "enable", type,
670 pgroups[type], sgrp_data, show_enable,
671 store_enable);
672 count++;
676 of_node_put(opal);
677 return 0;
680 static int ibmpowernv_probe(struct platform_device *pdev)
682 struct platform_data *pdata;
683 struct device *hwmon_dev;
684 int err;
686 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
687 if (!pdata)
688 return -ENOMEM;
690 platform_set_drvdata(pdev, pdata);
691 pdata->sensors_count = 0;
692 pdata->nr_sensor_groups = 0;
693 err = populate_attr_groups(pdev);
694 if (err)
695 return err;
697 /* Create sysfs attribute data for each sensor found in the DT */
698 err = create_device_attrs(pdev);
699 if (err)
700 return err;
702 /* Finally, register with hwmon */
703 hwmon_dev = devm_hwmon_device_register_with_groups(&pdev->dev, DRVNAME,
704 pdata,
705 pdata->attr_groups);
707 return PTR_ERR_OR_ZERO(hwmon_dev);
710 static const struct platform_device_id opal_sensor_driver_ids[] = {
712 .name = "opal-sensor",
716 MODULE_DEVICE_TABLE(platform, opal_sensor_driver_ids);
718 static const struct of_device_id opal_sensor_match[] = {
719 { .compatible = "ibm,opal-sensor" },
720 { },
722 MODULE_DEVICE_TABLE(of, opal_sensor_match);
724 static struct platform_driver ibmpowernv_driver = {
725 .probe = ibmpowernv_probe,
726 .id_table = opal_sensor_driver_ids,
727 .driver = {
728 .name = DRVNAME,
729 .of_match_table = opal_sensor_match,
733 module_platform_driver(ibmpowernv_driver);
735 MODULE_AUTHOR("Neelesh Gupta <neelegup@linux.vnet.ibm.com>");
736 MODULE_DESCRIPTION("IBM POWERNV platform sensors");
737 MODULE_LICENSE("GPL");