/* $NetBSD: hpet_acpi.c,v 1.8 2011/06/15 04:20:47 jruoho Exp $ */

/*
 * Copyright (c) 2006, 2011 Nicolas Joly
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: hpet_acpi.c,v 1.8 2011/06/15 04:20:47 jruoho Exp $");

#include <sys/param.h>
#include <sys/device.h>
#include <sys/time.h>
#include <sys/timetc.h>

#include <dev/acpi/acpivar.h>
#include <dev/ic/hpetvar.h>

#define _COMPONENT	ACPI_RESOURCE_COMPONENT
ACPI_MODULE_NAME	("acpi_hpet")

#define HPET_MEM_WIDTH	0x3ff   /* Expected memory region size. */

static int		hpet_acpi_dev_match(device_t, cfdata_t, void *);
static void		hpet_acpi_dev_attach(device_t, device_t, void *);
static int		hpet_acpi_tab_match(device_t, cfdata_t, void *);
static void		hpet_acpi_tab_attach(device_t, device_t, void *);
static int		hpet_acpi_detach(device_t, int);

static const char * const hpet_acpi_ids[] = {
	"PNP0103",
        NULL
};

CFATTACH_DECL_NEW(hpet_acpi_tab, sizeof(struct hpet_softc),
    hpet_acpi_tab_match, hpet_acpi_tab_attach, hpet_acpi_detach, NULL);

CFATTACH_DECL_NEW(hpet_acpi_dev, sizeof(struct hpet_softc),
    hpet_acpi_dev_match, hpet_acpi_dev_attach, hpet_acpi_detach, NULL);

static int
hpet_acpi_tab_match(device_t parent, cfdata_t match, void *aux)
{
	ACPI_TABLE_HPET *hpet;
	ACPI_STATUS rv;

	rv = AcpiGetTable(ACPI_SIG_HPET, 1, (ACPI_TABLE_HEADER **)&hpet);

	if (ACPI_FAILURE(rv))
		return 0;

	if (hpet->Address.Address == 0)
		return 0;

	if (hpet->Address.SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY)
		return 0;

	return 1;
}

static void
hpet_acpi_tab_attach(device_t parent, device_t self, void *aux)
{
	struct hpet_softc *sc = device_private(self);
	struct acpi_attach_args *aa = aux;
	ACPI_TABLE_HPET *hpet;
	ACPI_STATUS rv;

	sc->sc_mapped = false;

	rv = AcpiGetTable(ACPI_SIG_HPET, 1, (ACPI_TABLE_HEADER **)&hpet);

	if (ACPI_FAILURE(rv))
		return;

	sc->sc_memt = aa->aa_memt;
	sc->sc_mems = HPET_MEM_WIDTH;

	if (hpet->Address.Address == 0xfed0000000000000UL) /* A quirk. */
		hpet->Address.Address >>= 32;

	if (bus_space_map(sc->sc_memt, hpet->Address.Address,
		sc->sc_mems, 0, &sc->sc_memh) != 0) {
		aprint_error(": failed to map mem space\n");
		return;
	}

	sc->sc_mapped = true;

	aprint_naive("\n");
	aprint_normal(": mem 0x%"PRIx64"-0x%"PRIx64"\n",
	    hpet->Address.Address, hpet->Address.Address + HPET_MEM_WIDTH);

	hpet_attach_subr(self);
}

static int
hpet_acpi_dev_match(device_t parent, cfdata_t match, void *aux)
{
	struct acpi_attach_args *aa = aux;

	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
		return 0;

	return acpi_match_hid(aa->aa_node->ad_devinfo, hpet_acpi_ids);
}

static void
hpet_acpi_dev_attach(device_t parent, device_t self, void *aux)
{
	struct hpet_softc *sc = device_private(self);
	struct acpi_attach_args *aa = aux;
	struct acpi_resources res;
	struct acpi_mem *mem;
	ACPI_STATUS rv;

	sc->sc_mapped = false;

	rv = acpi_resource_parse(self, aa->aa_node->ad_handle, "_CRS",
	    &res, &acpi_resource_parse_ops_default);

	if (ACPI_FAILURE(rv))
		return;

	mem = acpi_res_mem(&res, 0);

	if (mem == NULL) {
		aprint_error(": failed to find mem resource\n");
		goto out;
	}

	if (mem->ar_length < HPET_MEM_WIDTH) {
		aprint_error(": invalid memory region size\n");
		goto out;
	}

	sc->sc_memt = aa->aa_memt;
	sc->sc_mems = mem->ar_length;

	if (bus_space_map(sc->sc_memt, mem->ar_base,
		sc->sc_mems, 0, &sc->sc_memh) != 0) {
		aprint_error(": failed to map mem space\n");
		goto out;
	}

	sc->sc_mapped = true;

	hpet_attach_subr(self);

out:
	acpi_resource_cleanup(&res);
}

static int
hpet_acpi_detach(device_t self, int flags)
{
	struct hpet_softc *sc = device_private(self);
	int rv;

	if (sc->sc_mapped != true)
		return 0;

	rv = hpet_detach(self, flags);

	if (rv != 0)
		return rv;

	bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_mems);

	return 0;
}