drivers/cpufreq/e_powersaver.c

   1 /*
   2  *  Based on documentation provided by Dave Jones. Thanks!
   3  *
   4  *  Licensed under the terms of the GNU GPL License version 2.
   5  *
   6  *  BIG FAT DISCLAIMER: Work in progress code. Possibly *dangerous*
   7  */
   8
   9 #include <linux/kernel.h>
  10 #include <linux/module.h>
  11 #include <linux/init.h>
  12 #include <linux/cpufreq.h>
  13 #include <linux/ioport.h>
  14 #include <linux/slab.h>
  15 #include <linux/timex.h>
  16 #include <linux/io.h>
  17 #include <linux/delay.h>
  18
  19 #include <asm/cpu_device_id.h>
  20 #include <asm/msr.h>
  21 #include <asm/tsc.h>
  22
  23 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
  24 #include <linux/acpi.h>
  25 #include <acpi/processor.h>
  26 #endif
  27
  28 #define EPS_BRAND_C7M   0
  29 #define EPS_BRAND_C7    1
  30 #define EPS_BRAND_EDEN  2
  31 #define EPS_BRAND_C3    3
  32 #define EPS_BRAND_C7D   4
  33
  34 struct eps_cpu_data {
  35         u32 fsb;
  36 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
  37         u32 bios_limit;
  38 #endif
  39         struct cpufreq_frequency_table freq_table[];
  40 };
  41
  42 static struct eps_cpu_data *eps_cpu[NR_CPUS];
  43
  44 /* Module parameters */
  45 static int freq_failsafe_off;
  46 static int voltage_failsafe_off;
  47 static int set_max_voltage;
  48
  49 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
  50 static int ignore_acpi_limit;
  51
  52 static struct acpi_processor_performance *eps_acpi_cpu_perf;
  53
  54 /* Minimum necessary to get acpi_processor_get_bios_limit() working */
  55 static int eps_acpi_init(void)
  56 {
  57         eps_acpi_cpu_perf = kzalloc(sizeof(*eps_acpi_cpu_perf),
  58                                       GFP_KERNEL);
  59         if (!eps_acpi_cpu_perf)
  60                 return -ENOMEM;
  61
  62         if (!zalloc_cpumask_var(&eps_acpi_cpu_perf->shared_cpu_map,
  63                                                                 GFP_KERNEL)) {
  64                 kfree(eps_acpi_cpu_perf);
  65                 eps_acpi_cpu_perf = NULL;
  66                 return -ENOMEM;
  67         }
  68
  69         if (acpi_processor_register_performance(eps_acpi_cpu_perf, 0)) {
  70                 free_cpumask_var(eps_acpi_cpu_perf->shared_cpu_map);
  71                 kfree(eps_acpi_cpu_perf);
  72                 eps_acpi_cpu_perf = NULL;
  73                 return -EIO;
  74         }
  75         return 0;
  76 }
  77
  78 static int eps_acpi_exit(struct cpufreq_policy *policy)
  79 {
  80         if (eps_acpi_cpu_perf) {
  81                 acpi_processor_unregister_performance(0);
  82                 free_cpumask_var(eps_acpi_cpu_perf->shared_cpu_map);
  83                 kfree(eps_acpi_cpu_perf);
  84                 eps_acpi_cpu_perf = NULL;
  85         }
  86         return 0;
  87 }
  88 #endif
  89
  90 static unsigned int eps_get(unsigned int cpu)
  91 {
  92         struct eps_cpu_data *centaur;
  93         u32 lo, hi;
  94
  95         if (cpu)
  96                 return 0;
  97         centaur = eps_cpu[cpu];
  98         if (centaur == NULL)
  99                 return 0;
 100
 101         /* Return current frequency */
 102         rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 103         return centaur->fsb * ((lo >> 8) & 0xff);
 104 }
 105
 106 static int eps_set_state(struct eps_cpu_data *centaur,
 107                          struct cpufreq_policy *policy,
 108                          u32 dest_state)
 109 {
 110         u32 lo, hi;
 111         int i;
 112
 113         /* Wait while CPU is busy */
 114         rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 115         i = 0;
 116         while (lo & ((1 << 16) | (1 << 17))) {
 117                 udelay(16);
 118                 rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 119                 i++;
 120                 if (unlikely(i > 64)) {
 121                         return -ENODEV;
 122                 }
 123         }
 124         /* Set new multiplier and voltage */
 125         wrmsr(MSR_IA32_PERF_CTL, dest_state & 0xffff, 0);
 126         /* Wait until transition end */
 127         i = 0;
 128         do {
 129                 udelay(16);
 130                 rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 131                 i++;
 132                 if (unlikely(i > 64)) {
 133                         return -ENODEV;
 134                 }
 135         } while (lo & ((1 << 16) | (1 << 17)));
 136
 137 #ifdef DEBUG
 138         {
 139         u8 current_multiplier, current_voltage;
 140
 141         /* Print voltage and multiplier */
 142         rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 143         current_voltage = lo & 0xff;
 144         pr_info("eps: Current voltage = %dmV\n", current_voltage * 16 + 700);
 145         current_multiplier = (lo >> 8) & 0xff;
 146         pr_info("eps: Current multiplier = %d\n", current_multiplier);
 147         }
 148 #endif
 149         return 0;
 150 }
 151
 152 static int eps_target(struct cpufreq_policy *policy, unsigned int index)
 153 {
 154         struct eps_cpu_data *centaur;
 155         unsigned int cpu = policy->cpu;
 156         unsigned int dest_state;
 157         int ret;
 158
 159         if (unlikely(eps_cpu[cpu] == NULL))
 160                 return -ENODEV;
 161         centaur = eps_cpu[cpu];
 162
 163         /* Make frequency transition */
 164         dest_state = centaur->freq_table[index].driver_data & 0xffff;
 165         ret = eps_set_state(centaur, policy, dest_state);
 166         if (ret)
 167                 pr_err("eps: Timeout!\n");
 168         return ret;
 169 }
 170
 171 static int eps_cpu_init(struct cpufreq_policy *policy)
 172 {
 173         unsigned int i;
 174         u32 lo, hi;
 175         u64 val;
 176         u8 current_multiplier, current_voltage;
 177         u8 max_multiplier, max_voltage;
 178         u8 min_multiplier, min_voltage;
 179         u8 brand = 0;
 180         u32 fsb;
 181         struct eps_cpu_data *centaur;
 182         struct cpuinfo_x86 *c = &cpu_data(0);
 183         struct cpufreq_frequency_table *f_table;
 184         int k, step, voltage;
 185         int ret;
 186         int states;
 187 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
 188         unsigned int limit;
 189 #endif
 190
 191         if (policy->cpu != 0)
 192                 return -ENODEV;
 193
 194         /* Check brand */
 195         pr_info("eps: Detected VIA ");
 196
 197         switch (c->x86_model) {
 198         case 10:
 199                 rdmsr(0x1153, lo, hi);
 200                 brand = (((lo >> 2) ^ lo) >> 18) & 3;
 201                 pr_cont("Model A ");
 202                 break;
 203         case 13:
 204                 rdmsr(0x1154, lo, hi);
 205                 brand = (((lo >> 4) ^ (lo >> 2))) & 0x000000ff;
 206                 pr_cont("Model D ");
 207                 break;
 208         }
 209
 210         switch (brand) {
 211         case EPS_BRAND_C7M:
 212                 pr_cont("C7-M\n");
 213                 break;
 214         case EPS_BRAND_C7:
 215                 pr_cont("C7\n");
 216                 break;
 217         case EPS_BRAND_EDEN:
 218                 pr_cont("Eden\n");
 219                 break;
 220         case EPS_BRAND_C7D:
 221                 pr_cont("C7-D\n");
 222                 break;
 223         case EPS_BRAND_C3:
 224                 pr_cont("C3\n");
 225                 return -ENODEV;
 226                 break;
 227         }
 228         /* Enable Enhanced PowerSaver */
 229         rdmsrl(MSR_IA32_MISC_ENABLE, val);
 230         if (!(val & MSR_IA32_MISC_ENABLE_ENHANCED_SPEEDSTEP)) {
 231                 val |= MSR_IA32_MISC_ENABLE_ENHANCED_SPEEDSTEP;
 232                 wrmsrl(MSR_IA32_MISC_ENABLE, val);
 233                 /* Can be locked at 0 */
 234                 rdmsrl(MSR_IA32_MISC_ENABLE, val);
 235                 if (!(val & MSR_IA32_MISC_ENABLE_ENHANCED_SPEEDSTEP)) {
 236                         pr_info("eps: Can't enable Enhanced PowerSaver\n");
 237                         return -ENODEV;
 238                 }
 239         }
 240
 241         /* Print voltage and multiplier */
 242         rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
 243         current_voltage = lo & 0xff;
 244         pr_info("eps: Current voltage = %dmV\n", current_voltage * 16 + 700);
 245         current_multiplier = (lo >> 8) & 0xff;
 246         pr_info("eps: Current multiplier = %d\n", current_multiplier);
 247
 248         /* Print limits */
 249         max_voltage = hi & 0xff;
 250         pr_info("eps: Highest voltage = %dmV\n", max_voltage * 16 + 700);
 251         max_multiplier = (hi >> 8) & 0xff;
 252         pr_info("eps: Highest multiplier = %d\n", max_multiplier);
 253         min_voltage = (hi >> 16) & 0xff;
 254         pr_info("eps: Lowest voltage = %dmV\n", min_voltage * 16 + 700);
 255         min_multiplier = (hi >> 24) & 0xff;
 256         pr_info("eps: Lowest multiplier = %d\n", min_multiplier);
 257
 258         /* Sanity checks */
 259         if (current_multiplier == 0 || max_multiplier == 0
 260             || min_multiplier == 0)
 261                 return -EINVAL;
 262         if (current_multiplier > max_multiplier
 263             || max_multiplier <= min_multiplier)
 264                 return -EINVAL;
 265         if (current_voltage > 0x1f || max_voltage > 0x1f)
 266                 return -EINVAL;
 267         if (max_voltage < min_voltage
 268             || current_voltage < min_voltage
 269             || current_voltage > max_voltage)
 270                 return -EINVAL;
 271
 272         /* Check for systems using underclocked CPU */
 273         if (!freq_failsafe_off && max_multiplier != current_multiplier) {
 274                 pr_info("eps: Your processor is running at different frequency then its maximum. Aborting.\n");
 275                 pr_info("eps: You can use freq_failsafe_off option to disable this check.\n");
 276                 return -EINVAL;
 277         }
 278         if (!voltage_failsafe_off && max_voltage != current_voltage) {
 279                 pr_info("eps: Your processor is running at different voltage then its maximum. Aborting.\n");
 280                 pr_info("eps: You can use voltage_failsafe_off option to disable this check.\n");
 281                 return -EINVAL;
 282         }
 283
 284         /* Calc FSB speed */
 285         fsb = cpu_khz / current_multiplier;
 286
 287 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
 288         /* Check for ACPI processor speed limit */
 289         if (!ignore_acpi_limit && !eps_acpi_init()) {
 290                 if (!acpi_processor_get_bios_limit(policy->cpu, &limit)) {
 291                         pr_info("eps: ACPI limit %u.%uGHz\n",
 292                                 limit/1000000,
 293                                 (limit%1000000)/10000);
 294                         eps_acpi_exit(policy);
 295                         /* Check if max_multiplier is in BIOS limits */
 296                         if (limit && max_multiplier * fsb > limit) {
 297                                 pr_info("eps: Aborting\n");
 298                                 return -EINVAL;
 299                         }
 300                 }
 301         }
 302 #endif
 303
 304         /* Allow user to set lower maximum voltage then that reported
 305          * by processor */
 306         if (brand == EPS_BRAND_C7M && set_max_voltage) {
 307                 u32 v;
 308
 309                 /* Change mV to something hardware can use */
 310                 v = (set_max_voltage - 700) / 16;
 311                 /* Check if voltage is within limits */
 312                 if (v >= min_voltage && v <= max_voltage) {
 313                         pr_info("eps: Setting %dmV as maximum\n", v * 16 + 700);
 314                         max_voltage = v;
 315                 }
 316         }
 317
 318         /* Calc number of p-states supported */
 319         if (brand == EPS_BRAND_C7M)
 320                 states = max_multiplier - min_multiplier + 1;
 321         else
 322                 states = 2;
 323
 324         /* Allocate private data and frequency table for current cpu */
 325         centaur = kzalloc(sizeof(*centaur)
 326                     + (states + 1) * sizeof(struct cpufreq_frequency_table),
 327                     GFP_KERNEL);
 328         if (!centaur)
 329                 return -ENOMEM;
 330         eps_cpu[0] = centaur;
 331
 332         /* Copy basic values */
 333         centaur->fsb = fsb;
 334 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
 335         centaur->bios_limit = limit;
 336 #endif
 337
 338         /* Fill frequency and MSR value table */
 339         f_table = &centaur->freq_table[0];
 340         if (brand != EPS_BRAND_C7M) {
 341                 f_table[0].frequency = fsb * min_multiplier;
 342                 f_table[0].driver_data = (min_multiplier << 8) | min_voltage;
 343                 f_table[1].frequency = fsb * max_multiplier;
 344                 f_table[1].driver_data = (max_multiplier << 8) | max_voltage;
 345                 f_table[2].frequency = CPUFREQ_TABLE_END;
 346         } else {
 347                 k = 0;
 348                 step = ((max_voltage - min_voltage) * 256)
 349                         / (max_multiplier - min_multiplier);
 350                 for (i = min_multiplier; i <= max_multiplier; i++) {
 351                         voltage = (k * step) / 256 + min_voltage;
 352                         f_table[k].frequency = fsb * i;
 353                         f_table[k].driver_data = (i << 8) | voltage;
 354                         k++;
 355                 }
 356                 f_table[k].frequency = CPUFREQ_TABLE_END;
 357         }
 358
 359         policy->cpuinfo.transition_latency = 140000; /* 844mV -> 700mV in ns */
 360
 361         ret = cpufreq_table_validate_and_show(policy, &centaur->freq_table[0]);
 362         if (ret) {
 363                 kfree(centaur);
 364                 return ret;
 365         }
 366
 367         return 0;
 368 }
 369
 370 static int eps_cpu_exit(struct cpufreq_policy *policy)
 371 {
 372         unsigned int cpu = policy->cpu;
 373
 374         /* Bye */
 375         kfree(eps_cpu[cpu]);
 376         eps_cpu[cpu] = NULL;
 377         return 0;
 378 }
 379
 380 static struct cpufreq_driver eps_driver = {
 381         .verify         = cpufreq_generic_frequency_table_verify,
 382         .target_index   = eps_target,
 383         .init           = eps_cpu_init,
 384         .exit           = eps_cpu_exit,
 385         .get            = eps_get,
 386         .name           = "e_powersaver",
 387         .attr           = cpufreq_generic_attr,
 388 };
 389
 390
 391 /* This driver will work only on Centaur C7 processors with
 392  * Enhanced SpeedStep/PowerSaver registers */
 393 static const struct x86_cpu_id eps_cpu_id[] = {
 394         { X86_VENDOR_CENTAUR, 6, X86_MODEL_ANY, X86_FEATURE_EST },
 395         {}
 396 };
 397 MODULE_DEVICE_TABLE(x86cpu, eps_cpu_id);
 398
 399 static int __init eps_init(void)
 400 {
 401         if (!x86_match_cpu(eps_cpu_id) || boot_cpu_data.x86_model < 10)
 402                 return -ENODEV;
 403         if (cpufreq_register_driver(&eps_driver))
 404                 return -EINVAL;
 405         return 0;
 406 }
 407
 408 static void __exit eps_exit(void)
 409 {
 410         cpufreq_unregister_driver(&eps_driver);
 411 }
 412
 413 /* Allow user to overclock his machine or to change frequency to higher after
 414  * unloading module */
 415 module_param(freq_failsafe_off, int, 0644);
 416 MODULE_PARM_DESC(freq_failsafe_off, "Disable current vs max frequency check");
 417 module_param(voltage_failsafe_off, int, 0644);
 418 MODULE_PARM_DESC(voltage_failsafe_off, "Disable current vs max voltage check");
 419 #if defined CONFIG_ACPI_PROCESSOR || defined CONFIG_ACPI_PROCESSOR_MODULE
 420 module_param(ignore_acpi_limit, int, 0644);
 421 MODULE_PARM_DESC(ignore_acpi_limit, "Don't check ACPI's processor speed limit");
 422 #endif
 423 module_param(set_max_voltage, int, 0644);
 424 MODULE_PARM_DESC(set_max_voltage, "Set maximum CPU voltage (mV) C7-M only");
 425
 426 MODULE_AUTHOR("Rafal Bilski <rafalbilski@interia.pl>");
 427 MODULE_DESCRIPTION("Enhanced PowerSaver driver for VIA C7 CPU's.");
 428 MODULE_LICENSE("GPL");
 429
 430 module_init(eps_init);
 431 module_exit(eps_exit);