Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * A hwmon driver for ACPI 4.0 power meters
4 * Copyright (C) 2009 IBM
5 *
6 * Author: Darrick J. Wong <darrick.wong@oracle.com>
7 */
8
9#include <linux/module.h>
10#include <linux/hwmon.h>
11#include <linux/hwmon-sysfs.h>
12#include <linux/jiffies.h>
13#include <linux/mutex.h>
14#include <linux/dmi.h>
15#include <linux/slab.h>
16#include <linux/kdev_t.h>
17#include <linux/sched.h>
18#include <linux/time.h>
19#include <linux/err.h>
20#include <linux/acpi.h>
21
22#define ACPI_POWER_METER_NAME "power_meter"
23#define ACPI_POWER_METER_DEVICE_NAME "Power Meter"
24#define ACPI_POWER_METER_CLASS "pwr_meter_resource"
25
26#define NUM_SENSORS 17
27
28#define POWER_METER_CAN_MEASURE (1 << 0)
29#define POWER_METER_CAN_TRIP (1 << 1)
30#define POWER_METER_CAN_CAP (1 << 2)
31#define POWER_METER_CAN_NOTIFY (1 << 3)
32#define POWER_METER_IS_BATTERY (1 << 8)
33#define UNKNOWN_HYSTERESIS 0xFFFFFFFF
34#define UNKNOWN_POWER 0xFFFFFFFF
35
36#define METER_NOTIFY_CONFIG 0x80
37#define METER_NOTIFY_TRIP 0x81
38#define METER_NOTIFY_CAP 0x82
39#define METER_NOTIFY_CAPPING 0x83
40#define METER_NOTIFY_INTERVAL 0x84
41
42#define POWER_AVERAGE_NAME "power1_average"
43#define POWER_CAP_NAME "power1_cap"
44#define POWER_AVG_INTERVAL_NAME "power1_average_interval"
45#define POWER_ALARM_NAME "power1_alarm"
46
47static int cap_in_hardware;
48static bool force_cap_on;
49
50static int can_cap_in_hardware(void)
51{
52 return force_cap_on || cap_in_hardware;
53}
54
55static const struct acpi_device_id power_meter_ids[] = {
56 {"ACPI000D", 0},
57 {"", 0},
58};
59MODULE_DEVICE_TABLE(acpi, power_meter_ids);
60
61struct acpi_power_meter_capabilities {
62 u64 flags;
63 u64 units;
64 u64 type;
65 u64 accuracy;
66 u64 sampling_time;
67 u64 min_avg_interval;
68 u64 max_avg_interval;
69 u64 hysteresis;
70 u64 configurable_cap;
71 u64 min_cap;
72 u64 max_cap;
73};
74
75struct acpi_power_meter_resource {
76 struct acpi_device *acpi_dev;
77 acpi_bus_id name;
78 struct mutex lock;
79 struct device *hwmon_dev;
80 struct acpi_power_meter_capabilities caps;
81 acpi_string model_number;
82 acpi_string serial_number;
83 acpi_string oem_info;
84 u64 power;
85 u64 cap;
86 u64 avg_interval;
87 int sensors_valid;
88 unsigned long sensors_last_updated;
89 struct sensor_device_attribute sensors[NUM_SENSORS];
90 int num_sensors;
91 s64 trip[2];
92 int num_domain_devices;
93 struct acpi_device **domain_devices;
94 struct kobject *holders_dir;
95};
96
97struct sensor_template {
98 char *label;
99 ssize_t (*show)(struct device *dev,
100 struct device_attribute *devattr,
101 char *buf);
102 ssize_t (*set)(struct device *dev,
103 struct device_attribute *devattr,
104 const char *buf, size_t count);
105 int index;
106};
107
108/* Averaging interval */
109static int update_avg_interval(struct acpi_power_meter_resource *resource)
110{
111 unsigned long long data;
112 acpi_status status;
113
114 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_GAI",
115 NULL, &data);
116 if (ACPI_FAILURE(status)) {
117 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_GAI",
118 status);
119 return -ENODEV;
120 }
121
122 resource->avg_interval = data;
123 return 0;
124}
125
126static ssize_t show_avg_interval(struct device *dev,
127 struct device_attribute *devattr,
128 char *buf)
129{
130 struct acpi_device *acpi_dev = to_acpi_device(dev);
131 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
132
133 mutex_lock(&resource->lock);
134 update_avg_interval(resource);
135 mutex_unlock(&resource->lock);
136
137 return sprintf(buf, "%llu\n", resource->avg_interval);
138}
139
140static ssize_t set_avg_interval(struct device *dev,
141 struct device_attribute *devattr,
142 const char *buf, size_t count)
143{
144 struct acpi_device *acpi_dev = to_acpi_device(dev);
145 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
146 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
147 struct acpi_object_list args = { 1, &arg0 };
148 int res;
149 unsigned long temp;
150 unsigned long long data;
151 acpi_status status;
152
153 res = kstrtoul(buf, 10, &temp);
154 if (res)
155 return res;
156
157 if (temp > resource->caps.max_avg_interval ||
158 temp < resource->caps.min_avg_interval)
159 return -EINVAL;
160 arg0.integer.value = temp;
161
162 mutex_lock(&resource->lock);
163 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PAI",
164 &args, &data);
165 if (ACPI_SUCCESS(status))
166 resource->avg_interval = temp;
167 mutex_unlock(&resource->lock);
168
169 if (ACPI_FAILURE(status)) {
170 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_PAI",
171 status);
172 return -EINVAL;
173 }
174
175 /* _PAI returns 0 on success, nonzero otherwise */
176 if (data)
177 return -EINVAL;
178
179 return count;
180}
181
182/* Cap functions */
183static int update_cap(struct acpi_power_meter_resource *resource)
184{
185 unsigned long long data;
186 acpi_status status;
187
188 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_GHL",
189 NULL, &data);
190 if (ACPI_FAILURE(status)) {
191 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_GHL",
192 status);
193 return -ENODEV;
194 }
195
196 resource->cap = data;
197 return 0;
198}
199
200static ssize_t show_cap(struct device *dev,
201 struct device_attribute *devattr,
202 char *buf)
203{
204 struct acpi_device *acpi_dev = to_acpi_device(dev);
205 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
206
207 mutex_lock(&resource->lock);
208 update_cap(resource);
209 mutex_unlock(&resource->lock);
210
211 return sprintf(buf, "%llu\n", resource->cap * 1000);
212}
213
214static ssize_t set_cap(struct device *dev, struct device_attribute *devattr,
215 const char *buf, size_t count)
216{
217 struct acpi_device *acpi_dev = to_acpi_device(dev);
218 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
219 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
220 struct acpi_object_list args = { 1, &arg0 };
221 int res;
222 unsigned long temp;
223 unsigned long long data;
224 acpi_status status;
225
226 res = kstrtoul(buf, 10, &temp);
227 if (res)
228 return res;
229
230 temp = DIV_ROUND_CLOSEST(temp, 1000);
231 if (temp > resource->caps.max_cap || temp < resource->caps.min_cap)
232 return -EINVAL;
233 arg0.integer.value = temp;
234
235 mutex_lock(&resource->lock);
236 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_SHL",
237 &args, &data);
238 if (ACPI_SUCCESS(status))
239 resource->cap = temp;
240 mutex_unlock(&resource->lock);
241
242 if (ACPI_FAILURE(status)) {
243 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_SHL",
244 status);
245 return -EINVAL;
246 }
247
248 /* _SHL returns 0 on success, nonzero otherwise */
249 if (data)
250 return -EINVAL;
251
252 return count;
253}
254
255/* Power meter trip points */
256static int set_acpi_trip(struct acpi_power_meter_resource *resource)
257{
258 union acpi_object arg_objs[] = {
259 {ACPI_TYPE_INTEGER},
260 {ACPI_TYPE_INTEGER}
261 };
262 struct acpi_object_list args = { 2, arg_objs };
263 unsigned long long data;
264 acpi_status status;
265
266 /* Both trip levels must be set */
267 if (resource->trip[0] < 0 || resource->trip[1] < 0)
268 return 0;
269
270 /* This driver stores min, max; ACPI wants max, min. */
271 arg_objs[0].integer.value = resource->trip[1];
272 arg_objs[1].integer.value = resource->trip[0];
273
274 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PTP",
275 &args, &data);
276 if (ACPI_FAILURE(status)) {
277 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_PTP",
278 status);
279 return -EINVAL;
280 }
281
282 /* _PTP returns 0 on success, nonzero otherwise */
283 if (data)
284 return -EINVAL;
285
286 return 0;
287}
288
289static ssize_t set_trip(struct device *dev, struct device_attribute *devattr,
290 const char *buf, size_t count)
291{
292 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
293 struct acpi_device *acpi_dev = to_acpi_device(dev);
294 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
295 int res;
296 unsigned long temp;
297
298 res = kstrtoul(buf, 10, &temp);
299 if (res)
300 return res;
301
302 temp = DIV_ROUND_CLOSEST(temp, 1000);
303
304 mutex_lock(&resource->lock);
305 resource->trip[attr->index - 7] = temp;
306 res = set_acpi_trip(resource);
307 mutex_unlock(&resource->lock);
308
309 if (res)
310 return res;
311
312 return count;
313}
314
315/* Power meter */
316static int update_meter(struct acpi_power_meter_resource *resource)
317{
318 unsigned long long data;
319 acpi_status status;
320 unsigned long local_jiffies = jiffies;
321
322 if (time_before(local_jiffies, resource->sensors_last_updated +
323 msecs_to_jiffies(resource->caps.sampling_time)) &&
324 resource->sensors_valid)
325 return 0;
326
327 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PMM",
328 NULL, &data);
329 if (ACPI_FAILURE(status)) {
330 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_PMM",
331 status);
332 return -ENODEV;
333 }
334
335 resource->power = data;
336 resource->sensors_valid = 1;
337 resource->sensors_last_updated = jiffies;
338 return 0;
339}
340
341static ssize_t show_power(struct device *dev,
342 struct device_attribute *devattr,
343 char *buf)
344{
345 struct acpi_device *acpi_dev = to_acpi_device(dev);
346 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
347
348 mutex_lock(&resource->lock);
349 update_meter(resource);
350 mutex_unlock(&resource->lock);
351
352 if (resource->power == UNKNOWN_POWER)
353 return -ENODATA;
354
355 return sprintf(buf, "%llu\n", resource->power * 1000);
356}
357
358/* Miscellaneous */
359static ssize_t show_str(struct device *dev,
360 struct device_attribute *devattr,
361 char *buf)
362{
363 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
364 struct acpi_device *acpi_dev = to_acpi_device(dev);
365 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
366 acpi_string val;
367 int ret;
368
369 mutex_lock(&resource->lock);
370 switch (attr->index) {
371 case 0:
372 val = resource->model_number;
373 break;
374 case 1:
375 val = resource->serial_number;
376 break;
377 case 2:
378 val = resource->oem_info;
379 break;
380 default:
381 WARN(1, "Implementation error: unexpected attribute index %d\n",
382 attr->index);
383 val = "";
384 break;
385 }
386 ret = sprintf(buf, "%s\n", val);
387 mutex_unlock(&resource->lock);
388 return ret;
389}
390
391static ssize_t show_val(struct device *dev,
392 struct device_attribute *devattr,
393 char *buf)
394{
395 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
396 struct acpi_device *acpi_dev = to_acpi_device(dev);
397 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
398 u64 val = 0;
399
400 switch (attr->index) {
401 case 0:
402 val = resource->caps.min_avg_interval;
403 break;
404 case 1:
405 val = resource->caps.max_avg_interval;
406 break;
407 case 2:
408 val = resource->caps.min_cap * 1000;
409 break;
410 case 3:
411 val = resource->caps.max_cap * 1000;
412 break;
413 case 4:
414 if (resource->caps.hysteresis == UNKNOWN_HYSTERESIS)
415 return sprintf(buf, "unknown\n");
416
417 val = resource->caps.hysteresis * 1000;
418 break;
419 case 5:
420 if (resource->caps.flags & POWER_METER_IS_BATTERY)
421 val = 1;
422 else
423 val = 0;
424 break;
425 case 6:
426 if (resource->power > resource->cap)
427 val = 1;
428 else
429 val = 0;
430 break;
431 case 7:
432 case 8:
433 if (resource->trip[attr->index - 7] < 0)
434 return sprintf(buf, "unknown\n");
435
436 val = resource->trip[attr->index - 7] * 1000;
437 break;
438 default:
439 WARN(1, "Implementation error: unexpected attribute index %d\n",
440 attr->index);
441 break;
442 }
443
444 return sprintf(buf, "%llu\n", val);
445}
446
447static ssize_t show_accuracy(struct device *dev,
448 struct device_attribute *devattr,
449 char *buf)
450{
451 struct acpi_device *acpi_dev = to_acpi_device(dev);
452 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
453 unsigned int acc = resource->caps.accuracy;
454
455 return sprintf(buf, "%u.%u%%\n", acc / 1000, acc % 1000);
456}
457
458static ssize_t show_name(struct device *dev,
459 struct device_attribute *devattr,
460 char *buf)
461{
462 return sprintf(buf, "%s\n", ACPI_POWER_METER_NAME);
463}
464
465#define RO_SENSOR_TEMPLATE(_label, _show, _index) \
466 { \
467 .label = _label, \
468 .show = _show, \
469 .index = _index, \
470 }
471
472#define RW_SENSOR_TEMPLATE(_label, _show, _set, _index) \
473 { \
474 .label = _label, \
475 .show = _show, \
476 .set = _set, \
477 .index = _index, \
478 }
479
480/* Sensor descriptions. If you add a sensor, update NUM_SENSORS above! */
481static struct sensor_template meter_attrs[] = {
482 RO_SENSOR_TEMPLATE(POWER_AVERAGE_NAME, show_power, 0),
483 RO_SENSOR_TEMPLATE("power1_accuracy", show_accuracy, 0),
484 RO_SENSOR_TEMPLATE("power1_average_interval_min", show_val, 0),
485 RO_SENSOR_TEMPLATE("power1_average_interval_max", show_val, 1),
486 RO_SENSOR_TEMPLATE("power1_is_battery", show_val, 5),
487 RW_SENSOR_TEMPLATE(POWER_AVG_INTERVAL_NAME, show_avg_interval,
488 set_avg_interval, 0),
489 {},
490};
491
492static struct sensor_template misc_cap_attrs[] = {
493 RO_SENSOR_TEMPLATE("power1_cap_min", show_val, 2),
494 RO_SENSOR_TEMPLATE("power1_cap_max", show_val, 3),
495 RO_SENSOR_TEMPLATE("power1_cap_hyst", show_val, 4),
496 RO_SENSOR_TEMPLATE(POWER_ALARM_NAME, show_val, 6),
497 {},
498};
499
500static struct sensor_template ro_cap_attrs[] = {
501 RO_SENSOR_TEMPLATE(POWER_CAP_NAME, show_cap, 0),
502 {},
503};
504
505static struct sensor_template rw_cap_attrs[] = {
506 RW_SENSOR_TEMPLATE(POWER_CAP_NAME, show_cap, set_cap, 0),
507 {},
508};
509
510static struct sensor_template trip_attrs[] = {
511 RW_SENSOR_TEMPLATE("power1_average_min", show_val, set_trip, 7),
512 RW_SENSOR_TEMPLATE("power1_average_max", show_val, set_trip, 8),
513 {},
514};
515
516static struct sensor_template misc_attrs[] = {
517 RO_SENSOR_TEMPLATE("name", show_name, 0),
518 RO_SENSOR_TEMPLATE("power1_model_number", show_str, 0),
519 RO_SENSOR_TEMPLATE("power1_oem_info", show_str, 2),
520 RO_SENSOR_TEMPLATE("power1_serial_number", show_str, 1),
521 {},
522};
523
524#undef RO_SENSOR_TEMPLATE
525#undef RW_SENSOR_TEMPLATE
526
527/* Read power domain data */
528static void remove_domain_devices(struct acpi_power_meter_resource *resource)
529{
530 int i;
531
532 if (!resource->num_domain_devices)
533 return;
534
535 for (i = 0; i < resource->num_domain_devices; i++) {
536 struct acpi_device *obj = resource->domain_devices[i];
537
538 if (!obj)
539 continue;
540
541 sysfs_remove_link(resource->holders_dir,
542 kobject_name(&obj->dev.kobj));
543 acpi_dev_put(obj);
544 }
545
546 kfree(resource->domain_devices);
547 kobject_put(resource->holders_dir);
548 resource->num_domain_devices = 0;
549}
550
551static int read_domain_devices(struct acpi_power_meter_resource *resource)
552{
553 int res = 0;
554 int i;
555 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
556 union acpi_object *pss;
557 acpi_status status;
558
559 status = acpi_evaluate_object(resource->acpi_dev->handle, "_PMD", NULL,
560 &buffer);
561 if (ACPI_FAILURE(status)) {
562 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_PMD",
563 status);
564 return -ENODEV;
565 }
566
567 pss = buffer.pointer;
568 if (!pss ||
569 pss->type != ACPI_TYPE_PACKAGE) {
570 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
571 "Invalid _PMD data\n");
572 res = -EFAULT;
573 goto end;
574 }
575
576 if (!pss->package.count)
577 goto end;
578
579 resource->domain_devices = kcalloc(pss->package.count,
580 sizeof(struct acpi_device *),
581 GFP_KERNEL);
582 if (!resource->domain_devices) {
583 res = -ENOMEM;
584 goto end;
585 }
586
587 resource->holders_dir = kobject_create_and_add("measures",
588 &resource->acpi_dev->dev.kobj);
589 if (!resource->holders_dir) {
590 res = -ENOMEM;
591 goto exit_free;
592 }
593
594 resource->num_domain_devices = pss->package.count;
595
596 for (i = 0; i < pss->package.count; i++) {
597 struct acpi_device *obj;
598 union acpi_object *element = &pss->package.elements[i];
599
600 /* Refuse non-references */
601 if (element->type != ACPI_TYPE_LOCAL_REFERENCE)
602 continue;
603
604 /* Create a symlink to domain objects */
605 obj = acpi_get_acpi_dev(element->reference.handle);
606 resource->domain_devices[i] = obj;
607 if (!obj)
608 continue;
609
610 res = sysfs_create_link(resource->holders_dir, &obj->dev.kobj,
611 kobject_name(&obj->dev.kobj));
612 if (res) {
613 acpi_dev_put(obj);
614 resource->domain_devices[i] = NULL;
615 }
616 }
617
618 res = 0;
619 goto end;
620
621exit_free:
622 kfree(resource->domain_devices);
623end:
624 kfree(buffer.pointer);
625 return res;
626}
627
628/* Registration and deregistration */
629static int register_attrs(struct acpi_power_meter_resource *resource,
630 struct sensor_template *attrs)
631{
632 struct device *dev = &resource->acpi_dev->dev;
633 struct sensor_device_attribute *sensors =
634 &resource->sensors[resource->num_sensors];
635 int res = 0;
636
637 while (attrs->label) {
638 sensors->dev_attr.attr.name = attrs->label;
639 sensors->dev_attr.attr.mode = 0444;
640 sensors->dev_attr.show = attrs->show;
641 sensors->index = attrs->index;
642
643 if (attrs->set) {
644 sensors->dev_attr.attr.mode |= 0200;
645 sensors->dev_attr.store = attrs->set;
646 }
647
648 sysfs_attr_init(&sensors->dev_attr.attr);
649 res = device_create_file(dev, &sensors->dev_attr);
650 if (res) {
651 sensors->dev_attr.attr.name = NULL;
652 goto error;
653 }
654 sensors++;
655 resource->num_sensors++;
656 attrs++;
657 }
658
659error:
660 return res;
661}
662
663static void remove_attrs(struct acpi_power_meter_resource *resource)
664{
665 int i;
666
667 for (i = 0; i < resource->num_sensors; i++) {
668 if (!resource->sensors[i].dev_attr.attr.name)
669 continue;
670 device_remove_file(&resource->acpi_dev->dev,
671 &resource->sensors[i].dev_attr);
672 }
673
674 remove_domain_devices(resource);
675
676 resource->num_sensors = 0;
677}
678
679static int setup_attrs(struct acpi_power_meter_resource *resource)
680{
681 int res = 0;
682
683 /* _PMD method is optional. */
684 res = read_domain_devices(resource);
685 if (res && res != -ENODEV)
686 return res;
687
688 if (resource->caps.flags & POWER_METER_CAN_MEASURE) {
689 res = register_attrs(resource, meter_attrs);
690 if (res)
691 goto error;
692 }
693
694 if (resource->caps.flags & POWER_METER_CAN_CAP) {
695 if (!can_cap_in_hardware()) {
696 dev_warn(&resource->acpi_dev->dev,
697 "Ignoring unsafe software power cap!\n");
698 goto skip_unsafe_cap;
699 }
700
701 if (resource->caps.configurable_cap)
702 res = register_attrs(resource, rw_cap_attrs);
703 else
704 res = register_attrs(resource, ro_cap_attrs);
705
706 if (res)
707 goto error;
708
709 res = register_attrs(resource, misc_cap_attrs);
710 if (res)
711 goto error;
712 }
713
714skip_unsafe_cap:
715 if (resource->caps.flags & POWER_METER_CAN_TRIP) {
716 res = register_attrs(resource, trip_attrs);
717 if (res)
718 goto error;
719 }
720
721 res = register_attrs(resource, misc_attrs);
722 if (res)
723 goto error;
724
725 return res;
726error:
727 remove_attrs(resource);
728 return res;
729}
730
731static void free_capabilities(struct acpi_power_meter_resource *resource)
732{
733 acpi_string *str;
734 int i;
735
736 str = &resource->model_number;
737 for (i = 0; i < 3; i++, str++) {
738 kfree(*str);
739 *str = NULL;
740 }
741}
742
743static int read_capabilities(struct acpi_power_meter_resource *resource)
744{
745 int res = 0;
746 int i;
747 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
748 struct acpi_buffer state = { 0, NULL };
749 struct acpi_buffer format = { sizeof("NNNNNNNNNNN"), "NNNNNNNNNNN" };
750 union acpi_object *pss;
751 acpi_string *str;
752 acpi_status status;
753
754 status = acpi_evaluate_object(resource->acpi_dev->handle, "_PMC", NULL,
755 &buffer);
756 if (ACPI_FAILURE(status)) {
757 acpi_evaluation_failure_warn(resource->acpi_dev->handle, "_PMC",
758 status);
759 return -ENODEV;
760 }
761
762 pss = buffer.pointer;
763 if (!pss ||
764 pss->type != ACPI_TYPE_PACKAGE ||
765 pss->package.count != 14) {
766 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
767 "Invalid _PMC data\n");
768 res = -EFAULT;
769 goto end;
770 }
771
772 /* Grab all the integer data at once */
773 state.length = sizeof(struct acpi_power_meter_capabilities);
774 state.pointer = &resource->caps;
775
776 status = acpi_extract_package(pss, &format, &state);
777 if (ACPI_FAILURE(status)) {
778 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
779 "_PMC package parsing failed: %s\n",
780 acpi_format_exception(status));
781 res = -EFAULT;
782 goto end;
783 }
784
785 if (resource->caps.units) {
786 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
787 "Unknown units %llu.\n",
788 resource->caps.units);
789 res = -EINVAL;
790 goto end;
791 }
792
793 /* Grab the string data */
794 str = &resource->model_number;
795
796 for (i = 11; i < 14; i++) {
797 union acpi_object *element = &pss->package.elements[i];
798
799 if (element->type != ACPI_TYPE_STRING) {
800 res = -EINVAL;
801 goto error;
802 }
803
804 *str = kmemdup_nul(element->string.pointer, element->string.length,
805 GFP_KERNEL);
806 if (!*str) {
807 res = -ENOMEM;
808 goto error;
809 }
810
811 str++;
812 }
813
814 dev_info(&resource->acpi_dev->dev, "Found ACPI power meter.\n");
815 goto end;
816error:
817 free_capabilities(resource);
818end:
819 kfree(buffer.pointer);
820 return res;
821}
822
823/* Handle ACPI event notifications */
824static void acpi_power_meter_notify(struct acpi_device *device, u32 event)
825{
826 struct acpi_power_meter_resource *resource;
827 int res;
828
829 if (!device || !acpi_driver_data(device))
830 return;
831
832 resource = acpi_driver_data(device);
833
834 switch (event) {
835 case METER_NOTIFY_CONFIG:
836 mutex_lock(&resource->lock);
837 free_capabilities(resource);
838 res = read_capabilities(resource);
839 mutex_unlock(&resource->lock);
840 if (res)
841 break;
842
843 remove_attrs(resource);
844 setup_attrs(resource);
845 break;
846 case METER_NOTIFY_TRIP:
847 sysfs_notify(&device->dev.kobj, NULL, POWER_AVERAGE_NAME);
848 break;
849 case METER_NOTIFY_CAP:
850 sysfs_notify(&device->dev.kobj, NULL, POWER_CAP_NAME);
851 break;
852 case METER_NOTIFY_INTERVAL:
853 sysfs_notify(&device->dev.kobj, NULL, POWER_AVG_INTERVAL_NAME);
854 break;
855 case METER_NOTIFY_CAPPING:
856 sysfs_notify(&device->dev.kobj, NULL, POWER_ALARM_NAME);
857 dev_info(&device->dev, "Capping in progress.\n");
858 break;
859 default:
860 WARN(1, "Unexpected event %d\n", event);
861 break;
862 }
863
864 acpi_bus_generate_netlink_event(ACPI_POWER_METER_CLASS,
865 dev_name(&device->dev), event, 0);
866}
867
868static int acpi_power_meter_add(struct acpi_device *device)
869{
870 int res;
871 struct acpi_power_meter_resource *resource;
872
873 if (!device)
874 return -EINVAL;
875
876 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
877 if (!resource)
878 return -ENOMEM;
879
880 resource->sensors_valid = 0;
881 resource->acpi_dev = device;
882 mutex_init(&resource->lock);
883 strcpy(acpi_device_name(device), ACPI_POWER_METER_DEVICE_NAME);
884 strcpy(acpi_device_class(device), ACPI_POWER_METER_CLASS);
885 device->driver_data = resource;
886
887#if IS_REACHABLE(CONFIG_ACPI_IPMI)
888 /*
889 * On Dell systems several methods of acpi_power_meter access
890 * variables in IPMI region, so wait until IPMI space handler is
891 * installed by acpi_ipmi and also wait until SMI is selected to make
892 * the space handler fully functional.
893 */
894 if (dmi_match(DMI_SYS_VENDOR, "Dell Inc.")) {
895 struct acpi_device *ipi_device = acpi_dev_get_first_match_dev("IPI0001", NULL, -1);
896
897 if (ipi_device && acpi_wait_for_acpi_ipmi())
898 dev_warn(&device->dev, "Waiting for ACPI IPMI timeout");
899 acpi_dev_put(ipi_device);
900 }
901#endif
902
903 res = read_capabilities(resource);
904 if (res)
905 goto exit_free;
906
907 resource->trip[0] = -1;
908 resource->trip[1] = -1;
909
910 res = setup_attrs(resource);
911 if (res)
912 goto exit_free_capability;
913
914 resource->hwmon_dev = hwmon_device_register(&device->dev);
915 if (IS_ERR(resource->hwmon_dev)) {
916 res = PTR_ERR(resource->hwmon_dev);
917 goto exit_remove;
918 }
919
920 res = 0;
921 goto exit;
922
923exit_remove:
924 remove_attrs(resource);
925exit_free_capability:
926 free_capabilities(resource);
927exit_free:
928 kfree(resource);
929exit:
930 return res;
931}
932
933static void acpi_power_meter_remove(struct acpi_device *device)
934{
935 struct acpi_power_meter_resource *resource;
936
937 if (!device || !acpi_driver_data(device))
938 return;
939
940 resource = acpi_driver_data(device);
941 hwmon_device_unregister(resource->hwmon_dev);
942
943 remove_attrs(resource);
944 free_capabilities(resource);
945
946 kfree(resource);
947}
948
949static int acpi_power_meter_resume(struct device *dev)
950{
951 struct acpi_power_meter_resource *resource;
952
953 if (!dev)
954 return -EINVAL;
955
956 resource = acpi_driver_data(to_acpi_device(dev));
957 if (!resource)
958 return -EINVAL;
959
960 free_capabilities(resource);
961 read_capabilities(resource);
962
963 return 0;
964}
965
966static DEFINE_SIMPLE_DEV_PM_OPS(acpi_power_meter_pm, NULL,
967 acpi_power_meter_resume);
968
969static struct acpi_driver acpi_power_meter_driver = {
970 .name = "power_meter",
971 .class = ACPI_POWER_METER_CLASS,
972 .ids = power_meter_ids,
973 .ops = {
974 .add = acpi_power_meter_add,
975 .remove = acpi_power_meter_remove,
976 .notify = acpi_power_meter_notify,
977 },
978 .drv.pm = pm_sleep_ptr(&acpi_power_meter_pm),
979};
980
981/* Module init/exit routines */
982static int __init enable_cap_knobs(const struct dmi_system_id *d)
983{
984 cap_in_hardware = 1;
985 return 0;
986}
987
988static const struct dmi_system_id pm_dmi_table[] __initconst = {
989 {
990 enable_cap_knobs, "IBM Active Energy Manager",
991 {
992 DMI_MATCH(DMI_SYS_VENDOR, "IBM")
993 },
994 },
995 {}
996};
997
998static int __init acpi_power_meter_init(void)
999{
1000 int result;
1001
1002 if (acpi_disabled)
1003 return -ENODEV;
1004
1005 dmi_check_system(pm_dmi_table);
1006
1007 result = acpi_bus_register_driver(&acpi_power_meter_driver);
1008 if (result < 0)
1009 return result;
1010
1011 return 0;
1012}
1013
1014static void __exit acpi_power_meter_exit(void)
1015{
1016 acpi_bus_unregister_driver(&acpi_power_meter_driver);
1017}
1018
1019MODULE_AUTHOR("Darrick J. Wong <darrick.wong@oracle.com>");
1020MODULE_DESCRIPTION("ACPI 4.0 power meter driver");
1021MODULE_LICENSE("GPL");
1022
1023module_param(force_cap_on, bool, 0644);
1024MODULE_PARM_DESC(force_cap_on, "Enable power cap even it is unsafe to do so.");
1025
1026module_init(acpi_power_meter_init);
1027module_exit(acpi_power_meter_exit);
1/*
2 * A hwmon driver for ACPI 4.0 power meters
3 * Copyright (C) 2009 IBM
4 *
5 * Author: Darrick J. Wong <darrick.wong@oracle.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22#include <linux/module.h>
23#include <linux/hwmon.h>
24#include <linux/hwmon-sysfs.h>
25#include <linux/jiffies.h>
26#include <linux/mutex.h>
27#include <linux/dmi.h>
28#include <linux/slab.h>
29#include <linux/kdev_t.h>
30#include <linux/sched.h>
31#include <linux/time.h>
32#include <linux/err.h>
33#include <linux/acpi.h>
34
35#define ACPI_POWER_METER_NAME "power_meter"
36ACPI_MODULE_NAME(ACPI_POWER_METER_NAME);
37#define ACPI_POWER_METER_DEVICE_NAME "Power Meter"
38#define ACPI_POWER_METER_CLASS "pwr_meter_resource"
39
40#define NUM_SENSORS 17
41
42#define POWER_METER_CAN_MEASURE (1 << 0)
43#define POWER_METER_CAN_TRIP (1 << 1)
44#define POWER_METER_CAN_CAP (1 << 2)
45#define POWER_METER_CAN_NOTIFY (1 << 3)
46#define POWER_METER_IS_BATTERY (1 << 8)
47#define UNKNOWN_HYSTERESIS 0xFFFFFFFF
48
49#define METER_NOTIFY_CONFIG 0x80
50#define METER_NOTIFY_TRIP 0x81
51#define METER_NOTIFY_CAP 0x82
52#define METER_NOTIFY_CAPPING 0x83
53#define METER_NOTIFY_INTERVAL 0x84
54
55#define POWER_AVERAGE_NAME "power1_average"
56#define POWER_CAP_NAME "power1_cap"
57#define POWER_AVG_INTERVAL_NAME "power1_average_interval"
58#define POWER_ALARM_NAME "power1_alarm"
59
60static int cap_in_hardware;
61static bool force_cap_on;
62
63static int can_cap_in_hardware(void)
64{
65 return force_cap_on || cap_in_hardware;
66}
67
68static const struct acpi_device_id power_meter_ids[] = {
69 {"ACPI000D", 0},
70 {"", 0},
71};
72MODULE_DEVICE_TABLE(acpi, power_meter_ids);
73
74struct acpi_power_meter_capabilities {
75 u64 flags;
76 u64 units;
77 u64 type;
78 u64 accuracy;
79 u64 sampling_time;
80 u64 min_avg_interval;
81 u64 max_avg_interval;
82 u64 hysteresis;
83 u64 configurable_cap;
84 u64 min_cap;
85 u64 max_cap;
86};
87
88struct acpi_power_meter_resource {
89 struct acpi_device *acpi_dev;
90 acpi_bus_id name;
91 struct mutex lock;
92 struct device *hwmon_dev;
93 struct acpi_power_meter_capabilities caps;
94 acpi_string model_number;
95 acpi_string serial_number;
96 acpi_string oem_info;
97 u64 power;
98 u64 cap;
99 u64 avg_interval;
100 int sensors_valid;
101 unsigned long sensors_last_updated;
102 struct sensor_device_attribute sensors[NUM_SENSORS];
103 int num_sensors;
104 s64 trip[2];
105 int num_domain_devices;
106 struct acpi_device **domain_devices;
107 struct kobject *holders_dir;
108};
109
110struct sensor_template {
111 char *label;
112 ssize_t (*show)(struct device *dev,
113 struct device_attribute *devattr,
114 char *buf);
115 ssize_t (*set)(struct device *dev,
116 struct device_attribute *devattr,
117 const char *buf, size_t count);
118 int index;
119};
120
121/* Averaging interval */
122static int update_avg_interval(struct acpi_power_meter_resource *resource)
123{
124 unsigned long long data;
125 acpi_status status;
126
127 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_GAI",
128 NULL, &data);
129 if (ACPI_FAILURE(status)) {
130 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _GAI"));
131 return -ENODEV;
132 }
133
134 resource->avg_interval = data;
135 return 0;
136}
137
138static ssize_t show_avg_interval(struct device *dev,
139 struct device_attribute *devattr,
140 char *buf)
141{
142 struct acpi_device *acpi_dev = to_acpi_device(dev);
143 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
144
145 mutex_lock(&resource->lock);
146 update_avg_interval(resource);
147 mutex_unlock(&resource->lock);
148
149 return sprintf(buf, "%llu\n", resource->avg_interval);
150}
151
152static ssize_t set_avg_interval(struct device *dev,
153 struct device_attribute *devattr,
154 const char *buf, size_t count)
155{
156 struct acpi_device *acpi_dev = to_acpi_device(dev);
157 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
158 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
159 struct acpi_object_list args = { 1, &arg0 };
160 int res;
161 unsigned long temp;
162 unsigned long long data;
163 acpi_status status;
164
165 res = kstrtoul(buf, 10, &temp);
166 if (res)
167 return res;
168
169 if (temp > resource->caps.max_avg_interval ||
170 temp < resource->caps.min_avg_interval)
171 return -EINVAL;
172 arg0.integer.value = temp;
173
174 mutex_lock(&resource->lock);
175 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PAI",
176 &args, &data);
177 if (!ACPI_FAILURE(status))
178 resource->avg_interval = temp;
179 mutex_unlock(&resource->lock);
180
181 if (ACPI_FAILURE(status)) {
182 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PAI"));
183 return -EINVAL;
184 }
185
186 /* _PAI returns 0 on success, nonzero otherwise */
187 if (data)
188 return -EINVAL;
189
190 return count;
191}
192
193/* Cap functions */
194static int update_cap(struct acpi_power_meter_resource *resource)
195{
196 unsigned long long data;
197 acpi_status status;
198
199 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_GHL",
200 NULL, &data);
201 if (ACPI_FAILURE(status)) {
202 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _GHL"));
203 return -ENODEV;
204 }
205
206 resource->cap = data;
207 return 0;
208}
209
210static ssize_t show_cap(struct device *dev,
211 struct device_attribute *devattr,
212 char *buf)
213{
214 struct acpi_device *acpi_dev = to_acpi_device(dev);
215 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
216
217 mutex_lock(&resource->lock);
218 update_cap(resource);
219 mutex_unlock(&resource->lock);
220
221 return sprintf(buf, "%llu\n", resource->cap * 1000);
222}
223
224static ssize_t set_cap(struct device *dev, struct device_attribute *devattr,
225 const char *buf, size_t count)
226{
227 struct acpi_device *acpi_dev = to_acpi_device(dev);
228 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
229 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
230 struct acpi_object_list args = { 1, &arg0 };
231 int res;
232 unsigned long temp;
233 unsigned long long data;
234 acpi_status status;
235
236 res = kstrtoul(buf, 10, &temp);
237 if (res)
238 return res;
239
240 temp = DIV_ROUND_CLOSEST(temp, 1000);
241 if (temp > resource->caps.max_cap || temp < resource->caps.min_cap)
242 return -EINVAL;
243 arg0.integer.value = temp;
244
245 mutex_lock(&resource->lock);
246 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_SHL",
247 &args, &data);
248 if (!ACPI_FAILURE(status))
249 resource->cap = temp;
250 mutex_unlock(&resource->lock);
251
252 if (ACPI_FAILURE(status)) {
253 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _SHL"));
254 return -EINVAL;
255 }
256
257 /* _SHL returns 0 on success, nonzero otherwise */
258 if (data)
259 return -EINVAL;
260
261 return count;
262}
263
264/* Power meter trip points */
265static int set_acpi_trip(struct acpi_power_meter_resource *resource)
266{
267 union acpi_object arg_objs[] = {
268 {ACPI_TYPE_INTEGER},
269 {ACPI_TYPE_INTEGER}
270 };
271 struct acpi_object_list args = { 2, arg_objs };
272 unsigned long long data;
273 acpi_status status;
274
275 /* Both trip levels must be set */
276 if (resource->trip[0] < 0 || resource->trip[1] < 0)
277 return 0;
278
279 /* This driver stores min, max; ACPI wants max, min. */
280 arg_objs[0].integer.value = resource->trip[1];
281 arg_objs[1].integer.value = resource->trip[0];
282
283 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PTP",
284 &args, &data);
285 if (ACPI_FAILURE(status)) {
286 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PTP"));
287 return -EINVAL;
288 }
289
290 /* _PTP returns 0 on success, nonzero otherwise */
291 if (data)
292 return -EINVAL;
293
294 return 0;
295}
296
297static ssize_t set_trip(struct device *dev, struct device_attribute *devattr,
298 const char *buf, size_t count)
299{
300 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
301 struct acpi_device *acpi_dev = to_acpi_device(dev);
302 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
303 int res;
304 unsigned long temp;
305
306 res = kstrtoul(buf, 10, &temp);
307 if (res)
308 return res;
309
310 temp = DIV_ROUND_CLOSEST(temp, 1000);
311
312 mutex_lock(&resource->lock);
313 resource->trip[attr->index - 7] = temp;
314 res = set_acpi_trip(resource);
315 mutex_unlock(&resource->lock);
316
317 if (res)
318 return res;
319
320 return count;
321}
322
323/* Power meter */
324static int update_meter(struct acpi_power_meter_resource *resource)
325{
326 unsigned long long data;
327 acpi_status status;
328 unsigned long local_jiffies = jiffies;
329
330 if (time_before(local_jiffies, resource->sensors_last_updated +
331 msecs_to_jiffies(resource->caps.sampling_time)) &&
332 resource->sensors_valid)
333 return 0;
334
335 status = acpi_evaluate_integer(resource->acpi_dev->handle, "_PMM",
336 NULL, &data);
337 if (ACPI_FAILURE(status)) {
338 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PMM"));
339 return -ENODEV;
340 }
341
342 resource->power = data;
343 resource->sensors_valid = 1;
344 resource->sensors_last_updated = jiffies;
345 return 0;
346}
347
348static ssize_t show_power(struct device *dev,
349 struct device_attribute *devattr,
350 char *buf)
351{
352 struct acpi_device *acpi_dev = to_acpi_device(dev);
353 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
354
355 mutex_lock(&resource->lock);
356 update_meter(resource);
357 mutex_unlock(&resource->lock);
358
359 return sprintf(buf, "%llu\n", resource->power * 1000);
360}
361
362/* Miscellaneous */
363static ssize_t show_str(struct device *dev,
364 struct device_attribute *devattr,
365 char *buf)
366{
367 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
368 struct acpi_device *acpi_dev = to_acpi_device(dev);
369 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
370 acpi_string val;
371
372 switch (attr->index) {
373 case 0:
374 val = resource->model_number;
375 break;
376 case 1:
377 val = resource->serial_number;
378 break;
379 case 2:
380 val = resource->oem_info;
381 break;
382 default:
383 WARN(1, "Implementation error: unexpected attribute index %d\n",
384 attr->index);
385 val = "";
386 break;
387 }
388
389 return sprintf(buf, "%s\n", val);
390}
391
392static ssize_t show_val(struct device *dev,
393 struct device_attribute *devattr,
394 char *buf)
395{
396 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
397 struct acpi_device *acpi_dev = to_acpi_device(dev);
398 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
399 u64 val = 0;
400
401 switch (attr->index) {
402 case 0:
403 val = resource->caps.min_avg_interval;
404 break;
405 case 1:
406 val = resource->caps.max_avg_interval;
407 break;
408 case 2:
409 val = resource->caps.min_cap * 1000;
410 break;
411 case 3:
412 val = resource->caps.max_cap * 1000;
413 break;
414 case 4:
415 if (resource->caps.hysteresis == UNKNOWN_HYSTERESIS)
416 return sprintf(buf, "unknown\n");
417
418 val = resource->caps.hysteresis * 1000;
419 break;
420 case 5:
421 if (resource->caps.flags & POWER_METER_IS_BATTERY)
422 val = 1;
423 else
424 val = 0;
425 break;
426 case 6:
427 if (resource->power > resource->cap)
428 val = 1;
429 else
430 val = 0;
431 break;
432 case 7:
433 case 8:
434 if (resource->trip[attr->index - 7] < 0)
435 return sprintf(buf, "unknown\n");
436
437 val = resource->trip[attr->index - 7] * 1000;
438 break;
439 default:
440 WARN(1, "Implementation error: unexpected attribute index %d\n",
441 attr->index);
442 break;
443 }
444
445 return sprintf(buf, "%llu\n", val);
446}
447
448static ssize_t show_accuracy(struct device *dev,
449 struct device_attribute *devattr,
450 char *buf)
451{
452 struct acpi_device *acpi_dev = to_acpi_device(dev);
453 struct acpi_power_meter_resource *resource = acpi_dev->driver_data;
454 unsigned int acc = resource->caps.accuracy;
455
456 return sprintf(buf, "%u.%u%%\n", acc / 1000, acc % 1000);
457}
458
459static ssize_t show_name(struct device *dev,
460 struct device_attribute *devattr,
461 char *buf)
462{
463 return sprintf(buf, "%s\n", ACPI_POWER_METER_NAME);
464}
465
466#define RO_SENSOR_TEMPLATE(_label, _show, _index) \
467 { \
468 .label = _label, \
469 .show = _show, \
470 .index = _index, \
471 }
472
473#define RW_SENSOR_TEMPLATE(_label, _show, _set, _index) \
474 { \
475 .label = _label, \
476 .show = _show, \
477 .set = _set, \
478 .index = _index, \
479 }
480
481/* Sensor descriptions. If you add a sensor, update NUM_SENSORS above! */
482static struct sensor_template meter_attrs[] = {
483 RO_SENSOR_TEMPLATE(POWER_AVERAGE_NAME, show_power, 0),
484 RO_SENSOR_TEMPLATE("power1_accuracy", show_accuracy, 0),
485 RO_SENSOR_TEMPLATE("power1_average_interval_min", show_val, 0),
486 RO_SENSOR_TEMPLATE("power1_average_interval_max", show_val, 1),
487 RO_SENSOR_TEMPLATE("power1_is_battery", show_val, 5),
488 RW_SENSOR_TEMPLATE(POWER_AVG_INTERVAL_NAME, show_avg_interval,
489 set_avg_interval, 0),
490 {},
491};
492
493static struct sensor_template misc_cap_attrs[] = {
494 RO_SENSOR_TEMPLATE("power1_cap_min", show_val, 2),
495 RO_SENSOR_TEMPLATE("power1_cap_max", show_val, 3),
496 RO_SENSOR_TEMPLATE("power1_cap_hyst", show_val, 4),
497 RO_SENSOR_TEMPLATE(POWER_ALARM_NAME, show_val, 6),
498 {},
499};
500
501static struct sensor_template ro_cap_attrs[] = {
502 RO_SENSOR_TEMPLATE(POWER_CAP_NAME, show_cap, 0),
503 {},
504};
505
506static struct sensor_template rw_cap_attrs[] = {
507 RW_SENSOR_TEMPLATE(POWER_CAP_NAME, show_cap, set_cap, 0),
508 {},
509};
510
511static struct sensor_template trip_attrs[] = {
512 RW_SENSOR_TEMPLATE("power1_average_min", show_val, set_trip, 7),
513 RW_SENSOR_TEMPLATE("power1_average_max", show_val, set_trip, 8),
514 {},
515};
516
517static struct sensor_template misc_attrs[] = {
518 RO_SENSOR_TEMPLATE("name", show_name, 0),
519 RO_SENSOR_TEMPLATE("power1_model_number", show_str, 0),
520 RO_SENSOR_TEMPLATE("power1_oem_info", show_str, 2),
521 RO_SENSOR_TEMPLATE("power1_serial_number", show_str, 1),
522 {},
523};
524
525#undef RO_SENSOR_TEMPLATE
526#undef RW_SENSOR_TEMPLATE
527
528/* Read power domain data */
529static void remove_domain_devices(struct acpi_power_meter_resource *resource)
530{
531 int i;
532
533 if (!resource->num_domain_devices)
534 return;
535
536 for (i = 0; i < resource->num_domain_devices; i++) {
537 struct acpi_device *obj = resource->domain_devices[i];
538 if (!obj)
539 continue;
540
541 sysfs_remove_link(resource->holders_dir,
542 kobject_name(&obj->dev.kobj));
543 put_device(&obj->dev);
544 }
545
546 kfree(resource->domain_devices);
547 kobject_put(resource->holders_dir);
548 resource->num_domain_devices = 0;
549}
550
551static int read_domain_devices(struct acpi_power_meter_resource *resource)
552{
553 int res = 0;
554 int i;
555 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
556 union acpi_object *pss;
557 acpi_status status;
558
559 status = acpi_evaluate_object(resource->acpi_dev->handle, "_PMD", NULL,
560 &buffer);
561 if (ACPI_FAILURE(status)) {
562 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PMD"));
563 return -ENODEV;
564 }
565
566 pss = buffer.pointer;
567 if (!pss ||
568 pss->type != ACPI_TYPE_PACKAGE) {
569 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
570 "Invalid _PMD data\n");
571 res = -EFAULT;
572 goto end;
573 }
574
575 if (!pss->package.count)
576 goto end;
577
578 resource->domain_devices = kzalloc(sizeof(struct acpi_device *) *
579 pss->package.count, GFP_KERNEL);
580 if (!resource->domain_devices) {
581 res = -ENOMEM;
582 goto end;
583 }
584
585 resource->holders_dir = kobject_create_and_add("measures",
586 &resource->acpi_dev->dev.kobj);
587 if (!resource->holders_dir) {
588 res = -ENOMEM;
589 goto exit_free;
590 }
591
592 resource->num_domain_devices = pss->package.count;
593
594 for (i = 0; i < pss->package.count; i++) {
595 struct acpi_device *obj;
596 union acpi_object *element = &(pss->package.elements[i]);
597
598 /* Refuse non-references */
599 if (element->type != ACPI_TYPE_LOCAL_REFERENCE)
600 continue;
601
602 /* Create a symlink to domain objects */
603 resource->domain_devices[i] = NULL;
604 if (acpi_bus_get_device(element->reference.handle,
605 &resource->domain_devices[i]))
606 continue;
607
608 obj = resource->domain_devices[i];
609 get_device(&obj->dev);
610
611 res = sysfs_create_link(resource->holders_dir, &obj->dev.kobj,
612 kobject_name(&obj->dev.kobj));
613 if (res) {
614 put_device(&obj->dev);
615 resource->domain_devices[i] = NULL;
616 }
617 }
618
619 res = 0;
620 goto end;
621
622exit_free:
623 kfree(resource->domain_devices);
624end:
625 kfree(buffer.pointer);
626 return res;
627}
628
629/* Registration and deregistration */
630static int register_attrs(struct acpi_power_meter_resource *resource,
631 struct sensor_template *attrs)
632{
633 struct device *dev = &resource->acpi_dev->dev;
634 struct sensor_device_attribute *sensors =
635 &resource->sensors[resource->num_sensors];
636 int res = 0;
637
638 while (attrs->label) {
639 sensors->dev_attr.attr.name = attrs->label;
640 sensors->dev_attr.attr.mode = S_IRUGO;
641 sensors->dev_attr.show = attrs->show;
642 sensors->index = attrs->index;
643
644 if (attrs->set) {
645 sensors->dev_attr.attr.mode |= S_IWUSR;
646 sensors->dev_attr.store = attrs->set;
647 }
648
649 sysfs_attr_init(&sensors->dev_attr.attr);
650 res = device_create_file(dev, &sensors->dev_attr);
651 if (res) {
652 sensors->dev_attr.attr.name = NULL;
653 goto error;
654 }
655 sensors++;
656 resource->num_sensors++;
657 attrs++;
658 }
659
660error:
661 return res;
662}
663
664static void remove_attrs(struct acpi_power_meter_resource *resource)
665{
666 int i;
667
668 for (i = 0; i < resource->num_sensors; i++) {
669 if (!resource->sensors[i].dev_attr.attr.name)
670 continue;
671 device_remove_file(&resource->acpi_dev->dev,
672 &resource->sensors[i].dev_attr);
673 }
674
675 remove_domain_devices(resource);
676
677 resource->num_sensors = 0;
678}
679
680static int setup_attrs(struct acpi_power_meter_resource *resource)
681{
682 int res = 0;
683
684 res = read_domain_devices(resource);
685 if (res)
686 return res;
687
688 if (resource->caps.flags & POWER_METER_CAN_MEASURE) {
689 res = register_attrs(resource, meter_attrs);
690 if (res)
691 goto error;
692 }
693
694 if (resource->caps.flags & POWER_METER_CAN_CAP) {
695 if (!can_cap_in_hardware()) {
696 dev_err(&resource->acpi_dev->dev,
697 "Ignoring unsafe software power cap!\n");
698 goto skip_unsafe_cap;
699 }
700
701 if (resource->caps.configurable_cap)
702 res = register_attrs(resource, rw_cap_attrs);
703 else
704 res = register_attrs(resource, ro_cap_attrs);
705
706 if (res)
707 goto error;
708
709 res = register_attrs(resource, misc_cap_attrs);
710 if (res)
711 goto error;
712 }
713
714skip_unsafe_cap:
715 if (resource->caps.flags & POWER_METER_CAN_TRIP) {
716 res = register_attrs(resource, trip_attrs);
717 if (res)
718 goto error;
719 }
720
721 res = register_attrs(resource, misc_attrs);
722 if (res)
723 goto error;
724
725 return res;
726error:
727 remove_attrs(resource);
728 return res;
729}
730
731static void free_capabilities(struct acpi_power_meter_resource *resource)
732{
733 acpi_string *str;
734 int i;
735
736 str = &resource->model_number;
737 for (i = 0; i < 3; i++, str++)
738 kfree(*str);
739}
740
741static int read_capabilities(struct acpi_power_meter_resource *resource)
742{
743 int res = 0;
744 int i;
745 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
746 struct acpi_buffer state = { 0, NULL };
747 struct acpi_buffer format = { sizeof("NNNNNNNNNNN"), "NNNNNNNNNNN" };
748 union acpi_object *pss;
749 acpi_string *str;
750 acpi_status status;
751
752 status = acpi_evaluate_object(resource->acpi_dev->handle, "_PMC", NULL,
753 &buffer);
754 if (ACPI_FAILURE(status)) {
755 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PMC"));
756 return -ENODEV;
757 }
758
759 pss = buffer.pointer;
760 if (!pss ||
761 pss->type != ACPI_TYPE_PACKAGE ||
762 pss->package.count != 14) {
763 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
764 "Invalid _PMC data\n");
765 res = -EFAULT;
766 goto end;
767 }
768
769 /* Grab all the integer data at once */
770 state.length = sizeof(struct acpi_power_meter_capabilities);
771 state.pointer = &resource->caps;
772
773 status = acpi_extract_package(pss, &format, &state);
774 if (ACPI_FAILURE(status)) {
775 ACPI_EXCEPTION((AE_INFO, status, "Invalid data"));
776 res = -EFAULT;
777 goto end;
778 }
779
780 if (resource->caps.units) {
781 dev_err(&resource->acpi_dev->dev, ACPI_POWER_METER_NAME
782 "Unknown units %llu.\n",
783 resource->caps.units);
784 res = -EINVAL;
785 goto end;
786 }
787
788 /* Grab the string data */
789 str = &resource->model_number;
790
791 for (i = 11; i < 14; i++) {
792 union acpi_object *element = &(pss->package.elements[i]);
793
794 if (element->type != ACPI_TYPE_STRING) {
795 res = -EINVAL;
796 goto error;
797 }
798
799 *str = kzalloc(sizeof(u8) * (element->string.length + 1),
800 GFP_KERNEL);
801 if (!*str) {
802 res = -ENOMEM;
803 goto error;
804 }
805
806 strncpy(*str, element->string.pointer, element->string.length);
807 str++;
808 }
809
810 dev_info(&resource->acpi_dev->dev, "Found ACPI power meter.\n");
811 goto end;
812error:
813 str = &resource->model_number;
814 for (i = 0; i < 3; i++, str++)
815 kfree(*str);
816end:
817 kfree(buffer.pointer);
818 return res;
819}
820
821/* Handle ACPI event notifications */
822static void acpi_power_meter_notify(struct acpi_device *device, u32 event)
823{
824 struct acpi_power_meter_resource *resource;
825 int res;
826
827 if (!device || !acpi_driver_data(device))
828 return;
829
830 resource = acpi_driver_data(device);
831
832 mutex_lock(&resource->lock);
833 switch (event) {
834 case METER_NOTIFY_CONFIG:
835 free_capabilities(resource);
836 res = read_capabilities(resource);
837 if (res)
838 break;
839
840 remove_attrs(resource);
841 setup_attrs(resource);
842 break;
843 case METER_NOTIFY_TRIP:
844 sysfs_notify(&device->dev.kobj, NULL, POWER_AVERAGE_NAME);
845 update_meter(resource);
846 break;
847 case METER_NOTIFY_CAP:
848 sysfs_notify(&device->dev.kobj, NULL, POWER_CAP_NAME);
849 update_cap(resource);
850 break;
851 case METER_NOTIFY_INTERVAL:
852 sysfs_notify(&device->dev.kobj, NULL, POWER_AVG_INTERVAL_NAME);
853 update_avg_interval(resource);
854 break;
855 case METER_NOTIFY_CAPPING:
856 sysfs_notify(&device->dev.kobj, NULL, POWER_ALARM_NAME);
857 dev_info(&device->dev, "Capping in progress.\n");
858 break;
859 default:
860 WARN(1, "Unexpected event %d\n", event);
861 break;
862 }
863 mutex_unlock(&resource->lock);
864
865 acpi_bus_generate_netlink_event(ACPI_POWER_METER_CLASS,
866 dev_name(&device->dev), event, 0);
867}
868
869static int acpi_power_meter_add(struct acpi_device *device)
870{
871 int res;
872 struct acpi_power_meter_resource *resource;
873
874 if (!device)
875 return -EINVAL;
876
877 resource = kzalloc(sizeof(struct acpi_power_meter_resource),
878 GFP_KERNEL);
879 if (!resource)
880 return -ENOMEM;
881
882 resource->sensors_valid = 0;
883 resource->acpi_dev = device;
884 mutex_init(&resource->lock);
885 strcpy(acpi_device_name(device), ACPI_POWER_METER_DEVICE_NAME);
886 strcpy(acpi_device_class(device), ACPI_POWER_METER_CLASS);
887 device->driver_data = resource;
888
889 free_capabilities(resource);
890 res = read_capabilities(resource);
891 if (res)
892 goto exit_free;
893
894 resource->trip[0] = resource->trip[1] = -1;
895
896 res = setup_attrs(resource);
897 if (res)
898 goto exit_free;
899
900 resource->hwmon_dev = hwmon_device_register(&device->dev);
901 if (IS_ERR(resource->hwmon_dev)) {
902 res = PTR_ERR(resource->hwmon_dev);
903 goto exit_remove;
904 }
905
906 res = 0;
907 goto exit;
908
909exit_remove:
910 remove_attrs(resource);
911exit_free:
912 kfree(resource);
913exit:
914 return res;
915}
916
917static int acpi_power_meter_remove(struct acpi_device *device)
918{
919 struct acpi_power_meter_resource *resource;
920
921 if (!device || !acpi_driver_data(device))
922 return -EINVAL;
923
924 resource = acpi_driver_data(device);
925 hwmon_device_unregister(resource->hwmon_dev);
926
927 free_capabilities(resource);
928 remove_attrs(resource);
929
930 kfree(resource);
931 return 0;
932}
933
934#ifdef CONFIG_PM_SLEEP
935
936static int acpi_power_meter_resume(struct device *dev)
937{
938 struct acpi_power_meter_resource *resource;
939
940 if (!dev)
941 return -EINVAL;
942
943 resource = acpi_driver_data(to_acpi_device(dev));
944 if (!resource)
945 return -EINVAL;
946
947 free_capabilities(resource);
948 read_capabilities(resource);
949
950 return 0;
951}
952
953#endif /* CONFIG_PM_SLEEP */
954
955static SIMPLE_DEV_PM_OPS(acpi_power_meter_pm, NULL, acpi_power_meter_resume);
956
957static struct acpi_driver acpi_power_meter_driver = {
958 .name = "power_meter",
959 .class = ACPI_POWER_METER_CLASS,
960 .ids = power_meter_ids,
961 .ops = {
962 .add = acpi_power_meter_add,
963 .remove = acpi_power_meter_remove,
964 .notify = acpi_power_meter_notify,
965 },
966 .drv.pm = &acpi_power_meter_pm,
967};
968
969/* Module init/exit routines */
970static int __init enable_cap_knobs(const struct dmi_system_id *d)
971{
972 cap_in_hardware = 1;
973 return 0;
974}
975
976static struct dmi_system_id __initdata pm_dmi_table[] = {
977 {
978 enable_cap_knobs, "IBM Active Energy Manager",
979 {
980 DMI_MATCH(DMI_SYS_VENDOR, "IBM")
981 },
982 },
983 {}
984};
985
986static int __init acpi_power_meter_init(void)
987{
988 int result;
989
990 if (acpi_disabled)
991 return -ENODEV;
992
993 dmi_check_system(pm_dmi_table);
994
995 result = acpi_bus_register_driver(&acpi_power_meter_driver);
996 if (result < 0)
997 return result;
998
999 return 0;
1000}
1001
1002static void __exit acpi_power_meter_exit(void)
1003{
1004 acpi_bus_unregister_driver(&acpi_power_meter_driver);
1005}
1006
1007MODULE_AUTHOR("Darrick J. Wong <darrick.wong@oracle.com>");
1008MODULE_DESCRIPTION("ACPI 4.0 power meter driver");
1009MODULE_LICENSE("GPL");
1010
1011module_param(force_cap_on, bool, 0644);
1012MODULE_PARM_DESC(force_cap_on, "Enable power cap even it is unsafe to do so.");
1013
1014module_init(acpi_power_meter_init);
1015module_exit(acpi_power_meter_exit);