?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris...
[linux/fpc-iii.git] / drivers / powercap / intel_rapl.c
blob3c6768378a94600bc487c61bc9d3fffcbf581750
1 /*
2 * Intel Running Average Power Limit (RAPL) Driver
3 * Copyright (c) 2013, Intel Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.
16 *
17 */
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/list.h>
23 #include <linux/types.h>
24 #include <linux/device.h>
25 #include <linux/slab.h>
26 #include <linux/log2.h>
27 #include <linux/bitmap.h>
28 #include <linux/delay.h>
29 #include <linux/sysfs.h>
30 #include <linux/cpu.h>
31 #include <linux/powercap.h>
32
33 #include <asm/processor.h>
34 #include <asm/cpu_device_id.h>
35
36 /* bitmasks for RAPL MSRs, used by primitive access functions */
37 #define ENERGY_STATUS_MASK 0xffffffff
38
39 #define POWER_LIMIT1_MASK 0x7FFF
40 #define POWER_LIMIT1_ENABLE BIT(15)
41 #define POWER_LIMIT1_CLAMP BIT(16)
42
43 #define POWER_LIMIT2_MASK (0x7FFFULL<<32)
44 #define POWER_LIMIT2_ENABLE BIT_ULL(47)
45 #define POWER_LIMIT2_CLAMP BIT_ULL(48)
46 #define POWER_PACKAGE_LOCK BIT_ULL(63)
47 #define POWER_PP_LOCK BIT(31)
48
49 #define TIME_WINDOW1_MASK (0x7FULL<<17)
50 #define TIME_WINDOW2_MASK (0x7FULL<<49)
51
52 #define POWER_UNIT_OFFSET 0
53 #define POWER_UNIT_MASK 0x0F
54
55 #define ENERGY_UNIT_OFFSET 0x08
56 #define ENERGY_UNIT_MASK 0x1F00
57
58 #define TIME_UNIT_OFFSET 0x10
59 #define TIME_UNIT_MASK 0xF0000
60
61 #define POWER_INFO_MAX_MASK (0x7fffULL<<32)
62 #define POWER_INFO_MIN_MASK (0x7fffULL<<16)
63 #define POWER_INFO_MAX_TIME_WIN_MASK (0x3fULL<<48)
64 #define POWER_INFO_THERMAL_SPEC_MASK 0x7fff
65
66 #define PERF_STATUS_THROTTLE_TIME_MASK 0xffffffff
67 #define PP_POLICY_MASK 0x1F
68
69 /* Non HW constants */
70 #define RAPL_PRIMITIVE_DERIVED BIT(1) /* not from raw data */
71 #define RAPL_PRIMITIVE_DUMMY BIT(2)
72
73 /* scale RAPL units to avoid floating point math inside kernel */
74 #define POWER_UNIT_SCALE (1000000)
75 #define ENERGY_UNIT_SCALE (1000000)
76 #define TIME_UNIT_SCALE (1000000)
77
78 #define TIME_WINDOW_MAX_MSEC 40000
79 #define TIME_WINDOW_MIN_MSEC 250
80
81 enum unit_type {
82 ARBITRARY_UNIT, /* no translation */
83 POWER_UNIT,
84 ENERGY_UNIT,
85 TIME_UNIT,
86 };
87
88 enum rapl_domain_type {
89 RAPL_DOMAIN_PACKAGE, /* entire package/socket */
90 RAPL_DOMAIN_PP0, /* core power plane */
91 RAPL_DOMAIN_PP1, /* graphics uncore */
92 RAPL_DOMAIN_DRAM,/* DRAM control_type */
93 RAPL_DOMAIN_MAX,
94 };
95
96 enum rapl_domain_msr_id {
97 RAPL_DOMAIN_MSR_LIMIT,
98 RAPL_DOMAIN_MSR_STATUS,
99 RAPL_DOMAIN_MSR_PERF,
100 RAPL_DOMAIN_MSR_POLICY,
101 RAPL_DOMAIN_MSR_INFO,
102 RAPL_DOMAIN_MSR_MAX,
103 };
104
105 /* per domain data, some are optional */
106 enum rapl_primitives {
107 ENERGY_COUNTER,
108 POWER_LIMIT1,
109 POWER_LIMIT2,
110 FW_LOCK,
111
112 PL1_ENABLE, /* power limit 1, aka long term */
113 PL1_CLAMP, /* allow frequency to go below OS request */
114 PL2_ENABLE, /* power limit 2, aka short term, instantaneous */
115 PL2_CLAMP,
116
117 TIME_WINDOW1, /* long term */
118 TIME_WINDOW2, /* short term */
119 THERMAL_SPEC_POWER,
120 MAX_POWER,
121
122 MIN_POWER,
123 MAX_TIME_WINDOW,
124 THROTTLED_TIME,
125 PRIORITY_LEVEL,
126
127 /* below are not raw primitive data */
128 AVERAGE_POWER,
129 NR_RAPL_PRIMITIVES,
130 };
131
132 #define NR_RAW_PRIMITIVES (NR_RAPL_PRIMITIVES - 2)
133
134 /* Can be expanded to include events, etc.*/
135 struct rapl_domain_data {
136 u64 primitives[NR_RAPL_PRIMITIVES];
137 unsigned long timestamp;
138 };
139
140
141 #define DOMAIN_STATE_INACTIVE BIT(0)
142 #define DOMAIN_STATE_POWER_LIMIT_SET BIT(1)
143 #define DOMAIN_STATE_BIOS_LOCKED BIT(2)
144
145 #define NR_POWER_LIMITS (2)
146 struct rapl_power_limit {
147 struct powercap_zone_constraint *constraint;
148 int prim_id; /* primitive ID used to enable */
149 struct rapl_domain *domain;
150 const char *name;
151 };
152
153 static const char pl1_name[] = "long_term";
154 static const char pl2_name[] = "short_term";
155
156 struct rapl_domain {
157 const char *name;
158 enum rapl_domain_type id;
159 int msrs[RAPL_DOMAIN_MSR_MAX];
160 struct powercap_zone power_zone;
161 struct rapl_domain_data rdd;
162 struct rapl_power_limit rpl[NR_POWER_LIMITS];
163 u64 attr_map; /* track capabilities */
164 unsigned int state;
165 int package_id;
166 };
167 #define power_zone_to_rapl_domain(_zone) \
168 container_of(_zone, struct rapl_domain, power_zone)
169
170
171 /* Each physical package contains multiple domains, these are the common
172 * data across RAPL domains within a package.
173 */
174 struct rapl_package {
175 unsigned int id; /* physical package/socket id */
176 unsigned int nr_domains;
177 unsigned long domain_map; /* bit map of active domains */
178 unsigned int power_unit_divisor;
179 unsigned int energy_unit_divisor;
180 unsigned int time_unit_divisor;
181 struct rapl_domain *domains; /* array of domains, sized at runtime */
182 struct powercap_zone *power_zone; /* keep track of parent zone */
183 int nr_cpus; /* active cpus on the package, topology info is lost during
184 * cpu hotplug. so we have to track ourselves.
185 */
186 unsigned long power_limit_irq; /* keep track of package power limit
187 * notify interrupt enable status.
188 */
189 struct list_head plist;
190 };
191 #define PACKAGE_PLN_INT_SAVED BIT(0)
192 #define MAX_PRIM_NAME (32)
193
194 /* per domain data. used to describe individual knobs such that access function
195 * can be consolidated into one instead of many inline functions.
196 */
197 struct rapl_primitive_info {
198 const char *name;
199 u64 mask;
200 int shift;
201 enum rapl_domain_msr_id id;
202 enum unit_type unit;
203 u32 flag;
204 };
205
206 #define PRIMITIVE_INFO_INIT(p, m, s, i, u, f) { \
207 .name = #p, \
208 .mask = m, \
209 .shift = s, \
210 .id = i, \
211 .unit = u, \
212 .flag = f \
213 }
214
215 static void rapl_init_domains(struct rapl_package *rp);
216 static int rapl_read_data_raw(struct rapl_domain *rd,
217 enum rapl_primitives prim,
218 bool xlate, u64 *data);
219 static int rapl_write_data_raw(struct rapl_domain *rd,
220 enum rapl_primitives prim,
221 unsigned long long value);
222 static u64 rapl_unit_xlate(int package, enum unit_type type, u64 value,
223 int to_raw);
224 static void package_power_limit_irq_save(int package_id);
225
226 static LIST_HEAD(rapl_packages); /* guarded by CPU hotplug lock */
227
228 static const char * const rapl_domain_names[] = {
229 "package",
230 "core",
231 "uncore",
232 "dram",
233 };
234
235 static struct powercap_control_type *control_type; /* PowerCap Controller */
236
237 /* caller to ensure CPU hotplug lock is held */
238 static struct rapl_package *find_package_by_id(int id)
239 {
240 struct rapl_package *rp;
241
242 list_for_each_entry(rp, &rapl_packages, plist) {
243 if (rp->id == id)
244 return rp;
245 }
246
247 return NULL;
248 }
249
250 /* caller to ensure CPU hotplug lock is held */
251 static int find_active_cpu_on_package(int package_id)
252 {
253 int i;
254
255 for_each_online_cpu(i) {
256 if (topology_physical_package_id(i) == package_id)
257 return i;
258 }
259 /* all CPUs on this package are offline */
260
261 return -ENODEV;
262 }
263
264 /* caller must hold cpu hotplug lock */
265 static void rapl_cleanup_data(void)
266 {
267 struct rapl_package *p, *tmp;
268
269 list_for_each_entry_safe(p, tmp, &rapl_packages, plist) {
270 kfree(p->domains);
271 list_del(&p->plist);
272 kfree(p);
273 }
274 }
275
276 static int get_energy_counter(struct powercap_zone *power_zone, u64 *energy_raw)
277 {
278 struct rapl_domain *rd;
279 u64 energy_now;
280
281 /* prevent CPU hotplug, make sure the RAPL domain does not go
282 * away while reading the counter.
283 */
284 get_online_cpus();
285 rd = power_zone_to_rapl_domain(power_zone);
286
287 if (!rapl_read_data_raw(rd, ENERGY_COUNTER, true, &energy_now)) {
288 *energy_raw = energy_now;
289 put_online_cpus();
290
291 return 0;
292 }
293 put_online_cpus();
294
295 return -EIO;
296 }
297
298 static int get_max_energy_counter(struct powercap_zone *pcd_dev, u64 *energy)
299 {
300 *energy = rapl_unit_xlate(0, ENERGY_UNIT, ENERGY_STATUS_MASK, 0);
301 return 0;
302 }
303
304 static int release_zone(struct powercap_zone *power_zone)
305 {
306 struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
307 struct rapl_package *rp;
308
309 /* package zone is the last zone of a package, we can free
310 * memory here since all children has been unregistered.
311 */
312 if (rd->id == RAPL_DOMAIN_PACKAGE) {
313 rp = find_package_by_id(rd->package_id);
314 if (!rp) {
315 dev_warn(&power_zone->dev, "no package id %s\n",
316 rd->name);
317 return -ENODEV;
318 }
319 kfree(rd);
320 rp->domains = NULL;
321 }
322
323 return 0;
324
325 }
326
327 static int find_nr_power_limit(struct rapl_domain *rd)
328 {
329 int i;
330
331 for (i = 0; i < NR_POWER_LIMITS; i++) {
332 if (rd->rpl[i].name == NULL)
333 break;
334 }
335
336 return i;
337 }
338
339 static int set_domain_enable(struct powercap_zone *power_zone, bool mode)
340 {
341 struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
342 int nr_powerlimit;
343
344 if (rd->state & DOMAIN_STATE_BIOS_LOCKED)
345 return -EACCES;
346 get_online_cpus();
347 nr_powerlimit = find_nr_power_limit(rd);
348 /* here we activate/deactivate the hardware for power limiting */
349 rapl_write_data_raw(rd, PL1_ENABLE, mode);
350 /* always enable clamp such that p-state can go below OS requested
351 * range. power capping priority over guranteed frequency.
352 */
353 rapl_write_data_raw(rd, PL1_CLAMP, mode);
354 /* some domains have pl2 */
355 if (nr_powerlimit > 1) {
356 rapl_write_data_raw(rd, PL2_ENABLE, mode);
357 rapl_write_data_raw(rd, PL2_CLAMP, mode);
358 }
359 put_online_cpus();
360
361 return 0;
362 }
363
364 static int get_domain_enable(struct powercap_zone *power_zone, bool *mode)
365 {
366 struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
367 u64 val;
368
369 if (rd->state & DOMAIN_STATE_BIOS_LOCKED) {
370 *mode = false;
371 return 0;
372 }
373 get_online_cpus();
374 if (rapl_read_data_raw(rd, PL1_ENABLE, true, &val)) {
375 put_online_cpus();
376 return -EIO;
377 }
378 *mode = val;
379 put_online_cpus();
380
381 return 0;
382 }
383
384 /* per RAPL domain ops, in the order of rapl_domain_type */
385 static struct powercap_zone_ops zone_ops[] = {
386 /* RAPL_DOMAIN_PACKAGE */
387 {
388 .get_energy_uj = get_energy_counter,
389 .get_max_energy_range_uj = get_max_energy_counter,
390 .release = release_zone,
391 .set_enable = set_domain_enable,
392 .get_enable = get_domain_enable,
393 },
394 /* RAPL_DOMAIN_PP0 */
395 {
396 .get_energy_uj = get_energy_counter,
397 .get_max_energy_range_uj = get_max_energy_counter,
398 .release = release_zone,
399 .set_enable = set_domain_enable,
400 .get_enable = get_domain_enable,
401 },
402 /* RAPL_DOMAIN_PP1 */
403 {
404 .get_energy_uj = get_energy_counter,
405 .get_max_energy_range_uj = get_max_energy_counter,
406 .release = release_zone,
407 .set_enable = set_domain_enable,
408 .get_enable = get_domain_enable,
409 },
410 /* RAPL_DOMAIN_DRAM */
411 {
412 .get_energy_uj = get_energy_counter,
413 .get_max_energy_range_uj = get_max_energy_counter,
414 .release = release_zone,
415 .set_enable = set_domain_enable,
416 .get_enable = get_domain_enable,
417 },
418 };
419
420 static int set_power_limit(struct powercap_zone *power_zone, int id,
421 u64 power_limit)
422 {
423 struct rapl_domain *rd;
424 struct rapl_package *rp;
425 int ret = 0;
426
427 get_online_cpus();
428 rd = power_zone_to_rapl_domain(power_zone);
429 rp = find_package_by_id(rd->package_id);
430 if (!rp) {
431 ret = -ENODEV;
432 goto set_exit;
433 }
434
435 if (rd->state & DOMAIN_STATE_BIOS_LOCKED) {
436 dev_warn(&power_zone->dev, "%s locked by BIOS, monitoring only\n",
437 rd->name);
438 ret = -EACCES;
439 goto set_exit;
440 }
441
442 switch (rd->rpl[id].prim_id) {
443 case PL1_ENABLE:
444 rapl_write_data_raw(rd, POWER_LIMIT1, power_limit);
445 break;
446 case PL2_ENABLE:
447 rapl_write_data_raw(rd, POWER_LIMIT2, power_limit);
448 break;
449 default:
450 ret = -EINVAL;
451 }
452 if (!ret)
453 package_power_limit_irq_save(rd->package_id);
454 set_exit:
455 put_online_cpus();
456 return ret;
457 }
458
459 static int get_current_power_limit(struct powercap_zone *power_zone, int id,
460 u64 *data)
461 {
462 struct rapl_domain *rd;
463 u64 val;
464 int prim;
465 int ret = 0;
466
467 get_online_cpus();
468 rd = power_zone_to_rapl_domain(power_zone);
469 switch (rd->rpl[id].prim_id) {
470 case PL1_ENABLE:
471 prim = POWER_LIMIT1;
472 break;
473 case PL2_ENABLE:
474 prim = POWER_LIMIT2;
475 break;
476 default:
477 put_online_cpus();
478 return -EINVAL;
479 }
480 if (rapl_read_data_raw(rd, prim, true, &val))
481 ret = -EIO;
482 else
483 *data = val;
484
485 put_online_cpus();
486
487 return ret;
488 }
489
490 static int set_time_window(struct powercap_zone *power_zone, int id,
491 u64 window)
492 {
493 struct rapl_domain *rd;
494 int ret = 0;
495
496 get_online_cpus();
497 rd = power_zone_to_rapl_domain(power_zone);
498 switch (rd->rpl[id].prim_id) {
499 case PL1_ENABLE:
500 rapl_write_data_raw(rd, TIME_WINDOW1, window);
501 break;
502 case PL2_ENABLE:
503 rapl_write_data_raw(rd, TIME_WINDOW2, window);
504 break;
505 default:
506 ret = -EINVAL;
507 }
508 put_online_cpus();
509 return ret;
510 }
511
512 static int get_time_window(struct powercap_zone *power_zone, int id, u64 *data)
513 {
514 struct rapl_domain *rd;
515 u64 val;
516 int ret = 0;
517
518 get_online_cpus();
519 rd = power_zone_to_rapl_domain(power_zone);
520 switch (rd->rpl[id].prim_id) {
521 case PL1_ENABLE:
522 ret = rapl_read_data_raw(rd, TIME_WINDOW1, true, &val);
523 break;
524 case PL2_ENABLE:
525 ret = rapl_read_data_raw(rd, TIME_WINDOW2, true, &val);
526 break;
527 default:
528 put_online_cpus();
529 return -EINVAL;
530 }
531 if (!ret)
532 *data = val;
533 put_online_cpus();
534
535 return ret;
536 }
537
538 static const char *get_constraint_name(struct powercap_zone *power_zone, int id)
539 {
540 struct rapl_power_limit *rpl;
541 struct rapl_domain *rd;
542
543 rd = power_zone_to_rapl_domain(power_zone);
544 rpl = (struct rapl_power_limit *) &rd->rpl[id];
545
546 return rpl->name;
547 }
548
549
550 static int get_max_power(struct powercap_zone *power_zone, int id,
551 u64 *data)
552 {
553 struct rapl_domain *rd;
554 u64 val;
555 int prim;
556 int ret = 0;
557
558 get_online_cpus();
559 rd = power_zone_to_rapl_domain(power_zone);
560 switch (rd->rpl[id].prim_id) {
561 case PL1_ENABLE:
562 prim = THERMAL_SPEC_POWER;
563 break;
564 case PL2_ENABLE:
565 prim = MAX_POWER;
566 break;
567 default:
568 put_online_cpus();
569 return -EINVAL;
570 }
571 if (rapl_read_data_raw(rd, prim, true, &val))
572 ret = -EIO;
573 else
574 *data = val;
575
576 put_online_cpus();
577
578 return ret;
579 }
580
581 static struct powercap_zone_constraint_ops constraint_ops = {
582 .set_power_limit_uw = set_power_limit,
583 .get_power_limit_uw = get_current_power_limit,
584 .set_time_window_us = set_time_window,
585 .get_time_window_us = get_time_window,
586 .get_max_power_uw = get_max_power,
587 .get_name = get_constraint_name,
588 };
589
590 /* called after domain detection and package level data are set */
591 static void rapl_init_domains(struct rapl_package *rp)
592 {
593 int i;
594 struct rapl_domain *rd = rp->domains;
595
596 for (i = 0; i < RAPL_DOMAIN_MAX; i++) {
597 unsigned int mask = rp->domain_map & (1 << i);
598 switch (mask) {
599 case BIT(RAPL_DOMAIN_PACKAGE):
600 rd->name = rapl_domain_names[RAPL_DOMAIN_PACKAGE];
601 rd->id = RAPL_DOMAIN_PACKAGE;
602 rd->msrs[0] = MSR_PKG_POWER_LIMIT;
603 rd->msrs[1] = MSR_PKG_ENERGY_STATUS;
604 rd->msrs[2] = MSR_PKG_PERF_STATUS;
605 rd->msrs[3] = 0;
606 rd->msrs[4] = MSR_PKG_POWER_INFO;
607 rd->rpl[0].prim_id = PL1_ENABLE;
608 rd->rpl[0].name = pl1_name;
609 rd->rpl[1].prim_id = PL2_ENABLE;
610 rd->rpl[1].name = pl2_name;
611 break;
612 case BIT(RAPL_DOMAIN_PP0):
613 rd->name = rapl_domain_names[RAPL_DOMAIN_PP0];
614 rd->id = RAPL_DOMAIN_PP0;
615 rd->msrs[0] = MSR_PP0_POWER_LIMIT;
616 rd->msrs[1] = MSR_PP0_ENERGY_STATUS;
617 rd->msrs[2] = 0;
618 rd->msrs[3] = MSR_PP0_POLICY;
619 rd->msrs[4] = 0;
620 rd->rpl[0].prim_id = PL1_ENABLE;
621 rd->rpl[0].name = pl1_name;
622 break;
623 case BIT(RAPL_DOMAIN_PP1):
624 rd->name = rapl_domain_names[RAPL_DOMAIN_PP1];
625 rd->id = RAPL_DOMAIN_PP1;
626 rd->msrs[0] = MSR_PP1_POWER_LIMIT;
627 rd->msrs[1] = MSR_PP1_ENERGY_STATUS;
628 rd->msrs[2] = 0;
629 rd->msrs[3] = MSR_PP1_POLICY;
630 rd->msrs[4] = 0;
631 rd->rpl[0].prim_id = PL1_ENABLE;
632 rd->rpl[0].name = pl1_name;
633 break;
634 case BIT(RAPL_DOMAIN_DRAM):
635 rd->name = rapl_domain_names[RAPL_DOMAIN_DRAM];
636 rd->id = RAPL_DOMAIN_DRAM;
637 rd->msrs[0] = MSR_DRAM_POWER_LIMIT;
638 rd->msrs[1] = MSR_DRAM_ENERGY_STATUS;
639 rd->msrs[2] = MSR_DRAM_PERF_STATUS;
640 rd->msrs[3] = 0;
641 rd->msrs[4] = MSR_DRAM_POWER_INFO;
642 rd->rpl[0].prim_id = PL1_ENABLE;
643 rd->rpl[0].name = pl1_name;
644 break;
645 }
646 if (mask) {
647 rd->package_id = rp->id;
648 rd++;
649 }
650 }
651 }
652
653 static u64 rapl_unit_xlate(int package, enum unit_type type, u64 value,
654 int to_raw)
655 {
656 u64 divisor = 1;
657 int scale = 1; /* scale to user friendly data without floating point */
658 u64 f, y; /* fraction and exp. used for time unit */
659 struct rapl_package *rp;
660
661 rp = find_package_by_id(package);
662 if (!rp)
663 return value;
664
665 switch (type) {
666 case POWER_UNIT:
667 divisor = rp->power_unit_divisor;
668 scale = POWER_UNIT_SCALE;
669 break;
670 case ENERGY_UNIT:
671 scale = ENERGY_UNIT_SCALE;
672 divisor = rp->energy_unit_divisor;
673 break;
674 case TIME_UNIT:
675 divisor = rp->time_unit_divisor;
676 scale = TIME_UNIT_SCALE;
677 /* special processing based on 2^Y*(1+F)/4 = val/divisor, refer
678 * to Intel Software Developer's manual Vol. 3a, CH 14.7.4.
679 */
680 if (!to_raw) {
681 f = (value & 0x60) >> 5;
682 y = value & 0x1f;
683 value = (1 << y) * (4 + f) * scale / 4;
684 return div64_u64(value, divisor);
685 } else {
686 do_div(value, scale);
687 value *= divisor;
688 y = ilog2(value);
689 f = div64_u64(4 * (value - (1 << y)), 1 << y);
690 value = (y & 0x1f) | ((f & 0x3) << 5);
691 return value;
692 }
693 break;
694 case ARBITRARY_UNIT:
695 default:
696 return value;
697 };
698
699 if (to_raw)
700 return div64_u64(value * divisor, scale);
701 else
702 return div64_u64(value * scale, divisor);
703 }
704
705 /* in the order of enum rapl_primitives */
706 static struct rapl_primitive_info rpi[] = {
707 /* name, mask, shift, msr index, unit divisor */
708 PRIMITIVE_INFO_INIT(ENERGY_COUNTER, ENERGY_STATUS_MASK, 0,
709 RAPL_DOMAIN_MSR_STATUS, ENERGY_UNIT, 0),
710 PRIMITIVE_INFO_INIT(POWER_LIMIT1, POWER_LIMIT1_MASK, 0,
711 RAPL_DOMAIN_MSR_LIMIT, POWER_UNIT, 0),
712 PRIMITIVE_INFO_INIT(POWER_LIMIT2, POWER_LIMIT2_MASK, 32,
713 RAPL_DOMAIN_MSR_LIMIT, POWER_UNIT, 0),
714 PRIMITIVE_INFO_INIT(FW_LOCK, POWER_PP_LOCK, 31,
715 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
716 PRIMITIVE_INFO_INIT(PL1_ENABLE, POWER_LIMIT1_ENABLE, 15,
717 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
718 PRIMITIVE_INFO_INIT(PL1_CLAMP, POWER_LIMIT1_CLAMP, 16,
719 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
720 PRIMITIVE_INFO_INIT(PL2_ENABLE, POWER_LIMIT2_ENABLE, 47,
721 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
722 PRIMITIVE_INFO_INIT(PL2_CLAMP, POWER_LIMIT2_CLAMP, 48,
723 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
724 PRIMITIVE_INFO_INIT(TIME_WINDOW1, TIME_WINDOW1_MASK, 17,
725 RAPL_DOMAIN_MSR_LIMIT, TIME_UNIT, 0),
726 PRIMITIVE_INFO_INIT(TIME_WINDOW2, TIME_WINDOW2_MASK, 49,
727 RAPL_DOMAIN_MSR_LIMIT, TIME_UNIT, 0),
728 PRIMITIVE_INFO_INIT(THERMAL_SPEC_POWER, POWER_INFO_THERMAL_SPEC_MASK,
729 0, RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
730 PRIMITIVE_INFO_INIT(MAX_POWER, POWER_INFO_MAX_MASK, 32,
731 RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
732 PRIMITIVE_INFO_INIT(MIN_POWER, POWER_INFO_MIN_MASK, 16,
733 RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
734 PRIMITIVE_INFO_INIT(MAX_TIME_WINDOW, POWER_INFO_MAX_TIME_WIN_MASK, 48,
735 RAPL_DOMAIN_MSR_INFO, TIME_UNIT, 0),
736 PRIMITIVE_INFO_INIT(THROTTLED_TIME, PERF_STATUS_THROTTLE_TIME_MASK, 0,
737 RAPL_DOMAIN_MSR_PERF, TIME_UNIT, 0),
738 PRIMITIVE_INFO_INIT(PRIORITY_LEVEL, PP_POLICY_MASK, 0,
739 RAPL_DOMAIN_MSR_POLICY, ARBITRARY_UNIT, 0),
740 /* non-hardware */
741 PRIMITIVE_INFO_INIT(AVERAGE_POWER, 0, 0, 0, POWER_UNIT,
742 RAPL_PRIMITIVE_DERIVED),
743 {NULL, 0, 0, 0},
744 };
745
746 /* Read primitive data based on its related struct rapl_primitive_info.
747 * if xlate flag is set, return translated data based on data units, i.e.
748 * time, energy, and power.
749 * RAPL MSRs are non-architectual and are laid out not consistently across
750 * domains. Here we use primitive info to allow writing consolidated access
751 * functions.
752 * For a given primitive, it is processed by MSR mask and shift. Unit conversion
753 * is pre-assigned based on RAPL unit MSRs read at init time.
754 * 63-------------------------- 31--------------------------- 0
755 * | xxxxx (mask) |
756 * | |<- shift ----------------|
757 * 63-------------------------- 31--------------------------- 0
758 */
759 static int rapl_read_data_raw(struct rapl_domain *rd,
760 enum rapl_primitives prim,
761 bool xlate, u64 *data)
762 {
763 u64 value, final;
764 u32 msr;
765 struct rapl_primitive_info *rp = &rpi[prim];
766 int cpu;
767
768 if (!rp->name || rp->flag & RAPL_PRIMITIVE_DUMMY)
769 return -EINVAL;
770
771 msr = rd->msrs[rp->id];
772 if (!msr)
773 return -EINVAL;
774 /* use physical package id to look up active cpus */
775 cpu = find_active_cpu_on_package(rd->package_id);
776 if (cpu < 0)
777 return cpu;
778
779 /* special-case package domain, which uses a different bit*/
780 if (prim == FW_LOCK && rd->id == RAPL_DOMAIN_PACKAGE) {
781 rp->mask = POWER_PACKAGE_LOCK;
782 rp->shift = 63;
783 }
784 /* non-hardware data are collected by the polling thread */
785 if (rp->flag & RAPL_PRIMITIVE_DERIVED) {
786 *data = rd->rdd.primitives[prim];
787 return 0;
788 }
789
790 if (rdmsrl_safe_on_cpu(cpu, msr, &value)) {
791 pr_debug("failed to read msr 0x%x on cpu %d\n", msr, cpu);
792 return -EIO;
793 }
794
795 final = value & rp->mask;
796 final = final >> rp->shift;
797 if (xlate)
798 *data = rapl_unit_xlate(rd->package_id, rp->unit, final, 0);
799 else
800 *data = final;
801
802 return 0;
803 }
804
805 /* Similar use of primitive info in the read counterpart */
806 static int rapl_write_data_raw(struct rapl_domain *rd,
807 enum rapl_primitives prim,
808 unsigned long long value)
809 {
810 u64 msr_val;
811 u32 msr;
812 struct rapl_primitive_info *rp = &rpi[prim];
813 int cpu;
814
815 cpu = find_active_cpu_on_package(rd->package_id);
816 if (cpu < 0)
817 return cpu;
818 msr = rd->msrs[rp->id];
819 if (rdmsrl_safe_on_cpu(cpu, msr, &msr_val)) {
820 dev_dbg(&rd->power_zone.dev,
821 "failed to read msr 0x%x on cpu %d\n", msr, cpu);
822 return -EIO;
823 }
824 value = rapl_unit_xlate(rd->package_id, rp->unit, value, 1);
825 msr_val &= ~rp->mask;
826 msr_val |= value << rp->shift;
827 if (wrmsrl_safe_on_cpu(cpu, msr, msr_val)) {
828 dev_dbg(&rd->power_zone.dev,
829 "failed to write msr 0x%x on cpu %d\n", msr, cpu);
830 return -EIO;
831 }
832
833 return 0;
834 }
835
836 static const struct x86_cpu_id energy_unit_quirk_ids[] = {
837 { X86_VENDOR_INTEL, 6, 0x37},/* VLV */
838 {}
839 };
840
841 static int rapl_check_unit(struct rapl_package *rp, int cpu)
842 {
843 u64 msr_val;
844 u32 value;
845
846 if (rdmsrl_safe_on_cpu(cpu, MSR_RAPL_POWER_UNIT, &msr_val)) {
847 pr_err("Failed to read power unit MSR 0x%x on CPU %d, exit.\n",
848 MSR_RAPL_POWER_UNIT, cpu);
849 return -ENODEV;
850 }
851
852 /* Raw RAPL data stored in MSRs are in certain scales. We need to
853 * convert them into standard units based on the divisors reported in
854 * the RAPL unit MSRs.
855 * i.e.
856 * energy unit: 1/enery_unit_divisor Joules
857 * power unit: 1/power_unit_divisor Watts
858 * time unit: 1/time_unit_divisor Seconds
859 */
860 value = (msr_val & ENERGY_UNIT_MASK) >> ENERGY_UNIT_OFFSET;
861 /* some CPUs have different way to calculate energy unit */
862 if (x86_match_cpu(energy_unit_quirk_ids))
863 rp->energy_unit_divisor = 1000000 / (1 << value);
864 else
865 rp->energy_unit_divisor = 1 << value;
866
867 value = (msr_val & POWER_UNIT_MASK) >> POWER_UNIT_OFFSET;
868 rp->power_unit_divisor = 1 << value;
869
870 value = (msr_val & TIME_UNIT_MASK) >> TIME_UNIT_OFFSET;
871 rp->time_unit_divisor = 1 << value;
872
873 pr_debug("Physical package %d units: energy=%d, time=%d, power=%d\n",
874 rp->id,
875 rp->energy_unit_divisor,
876 rp->time_unit_divisor,
877 rp->power_unit_divisor);
878
879 return 0;
880 }
881
882 /* REVISIT:
883 * When package power limit is set artificially low by RAPL, LVT
884 * thermal interrupt for package power limit should be ignored
885 * since we are not really exceeding the real limit. The intention
886 * is to avoid excessive interrupts while we are trying to save power.
887 * A useful feature might be routing the package_power_limit interrupt
888 * to userspace via eventfd. once we have a usecase, this is simple
889 * to do by adding an atomic notifier.
890 */
891
892 static void package_power_limit_irq_save(int package_id)
893 {
894 u32 l, h = 0;
895 int cpu;
896 struct rapl_package *rp;
897
898 rp = find_package_by_id(package_id);
899 if (!rp)
900 return;
901
902 if (!boot_cpu_has(X86_FEATURE_PTS) || !boot_cpu_has(X86_FEATURE_PLN))
903 return;
904
905 cpu = find_active_cpu_on_package(package_id);
906 if (cpu < 0)
907 return;
908 /* save the state of PLN irq mask bit before disabling it */
909 rdmsr_safe_on_cpu(cpu, MSR_IA32_PACKAGE_THERM_INTERRUPT, &l, &h);
910 if (!(rp->power_limit_irq & PACKAGE_PLN_INT_SAVED)) {
911 rp->power_limit_irq = l & PACKAGE_THERM_INT_PLN_ENABLE;
912 rp->power_limit_irq |= PACKAGE_PLN_INT_SAVED;
913 }
914 l &= ~PACKAGE_THERM_INT_PLN_ENABLE;
915 wrmsr_on_cpu(cpu, MSR_IA32_PACKAGE_THERM_INTERRUPT, l, h);
916 }
917
918 /* restore per package power limit interrupt enable state */
919 static void package_power_limit_irq_restore(int package_id)
920 {
921 u32 l, h;
922 int cpu;
923 struct rapl_package *rp;
924
925 rp = find_package_by_id(package_id);
926 if (!rp)
927 return;
928
929 if (!boot_cpu_has(X86_FEATURE_PTS) || !boot_cpu_has(X86_FEATURE_PLN))
930 return;
931
932 cpu = find_active_cpu_on_package(package_id);
933 if (cpu < 0)
934 return;
935
936 /* irq enable state not saved, nothing to restore */
937 if (!(rp->power_limit_irq & PACKAGE_PLN_INT_SAVED))
938 return;
939 rdmsr_safe_on_cpu(cpu, MSR_IA32_PACKAGE_THERM_INTERRUPT, &l, &h);
940
941 if (rp->power_limit_irq & PACKAGE_THERM_INT_PLN_ENABLE)
942 l |= PACKAGE_THERM_INT_PLN_ENABLE;
943 else
944 l &= ~PACKAGE_THERM_INT_PLN_ENABLE;
945
946 wrmsr_on_cpu(cpu, MSR_IA32_PACKAGE_THERM_INTERRUPT, l, h);
947 }
948
949 static const struct x86_cpu_id rapl_ids[] = {
950 { X86_VENDOR_INTEL, 6, 0x2a},/* SNB */
951 { X86_VENDOR_INTEL, 6, 0x2d},/* SNB EP */
952 { X86_VENDOR_INTEL, 6, 0x37},/* VLV */
953 { X86_VENDOR_INTEL, 6, 0x3a},/* IVB */
954 { X86_VENDOR_INTEL, 6, 0x45},/* HSW */
955 /* TODO: Add more CPU IDs after testing */
956 {}
957 };
958 MODULE_DEVICE_TABLE(x86cpu, rapl_ids);
959
960 /* read once for all raw primitive data for all packages, domains */
961 static void rapl_update_domain_data(void)
962 {
963 int dmn, prim;
964 u64 val;
965 struct rapl_package *rp;
966
967 list_for_each_entry(rp, &rapl_packages, plist) {
968 for (dmn = 0; dmn < rp->nr_domains; dmn++) {
969 pr_debug("update package %d domain %s data\n", rp->id,
970 rp->domains[dmn].name);
971 /* exclude non-raw primitives */
972 for (prim = 0; prim < NR_RAW_PRIMITIVES; prim++)
973 if (!rapl_read_data_raw(&rp->domains[dmn], prim,
974 rpi[prim].unit,
975 &val))
976 rp->domains[dmn].rdd.primitives[prim] =
977 val;
978 }
979 }
980
981 }
982
983 static int rapl_unregister_powercap(void)
984 {
985 struct rapl_package *rp;
986 struct rapl_domain *rd, *rd_package = NULL;
987
988 /* unregister all active rapl packages from the powercap layer,
989 * hotplug lock held
990 */
991 list_for_each_entry(rp, &rapl_packages, plist) {
992 package_power_limit_irq_restore(rp->id);
993
994 for (rd = rp->domains; rd < rp->domains + rp->nr_domains;
995 rd++) {
996 pr_debug("remove package, undo power limit on %d: %s\n",
997 rp->id, rd->name);
998 rapl_write_data_raw(rd, PL1_ENABLE, 0);
999 rapl_write_data_raw(rd, PL2_ENABLE, 0);
1000 rapl_write_data_raw(rd, PL1_CLAMP, 0);
1001 rapl_write_data_raw(rd, PL2_CLAMP, 0);
1002 if (rd->id == RAPL_DOMAIN_PACKAGE) {
1003 rd_package = rd;
1004 continue;
1005 }
1006 powercap_unregister_zone(control_type, &rd->power_zone);
1007 }
1008 /* do the package zone last */
1009 if (rd_package)
1010 powercap_unregister_zone(control_type,
1011 &rd_package->power_zone);
1012 }
1013 powercap_unregister_control_type(control_type);
1014
1015 return 0;
1016 }
1017
1018 static int rapl_package_register_powercap(struct rapl_package *rp)
1019 {
1020 struct rapl_domain *rd;
1021 int ret = 0;
1022 char dev_name[17]; /* max domain name = 7 + 1 + 8 for int + 1 for null*/
1023 struct powercap_zone *power_zone = NULL;
1024 int nr_pl;
1025
1026 /* first we register package domain as the parent zone*/
1027 for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1028 if (rd->id == RAPL_DOMAIN_PACKAGE) {
1029 nr_pl = find_nr_power_limit(rd);
1030 pr_debug("register socket %d package domain %s\n",
1031 rp->id, rd->name);
1032 memset(dev_name, 0, sizeof(dev_name));
1033 snprintf(dev_name, sizeof(dev_name), "%s-%d",
1034 rd->name, rp->id);
1035 power_zone = powercap_register_zone(&rd->power_zone,
1036 control_type,
1037 dev_name, NULL,
1038 &zone_ops[rd->id],
1039 nr_pl,
1040 &constraint_ops);
1041 if (IS_ERR(power_zone)) {
1042 pr_debug("failed to register package, %d\n",
1043 rp->id);
1044 ret = PTR_ERR(power_zone);
1045 goto exit_package;
1046 }
1047 /* track parent zone in per package/socket data */
1048 rp->power_zone = power_zone;
1049 /* done, only one package domain per socket */
1050 break;
1051 }
1052 }
1053 if (!power_zone) {
1054 pr_err("no package domain found, unknown topology!\n");
1055 ret = -ENODEV;
1056 goto exit_package;
1057 }
1058 /* now register domains as children of the socket/package*/
1059 for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1060 if (rd->id == RAPL_DOMAIN_PACKAGE)
1061 continue;
1062 /* number of power limits per domain varies */
1063 nr_pl = find_nr_power_limit(rd);
1064 power_zone = powercap_register_zone(&rd->power_zone,
1065 control_type, rd->name,
1066 rp->power_zone,
1067 &zone_ops[rd->id], nr_pl,
1068 &constraint_ops);
1069
1070 if (IS_ERR(power_zone)) {
1071 pr_debug("failed to register power_zone, %d:%s:%s\n",
1072 rp->id, rd->name, dev_name);
1073 ret = PTR_ERR(power_zone);
1074 goto err_cleanup;
1075 }
1076 }
1077
1078 exit_package:
1079 return ret;
1080 err_cleanup:
1081 /* clean up previously initialized domains within the package if we
1082 * failed after the first domain setup.
1083 */
1084 while (--rd >= rp->domains) {
1085 pr_debug("unregister package %d domain %s\n", rp->id, rd->name);
1086 powercap_unregister_zone(control_type, &rd->power_zone);
1087 }
1088
1089 return ret;
1090 }
1091
1092 static int rapl_register_powercap(void)
1093 {
1094 struct rapl_domain *rd;
1095 struct rapl_package *rp;
1096 int ret = 0;
1097
1098 control_type = powercap_register_control_type(NULL, "intel-rapl", NULL);
1099 if (IS_ERR(control_type)) {
1100 pr_debug("failed to register powercap control_type.\n");
1101 return PTR_ERR(control_type);
1102 }
1103 /* read the initial data */
1104 rapl_update_domain_data();
1105 list_for_each_entry(rp, &rapl_packages, plist)
1106 if (rapl_package_register_powercap(rp))
1107 goto err_cleanup_package;
1108 return ret;
1109
1110 err_cleanup_package:
1111 /* clean up previously initialized packages */
1112 list_for_each_entry_continue_reverse(rp, &rapl_packages, plist) {
1113 for (rd = rp->domains; rd < rp->domains + rp->nr_domains;
1114 rd++) {
1115 pr_debug("unregister zone/package %d, %s domain\n",
1116 rp->id, rd->name);
1117 powercap_unregister_zone(control_type, &rd->power_zone);
1118 }
1119 }
1120
1121 return ret;
1122 }
1123
1124 static int rapl_check_domain(int cpu, int domain)
1125 {
1126 unsigned msr;
1127 u64 val1, val2 = 0;
1128 int retry = 0;
1129
1130 switch (domain) {
1131 case RAPL_DOMAIN_PACKAGE:
1132 msr = MSR_PKG_ENERGY_STATUS;
1133 break;
1134 case RAPL_DOMAIN_PP0:
1135 msr = MSR_PP0_ENERGY_STATUS;
1136 break;
1137 case RAPL_DOMAIN_PP1:
1138 msr = MSR_PP1_ENERGY_STATUS;
1139 break;
1140 case RAPL_DOMAIN_DRAM:
1141 msr = MSR_DRAM_ENERGY_STATUS;
1142 break;
1143 default:
1144 pr_err("invalid domain id %d\n", domain);
1145 return -EINVAL;
1146 }
1147 if (rdmsrl_safe_on_cpu(cpu, msr, &val1))
1148 return -ENODEV;
1149
1150 /* energy counters roll slowly on some domains */
1151 while (++retry < 10) {
1152 usleep_range(10000, 15000);
1153 rdmsrl_safe_on_cpu(cpu, msr, &val2);
1154 if ((val1 & ENERGY_STATUS_MASK) != (val2 & ENERGY_STATUS_MASK))
1155 return 0;
1156 }
1157 /* if energy counter does not change, report as bad domain */
1158 pr_info("domain %s energy ctr %llu:%llu not working, skip\n",
1159 rapl_domain_names[domain], val1, val2);
1160
1161 return -ENODEV;
1162 }
1163
1164 /* Detect active and valid domains for the given CPU, caller must
1165 * ensure the CPU belongs to the targeted package and CPU hotlug is disabled.
1166 */
1167 static int rapl_detect_domains(struct rapl_package *rp, int cpu)
1168 {
1169 int i;
1170 int ret = 0;
1171 struct rapl_domain *rd;
1172 u64 locked;
1173
1174 for (i = 0; i < RAPL_DOMAIN_MAX; i++) {
1175 /* use physical package id to read counters */
1176 if (!rapl_check_domain(cpu, i))
1177 rp->domain_map |= 1 << i;
1178 }
1179 rp->nr_domains = bitmap_weight(&rp->domain_map, RAPL_DOMAIN_MAX);
1180 if (!rp->nr_domains) {
1181 pr_err("no valid rapl domains found in package %d\n", rp->id);
1182 ret = -ENODEV;
1183 goto done;
1184 }
1185 pr_debug("found %d domains on package %d\n", rp->nr_domains, rp->id);
1186
1187 rp->domains = kcalloc(rp->nr_domains + 1, sizeof(struct rapl_domain),
1188 GFP_KERNEL);
1189 if (!rp->domains) {
1190 ret = -ENOMEM;
1191 goto done;
1192 }
1193 rapl_init_domains(rp);
1194
1195 for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1196 /* check if the domain is locked by BIOS */
1197 if (rapl_read_data_raw(rd, FW_LOCK, false, &locked)) {
1198 pr_info("RAPL package %d domain %s locked by BIOS\n",
1199 rp->id, rd->name);
1200 rd->state |= DOMAIN_STATE_BIOS_LOCKED;
1201 }
1202 }
1203
1204
1205 done:
1206 return ret;
1207 }
1208
1209 static bool is_package_new(int package)
1210 {
1211 struct rapl_package *rp;
1212
1213 /* caller prevents cpu hotplug, there will be no new packages added
1214 * or deleted while traversing the package list, no need for locking.
1215 */
1216 list_for_each_entry(rp, &rapl_packages, plist)
1217 if (package == rp->id)
1218 return false;
1219
1220 return true;
1221 }
1222
1223 /* RAPL interface can be made of a two-level hierarchy: package level and domain
1224 * level. We first detect the number of packages then domains of each package.
1225 * We have to consider the possiblity of CPU online/offline due to hotplug and
1226 * other scenarios.
1227 */
1228 static int rapl_detect_topology(void)
1229 {
1230 int i;
1231 int phy_package_id;
1232 struct rapl_package *new_package, *rp;
1233
1234 for_each_online_cpu(i) {
1235 phy_package_id = topology_physical_package_id(i);
1236 if (is_package_new(phy_package_id)) {
1237 new_package = kzalloc(sizeof(*rp), GFP_KERNEL);
1238 if (!new_package) {
1239 rapl_cleanup_data();
1240 return -ENOMEM;
1241 }
1242 /* add the new package to the list */
1243 new_package->id = phy_package_id;
1244 new_package->nr_cpus = 1;
1245
1246 /* check if the package contains valid domains */
1247 if (rapl_detect_domains(new_package, i) ||
1248 rapl_check_unit(new_package, i)) {
1249 kfree(new_package->domains);
1250 kfree(new_package);
1251 /* free up the packages already initialized */
1252 rapl_cleanup_data();
1253 return -ENODEV;
1254 }
1255 INIT_LIST_HEAD(&new_package->plist);
1256 list_add(&new_package->plist, &rapl_packages);
1257 } else {
1258 rp = find_package_by_id(phy_package_id);
1259 if (rp)
1260 ++rp->nr_cpus;
1261 }
1262 }
1263
1264 return 0;
1265 }
1266
1267 /* called from CPU hotplug notifier, hotplug lock held */
1268 static void rapl_remove_package(struct rapl_package *rp)
1269 {
1270 struct rapl_domain *rd, *rd_package = NULL;
1271
1272 for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1273 if (rd->id == RAPL_DOMAIN_PACKAGE) {
1274 rd_package = rd;
1275 continue;
1276 }
1277 pr_debug("remove package %d, %s domain\n", rp->id, rd->name);
1278 powercap_unregister_zone(control_type, &rd->power_zone);
1279 }
1280 /* do parent zone last */
1281 powercap_unregister_zone(control_type, &rd_package->power_zone);
1282 list_del(&rp->plist);
1283 kfree(rp);
1284 }
1285
1286 /* called from CPU hotplug notifier, hotplug lock held */
1287 static int rapl_add_package(int cpu)
1288 {
1289 int ret = 0;
1290 int phy_package_id;
1291 struct rapl_package *rp;
1292
1293 phy_package_id = topology_physical_package_id(cpu);
1294 rp = kzalloc(sizeof(struct rapl_package), GFP_KERNEL);
1295 if (!rp)
1296 return -ENOMEM;
1297
1298 /* add the new package to the list */
1299 rp->id = phy_package_id;
1300 rp->nr_cpus = 1;
1301 /* check if the package contains valid domains */
1302 if (rapl_detect_domains(rp, cpu) ||
1303 rapl_check_unit(rp, cpu)) {
1304 ret = -ENODEV;
1305 goto err_free_package;
1306 }
1307 if (!rapl_package_register_powercap(rp)) {
1308 INIT_LIST_HEAD(&rp->plist);
1309 list_add(&rp->plist, &rapl_packages);
1310 return ret;
1311 }
1312
1313 err_free_package:
1314 kfree(rp->domains);
1315 kfree(rp);
1316
1317 return ret;
1318 }
1319
1320 /* Handles CPU hotplug on multi-socket systems.
1321 * If a CPU goes online as the first CPU of the physical package
1322 * we add the RAPL package to the system. Similarly, when the last
1323 * CPU of the package is removed, we remove the RAPL package and its
1324 * associated domains. Cooling devices are handled accordingly at
1325 * per-domain level.
1326 */
1327 static int rapl_cpu_callback(struct notifier_block *nfb,
1328 unsigned long action, void *hcpu)
1329 {
1330 unsigned long cpu = (unsigned long)hcpu;
1331 int phy_package_id;
1332 struct rapl_package *rp;
1333
1334 phy_package_id = topology_physical_package_id(cpu);
1335 switch (action) {
1336 case CPU_ONLINE:
1337 case CPU_ONLINE_FROZEN:
1338 case CPU_DOWN_FAILED:
1339 case CPU_DOWN_FAILED_FROZEN:
1340 rp = find_package_by_id(phy_package_id);
1341 if (rp)
1342 ++rp->nr_cpus;
1343 else
1344 rapl_add_package(cpu);
1345 break;
1346 case CPU_DOWN_PREPARE:
1347 case CPU_DOWN_PREPARE_FROZEN:
1348 rp = find_package_by_id(phy_package_id);
1349 if (!rp)
1350 break;
1351 if (--rp->nr_cpus == 0)
1352 rapl_remove_package(rp);
1353 }
1354
1355 return NOTIFY_OK;
1356 }
1357
1358 static struct notifier_block rapl_cpu_notifier = {
1359 .notifier_call = rapl_cpu_callback,
1360 };
1361
1362 static int __init rapl_init(void)
1363 {
1364 int ret = 0;
1365
1366 if (!x86_match_cpu(rapl_ids)) {
1367 pr_err("driver does not support CPU family %d model %d\n",
1368 boot_cpu_data.x86, boot_cpu_data.x86_model);
1369
1370 return -ENODEV;
1371 }
1372 /* prevent CPU hotplug during detection */
1373 get_online_cpus();
1374 ret = rapl_detect_topology();
1375 if (ret)
1376 goto done;
1377
1378 if (rapl_register_powercap()) {
1379 rapl_cleanup_data();
1380 ret = -ENODEV;
1381 goto done;
1382 }
1383 register_hotcpu_notifier(&rapl_cpu_notifier);
1384 done:
1385 put_online_cpus();
1386
1387 return ret;
1388 }
1389
1390 static void __exit rapl_exit(void)
1391 {
1392 get_online_cpus();
1393 unregister_hotcpu_notifier(&rapl_cpu_notifier);
1394 rapl_unregister_powercap();
1395 rapl_cleanup_data();
1396 put_online_cpus();
1397 }
1398
1399 module_init(rapl_init);
1400 module_exit(rapl_exit);
1401
1402 MODULE_DESCRIPTION("Driver for Intel RAPL (Running Average Power Limit)");
1403 MODULE_AUTHOR("Jacob Pan <jacob.jun.pan@intel.com>");
1404 MODULE_LICENSE("GPL v2");
Linux with added FPC-III support