2 * linux/drivers/clocksource/acpi_pm.c
4 * This file contains the ACPI PM based clocksource.
6 * This code was largely moved from the i386 timer_pm.c file
7 * which was (C) Dominik Brodowski <linux@brodo.de> 2003
8 * and contained the following comments:
10 * Driver to use the Power Management Timer (PMTMR) available in some
11 * southbridges as primary timing source for the Linux kernel.
13 * Based on parts of linux/drivers/acpi/hardware/hwtimer.c, timer_pit.c,
14 * timer_hpet.c, and on Arjan van de Ven's implementation for 2.4.
16 * This file is licensed under the GPL v2.
19 #include <linux/acpi_pmtmr.h>
20 #include <linux/clocksource.h>
21 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/pci.h>
27 * The I/O port the PMTMR resides at.
28 * The location is detected during setup_arch(),
29 * in arch/i386/kernel/acpi/boot.c
31 u32 pmtmr_ioport __read_mostly;
33 static inline u32 read_pmtmr(void)
35 /* mask the output to 24 bits */
36 return inl(pmtmr_ioport) & ACPI_PM_MASK;
39 u32 acpi_pm_read_verified(void)
41 u32 v1 = 0, v2 = 0, v3 = 0;
44 * It has been reported that because of various broken
45 * chipsets (ICH4, PIIX4 and PIIX4E) where the ACPI PM clock
46 * source is not latched, you must read it multiple
47 * times to ensure a safe value is read:
53 } while (unlikely((v1 > v2 && v1 < v3) || (v2 > v3 && v2 < v1)
54 || (v3 > v1 && v3 < v2)));
59 static cycle_t acpi_pm_read_slow(void)
61 return (cycle_t)acpi_pm_read_verified();
64 static cycle_t acpi_pm_read(void)
66 return (cycle_t)read_pmtmr();
69 static struct clocksource clocksource_acpi_pm = {
73 .mask = (cycle_t)ACPI_PM_MASK,
74 .mult = 0, /*to be calculated*/
76 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
82 static int __devinitdata acpi_pm_good;
83 static int __init acpi_pm_good_setup(char *__str)
88 __setup("acpi_pm_good", acpi_pm_good_setup);
90 static inline void acpi_pm_need_workaround(void)
92 clocksource_acpi_pm.read = acpi_pm_read_slow;
93 clocksource_acpi_pm.rating = 120;
99 * The power management timer may return improper results when read.
100 * Although the timer value settles properly after incrementing,
101 * while incrementing there is a 3 ns window every 69.8 ns where the
102 * timer value is indeterminate (a 4.2% chance that the data will be
103 * incorrect when read). As a result, the ACPI free running count up
104 * timer specification is violated due to erroneous reads.
106 static void __devinit acpi_pm_check_blacklist(struct pci_dev *dev)
111 /* the bug has been fixed in PIIX4M */
112 if (dev->revision < 3) {
113 printk(KERN_WARNING "* Found PM-Timer Bug on the chipset."
114 " Due to workarounds for a bug,\n"
115 "* this clock source is slow. Consider trying"
116 " other clock sources\n");
118 acpi_pm_need_workaround();
121 DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82371AB_3,
122 acpi_pm_check_blacklist);
124 static void __devinit acpi_pm_check_graylist(struct pci_dev *dev)
129 printk(KERN_WARNING "* The chipset may have PM-Timer Bug. Due to"
130 " workarounds for a bug,\n"
131 "* this clock source is slow. If you are sure your timer"
133 "* this bug, please use \"acpi_pm_good\" to disable the"
136 acpi_pm_need_workaround();
138 DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_0,
139 acpi_pm_check_graylist);
140 DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_LE,
141 acpi_pm_check_graylist);
144 #ifndef CONFIG_X86_64
145 #include "mach_timer.h"
146 #define PMTMR_EXPECTED_RATE \
147 ((CALIBRATE_LATCH * (PMTMR_TICKS_PER_SEC >> 10)) / (CLOCK_TICK_RATE>>10))
149 * Some boards have the PMTMR running way too fast. We check
150 * the PMTMR rate against PIT channel 2 to catch these cases.
152 static int verify_pmtmr_rate(void)
155 unsigned long count, delta;
157 mach_prepare_counter();
158 value1 = read_pmtmr();
159 mach_countup(&count);
160 value2 = read_pmtmr();
161 delta = (value2 - value1) & ACPI_PM_MASK;
163 /* Check that the PMTMR delta is within 5% of what we expect */
164 if (delta < (PMTMR_EXPECTED_RATE * 19) / 20 ||
165 delta > (PMTMR_EXPECTED_RATE * 21) / 20) {
166 printk(KERN_INFO "PM-Timer running at invalid rate: %lu%% "
167 "of normal - aborting.\n",
168 100UL * delta / PMTMR_EXPECTED_RATE);
175 #define verify_pmtmr_rate() (0)
178 static int __init init_acpi_pm_clocksource(void)
186 clocksource_acpi_pm.mult = clocksource_hz2mult(PMTMR_TICKS_PER_SEC,
187 clocksource_acpi_pm.shift);
189 /* "verify" this timing source: */
190 value1 = read_pmtmr();
191 for (i = 0; i < 10000; i++) {
192 value2 = read_pmtmr();
193 if (value2 == value1)
197 if ((value2 < value1) && ((value2) < 0xFFF))
199 printk(KERN_INFO "PM-Timer had inconsistent results:"
200 " 0x%#x, 0x%#x - aborting.\n", value1, value2);
203 printk(KERN_INFO "PM-Timer had no reasonable result:"
204 " 0x%#x - aborting.\n", value1);
208 if (verify_pmtmr_rate() != 0)
211 return clocksource_register(&clocksource_acpi_pm);
214 /* We use fs_initcall because we want the PCI fixups to have run
215 * but we still need to load before device_initcall
217 fs_initcall(init_acpi_pm_clocksource);
220 * Allow an override of the IOPort. Stupid BIOSes do not tell us about
221 * the PMTimer, but we might know where it is.
223 static int __init parse_pmtmr(char *arg)
227 if (strict_strtoul(arg, 16, &base))
230 printk(KERN_INFO "PMTMR IOPort override: 0x%04lx -> 0x%04lx\n",
236 __setup("pmtmr=", parse_pmtmr);