drivers/powercap/intel_rapl.c

   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 #include <asm/iosf_mbi.h>
  33
  34 #include <asm/processor.h>
  35 #include <asm/cpu_device_id.h>
  36 #include <asm/intel-family.h>
  37
  38 /* Local defines */
  39 #define MSR_PLATFORM_POWER_LIMIT        0x0000065C
  40
  41 /* bitmasks for RAPL MSRs, used by primitive access functions */
  42 #define ENERGY_STATUS_MASK      0xffffffff
  43
  44 #define POWER_LIMIT1_MASK       0x7FFF
  45 #define POWER_LIMIT1_ENABLE     BIT(15)
  46 #define POWER_LIMIT1_CLAMP      BIT(16)
  47
  48 #define POWER_LIMIT2_MASK       (0x7FFFULL<<32)
  49 #define POWER_LIMIT2_ENABLE     BIT_ULL(47)
  50 #define POWER_LIMIT2_CLAMP      BIT_ULL(48)
  51 #define POWER_PACKAGE_LOCK      BIT_ULL(63)
  52 #define POWER_PP_LOCK           BIT(31)
  53
  54 #define TIME_WINDOW1_MASK       (0x7FULL<<17)
  55 #define TIME_WINDOW2_MASK       (0x7FULL<<49)
  56
  57 #define POWER_UNIT_OFFSET       0
  58 #define POWER_UNIT_MASK         0x0F
  59
  60 #define ENERGY_UNIT_OFFSET      0x08
  61 #define ENERGY_UNIT_MASK        0x1F00
  62
  63 #define TIME_UNIT_OFFSET        0x10
  64 #define TIME_UNIT_MASK          0xF0000
  65
  66 #define POWER_INFO_MAX_MASK     (0x7fffULL<<32)
  67 #define POWER_INFO_MIN_MASK     (0x7fffULL<<16)
  68 #define POWER_INFO_MAX_TIME_WIN_MASK     (0x3fULL<<48)
  69 #define POWER_INFO_THERMAL_SPEC_MASK     0x7fff
  70
  71 #define PERF_STATUS_THROTTLE_TIME_MASK 0xffffffff
  72 #define PP_POLICY_MASK         0x1F
  73
  74 /* Non HW constants */
  75 #define RAPL_PRIMITIVE_DERIVED       BIT(1) /* not from raw data */
  76 #define RAPL_PRIMITIVE_DUMMY         BIT(2)
  77
  78 #define TIME_WINDOW_MAX_MSEC 40000
  79 #define TIME_WINDOW_MIN_MSEC 250
  80 #define ENERGY_UNIT_SCALE    1000 /* scale from driver unit to powercap unit */
  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_PLATFORM, /* PSys control_type */
  94         RAPL_DOMAIN_MAX,
  95 };
  96
  97 enum rapl_domain_msr_id {
  98         RAPL_DOMAIN_MSR_LIMIT,
  99         RAPL_DOMAIN_MSR_STATUS,
 100         RAPL_DOMAIN_MSR_PERF,
 101         RAPL_DOMAIN_MSR_POLICY,
 102         RAPL_DOMAIN_MSR_INFO,
 103         RAPL_DOMAIN_MSR_MAX,
 104 };
 105
 106 /* per domain data, some are optional */
 107 enum rapl_primitives {
 108         ENERGY_COUNTER,
 109         POWER_LIMIT1,
 110         POWER_LIMIT2,
 111         FW_LOCK,
 112
 113         PL1_ENABLE,  /* power limit 1, aka long term */
 114         PL1_CLAMP,   /* allow frequency to go below OS request */
 115         PL2_ENABLE,  /* power limit 2, aka short term, instantaneous */
 116         PL2_CLAMP,
 117
 118         TIME_WINDOW1, /* long term */
 119         TIME_WINDOW2, /* short term */
 120         THERMAL_SPEC_POWER,
 121         MAX_POWER,
 122
 123         MIN_POWER,
 124         MAX_TIME_WINDOW,
 125         THROTTLED_TIME,
 126         PRIORITY_LEVEL,
 127
 128         /* below are not raw primitive data */
 129         AVERAGE_POWER,
 130         NR_RAPL_PRIMITIVES,
 131 };
 132
 133 #define NR_RAW_PRIMITIVES (NR_RAPL_PRIMITIVES - 2)
 134
 135 /* Can be expanded to include events, etc.*/
 136 struct rapl_domain_data {
 137         u64 primitives[NR_RAPL_PRIMITIVES];
 138         unsigned long timestamp;
 139 };
 140
 141 struct msrl_action {
 142         u32 msr_no;
 143         u64 clear_mask;
 144         u64 set_mask;
 145         int err;
 146 };
 147
 148 #define DOMAIN_STATE_INACTIVE           BIT(0)
 149 #define DOMAIN_STATE_POWER_LIMIT_SET    BIT(1)
 150 #define DOMAIN_STATE_BIOS_LOCKED        BIT(2)
 151
 152 #define NR_POWER_LIMITS (2)
 153 struct rapl_power_limit {
 154         struct powercap_zone_constraint *constraint;
 155         int prim_id; /* primitive ID used to enable */
 156         struct rapl_domain *domain;
 157         const char *name;
 158 };
 159
 160 static const char pl1_name[] = "long_term";
 161 static const char pl2_name[] = "short_term";
 162
 163 struct rapl_package;
 164 struct rapl_domain {
 165         const char *name;
 166         enum rapl_domain_type id;
 167         int msrs[RAPL_DOMAIN_MSR_MAX];
 168         struct powercap_zone power_zone;
 169         struct rapl_domain_data rdd;
 170         struct rapl_power_limit rpl[NR_POWER_LIMITS];
 171         u64 attr_map; /* track capabilities */
 172         unsigned int state;
 173         unsigned int domain_energy_unit;
 174         struct rapl_package *rp;
 175 };
 176 #define power_zone_to_rapl_domain(_zone) \
 177         container_of(_zone, struct rapl_domain, power_zone)
 178
 179
 180 /* Each physical package contains multiple domains, these are the common
 181  * data across RAPL domains within a package.
 182  */
 183 struct rapl_package {
 184         unsigned int id; /* physical package/socket id */
 185         unsigned int nr_domains;
 186         unsigned long domain_map; /* bit map of active domains */
 187         unsigned int power_unit;
 188         unsigned int energy_unit;
 189         unsigned int time_unit;
 190         struct rapl_domain *domains; /* array of domains, sized at runtime */
 191         struct powercap_zone *power_zone; /* keep track of parent zone */
 192         int nr_cpus; /* active cpus on the package, topology info is lost during
 193                       * cpu hotplug. so we have to track ourselves.
 194                       */
 195         unsigned long power_limit_irq; /* keep track of package power limit
 196                                         * notify interrupt enable status.
 197                                         */
 198         struct list_head plist;
 199         int lead_cpu; /* one active cpu per package for access */
 200 };
 201
 202 struct rapl_defaults {
 203         u8 floor_freq_reg_addr;
 204         int (*check_unit)(struct rapl_package *rp, int cpu);
 205         void (*set_floor_freq)(struct rapl_domain *rd, bool mode);
 206         u64 (*compute_time_window)(struct rapl_package *rp, u64 val,
 207                                 bool to_raw);
 208         unsigned int dram_domain_energy_unit;
 209 };
 210 static struct rapl_defaults *rapl_defaults;
 211
 212 /* Sideband MBI registers */
 213 #define IOSF_CPU_POWER_BUDGET_CTL_BYT (0x2)
 214 #define IOSF_CPU_POWER_BUDGET_CTL_TNG (0xdf)
 215
 216 #define PACKAGE_PLN_INT_SAVED   BIT(0)
 217 #define MAX_PRIM_NAME (32)
 218
 219 /* per domain data. used to describe individual knobs such that access function
 220  * can be consolidated into one instead of many inline functions.
 221  */
 222 struct rapl_primitive_info {
 223         const char *name;
 224         u64 mask;
 225         int shift;
 226         enum rapl_domain_msr_id id;
 227         enum unit_type unit;
 228         u32 flag;
 229 };
 230
 231 #define PRIMITIVE_INFO_INIT(p, m, s, i, u, f) { \
 232                 .name = #p,                     \
 233                 .mask = m,                      \
 234                 .shift = s,                     \
 235                 .id = i,                        \
 236                 .unit = u,                      \
 237                 .flag = f                       \
 238         }
 239
 240 static void rapl_init_domains(struct rapl_package *rp);
 241 static int rapl_read_data_raw(struct rapl_domain *rd,
 242                         enum rapl_primitives prim,
 243                         bool xlate, u64 *data);
 244 static int rapl_write_data_raw(struct rapl_domain *rd,
 245                         enum rapl_primitives prim,
 246                         unsigned long long value);
 247 static u64 rapl_unit_xlate(struct rapl_domain *rd,
 248                         enum unit_type type, u64 value,
 249                         int to_raw);
 250 static void package_power_limit_irq_save(struct rapl_package *rp);
 251
 252 static LIST_HEAD(rapl_packages); /* guarded by CPU hotplug lock */
 253
 254 static const char * const rapl_domain_names[] = {
 255         "package",
 256         "core",
 257         "uncore",
 258         "dram",
 259         "psys",
 260 };
 261
 262 static struct powercap_control_type *control_type; /* PowerCap Controller */
 263 static struct rapl_domain *platform_rapl_domain; /* Platform (PSys) domain */
 264
 265 /* caller to ensure CPU hotplug lock is held */
 266 static struct rapl_package *find_package_by_id(int id)
 267 {
 268         struct rapl_package *rp;
 269
 270         list_for_each_entry(rp, &rapl_packages, plist) {
 271                 if (rp->id == id)
 272                         return rp;
 273         }
 274
 275         return NULL;
 276 }
 277
 278 /* caller must hold cpu hotplug lock */
 279 static void rapl_cleanup_data(void)
 280 {
 281         struct rapl_package *p, *tmp;
 282
 283         list_for_each_entry_safe(p, tmp, &rapl_packages, plist) {
 284                 kfree(p->domains);
 285                 list_del(&p->plist);
 286                 kfree(p);
 287         }
 288 }
 289
 290 static int get_energy_counter(struct powercap_zone *power_zone, u64 *energy_raw)
 291 {
 292         struct rapl_domain *rd;
 293         u64 energy_now;
 294
 295         /* prevent CPU hotplug, make sure the RAPL domain does not go
 296          * away while reading the counter.
 297          */
 298         get_online_cpus();
 299         rd = power_zone_to_rapl_domain(power_zone);
 300
 301         if (!rapl_read_data_raw(rd, ENERGY_COUNTER, true, &energy_now)) {
 302                 *energy_raw = energy_now;
 303                 put_online_cpus();
 304
 305                 return 0;
 306         }
 307         put_online_cpus();
 308
 309         return -EIO;
 310 }
 311
 312 static int get_max_energy_counter(struct powercap_zone *pcd_dev, u64 *energy)
 313 {
 314         struct rapl_domain *rd = power_zone_to_rapl_domain(pcd_dev);
 315
 316         *energy = rapl_unit_xlate(rd, ENERGY_UNIT, ENERGY_STATUS_MASK, 0);
 317         return 0;
 318 }
 319
 320 static int release_zone(struct powercap_zone *power_zone)
 321 {
 322         struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
 323         struct rapl_package *rp = rd->rp;
 324
 325         /* package zone is the last zone of a package, we can free
 326          * memory here since all children has been unregistered.
 327          */
 328         if (rd->id == RAPL_DOMAIN_PACKAGE) {
 329                 kfree(rd);
 330                 rp->domains = NULL;
 331         }
 332
 333         return 0;
 334
 335 }
 336
 337 static int find_nr_power_limit(struct rapl_domain *rd)
 338 {
 339         int i, nr_pl = 0;
 340
 341         for (i = 0; i < NR_POWER_LIMITS; i++) {
 342                 if (rd->rpl[i].name)
 343                         nr_pl++;
 344         }
 345
 346         return nr_pl;
 347 }
 348
 349 static int set_domain_enable(struct powercap_zone *power_zone, bool mode)
 350 {
 351         struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
 352
 353         if (rd->state & DOMAIN_STATE_BIOS_LOCKED)
 354                 return -EACCES;
 355
 356         get_online_cpus();
 357         rapl_write_data_raw(rd, PL1_ENABLE, mode);
 358         if (rapl_defaults->set_floor_freq)
 359                 rapl_defaults->set_floor_freq(rd, mode);
 360         put_online_cpus();
 361
 362         return 0;
 363 }
 364
 365 static int get_domain_enable(struct powercap_zone *power_zone, bool *mode)
 366 {
 367         struct rapl_domain *rd = power_zone_to_rapl_domain(power_zone);
 368         u64 val;
 369
 370         if (rd->state & DOMAIN_STATE_BIOS_LOCKED) {
 371                 *mode = false;
 372                 return 0;
 373         }
 374         get_online_cpus();
 375         if (rapl_read_data_raw(rd, PL1_ENABLE, true, &val)) {
 376                 put_online_cpus();
 377                 return -EIO;
 378         }
 379         *mode = val;
 380         put_online_cpus();
 381
 382         return 0;
 383 }
 384
 385 /* per RAPL domain ops, in the order of rapl_domain_type */
 386 static const struct powercap_zone_ops zone_ops[] = {
 387         /* RAPL_DOMAIN_PACKAGE */
 388         {
 389                 .get_energy_uj = get_energy_counter,
 390                 .get_max_energy_range_uj = get_max_energy_counter,
 391                 .release = release_zone,
 392                 .set_enable = set_domain_enable,
 393                 .get_enable = get_domain_enable,
 394         },
 395         /* RAPL_DOMAIN_PP0 */
 396         {
 397                 .get_energy_uj = get_energy_counter,
 398                 .get_max_energy_range_uj = get_max_energy_counter,
 399                 .release = release_zone,
 400                 .set_enable = set_domain_enable,
 401                 .get_enable = get_domain_enable,
 402         },
 403         /* RAPL_DOMAIN_PP1 */
 404         {
 405                 .get_energy_uj = get_energy_counter,
 406                 .get_max_energy_range_uj = get_max_energy_counter,
 407                 .release = release_zone,
 408                 .set_enable = set_domain_enable,
 409                 .get_enable = get_domain_enable,
 410         },
 411         /* RAPL_DOMAIN_DRAM */
 412         {
 413                 .get_energy_uj = get_energy_counter,
 414                 .get_max_energy_range_uj = get_max_energy_counter,
 415                 .release = release_zone,
 416                 .set_enable = set_domain_enable,
 417                 .get_enable = get_domain_enable,
 418         },
 419         /* RAPL_DOMAIN_PLATFORM */
 420         {
 421                 .get_energy_uj = get_energy_counter,
 422                 .get_max_energy_range_uj = get_max_energy_counter,
 423                 .release = release_zone,
 424                 .set_enable = set_domain_enable,
 425                 .get_enable = get_domain_enable,
 426         },
 427 };
 428
 429
 430 /*
 431  * Constraint index used by powercap can be different than power limit (PL)
 432  * index in that some  PLs maybe missing due to non-existant MSRs. So we
 433  * need to convert here by finding the valid PLs only (name populated).
 434  */
 435 static int contraint_to_pl(struct rapl_domain *rd, int cid)
 436 {
 437         int i, j;
 438
 439         for (i = 0, j = 0; i < NR_POWER_LIMITS; i++) {
 440                 if ((rd->rpl[i].name) && j++ == cid) {
 441                         pr_debug("%s: index %d\n", __func__, i);
 442                         return i;
 443                 }
 444         }
 445         pr_err("Cannot find matching power limit for constraint %d\n", cid);
 446
 447         return -EINVAL;
 448 }
 449
 450 static int set_power_limit(struct powercap_zone *power_zone, int cid,
 451                         u64 power_limit)
 452 {
 453         struct rapl_domain *rd;
 454         struct rapl_package *rp;
 455         int ret = 0;
 456         int id;
 457
 458         get_online_cpus();
 459         rd = power_zone_to_rapl_domain(power_zone);
 460         id = contraint_to_pl(rd, cid);
 461         if (id < 0) {
 462                 ret = id;
 463                 goto set_exit;
 464         }
 465
 466         rp = rd->rp;
 467
 468         if (rd->state & DOMAIN_STATE_BIOS_LOCKED) {
 469                 dev_warn(&power_zone->dev, "%s locked by BIOS, monitoring only\n",
 470                         rd->name);
 471                 ret = -EACCES;
 472                 goto set_exit;
 473         }
 474
 475         switch (rd->rpl[id].prim_id) {
 476         case PL1_ENABLE:
 477                 rapl_write_data_raw(rd, POWER_LIMIT1, power_limit);
 478                 break;
 479         case PL2_ENABLE:
 480                 rapl_write_data_raw(rd, POWER_LIMIT2, power_limit);
 481                 break;
 482         default:
 483                 ret = -EINVAL;
 484         }
 485         if (!ret)
 486                 package_power_limit_irq_save(rp);
 487 set_exit:
 488         put_online_cpus();
 489         return ret;
 490 }
 491
 492 static int get_current_power_limit(struct powercap_zone *power_zone, int cid,
 493                                         u64 *data)
 494 {
 495         struct rapl_domain *rd;
 496         u64 val;
 497         int prim;
 498         int ret = 0;
 499         int id;
 500
 501         get_online_cpus();
 502         rd = power_zone_to_rapl_domain(power_zone);
 503         id = contraint_to_pl(rd, cid);
 504         if (id < 0) {
 505                 ret = id;
 506                 goto get_exit;
 507         }
 508
 509         switch (rd->rpl[id].prim_id) {
 510         case PL1_ENABLE:
 511                 prim = POWER_LIMIT1;
 512                 break;
 513         case PL2_ENABLE:
 514                 prim = POWER_LIMIT2;
 515                 break;
 516         default:
 517                 put_online_cpus();
 518                 return -EINVAL;
 519         }
 520         if (rapl_read_data_raw(rd, prim, true, &val))
 521                 ret = -EIO;
 522         else
 523                 *data = val;
 524
 525 get_exit:
 526         put_online_cpus();
 527
 528         return ret;
 529 }
 530
 531 static int set_time_window(struct powercap_zone *power_zone, int cid,
 532                                                                 u64 window)
 533 {
 534         struct rapl_domain *rd;
 535         int ret = 0;
 536         int id;
 537
 538         get_online_cpus();
 539         rd = power_zone_to_rapl_domain(power_zone);
 540         id = contraint_to_pl(rd, cid);
 541         if (id < 0) {
 542                 ret = id;
 543                 goto set_time_exit;
 544         }
 545
 546         switch (rd->rpl[id].prim_id) {
 547         case PL1_ENABLE:
 548                 rapl_write_data_raw(rd, TIME_WINDOW1, window);
 549                 break;
 550         case PL2_ENABLE:
 551                 rapl_write_data_raw(rd, TIME_WINDOW2, window);
 552                 break;
 553         default:
 554                 ret = -EINVAL;
 555         }
 556
 557 set_time_exit:
 558         put_online_cpus();
 559         return ret;
 560 }
 561
 562 static int get_time_window(struct powercap_zone *power_zone, int cid, u64 *data)
 563 {
 564         struct rapl_domain *rd;
 565         u64 val;
 566         int ret = 0;
 567         int id;
 568
 569         get_online_cpus();
 570         rd = power_zone_to_rapl_domain(power_zone);
 571         id = contraint_to_pl(rd, cid);
 572         if (id < 0) {
 573                 ret = id;
 574                 goto get_time_exit;
 575         }
 576
 577         switch (rd->rpl[id].prim_id) {
 578         case PL1_ENABLE:
 579                 ret = rapl_read_data_raw(rd, TIME_WINDOW1, true, &val);
 580                 break;
 581         case PL2_ENABLE:
 582                 ret = rapl_read_data_raw(rd, TIME_WINDOW2, true, &val);
 583                 break;
 584         default:
 585                 put_online_cpus();
 586                 return -EINVAL;
 587         }
 588         if (!ret)
 589                 *data = val;
 590
 591 get_time_exit:
 592         put_online_cpus();
 593
 594         return ret;
 595 }
 596
 597 static const char *get_constraint_name(struct powercap_zone *power_zone, int cid)
 598 {
 599         struct rapl_domain *rd;
 600         int id;
 601
 602         rd = power_zone_to_rapl_domain(power_zone);
 603         id = contraint_to_pl(rd, cid);
 604         if (id >= 0)
 605                 return rd->rpl[id].name;
 606
 607         return NULL;
 608 }
 609
 610
 611 static int get_max_power(struct powercap_zone *power_zone, int id,
 612                                         u64 *data)
 613 {
 614         struct rapl_domain *rd;
 615         u64 val;
 616         int prim;
 617         int ret = 0;
 618
 619         get_online_cpus();
 620         rd = power_zone_to_rapl_domain(power_zone);
 621         switch (rd->rpl[id].prim_id) {
 622         case PL1_ENABLE:
 623                 prim = THERMAL_SPEC_POWER;
 624                 break;
 625         case PL2_ENABLE:
 626                 prim = MAX_POWER;
 627                 break;
 628         default:
 629                 put_online_cpus();
 630                 return -EINVAL;
 631         }
 632         if (rapl_read_data_raw(rd, prim, true, &val))
 633                 ret = -EIO;
 634         else
 635                 *data = val;
 636
 637         put_online_cpus();
 638
 639         return ret;
 640 }
 641
 642 static const struct powercap_zone_constraint_ops constraint_ops = {
 643         .set_power_limit_uw = set_power_limit,
 644         .get_power_limit_uw = get_current_power_limit,
 645         .set_time_window_us = set_time_window,
 646         .get_time_window_us = get_time_window,
 647         .get_max_power_uw = get_max_power,
 648         .get_name = get_constraint_name,
 649 };
 650
 651 /* called after domain detection and package level data are set */
 652 static void rapl_init_domains(struct rapl_package *rp)
 653 {
 654         int i;
 655         struct rapl_domain *rd = rp->domains;
 656
 657         for (i = 0; i < RAPL_DOMAIN_MAX; i++) {
 658                 unsigned int mask = rp->domain_map & (1 << i);
 659                 switch (mask) {
 660                 case BIT(RAPL_DOMAIN_PACKAGE):
 661                         rd->name = rapl_domain_names[RAPL_DOMAIN_PACKAGE];
 662                         rd->id = RAPL_DOMAIN_PACKAGE;
 663                         rd->msrs[0] = MSR_PKG_POWER_LIMIT;
 664                         rd->msrs[1] = MSR_PKG_ENERGY_STATUS;
 665                         rd->msrs[2] = MSR_PKG_PERF_STATUS;
 666                         rd->msrs[3] = 0;
 667                         rd->msrs[4] = MSR_PKG_POWER_INFO;
 668                         rd->rpl[0].prim_id = PL1_ENABLE;
 669                         rd->rpl[0].name = pl1_name;
 670                         rd->rpl[1].prim_id = PL2_ENABLE;
 671                         rd->rpl[1].name = pl2_name;
 672                         break;
 673                 case BIT(RAPL_DOMAIN_PP0):
 674                         rd->name = rapl_domain_names[RAPL_DOMAIN_PP0];
 675                         rd->id = RAPL_DOMAIN_PP0;
 676                         rd->msrs[0] = MSR_PP0_POWER_LIMIT;
 677                         rd->msrs[1] = MSR_PP0_ENERGY_STATUS;
 678                         rd->msrs[2] = 0;
 679                         rd->msrs[3] = MSR_PP0_POLICY;
 680                         rd->msrs[4] = 0;
 681                         rd->rpl[0].prim_id = PL1_ENABLE;
 682                         rd->rpl[0].name = pl1_name;
 683                         break;
 684                 case BIT(RAPL_DOMAIN_PP1):
 685                         rd->name = rapl_domain_names[RAPL_DOMAIN_PP1];
 686                         rd->id = RAPL_DOMAIN_PP1;
 687                         rd->msrs[0] = MSR_PP1_POWER_LIMIT;
 688                         rd->msrs[1] = MSR_PP1_ENERGY_STATUS;
 689                         rd->msrs[2] = 0;
 690                         rd->msrs[3] = MSR_PP1_POLICY;
 691                         rd->msrs[4] = 0;
 692                         rd->rpl[0].prim_id = PL1_ENABLE;
 693                         rd->rpl[0].name = pl1_name;
 694                         break;
 695                 case BIT(RAPL_DOMAIN_DRAM):
 696                         rd->name = rapl_domain_names[RAPL_DOMAIN_DRAM];
 697                         rd->id = RAPL_DOMAIN_DRAM;
 698                         rd->msrs[0] = MSR_DRAM_POWER_LIMIT;
 699                         rd->msrs[1] = MSR_DRAM_ENERGY_STATUS;
 700                         rd->msrs[2] = MSR_DRAM_PERF_STATUS;
 701                         rd->msrs[3] = 0;
 702                         rd->msrs[4] = MSR_DRAM_POWER_INFO;
 703                         rd->rpl[0].prim_id = PL1_ENABLE;
 704                         rd->rpl[0].name = pl1_name;
 705                         rd->domain_energy_unit =
 706                                 rapl_defaults->dram_domain_energy_unit;
 707                         if (rd->domain_energy_unit)
 708                                 pr_info("DRAM domain energy unit %dpj\n",
 709                                         rd->domain_energy_unit);
 710                         break;
 711                 }
 712                 if (mask) {
 713                         rd->rp = rp;
 714                         rd++;
 715                 }
 716         }
 717 }
 718
 719 static u64 rapl_unit_xlate(struct rapl_domain *rd, enum unit_type type,
 720                         u64 value, int to_raw)
 721 {
 722         u64 units = 1;
 723         struct rapl_package *rp = rd->rp;
 724         u64 scale = 1;
 725
 726         switch (type) {
 727         case POWER_UNIT:
 728                 units = rp->power_unit;
 729                 break;
 730         case ENERGY_UNIT:
 731                 scale = ENERGY_UNIT_SCALE;
 732                 /* per domain unit takes precedence */
 733                 if (rd->domain_energy_unit)
 734                         units = rd->domain_energy_unit;
 735                 else
 736                         units = rp->energy_unit;
 737                 break;
 738         case TIME_UNIT:
 739                 return rapl_defaults->compute_time_window(rp, value, to_raw);
 740         case ARBITRARY_UNIT:
 741         default:
 742                 return value;
 743         };
 744
 745         if (to_raw)
 746                 return div64_u64(value, units) * scale;
 747
 748         value *= units;
 749
 750         return div64_u64(value, scale);
 751 }
 752
 753 /* in the order of enum rapl_primitives */
 754 static struct rapl_primitive_info rpi[] = {
 755         /* name, mask, shift, msr index, unit divisor */
 756         PRIMITIVE_INFO_INIT(ENERGY_COUNTER, ENERGY_STATUS_MASK, 0,
 757                                 RAPL_DOMAIN_MSR_STATUS, ENERGY_UNIT, 0),
 758         PRIMITIVE_INFO_INIT(POWER_LIMIT1, POWER_LIMIT1_MASK, 0,
 759                                 RAPL_DOMAIN_MSR_LIMIT, POWER_UNIT, 0),
 760         PRIMITIVE_INFO_INIT(POWER_LIMIT2, POWER_LIMIT2_MASK, 32,
 761                                 RAPL_DOMAIN_MSR_LIMIT, POWER_UNIT, 0),
 762         PRIMITIVE_INFO_INIT(FW_LOCK, POWER_PP_LOCK, 31,
 763                                 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
 764         PRIMITIVE_INFO_INIT(PL1_ENABLE, POWER_LIMIT1_ENABLE, 15,
 765                                 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
 766         PRIMITIVE_INFO_INIT(PL1_CLAMP, POWER_LIMIT1_CLAMP, 16,
 767                                 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
 768         PRIMITIVE_INFO_INIT(PL2_ENABLE, POWER_LIMIT2_ENABLE, 47,
 769                                 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
 770         PRIMITIVE_INFO_INIT(PL2_CLAMP, POWER_LIMIT2_CLAMP, 48,
 771                                 RAPL_DOMAIN_MSR_LIMIT, ARBITRARY_UNIT, 0),
 772         PRIMITIVE_INFO_INIT(TIME_WINDOW1, TIME_WINDOW1_MASK, 17,
 773                                 RAPL_DOMAIN_MSR_LIMIT, TIME_UNIT, 0),
 774         PRIMITIVE_INFO_INIT(TIME_WINDOW2, TIME_WINDOW2_MASK, 49,
 775                                 RAPL_DOMAIN_MSR_LIMIT, TIME_UNIT, 0),
 776         PRIMITIVE_INFO_INIT(THERMAL_SPEC_POWER, POWER_INFO_THERMAL_SPEC_MASK,
 777                                 0, RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
 778         PRIMITIVE_INFO_INIT(MAX_POWER, POWER_INFO_MAX_MASK, 32,
 779                                 RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
 780         PRIMITIVE_INFO_INIT(MIN_POWER, POWER_INFO_MIN_MASK, 16,
 781                                 RAPL_DOMAIN_MSR_INFO, POWER_UNIT, 0),
 782         PRIMITIVE_INFO_INIT(MAX_TIME_WINDOW, POWER_INFO_MAX_TIME_WIN_MASK, 48,
 783                                 RAPL_DOMAIN_MSR_INFO, TIME_UNIT, 0),
 784         PRIMITIVE_INFO_INIT(THROTTLED_TIME, PERF_STATUS_THROTTLE_TIME_MASK, 0,
 785                                 RAPL_DOMAIN_MSR_PERF, TIME_UNIT, 0),
 786         PRIMITIVE_INFO_INIT(PRIORITY_LEVEL, PP_POLICY_MASK, 0,
 787                                 RAPL_DOMAIN_MSR_POLICY, ARBITRARY_UNIT, 0),
 788         /* non-hardware */
 789         PRIMITIVE_INFO_INIT(AVERAGE_POWER, 0, 0, 0, POWER_UNIT,
 790                                 RAPL_PRIMITIVE_DERIVED),
 791         {NULL, 0, 0, 0},
 792 };
 793
 794 /* Read primitive data based on its related struct rapl_primitive_info.
 795  * if xlate flag is set, return translated data based on data units, i.e.
 796  * time, energy, and power.
 797  * RAPL MSRs are non-architectual and are laid out not consistently across
 798  * domains. Here we use primitive info to allow writing consolidated access
 799  * functions.
 800  * For a given primitive, it is processed by MSR mask and shift. Unit conversion
 801  * is pre-assigned based on RAPL unit MSRs read at init time.
 802  * 63-------------------------- 31--------------------------- 0
 803  * |                           xxxxx (mask)                   |
 804  * |                                |<- shift ----------------|
 805  * 63-------------------------- 31--------------------------- 0
 806  */
 807 static int rapl_read_data_raw(struct rapl_domain *rd,
 808                         enum rapl_primitives prim,
 809                         bool xlate, u64 *data)
 810 {
 811         u64 value, final;
 812         u32 msr;
 813         struct rapl_primitive_info *rp = &rpi[prim];
 814         int cpu;
 815
 816         if (!rp->name || rp->flag & RAPL_PRIMITIVE_DUMMY)
 817                 return -EINVAL;
 818
 819         msr = rd->msrs[rp->id];
 820         if (!msr)
 821                 return -EINVAL;
 822
 823         cpu = rd->rp->lead_cpu;
 824
 825         /* special-case package domain, which uses a different bit*/
 826         if (prim == FW_LOCK && rd->id == RAPL_DOMAIN_PACKAGE) {
 827                 rp->mask = POWER_PACKAGE_LOCK;
 828                 rp->shift = 63;
 829         }
 830         /* non-hardware data are collected by the polling thread */
 831         if (rp->flag & RAPL_PRIMITIVE_DERIVED) {
 832                 *data = rd->rdd.primitives[prim];
 833                 return 0;
 834         }
 835
 836         if (rdmsrl_safe_on_cpu(cpu, msr, &value)) {
 837                 pr_debug("failed to read msr 0x%x on cpu %d\n", msr, cpu);
 838                 return -EIO;
 839         }
 840
 841         final = value & rp->mask;
 842         final = final >> rp->shift;
 843         if (xlate)
 844                 *data = rapl_unit_xlate(rd, rp->unit, final, 0);
 845         else
 846                 *data = final;
 847
 848         return 0;
 849 }
 850
 851
 852 static int msrl_update_safe(u32 msr_no, u64 clear_mask, u64 set_mask)
 853 {
 854         int err;
 855         u64 val;
 856
 857         err = rdmsrl_safe(msr_no, &val);
 858         if (err)
 859                 goto out;
 860
 861         val &= ~clear_mask;
 862         val |= set_mask;
 863
 864         err = wrmsrl_safe(msr_no, val);
 865
 866 out:
 867         return err;
 868 }
 869
 870 static void msrl_update_func(void *info)
 871 {
 872         struct msrl_action *ma = info;
 873
 874         ma->err = msrl_update_safe(ma->msr_no, ma->clear_mask, ma->set_mask);
 875 }
 876
 877 /* Similar use of primitive info in the read counterpart */
 878 static int rapl_write_data_raw(struct rapl_domain *rd,
 879                         enum rapl_primitives prim,
 880                         unsigned long long value)
 881 {
 882         struct rapl_primitive_info *rp = &rpi[prim];
 883         int cpu;
 884         u64 bits;
 885         struct msrl_action ma;
 886         int ret;
 887
 888         cpu = rd->rp->lead_cpu;
 889         bits = rapl_unit_xlate(rd, rp->unit, value, 1);
 890         bits |= bits << rp->shift;
 891         memset(&ma, 0, sizeof(ma));
 892
 893         ma.msr_no = rd->msrs[rp->id];
 894         ma.clear_mask = rp->mask;
 895         ma.set_mask = bits;
 896
 897         ret = smp_call_function_single(cpu, msrl_update_func, &ma, 1);
 898         if (ret)
 899                 WARN_ON_ONCE(ret);
 900         else
 901                 ret = ma.err;
 902
 903         return ret;
 904 }
 905
 906 /*
 907  * Raw RAPL data stored in MSRs are in certain scales. We need to
 908  * convert them into standard units based on the units reported in
 909  * the RAPL unit MSRs. This is specific to CPUs as the method to
 910  * calculate units differ on different CPUs.
 911  * We convert the units to below format based on CPUs.
 912  * i.e.
 913  * energy unit: picoJoules  : Represented in picoJoules by default
 914  * power unit : microWatts  : Represented in milliWatts by default
 915  * time unit  : microseconds: Represented in seconds by default
 916  */
 917 static int rapl_check_unit_core(struct rapl_package *rp, int cpu)
 918 {
 919         u64 msr_val;
 920         u32 value;
 921
 922         if (rdmsrl_safe_on_cpu(cpu, MSR_RAPL_POWER_UNIT, &msr_val)) {
 923                 pr_err("Failed to read power unit MSR 0x%x on CPU %d, exit.\n",
 924                         MSR_RAPL_POWER_UNIT, cpu);
 925                 return -ENODEV;
 926         }
 927
 928         value = (msr_val & ENERGY_UNIT_MASK) >> ENERGY_UNIT_OFFSET;
 929         rp->energy_unit = ENERGY_UNIT_SCALE * 1000000 / (1 << value);
 930
 931         value = (msr_val & POWER_UNIT_MASK) >> POWER_UNIT_OFFSET;
 932         rp->power_unit = 1000000 / (1 << value);
 933
 934         value = (msr_val & TIME_UNIT_MASK) >> TIME_UNIT_OFFSET;
 935         rp->time_unit = 1000000 / (1 << value);
 936
 937         pr_debug("Core CPU package %d energy=%dpJ, time=%dus, power=%duW\n",
 938                 rp->id, rp->energy_unit, rp->time_unit, rp->power_unit);
 939
 940         return 0;
 941 }
 942
 943 static int rapl_check_unit_atom(struct rapl_package *rp, int cpu)
 944 {
 945         u64 msr_val;
 946         u32 value;
 947
 948         if (rdmsrl_safe_on_cpu(cpu, MSR_RAPL_POWER_UNIT, &msr_val)) {
 949                 pr_err("Failed to read power unit MSR 0x%x on CPU %d, exit.\n",
 950                         MSR_RAPL_POWER_UNIT, cpu);
 951                 return -ENODEV;
 952         }
 953         value = (msr_val & ENERGY_UNIT_MASK) >> ENERGY_UNIT_OFFSET;
 954         rp->energy_unit = ENERGY_UNIT_SCALE * 1 << value;
 955
 956         value = (msr_val & POWER_UNIT_MASK) >> POWER_UNIT_OFFSET;
 957         rp->power_unit = (1 << value) * 1000;
 958
 959         value = (msr_val & TIME_UNIT_MASK) >> TIME_UNIT_OFFSET;
 960         rp->time_unit = 1000000 / (1 << value);
 961
 962         pr_debug("Atom package %d energy=%dpJ, time=%dus, power=%duW\n",
 963                 rp->id, rp->energy_unit, rp->time_unit, rp->power_unit);
 964
 965         return 0;
 966 }
 967
 968 static void power_limit_irq_save_cpu(void *info)
 969 {
 970         u32 l, h = 0;
 971         struct rapl_package *rp = (struct rapl_package *)info;
 972
 973         /* save the state of PLN irq mask bit before disabling it */
 974         rdmsr_safe(MSR_IA32_PACKAGE_THERM_INTERRUPT, &l, &h);
 975         if (!(rp->power_limit_irq & PACKAGE_PLN_INT_SAVED)) {
 976                 rp->power_limit_irq = l & PACKAGE_THERM_INT_PLN_ENABLE;
 977                 rp->power_limit_irq |= PACKAGE_PLN_INT_SAVED;
 978         }
 979         l &= ~PACKAGE_THERM_INT_PLN_ENABLE;
 980         wrmsr_safe(MSR_IA32_PACKAGE_THERM_INTERRUPT, l, h);
 981 }
 982
 983
 984 /* REVISIT:
 985  * When package power limit is set artificially low by RAPL, LVT
 986  * thermal interrupt for package power limit should be ignored
 987  * since we are not really exceeding the real limit. The intention
 988  * is to avoid excessive interrupts while we are trying to save power.
 989  * A useful feature might be routing the package_power_limit interrupt
 990  * to userspace via eventfd. once we have a usecase, this is simple
 991  * to do by adding an atomic notifier.
 992  */
 993
 994 static void package_power_limit_irq_save(struct rapl_package *rp)
 995 {
 996         if (!boot_cpu_has(X86_FEATURE_PTS) || !boot_cpu_has(X86_FEATURE_PLN))
 997                 return;
 998
 999         smp_call_function_single(rp->lead_cpu, power_limit_irq_save_cpu, rp, 1);
1000 }
1001
1002 static void power_limit_irq_restore_cpu(void *info)
1003 {
1004         u32 l, h = 0;
1005         struct rapl_package *rp = (struct rapl_package *)info;
1006
1007         rdmsr_safe(MSR_IA32_PACKAGE_THERM_INTERRUPT, &l, &h);
1008
1009         if (rp->power_limit_irq & PACKAGE_THERM_INT_PLN_ENABLE)
1010                 l |= PACKAGE_THERM_INT_PLN_ENABLE;
1011         else
1012                 l &= ~PACKAGE_THERM_INT_PLN_ENABLE;
1013
1014         wrmsr_safe(MSR_IA32_PACKAGE_THERM_INTERRUPT, l, h);
1015 }
1016
1017 /* restore per package power limit interrupt enable state */
1018 static void package_power_limit_irq_restore(struct rapl_package *rp)
1019 {
1020         if (!boot_cpu_has(X86_FEATURE_PTS) || !boot_cpu_has(X86_FEATURE_PLN))
1021                 return;
1022
1023         /* irq enable state not saved, nothing to restore */
1024         if (!(rp->power_limit_irq & PACKAGE_PLN_INT_SAVED))
1025                 return;
1026
1027         smp_call_function_single(rp->lead_cpu, power_limit_irq_restore_cpu, rp, 1);
1028 }
1029
1030 static void set_floor_freq_default(struct rapl_domain *rd, bool mode)
1031 {
1032         int nr_powerlimit = find_nr_power_limit(rd);
1033
1034         /* always enable clamp such that p-state can go below OS requested
1035          * range. power capping priority over guranteed frequency.
1036          */
1037         rapl_write_data_raw(rd, PL1_CLAMP, mode);
1038
1039         /* some domains have pl2 */
1040         if (nr_powerlimit > 1) {
1041                 rapl_write_data_raw(rd, PL2_ENABLE, mode);
1042                 rapl_write_data_raw(rd, PL2_CLAMP, mode);
1043         }
1044 }
1045
1046 static void set_floor_freq_atom(struct rapl_domain *rd, bool enable)
1047 {
1048         static u32 power_ctrl_orig_val;
1049         u32 mdata;
1050
1051         if (!rapl_defaults->floor_freq_reg_addr) {
1052                 pr_err("Invalid floor frequency config register\n");
1053                 return;
1054         }
1055
1056         if (!power_ctrl_orig_val)
1057                 iosf_mbi_read(BT_MBI_UNIT_PMC, MBI_CR_READ,
1058                               rapl_defaults->floor_freq_reg_addr,
1059                               &power_ctrl_orig_val);
1060         mdata = power_ctrl_orig_val;
1061         if (enable) {
1062                 mdata &= ~(0x7f << 8);
1063                 mdata |= 1 << 8;
1064         }
1065         iosf_mbi_write(BT_MBI_UNIT_PMC, MBI_CR_WRITE,
1066                        rapl_defaults->floor_freq_reg_addr, mdata);
1067 }
1068
1069 static u64 rapl_compute_time_window_core(struct rapl_package *rp, u64 value,
1070                                         bool to_raw)
1071 {
1072         u64 f, y; /* fraction and exp. used for time unit */
1073
1074         /*
1075          * Special processing based on 2^Y*(1+F/4), refer
1076          * to Intel Software Developer's manual Vol.3B: CH 14.9.3.
1077          */
1078         if (!to_raw) {
1079                 f = (value & 0x60) >> 5;
1080                 y = value & 0x1f;
1081                 value = (1 << y) * (4 + f) * rp->time_unit / 4;
1082         } else {
1083                 if (value < rp->time_unit)
1084                         return 0;
1085
1086                 do_div(value, rp->time_unit);
1087                 y = ilog2(value);
1088                 f = div64_u64(4 * (value - (1 << y)), 1 << y);
1089                 value = (y & 0x1f) | ((f & 0x3) << 5);
1090         }
1091         return value;
1092 }
1093
1094 static u64 rapl_compute_time_window_atom(struct rapl_package *rp, u64 value,
1095                                         bool to_raw)
1096 {
1097         /*
1098          * Atom time unit encoding is straight forward val * time_unit,
1099          * where time_unit is default to 1 sec. Never 0.
1100          */
1101         if (!to_raw)
1102                 return (value) ? value *= rp->time_unit : rp->time_unit;
1103         else
1104                 value = div64_u64(value, rp->time_unit);
1105
1106         return value;
1107 }
1108
1109 static const struct rapl_defaults rapl_defaults_core = {
1110         .floor_freq_reg_addr = 0,
1111         .check_unit = rapl_check_unit_core,
1112         .set_floor_freq = set_floor_freq_default,
1113         .compute_time_window = rapl_compute_time_window_core,
1114 };
1115
1116 static const struct rapl_defaults rapl_defaults_hsw_server = {
1117         .check_unit = rapl_check_unit_core,
1118         .set_floor_freq = set_floor_freq_default,
1119         .compute_time_window = rapl_compute_time_window_core,
1120         .dram_domain_energy_unit = 15300,
1121 };
1122
1123 static const struct rapl_defaults rapl_defaults_byt = {
1124         .floor_freq_reg_addr = IOSF_CPU_POWER_BUDGET_CTL_BYT,
1125         .check_unit = rapl_check_unit_atom,
1126         .set_floor_freq = set_floor_freq_atom,
1127         .compute_time_window = rapl_compute_time_window_atom,
1128 };
1129
1130 static const struct rapl_defaults rapl_defaults_tng = {
1131         .floor_freq_reg_addr = IOSF_CPU_POWER_BUDGET_CTL_TNG,
1132         .check_unit = rapl_check_unit_atom,
1133         .set_floor_freq = set_floor_freq_atom,
1134         .compute_time_window = rapl_compute_time_window_atom,
1135 };
1136
1137 static const struct rapl_defaults rapl_defaults_ann = {
1138         .floor_freq_reg_addr = 0,
1139         .check_unit = rapl_check_unit_atom,
1140         .set_floor_freq = NULL,
1141         .compute_time_window = rapl_compute_time_window_atom,
1142 };
1143
1144 static const struct rapl_defaults rapl_defaults_cht = {
1145         .floor_freq_reg_addr = 0,
1146         .check_unit = rapl_check_unit_atom,
1147         .set_floor_freq = NULL,
1148         .compute_time_window = rapl_compute_time_window_atom,
1149 };
1150
1151 #define RAPL_CPU(_model, _ops) {                        \
1152                 .vendor = X86_VENDOR_INTEL,             \
1153                 .family = 6,                            \
1154                 .model = _model,                        \
1155                 .driver_data = (kernel_ulong_t)&_ops,   \
1156                 }
1157
1158 static const struct x86_cpu_id rapl_ids[] __initconst = {
1159         RAPL_CPU(INTEL_FAM6_SANDYBRIDGE,        rapl_defaults_core),
1160         RAPL_CPU(INTEL_FAM6_SANDYBRIDGE_X,      rapl_defaults_core),
1161
1162         RAPL_CPU(INTEL_FAM6_IVYBRIDGE,          rapl_defaults_core),
1163         RAPL_CPU(INTEL_FAM6_IVYBRIDGE_X,        rapl_defaults_core),
1164
1165         RAPL_CPU(INTEL_FAM6_HASWELL_CORE,       rapl_defaults_core),
1166         RAPL_CPU(INTEL_FAM6_HASWELL_ULT,        rapl_defaults_core),
1167         RAPL_CPU(INTEL_FAM6_HASWELL_GT3E,       rapl_defaults_core),
1168         RAPL_CPU(INTEL_FAM6_HASWELL_X,          rapl_defaults_hsw_server),
1169
1170         RAPL_CPU(INTEL_FAM6_BROADWELL_CORE,     rapl_defaults_core),
1171         RAPL_CPU(INTEL_FAM6_BROADWELL_GT3E,     rapl_defaults_core),
1172         RAPL_CPU(INTEL_FAM6_BROADWELL_XEON_D,   rapl_defaults_core),
1173         RAPL_CPU(INTEL_FAM6_BROADWELL_X,        rapl_defaults_hsw_server),
1174
1175         RAPL_CPU(INTEL_FAM6_SKYLAKE_DESKTOP,    rapl_defaults_core),
1176         RAPL_CPU(INTEL_FAM6_SKYLAKE_MOBILE,     rapl_defaults_core),
1177         RAPL_CPU(INTEL_FAM6_SKYLAKE_X,          rapl_defaults_hsw_server),
1178         RAPL_CPU(INTEL_FAM6_KABYLAKE_MOBILE,    rapl_defaults_core),
1179         RAPL_CPU(INTEL_FAM6_KABYLAKE_DESKTOP,   rapl_defaults_core),
1180
1181         RAPL_CPU(INTEL_FAM6_ATOM_SILVERMONT,    rapl_defaults_byt),
1182         RAPL_CPU(INTEL_FAM6_ATOM_AIRMONT,       rapl_defaults_cht),
1183         RAPL_CPU(INTEL_FAM6_ATOM_SILVERMONT_MID,rapl_defaults_tng),
1184         RAPL_CPU(INTEL_FAM6_ATOM_AIRMONT_MID,   rapl_defaults_ann),
1185         RAPL_CPU(INTEL_FAM6_ATOM_GOLDMONT,      rapl_defaults_core),
1186         RAPL_CPU(INTEL_FAM6_ATOM_GOLDMONT_X,    rapl_defaults_core),
1187
1188         RAPL_CPU(INTEL_FAM6_XEON_PHI_KNL,       rapl_defaults_hsw_server),
1189         {}
1190 };
1191 MODULE_DEVICE_TABLE(x86cpu, rapl_ids);
1192
1193 /* read once for all raw primitive data for all packages, domains */
1194 static void rapl_update_domain_data(void)
1195 {
1196         int dmn, prim;
1197         u64 val;
1198         struct rapl_package *rp;
1199
1200         list_for_each_entry(rp, &rapl_packages, plist) {
1201                 for (dmn = 0; dmn < rp->nr_domains; dmn++) {
1202                         pr_debug("update package %d domain %s data\n", rp->id,
1203                                 rp->domains[dmn].name);
1204                         /* exclude non-raw primitives */
1205                         for (prim = 0; prim < NR_RAW_PRIMITIVES; prim++)
1206                                 if (!rapl_read_data_raw(&rp->domains[dmn], prim,
1207                                                                 rpi[prim].unit,
1208                                                                 &val))
1209                                         rp->domains[dmn].rdd.primitives[prim] =
1210                                                                         val;
1211                 }
1212         }
1213
1214 }
1215
1216 static int rapl_unregister_powercap(void)
1217 {
1218         struct rapl_package *rp;
1219         struct rapl_domain *rd, *rd_package = NULL;
1220
1221         /* unregister all active rapl packages from the powercap layer,
1222          * hotplug lock held
1223          */
1224         list_for_each_entry(rp, &rapl_packages, plist) {
1225                 package_power_limit_irq_restore(rp);
1226
1227                 for (rd = rp->domains; rd < rp->domains + rp->nr_domains;
1228                      rd++) {
1229                         pr_debug("remove package, undo power limit on %d: %s\n",
1230                                 rp->id, rd->name);
1231                         rapl_write_data_raw(rd, PL1_ENABLE, 0);
1232                         rapl_write_data_raw(rd, PL1_CLAMP, 0);
1233                         if (find_nr_power_limit(rd) > 1) {
1234                                 rapl_write_data_raw(rd, PL2_ENABLE, 0);
1235                                 rapl_write_data_raw(rd, PL2_CLAMP, 0);
1236                         }
1237                         if (rd->id == RAPL_DOMAIN_PACKAGE) {
1238                                 rd_package = rd;
1239                                 continue;
1240                         }
1241                         powercap_unregister_zone(control_type, &rd->power_zone);
1242                 }
1243                 /* do the package zone last */
1244                 if (rd_package)
1245                         powercap_unregister_zone(control_type,
1246                                                 &rd_package->power_zone);
1247         }
1248
1249         if (platform_rapl_domain) {
1250                 powercap_unregister_zone(control_type,
1251                                          &platform_rapl_domain->power_zone);
1252                 kfree(platform_rapl_domain);
1253         }
1254
1255         powercap_unregister_control_type(control_type);
1256
1257         return 0;
1258 }
1259
1260 static int rapl_package_register_powercap(struct rapl_package *rp)
1261 {
1262         struct rapl_domain *rd;
1263         int ret = 0;
1264         char dev_name[17]; /* max domain name = 7 + 1 + 8 for int + 1 for null*/
1265         struct powercap_zone *power_zone = NULL;
1266         int nr_pl;
1267
1268         /* first we register package domain as the parent zone*/
1269         for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1270                 if (rd->id == RAPL_DOMAIN_PACKAGE) {
1271                         nr_pl = find_nr_power_limit(rd);
1272                         pr_debug("register socket %d package domain %s\n",
1273                                 rp->id, rd->name);
1274                         memset(dev_name, 0, sizeof(dev_name));
1275                         snprintf(dev_name, sizeof(dev_name), "%s-%d",
1276                                 rd->name, rp->id);
1277                         power_zone = powercap_register_zone(&rd->power_zone,
1278                                                         control_type,
1279                                                         dev_name, NULL,
1280                                                         &zone_ops[rd->id],
1281                                                         nr_pl,
1282                                                         &constraint_ops);
1283                         if (IS_ERR(power_zone)) {
1284                                 pr_debug("failed to register package, %d\n",
1285                                         rp->id);
1286                                 ret = PTR_ERR(power_zone);
1287                                 goto exit_package;
1288                         }
1289                         /* track parent zone in per package/socket data */
1290                         rp->power_zone = power_zone;
1291                         /* done, only one package domain per socket */
1292                         break;
1293                 }
1294         }
1295         if (!power_zone) {
1296                 pr_err("no package domain found, unknown topology!\n");
1297                 ret = -ENODEV;
1298                 goto exit_package;
1299         }
1300         /* now register domains as children of the socket/package*/
1301         for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1302                 if (rd->id == RAPL_DOMAIN_PACKAGE)
1303                         continue;
1304                 /* number of power limits per domain varies */
1305                 nr_pl = find_nr_power_limit(rd);
1306                 power_zone = powercap_register_zone(&rd->power_zone,
1307                                                 control_type, rd->name,
1308                                                 rp->power_zone,
1309                                                 &zone_ops[rd->id], nr_pl,
1310                                                 &constraint_ops);
1311
1312                 if (IS_ERR(power_zone)) {
1313                         pr_debug("failed to register power_zone, %d:%s:%s\n",
1314                                 rp->id, rd->name, dev_name);
1315                         ret = PTR_ERR(power_zone);
1316                         goto err_cleanup;
1317                 }
1318         }
1319
1320 exit_package:
1321         return ret;
1322 err_cleanup:
1323         /* clean up previously initialized domains within the package if we
1324          * failed after the first domain setup.
1325          */
1326         while (--rd >= rp->domains) {
1327                 pr_debug("unregister package %d domain %s\n", rp->id, rd->name);
1328                 powercap_unregister_zone(control_type, &rd->power_zone);
1329         }
1330
1331         return ret;
1332 }
1333
1334 static int rapl_register_psys(void)
1335 {
1336         struct rapl_domain *rd;
1337         struct powercap_zone *power_zone;
1338         u64 val;
1339
1340         if (rdmsrl_safe_on_cpu(0, MSR_PLATFORM_ENERGY_STATUS, &val) || !val)
1341                 return -ENODEV;
1342
1343         if (rdmsrl_safe_on_cpu(0, MSR_PLATFORM_POWER_LIMIT, &val) || !val)
1344                 return -ENODEV;
1345
1346         rd = kzalloc(sizeof(*rd), GFP_KERNEL);
1347         if (!rd)
1348                 return -ENOMEM;
1349
1350         rd->name = rapl_domain_names[RAPL_DOMAIN_PLATFORM];
1351         rd->id = RAPL_DOMAIN_PLATFORM;
1352         rd->msrs[0] = MSR_PLATFORM_POWER_LIMIT;
1353         rd->msrs[1] = MSR_PLATFORM_ENERGY_STATUS;
1354         rd->rpl[0].prim_id = PL1_ENABLE;
1355         rd->rpl[0].name = pl1_name;
1356         rd->rpl[1].prim_id = PL2_ENABLE;
1357         rd->rpl[1].name = pl2_name;
1358         rd->rp = find_package_by_id(0);
1359
1360         power_zone = powercap_register_zone(&rd->power_zone, control_type,
1361                                             "psys", NULL,
1362                                             &zone_ops[RAPL_DOMAIN_PLATFORM],
1363                                             2, &constraint_ops);
1364
1365         if (IS_ERR(power_zone)) {
1366                 kfree(rd);
1367                 return PTR_ERR(power_zone);
1368         }
1369
1370         platform_rapl_domain = rd;
1371
1372         return 0;
1373 }
1374
1375 static int rapl_register_powercap(void)
1376 {
1377         struct rapl_domain *rd;
1378         struct rapl_package *rp;
1379         int ret = 0;
1380
1381         control_type = powercap_register_control_type(NULL, "intel-rapl", NULL);
1382         if (IS_ERR(control_type)) {
1383                 pr_debug("failed to register powercap control_type.\n");
1384                 return PTR_ERR(control_type);
1385         }
1386         /* read the initial data */
1387         rapl_update_domain_data();
1388         list_for_each_entry(rp, &rapl_packages, plist)
1389                 if (rapl_package_register_powercap(rp))
1390                         goto err_cleanup_package;
1391
1392         /* Don't bail out if PSys is not supported */
1393         rapl_register_psys();
1394
1395         return ret;
1396
1397 err_cleanup_package:
1398         /* clean up previously initialized packages */
1399         list_for_each_entry_continue_reverse(rp, &rapl_packages, plist) {
1400                 for (rd = rp->domains; rd < rp->domains + rp->nr_domains;
1401                      rd++) {
1402                         pr_debug("unregister zone/package %d, %s domain\n",
1403                                 rp->id, rd->name);
1404                         powercap_unregister_zone(control_type, &rd->power_zone);
1405                 }
1406         }
1407
1408         return ret;
1409 }
1410
1411 static int rapl_check_domain(int cpu, int domain)
1412 {
1413         unsigned msr;
1414         u64 val = 0;
1415
1416         switch (domain) {
1417         case RAPL_DOMAIN_PACKAGE:
1418                 msr = MSR_PKG_ENERGY_STATUS;
1419                 break;
1420         case RAPL_DOMAIN_PP0:
1421                 msr = MSR_PP0_ENERGY_STATUS;
1422                 break;
1423         case RAPL_DOMAIN_PP1:
1424                 msr = MSR_PP1_ENERGY_STATUS;
1425                 break;
1426         case RAPL_DOMAIN_DRAM:
1427                 msr = MSR_DRAM_ENERGY_STATUS;
1428                 break;
1429         case RAPL_DOMAIN_PLATFORM:
1430                 /* PSYS(PLATFORM) is not a CPU domain, so avoid printng error */
1431                 return -EINVAL;
1432         default:
1433                 pr_err("invalid domain id %d\n", domain);
1434                 return -EINVAL;
1435         }
1436         /* make sure domain counters are available and contains non-zero
1437          * values, otherwise skip it.
1438          */
1439         if (rdmsrl_safe_on_cpu(cpu, msr, &val) || !val)
1440                 return -ENODEV;
1441
1442         return 0;
1443 }
1444
1445
1446 /*
1447  * Check if power limits are available. Two cases when they are not available:
1448  * 1. Locked by BIOS, in this case we still provide read-only access so that
1449  *    users can see what limit is set by the BIOS.
1450  * 2. Some CPUs make some domains monitoring only which means PLx MSRs may not
1451  *    exist at all. In this case, we do not show the contraints in powercap.
1452  *
1453  * Called after domains are detected and initialized.
1454  */
1455 static void rapl_detect_powerlimit(struct rapl_domain *rd)
1456 {
1457         u64 val64;
1458         int i;
1459
1460         /* check if the domain is locked by BIOS, ignore if MSR doesn't exist */
1461         if (!rapl_read_data_raw(rd, FW_LOCK, false, &val64)) {
1462                 if (val64) {
1463                         pr_info("RAPL package %d domain %s locked by BIOS\n",
1464                                 rd->rp->id, rd->name);
1465                         rd->state |= DOMAIN_STATE_BIOS_LOCKED;
1466                 }
1467         }
1468         /* check if power limit MSRs exists, otherwise domain is monitoring only */
1469         for (i = 0; i < NR_POWER_LIMITS; i++) {
1470                 int prim = rd->rpl[i].prim_id;
1471                 if (rapl_read_data_raw(rd, prim, false, &val64))
1472                         rd->rpl[i].name = NULL;
1473         }
1474 }
1475
1476 /* Detect active and valid domains for the given CPU, caller must
1477  * ensure the CPU belongs to the targeted package and CPU hotlug is disabled.
1478  */
1479 static int rapl_detect_domains(struct rapl_package *rp, int cpu)
1480 {
1481         int i;
1482         int ret = 0;
1483         struct rapl_domain *rd;
1484
1485         for (i = 0; i < RAPL_DOMAIN_MAX; i++) {
1486                 /* use physical package id to read counters */
1487                 if (!rapl_check_domain(cpu, i)) {
1488                         rp->domain_map |= 1 << i;
1489                         pr_info("Found RAPL domain %s\n", rapl_domain_names[i]);
1490                 }
1491         }
1492         rp->nr_domains = bitmap_weight(&rp->domain_map, RAPL_DOMAIN_MAX);
1493         if (!rp->nr_domains) {
1494                 pr_debug("no valid rapl domains found in package %d\n", rp->id);
1495                 ret = -ENODEV;
1496                 goto done;
1497         }
1498         pr_debug("found %d domains on package %d\n", rp->nr_domains, rp->id);
1499
1500         rp->domains = kcalloc(rp->nr_domains + 1, sizeof(struct rapl_domain),
1501                         GFP_KERNEL);
1502         if (!rp->domains) {
1503                 ret = -ENOMEM;
1504                 goto done;
1505         }
1506         rapl_init_domains(rp);
1507
1508         for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++)
1509                 rapl_detect_powerlimit(rd);
1510
1511
1512
1513 done:
1514         return ret;
1515 }
1516
1517 static bool is_package_new(int package)
1518 {
1519         struct rapl_package *rp;
1520
1521         /* caller prevents cpu hotplug, there will be no new packages added
1522          * or deleted while traversing the package list, no need for locking.
1523          */
1524         list_for_each_entry(rp, &rapl_packages, plist)
1525                 if (package == rp->id)
1526                         return false;
1527
1528         return true;
1529 }
1530
1531 /* RAPL interface can be made of a two-level hierarchy: package level and domain
1532  * level. We first detect the number of packages then domains of each package.
1533  * We have to consider the possiblity of CPU online/offline due to hotplug and
1534  * other scenarios.
1535  */
1536 static int rapl_detect_topology(void)
1537 {
1538         int i;
1539         int phy_package_id;
1540         struct rapl_package *new_package, *rp;
1541
1542         for_each_online_cpu(i) {
1543                 phy_package_id = topology_physical_package_id(i);
1544                 if (is_package_new(phy_package_id)) {
1545                         new_package = kzalloc(sizeof(*rp), GFP_KERNEL);
1546                         if (!new_package) {
1547                                 rapl_cleanup_data();
1548                                 return -ENOMEM;
1549                         }
1550                         /* add the new package to the list */
1551                         new_package->id = phy_package_id;
1552                         new_package->nr_cpus = 1;
1553                         /* use the first active cpu of the package to access */
1554                         new_package->lead_cpu = i;
1555                         /* check if the package contains valid domains */
1556                         if (rapl_detect_domains(new_package, i) ||
1557                                 rapl_defaults->check_unit(new_package, i)) {
1558                                 kfree(new_package->domains);
1559                                 kfree(new_package);
1560                                 /* free up the packages already initialized */
1561                                 rapl_cleanup_data();
1562                                 return -ENODEV;
1563                         }
1564                         INIT_LIST_HEAD(&new_package->plist);
1565                         list_add(&new_package->plist, &rapl_packages);
1566                 } else {
1567                         rp = find_package_by_id(phy_package_id);
1568                         if (rp)
1569                                 ++rp->nr_cpus;
1570                 }
1571         }
1572
1573         return 0;
1574 }
1575
1576 /* called from CPU hotplug notifier, hotplug lock held */
1577 static void rapl_remove_package(struct rapl_package *rp)
1578 {
1579         struct rapl_domain *rd, *rd_package = NULL;
1580
1581         for (rd = rp->domains; rd < rp->domains + rp->nr_domains; rd++) {
1582                 if (rd->id == RAPL_DOMAIN_PACKAGE) {
1583                         rd_package = rd;
1584                         continue;
1585                 }
1586                 pr_debug("remove package %d, %s domain\n", rp->id, rd->name);
1587                 powercap_unregister_zone(control_type, &rd->power_zone);
1588         }
1589         /* do parent zone last */
1590         powercap_unregister_zone(control_type, &rd_package->power_zone);
1591         list_del(&rp->plist);
1592         kfree(rp);
1593 }
1594
1595 /* called from CPU hotplug notifier, hotplug lock held */
1596 static int rapl_add_package(int cpu)
1597 {
1598         int ret = 0;
1599         int phy_package_id;
1600         struct rapl_package *rp;
1601
1602         phy_package_id = topology_physical_package_id(cpu);
1603         rp = kzalloc(sizeof(struct rapl_package), GFP_KERNEL);
1604         if (!rp)
1605                 return -ENOMEM;
1606
1607         /* add the new package to the list */
1608         rp->id = phy_package_id;
1609         rp->nr_cpus = 1;
1610         rp->lead_cpu = cpu;
1611
1612         /* check if the package contains valid domains */
1613         if (rapl_detect_domains(rp, cpu) ||
1614                 rapl_defaults->check_unit(rp, cpu)) {
1615                 ret = -ENODEV;
1616                 goto err_free_package;
1617         }
1618         if (!rapl_package_register_powercap(rp)) {
1619                 INIT_LIST_HEAD(&rp->plist);
1620                 list_add(&rp->plist, &rapl_packages);
1621                 return ret;
1622         }
1623
1624 err_free_package:
1625         kfree(rp->domains);
1626         kfree(rp);
1627
1628         return ret;
1629 }
1630
1631 /* Handles CPU hotplug on multi-socket systems.
1632  * If a CPU goes online as the first CPU of the physical package
1633  * we add the RAPL package to the system. Similarly, when the last
1634  * CPU of the package is removed, we remove the RAPL package and its
1635  * associated domains. Cooling devices are handled accordingly at
1636  * per-domain level.
1637  */
1638 static int rapl_cpu_callback(struct notifier_block *nfb,
1639                                 unsigned long action, void *hcpu)
1640 {
1641         unsigned long cpu = (unsigned long)hcpu;
1642         int phy_package_id;
1643         struct rapl_package *rp;
1644         int lead_cpu;
1645
1646         phy_package_id = topology_physical_package_id(cpu);
1647         switch (action) {
1648         case CPU_ONLINE:
1649         case CPU_ONLINE_FROZEN:
1650         case CPU_DOWN_FAILED:
1651         case CPU_DOWN_FAILED_FROZEN:
1652                 rp = find_package_by_id(phy_package_id);
1653                 if (rp)
1654                         ++rp->nr_cpus;
1655                 else
1656                         rapl_add_package(cpu);
1657                 break;
1658         case CPU_DOWN_PREPARE:
1659         case CPU_DOWN_PREPARE_FROZEN:
1660                 rp = find_package_by_id(phy_package_id);
1661                 if (!rp)
1662                         break;
1663                 if (--rp->nr_cpus == 0)
1664                         rapl_remove_package(rp);
1665                 else if (cpu == rp->lead_cpu) {
1666                         /* choose another active cpu in the package */
1667                         lead_cpu = cpumask_any_but(topology_core_cpumask(cpu), cpu);
1668                         if (lead_cpu < nr_cpu_ids)
1669                                 rp->lead_cpu = lead_cpu;
1670                         else /* should never go here */
1671                                 pr_err("no active cpu available for package %d\n",
1672                                         phy_package_id);
1673                 }
1674         }
1675
1676         return NOTIFY_OK;
1677 }
1678
1679 static struct notifier_block rapl_cpu_notifier = {
1680         .notifier_call = rapl_cpu_callback,
1681 };
1682
1683 static int __init rapl_init(void)
1684 {
1685         int ret = 0;
1686         const struct x86_cpu_id *id;
1687
1688         id = x86_match_cpu(rapl_ids);
1689         if (!id) {
1690                 pr_err("driver does not support CPU family %d model %d\n",
1691                         boot_cpu_data.x86, boot_cpu_data.x86_model);
1692
1693                 return -ENODEV;
1694         }
1695
1696         rapl_defaults = (struct rapl_defaults *)id->driver_data;
1697
1698         cpu_notifier_register_begin();
1699
1700         /* prevent CPU hotplug during detection */
1701         get_online_cpus();
1702         ret = rapl_detect_topology();
1703         if (ret)
1704                 goto done;
1705
1706         if (rapl_register_powercap()) {
1707                 rapl_cleanup_data();
1708                 ret = -ENODEV;
1709                 goto done;
1710         }
1711         __register_hotcpu_notifier(&rapl_cpu_notifier);
1712 done:
1713         put_online_cpus();
1714         cpu_notifier_register_done();
1715
1716         return ret;
1717 }
1718
1719 static void __exit rapl_exit(void)
1720 {
1721         cpu_notifier_register_begin();
1722         get_online_cpus();
1723         __unregister_hotcpu_notifier(&rapl_cpu_notifier);
1724         rapl_unregister_powercap();
1725         rapl_cleanup_data();
1726         put_online_cpus();
1727         cpu_notifier_register_done();
1728 }
1729
1730 module_init(rapl_init);
1731 module_exit(rapl_exit);
1732
1733 MODULE_DESCRIPTION("Driver for Intel RAPL (Running Average Power Limit)");
1734 MODULE_AUTHOR("Jacob Pan <jacob.jun.pan@intel.com>");
1735 MODULE_LICENSE("GPL v2");