xref: /netbsd-src/sys/dev/acpi/sdhc_acpi.c (revision f3cfa6f6ce31685c6c4a758bc430e69eb99f50a4)
1 /*	$NetBSD: sdhc_acpi.c,v 1.7 2018/11/17 07:06:25 kre Exp $	*/
2 
3 /*
4  * Copyright (c) 2016 Kimihiro Nonaka <nonaka@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.7 2018/11/17 07:06:25 kre 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,
183 	    (uint64_t)(uintptr_t)aa->aa_node->ad_handle,
184 	    IPL_BIO, false, sdhc_intr, &sc->sc, device_xname(self));
185 	if (sc->sc_ih == NULL) {
186 		aprint_error_dev(self,
187 		    "couldn't establish interrupt handler\n");
188 		goto unmap;
189 	}
190 
191 	sc->sc.sc_host = kmem_zalloc(sizeof(struct sdhc_host *), KM_NOSLEEP);
192 	if (sc->sc.sc_host == NULL) {
193 		aprint_error_dev(self, "couldn't alloc memory\n");
194 		goto intr_disestablish;
195 	}
196 
197 	/* Enable DMA transfer */
198 	sc->sc.sc_flags |= SDHC_FLAG_USE_DMA;
199 
200 	if (sdhc_host_found(&sc->sc, sc->sc_memt, sc->sc_memh,
201 	    sc->sc_memsize) != 0) {
202 		aprint_error_dev(self, "couldn't initialize host\n");
203 		goto fail;
204 	}
205 
206 	if (!pmf_device_register1(self, sdhc_suspend, sdhc_acpi_resume,
207 	    sdhc_shutdown)) {
208 		aprint_error_dev(self, "couldn't establish powerhook\n");
209 	}
210 
211 	acpi_resource_cleanup(&res);
212 	return;
213 
214 fail:
215 	if (sc->sc.sc_host != NULL)
216 		kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
217 	sc->sc.sc_host = NULL;
218 intr_disestablish:
219 	if (sc->sc_ih != NULL)
220 		acpi_intr_disestablish(sc->sc_ih);
221 	sc->sc_ih = NULL;
222 unmap:
223 	bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
224 	sc->sc_memsize = 0;
225 cleanup:
226 	if (sc->sc_crs_buffer.Pointer)
227 		ACPI_FREE(sc->sc_crs_buffer.Pointer);
228 	sc->sc_crs_buffer.Pointer = NULL;
229 	acpi_resource_cleanup(&res);
230 }
231 
232 static int
233 sdhc_acpi_detach(device_t self, int flags)
234 {
235 	struct sdhc_acpi_softc *sc = device_private(self);
236 	int rv;
237 
238 	pmf_device_deregister(self);
239 
240 	rv = sdhc_detach(&sc->sc, flags);
241 	if (rv)
242 		return rv;
243 
244 	if (sc->sc_ih != NULL)
245 		acpi_intr_disestablish(sc->sc_ih);
246 
247 	if (sc->sc.sc_host != NULL)
248 		kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
249 
250 	if (sc->sc_memsize > 0)
251 		bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
252 
253 	if (sc->sc_crs_buffer.Pointer)
254 		ACPI_FREE(sc->sc_crs_buffer.Pointer);
255 
256 	return 0;
257 }
258 
259 static bool
260 sdhc_acpi_resume(device_t self, const pmf_qual_t *qual)
261 {
262 	struct sdhc_acpi_softc *sc = device_private(self);
263 	ACPI_STATUS rv;
264 
265 	if (sc->sc_crs && sc->sc_srs) {
266 		rv = AcpiSetCurrentResources(sc->sc_srs, &sc->sc_crs_buffer);
267 		if (ACPI_FAILURE(rv))
268 			printf("%s: _SRS failed: %s\n",
269 			    device_xname(self), AcpiFormatException(rv));
270 	}
271 
272 	return sdhc_resume(self, qual);
273 }
274 
275 static void
276 sdhc_acpi_intel_emmc_hw_reset(struct sdhc_softc *sc, struct sdhc_host *hp)
277 {
278 	kmutex_t *plock = sdhc_host_lock(hp);
279 	uint8_t reg;
280 
281 	mutex_enter(plock);
282 
283 	reg = sdhc_host_read_1(hp, SDHC_POWER_CTL);
284 	reg |= 0x10;
285 	sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
286 
287 	sdmmc_delay(10);
288 
289 	reg &= ~0x10;
290 	sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
291 
292 	sdmmc_delay(1000);
293 
294 	mutex_exit(plock);
295 }
296