2 * (C) 2001-2004 Dave Jones. <davej@codemonkey.org.uk>
3 * (C) 2002 Padraig Brady. <padraig@antefacto.com>
5 * Licensed under the terms of the GNU GPL License version 2.
6 * Based upon datasheets & sample CPUs kindly provided by VIA.
8 * VIA have currently 3 different versions of Longhaul.
9 * Version 1 (Longhaul) uses the BCR2 MSR at 0x1147.
10 * It is present only in Samuel 1 (C5A), Samuel 2 (C5B) stepping 0.
11 * Version 2 of longhaul is the same as v1, but adds voltage scaling.
12 * Present in Samuel 2 (steppings 1-7 only) (C5B), and Ezra (C5C)
13 * voltage scaling support has currently been disabled in this driver
14 * until we have code that gets it right.
15 * Version 3 of longhaul got renamed to Powersaver and redesigned
16 * to use the POWERSAVER MSR at 0x110a.
17 * It is present in Ezra-T (C5M), Nehemiah (C5X) and above.
18 * It's pretty much the same feature wise to longhaul v2, though
19 * there is provision for scaling FSB too, but this doesn't work
20 * too well in practice so we don't even try to use this.
22 * BIG FAT DISCLAIMER: Work in progress code. Possibly *dangerous*
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/init.h>
29 #include <linux/cpufreq.h>
30 #include <linux/slab.h>
31 #include <linux/string.h>
34 #include <asm/timex.h>
37 #include <linux/acpi.h>
38 #include <acpi/processor.h>
42 #define PFX "longhaul: "
44 #define TYPE_LONGHAUL_V1 1
45 #define TYPE_LONGHAUL_V2 2
46 #define TYPE_POWERSAVER 3
52 #define CPU_NEHEMIAH 5
55 static unsigned int numscales=16, numvscales;
56 static unsigned int fsb;
57 static int minvid, maxvid;
58 static unsigned int minmult, maxmult;
59 static int can_scale_voltage;
61 static struct acpi_processor *pr = NULL;
62 static struct acpi_processor_cx *cx = NULL;
64 /* Module parameters */
65 static int dont_scale_voltage;
68 #define dprintk(msg...) cpufreq_debug_printk(CPUFREQ_DEBUG_DRIVER, "longhaul", msg)
71 /* Clock ratios multiplied by 10 */
72 static int clock_ratio[32];
73 static int eblcr_table[32];
74 static int voltage_table[32];
75 static unsigned int highest_speed, lowest_speed; /* kHz */
76 static int longhaul_version;
77 static struct cpufreq_frequency_table *longhaul_table;
79 #ifdef CONFIG_CPU_FREQ_DEBUG
80 static char speedbuffer[8];
82 static char *print_speed(int speed)
85 snprintf(speedbuffer, sizeof(speedbuffer),"%dMHz", speed);
90 snprintf(speedbuffer, sizeof(speedbuffer),
93 snprintf(speedbuffer, sizeof(speedbuffer),
94 "%d.%dGHz", speed/1000, (speed%1000)/100);
101 static unsigned int calc_speed(int mult)
112 static int longhaul_get_cpu_mult(void)
114 unsigned long invalue=0,lo, hi;
116 rdmsr (MSR_IA32_EBL_CR_POWERON, lo, hi);
117 invalue = (lo & (1<<22|1<<23|1<<24|1<<25)) >>22;
118 if (longhaul_version==TYPE_LONGHAUL_V2 || longhaul_version==TYPE_POWERSAVER) {
122 return eblcr_table[invalue];
125 /* For processor with BCR2 MSR */
127 static void do_longhaul1(int cx_address, unsigned int clock_ratio_index)
132 rdmsrl(MSR_VIA_BCR2, bcr2.val);
133 /* Enable software clock multiplier */
134 bcr2.bits.ESOFTBF = 1;
135 bcr2.bits.CLOCKMUL = clock_ratio_index;
137 /* Sync to timer tick */
139 ACPI_FLUSH_CPU_CACHE();
140 /* Change frequency on next halt or sleep */
141 wrmsrl(MSR_VIA_BCR2, bcr2.val);
144 /* Dummy op - must do something useless after P_LVL3 read */
145 t = inl(acpi_fadt.xpm_tmr_blk.address);
147 /* Disable software clock multiplier */
149 rdmsrl(MSR_VIA_BCR2, bcr2.val);
150 bcr2.bits.ESOFTBF = 0;
151 wrmsrl(MSR_VIA_BCR2, bcr2.val);
154 /* For processor with Longhaul MSR */
156 static void do_powersaver(int cx_address, unsigned int clock_ratio_index)
158 union msr_longhaul longhaul;
161 rdmsrl(MSR_VIA_LONGHAUL, longhaul.val);
162 longhaul.bits.RevisionKey = longhaul.bits.RevisionID;
163 longhaul.bits.SoftBusRatio = clock_ratio_index & 0xf;
164 longhaul.bits.SoftBusRatio4 = (clock_ratio_index & 0x10) >> 4;
166 /* Sync to timer tick */
168 ACPI_FLUSH_CPU_CACHE();
169 /* Change frequency on next halt or sleep */
170 wrmsrl(MSR_VIA_LONGHAUL, longhaul.val);
173 /* Dummy op - must do something useless after P_LVL3 read */
174 t = inl(acpi_fadt.xpm_tmr_blk.address);
176 /* Disable bus ratio bit */
178 longhaul.bits.RevisionKey = longhaul.bits.RevisionID;
179 longhaul.bits.EnableSoftBusRatio = 0;
180 longhaul.bits.EnableSoftBSEL = 0;
181 longhaul.bits.EnableSoftVID = 0;
182 wrmsrl(MSR_VIA_LONGHAUL, longhaul.val);
186 * longhaul_set_cpu_frequency()
187 * @clock_ratio_index : bitpattern of the new multiplier.
189 * Sets a new clock ratio.
192 static void longhaul_setstate(unsigned int clock_ratio_index)
195 struct cpufreq_freqs freqs;
196 static unsigned int old_ratio=-1;
198 unsigned int pic1_mask, pic2_mask;
200 if (old_ratio == clock_ratio_index)
202 old_ratio = clock_ratio_index;
204 mult = clock_ratio[clock_ratio_index];
208 speed = calc_speed(mult);
209 if ((speed > highest_speed) || (speed < lowest_speed))
212 freqs.old = calc_speed(longhaul_get_cpu_mult());
214 freqs.cpu = 0; /* longhaul.c is UP only driver */
216 cpufreq_notify_transition(&freqs, CPUFREQ_PRECHANGE);
218 dprintk ("Setting to FSB:%dMHz Mult:%d.%dx (%s)\n",
219 fsb, mult/10, mult%10, print_speed(speed/1000));
222 local_irq_save(flags);
224 pic2_mask = inb(0xA1);
225 pic1_mask = inb(0x21); /* works on C3. save mask. */
226 outb(0xFF,0xA1); /* Overkill */
227 outb(0xFE,0x21); /* TMR0 only */
229 /* Disable bus master arbitration */
230 if (pr->flags.bm_check) {
231 acpi_set_register(ACPI_BITREG_ARB_DISABLE, 1,
232 ACPI_MTX_DO_NOT_LOCK);
235 switch (longhaul_version) {
238 * Longhaul v1. (Samuel[C5A] and Samuel2 stepping 0[C5B])
239 * Software controlled multipliers only.
241 * *NB* Until we get voltage scaling working v1 & v2 are the same code.
242 * Longhaul v2 appears in Samuel2 Steppings 1->7 [C5b] and Ezra [C5C]
244 case TYPE_LONGHAUL_V1:
245 case TYPE_LONGHAUL_V2:
246 do_longhaul1(cx->address, clock_ratio_index);
250 * Longhaul v3 (aka Powersaver). (Ezra-T [C5M] & Nehemiah [C5N])
251 * We can scale voltage with this too, but that's currently
252 * disabled until we come up with a decent 'match freq to voltage'
254 * When we add voltage scaling, we will also need to do the
255 * voltage/freq setting in order depending on the direction
256 * of scaling (like we do in powernow-k7.c)
257 * Nehemiah can do FSB scaling too, but this has never been proven
258 * to work in practice.
260 case TYPE_POWERSAVER:
261 do_powersaver(cx->address, clock_ratio_index);
265 /* Enable bus master arbitration */
266 if (pr->flags.bm_check) {
267 acpi_set_register(ACPI_BITREG_ARB_DISABLE, 0,
268 ACPI_MTX_DO_NOT_LOCK);
271 outb(pic2_mask,0xA1); /* restore mask */
272 outb(pic1_mask,0x21);
274 local_irq_restore(flags);
277 cpufreq_notify_transition(&freqs, CPUFREQ_POSTCHANGE);
281 * Centaur decided to make life a little more tricky.
282 * Only longhaul v1 is allowed to read EBLCR BSEL[0:1].
283 * Samuel2 and above have to try and guess what the FSB is.
284 * We do this by assuming we booted at maximum multiplier, and interpolate
285 * between that value multiplied by possible FSBs and cpu_mhz which
286 * was calculated at boot time. Really ugly, but no other way to do this.
291 static int _guess(int guess)
295 target = ((maxmult/10)*guess);
298 target += ROUNDING/2;
304 static int guess_fsb(void)
306 int speed = (cpu_khz/1000);
308 int speeds[3] = { 66, 100, 133 };
313 for (i=0; i<3; i++) {
314 if (_guess(speeds[i]) == speed)
321 static int __init longhaul_get_ranges(void)
323 unsigned long invalue;
324 unsigned int multipliers[32]= {
325 50,30,40,100,55,35,45,95,90,70,80,60,120,75,85,65,
326 -1,110,120,-1,135,115,125,105,130,150,160,140,-1,155,-1,145 };
327 unsigned int j, k = 0;
328 union msr_longhaul longhaul;
329 unsigned long lo, hi;
330 unsigned int eblcr_fsb_table_v1[] = { 66, 133, 100, -1 };
331 unsigned int eblcr_fsb_table_v2[] = { 133, 100, -1, 66 };
333 switch (longhaul_version) {
334 case TYPE_LONGHAUL_V1:
335 case TYPE_LONGHAUL_V2:
336 /* Ugh, Longhaul v1 didn't have the min/max MSRs.
337 Assume min=3.0x & max = whatever we booted at. */
339 maxmult = longhaul_get_cpu_mult();
340 rdmsr (MSR_IA32_EBL_CR_POWERON, lo, hi);
341 invalue = (lo & (1<<18|1<<19)) >>18;
342 if (cpu_model==CPU_SAMUEL || cpu_model==CPU_SAMUEL2)
343 fsb = eblcr_fsb_table_v1[invalue];
348 case TYPE_POWERSAVER:
350 if (cpu_model==CPU_EZRA_T) {
351 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
352 invalue = longhaul.bits.MaxMHzBR;
353 if (longhaul.bits.MaxMHzBR4)
355 maxmult=multipliers[invalue];
357 invalue = longhaul.bits.MinMHzBR;
358 if (longhaul.bits.MinMHzBR4 == 1)
361 minmult = multipliers[invalue];
362 fsb = eblcr_fsb_table_v2[longhaul.bits.MaxMHzFSB];
367 if (cpu_model==CPU_NEHEMIAH) {
368 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
371 * TODO: This code works, but raises a lot of questions.
372 * - Some Nehemiah's seem to have broken Min/MaxMHzBR's.
373 * We get around this by using a hardcoded multiplier of 4.0x
374 * for the minimimum speed, and the speed we booted up at for the max.
375 * This is done in longhaul_get_cpu_mult() by reading the EBLCR register.
376 * - According to some VIA documentation EBLCR is only
377 * in pre-Nehemiah C3s. How this still works is a mystery.
378 * We're possibly using something undocumented and unsupported,
379 * But it works, so we don't grumble.
382 maxmult=longhaul_get_cpu_mult();
384 /* Starting with the 1.2GHz parts, theres a 200MHz bus. */
385 if ((cpu_khz/1000) > 1200)
388 fsb = eblcr_fsb_table_v2[longhaul.bits.MaxMHzFSB];
393 dprintk ("MinMult:%d.%dx MaxMult:%d.%dx\n",
394 minmult/10, minmult%10, maxmult/10, maxmult%10);
397 printk (KERN_INFO PFX "Invalid (reserved) FSB!\n");
401 highest_speed = calc_speed(maxmult);
402 lowest_speed = calc_speed(minmult);
403 dprintk ("FSB:%dMHz Lowest speed: %s Highest speed:%s\n", fsb,
404 print_speed(lowest_speed/1000),
405 print_speed(highest_speed/1000));
407 if (lowest_speed == highest_speed) {
408 printk (KERN_INFO PFX "highestspeed == lowest, aborting.\n");
411 if (lowest_speed > highest_speed) {
412 printk (KERN_INFO PFX "nonsense! lowest (%d > %d) !\n",
413 lowest_speed, highest_speed);
417 longhaul_table = kmalloc((numscales + 1) * sizeof(struct cpufreq_frequency_table), GFP_KERNEL);
421 for (j=0; j < numscales; j++) {
423 ratio = clock_ratio[j];
426 if (ratio > maxmult || ratio < minmult)
428 longhaul_table[k].frequency = calc_speed(ratio);
429 longhaul_table[k].index = j;
433 longhaul_table[k].frequency = CPUFREQ_TABLE_END;
435 kfree (longhaul_table);
443 static void __init longhaul_setup_voltagescaling(void)
445 union msr_longhaul longhaul;
447 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
449 if (!(longhaul.bits.RevisionID & 1))
452 minvid = longhaul.bits.MinimumVID;
453 maxvid = longhaul.bits.MaximumVID;
454 vrmrev = longhaul.bits.VRMRev;
456 if (minvid == 0 || maxvid == 0) {
457 printk (KERN_INFO PFX "Bogus values Min:%d.%03d Max:%d.%03d. "
458 "Voltage scaling disabled.\n",
459 minvid/1000, minvid%1000, maxvid/1000, maxvid%1000);
463 if (minvid == maxvid) {
464 printk (KERN_INFO PFX "Claims to support voltage scaling but min & max are "
465 "both %d.%03d. Voltage scaling disabled\n",
466 maxvid/1000, maxvid%1000);
471 dprintk ("VRM 8.5\n");
472 memcpy (voltage_table, vrm85scales, sizeof(voltage_table));
473 numvscales = (voltage_table[maxvid]-voltage_table[minvid])/25;
475 dprintk ("Mobile VRM\n");
476 memcpy (voltage_table, mobilevrmscales, sizeof(voltage_table));
477 numvscales = (voltage_table[maxvid]-voltage_table[minvid])/5;
480 /* Current voltage isn't readable at first, so we need to
481 set it to a known value. The spec says to use maxvid */
482 longhaul.bits.RevisionKey = longhaul.bits.RevisionID; /* FIXME: This is bad. */
483 longhaul.bits.EnableSoftVID = 1;
484 longhaul.bits.SoftVID = maxvid;
485 wrmsrl (MSR_VIA_LONGHAUL, longhaul.val);
487 minvid = voltage_table[minvid];
488 maxvid = voltage_table[maxvid];
490 dprintk ("Min VID=%d.%03d Max VID=%d.%03d, %d possible voltage scales\n",
491 maxvid/1000, maxvid%1000, minvid/1000, minvid%1000, numvscales);
493 can_scale_voltage = 1;
497 static int longhaul_verify(struct cpufreq_policy *policy)
499 return cpufreq_frequency_table_verify(policy, longhaul_table);
503 static int longhaul_target(struct cpufreq_policy *policy,
504 unsigned int target_freq, unsigned int relation)
506 unsigned int table_index = 0;
507 unsigned int new_clock_ratio = 0;
509 if (cpufreq_frequency_table_target(policy, longhaul_table, target_freq, relation, &table_index))
512 new_clock_ratio = longhaul_table[table_index].index & 0xFF;
514 longhaul_setstate(new_clock_ratio);
520 static unsigned int longhaul_get(unsigned int cpu)
524 return calc_speed(longhaul_get_cpu_mult());
527 acpi_status longhaul_walk_callback(acpi_handle obj_handle,
529 void *context, void **return_value)
531 struct acpi_device *d;
533 if ( acpi_bus_get_device(obj_handle, &d) ) {
536 *return_value = (void *)acpi_driver_data(d);
540 static int __init longhaul_cpu_init(struct cpufreq_policy *policy)
542 struct cpuinfo_x86 *c = cpu_data;
546 /* Check ACPI support for C3 state */
547 acpi_walk_namespace(ACPI_TYPE_PROCESSOR, ACPI_ROOT_OBJECT, ACPI_UINT32_MAX,
548 &longhaul_walk_callback, NULL, (void *)&pr);
549 if (pr == NULL) goto err_acpi;
551 cx = &pr->power.states[ACPI_STATE_C3];
552 if (cx == NULL || cx->latency > 1000) goto err_acpi;
554 /* Now check what we have on this motherboard */
555 switch (c->x86_model) {
557 cpu_model = CPU_SAMUEL;
558 cpuname = "C3 'Samuel' [C5A]";
559 longhaul_version = TYPE_LONGHAUL_V1;
560 memcpy (clock_ratio, samuel1_clock_ratio, sizeof(samuel1_clock_ratio));
561 memcpy (eblcr_table, samuel1_eblcr, sizeof(samuel1_eblcr));
565 longhaul_version = TYPE_LONGHAUL_V1;
566 switch (c->x86_mask) {
568 cpu_model = CPU_SAMUEL2;
569 cpuname = "C3 'Samuel 2' [C5B]";
570 /* Note, this is not a typo, early Samuel2's had Samuel1 ratios. */
571 memcpy (clock_ratio, samuel1_clock_ratio, sizeof(samuel1_clock_ratio));
572 memcpy (eblcr_table, samuel2_eblcr, sizeof(samuel2_eblcr));
575 if (c->x86_mask < 8) {
576 cpu_model = CPU_SAMUEL2;
577 cpuname = "C3 'Samuel 2' [C5B]";
579 cpu_model = CPU_EZRA;
580 cpuname = "C3 'Ezra' [C5C]";
582 memcpy (clock_ratio, ezra_clock_ratio, sizeof(ezra_clock_ratio));
583 memcpy (eblcr_table, ezra_eblcr, sizeof(ezra_eblcr));
589 cpu_model = CPU_EZRA_T;
590 cpuname = "C3 'Ezra-T' [C5M]";
591 longhaul_version = TYPE_POWERSAVER;
593 memcpy (clock_ratio, ezrat_clock_ratio, sizeof(ezrat_clock_ratio));
594 memcpy (eblcr_table, ezrat_eblcr, sizeof(ezrat_eblcr));
598 cpu_model = CPU_NEHEMIAH;
599 longhaul_version = TYPE_POWERSAVER;
601 switch (c->x86_mask) {
603 cpuname = "C3 'Nehemiah A' [C5N]";
604 memcpy (clock_ratio, nehemiah_a_clock_ratio, sizeof(nehemiah_a_clock_ratio));
605 memcpy (eblcr_table, nehemiah_a_eblcr, sizeof(nehemiah_a_eblcr));
608 cpuname = "C3 'Nehemiah B' [C5N]";
609 memcpy (clock_ratio, nehemiah_b_clock_ratio, sizeof(nehemiah_b_clock_ratio));
610 memcpy (eblcr_table, nehemiah_b_eblcr, sizeof(nehemiah_b_eblcr));
613 cpuname = "C3 'Nehemiah C' [C5N]";
614 memcpy (clock_ratio, nehemiah_c_clock_ratio, sizeof(nehemiah_c_clock_ratio));
615 memcpy (eblcr_table, nehemiah_c_eblcr, sizeof(nehemiah_c_eblcr));
625 printk (KERN_INFO PFX "VIA %s CPU detected. ", cpuname);
626 switch (longhaul_version) {
627 case TYPE_LONGHAUL_V1:
628 case TYPE_LONGHAUL_V2:
629 printk ("Longhaul v%d supported.\n", longhaul_version);
631 case TYPE_POWERSAVER:
632 printk ("Powersaver supported.\n");
636 ret = longhaul_get_ranges();
640 if ((longhaul_version==TYPE_LONGHAUL_V2 || longhaul_version==TYPE_POWERSAVER) &&
641 (dont_scale_voltage==0))
642 longhaul_setup_voltagescaling();
644 policy->governor = CPUFREQ_DEFAULT_GOVERNOR;
645 policy->cpuinfo.transition_latency = 200000; /* nsec */
646 policy->cur = calc_speed(longhaul_get_cpu_mult());
648 ret = cpufreq_frequency_table_cpuinfo(policy, longhaul_table);
652 cpufreq_frequency_table_get_attr(longhaul_table, policy->cpu);
657 printk(KERN_ERR PFX "No ACPI support for CPU frequency changes.\n");
661 static int __devexit longhaul_cpu_exit(struct cpufreq_policy *policy)
663 cpufreq_frequency_table_put_attr(policy->cpu);
667 static struct freq_attr* longhaul_attr[] = {
668 &cpufreq_freq_attr_scaling_available_freqs,
672 static struct cpufreq_driver longhaul_driver = {
673 .verify = longhaul_verify,
674 .target = longhaul_target,
676 .init = longhaul_cpu_init,
677 .exit = __devexit_p(longhaul_cpu_exit),
679 .owner = THIS_MODULE,
680 .attr = longhaul_attr,
684 static int __init longhaul_init(void)
686 struct cpuinfo_x86 *c = cpu_data;
688 if (c->x86_vendor != X86_VENDOR_CENTAUR || c->x86 != 6)
692 if (num_online_cpus() > 1) {
694 printk(KERN_ERR PFX "More than 1 CPU detected, longhaul disabled.\n");
697 #ifdef CONFIG_X86_IO_APIC
699 printk(KERN_ERR PFX "APIC detected. Longhaul is currently broken in this configuration.\n");
703 switch (c->x86_model) {
705 return cpufreq_register_driver(&longhaul_driver);
707 printk (KERN_INFO PFX "Unknown VIA CPU. Contact davej@codemonkey.org.uk\n");
714 static void __exit longhaul_exit(void)
718 for (i=0; i < numscales; i++) {
719 if (clock_ratio[i] == maxmult) {
720 longhaul_setstate(i);
725 cpufreq_unregister_driver(&longhaul_driver);
726 kfree(longhaul_table);
729 module_param (dont_scale_voltage, int, 0644);
730 MODULE_PARM_DESC(dont_scale_voltage, "Don't scale voltage of processor");
732 MODULE_AUTHOR ("Dave Jones <davej@codemonkey.org.uk>");
733 MODULE_DESCRIPTION ("Longhaul driver for VIA Cyrix processors.");
734 MODULE_LICENSE ("GPL");
736 late_initcall(longhaul_init);
737 module_exit(longhaul_exit);