1 /*-
2 * Copyright (c) 2005 Poul-Henning Kamp
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD: releng/7.3/sys/dev/acpica/acpi_hpet.c 199986 2009-12-01 06:15:19Z avg $");
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/rman.h>
36 #include <sys/time.h>
37 #include <sys/timetc.h>
38
39 #include <contrib/dev/acpica/acpi.h>
40 #include <dev/acpica/acpivar.h>
41 #include <dev/acpica/acpi_hpet.h>
42
43 ACPI_SERIAL_DECL(hpet, "ACPI HPET support");
44
45 static devclass_t acpi_hpet_devclass;
46
47 /* ACPI CA debugging */
48 #define _COMPONENT ACPI_TIMER
49 ACPI_MODULE_NAME("HPET")
50
51 struct acpi_hpet_softc {
52 device_t dev;
53 struct resource *mem_res;
54 ACPI_HANDLE handle;
55 };
56
57 static u_int hpet_get_timecount(struct timecounter *tc);
58 static void acpi_hpet_test(struct acpi_hpet_softc *sc);
59
60 static char *hpet_ids[] = { "PNP0103", NULL };
61
62 struct timecounter hpet_timecounter = {
63 .tc_get_timecount = hpet_get_timecount,
64 .tc_counter_mask = ~0u,
65 .tc_name = "HPET",
66 .tc_quality = 900,
67 };
68
69 static u_int
70 hpet_get_timecount(struct timecounter *tc)
71 {
72 struct acpi_hpet_softc *sc;
73
74 sc = tc->tc_priv;
75 return (bus_read_4(sc->mem_res, HPET_MAIN_COUNTER));
76 }
77
78 static void
79 hpet_enable(struct acpi_hpet_softc *sc)
80 {
81 uint32_t val;
82
83 val = bus_read_4(sc->mem_res, HPET_CONFIG);
84 val &= ~HPET_CNF_LEG_RT;
85 val |= HPET_CNF_ENABLE;
86 bus_write_4(sc->mem_res, HPET_CONFIG, val);
87 }
88
89 static void
90 hpet_disable(struct acpi_hpet_softc *sc)
91 {
92 uint32_t val;
93
94 val = bus_read_4(sc->mem_res, HPET_CONFIG);
95 val &= ~HPET_CNF_ENABLE;
96 bus_write_4(sc->mem_res, HPET_CONFIG, val);
97 }
98
99 /* Discover the HPET via the ACPI table of the same name. */
100 static void
101 acpi_hpet_identify(driver_t *driver, device_t parent)
102 {
103 ACPI_TABLE_HPET *hpet;
104 ACPI_TABLE_HEADER *hdr;
105 ACPI_STATUS status;
106 device_t child;
107
108 /* Only one HPET device can be added. */
109 if (devclass_get_device(acpi_hpet_devclass, 0))
110 return;
111
112 /* Currently, ID and minimum clock tick info is unused. */
113
114 status = AcpiGetTable(ACPI_SIG_HPET, 1, (ACPI_TABLE_HEADER **)&hdr);
115 if (ACPI_FAILURE(status))
116 return;
117
118 /*
119 * The unit number could be derived from hdr->Sequence but we only
120 * support one HPET device.
121 */
122 hpet = (ACPI_TABLE_HPET *)hdr;
123 if (hpet->Sequence != 0)
124 printf("ACPI HPET table warning: Sequence is non-zero (%d)\n",
125 hpet->Sequence);
126 child = BUS_ADD_CHILD(parent, ACPI_DEV_BASE_ORDER, "acpi_hpet", 0);
127 if (child == NULL) {
128 printf("%s: can't add child\n", __func__);
129 return;
130 }
131
132 bus_set_resource(child, SYS_RES_MEMORY, 0, hpet->Address.Address,
133 HPET_MEM_WIDTH);
134 }
135
136 static int
137 acpi_hpet_probe(device_t dev)
138 {
139 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
140
141 if (acpi_disabled("hpet"))
142 return (ENXIO);
143 if (acpi_get_handle(dev) != NULL &&
144 (ACPI_ID_PROBE(device_get_parent(dev), dev, hpet_ids) == NULL ||
145 device_get_unit(dev) != 0))
146 return (ENXIO);
147
148 device_set_desc(dev, "High Precision Event Timer");
149 return (0);
150 }
151
152 static int
153 acpi_hpet_attach(device_t dev)
154 {
155 struct acpi_hpet_softc *sc;
156 int rid;
157 uint32_t val, val2;
158 uintmax_t freq;
159
160 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
161
162 sc = device_get_softc(dev);
163 sc->dev = dev;
164 sc->handle = acpi_get_handle(dev);
165
166 rid = 0;
167 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
168 RF_ACTIVE);
169 if (sc->mem_res == NULL)
170 return (ENOMEM);
171
172 /* Validate that we can access the whole region. */
173 if (rman_get_size(sc->mem_res) < HPET_MEM_WIDTH) {
174 device_printf(dev, "memory region width %ld too small\n",
175 rman_get_size(sc->mem_res));
176 bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
177 return (ENXIO);
178 }
179
180 /* Be sure timer is enabled. */
181 hpet_enable(sc);
182
183 /* Read basic statistics about the timer. */
184 val = bus_read_4(sc->mem_res, HPET_PERIOD);
185 if (val == 0) {
186 device_printf(dev, "invalid period\n");
187 hpet_disable(sc);
188 bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
189 return (ENXIO);
190 }
191
192 freq = (1000000000000000LL + val / 2) / val;
193 if (bootverbose) {
194 val = bus_read_4(sc->mem_res, HPET_CAPABILITIES);
195 device_printf(dev,
196 "vend: 0x%x rev: 0x%x num: %d hz: %jd opts:%s%s\n",
197 val >> 16, val & HPET_CAP_REV_ID,
198 (val & HPET_CAP_NUM_TIM) >> 8, freq,
199 (val & HPET_CAP_LEG_RT) ? " legacy_route" : "",
200 (val & HPET_CAP_COUNT_SIZE) ? " 64-bit" : "");
201 }
202
203 if (testenv("debug.acpi.hpet_test"))
204 acpi_hpet_test(sc);
205
206 /*
207 * Don't attach if the timer never increments. Since the spec
208 * requires it to be at least 10 MHz, it has to change in 1 us.
209 */
210 val = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
211 DELAY(1);
212 val2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
213 if (val == val2) {
214 device_printf(dev, "HPET never increments, disabling\n");
215 hpet_disable(sc);
216 bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
217 return (ENXIO);
218 }
219
220 hpet_timecounter.tc_frequency = freq;
221 hpet_timecounter.tc_priv = sc;
222 tc_init(&hpet_timecounter);
223
224 return (0);
225 }
226
227 static int
228 acpi_hpet_detach(device_t dev)
229 {
230 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
231
232 /* XXX Without a tc_remove() function, we can't detach. */
233 return (EBUSY);
234 }
235
236 static int
237 acpi_hpet_suspend(device_t dev)
238 {
239 struct acpi_hpet_softc *sc;
240
241 /*
242 * Disable the timer during suspend. The timer will not lose
243 * its state in S1 or S2, but we are required to disable
244 * it.
245 */
246 sc = device_get_softc(dev);
247 hpet_disable(sc);
248
249 return (0);
250 }
251
252 static int
253 acpi_hpet_resume(device_t dev)
254 {
255 struct acpi_hpet_softc *sc;
256
257 /* Re-enable the timer after a resume to keep the clock advancing. */
258 sc = device_get_softc(dev);
259 hpet_enable(sc);
260
261 return (0);
262 }
263
264 /* Print some basic latency/rate information to assist in debugging. */
265 static void
266 acpi_hpet_test(struct acpi_hpet_softc *sc)
267 {
268 int i;
269 uint32_t u1, u2;
270 struct bintime b0, b1, b2;
271 struct timespec ts;
272
273 binuptime(&b0);
274 binuptime(&b0);
275 binuptime(&b1);
276 u1 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
277 for (i = 1; i < 1000; i++)
278 u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
279 binuptime(&b2);
280 u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
281
282 bintime_sub(&b2, &b1);
283 bintime_sub(&b1, &b0);
284 bintime_sub(&b2, &b1);
285 bintime2timespec(&b2, &ts);
286
287 device_printf(sc->dev, "%ld.%09ld: %u ... %u = %u\n",
288 (long)ts.tv_sec, ts.tv_nsec, u1, u2, u2 - u1);
289
290 device_printf(sc->dev, "time per call: %ld ns\n", ts.tv_nsec / 1000);
291 }
292
293 static device_method_t acpi_hpet_methods[] = {
294 /* Device interface */
295 DEVMETHOD(device_identify, acpi_hpet_identify),
296 DEVMETHOD(device_probe, acpi_hpet_probe),
297 DEVMETHOD(device_attach, acpi_hpet_attach),
298 DEVMETHOD(device_detach, acpi_hpet_detach),
299 DEVMETHOD(device_suspend, acpi_hpet_suspend),
300 DEVMETHOD(device_resume, acpi_hpet_resume),
301
302 {0, 0}
303 };
304
305 static driver_t acpi_hpet_driver = {
306 "acpi_hpet",
307 acpi_hpet_methods,
308 sizeof(struct acpi_hpet_softc),
309 };
310
311
312 DRIVER_MODULE(acpi_hpet, acpi, acpi_hpet_driver, acpi_hpet_devclass, 0, 0);
313 MODULE_DEPEND(acpi_hpet, acpi, 1, 1, 1);
Cache object: 63a398790048c7427adb6834a6d265d8
|