arch/i386/kernel/cpu/cpufreq/gx-suspmod.c

   1 /*
   2  *      Cyrix MediaGX and NatSemi Geode Suspend Modulation
   3  *      (C) 2002 Zwane Mwaikambo <zwane@commfireservices.com>
   4  *      (C) 2002 Hiroshi Miura   <miura@da-cha.org>
   5  *      All Rights Reserved
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      version 2 as published by the Free Software Foundation
  10  *
  11  *      The author(s) of this software shall not be held liable for damages
  12  *      of any nature resulting due to the use of this software. This
  13  *      software is provided AS-IS with no warranties.
  14  *
  15  * Theoritical note:
  16  *
  17  *      (see Geode(tm) CS5530 manual (rev.4.1) page.56)
  18  *
  19  *      CPU frequency control on NatSemi Geode GX1/GXLV processor and CS55x0
  20  *      are based on Suspend Moduration.
  21  *
  22  *      Suspend Modulation works by asserting and de-asserting the SUSP# pin
  23  *      to CPU(GX1/GXLV) for configurable durations. When asserting SUSP#
  24  *      the CPU enters an idle state. GX1 stops its core clock when SUSP# is
  25  *      asserted then power consumption is reduced.
  26  *
  27  *      Suspend Modulation's OFF/ON duration are configurable
  28  *      with 'Suspend Modulation OFF Count Register'
  29  *      and 'Suspend Modulation ON Count Register'.
  30  *      These registers are 8bit counters that represent the number of
  31  *      32us intervals which the SUSP# pin is asserted(ON)/de-asserted(OFF)
  32  *      to the processor.
  33  *
  34  *      These counters define a ratio which is the effective frequency
  35  *      of operation of the system.
  36  *
  37  *                             OFF Count
  38  *      F_eff = Fgx * ----------------------
  39  *                      OFF Count + ON Count
  40  *
  41  *      0 <= On Count, Off Count <= 255
  42  *
  43  *      From these limits, we can get register values
  44  *
  45  *      off_duration + on_duration <= MAX_DURATION
  46  *      on_duration = off_duration * (stock_freq - freq) / freq
  47  *
  48  *      off_duration  =  (freq * DURATION) / stock_freq
  49  *      on_duration = DURATION - off_duration
  50  *
  51  *
  52  *---------------------------------------------------------------------------
  53  *
  54  * ChangeLog:
  55  *      Dec. 12, 2003   Hiroshi Miura <miura@da-cha.org>
  56  *              - fix on/off register mistake
  57  *              - fix cpu_khz calc when it stops cpu modulation.
  58  *
  59  *      Dec. 11, 2002   Hiroshi Miura <miura@da-cha.org>
  60  *              - rewrite for Cyrix MediaGX Cx5510/5520 and
  61  *                NatSemi Geode Cs5530(A).
  62  *
  63  *      Jul. ??, 2002  Zwane Mwaikambo <zwane@commfireservices.com>
  64  *              - cs5530_mod patch for 2.4.19-rc1.
  65  *
  66  *---------------------------------------------------------------------------
  67  *
  68  * Todo
  69  *      Test on machines with 5510, 5530, 5530A
  70  */
  71
  72 /************************************************************************
  73  *                      Suspend Modulation - Definitions                *
  74  ************************************************************************/
  75
  76 #include <linux/kernel.h>
  77 #include <linux/module.h>
  78 #include <linux/init.h>
  79 #include <linux/smp.h>
  80 #include <linux/cpufreq.h>
  81 #include <linux/pci.h>
  82 #include <asm/processor.h>
  83 #include <asm/errno.h>
  84
  85 /* PCI config registers, all at F0 */
  86 #define PCI_PMER1              0x80    /* power management enable register 1 */
  87 #define PCI_PMER2              0x81    /* power management enable register 2 */
  88 #define PCI_PMER3              0x82    /* power management enable register 3 */
  89 #define PCI_IRQTC              0x8c    /* irq speedup timer counter register:typical 2 to 4ms */
  90 #define PCI_VIDTC              0x8d    /* video speedup timer counter register: typical 50 to 100ms */
  91 #define PCI_MODOFF             0x94    /* suspend modulation OFF counter register, 1 = 32us */
  92 #define PCI_MODON              0x95    /* suspend modulation ON counter register */
  93 #define PCI_SUSCFG             0x96    /* suspend configuration register */
  94
  95 /* PMER1 bits */
  96 #define GPM                    (1<<0)  /* global power management */
  97 #define GIT                    (1<<1)  /* globally enable PM device idle timers */
  98 #define GTR                    (1<<2)  /* globally enable IO traps */
  99 #define IRQ_SPDUP              (1<<3)  /* disable clock throttle during interrupt handling */
 100 #define VID_SPDUP              (1<<4)  /* disable clock throttle during vga video handling */
 101
 102 /* SUSCFG bits */
 103 #define SUSMOD                 (1<<0)  /* enable/disable suspend modulation */
 104 /* the belows support only with cs5530 (after rev.1.2)/cs5530A */
 105 #define SMISPDUP               (1<<1)  /* select how SMI re-enable suspend modulation: */
 106                                        /* IRQTC timer or read SMI speedup disable reg.(F1BAR[08-09h]) */
 107 #define SUSCFG                 (1<<2)  /* enable powering down a GXLV processor. "Special 3Volt Suspend" mode */
 108 /* the belows support only with cs5530A */
 109 #define PWRSVE_ISA             (1<<3)  /* stop ISA clock  */
 110 #define PWRSVE                 (1<<4)  /* active idle */
 111
 112 struct gxfreq_params {
 113         u8 on_duration;
 114         u8 off_duration;
 115         u8 pci_suscfg;
 116         u8 pci_pmer1;
 117         u8 pci_pmer2;
 118         u8 pci_rev;
 119         struct pci_dev *cs55x0;
 120 };
 121
 122 static struct gxfreq_params *gx_params;
 123 static int stock_freq;
 124
 125 /* PCI bus clock - defaults to 30.000 if cpu_khz is not available */
 126 static int pci_busclk = 0;
 127 module_param (pci_busclk, int, 0444);
 128
 129 /* maximum duration for which the cpu may be suspended
 130  * (32us * MAX_DURATION). If no parameter is given, this defaults
 131  * to 255.
 132  * Note that this leads to a maximum of 8 ms(!) where the CPU clock
 133  * is suspended -- processing power is just 0.39% of what it used to be,
 134  * though. 781.25 kHz(!) for a 200 MHz processor -- wow. */
 135 static int max_duration = 255;
 136 module_param (max_duration, int, 0444);
 137
 138 /* For the default policy, we want at least some processing power
 139  * - let's say 5%. (min = maxfreq / POLICY_MIN_DIV)
 140  */
 141 #define POLICY_MIN_DIV 20
 142
 143
 144 /* DEBUG
 145  *   Define it if you want verbose debug output
 146  */
 147
 148 #define SUSPMOD_DEBUG 1
 149
 150 #ifdef SUSPMOD_DEBUG
 151 #define dprintk(msg...) printk(KERN_DEBUG "cpufreq:" msg)
 152 #else
 153 #define dprintk(msg...) do { } while(0)
 154 #endif
 155
 156 /**
 157  *      we can detect a core multipiler from dir0_lsb
 158  *      from GX1 datasheet p.56,
 159  *         MULT[3:0]:
 160  *         0000 = SYSCLK multiplied by 4 (test only)
 161  *         0001 = SYSCLK multiplied by 10
 162  *         0010 = SYSCLK multiplied by 4
 163  *         0011 = SYSCLK multiplied by 6
 164  *         0100 = SYSCLK multiplied by 9
 165  *         0101 = SYSCLK multiplied by 5
 166  *         0110 = SYSCLK multiplied by 7
 167  *         0111 = SYSCLK multiplied by 8
 168  *              of 33.3MHz
 169  **/
 170 static int gx_freq_mult[16] = {
 171                 4, 10, 4, 6, 9, 5, 7, 8,
 172                 0, 0, 0, 0, 0, 0, 0, 0
 173 };
 174
 175
 176 /****************************************************************
 177  *      Low Level chipset interface                             *
 178  ****************************************************************/
 179 static struct pci_device_id gx_chipset_tbl[] __initdata = {
 180         { PCI_VENDOR_ID_CYRIX, PCI_DEVICE_ID_CYRIX_5530_LEGACY, PCI_ANY_ID, PCI_ANY_ID },
 181         { PCI_VENDOR_ID_CYRIX, PCI_DEVICE_ID_CYRIX_5520, PCI_ANY_ID, PCI_ANY_ID },
 182         { PCI_VENDOR_ID_CYRIX, PCI_DEVICE_ID_CYRIX_5510, PCI_ANY_ID, PCI_ANY_ID },
 183         { 0, },
 184 };
 185
 186 /**
 187  *     gx_detect_chipset:
 188  *
 189  **/
 190 static __init struct pci_dev *gx_detect_chipset(void)
 191 {
 192         struct pci_dev *gx_pci = NULL;
 193
 194         /* check if CPU is a MediaGX or a Geode. */
 195         if ((current_cpu_data.x86_vendor != X86_VENDOR_NSC) &&
 196             (current_cpu_data.x86_vendor != X86_VENDOR_CYRIX)) {
 197                 printk(KERN_INFO "gx-suspmod: error: no MediaGX/Geode processor found!\n");
 198                 return NULL;
 199         }
 200
 201         /* detect which companion chip is used */
 202         while ((gx_pci = pci_find_device(PCI_ANY_ID, PCI_ANY_ID, gx_pci)) != NULL) {
 203                 if ((pci_match_device (gx_chipset_tbl, gx_pci)) != NULL) {
 204                         return gx_pci;
 205                 }
 206         }
 207
 208         dprintk(KERN_INFO "gx-suspmod: error: no supported chipset found!\n");
 209         return NULL;
 210 }
 211
 212 /**
 213  *      gx_get_cpuspeed:
 214  *
 215  * Finds out at which efficient frequency the Cyrix MediaGX/NatSemi Geode CPU runs.
 216  */
 217 static unsigned int gx_get_cpuspeed(unsigned int cpu)
 218 {
 219         if ((gx_params->pci_suscfg & SUSMOD) == 0)
 220                 return stock_freq;
 221
 222         return (stock_freq * gx_params->on_duration)
 223                 / (gx_params->on_duration + gx_params->off_duration);
 224 }
 225
 226 /**
 227  *      gx_validate_speed:
 228  *      determine current cpu speed
 229  *
 230 **/
 231
 232 static unsigned int gx_validate_speed(unsigned int khz, u8 *on_duration, u8 *off_duration)
 233 {
 234         unsigned int i;
 235         u8 tmp_on, tmp_off;
 236         int old_tmp_freq = stock_freq;
 237         int tmp_freq;
 238
 239         *off_duration=1;
 240         *on_duration=0;
 241
 242         for (i=max_duration; i>0; i--) {
 243                 tmp_off = ((khz * i) / stock_freq) & 0xff;
 244                 tmp_on = i - tmp_off;
 245                 tmp_freq = (stock_freq * tmp_off) / i;
 246                 /* if this relation is closer to khz, use this. If it's equal,
 247                  * prefer it, too - lower latency */
 248                 if (abs(tmp_freq - khz) <= abs(old_tmp_freq - khz)) {
 249                         *on_duration = tmp_on;
 250                         *off_duration = tmp_off;
 251                         old_tmp_freq = tmp_freq;
 252                 }
 253         }
 254
 255         return old_tmp_freq;
 256 }
 257
 258
 259 /**
 260  *      gx_set_cpuspeed:
 261  *              set cpu speed in khz.
 262  **/
 263
 264 static void gx_set_cpuspeed(unsigned int khz)
 265 {
 266         u8 suscfg, pmer1;
 267         unsigned int new_khz;
 268         unsigned long flags;
 269         struct cpufreq_freqs freqs;
 270
 271
 272         freqs.cpu = 0;
 273         freqs.old = gx_get_cpuspeed(0);
 274
 275         new_khz = gx_validate_speed(khz, &gx_params->on_duration, &gx_params->off_duration);
 276
 277         freqs.new = new_khz;
 278
 279         cpufreq_notify_transition(&freqs, CPUFREQ_PRECHANGE);
 280         local_irq_save(flags);
 281
 282         if (new_khz != stock_freq) {  /* if new khz == 100% of CPU speed, it is special case */
 283                 switch (gx_params->cs55x0->device) {
 284                 case PCI_DEVICE_ID_CYRIX_5530_LEGACY:
 285                         pmer1 = gx_params->pci_pmer1 | IRQ_SPDUP | VID_SPDUP;
 286                         /* FIXME: need to test other values -- Zwane,Miura */
 287                         pci_write_config_byte(gx_params->cs55x0, PCI_IRQTC, 4); /* typical 2 to 4ms */
 288                         pci_write_config_byte(gx_params->cs55x0, PCI_VIDTC, 100);/* typical 50 to 100ms */
 289                         pci_write_config_byte(gx_params->cs55x0, PCI_PMER1, pmer1);
 290
 291                         if (gx_params->pci_rev < 0x10) {   /* CS5530(rev 1.2, 1.3) */
 292                                 suscfg = gx_params->pci_suscfg | SUSMOD;
 293                         } else {                           /* CS5530A,B.. */
 294                                 suscfg = gx_params->pci_suscfg | SUSMOD | PWRSVE;
 295                         }
 296                         break;
 297                 case PCI_DEVICE_ID_CYRIX_5520:
 298                 case PCI_DEVICE_ID_CYRIX_5510:
 299                         suscfg = gx_params->pci_suscfg | SUSMOD;
 300                 default:
 301                         local_irq_restore(flags);
 302                         dprintk("fatal: try to set unknown chipset.\n");
 303                         return;
 304                 }
 305         } else {
 306                 suscfg = gx_params->pci_suscfg & ~(SUSMOD);
 307                 gx_params->off_duration = 0;
 308                 gx_params->on_duration = 0;
 309                 dprintk("suspend modulation disabled: cpu runs 100 percent speed.\n");
 310         }
 311
 312         pci_write_config_byte(gx_params->cs55x0, PCI_MODOFF, gx_params->off_duration);
 313         pci_write_config_byte(gx_params->cs55x0, PCI_MODON, gx_params->on_duration);
 314
 315         pci_write_config_byte(gx_params->cs55x0, PCI_SUSCFG, suscfg);
 316         pci_read_config_byte(gx_params->cs55x0, PCI_SUSCFG, &suscfg);
 317
 318         local_irq_restore(flags);
 319
 320         gx_params->pci_suscfg = suscfg;
 321
 322         cpufreq_notify_transition(&freqs, CPUFREQ_POSTCHANGE);
 323
 324         dprintk("suspend modulation w/ duration of ON:%d us, OFF:%d us\n",
 325                 gx_params->on_duration * 32, gx_params->off_duration * 32);
 326         dprintk("suspend modulation w/ clock speed: %d kHz.\n", freqs.new);
 327 }
 328
 329 /****************************************************************
 330  *             High level functions                             *
 331  ****************************************************************/
 332
 333 /*
 334  *      cpufreq_gx_verify: test if frequency range is valid
 335  *
 336  *      This function checks if a given frequency range in kHz is valid
 337  *      for the hardware supported by the driver.
 338  */
 339
 340 static int cpufreq_gx_verify(struct cpufreq_policy *policy)
 341 {
 342         unsigned int tmp_freq = 0;
 343         u8 tmp1, tmp2;
 344
 345         if (!stock_freq || !policy)
 346                 return -EINVAL;
 347
 348         policy->cpu = 0;
 349         cpufreq_verify_within_limits(policy, (stock_freq / max_duration), stock_freq);
 350
 351         /* it needs to be assured that at least one supported frequency is
 352          * within policy->min and policy->max. If it is not, policy->max
 353          * needs to be increased until one freuqency is supported.
 354          * policy->min may not be decreased, though. This way we guarantee a
 355          * specific processing capacity.
 356          */
 357         tmp_freq = gx_validate_speed(policy->min, &tmp1, &tmp2);
 358         if (tmp_freq < policy->min)
 359                 tmp_freq += stock_freq / max_duration;
 360         policy->min = tmp_freq;
 361         if (policy->min > policy->max)
 362                 policy->max = tmp_freq;
 363         tmp_freq = gx_validate_speed(policy->max, &tmp1, &tmp2);
 364         if (tmp_freq > policy->max)
 365                 tmp_freq -= stock_freq / max_duration;
 366         policy->max = tmp_freq;
 367         if (policy->max < policy->min)
 368                 policy->max = policy->min;
 369         cpufreq_verify_within_limits(policy, (stock_freq / max_duration), stock_freq);
 370
 371         return 0;
 372 }
 373
 374 /*
 375  *      cpufreq_gx_target:
 376  *
 377  */
 378 static int cpufreq_gx_target(struct cpufreq_policy *policy,
 379                              unsigned int target_freq,
 380                              unsigned int relation)
 381 {
 382         u8 tmp1, tmp2;
 383         unsigned int tmp_freq;
 384
 385         if (!stock_freq || !policy)
 386                 return -EINVAL;
 387
 388         policy->cpu = 0;
 389
 390         tmp_freq = gx_validate_speed(target_freq, &tmp1, &tmp2);
 391         while (tmp_freq < policy->min) {
 392                 tmp_freq += stock_freq / max_duration;
 393                 tmp_freq = gx_validate_speed(tmp_freq, &tmp1, &tmp2);
 394         }
 395         while (tmp_freq > policy->max) {
 396                 tmp_freq -= stock_freq / max_duration;
 397                 tmp_freq = gx_validate_speed(tmp_freq, &tmp1, &tmp2);
 398         }
 399
 400         gx_set_cpuspeed(tmp_freq);
 401
 402         return 0;
 403 }
 404
 405 static int cpufreq_gx_cpu_init(struct cpufreq_policy *policy)
 406 {
 407         unsigned int maxfreq, curfreq;
 408
 409         if (!policy || policy->cpu != 0)
 410                 return -ENODEV;
 411
 412         /* determine maximum frequency */
 413         if (pci_busclk) {
 414                 maxfreq = pci_busclk * gx_freq_mult[getCx86(CX86_DIR1) & 0x0f];
 415         } else if (cpu_khz) {
 416                 maxfreq = cpu_khz;
 417         } else {
 418                 maxfreq = 30000 * gx_freq_mult[getCx86(CX86_DIR1) & 0x0f];
 419         }
 420         stock_freq = maxfreq;
 421         curfreq = gx_get_cpuspeed(0);
 422
 423         dprintk("cpu max frequency is %d.\n", maxfreq);
 424         dprintk("cpu current frequency is %dkHz.\n",curfreq);
 425
 426         /* setup basic struct for cpufreq API */
 427         policy->cpu = 0;
 428
 429         if (max_duration < POLICY_MIN_DIV)
 430                 policy->min = maxfreq / max_duration;
 431         else
 432                 policy->min = maxfreq / POLICY_MIN_DIV;
 433         policy->max = maxfreq;
 434         policy->cur = curfreq;
 435         policy->governor = CPUFREQ_DEFAULT_GOVERNOR;
 436         policy->cpuinfo.min_freq = maxfreq / max_duration;
 437         policy->cpuinfo.max_freq = maxfreq;
 438         policy->cpuinfo.transition_latency = CPUFREQ_ETERNAL;
 439
 440         return 0;
 441 }
 442
 443 /*
 444  * cpufreq_gx_init:
 445  *   MediaGX/Geode GX initialize cpufreq driver
 446  */
 447 static struct cpufreq_driver gx_suspmod_driver = {
 448         .get            = gx_get_cpuspeed,
 449         .verify         = cpufreq_gx_verify,
 450         .target         = cpufreq_gx_target,
 451         .init           = cpufreq_gx_cpu_init,
 452         .name           = "gx-suspmod",
 453         .owner          = THIS_MODULE,
 454 };
 455
 456 static int __init cpufreq_gx_init(void)
 457 {
 458         int ret;
 459         struct gxfreq_params *params;
 460         struct pci_dev *gx_pci;
 461         u32 class_rev;
 462
 463         /* Test if we have the right hardware */
 464         if ((gx_pci = gx_detect_chipset()) == NULL)
 465                 return -ENODEV;
 466
 467         /* check whether module parameters are sane */
 468         if (max_duration > 0xff)
 469                 max_duration = 0xff;
 470
 471         dprintk("geode suspend modulation available.\n");
 472
 473         params = kmalloc(sizeof(struct gxfreq_params), GFP_KERNEL);
 474         if (params == NULL)
 475                 return -ENOMEM;
 476         memset(params, 0, sizeof(struct gxfreq_params));
 477
 478         params->cs55x0 = gx_pci;
 479         gx_params = params;
 480
 481         /* keep cs55x0 configurations */
 482         pci_read_config_byte(params->cs55x0, PCI_SUSCFG, &(params->pci_suscfg));
 483         pci_read_config_byte(params->cs55x0, PCI_PMER1, &(params->pci_pmer1));
 484         pci_read_config_byte(params->cs55x0, PCI_PMER2, &(params->pci_pmer2));
 485         pci_read_config_byte(params->cs55x0, PCI_MODON, &(params->on_duration));
 486         pci_read_config_byte(params->cs55x0, PCI_MODOFF, &(params->off_duration));
 487         pci_read_config_dword(params->cs55x0, PCI_CLASS_REVISION, &class_rev);
 488         params->pci_rev = class_rev && 0xff;
 489
 490         if ((ret = cpufreq_register_driver(&gx_suspmod_driver))) {
 491                 kfree(params);
 492                 return ret;                   /* register error! */
 493         }
 494
 495         return 0;
 496 }
 497
 498 static void __exit cpufreq_gx_exit(void)
 499 {
 500         cpufreq_unregister_driver(&gx_suspmod_driver);
 501         kfree(gx_params);
 502 }
 503
 504 MODULE_AUTHOR ("Hiroshi Miura <miura@da-cha.org>");
 505 MODULE_DESCRIPTION ("Cpufreq driver for Cyrix MediaGX and NatSemi Geode");
 506 MODULE_LICENSE ("GPL");
 507
 508 module_init(cpufreq_gx_init);
 509 module_exit(cpufreq_gx_exit);
 510