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