2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 Thomas Skibo
5 * Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 /* Generic driver to attach sdhci controllers on simplebus.
30 * Derived mainly from sdhci_pci.c
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/resource.h>
45 #include <sys/sysctl.h>
46 #include <sys/taskqueue.h>
48 #include <machine/bus.h>
49 #include <machine/resource.h>
51 #include <dev/fdt/fdt_common.h>
52 #include <dev/ofw/ofw_bus.h>
53 #include <dev/ofw/ofw_bus_subr.h>
55 #include <dev/mmc/bridge.h>
57 #include <dev/sdhci/sdhci.h>
63 #define SDHCI_FDT_ARMADA38X 1
64 #define SDHCI_FDT_GENERIC 2
65 #define SDHCI_FDT_XLNX_ZY7 3
66 #define SDHCI_FDT_QUALCOMM 4
68 static struct ofw_compat_data compat_data[] = {
69 { "marvell,armada-380-sdhci", SDHCI_FDT_ARMADA38X },
70 { "sdhci_generic", SDHCI_FDT_GENERIC },
71 { "qcom,sdhci-msm-v4", SDHCI_FDT_QUALCOMM },
72 { "xlnx,zy7_sdhci", SDHCI_FDT_XLNX_ZY7 },
76 struct sdhci_fdt_softc {
77 device_t dev; /* Controller device */
78 u_int quirks; /* Chip specific quirks */
79 u_int caps; /* If we override SDHCI_CAPABILITIES */
80 uint32_t max_clk; /* Max possible freq */
81 struct resource *irq_res; /* IRQ resource */
82 void *intrhand; /* Interrupt handle */
84 int num_slots; /* Number of slots on this controller*/
85 struct sdhci_slot slots[MAX_SLOTS];
86 struct resource *mem_res[MAX_SLOTS]; /* Memory resource */
88 bool wp_inverted; /* WP pin is inverted */
89 bool no_18v; /* No 1.8V support */
93 sdhci_fdt_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off)
95 struct sdhci_fdt_softc *sc = device_get_softc(dev);
97 return (bus_read_1(sc->mem_res[slot->num], off));
101 sdhci_fdt_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off,
104 struct sdhci_fdt_softc *sc = device_get_softc(dev);
106 bus_write_1(sc->mem_res[slot->num], off, val);
110 sdhci_fdt_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off)
112 struct sdhci_fdt_softc *sc = device_get_softc(dev);
114 return (bus_read_2(sc->mem_res[slot->num], off));
118 sdhci_fdt_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off,
121 struct sdhci_fdt_softc *sc = device_get_softc(dev);
123 bus_write_2(sc->mem_res[slot->num], off, val);
127 sdhci_fdt_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off)
129 struct sdhci_fdt_softc *sc = device_get_softc(dev);
132 val32 = bus_read_4(sc->mem_res[slot->num], off);
133 if (off == SDHCI_CAPABILITIES && sc->no_18v)
134 val32 &= ~SDHCI_CAN_VDD_180;
140 sdhci_fdt_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off,
143 struct sdhci_fdt_softc *sc = device_get_softc(dev);
145 bus_write_4(sc->mem_res[slot->num], off, val);
149 sdhci_fdt_read_multi_4(device_t dev, struct sdhci_slot *slot,
150 bus_size_t off, uint32_t *data, bus_size_t count)
152 struct sdhci_fdt_softc *sc = device_get_softc(dev);
154 bus_read_multi_4(sc->mem_res[slot->num], off, data, count);
158 sdhci_fdt_write_multi_4(device_t dev, struct sdhci_slot *slot,
159 bus_size_t off, uint32_t *data, bus_size_t count)
161 struct sdhci_fdt_softc *sc = device_get_softc(dev);
163 bus_write_multi_4(sc->mem_res[slot->num], off, data, count);
167 sdhci_fdt_intr(void *arg)
169 struct sdhci_fdt_softc *sc = (struct sdhci_fdt_softc *)arg;
172 for (i = 0; i < sc->num_slots; i++)
173 sdhci_generic_intr(&sc->slots[i]);
177 sdhci_fdt_get_ro(device_t bus, device_t dev)
179 struct sdhci_fdt_softc *sc = device_get_softc(bus);
181 return (sdhci_generic_get_ro(bus, dev) ^ sc->wp_inverted);
185 sdhci_fdt_probe(device_t dev)
187 struct sdhci_fdt_softc *sc = device_get_softc(dev);
195 if (!ofw_bus_status_okay(dev))
198 switch (ofw_bus_search_compatible(dev, compat_data)->ocd_data) {
199 case SDHCI_FDT_ARMADA38X:
200 sc->quirks = SDHCI_QUIRK_BROKEN_AUTO_STOP;
201 device_set_desc(dev, "ARMADA38X SDHCI controller");
203 case SDHCI_FDT_GENERIC:
204 device_set_desc(dev, "generic fdt SDHCI controller");
206 case SDHCI_FDT_QUALCOMM:
207 sc->quirks = SDHCI_QUIRK_ALL_SLOTS_NON_REMOVABLE;
208 device_set_desc(dev, "Qualcomm FDT SDHCI controller");
210 case SDHCI_FDT_XLNX_ZY7:
211 sc->quirks = SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK;
212 device_set_desc(dev, "Zynq-7000 generic fdt SDHCI controller");
218 node = ofw_bus_get_node(dev);
220 /* Allow dts to patch quirks, slots, and max-frequency. */
221 if ((OF_getencprop(node, "quirks", &cid, sizeof(cid))) > 0)
223 if ((OF_getencprop(node, "num-slots", &cid, sizeof(cid))) > 0)
225 if ((OF_getencprop(node, "max-frequency", &cid, sizeof(cid))) > 0)
227 if (OF_hasprop(node, "no-1-8-v"))
229 if (OF_hasprop(node, "wp-inverted"))
230 sc->wp_inverted = true;
236 sdhci_fdt_attach(device_t dev)
238 struct sdhci_fdt_softc *sc = device_get_softc(dev);
239 struct sdhci_slot *slot;
240 int err, slots, rid, i;
246 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
248 if (sc->irq_res == NULL) {
249 device_printf(dev, "Can't allocate IRQ\n");
253 /* Scan all slots. */
254 slots = sc->num_slots; /* number of slots determined in probe(). */
256 for (i = 0; i < slots; i++) {
257 slot = &sc->slots[sc->num_slots];
259 /* Allocate memory. */
261 sc->mem_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
263 if (sc->mem_res[i] == NULL) {
265 "Can't allocate memory for slot %d\n", i);
269 slot->quirks = sc->quirks;
270 slot->caps = sc->caps;
271 slot->max_clk = sc->max_clk;
273 if (sdhci_init_slot(dev, slot, i) != 0)
278 device_printf(dev, "%d slot(s) allocated\n", sc->num_slots);
280 /* Activate the interrupt */
281 err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
282 NULL, sdhci_fdt_intr, sc, &sc->intrhand);
284 device_printf(dev, "Cannot setup IRQ\n");
288 /* Process cards detection. */
289 for (i = 0; i < sc->num_slots; i++)
290 sdhci_start_slot(&sc->slots[i]);
296 sdhci_fdt_detach(device_t dev)
298 struct sdhci_fdt_softc *sc = device_get_softc(dev);
301 bus_generic_detach(dev);
302 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
303 bus_release_resource(dev, SYS_RES_IRQ, rman_get_rid(sc->irq_res),
306 for (i = 0; i < sc->num_slots; i++) {
307 sdhci_cleanup_slot(&sc->slots[i]);
308 bus_release_resource(dev, SYS_RES_MEMORY,
309 rman_get_rid(sc->mem_res[i]), sc->mem_res[i]);
315 static device_method_t sdhci_fdt_methods[] = {
317 DEVMETHOD(device_probe, sdhci_fdt_probe),
318 DEVMETHOD(device_attach, sdhci_fdt_attach),
319 DEVMETHOD(device_detach, sdhci_fdt_detach),
322 DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar),
323 DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar),
326 DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios),
327 DEVMETHOD(mmcbr_request, sdhci_generic_request),
328 DEVMETHOD(mmcbr_get_ro, sdhci_fdt_get_ro),
329 DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host),
330 DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host),
332 /* SDHCI registers accessors */
333 DEVMETHOD(sdhci_read_1, sdhci_fdt_read_1),
334 DEVMETHOD(sdhci_read_2, sdhci_fdt_read_2),
335 DEVMETHOD(sdhci_read_4, sdhci_fdt_read_4),
336 DEVMETHOD(sdhci_read_multi_4, sdhci_fdt_read_multi_4),
337 DEVMETHOD(sdhci_write_1, sdhci_fdt_write_1),
338 DEVMETHOD(sdhci_write_2, sdhci_fdt_write_2),
339 DEVMETHOD(sdhci_write_4, sdhci_fdt_write_4),
340 DEVMETHOD(sdhci_write_multi_4, sdhci_fdt_write_multi_4),
345 static driver_t sdhci_fdt_driver = {
348 sizeof(struct sdhci_fdt_softc),
350 static devclass_t sdhci_fdt_devclass;
352 DRIVER_MODULE(sdhci_fdt, simplebus, sdhci_fdt_driver, sdhci_fdt_devclass,
354 MODULE_DEPEND(sdhci_fdt, sdhci, 1, 1, 1);
355 MMC_DECLARE_BRIDGE(sdhci_fdt);