sdhc_acpi.c revision 1.5 1 /* $NetBSD: sdhc_acpi.c,v 1.5 2018/05/08 03:27:17 mlelstv 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.5 2018/05/08 03:27:17 mlelstv 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
39 #include <dev/sdmmc/sdhcreg.h>
40 #include <dev/sdmmc/sdhcvar.h>
41 #include <dev/sdmmc/sdmmcvar.h>
42
43 #define _COMPONENT ACPI_RESOURCE_COMPONENT
44 ACPI_MODULE_NAME ("sdhc_acpi")
45
46 static int sdhc_acpi_match(device_t, cfdata_t, void *);
47 static void sdhc_acpi_attach(device_t, device_t, void *);
48 static int sdhc_acpi_detach(device_t, int);
49 static bool sdhc_acpi_resume(device_t, const pmf_qual_t *);
50
51 struct sdhc_acpi_softc {
52 struct sdhc_softc sc;
53 bus_space_tag_t sc_memt;
54 bus_space_handle_t sc_memh;
55 bus_size_t sc_memsize;
56 int sc_irq;
57
58 ACPI_HANDLE sc_crs, sc_srs;
59 ACPI_BUFFER sc_crs_buffer;
60 };
61
62 CFATTACH_DECL_NEW(sdhc_acpi, sizeof(struct sdhc_acpi_softc),
63 sdhc_acpi_match, sdhc_acpi_attach, sdhc_acpi_detach, NULL);
64
65 static uint32_t sdhc_acpi_intr(void *);
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 sc->sc_irq = -1;
144
145 slot = sdhc_acpi_find_slot(aa->aa_node->ad_devinfo);
146 if (slot->type == SLOT_TYPE_EMMC)
147 sc->sc.sc_vendor_hw_reset = sdhc_acpi_intel_emmc_hw_reset;
148
149 rv = acpi_resource_parse(self, aa->aa_node->ad_handle, "_CRS",
150 &res, &acpi_resource_parse_ops_default);
151 if (ACPI_FAILURE(rv))
152 return;
153
154 AcpiGetHandle(aa->aa_node->ad_handle, "_CRS", &sc->sc_crs);
155 AcpiGetHandle(aa->aa_node->ad_handle, "_SRS", &sc->sc_srs);
156 if (sc->sc_crs && sc->sc_srs) {
157 /* XXX Why need this? */
158 sc->sc_crs_buffer.Pointer = NULL;
159 sc->sc_crs_buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
160 rv = AcpiGetCurrentResources(sc->sc_crs, &sc->sc_crs_buffer);
161 if (ACPI_FAILURE(rv))
162 sc->sc_crs = sc->sc_srs = NULL;
163 }
164
165 mem = acpi_res_mem(&res, 0);
166 irq = acpi_res_irq(&res, 0);
167 if (mem == NULL || irq == NULL) {
168 aprint_error_dev(self, "incomplete resources\n");
169 goto cleanup;
170 }
171 if (mem->ar_length == 0) {
172 aprint_error_dev(self, "zero length memory resource\n");
173 goto cleanup;
174 }
175 sc->sc_memsize = mem->ar_length;
176
177 if (bus_space_map(sc->sc_memt, mem->ar_base, sc->sc_memsize, 0,
178 &sc->sc_memh)) {
179 aprint_error_dev(self, "couldn't map registers\n");
180 goto cleanup;
181 }
182
183 /* XXX acpi_intr_establish? */
184 rv = AcpiOsInstallInterruptHandler(irq->ar_irq, sdhc_acpi_intr, sc);
185 if (ACPI_FAILURE(rv)) {
186 aprint_error_dev(self,
187 "couldn't establish interrupt handler\n");
188 goto unmap;
189 }
190 sc->sc_irq = irq->ar_irq;
191
192 sc->sc.sc_host = kmem_zalloc(sizeof(struct sdhc_host *), KM_NOSLEEP);
193 if (sc->sc.sc_host == NULL) {
194 aprint_error_dev(self, "couldn't alloc memory\n");
195 goto intr_disestablish;
196 }
197
198 /* Enable DMA transfer */
199 sc->sc.sc_flags |= SDHC_FLAG_USE_DMA;
200
201 if (sdhc_host_found(&sc->sc, sc->sc_memt, sc->sc_memh,
202 sc->sc_memsize) != 0) {
203 aprint_error_dev(self, "couldn't initialize host\n");
204 goto fail;
205 }
206
207 if (!pmf_device_register1(self, sdhc_suspend, sdhc_acpi_resume,
208 sdhc_shutdown)) {
209 aprint_error_dev(self, "couldn't establish powerhook\n");
210 }
211
212 acpi_resource_cleanup(&res);
213 return;
214
215 fail:
216 if (sc->sc.sc_host != NULL)
217 kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
218 sc->sc.sc_host = NULL;
219 intr_disestablish:
220 if (sc->sc_irq >= 0)
221 /* XXX acpi_intr_disestablish? */
222 AcpiOsRemoveInterruptHandler(sc->sc_irq, sdhc_acpi_intr);
223 sc->sc_irq = -1;
224 unmap:
225 bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
226 sc->sc_memsize = 0;
227 cleanup:
228 if (sc->sc_crs_buffer.Pointer)
229 ACPI_FREE(sc->sc_crs_buffer.Pointer);
230 sc->sc_crs_buffer.Pointer = NULL;
231 acpi_resource_cleanup(&res);
232 }
233
234 static int
235 sdhc_acpi_detach(device_t self, int flags)
236 {
237 struct sdhc_acpi_softc *sc = device_private(self);
238 int rv;
239
240 pmf_device_deregister(self);
241
242 rv = sdhc_detach(&sc->sc, flags);
243 if (rv)
244 return rv;
245
246 if (sc->sc_irq >= 0)
247 /* XXX acpi_intr_disestablish? */
248 AcpiOsRemoveInterruptHandler(sc->sc_irq, sdhc_acpi_intr);
249
250 if (sc->sc.sc_host != NULL)
251 kmem_free(sc->sc.sc_host, sizeof(struct sdhc_host *));
252
253 if (sc->sc_memsize > 0)
254 bus_space_unmap(sc->sc_memt, sc->sc_memh, sc->sc_memsize);
255
256 if (sc->sc_crs_buffer.Pointer)
257 ACPI_FREE(sc->sc_crs_buffer.Pointer);
258
259 return 0;
260 }
261
262 static bool
263 sdhc_acpi_resume(device_t self, const pmf_qual_t *qual)
264 {
265 struct sdhc_acpi_softc *sc = device_private(self);
266 ACPI_STATUS rv;
267
268 if (sc->sc_crs && sc->sc_srs) {
269 rv = AcpiSetCurrentResources(sc->sc_srs, &sc->sc_crs_buffer);
270 if (ACPI_FAILURE(rv))
271 printf("%s: _SRS failed: %s\n",
272 device_xname(self), AcpiFormatException(rv));
273 }
274
275 return sdhc_resume(self, qual);
276 }
277
278 static uint32_t
279 sdhc_acpi_intr(void *context)
280 {
281 struct sdhc_acpi_softc *sc = context;
282
283 if (!sdhc_intr(&sc->sc))
284 return ACPI_INTERRUPT_NOT_HANDLED;
285 return ACPI_INTERRUPT_HANDLED;
286 }
287
288 static void
289 sdhc_acpi_intel_emmc_hw_reset(struct sdhc_softc *sc, struct sdhc_host *hp)
290 {
291 kmutex_t *plock = sdhc_host_lock(hp);
292 uint8_t reg;
293
294 mutex_enter(plock);
295
296 reg = sdhc_host_read_1(hp, SDHC_POWER_CTL);
297 reg |= 0x10;
298 sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
299
300 sdmmc_delay(10);
301
302 reg &= ~0x10;
303 sdhc_host_write_1(hp, SDHC_POWER_CTL, reg);
304
305 sdmmc_delay(1000);
306
307 mutex_exit(plock);
308 }
309