1151912Sphk/*-
2151912Sphk * Copyright (c) 2005 Poul-Henning Kamp
3209440Smav * Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
4151912Sphk * All rights reserved.
5151912Sphk *
6151912Sphk * Redistribution and use in source and binary forms, with or without
7151912Sphk * modification, are permitted provided that the following conditions
8151912Sphk * are met:
9151912Sphk * 1. Redistributions of source code must retain the above copyright
10151912Sphk *    notice, this list of conditions and the following disclaimer.
11151912Sphk * 2. Redistributions in binary form must reproduce the above copyright
12151912Sphk *    notice, this list of conditions and the following disclaimer in the
13151912Sphk *    documentation and/or other materials provided with the distribution.
14151912Sphk *
15151912Sphk * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16151912Sphk * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17151912Sphk * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18151912Sphk * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19151912Sphk * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20151912Sphk * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21151912Sphk * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22151912Sphk * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23151912Sphk * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24151912Sphk * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25151912Sphk * SUCH DAMAGE.
26151912Sphk */
27151912Sphk
28151912Sphk#include <sys/cdefs.h>
29151912Sphk__FBSDID("$FreeBSD$");
30151912Sphk
31151912Sphk#include "opt_acpi.h"
32209402Smav#if defined(__amd64__) || defined(__ia64__)
33209371Smav#define	DEV_APIC
34209371Smav#else
35209371Smav#include "opt_apic.h"
36209371Smav#endif
37151912Sphk#include <sys/param.h>
38159217Snjl#include <sys/bus.h>
39151912Sphk#include <sys/kernel.h>
40151912Sphk#include <sys/module.h>
41209371Smav#include <sys/proc.h>
42151912Sphk#include <sys/rman.h>
43151912Sphk#include <sys/time.h>
44209371Smav#include <sys/smp.h>
45209371Smav#include <sys/sysctl.h>
46209371Smav#include <sys/timeet.h>
47151912Sphk#include <sys/timetc.h>
48159217Snjl
49193530Sjkim#include <contrib/dev/acpica/include/acpi.h>
50193530Sjkim#include <contrib/dev/acpica/include/accommon.h>
51193530Sjkim
52151912Sphk#include <dev/acpica/acpivar.h>
53175385Sjhb#include <dev/acpica/acpi_hpet.h>
54151912Sphk
55209371Smav#ifdef DEV_APIC
56209371Smav#include "pcib_if.h"
57209371Smav#endif
58209371Smav
59203062Savg#define HPET_VENDID_AMD		0x4353
60240286Smav#define HPET_VENDID_AMD2	0x1022
61203062Savg#define HPET_VENDID_INTEL	0x8086
62213302Smav#define HPET_VENDID_NVIDIA	0x10de
63232797Smav#define HPET_VENDID_SW		0x1166
64203062Savg
65151912SphkACPI_SERIAL_DECL(hpet, "ACPI HPET support");
66151912Sphk
67209371Smavstatic devclass_t hpet_devclass;
68169574Stakawata
69151931Sscottl/* ACPI CA debugging */
70151935Sscottl#define _COMPONENT	ACPI_TIMER
71151931SscottlACPI_MODULE_NAME("HPET")
72151931Sscottl
73209371Smavstruct hpet_softc {
74151912Sphk	device_t		dev;
75209371Smav	int			mem_rid;
76209371Smav	int			intr_rid;
77209371Smav	int			irq;
78209371Smav	int			useirq;
79209440Smav	int			legacy_route;
80212533Smav	int			per_cpu;
81212238Smav	uint32_t		allowed_irqs;
82159217Snjl	struct resource		*mem_res;
83209371Smav	struct resource		*intr_res;
84209371Smav	void			*intr_handle;
85151912Sphk	ACPI_HANDLE		handle;
86209371Smav	uint64_t		freq;
87209440Smav	uint32_t		caps;
88209371Smav	struct timecounter	tc;
89209371Smav	struct hpet_timer {
90209371Smav		struct eventtimer	et;
91209371Smav		struct hpet_softc	*sc;
92209371Smav		int			num;
93209371Smav		int			mode;
94209371Smav		int			intr_rid;
95209371Smav		int			irq;
96212323Smav		int			pcpu_cpu;
97212323Smav		int			pcpu_misrouted;
98209371Smav		int			pcpu_master;
99209371Smav		int			pcpu_slaves[MAXCPU];
100209371Smav		struct resource		*intr_res;
101209371Smav		void			*intr_handle;
102209371Smav		uint32_t		caps;
103209371Smav		uint32_t		vectors;
104209371Smav		uint32_t		div;
105212491Smav		uint32_t		next;
106209371Smav		char			name[8];
107209371Smav	} 			t[32];
108209371Smav	int			num_timers;
109151912Sphk};
110151912Sphk
111159217Snjlstatic u_int hpet_get_timecount(struct timecounter *tc);
112209371Smavstatic void hpet_test(struct hpet_softc *sc);
113151912Sphk
114159217Snjlstatic char *hpet_ids[] = { "PNP0103", NULL };
115159217Snjl
116159217Snjlstatic u_int
117151912Sphkhpet_get_timecount(struct timecounter *tc)
118151912Sphk{
119209371Smav	struct hpet_softc *sc;
120151912Sphk
121151912Sphk	sc = tc->tc_priv;
122175385Sjhb	return (bus_read_4(sc->mem_res, HPET_MAIN_COUNTER));
123151912Sphk}
124151912Sphk
125175361Sjhbstatic void
126209371Smavhpet_enable(struct hpet_softc *sc)
127175361Sjhb{
128175361Sjhb	uint32_t val;
129175385Sjhb
130175385Sjhb	val = bus_read_4(sc->mem_res, HPET_CONFIG);
131209440Smav	if (sc->legacy_route)
132209440Smav		val |= HPET_CNF_LEG_RT;
133209440Smav	else
134209440Smav		val &= ~HPET_CNF_LEG_RT;
135185103Sjkim	val |= HPET_CNF_ENABLE;
136185103Sjkim	bus_write_4(sc->mem_res, HPET_CONFIG, val);
137175361Sjhb}
138175361Sjhb
139175361Sjhbstatic void
140209371Smavhpet_disable(struct hpet_softc *sc)
141175361Sjhb{
142175361Sjhb	uint32_t val;
143175385Sjhb
144175385Sjhb	val = bus_read_4(sc->mem_res, HPET_CONFIG);
145185103Sjkim	val &= ~HPET_CNF_ENABLE;
146185103Sjkim	bus_write_4(sc->mem_res, HPET_CONFIG, val);
147175361Sjhb}
148175361Sjhb
149209371Smavstatic int
150247463Smavhpet_start(struct eventtimer *et, sbintime_t first, sbintime_t period)
151209371Smav{
152209371Smav	struct hpet_timer *mt = (struct hpet_timer *)et->et_priv;
153209371Smav	struct hpet_timer *t;
154209371Smav	struct hpet_softc *sc = mt->sc;
155212491Smav	uint32_t fdiv, now;
156209371Smav
157209371Smav	t = (mt->pcpu_master < 0) ? mt : &sc->t[mt->pcpu_slaves[curcpu]];
158247463Smav	if (period != 0) {
159209371Smav		t->mode = 1;
160247463Smav		t->div = (sc->freq * period) >> 32;
161209371Smav	} else {
162209371Smav		t->mode = 2;
163209371Smav		t->div = 0;
164209371Smav	}
165247463Smav	if (first != 0)
166247463Smav		fdiv = (sc->freq * first) >> 32;
167247463Smav	else
168210290Smav		fdiv = t->div;
169212238Smav	if (t->irq < 0)
170212238Smav		bus_write_4(sc->mem_res, HPET_ISR, 1 << t->num);
171212238Smav	t->caps |= HPET_TCNF_INT_ENB;
172212491Smav	now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
173212238Smavrestart:
174212491Smav	t->next = now + fdiv;
175209371Smav	if (t->mode == 1 && (t->caps & HPET_TCAP_PER_INT)) {
176209371Smav		t->caps |= HPET_TCNF_TYPE;
177209371Smav		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
178209371Smav		    t->caps | HPET_TCNF_VAL_SET);
179212491Smav		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
180212491Smav		    t->next);
181212491Smav		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
182212491Smav		    t->div);
183209371Smav	} else {
184212238Smav		t->caps &= ~HPET_TCNF_TYPE;
185212491Smav		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
186212491Smav		    t->caps);
187212491Smav		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
188212491Smav		    t->next);
189209371Smav	}
190224919Smav	now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
191224919Smav	if ((int32_t)(now - t->next + HPET_MIN_CYCLES) >= 0) {
192224919Smav		fdiv *= 2;
193224919Smav		goto restart;
194212238Smav	}
195209371Smav	return (0);
196209371Smav}
197209371Smav
198209371Smavstatic int
199209371Smavhpet_stop(struct eventtimer *et)
200209371Smav{
201209371Smav	struct hpet_timer *mt = (struct hpet_timer *)et->et_priv;
202209371Smav	struct hpet_timer *t;
203209371Smav	struct hpet_softc *sc = mt->sc;
204209371Smav
205209371Smav	t = (mt->pcpu_master < 0) ? mt : &sc->t[mt->pcpu_slaves[curcpu]];
206209371Smav	t->mode = 0;
207209371Smav	t->caps &= ~(HPET_TCNF_INT_ENB | HPET_TCNF_TYPE);
208209371Smav	bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num), t->caps);
209209371Smav	return (0);
210209371Smav}
211209371Smav
212209371Smavstatic int
213209371Smavhpet_intr_single(void *arg)
214209371Smav{
215209371Smav	struct hpet_timer *t = (struct hpet_timer *)arg;
216209371Smav	struct hpet_timer *mt;
217209371Smav	struct hpet_softc *sc = t->sc;
218209371Smav	uint32_t now;
219209371Smav
220212491Smav	if (t->mode == 0)
221212491Smav		return (FILTER_STRAY);
222212323Smav	/* Check that per-CPU timer interrupt reached right CPU. */
223212323Smav	if (t->pcpu_cpu >= 0 && t->pcpu_cpu != curcpu) {
224212323Smav		if ((++t->pcpu_misrouted) % 32 == 0) {
225212323Smav			printf("HPET interrupt routed to the wrong CPU"
226212323Smav			    " (timer %d CPU %d -> %d)!\n",
227212323Smav			    t->num, t->pcpu_cpu, curcpu);
228212323Smav		}
229212323Smav
230212323Smav		/*
231212323Smav		 * Reload timer, hoping that next time may be more lucky
232212323Smav		 * (system will manage proper interrupt binding).
233212323Smav		 */
234212323Smav		if ((t->mode == 1 && (t->caps & HPET_TCAP_PER_INT) == 0) ||
235212323Smav		    t->mode == 2) {
236212491Smav			t->next = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER) +
237212491Smav			    sc->freq / 8;
238212323Smav			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
239212491Smav			    t->next);
240212323Smav		}
241212323Smav		return (FILTER_HANDLED);
242212323Smav	}
243209371Smav	if (t->mode == 1 &&
244209371Smav	    (t->caps & HPET_TCAP_PER_INT) == 0) {
245212491Smav		t->next += t->div;
246209371Smav		now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
247212491Smav		if ((int32_t)((now + t->div / 2) - t->next) > 0)
248212491Smav			t->next = now + t->div / 2;
249209371Smav		bus_write_4(sc->mem_res,
250212491Smav		    HPET_TIMER_COMPARATOR(t->num), t->next);
251209371Smav	} else if (t->mode == 2)
252209371Smav		t->mode = 0;
253209371Smav	mt = (t->pcpu_master < 0) ? t : &sc->t[t->pcpu_master];
254209990Smav	if (mt->et.et_active)
255209990Smav		mt->et.et_event_cb(&mt->et, mt->et.et_arg);
256209371Smav	return (FILTER_HANDLED);
257209371Smav}
258209371Smav
259209371Smavstatic int
260209371Smavhpet_intr(void *arg)
261209371Smav{
262209371Smav	struct hpet_softc *sc = (struct hpet_softc *)arg;
263209371Smav	int i;
264209371Smav	uint32_t val;
265209371Smav
266209371Smav	val = bus_read_4(sc->mem_res, HPET_ISR);
267209371Smav	if (val) {
268209371Smav		bus_write_4(sc->mem_res, HPET_ISR, val);
269209371Smav		val &= sc->useirq;
270209371Smav		for (i = 0; i < sc->num_timers; i++) {
271209371Smav			if ((val & (1 << i)) == 0)
272209371Smav				continue;
273209371Smav			hpet_intr_single(&sc->t[i]);
274209371Smav		}
275209371Smav		return (FILTER_HANDLED);
276209371Smav	}
277209371Smav	return (FILTER_STRAY);
278209371Smav}
279209371Smav
280208436Smavstatic ACPI_STATUS
281209371Smavhpet_find(ACPI_HANDLE handle, UINT32 level, void *context,
282208436Smav    void **status)
283208436Smav{
284208436Smav	char 		**ids;
285208436Smav	uint32_t	id = (uint32_t)(uintptr_t)context;
286208438Smav	uint32_t	uid = 0;
287208436Smav
288208436Smav	for (ids = hpet_ids; *ids != NULL; ids++) {
289208436Smav		if (acpi_MatchHid(handle, *ids))
290208436Smav		        break;
291208436Smav	}
292208436Smav	if (*ids == NULL)
293208436Smav		return (AE_OK);
294209371Smav	if (ACPI_FAILURE(acpi_GetInteger(handle, "_UID", &uid)) ||
295209371Smav	    id == uid)
296260350Smav		*status = acpi_get_device(handle);
297208436Smav	return (AE_OK);
298208436Smav}
299208436Smav
300216263Sjhb/*
301216263Sjhb * Find an existing IRQ resource that matches the requested IRQ range
302216263Sjhb * and return its RID.  If one is not found, use a new RID.
303216263Sjhb */
304216263Sjhbstatic int
305216263Sjhbhpet_find_irq_rid(device_t dev, u_long start, u_long end)
306216263Sjhb{
307216263Sjhb	u_long irq;
308216263Sjhb	int error, rid;
309216263Sjhb
310216263Sjhb	for (rid = 0;; rid++) {
311216263Sjhb		error = bus_get_resource(dev, SYS_RES_IRQ, rid, &irq, NULL);
312216263Sjhb		if (error != 0 || (start <= irq && irq <= end))
313216263Sjhb			return (rid);
314216263Sjhb	}
315216263Sjhb}
316216263Sjhb
317169592Snjl/* Discover the HPET via the ACPI table of the same name. */
318172489Snjlstatic void
319209371Smavhpet_identify(driver_t *driver, device_t parent)
320169574Stakawata{
321169574Stakawata	ACPI_TABLE_HPET *hpet;
322169574Stakawata	ACPI_STATUS	status;
323169574Stakawata	device_t	child;
324260350Smav	int		i;
325169574Stakawata
326172489Snjl	/* Only one HPET device can be added. */
327209371Smav	if (devclass_get_device(hpet_devclass, 0))
328172489Snjl		return;
329208436Smav	for (i = 1; ; i++) {
330208436Smav		/* Search for HPET table. */
331208436Smav		status = AcpiGetTable(ACPI_SIG_HPET, i, (ACPI_TABLE_HEADER **)&hpet);
332208436Smav		if (ACPI_FAILURE(status))
333208436Smav			return;
334208436Smav		/* Search for HPET device with same ID. */
335260350Smav		child = NULL;
336208436Smav		AcpiWalkNamespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
337260350Smav		    100, hpet_find, NULL, (void *)(uintptr_t)hpet->Sequence,
338260350Smav		    (void *)&child);
339208436Smav		/* If found - let it be probed in normal way. */
340260350Smav		if (child) {
341260350Smav			if (bus_get_resource(child, SYS_RES_MEMORY, 0,
342260350Smav			    NULL, NULL) != 0)
343260350Smav				bus_set_resource(child, SYS_RES_MEMORY, 0,
344260350Smav				    hpet->Address.Address, HPET_MEM_WIDTH);
345208436Smav			continue;
346260350Smav		}
347208436Smav		/* If not - create it from table info. */
348231161Sjkim		child = BUS_ADD_CHILD(parent, 2, "hpet", 0);
349208436Smav		if (child == NULL) {
350208436Smav			printf("%s: can't add child\n", __func__);
351208436Smav			continue;
352208436Smav		}
353208436Smav		bus_set_resource(child, SYS_RES_MEMORY, 0, hpet->Address.Address,
354208436Smav		    HPET_MEM_WIDTH);
355169574Stakawata	}
356169574Stakawata}
357169574Stakawata
358151912Sphkstatic int
359209371Smavhpet_probe(device_t dev)
360151912Sphk{
361159217Snjl	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
362159217Snjl
363169592Snjl	if (acpi_disabled("hpet"))
364151912Sphk		return (ENXIO);
365199016Savg	if (acpi_get_handle(dev) != NULL &&
366208436Smav	    ACPI_ID_PROBE(device_get_parent(dev), dev, hpet_ids) == NULL)
367169592Snjl		return (ENXIO);
368151912Sphk
369159217Snjl	device_set_desc(dev, "High Precision Event Timer");
370151912Sphk	return (0);
371151912Sphk}
372151912Sphk
373151912Sphkstatic int
374209371Smavhpet_attach(device_t dev)
375151912Sphk{
376209371Smav	struct hpet_softc *sc;
377209371Smav	struct hpet_timer *t;
378209371Smav	int i, j, num_msi, num_timers, num_percpu_et, num_percpu_t, cur_cpu;
379209371Smav	int pcpu_master;
380209371Smav	static int maxhpetet = 0;
381212238Smav	uint32_t val, val2, cvectors, dvectors;
382209371Smav	uint16_t vendor, rev;
383151912Sphk
384151912Sphk	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
385151912Sphk
386151912Sphk	sc = device_get_softc(dev);
387151912Sphk	sc->dev = dev;
388151912Sphk	sc->handle = acpi_get_handle(dev);
389151912Sphk
390209371Smav	sc->mem_rid = 0;
391209371Smav	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid,
392159217Snjl	    RF_ACTIVE);
393159217Snjl	if (sc->mem_res == NULL)
394159217Snjl		return (ENOMEM);
395151912Sphk
396159217Snjl	/* Validate that we can access the whole region. */
397159217Snjl	if (rman_get_size(sc->mem_res) < HPET_MEM_WIDTH) {
398159217Snjl		device_printf(dev, "memory region width %ld too small\n",
399159217Snjl		    rman_get_size(sc->mem_res));
400159217Snjl		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
401159217Snjl		return (ENXIO);
402159217Snjl	}
403151912Sphk
404171547Snjl	/* Be sure timer is enabled. */
405175361Sjhb	hpet_enable(sc);
406171547Snjl
407159217Snjl	/* Read basic statistics about the timer. */
408175385Sjhb	val = bus_read_4(sc->mem_res, HPET_PERIOD);
409175361Sjhb	if (val == 0) {
410175361Sjhb		device_printf(dev, "invalid period\n");
411175361Sjhb		hpet_disable(sc);
412175361Sjhb		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
413175361Sjhb		return (ENXIO);
414175361Sjhb	}
415175361Sjhb
416209371Smav	sc->freq = (1000000000000000LL + val / 2) / val;
417209440Smav	sc->caps = bus_read_4(sc->mem_res, HPET_CAPABILITIES);
418209440Smav	vendor = (sc->caps & HPET_CAP_VENDOR_ID) >> 16;
419209440Smav	rev = sc->caps & HPET_CAP_REV_ID;
420209440Smav	num_timers = 1 + ((sc->caps & HPET_CAP_NUM_TIM) >> 8);
421209371Smav	/*
422209371Smav	 * ATI/AMD violates IA-PC HPET (High Precision Event Timers)
423209371Smav	 * Specification and provides an off by one number
424209371Smav	 * of timers/comparators.
425209371Smav	 * Additionally, they use unregistered value in VENDOR_ID field.
426209371Smav	 */
427209371Smav	if (vendor == HPET_VENDID_AMD && rev < 0x10 && num_timers > 0)
428209371Smav		num_timers--;
429209371Smav	sc->num_timers = num_timers;
430159217Snjl	if (bootverbose) {
431159217Snjl		device_printf(dev,
432209371Smav		    "vendor 0x%x, rev 0x%x, %jdHz%s, %d timers,%s\n",
433209440Smav		    vendor, rev, sc->freq,
434209440Smav		    (sc->caps & HPET_CAP_COUNT_SIZE) ? " 64bit" : "",
435209440Smav		    num_timers,
436209440Smav		    (sc->caps & HPET_CAP_LEG_RT) ? " legacy route" : "");
437159217Snjl	}
438209371Smav	for (i = 0; i < num_timers; i++) {
439209371Smav		t = &sc->t[i];
440209371Smav		t->sc = sc;
441209371Smav		t->num = i;
442209371Smav		t->mode = 0;
443209371Smav		t->intr_rid = -1;
444209371Smav		t->irq = -1;
445212323Smav		t->pcpu_cpu = -1;
446212323Smav		t->pcpu_misrouted = 0;
447209371Smav		t->pcpu_master = -1;
448209371Smav		t->caps = bus_read_4(sc->mem_res, HPET_TIMER_CAP_CNF(i));
449209371Smav		t->vectors = bus_read_4(sc->mem_res, HPET_TIMER_CAP_CNF(i) + 4);
450209371Smav		if (bootverbose) {
451209371Smav			device_printf(dev,
452209371Smav			    " t%d: irqs 0x%08x (%d)%s%s%s\n", i,
453209371Smav			    t->vectors, (t->caps & HPET_TCNF_INT_ROUTE) >> 9,
454209371Smav			    (t->caps & HPET_TCAP_FSB_INT_DEL) ? ", MSI" : "",
455209371Smav			    (t->caps & HPET_TCAP_SIZE) ? ", 64bit" : "",
456209371Smav			    (t->caps & HPET_TCAP_PER_INT) ? ", periodic" : "");
457209371Smav		}
458209371Smav	}
459159217Snjl	if (testenv("debug.acpi.hpet_test"))
460209371Smav		hpet_test(sc);
461171547Snjl	/*
462171547Snjl	 * Don't attach if the timer never increments.  Since the spec
463171547Snjl	 * requires it to be at least 10 MHz, it has to change in 1 us.
464171547Snjl	 */
465175385Sjhb	val = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
466171547Snjl	DELAY(1);
467175385Sjhb	val2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
468171547Snjl	if (val == val2) {
469171547Snjl		device_printf(dev, "HPET never increments, disabling\n");
470175361Sjhb		hpet_disable(sc);
471171547Snjl		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
472171547Snjl		return (ENXIO);
473171547Snjl	}
474208436Smav	/* Announce first HPET as timecounter. */
475208436Smav	if (device_get_unit(dev) == 0) {
476209371Smav		sc->tc.tc_get_timecount = hpet_get_timecount,
477209371Smav		sc->tc.tc_counter_mask = ~0u,
478209371Smav		sc->tc.tc_name = "HPET",
479222222Sjkim		sc->tc.tc_quality = 950,
480209371Smav		sc->tc.tc_frequency = sc->freq;
481209371Smav		sc->tc.tc_priv = sc;
482209371Smav		tc_init(&sc->tc);
483208436Smav	}
484209371Smav	/* If not disabled - setup and announce event timers. */
485209371Smav	if (resource_int_value(device_get_name(dev), device_get_unit(dev),
486209371Smav	     "clock", &i) == 0 && i == 0)
487209371Smav	        return (0);
488209440Smav
489209440Smav	/* Check whether we can and want legacy routing. */
490209440Smav	sc->legacy_route = 0;
491209440Smav	resource_int_value(device_get_name(dev), device_get_unit(dev),
492209440Smav	     "legacy_route", &sc->legacy_route);
493209440Smav	if ((sc->caps & HPET_CAP_LEG_RT) == 0)
494209440Smav		sc->legacy_route = 0;
495209440Smav	if (sc->legacy_route) {
496209440Smav		sc->t[0].vectors = 0;
497209440Smav		sc->t[1].vectors = 0;
498209440Smav	}
499209440Smav
500212238Smav	/* Check what IRQs we want use. */
501212238Smav	/* By default allow any PCI IRQs. */
502212238Smav	sc->allowed_irqs = 0xffff0000;
503209371Smav	/*
504209371Smav	 * HPETs in AMD chipsets before SB800 have problems with IRQs >= 16
505209371Smav	 * Lower are also not always working for different reasons.
506209371Smav	 * SB800 fixed it, but seems do not implements level triggering
507209371Smav	 * properly, that makes it very unreliable - it freezes after any
508209371Smav	 * interrupt loss. Avoid legacy IRQs for AMD.
509209371Smav	 */
510240286Smav	if (vendor == HPET_VENDID_AMD || vendor == HPET_VENDID_AMD2)
511212238Smav		sc->allowed_irqs = 0x00000000;
512212238Smav	/*
513213302Smav	 * NVidia MCP5x chipsets have number of unexplained interrupt
514213302Smav	 * problems. For some reason, using HPET interrupts breaks HDA sound.
515213302Smav	 */
516213302Smav	if (vendor == HPET_VENDID_NVIDIA && rev <= 0x01)
517213302Smav		sc->allowed_irqs = 0x00000000;
518213302Smav	/*
519232797Smav	 * ServerWorks HT1000 reported to have problems with IRQs >= 16.
520232797Smav	 * Lower IRQs are working, but allowed mask is not set correctly.
521232797Smav	 * Legacy_route mode works fine.
522232797Smav	 */
523232797Smav	if (vendor == HPET_VENDID_SW && rev <= 0x01)
524232797Smav		sc->allowed_irqs = 0x00000000;
525232797Smav	/*
526212238Smav	 * Neither QEMU nor VirtualBox report supported IRQs correctly.
527212238Smav	 * The only way to use HPET there is to specify IRQs manually
528215473Sjhb	 * and/or use legacy_route. Legacy_route mode works on both.
529212238Smav	 */
530212238Smav	if (vm_guest)
531212238Smav		sc->allowed_irqs = 0x00000000;
532212238Smav	/* Let user override. */
533212238Smav	resource_int_value(device_get_name(dev), device_get_unit(dev),
534212238Smav	     "allowed_irqs", &sc->allowed_irqs);
535212238Smav
536212533Smav	/* Get how much per-CPU timers we should try to provide. */
537212533Smav	sc->per_cpu = 1;
538212533Smav	resource_int_value(device_get_name(dev), device_get_unit(dev),
539212533Smav	     "per_cpu", &sc->per_cpu);
540212533Smav
541212238Smav	num_msi = 0;
542212238Smav	sc->useirq = 0;
543212238Smav	/* Find IRQ vectors for all timers. */
544212238Smav	cvectors = sc->allowed_irqs & 0xffff0000;
545212238Smav	dvectors = sc->allowed_irqs & 0x0000ffff;
546212238Smav	if (sc->legacy_route)
547212238Smav		dvectors &= 0x0000fefe;
548209371Smav	for (i = 0; i < num_timers; i++) {
549209371Smav		t = &sc->t[i];
550209440Smav		if (sc->legacy_route && i < 2)
551209440Smav			t->irq = (i == 0) ? 0 : 8;
552209371Smav#ifdef DEV_APIC
553209440Smav		else if (t->caps & HPET_TCAP_FSB_INT_DEL) {
554209371Smav			if ((j = PCIB_ALLOC_MSIX(
555209371Smav			    device_get_parent(device_get_parent(dev)), dev,
556209371Smav			    &t->irq))) {
557209371Smav				device_printf(dev,
558209440Smav				    "Can't allocate interrupt for t%d.\n", j);
559209440Smav			}
560209440Smav		}
561209440Smav#endif
562212238Smav		else if (dvectors & t->vectors) {
563212238Smav			t->irq = ffs(dvectors & t->vectors) - 1;
564212238Smav			dvectors &= ~(1 << t->irq);
565212238Smav		}
566209440Smav		if (t->irq >= 0) {
567216263Sjhb			t->intr_rid = hpet_find_irq_rid(dev, t->irq, t->irq);
568216490Sjhb			t->intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
569216490Sjhb			    &t->intr_rid, t->irq, t->irq, 1, RF_ACTIVE);
570216490Sjhb			if (t->intr_res == NULL) {
571209440Smav				t->irq = -1;
572209440Smav				device_printf(dev,
573209440Smav				    "Can't map interrupt for t%d.\n", i);
574216490Sjhb			} else if (bus_setup_intr(dev, t->intr_res,
575216490Sjhb			    INTR_TYPE_CLK, hpet_intr_single, NULL, t,
576216490Sjhb			    &t->intr_handle) != 0) {
577209440Smav				t->irq = -1;
578209440Smav				device_printf(dev,
579209440Smav				    "Can't setup interrupt for t%d.\n", i);
580209371Smav			} else {
581209371Smav				bus_describe_intr(dev, t->intr_res,
582209371Smav				    t->intr_handle, "t%d", i);
583209371Smav				num_msi++;
584209371Smav			}
585209440Smav		}
586209440Smav		if (t->irq < 0 && (cvectors & t->vectors) != 0) {
587209371Smav			cvectors &= t->vectors;
588209371Smav			sc->useirq |= (1 << i);
589209371Smav		}
590209371Smav	}
591209440Smav	if (sc->legacy_route && sc->t[0].irq < 0 && sc->t[1].irq < 0)
592209440Smav		sc->legacy_route = 0;
593209440Smav	if (sc->legacy_route)
594209440Smav		hpet_enable(sc);
595209440Smav	/* Group timers for per-CPU operation. */
596212533Smav	num_percpu_et = min(num_msi / mp_ncpus, sc->per_cpu);
597209440Smav	num_percpu_t = num_percpu_et * mp_ncpus;
598209440Smav	pcpu_master = 0;
599209440Smav	cur_cpu = CPU_FIRST();
600209440Smav	for (i = 0; i < num_timers; i++) {
601209440Smav		t = &sc->t[i];
602209440Smav		if (t->irq >= 0 && num_percpu_t > 0) {
603209440Smav			if (cur_cpu == CPU_FIRST())
604209440Smav				pcpu_master = i;
605212323Smav			t->pcpu_cpu = cur_cpu;
606209440Smav			t->pcpu_master = pcpu_master;
607209440Smav			sc->t[pcpu_master].
608209440Smav			    pcpu_slaves[cur_cpu] = i;
609209440Smav			bus_bind_intr(dev, t->intr_res, cur_cpu);
610209440Smav			cur_cpu = CPU_NEXT(cur_cpu);
611209440Smav			num_percpu_t--;
612212238Smav		} else if (t->irq >= 0)
613212238Smav			bus_bind_intr(dev, t->intr_res, CPU_FIRST());
614209440Smav	}
615209371Smav	bus_write_4(sc->mem_res, HPET_ISR, 0xffffffff);
616209371Smav	sc->irq = -1;
617215473Sjhb	/* If at least one timer needs legacy IRQ - set it up. */
618209371Smav	if (sc->useirq) {
619209371Smav		j = i = fls(cvectors) - 1;
620209371Smav		while (j > 0 && (cvectors & (1 << (j - 1))) != 0)
621209371Smav			j--;
622216263Sjhb		sc->intr_rid = hpet_find_irq_rid(dev, j, i);
623216490Sjhb		sc->intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
624216490Sjhb		    &sc->intr_rid, j, i, 1, RF_SHAREABLE | RF_ACTIVE);
625216490Sjhb		if (sc->intr_res == NULL)
626216490Sjhb			device_printf(dev, "Can't map interrupt.\n");
627216490Sjhb		else if (bus_setup_intr(dev, sc->intr_res, INTR_TYPE_CLK,
628216490Sjhb		    hpet_intr, NULL, sc, &sc->intr_handle) != 0) {
629209371Smav			device_printf(dev, "Can't setup interrupt.\n");
630209371Smav		} else {
631209371Smav			sc->irq = rman_get_start(sc->intr_res);
632209371Smav			/* Bind IRQ to BSP to avoid live migration. */
633209371Smav			bus_bind_intr(dev, sc->intr_res, CPU_FIRST());
634209371Smav		}
635209371Smav	}
636209371Smav	/* Program and announce event timers. */
637209371Smav	for (i = 0; i < num_timers; i++) {
638209371Smav		t = &sc->t[i];
639209371Smav		t->caps &= ~(HPET_TCNF_FSB_EN | HPET_TCNF_INT_ROUTE);
640209371Smav		t->caps &= ~(HPET_TCNF_VAL_SET | HPET_TCNF_INT_ENB);
641209440Smav		t->caps &= ~(HPET_TCNF_INT_TYPE);
642209371Smav		t->caps |= HPET_TCNF_32MODE;
643209440Smav		if (t->irq >= 0 && sc->legacy_route && i < 2) {
644209440Smav			/* Legacy route doesn't need more configuration. */
645209440Smav		} else
646209371Smav#ifdef DEV_APIC
647212238Smav		if ((t->caps & HPET_TCAP_FSB_INT_DEL) && t->irq >= 0) {
648209371Smav			uint64_t addr;
649209371Smav			uint32_t data;
650209371Smav
651209371Smav			if (PCIB_MAP_MSI(
652209371Smav			    device_get_parent(device_get_parent(dev)), dev,
653209371Smav			    t->irq, &addr, &data) == 0) {
654209371Smav				bus_write_4(sc->mem_res,
655209371Smav				    HPET_TIMER_FSB_ADDR(i), addr);
656209371Smav				bus_write_4(sc->mem_res,
657209371Smav				    HPET_TIMER_FSB_VAL(i), data);
658209371Smav				t->caps |= HPET_TCNF_FSB_EN;
659209371Smav			} else
660209371Smav				t->irq = -2;
661209371Smav		} else
662209371Smav#endif
663212238Smav		if (t->irq >= 0)
664212238Smav			t->caps |= (t->irq << 9);
665212238Smav		else if (sc->irq >= 0 && (t->vectors & (1 << sc->irq)))
666209371Smav			t->caps |= (sc->irq << 9) | HPET_TCNF_INT_TYPE;
667209371Smav		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(i), t->caps);
668209371Smav		/* Skip event timers without set up IRQ. */
669209371Smav		if (t->irq < 0 &&
670209371Smav		    (sc->irq < 0 || (t->vectors & (1 << sc->irq)) == 0))
671209371Smav			continue;
672209371Smav		/* Announce the reset. */
673209371Smav		if (maxhpetet == 0)
674209371Smav			t->et.et_name = "HPET";
675209371Smav		else {
676209371Smav			sprintf(t->name, "HPET%d", maxhpetet);
677209371Smav			t->et.et_name = t->name;
678209371Smav		}
679209371Smav		t->et.et_flags = ET_FLAGS_PERIODIC | ET_FLAGS_ONESHOT;
680209371Smav		t->et.et_quality = 450;
681209371Smav		if (t->pcpu_master >= 0) {
682209371Smav			t->et.et_flags |= ET_FLAGS_PERCPU;
683209371Smav			t->et.et_quality += 100;
684248170Smav		} else if (mp_ncpus >= 8)
685248154Smav			t->et.et_quality -= 100;
686209371Smav		if ((t->caps & HPET_TCAP_PER_INT) == 0)
687209371Smav			t->et.et_quality -= 10;
688209371Smav		t->et.et_frequency = sc->freq;
689247463Smav		t->et.et_min_period =
690247463Smav		    ((uint64_t)(HPET_MIN_CYCLES * 2) << 32) / sc->freq;
691247463Smav		t->et.et_max_period = (0xfffffffeLLU << 32) / sc->freq;
692209371Smav		t->et.et_start = hpet_start;
693209371Smav		t->et.et_stop = hpet_stop;
694209371Smav		t->et.et_priv = &sc->t[i];
695209371Smav		if (t->pcpu_master < 0 || t->pcpu_master == i) {
696209371Smav			et_register(&t->et);
697209371Smav			maxhpetet++;
698209371Smav		}
699209371Smav	}
700159217Snjl	return (0);
701159217Snjl}
702159217Snjl
703159217Snjlstatic int
704209371Smavhpet_detach(device_t dev)
705159217Snjl{
706159217Snjl	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
707159217Snjl
708159217Snjl	/* XXX Without a tc_remove() function, we can't detach. */
709159217Snjl	return (EBUSY);
710159217Snjl}
711159217Snjl
712168010Snjlstatic int
713209371Smavhpet_suspend(device_t dev)
714175361Sjhb{
715212541Smav//	struct hpet_softc *sc;
716175361Sjhb
717175361Sjhb	/*
718175361Sjhb	 * Disable the timer during suspend.  The timer will not lose
719175361Sjhb	 * its state in S1 or S2, but we are required to disable
720175361Sjhb	 * it.
721175361Sjhb	 */
722212541Smav//	sc = device_get_softc(dev);
723212541Smav//	hpet_disable(sc);
724175361Sjhb
725175361Sjhb	return (0);
726175361Sjhb}
727175361Sjhb
728175361Sjhbstatic int
729209371Smavhpet_resume(device_t dev)
730168010Snjl{
731209371Smav	struct hpet_softc *sc;
732209371Smav	struct hpet_timer *t;
733209371Smav	int i;
734168010Snjl
735168010Snjl	/* Re-enable the timer after a resume to keep the clock advancing. */
736168010Snjl	sc = device_get_softc(dev);
737175361Sjhb	hpet_enable(sc);
738209371Smav	/* Restart event timers that were running on suspend. */
739209371Smav	for (i = 0; i < sc->num_timers; i++) {
740209371Smav		t = &sc->t[i];
741209371Smav#ifdef DEV_APIC
742209440Smav		if (t->irq >= 0 && (sc->legacy_route == 0 || i >= 2)) {
743209371Smav			uint64_t addr;
744209371Smav			uint32_t data;
745209371Smav
746209371Smav			if (PCIB_MAP_MSI(
747209371Smav			    device_get_parent(device_get_parent(dev)), dev,
748209371Smav			    t->irq, &addr, &data) == 0) {
749209371Smav				bus_write_4(sc->mem_res,
750209371Smav				    HPET_TIMER_FSB_ADDR(i), addr);
751209371Smav				bus_write_4(sc->mem_res,
752209371Smav				    HPET_TIMER_FSB_VAL(i), data);
753209371Smav			}
754209371Smav		}
755209371Smav#endif
756209371Smav		if (t->mode == 0)
757209371Smav			continue;
758212491Smav		t->next = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
759209371Smav		if (t->mode == 1 && (t->caps & HPET_TCAP_PER_INT)) {
760209371Smav			t->caps |= HPET_TCNF_TYPE;
761212491Smav			t->next += t->div;
762209371Smav			bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
763209371Smav			    t->caps | HPET_TCNF_VAL_SET);
764209371Smav			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
765212491Smav			    t->next);
766209371Smav			bus_read_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num));
767209371Smav			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
768209371Smav			    t->div);
769209371Smav		} else {
770212491Smav			t->next += sc->freq / 1024;
771209371Smav			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
772212491Smav			    t->next);
773209371Smav		}
774209371Smav		bus_write_4(sc->mem_res, HPET_ISR, 1 << t->num);
775209371Smav		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num), t->caps);
776209371Smav	}
777168010Snjl	return (0);
778168010Snjl}
779168010Snjl
780159217Snjl/* Print some basic latency/rate information to assist in debugging. */
781159217Snjlstatic void
782209371Smavhpet_test(struct hpet_softc *sc)
783159217Snjl{
784151912Sphk	int i;
785151912Sphk	uint32_t u1, u2;
786151912Sphk	struct bintime b0, b1, b2;
787151912Sphk	struct timespec ts;
788151912Sphk
789151912Sphk	binuptime(&b0);
790151912Sphk	binuptime(&b0);
791151912Sphk	binuptime(&b1);
792175385Sjhb	u1 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
793151912Sphk	for (i = 1; i < 1000; i++)
794175385Sjhb		u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
795151912Sphk	binuptime(&b2);
796175385Sjhb	u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
797151912Sphk
798151912Sphk	bintime_sub(&b2, &b1);
799151912Sphk	bintime_sub(&b1, &b0);
800151912Sphk	bintime_sub(&b2, &b1);
801151912Sphk	bintime2timespec(&b2, &ts);
802151912Sphk
803159217Snjl	device_printf(sc->dev, "%ld.%09ld: %u ... %u = %u\n",
804151912Sphk	    (long)ts.tv_sec, ts.tv_nsec, u1, u2, u2 - u1);
805151912Sphk
806159217Snjl	device_printf(sc->dev, "time per call: %ld ns\n", ts.tv_nsec / 1000);
807151912Sphk}
808151912Sphk
809209371Smav#ifdef DEV_APIC
810209371Smavstatic int
811209371Smavhpet_remap_intr(device_t dev, device_t child, u_int irq)
812209371Smav{
813209371Smav	struct hpet_softc *sc = device_get_softc(dev);
814209371Smav	struct hpet_timer *t;
815209371Smav	uint64_t addr;
816209371Smav	uint32_t data;
817209371Smav	int error, i;
818209371Smav
819209371Smav	for (i = 0; i < sc->num_timers; i++) {
820209371Smav		t = &sc->t[i];
821209371Smav		if (t->irq != irq)
822209371Smav			continue;
823209371Smav		error = PCIB_MAP_MSI(
824209371Smav		    device_get_parent(device_get_parent(dev)), dev,
825209371Smav		    irq, &addr, &data);
826209371Smav		if (error)
827209371Smav			return (error);
828209371Smav		hpet_disable(sc); /* Stop timer to avoid interrupt loss. */
829209371Smav		bus_write_4(sc->mem_res, HPET_TIMER_FSB_ADDR(i), addr);
830209371Smav		bus_write_4(sc->mem_res, HPET_TIMER_FSB_VAL(i), data);
831209371Smav		hpet_enable(sc);
832209371Smav		return (0);
833209371Smav	}
834209371Smav	return (ENOENT);
835209371Smav}
836209371Smav#endif
837209371Smav
838209371Smavstatic device_method_t hpet_methods[] = {
839151912Sphk	/* Device interface */
840209371Smav	DEVMETHOD(device_identify, hpet_identify),
841209371Smav	DEVMETHOD(device_probe, hpet_probe),
842209371Smav	DEVMETHOD(device_attach, hpet_attach),
843209371Smav	DEVMETHOD(device_detach, hpet_detach),
844209371Smav	DEVMETHOD(device_suspend, hpet_suspend),
845209371Smav	DEVMETHOD(device_resume, hpet_resume),
846151912Sphk
847209371Smav#ifdef DEV_APIC
848209371Smav	DEVMETHOD(bus_remap_intr, hpet_remap_intr),
849209371Smav#endif
850209371Smav
851246128Ssbz	DEVMETHOD_END
852151912Sphk};
853151912Sphk
854209371Smavstatic driver_t	hpet_driver = {
855209371Smav	"hpet",
856209371Smav	hpet_methods,
857209371Smav	sizeof(struct hpet_softc),
858151912Sphk};
859151912Sphk
860209371SmavDRIVER_MODULE(hpet, acpi, hpet_driver, hpet_devclass, 0, 0);
861209371SmavMODULE_DEPEND(hpet, acpi, 1, 1, 1);
862