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/pci.h>
31 #include <linux/slab.h>
32 #include <linux/string.h>
35 #include <asm/timex.h>
38 #include <linux/acpi.h>
39 #include <acpi/processor.h>
43 #define PFX "longhaul: "
45 #define TYPE_LONGHAUL_V1 1
46 #define TYPE_LONGHAUL_V2 2
47 #define TYPE_POWERSAVER 3
53 #define CPU_NEHEMIAH 5
56 static unsigned int numscales=16, numvscales;
57 static unsigned int fsb;
58 static int minvid, maxvid;
59 static unsigned int minmult, maxmult;
60 static int can_scale_voltage;
62 static struct acpi_processor *pr = NULL;
63 static struct acpi_processor_cx *cx = NULL;
64 static int port22_en = 0;
66 /* Module parameters */
67 static int dont_scale_voltage;
70 #define dprintk(msg...) cpufreq_debug_printk(CPUFREQ_DEBUG_DRIVER, "longhaul", msg)
73 /* Clock ratios multiplied by 10 */
74 static int clock_ratio[32];
75 static int eblcr_table[32];
76 static int voltage_table[32];
77 static unsigned int highest_speed, lowest_speed; /* kHz */
78 static int longhaul_version;
79 static struct cpufreq_frequency_table *longhaul_table;
81 #ifdef CONFIG_CPU_FREQ_DEBUG
82 static char speedbuffer[8];
84 static char *print_speed(int speed)
87 snprintf(speedbuffer, sizeof(speedbuffer),"%dMHz", speed);
92 snprintf(speedbuffer, sizeof(speedbuffer),
95 snprintf(speedbuffer, sizeof(speedbuffer),
96 "%d.%dGHz", speed/1000, (speed%1000)/100);
103 static unsigned int calc_speed(int mult)
114 static int longhaul_get_cpu_mult(void)
116 unsigned long invalue=0,lo, hi;
118 rdmsr (MSR_IA32_EBL_CR_POWERON, lo, hi);
119 invalue = (lo & (1<<22|1<<23|1<<24|1<<25)) >>22;
120 if (longhaul_version==TYPE_LONGHAUL_V2 || longhaul_version==TYPE_POWERSAVER) {
124 return eblcr_table[invalue];
127 /* For processor with BCR2 MSR */
129 static void do_longhaul1(unsigned int clock_ratio_index)
133 rdmsrl(MSR_VIA_BCR2, bcr2.val);
134 /* Enable software clock multiplier */
135 bcr2.bits.ESOFTBF = 1;
136 bcr2.bits.CLOCKMUL = clock_ratio_index;
138 /* Sync to timer tick */
140 /* Change frequency on next halt or sleep */
141 wrmsrl(MSR_VIA_BCR2, bcr2.val);
142 /* Invoke transition */
143 ACPI_FLUSH_CPU_CACHE();
146 /* Disable software clock multiplier */
148 rdmsrl(MSR_VIA_BCR2, bcr2.val);
149 bcr2.bits.ESOFTBF = 0;
150 wrmsrl(MSR_VIA_BCR2, bcr2.val);
153 /* For processor with Longhaul MSR */
155 static void do_powersaver(int cx_address, unsigned int clock_ratio_index)
157 union msr_longhaul longhaul;
160 rdmsrl(MSR_VIA_LONGHAUL, longhaul.val);
161 longhaul.bits.RevisionKey = longhaul.bits.RevisionID;
162 longhaul.bits.SoftBusRatio = clock_ratio_index & 0xf;
163 longhaul.bits.SoftBusRatio4 = (clock_ratio_index & 0x10) >> 4;
164 longhaul.bits.EnableSoftBusRatio = 1;
166 /* Sync to timer tick */
168 /* Change frequency on next halt or sleep */
169 wrmsrl(MSR_VIA_LONGHAUL, longhaul.val);
170 ACPI_FLUSH_CPU_CACHE();
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 if (pr->flags.bm_control) {
230 /* Disable bus master arbitration */
231 acpi_set_register(ACPI_BITREG_ARB_DISABLE, 1,
232 ACPI_MTX_DO_NOT_LOCK);
233 } else if (port22_en) {
234 /* Disable AGP and PCI arbiters */
238 switch (longhaul_version) {
241 * Longhaul v1. (Samuel[C5A] and Samuel2 stepping 0[C5B])
242 * Software controlled multipliers only.
244 * *NB* Until we get voltage scaling working v1 & v2 are the same code.
245 * Longhaul v2 appears in Samuel2 Steppings 1->7 [C5b] and Ezra [C5C]
247 case TYPE_LONGHAUL_V1:
248 case TYPE_LONGHAUL_V2:
249 do_longhaul1(clock_ratio_index);
253 * Longhaul v3 (aka Powersaver). (Ezra-T [C5M] & Nehemiah [C5N])
254 * We can scale voltage with this too, but that's currently
255 * disabled until we come up with a decent 'match freq to voltage'
257 * When we add voltage scaling, we will also need to do the
258 * voltage/freq setting in order depending on the direction
259 * of scaling (like we do in powernow-k7.c)
260 * Nehemiah can do FSB scaling too, but this has never been proven
261 * to work in practice.
263 case TYPE_POWERSAVER:
264 /* Don't allow wakeup */
265 acpi_set_register(ACPI_BITREG_BUS_MASTER_RLD, 0,
266 ACPI_MTX_DO_NOT_LOCK);
267 do_powersaver(cx->address, clock_ratio_index);
271 if (pr->flags.bm_control) {
272 /* Enable bus master arbitration */
273 acpi_set_register(ACPI_BITREG_ARB_DISABLE, 0,
274 ACPI_MTX_DO_NOT_LOCK);
275 } else if (port22_en) {
276 /* Enable arbiters */
280 outb(pic2_mask,0xA1); /* restore mask */
281 outb(pic1_mask,0x21);
283 local_irq_restore(flags);
286 cpufreq_notify_transition(&freqs, CPUFREQ_POSTCHANGE);
290 * Centaur decided to make life a little more tricky.
291 * Only longhaul v1 is allowed to read EBLCR BSEL[0:1].
292 * Samuel2 and above have to try and guess what the FSB is.
293 * We do this by assuming we booted at maximum multiplier, and interpolate
294 * between that value multiplied by possible FSBs and cpu_mhz which
295 * was calculated at boot time. Really ugly, but no other way to do this.
300 static int _guess(int guess)
304 target = ((maxmult/10)*guess);
307 target += ROUNDING/2;
313 static int guess_fsb(void)
315 int speed = (cpu_khz/1000);
317 int speeds[3] = { 66, 100, 133 };
322 for (i=0; i<3; i++) {
323 if (_guess(speeds[i]) == speed)
330 static int __init longhaul_get_ranges(void)
332 unsigned long invalue;
333 unsigned int ezra_t_multipliers[32]= {
334 90, 30, 40, 100, 55, 35, 45, 95,
335 50, 70, 80, 60, 120, 75, 85, 65,
336 -1, 110, 120, -1, 135, 115, 125, 105,
337 130, 150, 160, 140, -1, 155, -1, 145 };
338 unsigned int j, k = 0;
339 union msr_longhaul longhaul;
340 unsigned long lo, hi;
341 unsigned int eblcr_fsb_table_v1[] = { 66, 133, 100, -1 };
342 unsigned int eblcr_fsb_table_v2[] = { 133, 100, -1, 66 };
344 switch (longhaul_version) {
345 case TYPE_LONGHAUL_V1:
346 case TYPE_LONGHAUL_V2:
347 /* Ugh, Longhaul v1 didn't have the min/max MSRs.
348 Assume min=3.0x & max = whatever we booted at. */
350 maxmult = longhaul_get_cpu_mult();
351 rdmsr (MSR_IA32_EBL_CR_POWERON, lo, hi);
352 invalue = (lo & (1<<18|1<<19)) >>18;
353 if (cpu_model==CPU_SAMUEL || cpu_model==CPU_SAMUEL2)
354 fsb = eblcr_fsb_table_v1[invalue];
359 case TYPE_POWERSAVER:
361 if (cpu_model==CPU_EZRA_T) {
362 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
363 invalue = longhaul.bits.MaxMHzBR;
364 if (longhaul.bits.MaxMHzBR4)
366 maxmult=ezra_t_multipliers[invalue];
368 invalue = longhaul.bits.MinMHzBR;
369 if (longhaul.bits.MinMHzBR4 == 1)
372 minmult = ezra_t_multipliers[invalue];
373 fsb = eblcr_fsb_table_v2[longhaul.bits.MaxMHzFSB];
378 if (cpu_model==CPU_NEHEMIAH) {
379 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
382 * TODO: This code works, but raises a lot of questions.
383 * - Some Nehemiah's seem to have broken Min/MaxMHzBR's.
384 * We get around this by using a hardcoded multiplier of 4.0x
385 * for the minimimum speed, and the speed we booted up at for the max.
386 * This is done in longhaul_get_cpu_mult() by reading the EBLCR register.
387 * - According to some VIA documentation EBLCR is only
388 * in pre-Nehemiah C3s. How this still works is a mystery.
389 * We're possibly using something undocumented and unsupported,
390 * But it works, so we don't grumble.
393 maxmult=longhaul_get_cpu_mult();
395 /* Starting with the 1.2GHz parts, theres a 200MHz bus. */
396 if ((cpu_khz/1000) > 1200)
399 fsb = eblcr_fsb_table_v2[longhaul.bits.MaxMHzFSB];
404 dprintk ("MinMult:%d.%dx MaxMult:%d.%dx\n",
405 minmult/10, minmult%10, maxmult/10, maxmult%10);
408 printk (KERN_INFO PFX "Invalid (reserved) FSB!\n");
412 highest_speed = calc_speed(maxmult);
413 lowest_speed = calc_speed(minmult);
414 dprintk ("FSB:%dMHz Lowest speed: %s Highest speed:%s\n", fsb,
415 print_speed(lowest_speed/1000),
416 print_speed(highest_speed/1000));
418 if (lowest_speed == highest_speed) {
419 printk (KERN_INFO PFX "highestspeed == lowest, aborting.\n");
422 if (lowest_speed > highest_speed) {
423 printk (KERN_INFO PFX "nonsense! lowest (%d > %d) !\n",
424 lowest_speed, highest_speed);
428 longhaul_table = kmalloc((numscales + 1) * sizeof(struct cpufreq_frequency_table), GFP_KERNEL);
432 for (j=0; j < numscales; j++) {
434 ratio = clock_ratio[j];
437 if (ratio > maxmult || ratio < minmult)
439 longhaul_table[k].frequency = calc_speed(ratio);
440 longhaul_table[k].index = j;
444 longhaul_table[k].frequency = CPUFREQ_TABLE_END;
446 kfree (longhaul_table);
454 static void __init longhaul_setup_voltagescaling(void)
456 union msr_longhaul longhaul;
458 rdmsrl (MSR_VIA_LONGHAUL, longhaul.val);
460 if (!(longhaul.bits.RevisionID & 1))
463 minvid = longhaul.bits.MinimumVID;
464 maxvid = longhaul.bits.MaximumVID;
465 vrmrev = longhaul.bits.VRMRev;
467 if (minvid == 0 || maxvid == 0) {
468 printk (KERN_INFO PFX "Bogus values Min:%d.%03d Max:%d.%03d. "
469 "Voltage scaling disabled.\n",
470 minvid/1000, minvid%1000, maxvid/1000, maxvid%1000);
474 if (minvid == maxvid) {
475 printk (KERN_INFO PFX "Claims to support voltage scaling but min & max are "
476 "both %d.%03d. Voltage scaling disabled\n",
477 maxvid/1000, maxvid%1000);
482 dprintk ("VRM 8.5\n");
483 memcpy (voltage_table, vrm85scales, sizeof(voltage_table));
484 numvscales = (voltage_table[maxvid]-voltage_table[minvid])/25;
486 dprintk ("Mobile VRM\n");
487 memcpy (voltage_table, mobilevrmscales, sizeof(voltage_table));
488 numvscales = (voltage_table[maxvid]-voltage_table[minvid])/5;
491 /* Current voltage isn't readable at first, so we need to
492 set it to a known value. The spec says to use maxvid */
493 longhaul.bits.RevisionKey = longhaul.bits.RevisionID; /* FIXME: This is bad. */
494 longhaul.bits.EnableSoftVID = 1;
495 longhaul.bits.SoftVID = maxvid;
496 wrmsrl (MSR_VIA_LONGHAUL, longhaul.val);
498 minvid = voltage_table[minvid];
499 maxvid = voltage_table[maxvid];
501 dprintk ("Min VID=%d.%03d Max VID=%d.%03d, %d possible voltage scales\n",
502 maxvid/1000, maxvid%1000, minvid/1000, minvid%1000, numvscales);
504 can_scale_voltage = 1;
508 static int longhaul_verify(struct cpufreq_policy *policy)
510 return cpufreq_frequency_table_verify(policy, longhaul_table);
514 static int longhaul_target(struct cpufreq_policy *policy,
515 unsigned int target_freq, unsigned int relation)
517 unsigned int table_index = 0;
518 unsigned int new_clock_ratio = 0;
520 if (cpufreq_frequency_table_target(policy, longhaul_table, target_freq, relation, &table_index))
523 new_clock_ratio = longhaul_table[table_index].index & 0xFF;
525 longhaul_setstate(new_clock_ratio);
531 static unsigned int longhaul_get(unsigned int cpu)
535 return calc_speed(longhaul_get_cpu_mult());
538 static acpi_status longhaul_walk_callback(acpi_handle obj_handle,
540 void *context, void **return_value)
542 struct acpi_device *d;
544 if ( acpi_bus_get_device(obj_handle, &d) ) {
547 *return_value = (void *)acpi_driver_data(d);
551 /* VIA don't support PM2 reg, but have something similar */
552 static int enable_arbiter_disable(void)
557 /* Find PLE133 host bridge */
558 dev = pci_find_device(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8601_0, NULL);
560 /* Enable access to port 0x22 */
561 pci_read_config_byte(dev, 0x78, &pci_cmd);
562 if ( !(pci_cmd & 1<<7) ) {
564 pci_write_config_byte(dev, 0x78, pci_cmd);
571 static int __init longhaul_cpu_init(struct cpufreq_policy *policy)
573 struct cpuinfo_x86 *c = cpu_data;
577 /* Check what we have on this motherboard */
578 switch (c->x86_model) {
580 cpu_model = CPU_SAMUEL;
581 cpuname = "C3 'Samuel' [C5A]";
582 longhaul_version = TYPE_LONGHAUL_V1;
583 memcpy (clock_ratio, samuel1_clock_ratio, sizeof(samuel1_clock_ratio));
584 memcpy (eblcr_table, samuel1_eblcr, sizeof(samuel1_eblcr));
588 longhaul_version = TYPE_LONGHAUL_V1;
589 switch (c->x86_mask) {
591 cpu_model = CPU_SAMUEL2;
592 cpuname = "C3 'Samuel 2' [C5B]";
593 /* Note, this is not a typo, early Samuel2's had Samuel1 ratios. */
594 memcpy (clock_ratio, samuel1_clock_ratio, sizeof(samuel1_clock_ratio));
595 memcpy (eblcr_table, samuel2_eblcr, sizeof(samuel2_eblcr));
598 if (c->x86_mask < 8) {
599 cpu_model = CPU_SAMUEL2;
600 cpuname = "C3 'Samuel 2' [C5B]";
602 cpu_model = CPU_EZRA;
603 cpuname = "C3 'Ezra' [C5C]";
605 memcpy (clock_ratio, ezra_clock_ratio, sizeof(ezra_clock_ratio));
606 memcpy (eblcr_table, ezra_eblcr, sizeof(ezra_eblcr));
612 cpu_model = CPU_EZRA_T;
613 cpuname = "C3 'Ezra-T' [C5M]";
614 longhaul_version = TYPE_POWERSAVER;
616 memcpy (clock_ratio, ezrat_clock_ratio, sizeof(ezrat_clock_ratio));
617 memcpy (eblcr_table, ezrat_eblcr, sizeof(ezrat_eblcr));
621 cpu_model = CPU_NEHEMIAH;
622 longhaul_version = TYPE_POWERSAVER;
624 switch (c->x86_mask) {
626 cpuname = "C3 'Nehemiah A' [C5N]";
627 memcpy (clock_ratio, nehemiah_a_clock_ratio, sizeof(nehemiah_a_clock_ratio));
628 memcpy (eblcr_table, nehemiah_a_eblcr, sizeof(nehemiah_a_eblcr));
631 cpuname = "C3 'Nehemiah B' [C5N]";
632 memcpy (clock_ratio, nehemiah_b_clock_ratio, sizeof(nehemiah_b_clock_ratio));
633 memcpy (eblcr_table, nehemiah_b_eblcr, sizeof(nehemiah_b_eblcr));
636 cpuname = "C3 'Nehemiah C' [C5N]";
637 memcpy (clock_ratio, nehemiah_c_clock_ratio, sizeof(nehemiah_c_clock_ratio));
638 memcpy (eblcr_table, nehemiah_c_eblcr, sizeof(nehemiah_c_eblcr));
648 printk (KERN_INFO PFX "VIA %s CPU detected. ", cpuname);
649 switch (longhaul_version) {
650 case TYPE_LONGHAUL_V1:
651 case TYPE_LONGHAUL_V2:
652 printk ("Longhaul v%d supported.\n", longhaul_version);
654 case TYPE_POWERSAVER:
655 printk ("Powersaver supported.\n");
659 /* Find ACPI data for processor */
660 acpi_walk_namespace(ACPI_TYPE_PROCESSOR, ACPI_ROOT_OBJECT, ACPI_UINT32_MAX,
661 &longhaul_walk_callback, NULL, (void *)&pr);
665 if (longhaul_version == TYPE_POWERSAVER) {
666 /* Check ACPI support for C3 state */
667 cx = &pr->power.states[ACPI_STATE_C3];
668 if (cx->address == 0 || cx->latency > 1000)
671 /* Check ACPI support for bus master arbiter disable */
672 if (!pr->flags.bm_control) {
673 if (!enable_arbiter_disable()) {
674 printk(KERN_ERR PFX "No ACPI support. No VT8601 host bridge. Aborting.\n");
681 ret = longhaul_get_ranges();
685 if ((longhaul_version==TYPE_LONGHAUL_V2 || longhaul_version==TYPE_POWERSAVER) &&
686 (dont_scale_voltage==0))
687 longhaul_setup_voltagescaling();
689 policy->governor = CPUFREQ_DEFAULT_GOVERNOR;
690 policy->cpuinfo.transition_latency = 200000; /* nsec */
691 policy->cur = calc_speed(longhaul_get_cpu_mult());
693 ret = cpufreq_frequency_table_cpuinfo(policy, longhaul_table);
697 cpufreq_frequency_table_get_attr(longhaul_table, policy->cpu);
702 printk(KERN_ERR PFX "No ACPI support for CPU frequency changes.\n");
706 static int __devexit longhaul_cpu_exit(struct cpufreq_policy *policy)
708 cpufreq_frequency_table_put_attr(policy->cpu);
712 static struct freq_attr* longhaul_attr[] = {
713 &cpufreq_freq_attr_scaling_available_freqs,
717 static struct cpufreq_driver longhaul_driver = {
718 .verify = longhaul_verify,
719 .target = longhaul_target,
721 .init = longhaul_cpu_init,
722 .exit = __devexit_p(longhaul_cpu_exit),
724 .owner = THIS_MODULE,
725 .attr = longhaul_attr,
729 static int __init longhaul_init(void)
731 struct cpuinfo_x86 *c = cpu_data;
733 if (c->x86_vendor != X86_VENDOR_CENTAUR || c->x86 != 6)
737 if (num_online_cpus() > 1) {
739 printk(KERN_ERR PFX "More than 1 CPU detected, longhaul disabled.\n");
742 #ifdef CONFIG_X86_IO_APIC
744 printk(KERN_ERR PFX "APIC detected. Longhaul is currently broken in this configuration.\n");
748 switch (c->x86_model) {
750 return cpufreq_register_driver(&longhaul_driver);
752 printk (KERN_INFO PFX "Unknown VIA CPU. Contact davej@codemonkey.org.uk\n");
759 static void __exit longhaul_exit(void)
763 for (i=0; i < numscales; i++) {
764 if (clock_ratio[i] == maxmult) {
765 longhaul_setstate(i);
770 cpufreq_unregister_driver(&longhaul_driver);
771 kfree(longhaul_table);
774 module_param (dont_scale_voltage, int, 0644);
775 MODULE_PARM_DESC(dont_scale_voltage, "Don't scale voltage of processor");
777 MODULE_AUTHOR ("Dave Jones <davej@codemonkey.org.uk>");
778 MODULE_DESCRIPTION ("Longhaul driver for VIA Cyrix processors.");
779 MODULE_LICENSE ("GPL");
781 late_initcall(longhaul_init);
782 module_exit(longhaul_exit);