acpi_hpet.c revision 258164
162053Smarkm/*-
2128059Smarkm * Copyright (c) 2005 Poul-Henning Kamp
362053Smarkm * Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
462053Smarkm * All rights reserved.
562053Smarkm *
662053Smarkm * Redistribution and use in source and binary forms, with or without
762053Smarkm * modification, are permitted provided that the following conditions
862053Smarkm * are met:
962053Smarkm * 1. Redistributions of source code must retain the above copyright
1062053Smarkm *    notice, this list of conditions and the following disclaimer.
1162053Smarkm * 2. Redistributions in binary form must reproduce the above copyright
1262053Smarkm *    notice, this list of conditions and the following disclaimer in the
1362053Smarkm *    documentation and/or other materials provided with the distribution.
1462053Smarkm *
1562053Smarkm * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1662053Smarkm * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1762053Smarkm * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1862053Smarkm * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1962053Smarkm * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2062053Smarkm * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2162053Smarkm * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2262053Smarkm * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2362053Smarkm * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2462053Smarkm * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2562053Smarkm * SUCH DAMAGE.
2662053Smarkm */
2762053Smarkm
28119418Sobrien#include <sys/cdefs.h>
29119418Sobrien__FBSDID("$FreeBSD: head/sys/dev/acpica/acpi_hpet.c 258164 2013-11-15 11:32:19Z mav $");
30119418Sobrien
3162053Smarkm#include "opt_acpi.h"
3265686Smarkm#if defined(__amd64__) || defined(__ia64__)
3374914Sjhb#define	DEV_APIC
34122871Smarkm#else
3567365Sjhb#include "opt_apic.h"
3662053Smarkm#endif
3774072Smarkm#include <sys/param.h>
38122871Smarkm#include <sys/bus.h>
3969168Smarkm#include <sys/kernel.h>
40143418Sume#include <sys/module.h>
41100082Smarkm#include <sys/proc.h>
4269168Smarkm#include <sys/rman.h>
4367112Smarkm#include <sys/time.h>
44254147Sobrien#include <sys/smp.h>
45128059Smarkm#include <sys/sysctl.h>
4667112Smarkm#include <sys/timeet.h>
4762053Smarkm#include <sys/timetc.h>
4874072Smarkm
4974072Smarkm#include <contrib/dev/acpica/include/acpi.h>
5074072Smarkm#include <contrib/dev/acpica/include/accommon.h>
5174072Smarkm
5274072Smarkm#include <dev/acpica/acpivar.h>
5374072Smarkm#include <dev/acpica/acpi_hpet.h>
5489170Smsmith
5589170Smsmith#ifdef DEV_APIC
5689170Smsmith#include "pcib_if.h"
5762765Smarkm#endif
5874072Smarkm
5962053Smarkm#define HPET_VENDID_AMD		0x4353
6065686Smarkm#define HPET_VENDID_AMD2	0x1022
61153575Sps#define HPET_VENDID_INTEL	0x8086
6262765Smarkm#define HPET_VENDID_NVIDIA	0x10de
6374072Smarkm#define HPET_VENDID_SW		0x1166
6474072Smarkm
6574072SmarkmACPI_SERIAL_DECL(hpet, "ACPI HPET support");
6662765Smarkm
6791600Smarkmstatic devclass_t hpet_devclass;
6865686Smarkm
6991600Smarkm/* ACPI CA debugging */
7065686Smarkm#define _COMPONENT	ACPI_TIMER
7174072SmarkmACPI_MODULE_NAME("HPET")
7274072Smarkm
7374072Smarkmstruct hpet_softc {
7474072Smarkm	device_t		dev;
7574072Smarkm	int			mem_rid;
7674072Smarkm	int			intr_rid;
7774072Smarkm	int			irq;
7874072Smarkm	int			useirq;
7974072Smarkm	int			legacy_route;
8074072Smarkm	int			per_cpu;
8165686Smarkm	uint32_t		allowed_irqs;
8274072Smarkm	struct resource		*mem_res;
8374072Smarkm	struct resource		*intr_res;
8474072Smarkm	void			*intr_handle;
8591600Smarkm	ACPI_HANDLE		handle;
8674072Smarkm	uint64_t		freq;
8774072Smarkm	uint32_t		caps;
8874072Smarkm	struct timecounter	tc;
8965686Smarkm	struct hpet_timer {
9074072Smarkm		struct eventtimer	et;
9165686Smarkm		struct hpet_softc	*sc;
9274072Smarkm		int			num;
9374072Smarkm		int			mode;
9474072Smarkm		int			intr_rid;
9565686Smarkm		int			irq;
9674072Smarkm		int			pcpu_cpu;
9774072Smarkm		int			pcpu_misrouted;
9874072Smarkm		int			pcpu_master;
9965686Smarkm		int			pcpu_slaves[MAXCPU];
10074072Smarkm		struct resource		*intr_res;
10174072Smarkm		void			*intr_handle;
10262765Smarkm		uint32_t		caps;
10362765Smarkm		uint32_t		vectors;
10474072Smarkm		uint32_t		div;
105254147Sobrien		uint32_t		next;
10662053Smarkm		char			name[8];
10774072Smarkm	} 			t[32];
108170025Srwatson	int			num_timers;
10965686Smarkm};
11072364Smarkm
11172364Smarkmstatic u_int hpet_get_timecount(struct timecounter *tc);
11272364Smarkmstatic void hpet_test(struct hpet_softc *sc);
113170025Srwatson
114254147Sobrienstatic char *hpet_ids[] = { "PNP0103", NULL };
115128059Smarkm
116128059Smarkmstatic u_int
117128059Smarkmhpet_get_timecount(struct timecounter *tc)
118170025Srwatson{
119128059Smarkm	struct hpet_softc *sc;
120128059Smarkm
121128059Smarkm	sc = tc->tc_priv;
122128059Smarkm	return (bus_read_4(sc->mem_res, HPET_MAIN_COUNTER));
123128059Smarkm}
124128059Smarkm
125170025Srwatsonstatic void
126128059Smarkmhpet_enable(struct hpet_softc *sc)
127128059Smarkm{
128128059Smarkm	uint32_t val;
129128059Smarkm
130128059Smarkm	val = bus_read_4(sc->mem_res, HPET_CONFIG);
131128059Smarkm	if (sc->legacy_route)
132170025Srwatson		val |= HPET_CNF_LEG_RT;
133128059Smarkm	else
134128059Smarkm		val &= ~HPET_CNF_LEG_RT;
135128059Smarkm	val |= HPET_CNF_ENABLE;
136128059Smarkm	bus_write_4(sc->mem_res, HPET_CONFIG, val);
137128059Smarkm}
138128059Smarkm
139170025Srwatsonstatic void
140128059Smarkmhpet_disable(struct hpet_softc *sc)
141128059Smarkm{
142128059Smarkm	uint32_t val;
143128059Smarkm
144128059Smarkm	val = bus_read_4(sc->mem_res, HPET_CONFIG);
145128059Smarkm	val &= ~HPET_CNF_ENABLE;
146170025Srwatson	bus_write_4(sc->mem_res, HPET_CONFIG, val);
147128059Smarkm}
148128059Smarkm
149128059Smarkmstatic int
150128059Smarkmhpet_start(struct eventtimer *et, sbintime_t first, sbintime_t period)
151128059Smarkm{
152128059Smarkm	struct hpet_timer *mt = (struct hpet_timer *)et->et_priv;
15362765Smarkm	struct hpet_timer *t;
15462765Smarkm	struct hpet_softc *sc = mt->sc;
15574072Smarkm	uint32_t fdiv, now;
15674072Smarkm
15762765Smarkm	t = (mt->pcpu_master < 0) ? mt : &sc->t[mt->pcpu_slaves[curcpu]];
15862765Smarkm	if (period != 0) {
15965686Smarkm		t->mode = 1;
16074072Smarkm		t->div = (sc->freq * period) >> 32;
16174072Smarkm	} else {
16274072Smarkm		t->mode = 2;
16365686Smarkm		t->div = 0;
16474072Smarkm	}
16574072Smarkm	if (first != 0)
16674072Smarkm		fdiv = (sc->freq * first) >> 32;
16769526Smarkm	else
16874072Smarkm		fdiv = t->div;
16993818Sjhb	if (t->irq < 0)
17062053Smarkm		bus_write_4(sc->mem_res, HPET_ISR, 1 << t->num);
17162053Smarkm	t->caps |= HPET_TCNF_INT_ENB;
17262053Smarkm	now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
173128059Smarkmrestart:
17462053Smarkm	t->next = now + fdiv;
17565686Smarkm	if (t->mode == 1 && (t->caps & HPET_TCAP_PER_INT)) {
17662765Smarkm		t->caps |= HPET_TCNF_TYPE;
17762765Smarkm		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
17862765Smarkm		    t->caps | HPET_TCNF_VAL_SET);
17974072Smarkm		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
18062765Smarkm		    t->next);
18165686Smarkm		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
18265686Smarkm		    t->div);
18363771Smarkm	} else {
18465686Smarkm		t->caps &= ~HPET_TCNF_TYPE;
18565686Smarkm		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
18665686Smarkm		    t->caps);
18765686Smarkm		bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
18891600Smarkm		    t->next);
18991600Smarkm	}
19062053Smarkm	now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
19165686Smarkm	if ((int32_t)(now - t->next + HPET_MIN_CYCLES) >= 0) {
19272200Sbmilekic		fdiv *= 2;
19365686Smarkm		goto restart;
19462053Smarkm	}
19562053Smarkm	return (0);
19674072Smarkm}
19765686Smarkm
19865686Smarkmstatic int
19965686Smarkmhpet_stop(struct eventtimer *et)
20074072Smarkm{
20174072Smarkm	struct hpet_timer *mt = (struct hpet_timer *)et->et_priv;
20265686Smarkm	struct hpet_timer *t;
20365686Smarkm	struct hpet_softc *sc = mt->sc;
20474072Smarkm
20562765Smarkm	t = (mt->pcpu_master < 0) ? mt : &sc->t[mt->pcpu_slaves[curcpu]];
20663771Smarkm	t->mode = 0;
20763771Smarkm	t->caps &= ~(HPET_TCNF_INT_ENB | HPET_TCNF_TYPE);
20863771Smarkm	bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num), t->caps);
20962053Smarkm	return (0);
21062765Smarkm}
21162765Smarkm
21262765Smarkmstatic int
21374072Smarkmhpet_intr_single(void *arg)
21474072Smarkm{
21565686Smarkm	struct hpet_timer *t = (struct hpet_timer *)arg;
21662765Smarkm	struct hpet_timer *mt;
21765686Smarkm	struct hpet_softc *sc = t->sc;
21862765Smarkm	uint32_t now;
21974072Smarkm
22065686Smarkm	if (t->mode == 0)
22165686Smarkm		return (FILTER_STRAY);
22262053Smarkm	/* Check that per-CPU timer interrupt reached right CPU. */
22362053Smarkm	if (t->pcpu_cpu >= 0 && t->pcpu_cpu != curcpu) {
22465686Smarkm		if ((++t->pcpu_misrouted) % 32 == 0) {
22565686Smarkm			printf("HPET interrupt routed to the wrong CPU"
22665686Smarkm			    " (timer %d CPU %d -> %d)!\n",
22762053Smarkm			    t->num, t->pcpu_cpu, curcpu);
22874072Smarkm		}
22965686Smarkm
23065686Smarkm		/*
23165686Smarkm		 * Reload timer, hoping that next time may be more lucky
23265686Smarkm		 * (system will manage proper interrupt binding).
23374072Smarkm		 */
23462053Smarkm		if ((t->mode == 1 && (t->caps & HPET_TCAP_PER_INT) == 0) ||
23562053Smarkm		    t->mode == 2) {
23662053Smarkm			t->next = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER) +
23774072Smarkm			    sc->freq / 8;
23874072Smarkm			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
23974072Smarkm			    t->next);
24074072Smarkm		}
24162053Smarkm		return (FILTER_HANDLED);
24262765Smarkm	}
24362053Smarkm	if (t->mode == 1 &&
24462765Smarkm	    (t->caps & HPET_TCAP_PER_INT) == 0) {
24591600Smarkm		t->next += t->div;
24674072Smarkm		now = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
24774072Smarkm		if ((int32_t)((now + t->div / 2) - t->next) > 0)
24862765Smarkm			t->next = now + t->div / 2;
24962765Smarkm		bus_write_4(sc->mem_res,
25062053Smarkm		    HPET_TIMER_COMPARATOR(t->num), t->next);
25162053Smarkm	} else if (t->mode == 2)
25262053Smarkm		t->mode = 0;
25365686Smarkm	mt = (t->pcpu_master < 0) ? t : &sc->t[t->pcpu_master];
25465686Smarkm	if (mt->et.et_active)
25565686Smarkm		mt->et.et_event_cb(&mt->et, mt->et.et_arg);
25662053Smarkm	return (FILTER_HANDLED);
25765686Smarkm}
25865686Smarkm
25962053Smarkmstatic int
260153575Spshpet_intr(void *arg)
261153575Sps{
262153575Sps	struct hpet_softc *sc = (struct hpet_softc *)arg;
26365686Smarkm	int i;
26472200Sbmilekic	uint32_t val;
26562053Smarkm
26662053Smarkm	val = bus_read_4(sc->mem_res, HPET_ISR);
267100082Smarkm	if (val) {
26891600Smarkm		bus_write_4(sc->mem_res, HPET_ISR, val);
269128059Smarkm		val &= sc->useirq;
27062053Smarkm		for (i = 0; i < sc->num_timers; i++) {
27162053Smarkm			if ((val & (1 << i)) == 0)
27262053Smarkm				continue;
27374908Smarkm			hpet_intr_single(&sc->t[i]);
274107789Smarkm		}
27591600Smarkm		return (FILTER_HANDLED);
27691600Smarkm	}
27762053Smarkm	return (FILTER_STRAY);
27862875Smarkm}
27972200Sbmilekic
28062875Smarkmstatic ACPI_STATUS
28162053Smarkmhpet_find(ACPI_HANDLE handle, UINT32 level, void *context,
28262053Smarkm    void **status)
28362765Smarkm{
28462053Smarkm	char 		**ids;
28562053Smarkm	uint32_t	id = (uint32_t)(uintptr_t)context;
28691600Smarkm	uint32_t	uid = 0;
28762053Smarkm
28891600Smarkm	for (ids = hpet_ids; *ids != NULL; ids++) {
28974072Smarkm		if (acpi_MatchHid(handle, *ids))
29074072Smarkm		        break;
29174908Smarkm	}
292107789Smarkm	if (*ids == NULL)
293107789Smarkm		return (AE_OK);
29474072Smarkm	if (ACPI_FAILURE(acpi_GetInteger(handle, "_UID", &uid)) ||
29574072Smarkm	    id == uid)
29662053Smarkm		*status = acpi_get_device(handle);
29762765Smarkm	return (AE_OK);
29862053Smarkm}
299107789Smarkm
300174073Ssimon/*
30162053Smarkm * Find an existing IRQ resource that matches the requested IRQ range
30262053Smarkm * and return its RID.  If one is not found, use a new RID.
30362053Smarkm */
30462053Smarkmstatic int
30574072Smarkmhpet_find_irq_rid(device_t dev, u_long start, u_long end)
30674072Smarkm{
30774908Smarkm	u_long irq;
30891600Smarkm	int error, rid;
30991600Smarkm
31074072Smarkm	for (rid = 0;; rid++) {
31174072Smarkm		error = bus_get_resource(dev, SYS_RES_IRQ, rid, &irq, NULL);
31262053Smarkm		if (error != 0 || (start <= irq && irq <= end))
31362765Smarkm			return (rid);
31462053Smarkm	}
31562053Smarkm}
31662053Smarkm
31762053Smarkm/* Discover the HPET via the ACPI table of the same name. */
318128059Smarkmstatic void
31991600Smarkmhpet_identify(driver_t *driver, device_t parent)
32091600Smarkm{
32191600Smarkm	ACPI_TABLE_HPET *hpet;
32262053Smarkm	ACPI_STATUS	status;
32362053Smarkm	device_t	child;
32462053Smarkm	int		i;
32572200Sbmilekic
32662053Smarkm	/* Only one HPET device can be added. */
32762053Smarkm	if (devclass_get_device(hpet_devclass, 0))
32862053Smarkm		return;
32962765Smarkm	for (i = 1; ; i++) {
33062053Smarkm		/* Search for HPET table. */
33162053Smarkm		status = AcpiGetTable(ACPI_SIG_HPET, i, (ACPI_TABLE_HEADER **)&hpet);
33274072Smarkm		if (ACPI_FAILURE(status))
33365686Smarkm			return;
33462053Smarkm		/* Search for HPET device with same ID. */
33562765Smarkm		child = NULL;
33674072Smarkm		AcpiWalkNamespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
33774072Smarkm		    100, hpet_find, NULL, (void *)(uintptr_t)hpet->Sequence,
33874072Smarkm		    (void *)&child);
33962053Smarkm		/* If found - let it be probed in normal way. */
34062053Smarkm		if (child) {
34174072Smarkm			if (bus_get_resource(child, SYS_RES_MEMORY, 0,
34265686Smarkm			    NULL, NULL) != 0)
34362875Smarkm				bus_set_resource(child, SYS_RES_MEMORY, 0,
34462053Smarkm				    hpet->Address.Address, HPET_MEM_WIDTH);
34562765Smarkm			continue;
34669172Smarkm		}
34769172Smarkm		/* If not - create it from table info. */
348128059Smarkm		child = BUS_ADD_CHILD(parent, 2, "hpet", 0);
34969172Smarkm		if (child == NULL) {
350100082Smarkm			printf("%s: can't add child\n", __func__);
35169172Smarkm			continue;
352		}
353		bus_set_resource(child, SYS_RES_MEMORY, 0, hpet->Address.Address,
354		    HPET_MEM_WIDTH);
355	}
356}
357
358static int
359hpet_probe(device_t dev)
360{
361	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
362
363	if (acpi_disabled("hpet"))
364		return (ENXIO);
365	if (acpi_get_handle(dev) != NULL &&
366	    ACPI_ID_PROBE(device_get_parent(dev), dev, hpet_ids) == NULL)
367		return (ENXIO);
368
369	device_set_desc(dev, "High Precision Event Timer");
370	return (0);
371}
372
373static int
374hpet_attach(device_t dev)
375{
376	struct hpet_softc *sc;
377	struct hpet_timer *t;
378	int i, j, num_msi, num_timers, num_percpu_et, num_percpu_t, cur_cpu;
379	int pcpu_master;
380	static int maxhpetet = 0;
381	uint32_t val, val2, cvectors, dvectors;
382	uint16_t vendor, rev;
383
384	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
385
386	sc = device_get_softc(dev);
387	sc->dev = dev;
388	sc->handle = acpi_get_handle(dev);
389
390	sc->mem_rid = 0;
391	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid,
392	    RF_ACTIVE);
393	if (sc->mem_res == NULL)
394		return (ENOMEM);
395
396	/* Validate that we can access the whole region. */
397	if (rman_get_size(sc->mem_res) < HPET_MEM_WIDTH) {
398		device_printf(dev, "memory region width %ld too small\n",
399		    rman_get_size(sc->mem_res));
400		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
401		return (ENXIO);
402	}
403
404	/* Be sure timer is enabled. */
405	hpet_enable(sc);
406
407	/* Read basic statistics about the timer. */
408	val = bus_read_4(sc->mem_res, HPET_PERIOD);
409	if (val == 0) {
410		device_printf(dev, "invalid period\n");
411		hpet_disable(sc);
412		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
413		return (ENXIO);
414	}
415
416	sc->freq = (1000000000000000LL + val / 2) / val;
417	sc->caps = bus_read_4(sc->mem_res, HPET_CAPABILITIES);
418	vendor = (sc->caps & HPET_CAP_VENDOR_ID) >> 16;
419	rev = sc->caps & HPET_CAP_REV_ID;
420	num_timers = 1 + ((sc->caps & HPET_CAP_NUM_TIM) >> 8);
421	/*
422	 * ATI/AMD violates IA-PC HPET (High Precision Event Timers)
423	 * Specification and provides an off by one number
424	 * of timers/comparators.
425	 * Additionally, they use unregistered value in VENDOR_ID field.
426	 */
427	if (vendor == HPET_VENDID_AMD && rev < 0x10 && num_timers > 0)
428		num_timers--;
429	sc->num_timers = num_timers;
430	if (bootverbose) {
431		device_printf(dev,
432		    "vendor 0x%x, rev 0x%x, %jdHz%s, %d timers,%s\n",
433		    vendor, rev, sc->freq,
434		    (sc->caps & HPET_CAP_COUNT_SIZE) ? " 64bit" : "",
435		    num_timers,
436		    (sc->caps & HPET_CAP_LEG_RT) ? " legacy route" : "");
437	}
438	for (i = 0; i < num_timers; i++) {
439		t = &sc->t[i];
440		t->sc = sc;
441		t->num = i;
442		t->mode = 0;
443		t->intr_rid = -1;
444		t->irq = -1;
445		t->pcpu_cpu = -1;
446		t->pcpu_misrouted = 0;
447		t->pcpu_master = -1;
448		t->caps = bus_read_4(sc->mem_res, HPET_TIMER_CAP_CNF(i));
449		t->vectors = bus_read_4(sc->mem_res, HPET_TIMER_CAP_CNF(i) + 4);
450		if (bootverbose) {
451			device_printf(dev,
452			    " t%d: irqs 0x%08x (%d)%s%s%s\n", i,
453			    t->vectors, (t->caps & HPET_TCNF_INT_ROUTE) >> 9,
454			    (t->caps & HPET_TCAP_FSB_INT_DEL) ? ", MSI" : "",
455			    (t->caps & HPET_TCAP_SIZE) ? ", 64bit" : "",
456			    (t->caps & HPET_TCAP_PER_INT) ? ", periodic" : "");
457		}
458	}
459	if (testenv("debug.acpi.hpet_test"))
460		hpet_test(sc);
461	/*
462	 * Don't attach if the timer never increments.  Since the spec
463	 * requires it to be at least 10 MHz, it has to change in 1 us.
464	 */
465	val = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
466	DELAY(1);
467	val2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
468	if (val == val2) {
469		device_printf(dev, "HPET never increments, disabling\n");
470		hpet_disable(sc);
471		bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res);
472		return (ENXIO);
473	}
474	/* Announce first HPET as timecounter. */
475	if (device_get_unit(dev) == 0) {
476		sc->tc.tc_get_timecount = hpet_get_timecount,
477		sc->tc.tc_counter_mask = ~0u,
478		sc->tc.tc_name = "HPET",
479		sc->tc.tc_quality = 950,
480		sc->tc.tc_frequency = sc->freq;
481		sc->tc.tc_priv = sc;
482		tc_init(&sc->tc);
483	}
484	/* If not disabled - setup and announce event timers. */
485	if (resource_int_value(device_get_name(dev), device_get_unit(dev),
486	     "clock", &i) == 0 && i == 0)
487	        return (0);
488
489	/* Check whether we can and want legacy routing. */
490	sc->legacy_route = 0;
491	resource_int_value(device_get_name(dev), device_get_unit(dev),
492	     "legacy_route", &sc->legacy_route);
493	if ((sc->caps & HPET_CAP_LEG_RT) == 0)
494		sc->legacy_route = 0;
495	if (sc->legacy_route) {
496		sc->t[0].vectors = 0;
497		sc->t[1].vectors = 0;
498	}
499
500	/* Check what IRQs we want use. */
501	/* By default allow any PCI IRQs. */
502	sc->allowed_irqs = 0xffff0000;
503	/*
504	 * HPETs in AMD chipsets before SB800 have problems with IRQs >= 16
505	 * Lower are also not always working for different reasons.
506	 * SB800 fixed it, but seems do not implements level triggering
507	 * properly, that makes it very unreliable - it freezes after any
508	 * interrupt loss. Avoid legacy IRQs for AMD.
509	 */
510	if (vendor == HPET_VENDID_AMD || vendor == HPET_VENDID_AMD2)
511		sc->allowed_irqs = 0x00000000;
512	/*
513	 * NVidia MCP5x chipsets have number of unexplained interrupt
514	 * problems. For some reason, using HPET interrupts breaks HDA sound.
515	 */
516	if (vendor == HPET_VENDID_NVIDIA && rev <= 0x01)
517		sc->allowed_irqs = 0x00000000;
518	/*
519	 * ServerWorks HT1000 reported to have problems with IRQs >= 16.
520	 * Lower IRQs are working, but allowed mask is not set correctly.
521	 * Legacy_route mode works fine.
522	 */
523	if (vendor == HPET_VENDID_SW && rev <= 0x01)
524		sc->allowed_irqs = 0x00000000;
525	/*
526	 * Neither QEMU nor VirtualBox report supported IRQs correctly.
527	 * The only way to use HPET there is to specify IRQs manually
528	 * and/or use legacy_route. Legacy_route mode works on both.
529	 */
530	if (vm_guest)
531		sc->allowed_irqs = 0x00000000;
532	/* Let user override. */
533	resource_int_value(device_get_name(dev), device_get_unit(dev),
534	     "allowed_irqs", &sc->allowed_irqs);
535
536	/* Get how much per-CPU timers we should try to provide. */
537	sc->per_cpu = 1;
538	resource_int_value(device_get_name(dev), device_get_unit(dev),
539	     "per_cpu", &sc->per_cpu);
540
541	num_msi = 0;
542	sc->useirq = 0;
543	/* Find IRQ vectors for all timers. */
544	cvectors = sc->allowed_irqs & 0xffff0000;
545	dvectors = sc->allowed_irqs & 0x0000ffff;
546	if (sc->legacy_route)
547		dvectors &= 0x0000fefe;
548	for (i = 0; i < num_timers; i++) {
549		t = &sc->t[i];
550		if (sc->legacy_route && i < 2)
551			t->irq = (i == 0) ? 0 : 8;
552#ifdef DEV_APIC
553		else if (t->caps & HPET_TCAP_FSB_INT_DEL) {
554			if ((j = PCIB_ALLOC_MSIX(
555			    device_get_parent(device_get_parent(dev)), dev,
556			    &t->irq))) {
557				device_printf(dev,
558				    "Can't allocate interrupt for t%d.\n", j);
559			}
560		}
561#endif
562		else if (dvectors & t->vectors) {
563			t->irq = ffs(dvectors & t->vectors) - 1;
564			dvectors &= ~(1 << t->irq);
565		}
566		if (t->irq >= 0) {
567			t->intr_rid = hpet_find_irq_rid(dev, t->irq, t->irq);
568			t->intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
569			    &t->intr_rid, t->irq, t->irq, 1, RF_ACTIVE);
570			if (t->intr_res == NULL) {
571				t->irq = -1;
572				device_printf(dev,
573				    "Can't map interrupt for t%d.\n", i);
574			} else if (bus_setup_intr(dev, t->intr_res,
575			    INTR_TYPE_CLK, hpet_intr_single, NULL, t,
576			    &t->intr_handle) != 0) {
577				t->irq = -1;
578				device_printf(dev,
579				    "Can't setup interrupt for t%d.\n", i);
580			} else {
581				bus_describe_intr(dev, t->intr_res,
582				    t->intr_handle, "t%d", i);
583				num_msi++;
584			}
585		}
586		if (t->irq < 0 && (cvectors & t->vectors) != 0) {
587			cvectors &= t->vectors;
588			sc->useirq |= (1 << i);
589		}
590	}
591	if (sc->legacy_route && sc->t[0].irq < 0 && sc->t[1].irq < 0)
592		sc->legacy_route = 0;
593	if (sc->legacy_route)
594		hpet_enable(sc);
595	/* Group timers for per-CPU operation. */
596	num_percpu_et = min(num_msi / mp_ncpus, sc->per_cpu);
597	num_percpu_t = num_percpu_et * mp_ncpus;
598	pcpu_master = 0;
599	cur_cpu = CPU_FIRST();
600	for (i = 0; i < num_timers; i++) {
601		t = &sc->t[i];
602		if (t->irq >= 0 && num_percpu_t > 0) {
603			if (cur_cpu == CPU_FIRST())
604				pcpu_master = i;
605			t->pcpu_cpu = cur_cpu;
606			t->pcpu_master = pcpu_master;
607			sc->t[pcpu_master].
608			    pcpu_slaves[cur_cpu] = i;
609			bus_bind_intr(dev, t->intr_res, cur_cpu);
610			cur_cpu = CPU_NEXT(cur_cpu);
611			num_percpu_t--;
612		} else if (t->irq >= 0)
613			bus_bind_intr(dev, t->intr_res, CPU_FIRST());
614	}
615	bus_write_4(sc->mem_res, HPET_ISR, 0xffffffff);
616	sc->irq = -1;
617	/* If at least one timer needs legacy IRQ - set it up. */
618	if (sc->useirq) {
619		j = i = fls(cvectors) - 1;
620		while (j > 0 && (cvectors & (1 << (j - 1))) != 0)
621			j--;
622		sc->intr_rid = hpet_find_irq_rid(dev, j, i);
623		sc->intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
624		    &sc->intr_rid, j, i, 1, RF_SHAREABLE | RF_ACTIVE);
625		if (sc->intr_res == NULL)
626			device_printf(dev, "Can't map interrupt.\n");
627		else if (bus_setup_intr(dev, sc->intr_res, INTR_TYPE_CLK,
628		    hpet_intr, NULL, sc, &sc->intr_handle) != 0) {
629			device_printf(dev, "Can't setup interrupt.\n");
630		} else {
631			sc->irq = rman_get_start(sc->intr_res);
632			/* Bind IRQ to BSP to avoid live migration. */
633			bus_bind_intr(dev, sc->intr_res, CPU_FIRST());
634		}
635	}
636	/* Program and announce event timers. */
637	for (i = 0; i < num_timers; i++) {
638		t = &sc->t[i];
639		t->caps &= ~(HPET_TCNF_FSB_EN | HPET_TCNF_INT_ROUTE);
640		t->caps &= ~(HPET_TCNF_VAL_SET | HPET_TCNF_INT_ENB);
641		t->caps &= ~(HPET_TCNF_INT_TYPE);
642		t->caps |= HPET_TCNF_32MODE;
643		if (t->irq >= 0 && sc->legacy_route && i < 2) {
644			/* Legacy route doesn't need more configuration. */
645		} else
646#ifdef DEV_APIC
647		if ((t->caps & HPET_TCAP_FSB_INT_DEL) && t->irq >= 0) {
648			uint64_t addr;
649			uint32_t data;
650
651			if (PCIB_MAP_MSI(
652			    device_get_parent(device_get_parent(dev)), dev,
653			    t->irq, &addr, &data) == 0) {
654				bus_write_4(sc->mem_res,
655				    HPET_TIMER_FSB_ADDR(i), addr);
656				bus_write_4(sc->mem_res,
657				    HPET_TIMER_FSB_VAL(i), data);
658				t->caps |= HPET_TCNF_FSB_EN;
659			} else
660				t->irq = -2;
661		} else
662#endif
663		if (t->irq >= 0)
664			t->caps |= (t->irq << 9);
665		else if (sc->irq >= 0 && (t->vectors & (1 << sc->irq)))
666			t->caps |= (sc->irq << 9) | HPET_TCNF_INT_TYPE;
667		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(i), t->caps);
668		/* Skip event timers without set up IRQ. */
669		if (t->irq < 0 &&
670		    (sc->irq < 0 || (t->vectors & (1 << sc->irq)) == 0))
671			continue;
672		/* Announce the reset. */
673		if (maxhpetet == 0)
674			t->et.et_name = "HPET";
675		else {
676			sprintf(t->name, "HPET%d", maxhpetet);
677			t->et.et_name = t->name;
678		}
679		t->et.et_flags = ET_FLAGS_PERIODIC | ET_FLAGS_ONESHOT;
680		t->et.et_quality = 450;
681		if (t->pcpu_master >= 0) {
682			t->et.et_flags |= ET_FLAGS_PERCPU;
683			t->et.et_quality += 100;
684		} else if (mp_ncpus >= 8)
685			t->et.et_quality -= 100;
686		if ((t->caps & HPET_TCAP_PER_INT) == 0)
687			t->et.et_quality -= 10;
688		t->et.et_frequency = sc->freq;
689		t->et.et_min_period =
690		    ((uint64_t)(HPET_MIN_CYCLES * 2) << 32) / sc->freq;
691		t->et.et_max_period = (0xfffffffeLLU << 32) / sc->freq;
692		t->et.et_start = hpet_start;
693		t->et.et_stop = hpet_stop;
694		t->et.et_priv = &sc->t[i];
695		if (t->pcpu_master < 0 || t->pcpu_master == i) {
696			et_register(&t->et);
697			maxhpetet++;
698		}
699	}
700	return (0);
701}
702
703static int
704hpet_detach(device_t dev)
705{
706	ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
707
708	/* XXX Without a tc_remove() function, we can't detach. */
709	return (EBUSY);
710}
711
712static int
713hpet_suspend(device_t dev)
714{
715//	struct hpet_softc *sc;
716
717	/*
718	 * Disable the timer during suspend.  The timer will not lose
719	 * its state in S1 or S2, but we are required to disable
720	 * it.
721	 */
722//	sc = device_get_softc(dev);
723//	hpet_disable(sc);
724
725	return (0);
726}
727
728static int
729hpet_resume(device_t dev)
730{
731	struct hpet_softc *sc;
732	struct hpet_timer *t;
733	int i;
734
735	/* Re-enable the timer after a resume to keep the clock advancing. */
736	sc = device_get_softc(dev);
737	hpet_enable(sc);
738	/* Restart event timers that were running on suspend. */
739	for (i = 0; i < sc->num_timers; i++) {
740		t = &sc->t[i];
741#ifdef DEV_APIC
742		if (t->irq >= 0 && (sc->legacy_route == 0 || i >= 2)) {
743			uint64_t addr;
744			uint32_t data;
745
746			if (PCIB_MAP_MSI(
747			    device_get_parent(device_get_parent(dev)), dev,
748			    t->irq, &addr, &data) == 0) {
749				bus_write_4(sc->mem_res,
750				    HPET_TIMER_FSB_ADDR(i), addr);
751				bus_write_4(sc->mem_res,
752				    HPET_TIMER_FSB_VAL(i), data);
753			}
754		}
755#endif
756		if (t->mode == 0)
757			continue;
758		t->next = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
759		if (t->mode == 1 && (t->caps & HPET_TCAP_PER_INT)) {
760			t->caps |= HPET_TCNF_TYPE;
761			t->next += t->div;
762			bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num),
763			    t->caps | HPET_TCNF_VAL_SET);
764			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
765			    t->next);
766			bus_read_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num));
767			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
768			    t->div);
769		} else {
770			t->next += sc->freq / 1024;
771			bus_write_4(sc->mem_res, HPET_TIMER_COMPARATOR(t->num),
772			    t->next);
773		}
774		bus_write_4(sc->mem_res, HPET_ISR, 1 << t->num);
775		bus_write_4(sc->mem_res, HPET_TIMER_CAP_CNF(t->num), t->caps);
776	}
777	return (0);
778}
779
780/* Print some basic latency/rate information to assist in debugging. */
781static void
782hpet_test(struct hpet_softc *sc)
783{
784	int i;
785	uint32_t u1, u2;
786	struct bintime b0, b1, b2;
787	struct timespec ts;
788
789	binuptime(&b0);
790	binuptime(&b0);
791	binuptime(&b1);
792	u1 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
793	for (i = 1; i < 1000; i++)
794		u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
795	binuptime(&b2);
796	u2 = bus_read_4(sc->mem_res, HPET_MAIN_COUNTER);
797
798	bintime_sub(&b2, &b1);
799	bintime_sub(&b1, &b0);
800	bintime_sub(&b2, &b1);
801	bintime2timespec(&b2, &ts);
802
803	device_printf(sc->dev, "%ld.%09ld: %u ... %u = %u\n",
804	    (long)ts.tv_sec, ts.tv_nsec, u1, u2, u2 - u1);
805
806	device_printf(sc->dev, "time per call: %ld ns\n", ts.tv_nsec / 1000);
807}
808
809#ifdef DEV_APIC
810static int
811hpet_remap_intr(device_t dev, device_t child, u_int irq)
812{
813	struct hpet_softc *sc = device_get_softc(dev);
814	struct hpet_timer *t;
815	uint64_t addr;
816	uint32_t data;
817	int error, i;
818
819	for (i = 0; i < sc->num_timers; i++) {
820		t = &sc->t[i];
821		if (t->irq != irq)
822			continue;
823		error = PCIB_MAP_MSI(
824		    device_get_parent(device_get_parent(dev)), dev,
825		    irq, &addr, &data);
826		if (error)
827			return (error);
828		hpet_disable(sc); /* Stop timer to avoid interrupt loss. */
829		bus_write_4(sc->mem_res, HPET_TIMER_FSB_ADDR(i), addr);
830		bus_write_4(sc->mem_res, HPET_TIMER_FSB_VAL(i), data);
831		hpet_enable(sc);
832		return (0);
833	}
834	return (ENOENT);
835}
836#endif
837
838static device_method_t hpet_methods[] = {
839	/* Device interface */
840	DEVMETHOD(device_identify, hpet_identify),
841	DEVMETHOD(device_probe, hpet_probe),
842	DEVMETHOD(device_attach, hpet_attach),
843	DEVMETHOD(device_detach, hpet_detach),
844	DEVMETHOD(device_suspend, hpet_suspend),
845	DEVMETHOD(device_resume, hpet_resume),
846
847#ifdef DEV_APIC
848	DEVMETHOD(bus_remap_intr, hpet_remap_intr),
849#endif
850
851	DEVMETHOD_END
852};
853
854static driver_t	hpet_driver = {
855	"hpet",
856	hpet_methods,
857	sizeof(struct hpet_softc),
858};
859
860DRIVER_MODULE(hpet, acpi, hpet_driver, hpet_devclass, 0, 0);
861MODULE_DEPEND(hpet, acpi, 1, 1, 1);
862