blob: 5cfcff532545b019e3f984dbf3de5273b91d464b [file] [log] [blame]
john stultz5d0cf412006-06-26 00:25:12 -07001/*
2 * linux/drivers/clocksource/acpi_pm.c
3 *
4 * This file contains the ACPI PM based clocksource.
5 *
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:
9 *
10 * Driver to use the Power Management Timer (PMTMR) available in some
11 * southbridges as primary timing source for the Linux kernel.
12 *
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.
15 *
16 * This file is licensed under the GPL v2.
17 */
18
Thomas Gleixnerd66bea52007-02-16 01:27:57 -080019#include <linux/acpi_pmtmr.h>
john stultz5d0cf412006-06-26 00:25:12 -070020#include <linux/clocksource.h>
21#include <linux/errno.h>
22#include <linux/init.h>
23#include <linux/pci.h>
24#include <asm/io.h>
25
john stultz5d0cf412006-06-26 00:25:12 -070026/*
27 * The I/O port the PMTMR resides at.
28 * The location is detected during setup_arch(),
Daniel Walker8ce8e2f2007-04-25 14:27:06 -040029 * in arch/i386/kernel/acpi/boot.c
john stultz5d0cf412006-06-26 00:25:12 -070030 */
Andreas Mohr7d622d42006-06-26 00:25:14 -070031u32 pmtmr_ioport __read_mostly;
john stultz5d0cf412006-06-26 00:25:12 -070032
john stultz5d0cf412006-06-26 00:25:12 -070033static inline u32 read_pmtmr(void)
34{
35 /* mask the output to 24 bits */
36 return inl(pmtmr_ioport) & ACPI_PM_MASK;
37}
38
Thomas Gleixnerd66bea52007-02-16 01:27:57 -080039u32 acpi_pm_read_verified(void)
john stultz5d0cf412006-06-26 00:25:12 -070040{
41 u32 v1 = 0, v2 = 0, v3 = 0;
42
43 /*
44 * It has been reported that because of various broken
45 * chipsets (ICH4, PIIX4 and PIIX4E) where the ACPI PM clock
Andreas Mohr7d622d42006-06-26 00:25:14 -070046 * source is not latched, you must read it multiple
john stultz5d0cf412006-06-26 00:25:12 -070047 * times to ensure a safe value is read:
48 */
49 do {
50 v1 = read_pmtmr();
51 v2 = read_pmtmr();
52 v3 = read_pmtmr();
Daniel Walker78f32662006-10-21 10:24:10 -070053 } while (unlikely((v1 > v2 && v1 < v3) || (v2 > v3 && v2 < v1)
54 || (v3 > v1 && v3 < v2)));
john stultz5d0cf412006-06-26 00:25:12 -070055
Thomas Gleixnerd66bea52007-02-16 01:27:57 -080056 return v2;
57}
58
59static cycle_t acpi_pm_read_slow(void)
60{
61 return (cycle_t)acpi_pm_read_verified();
john stultz5d0cf412006-06-26 00:25:12 -070062}
63
64static cycle_t acpi_pm_read(void)
65{
66 return (cycle_t)read_pmtmr();
67}
68
69static struct clocksource clocksource_acpi_pm = {
70 .name = "acpi_pm",
71 .rating = 200,
72 .read = acpi_pm_read,
73 .mask = (cycle_t)ACPI_PM_MASK,
74 .mult = 0, /*to be caluclated*/
75 .shift = 22,
Thomas Gleixner73b08d22007-02-16 01:27:36 -080076 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
77
john stultz5d0cf412006-06-26 00:25:12 -070078};
79
80
81#ifdef CONFIG_PCI
Daniel Walkerf5f1a242006-12-10 02:21:33 -080082static int __devinitdata acpi_pm_good;
john stultz5d0cf412006-06-26 00:25:12 -070083static int __init acpi_pm_good_setup(char *__str)
84{
Daniel Walkerf5f1a242006-12-10 02:21:33 -080085 acpi_pm_good = 1;
86 return 1;
john stultz5d0cf412006-06-26 00:25:12 -070087}
88__setup("acpi_pm_good", acpi_pm_good_setup);
89
90static inline void acpi_pm_need_workaround(void)
91{
Thomas Gleixnerd66bea52007-02-16 01:27:57 -080092 clocksource_acpi_pm.read = acpi_pm_read_slow;
john stultz1ff100d2007-03-26 21:32:19 -080093 clocksource_acpi_pm.rating = 120;
john stultz5d0cf412006-06-26 00:25:12 -070094}
95
96/*
97 * PIIX4 Errata:
98 *
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.
105 */
106static void __devinit acpi_pm_check_blacklist(struct pci_dev *dev)
107{
108 u8 rev;
109
110 if (acpi_pm_good)
111 return;
112
113 pci_read_config_byte(dev, PCI_REVISION_ID, &rev);
114 /* the bug has been fixed in PIIX4M */
115 if (rev < 3) {
116 printk(KERN_WARNING "* Found PM-Timer Bug on the chipset."
117 " Due to workarounds for a bug,\n"
118 "* this clock source is slow. Consider trying"
119 " other clock sources\n");
120
121 acpi_pm_need_workaround();
122 }
123}
124DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82371AB_3,
125 acpi_pm_check_blacklist);
126
127static void __devinit acpi_pm_check_graylist(struct pci_dev *dev)
128{
129 if (acpi_pm_good)
130 return;
131
132 printk(KERN_WARNING "* The chipset may have PM-Timer Bug. Due to"
133 " workarounds for a bug,\n"
134 "* this clock source is slow. If you are sure your timer"
135 " does not have\n"
136 "* this bug, please use \"acpi_pm_good\" to disable the"
137 " workaround\n");
138
139 acpi_pm_need_workaround();
140}
141DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_0,
142 acpi_pm_check_graylist);
Daniel Walker78f32662006-10-21 10:24:10 -0700143DECLARE_PCI_FIXUP_EARLY(PCI_VENDOR_ID_SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_LE,
144 acpi_pm_check_graylist);
john stultz5d0cf412006-06-26 00:25:12 -0700145#endif
146
john stultz562f9c52006-12-08 02:36:02 -0800147#ifndef CONFIG_X86_64
148#include "mach_timer.h"
149#define PMTMR_EXPECTED_RATE \
150 ((CALIBRATE_LATCH * (PMTMR_TICKS_PER_SEC >> 10)) / (CLOCK_TICK_RATE>>10))
151/*
152 * Some boards have the PMTMR running way too fast. We check
153 * the PMTMR rate against PIT channel 2 to catch these cases.
154 */
155static int verify_pmtmr_rate(void)
156{
157 u32 value1, value2;
158 unsigned long count, delta;
159
160 mach_prepare_counter();
161 value1 = read_pmtmr();
162 mach_countup(&count);
163 value2 = read_pmtmr();
164 delta = (value2 - value1) & ACPI_PM_MASK;
165
166 /* Check that the PMTMR delta is within 5% of what we expect */
167 if (delta < (PMTMR_EXPECTED_RATE * 19) / 20 ||
168 delta > (PMTMR_EXPECTED_RATE * 21) / 20) {
169 printk(KERN_INFO "PM-Timer running at invalid rate: %lu%% "
170 "of normal - aborting.\n",
171 100UL * delta / PMTMR_EXPECTED_RATE);
172 return -1;
173 }
174
175 return 0;
176}
177#else
178#define verify_pmtmr_rate() (0)
179#endif
john stultz5d0cf412006-06-26 00:25:12 -0700180
181static int __init init_acpi_pm_clocksource(void)
182{
183 u32 value1, value2;
184 unsigned int i;
185
186 if (!pmtmr_ioport)
187 return -ENODEV;
188
189 clocksource_acpi_pm.mult = clocksource_hz2mult(PMTMR_TICKS_PER_SEC,
190 clocksource_acpi_pm.shift);
191
192 /* "verify" this timing source: */
193 value1 = read_pmtmr();
194 for (i = 0; i < 10000; i++) {
195 value2 = read_pmtmr();
196 if (value2 == value1)
197 continue;
198 if (value2 > value1)
199 goto pm_good;
200 if ((value2 < value1) && ((value2) < 0xFFF))
201 goto pm_good;
202 printk(KERN_INFO "PM-Timer had inconsistent results:"
203 " 0x%#x, 0x%#x - aborting.\n", value1, value2);
204 return -EINVAL;
205 }
206 printk(KERN_INFO "PM-Timer had no reasonable result:"
207 " 0x%#x - aborting.\n", value1);
208 return -ENODEV;
209
210pm_good:
john stultz562f9c52006-12-08 02:36:02 -0800211 if (verify_pmtmr_rate() != 0)
212 return -ENODEV;
213
john stultza2752542006-06-26 00:25:14 -0700214 return clocksource_register(&clocksource_acpi_pm);
john stultz5d0cf412006-06-26 00:25:12 -0700215}
216
john stultz6bb74df2007-03-05 00:30:50 -0800217/* We use fs_initcall because we want the PCI fixups to have run
218 * but we still need to load before device_initcall
219 */
220fs_initcall(init_acpi_pm_clocksource);