MFC r311911, r311923

r311911:
[sdhci] Add ACPI platform support for SDHCI driver

- Create ACPI version of SDHCI attach/detach/accessors logic. Some
    platforms (e.g. BayTrail-based Minnowboard) expose SDHCI devices
    via ACPI, not PCI
- Add sdchi_acpi kernel module

Reviewed by:	ian, imp
Differential Revision:	https://reviews.freebsd.org/D9112

r311923:
Add acpi_if.h and opt_acpi.h to Makefile to unbreak "make depend" with
sys/modules/sdhci_acpi

X-MFC with:	r311911
Reported by:	Jenkins

4 files changed, 382 insertions, 0 deletions

diff --git a/sys/conf/files b/sys/conf/files
index 2f20e96..ae4f87d 100644
--- a/sys/conf/files
+++ b/sys/conf/files
@@ -2557,6 +2557,7 @@ dev/scd/scd.c			optional scd isa
 dev/scd/scd_isa.c		optional scd isa
 dev/sdhci/sdhci.c		optional sdhci
 dev/sdhci/sdhci_if.m		optional sdhci
+dev/sdhci/sdhci_acpi.c		optional sdhci acpi
 dev/sdhci/sdhci_pci.c		optional sdhci pci
 dev/sf/if_sf.c			optional sf pci
 dev/sge/if_sge.c		optional sge pci
diff --git a/sys/dev/sdhci/sdhci_acpi.c b/sys/dev/sdhci/sdhci_acpi.c
new file mode 100644
index 0000000..a2a2cab
--- /dev/null
+++ b/sys/dev/sdhci/sdhci_acpi.c
@@ -0,0 +1,370 @@
+/*-
+ * Copyright (c) 2017 Oleksandr Tymoshenko <gonzo@FreeBSD.org>
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/bus.h>
+#include <sys/conf.h>
+#include <sys/kernel.h>
+#include <sys/lock.h>
+#include <sys/module.h>
+#include <sys/mutex.h>
+#include <sys/resource.h>
+#include <sys/rman.h>
+#include <sys/sysctl.h>
+#include <sys/taskqueue.h>
+
+#include <machine/bus.h>
+#include <machine/resource.h>
+#include <machine/stdarg.h>
+
+#include <contrib/dev/acpica/include/acpi.h>
+#include <dev/acpica/acpivar.h>
+
+#include <dev/mmc/bridge.h>
+#include <dev/mmc/mmcreg.h>
+#include <dev/mmc/mmcbrvar.h>
+
+#include "sdhci.h"
+#include "mmcbr_if.h"
+#include "sdhci_if.h"
+
+static const struct sdhci_acpi_device {
+	const char*	hid;
+	int		uid;
+	const char	*desc;
+	u_int		quirks;
+} sdhci_acpi_devices[] = {
+	{ "80860F14",	1,	"Intel Bay Trail eMMC 4.5 Controller",
+	    SDHCI_QUIRK_ALL_SLOTS_NON_REMOVABLE |
+	    SDHCI_QUIRK_INTEL_POWER_UP_RESET },
+	{ "80860F16",	0,	"Intel Bay Trail SD Host Controller",
+	    0 },
+	{ NULL, 0, NULL, 0}
+};
+
+static char *sdhci_ids[] = {
+	"80860F14",
+	"80860F16",
+	NULL
+};
+
+struct sdhci_acpi_softc {
+	u_int		quirks;		/* Chip specific quirks */
+	struct resource *irq_res;	/* IRQ resource */
+	void 		*intrhand;	/* Interrupt handle */
+
+	struct sdhci_slot slot;
+	struct resource	*mem_res;	/* Memory resource */
+};
+
+static void sdhci_acpi_intr(void *arg);
+static int sdhci_acpi_detach(device_t dev);
+
+static uint8_t
+sdhci_acpi_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	return bus_read_1(sc->mem_res, off);
+}
+
+static void
+sdhci_acpi_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint8_t val)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	bus_write_1(sc->mem_res, off, val);
+}
+
+static uint16_t
+sdhci_acpi_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	return bus_read_2(sc->mem_res, off);
+}
+
+static void
+sdhci_acpi_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint16_t val)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	bus_write_2(sc->mem_res, off, val);
+}
+
+static uint32_t
+sdhci_acpi_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	return bus_read_4(sc->mem_res, off);
+}
+
+static void
+sdhci_acpi_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint32_t val)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_barrier(sc->mem_res, 0, 0xFF,
+	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
+	bus_write_4(sc->mem_res, off, val);
+}
+
+static void
+sdhci_acpi_read_multi_4(device_t dev, struct sdhci_slot *slot,
+    bus_size_t off, uint32_t *data, bus_size_t count)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_read_multi_stream_4(sc->mem_res, off, data, count);
+}
+
+static void
+sdhci_acpi_write_multi_4(device_t dev, struct sdhci_slot *slot,
+    bus_size_t off, uint32_t *data, bus_size_t count)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	bus_write_multi_stream_4(sc->mem_res, off, data, count);
+}
+
+static const struct sdhci_acpi_device *
+sdhci_acpi_find_device(device_t dev)
+{
+	const char *hid;
+	int i, uid;
+	ACPI_HANDLE handle;
+	ACPI_STATUS status;
+
+	hid = ACPI_ID_PROBE(device_get_parent(dev), dev, sdhci_ids);
+	if (hid == NULL)
+		return (NULL);
+
+	handle = acpi_get_handle(dev);
+	status = acpi_GetInteger(handle, "_UID", &uid);
+	if (ACPI_FAILURE(status))
+		uid = 0;
+
+	for (i = 0; sdhci_acpi_devices[i].hid != NULL; i++) {
+		if (strcmp(sdhci_acpi_devices[i].hid, hid) != 0)
+			continue;
+		if ((sdhci_acpi_devices[i].uid != 0) &&
+		    (sdhci_acpi_devices[i].uid != uid))
+			continue;
+		return &sdhci_acpi_devices[i];
+	}
+
+	return (NULL);
+}
+
+static int
+sdhci_acpi_probe(device_t dev)
+{
+	const struct sdhci_acpi_device *acpi_dev;
+
+	acpi_dev = sdhci_acpi_find_device(dev);
+	if (acpi_dev == NULL)
+		return (ENXIO);
+
+	device_set_desc(dev, acpi_dev->desc);
+
+	return (BUS_PROBE_DEFAULT);
+}
+
+static int
+sdhci_acpi_attach(device_t dev)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+	int rid, err;
+	const struct sdhci_acpi_device *acpi_dev;
+
+	acpi_dev = sdhci_acpi_find_device(dev);
+	if (acpi_dev == NULL)
+		return (ENXIO);
+
+	sc->quirks = acpi_dev->quirks;
+
+	/* Allocate IRQ. */
+	rid = 0;
+	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
+		RF_ACTIVE);
+	if (sc->irq_res == NULL) {
+		device_printf(dev, "can't allocate IRQ\n");
+		return (ENOMEM);
+	}
+
+	rid = 0;
+	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
+	    &rid, RF_ACTIVE);
+	if (sc->mem_res == NULL) {
+		device_printf(dev, "can't allocate memory resource for slot\n");
+		sdhci_acpi_detach(dev);
+		return (ENOMEM);
+	}
+		
+	sc->slot.quirks = sc->quirks;
+
+	err = sdhci_init_slot(dev, &sc->slot, 0);
+	if (err) {
+		device_printf(dev, "failed to init slot\n");
+		sdhci_acpi_detach(dev);
+		return (err);
+	}
+
+	/* Activate the interrupt */
+	err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
+	    NULL, sdhci_acpi_intr, sc, &sc->intrhand);
+	if (err) {
+		device_printf(dev, "can't setup IRQ\n");
+		sdhci_acpi_detach(dev);
+		return (err);
+	}
+
+	/* Process cards detection. */
+	sdhci_start_slot(&sc->slot);
+
+	return (0);
+}
+
+static int
+sdhci_acpi_detach(device_t dev)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+
+	if (sc->intrhand)
+		bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
+	if (sc->irq_res)
+		bus_release_resource(dev, SYS_RES_IRQ,
+		    rman_get_rid(sc->irq_res), sc->irq_res);
+
+	if (sc->mem_res) {
+		sdhci_cleanup_slot(&sc->slot);
+		bus_release_resource(dev, SYS_RES_MEMORY,
+		    rman_get_rid(sc->mem_res), sc->mem_res);
+	}
+
+	return (0);
+}
+
+static int
+sdhci_acpi_shutdown(device_t dev)
+{
+
+	return (0);
+}
+
+static int
+sdhci_acpi_suspend(device_t dev)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+	int err;
+
+	err = bus_generic_suspend(dev);
+	if (err)
+		return (err);
+	sdhci_generic_suspend(&sc->slot);
+	return (0);
+}
+
+static int
+sdhci_acpi_resume(device_t dev)
+{
+	struct sdhci_acpi_softc *sc = device_get_softc(dev);
+	int err;
+
+	sdhci_generic_resume(&sc->slot);
+	err = bus_generic_resume(dev);
+	if (err)
+		return (err);
+	return (0);
+}
+
+static void
+sdhci_acpi_intr(void *arg)
+{
+	struct sdhci_acpi_softc *sc = (struct sdhci_acpi_softc *)arg;
+
+	sdhci_generic_intr(&sc->slot);
+}
+
+static device_method_t sdhci_methods[] = {
+	/* device_if */
+	DEVMETHOD(device_probe, sdhci_acpi_probe),
+	DEVMETHOD(device_attach, sdhci_acpi_attach),
+	DEVMETHOD(device_detach, sdhci_acpi_detach),
+	DEVMETHOD(device_shutdown, sdhci_acpi_shutdown),
+	DEVMETHOD(device_suspend, sdhci_acpi_suspend),
+	DEVMETHOD(device_resume, sdhci_acpi_resume),
+
+	/* Bus interface */
+	DEVMETHOD(bus_read_ivar,	sdhci_generic_read_ivar),
+	DEVMETHOD(bus_write_ivar,	sdhci_generic_write_ivar),
+
+	/* mmcbr_if */
+	DEVMETHOD(mmcbr_update_ios,     sdhci_generic_update_ios),
+	DEVMETHOD(mmcbr_request,        sdhci_generic_request),
+	DEVMETHOD(mmcbr_get_ro,         sdhci_generic_get_ro),
+	DEVMETHOD(mmcbr_acquire_host,   sdhci_generic_acquire_host),
+	DEVMETHOD(mmcbr_release_host,   sdhci_generic_release_host),
+
+	/* SDHCI registers accessors */
+	DEVMETHOD(sdhci_read_1,		sdhci_acpi_read_1),
+	DEVMETHOD(sdhci_read_2,		sdhci_acpi_read_2),
+	DEVMETHOD(sdhci_read_4,		sdhci_acpi_read_4),
+	DEVMETHOD(sdhci_read_multi_4,	sdhci_acpi_read_multi_4),
+	DEVMETHOD(sdhci_write_1,	sdhci_acpi_write_1),
+	DEVMETHOD(sdhci_write_2,	sdhci_acpi_write_2),
+	DEVMETHOD(sdhci_write_4,	sdhci_acpi_write_4),
+	DEVMETHOD(sdhci_write_multi_4,	sdhci_acpi_write_multi_4),
+
+	DEVMETHOD_END
+};
+
+static driver_t sdhci_acpi_driver = {
+	"sdhci_acpi",
+	sdhci_methods,
+	sizeof(struct sdhci_acpi_softc),
+};
+static devclass_t sdhci_acpi_devclass;
+
+DRIVER_MODULE(sdhci_acpi, acpi, sdhci_acpi_driver, sdhci_acpi_devclass, NULL,
+    NULL);
+MODULE_DEPEND(sdhci_acpi, sdhci, 1, 1, 1);
+DRIVER_MODULE(mmc, sdhci_acpi, mmc_driver, mmc_devclass, NULL, NULL);
+MODULE_DEPEND(sdhci_acpi, mmc, 1, 1, 1);
diff --git a/sys/modules/Makefile b/sys/modules/Makefile
index 0011024..c0d59b3 100644
--- a/sys/modules/Makefile
+++ b/sys/modules/Makefile
@@ -330,6 +330,7 @@ SUBDIR=	\
 	scd \
 	${_scsi_low} \
 	sdhci \
+	${_sdhci_acpi} \
 	sdhci_pci \
 	sem \
 	send \
@@ -662,6 +663,7 @@ _padlock_rng=	padlock_rng
 _rdrand_rng=	rdrand_rng
 .endif
 _s3=		s3
+_sdhci_acpi=	sdhci_acpi
 _tpm=		tpm
 _twa=		twa
 _vesa=		vesa
diff --git a/sys/modules/sdhci_acpi/Makefile b/sys/modules/sdhci_acpi/Makefile
new file mode 100644
index 0000000..0d34805
--- /dev/null
+++ b/sys/modules/sdhci_acpi/Makefile
@@ -0,0 +1,9 @@
+# $FreeBSD$
+
+.PATH: ${.CURDIR}/../../dev/sdhci
+
+KMOD=	sdhci_acpi
+SRCS=	sdhci_acpi.c sdhci.h sdhci_if.h
+SRCS+=	acpi_if.h device_if.h bus_if.h opt_acpi.h pci_if.h mmcbr_if.h
+
+.include <bsd.kmod.mk>