drivers/powercap/intel_rapl.c

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