Replace the hand rolled linked list with a SLIST.
[dragonfly.git] / sys / dev / acpica5 / acpi_timer.c
1 /*-
2  * Copyright (c) 2000, 2001 Michael Smith
3  * Copyright (c) 2000 BSDi
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD: src/sys/dev/acpica/acpi_timer.c,v 1.33 2004/05/30 20:08:23 phk Exp $
28  * $DragonFly: src/sys/dev/acpica5/acpi_timer.c,v 1.5 2005/06/09 19:14:11 eirikn Exp $
29  */
30 #include "opt_acpi.h"
31 #include <sys/param.h>
32 #include <sys/bus.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/sysctl.h>
36 #include <sys/systimer.h>
37
38 #include <machine/bus.h>
39 #include <machine/resource.h>
40 #include <machine/lock.h>
41 #include <sys/rman.h>
42 #include <bus/pci/pcivar.h>
43
44 #include "acpi.h"
45 #include "acpivar.h"
46
47 /*
48  * A timecounter based on the free-running ACPI timer.
49  *
50  * Based on the i386-only mp_clock.c by <phk@FreeBSD.ORG>.
51  */
52
53 /* Hooks for the ACPI CA debugging infrastructure */
54 #define _COMPONENT      ACPI_TIMER
55 ACPI_MODULE_NAME("TIMER")
56
57 static device_t                 acpi_timer_dev;
58 static struct resource          *acpi_timer_reg;
59 static bus_space_handle_t       acpi_timer_bsh;
60 static bus_space_tag_t          acpi_timer_bst;
61 static sysclock_t               acpi_counter_mask;
62 static sysclock_t               acpi_last_counter;
63
64 #define ACPI_TIMER_FREQ         (14318182 / 4)
65
66 static sysclock_t acpi_timer_get_timecount(void);
67 static sysclock_t acpi_timer_get_timecount24(void);
68 static sysclock_t acpi_timer_get_timecount_safe(void);
69 static void acpi_timer_construct(struct cputimer *timer, sysclock_t oldclock);
70
71 static struct cputimer acpi_cputimer = {
72         SLIST_ENTRY_INITIALIZER,
73         "ACPI",
74         CPUTIMER_PRI_ACPI,
75         CPUTIMER_ACPI,
76         acpi_timer_get_timecount_safe,
77         cputimer_default_fromhz,
78         cputimer_default_fromus,
79         acpi_timer_construct,
80         cputimer_default_destruct,
81         ACPI_TIMER_FREQ,
82         0, 0, 0
83 };
84
85 static void     acpi_timer_identify(driver_t *driver, device_t parent);
86 static int      acpi_timer_probe(device_t dev);
87 static int      acpi_timer_attach(device_t dev);
88 static int      acpi_timer_sysctl_freq(SYSCTL_HANDLER_ARGS);
89
90 static u_int    acpi_timer_read(void);
91 static int      acpi_timer_test(void);
92
93 static device_method_t acpi_timer_methods[] = {
94     DEVMETHOD(device_identify,  acpi_timer_identify),
95     DEVMETHOD(device_probe,     acpi_timer_probe),
96     DEVMETHOD(device_attach,    acpi_timer_attach),
97
98     {0, 0}
99 };
100
101 static driver_t acpi_timer_driver = {
102     "acpi_timer",
103     acpi_timer_methods,
104     0,
105 };
106
107 static devclass_t acpi_timer_devclass;
108 DRIVER_MODULE(acpi_timer, acpi, acpi_timer_driver, acpi_timer_devclass, 0, 0);
109 MODULE_DEPEND(acpi_timer, acpi, 1, 1, 1);
110
111 static u_int
112 acpi_timer_read()
113 {
114     return (bus_space_read_4(acpi_timer_bst, acpi_timer_bsh, 0));
115 }
116
117 /*
118  * Locate the ACPI timer using the FADT, set up and allocate the I/O resources
119  * we will be using.
120  */
121 static void
122 acpi_timer_identify(driver_t *driver, device_t parent)
123 {
124     device_t    dev;
125     char        desc[40];
126     u_long      rlen, rstart;
127     int         i, j, rid, rtype;
128
129     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
130
131     if (acpi_disabled("timer") || AcpiGbl_FADT == NULL)
132         return_VOID;
133
134     if ((dev = BUS_ADD_CHILD(parent, 0, "acpi_timer", 0)) == NULL) {
135         device_printf(parent, "could not add acpi_timer0\n");
136         return_VOID;
137     }
138     acpi_timer_dev = dev;
139
140     rid = 0;
141     rlen = AcpiGbl_FADT->PmTmLen;
142     rtype = (AcpiGbl_FADT->XPmTmrBlk.AddressSpaceId)
143       ? SYS_RES_IOPORT : SYS_RES_MEMORY;
144     rstart = AcpiGbl_FADT->XPmTmrBlk.Address;
145     bus_set_resource(dev, rtype, rid, rstart, rlen);
146     acpi_timer_reg = bus_alloc_resource_any(dev, rtype, &rid, RF_ACTIVE);
147     if (acpi_timer_reg == NULL) {
148         device_printf(dev, "couldn't allocate I/O resource (%s 0x%lx)\n",
149                       rtype == SYS_RES_IOPORT ? "port" : "mem", rstart);
150         return_VOID;
151     }
152     acpi_timer_bsh = rman_get_bushandle(acpi_timer_reg);
153     acpi_timer_bst = rman_get_bustag(acpi_timer_reg);
154     if (AcpiGbl_FADT->TmrValExt != 0)
155         acpi_counter_mask = 0xffffffff;
156     else
157         acpi_counter_mask = 0x00ffffff;
158
159     /*
160      * If all tests of the counter succeed, use the ACPI-fast method.  If
161      * at least one failed, default to using the safe routine, which reads
162      * the timer multiple times to get a consistent value before returning.
163      */
164     j = 0;
165     for (i = 0; i < 10; i++)
166         j += acpi_timer_test();
167     if (j == 10) {
168         if (acpi_counter_mask == 0xffffffff) {
169             acpi_cputimer.name = "ACPI-fast";
170             acpi_cputimer.count = acpi_timer_get_timecount;
171         } else {
172             acpi_cputimer.name = "ACPI-fast24";
173             acpi_cputimer.count = acpi_timer_get_timecount24;
174         }
175     } else {
176         acpi_cputimer.name = "ACPI-safe";
177         acpi_cputimer.count = acpi_timer_get_timecount_safe;
178     }
179
180     sprintf(desc, "%d-bit timer at 3.579545MHz",
181             AcpiGbl_FADT->TmrValExt ? 32 : 24);
182     device_set_desc_copy(dev, desc);
183
184     cputimer_register(&acpi_cputimer);
185     cputimer_select(&acpi_cputimer, 0);
186     return_VOID;
187 }
188
189 static int
190 acpi_timer_probe(device_t dev)
191 {
192     if (dev == acpi_timer_dev)
193         return (0);
194
195     return (ENXIO);
196 }
197
198 static int
199 acpi_timer_attach(device_t dev)
200 {
201     return (0);
202 }
203
204 /*
205  * Construct the timer.  Adjust the base so the system clock does not
206  * jump weirdly.
207  */
208 static void
209 acpi_timer_construct(struct cputimer *timer, sysclock_t oldclock)
210 {
211     timer->base = 0;
212     timer->base = oldclock - acpi_timer_get_timecount_safe();
213 }
214
215 /*
216  * Fetch current time value from reliable hardware.
217  *
218  * The cputimer interface requires a 32 bit return value.  If the ACPI timer
219  * is only 24 bits then we have to keep track of the upper 8 bits on our
220  * own.
221  *
222  * XXX we could probably get away with using a per-cpu field for this and
223  * just use interrupt disablement instead of clock_lock.
224  */
225 static sysclock_t
226 acpi_timer_get_timecount24(void)
227 {
228     sysclock_t counter;
229
230     clock_lock();
231     counter = acpi_timer_read();
232     if (counter < acpi_last_counter)
233         acpi_cputimer.base += 0x01000000;
234     acpi_last_counter = counter;
235     counter += acpi_cputimer.base;
236     clock_unlock();
237     return (counter);
238 }
239
240 static sysclock_t
241 acpi_timer_get_timecount(void)
242 {
243     return (acpi_timer_read() + acpi_cputimer.base);
244 }
245
246 /*
247  * Fetch current time value from hardware that may not correctly
248  * latch the counter.  We need to read until we have three monotonic
249  * samples and then use the middle one, otherwise we are not protected
250  * against the fact that the bits can be wrong in two directions.  If
251  * we only cared about monosity, two reads would be enough.
252  */
253 static sysclock_t
254 acpi_timer_get_timecount_safe(void)
255 {
256     u_int u1, u2, u3;
257
258     if (acpi_counter_mask != 0xffffffff)
259         clock_lock();
260
261     u2 = acpi_timer_read();
262     u3 = acpi_timer_read();
263     do {
264         u1 = u2;
265         u2 = u3;
266         u3 = acpi_timer_read();
267     } while (u1 > u2 || u2 > u3);
268
269     if (acpi_counter_mask != 0xffffffff) {
270         if (u2 < acpi_last_counter)
271             acpi_cputimer.base += 0x01000000;
272         acpi_last_counter = u2;
273         clock_unlock();
274     }
275     return (u2 + acpi_cputimer.base);
276 }
277
278 /*
279  * Timecounter freqency adjustment interface.
280  */ 
281 static int
282 acpi_timer_sysctl_freq(SYSCTL_HANDLER_ARGS)
283 {
284     int error;
285     u_int freq;
286  
287     if (acpi_cputimer.freq == 0)
288         return (EOPNOTSUPP);
289     freq = acpi_cputimer.freq;
290     error = sysctl_handle_int(oidp, &freq, sizeof(freq), req);
291     if (error == 0 && req->newptr != NULL)
292         cputimer_set_frequency(&acpi_cputimer, freq);
293
294     return (error);
295 }
296  
297 SYSCTL_PROC(_machdep, OID_AUTO, acpi_timer_freq, CTLTYPE_INT | CTLFLAG_RW,
298             0, sizeof(u_int), acpi_timer_sysctl_freq, "I", "");
299
300 /*
301  * Some ACPI timers are known or believed to suffer from implementation
302  * problems which can lead to erroneous values being read.  This function
303  * tests for consistent results from the timer and returns 1 if it believes
304  * the timer is consistent, otherwise it returns 0.
305  *
306  * It appears the cause is that the counter is not latched to the PCI bus
307  * clock when read:
308  *
309  * ] 20. ACPI Timer Errata
310  * ]
311  * ]   Problem: The power management timer may return improper result when
312  * ]   read. Although the timer value settles properly after incrementing,
313  * ]   while incrementing there is a 3nS window every 69.8nS where the
314  * ]   timer value is indeterminate (a 4.2% chance that the data will be
315  * ]   incorrect when read). As a result, the ACPI free running count up
316  * ]   timer specification is violated due to erroneous reads.  Implication:
317  * ]   System hangs due to the "inaccuracy" of the timer when used by
318  * ]   software for time critical events and delays.
319  * ]
320  * ] Workaround: Read the register twice and compare.
321  * ] Status: This will not be fixed in the PIIX4 or PIIX4E, it is fixed
322  * ] in the PIIX4M.
323  */
324
325 static int
326 acpi_timer_test()
327 {
328     uint32_t    last, this;
329     int         min, max, n, delta;
330     register_t  s;
331
332     min = 10000000;
333     max = 0;
334
335     /* Test the timer with interrupts disabled to get accurate results. */
336     s = read_eflags();
337     cpu_disable_intr();
338     last = acpi_timer_read();
339     for (n = 0; n < 2000; n++) {
340         this = acpi_timer_read();
341         delta = acpi_TimerDelta(this, last);
342         if (delta > max)
343             max = delta;
344         else if (delta < min)
345             min = delta;
346         last = this;
347     }
348     write_eflags(s);
349
350     if (max - min > 2)
351         n = 0;
352     else if (min < 0 || max == 0)
353         n = 0;
354     else
355         n = 1;
356     if (bootverbose) {
357         printf("ACPI timer looks %s min = %d, max = %d, width = %d\n",
358                 n ? "GOOD" : "BAD ",
359                 min, max, max - min);
360     }
361
362     return (n);
363 }
364