Home | History | Annotate | Line # | Download | only in acpi
sdhc_acpi.c revision 1.6
      1 /*	$NetBSD: sdhc_acpi.c,v 1.6 2018/11/16 23:05:50 jmcneill Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2016 Kimihiro Nonaka <nonaka (at) NetBSD.org>
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. The name of the author may not be used to endorse or promote products
     13  *    derived from this software without specific prior written permission.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     22  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     25  * SUCH DAMAGE.
     26  */
     27 
     28 #include <sys/cdefs.h>
     29 __KERNEL_RCSID(0, "$NetBSD: sdhc_acpi.c,v 1.6 2018/11/16 23:05:50 jmcneill Exp $");
     30 
     31 #include <sys/param.h>
     32 #include <sys/device.h>
     33 #include <sys/systm.h>
     34 #include <sys/kmem.h>
     35 
     36 #include <dev/acpi/acpireg.h>
     37 #include <dev/acpi/acpivar.h>
     38 #include <dev/acpi/acpi_intr.h>
     39 
     40 #include <dev/sdmmc/sdhcreg.h>
     41 #include <dev/sdmmc/sdhcvar.h>
     42 #include <dev/sdmmc/sdmmcvar.h>
     43 
     44 #define _COMPONENT	ACPI_RESOURCE_COMPONENT
     45 ACPI_MODULE_NAME	("sdhc_acpi")
     46 
     47 static int	sdhc_acpi_match(device_t, cfdata_t, void *);
     48 static void	sdhc_acpi_attach(device_t, device_t, void *);
     49 static int	sdhc_acpi_detach(device_t, int);
     50 static bool	sdhc_acpi_resume(device_t, const pmf_qual_t *);
     51 
     52 struct sdhc_acpi_softc {
     53 	struct sdhc_softc sc;
     54 	bus_space_tag_t sc_memt;
     55 	bus_space_handle_t sc_memh;
     56 	bus_size_t sc_memsize;
     57 	void *sc_ih;
     58 
     59 	ACPI_HANDLE sc_crs, sc_srs;
     60 	ACPI_BUFFER sc_crs_buffer;
     61 };
     62 
     63 CFATTACH_DECL_NEW(sdhc_acpi, sizeof(struct sdhc_acpi_softc),
     64     sdhc_acpi_match, sdhc_acpi_attach, sdhc_acpi_detach, NULL);
     65 
     66 static void	sdhc_acpi_intel_emmc_hw_reset(struct sdhc_softc *,
     67 		    struct sdhc_host *);
     68 
     69 static const struct sdhc_acpi_slot {
     70 	const char *hid;
     71 	const char *uid;
     72 	int type;
     73 #define	SLOT_TYPE_SD	0	/* SD or SDIO */
     74 #define	SLOT_TYPE_EMMC	1	/* eMMC */
     75 } sdhc_acpi_slot_map[] = {
     76 	{ "80865ACA",	NULL,	SLOT_TYPE_SD },
     77 	{ "80865ACC",	NULL,	SLOT_TYPE_EMMC },
     78 	{ "80865AD0",	NULL,	SLOT_TYPE_SD },
     79 	{ "80860F14",   "1",	SLOT_TYPE_EMMC },
     80 	{ "80860F14",   "3",	SLOT_TYPE_SD },
     81 	{ "80860F16",   NULL,	SLOT_TYPE_SD },
     82 	{ "INT33BB",	"2",	SLOT_TYPE_SD },
     83 	{ "INT33BB",	"3",	SLOT_TYPE_SD },
     84 	{ "INT33C6",	NULL,	SLOT_TYPE_SD },
     85 	{ "INT3436",	NULL,	SLOT_TYPE_SD },
     86 	{ "INT344D",	NULL,	SLOT_TYPE_SD },
     87 	{ "PNP0D40",	NULL,	SLOT_TYPE_SD },
     88 	{ "PNP0FFF",	"3",	SLOT_TYPE_SD },
     89 };
     90 
     91 static const struct sdhc_acpi_slot *
     92 sdhc_acpi_find_slot(ACPI_DEVICE_INFO *ad)
     93 {
     94 	const struct sdhc_acpi_slot *slot;
     95 	const char *hid, *uid;
     96 	size_t i;
     97 
     98 	hid = ad->HardwareId.String;
     99 	uid = ad->UniqueId.String;
    100 
    101 	if (!(ad->Valid & ACPI_VALID_HID) || hid == NULL)
    102 		return NULL;
    103 
    104 	for (i = 0; i < __arraycount(sdhc_acpi_slot_map); i++) {
    105 		slot = &sdhc_acpi_slot_map[i];
    106 		if (strcmp(hid, slot->hid) == 0) {
    107 			if (slot->uid == NULL ||
    108 			    ((ad->Valid & ACPI_VALID_UID) != 0 &&
    109 			     uid != NULL &&
    110 			     strcmp(uid, slot->uid) == 0))
    111 				return slot;
    112 		}
    113 	}
    114 	return NULL;
    115 }
    116 
    117 static int
    118 sdhc_acpi_match(device_t parent, cfdata_t match, void *opaque)
    119 {
    120 	struct acpi_attach_args *aa = opaque;
    121 
    122 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
    123 		return 0;
    124 
    125 	return sdhc_acpi_find_slot(aa->aa_node->ad_devinfo) != NULL;
    126 }
    127 
    128 static void
    129 sdhc_acpi_attach(device_t parent, device_t self, void *opaque)
    130 {
    131 	struct sdhc_acpi_softc *sc = device_private(self);
    132 	struct acpi_attach_args *aa = opaque;
    133 	const struct sdhc_acpi_slot *slot;
    134 	struct acpi_resources res;
    135 	struct acpi_mem *mem;
    136 	struct acpi_irq *irq;
    137 	ACPI_STATUS rv;
    138 
    139 	sc->sc.sc_dev = self;
    140 	sc->sc.sc_dmat = aa->aa_dmat;
    141 	sc->sc.sc_host = NULL;
    142 	sc->sc_memt = aa->aa_memt;
    143 
    144 	slot = sdhc_acpi_find_slot(aa->aa_node->ad_devinfo);
    145 	if (slot->type == SLOT_TYPE_EMMC)
    146 		sc->sc.sc_vendor_hw_reset = sdhc_acpi_intel_emmc_hw_reset;
    147 
    148 	rv = acpi_resource_parse(self, aa->aa_node->ad_handle, "_CRS",
    149 	    &res, &acpi_resource_parse_ops_default);
    150 	if (ACPI_FAILURE(rv))
    151 		return;
    152 
    153 	AcpiGetHandle(aa->aa_node->ad_handle, "_CRS", &sc->sc_crs);
    154 	AcpiGetHandle(aa->aa_node->ad_handle, "_SRS", &sc->sc_srs);
    155 	if (sc->sc_crs && sc->sc_srs) {
    156 		/* XXX Why need this? */
    157 		sc->sc_crs_buffer.Pointer = NULL;
    158 		sc->sc_crs_buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
    159 		rv = AcpiGetCurrentResources(sc->sc_crs, &sc->sc_crs_buffer);
    160 		if (ACPI_FAILURE(rv))
    161 			sc->sc_crs = sc->sc_srs = NULL;
    162 	}
    163 
    164 	mem = acpi_res_mem(&res, 0);
    165 	irq = acpi_res_irq(&res, 0);
    166 	if (mem == NULL || irq == NULL) {
    167 		aprint_error_dev(self, "incomplete resources\n");
    168 		goto cleanup;
    169 	}
    170 	if (mem->ar_length == 0) {
    171 		aprint_error_dev(self, "zero length memory resource\n");
    172 		goto cleanup;
    173 	}
    174 	sc->sc_memsize = mem->ar_length;
    175 
    176 	if (bus_space_map(sc->sc_memt, mem->ar_base, sc->sc_memsize, 0,
    177 	    &sc->sc_memh)) {
    178 		aprint_error_dev(self, "couldn't map registers\n");
    179 		goto cleanup;
    180 	}
    181 
    182 	sc->sc_ih = acpi_intr_establish(self, (uint64_t)aa->aa_node->ad_handle,
    183 	    IPL_BIO, false, sdhc_intr, &sc->sc, device_xname(self));
    184 	if (sc->sc_ih == NULL) {
    185 		aprint_error_dev(self,
    186 		    "couldn't establish interrupt handler\n");
    187 		goto unmap;
    188 	}
    189 
    190 	sc->sc.sc_host = kmem_zalloc(sizeof(struct sdhc_host *), KM_NOSLEEP);
    191 	if (sc->sc.sc_host == NULL) {
    192 		aprint_error_dev(self, "couldn't alloc memory\n");
    193 		goto intr_disestablish;
    194 	}
    195 
    196 	/* Enable DMA transfer */
    197 	sc->sc.sc_flags |= SDHC_FLAG_USE_DMA;
    198 
    199 	if (sdhc_host_found(&sc->sc, sc->sc_memt, sc->sc_memh,
    200 	    sc->sc_memsize) != 0) {
    201 		aprint_error_dev(self, "couldn't initialize host\n");
    202 		goto fail;
    203 	}
    204 
    205 	if (!pmf_device_register1(self, sdhc_suspend, sdhc_acpi_resume,
    206 	    sdhc_shutdown)) {
    207 		aprint_error_dev(self, "couldn't establish powerhook\n");
    208 	}
    209 
    210 	acpi_resource_cleanup(&res);
    211 	return;
    212 
    213 fail:
    214 	if (sc->sc.sc_host != NULL)
    215 		kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
    216 	sc->sc.sc_host = NULL;
    217 intr_disestablish:
    218 	if (sc->sc_ih != NULL)
    219 		acpi_intr_disestablish(sc->sc_ih);
    220 	sc->sc_ih = NULL;
    221 unmap:
    222 	bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
    223 	sc->sc_memsize = 0;
    224 cleanup:
    225 	if (sc->sc_crs_buffer.Pointer)
    226 		ACPI_FREE(sc->sc_crs_buffer.Pointer);
    227 	sc->sc_crs_buffer.Pointer = NULL;
    228 	acpi_resource_cleanup(&res);
    229 }
    230 
    231 static int
    232 sdhc_acpi_detach(device_t self, int flags)
    233 {
    234 	struct sdhc_acpi_softc *sc = device_private(self);
    235 	int rv;
    236 
    237 	pmf_device_deregister(self);
    238 
    239 	rv = sdhc_detach(&sc->sc, flags);
    240 	if (rv)
    241 		return rv;
    242 
    243 	if (sc->sc_ih != NULL)
    244 		acpi_intr_disestablish(sc->sc_ih);
    245 
    246 	if (sc->sc.sc_host != NULL)
    247 		kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
    248 
    249 	if (sc->sc_memsize > 0)
    250 		bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
    251 
    252 	if (sc->sc_crs_buffer.Pointer)
    253 		ACPI_FREE(sc->sc_crs_buffer.Pointer);
    254 
    255 	return 0;
    256 }
    257 
    258 static bool
    259 sdhc_acpi_resume(device_t self, const pmf_qual_t *qual)
    260 {
    261 	struct sdhc_acpi_softc *sc = device_private(self);
    262 	ACPI_STATUS rv;
    263 
    264 	if (sc->sc_crs && sc->sc_srs) {
    265 		rv = AcpiSetCurrentResources(sc->sc_srs, &sc->sc_crs_buffer);
    266 		if (ACPI_FAILURE(rv))
    267 			printf("%s: _SRS failed: %s\n",
    268 			    device_xname(self), AcpiFormatException(rv));
    269 	}
    270 
    271 	return sdhc_resume(self, qual);
    272 }
    273 
    274 static void
    275 sdhc_acpi_intel_emmc_hw_reset(struct sdhc_softc *sc, struct sdhc_host *hp)
    276 {
    277 	kmutex_t *plock = sdhc_host_lock(hp);
    278 	uint8_t reg;
    279 
    280 	mutex_enter(plock);
    281 
    282 	reg = sdhc_host_read_1(hp, SDHC_POWER_CTL);
    283 	reg |= 0x10;
    284 	sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
    285 
    286 	sdmmc_delay(10);
    287 
    288 	reg &= ~0x10;
    289 	sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
    290 
    291 	sdmmc_delay(1000);
    292 
    293 	mutex_exit(plock);
    294 }
    295