1a9caca6aSWojciech A. Koszek /*- 2a9caca6aSWojciech A. Koszek * Copyright (c) 2012 Thomas Skibo 3a9caca6aSWojciech A. Koszek * Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org> 4a9caca6aSWojciech A. Koszek * All rights reserved. 5a9caca6aSWojciech A. Koszek * 6a9caca6aSWojciech A. Koszek * Redistribution and use in source and binary forms, with or without 7a9caca6aSWojciech A. Koszek * modification, are permitted provided that the following conditions 8a9caca6aSWojciech A. Koszek * are met: 9a9caca6aSWojciech A. Koszek * 1. Redistributions of source code must retain the above copyright 10a9caca6aSWojciech A. Koszek * notice, this list of conditions and the following disclaimer. 11a9caca6aSWojciech A. Koszek * 2. Redistributions in binary form must reproduce the above copyright 12a9caca6aSWojciech A. Koszek * notice, this list of conditions and the following disclaimer in the 13a9caca6aSWojciech A. Koszek * documentation and/or other materials provided with the distribution. 14a9caca6aSWojciech A. Koszek * 15a9caca6aSWojciech A. Koszek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16a9caca6aSWojciech A. Koszek * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17a9caca6aSWojciech A. Koszek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18a9caca6aSWojciech A. Koszek * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19a9caca6aSWojciech A. Koszek * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20a9caca6aSWojciech A. Koszek * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21a9caca6aSWojciech A. Koszek * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22a9caca6aSWojciech A. Koszek * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23a9caca6aSWojciech A. Koszek * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24a9caca6aSWojciech A. Koszek * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25a9caca6aSWojciech A. Koszek */ 26a9caca6aSWojciech A. Koszek 27a9caca6aSWojciech A. Koszek /* Generic driver to attach sdhci controllers on simplebus. 28a9caca6aSWojciech A. Koszek * Derived mainly from sdhci_pci.c 29a9caca6aSWojciech A. Koszek */ 30a9caca6aSWojciech A. Koszek 31a9caca6aSWojciech A. Koszek #include <sys/cdefs.h> 32a9caca6aSWojciech A. Koszek __FBSDID("$FreeBSD$"); 33a9caca6aSWojciech A. Koszek 34a9caca6aSWojciech A. Koszek #include <sys/param.h> 35a9caca6aSWojciech A. Koszek #include <sys/systm.h> 36a9caca6aSWojciech A. Koszek #include <sys/bus.h> 37a9caca6aSWojciech A. Koszek #include <sys/conf.h> 38a9caca6aSWojciech A. Koszek #include <sys/kernel.h> 39a9caca6aSWojciech A. Koszek #include <sys/lock.h> 40a9caca6aSWojciech A. Koszek #include <sys/module.h> 41a9caca6aSWojciech A. Koszek #include <sys/mutex.h> 42a9caca6aSWojciech A. Koszek #include <sys/resource.h> 43a9caca6aSWojciech A. Koszek #include <sys/rman.h> 44a9caca6aSWojciech A. Koszek #include <sys/sysctl.h> 45a9caca6aSWojciech A. Koszek #include <sys/taskqueue.h> 46a9caca6aSWojciech A. Koszek 47a9caca6aSWojciech A. Koszek #include <machine/bus.h> 48a9caca6aSWojciech A. Koszek #include <machine/resource.h> 49a9caca6aSWojciech A. Koszek #include <machine/stdarg.h> 50a9caca6aSWojciech A. Koszek 51a9caca6aSWojciech A. Koszek #include <dev/fdt/fdt_common.h> 52a9caca6aSWojciech A. Koszek #include <dev/ofw/ofw_bus.h> 53a9caca6aSWojciech A. Koszek #include <dev/ofw/ofw_bus_subr.h> 54a9caca6aSWojciech A. Koszek 55a9caca6aSWojciech A. Koszek #include <dev/mmc/bridge.h> 56a9caca6aSWojciech A. Koszek #include <dev/mmc/mmcreg.h> 57a9caca6aSWojciech A. Koszek #include <dev/mmc/mmcbrvar.h> 58a9caca6aSWojciech A. Koszek #include <dev/sdhci/sdhci.h> 59a9caca6aSWojciech A. Koszek 60a9caca6aSWojciech A. Koszek #include "mmcbr_if.h" 61a9caca6aSWojciech A. Koszek #include "sdhci_if.h" 62a9caca6aSWojciech A. Koszek 63a9caca6aSWojciech A. Koszek #define MAX_SLOTS 6 64a9caca6aSWojciech A. Koszek 65a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc { 66a9caca6aSWojciech A. Koszek device_t dev; /* Controller device */ 67a9caca6aSWojciech A. Koszek u_int quirks; /* Chip specific quirks */ 68a9caca6aSWojciech A. Koszek u_int caps; /* If we override SDHCI_CAPABILITIES */ 69a9caca6aSWojciech A. Koszek struct resource *irq_res; /* IRQ resource */ 70a9caca6aSWojciech A. Koszek void *intrhand; /* Interrupt handle */ 71a9caca6aSWojciech A. Koszek 72a9caca6aSWojciech A. Koszek int num_slots; /* Number of slots on this controller*/ 73a9caca6aSWojciech A. Koszek struct sdhci_slot slots[MAX_SLOTS]; 74a9caca6aSWojciech A. Koszek struct resource *mem_res[MAX_SLOTS]; /* Memory resource */ 75a9caca6aSWojciech A. Koszek }; 76a9caca6aSWojciech A. Koszek 77a9caca6aSWojciech A. Koszek static uint8_t 78a9caca6aSWojciech A. Koszek sdhci_fdt_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off) 79a9caca6aSWojciech A. Koszek { 80a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 81a9caca6aSWojciech A. Koszek return (bus_read_1(sc->mem_res[slot->num], off)); 82a9caca6aSWojciech A. Koszek } 83a9caca6aSWojciech A. Koszek 84a9caca6aSWojciech A. Koszek static void 85a9caca6aSWojciech A. Koszek sdhci_fdt_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, 86a9caca6aSWojciech A. Koszek uint8_t val) 87a9caca6aSWojciech A. Koszek { 88a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 89a9caca6aSWojciech A. Koszek bus_write_1(sc->mem_res[slot->num], off, val); 90a9caca6aSWojciech A. Koszek } 91a9caca6aSWojciech A. Koszek 92a9caca6aSWojciech A. Koszek static uint16_t 93a9caca6aSWojciech A. Koszek sdhci_fdt_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off) 94a9caca6aSWojciech A. Koszek { 95a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 96a9caca6aSWojciech A. Koszek return (bus_read_2(sc->mem_res[slot->num], off)); 97a9caca6aSWojciech A. Koszek } 98a9caca6aSWojciech A. Koszek 99a9caca6aSWojciech A. Koszek static void 100a9caca6aSWojciech A. Koszek sdhci_fdt_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, 101a9caca6aSWojciech A. Koszek uint16_t val) 102a9caca6aSWojciech A. Koszek { 103a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 104a9caca6aSWojciech A. Koszek bus_write_2(sc->mem_res[slot->num], off, val); 105a9caca6aSWojciech A. Koszek } 106a9caca6aSWojciech A. Koszek 107a9caca6aSWojciech A. Koszek static uint32_t 108a9caca6aSWojciech A. Koszek sdhci_fdt_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off) 109a9caca6aSWojciech A. Koszek { 110a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 111a9caca6aSWojciech A. Koszek return (bus_read_4(sc->mem_res[slot->num], off)); 112a9caca6aSWojciech A. Koszek } 113a9caca6aSWojciech A. Koszek 114a9caca6aSWojciech A. Koszek static void 115a9caca6aSWojciech A. Koszek sdhci_fdt_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, 116a9caca6aSWojciech A. Koszek uint32_t val) 117a9caca6aSWojciech A. Koszek { 118a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 119a9caca6aSWojciech A. Koszek bus_write_4(sc->mem_res[slot->num], off, val); 120a9caca6aSWojciech A. Koszek } 121a9caca6aSWojciech A. Koszek 122a9caca6aSWojciech A. Koszek static void 123a9caca6aSWojciech A. Koszek sdhci_fdt_read_multi_4(device_t dev, struct sdhci_slot *slot, 124a9caca6aSWojciech A. Koszek bus_size_t off, uint32_t *data, bus_size_t count) 125a9caca6aSWojciech A. Koszek { 126a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 127a9caca6aSWojciech A. Koszek bus_read_multi_4(sc->mem_res[slot->num], off, data, count); 128a9caca6aSWojciech A. Koszek } 129a9caca6aSWojciech A. Koszek 130a9caca6aSWojciech A. Koszek static void 131a9caca6aSWojciech A. Koszek sdhci_fdt_write_multi_4(device_t dev, struct sdhci_slot *slot, 132a9caca6aSWojciech A. Koszek bus_size_t off, uint32_t *data, bus_size_t count) 133a9caca6aSWojciech A. Koszek { 134a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 135a9caca6aSWojciech A. Koszek bus_write_multi_4(sc->mem_res[slot->num], off, data, count); 136a9caca6aSWojciech A. Koszek } 137a9caca6aSWojciech A. Koszek 138a9caca6aSWojciech A. Koszek static void 139a9caca6aSWojciech A. Koszek sdhci_fdt_intr(void *arg) 140a9caca6aSWojciech A. Koszek { 141a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = (struct sdhci_fdt_softc *)arg; 142a9caca6aSWojciech A. Koszek int i; 143a9caca6aSWojciech A. Koszek 144a9caca6aSWojciech A. Koszek for (i = 0; i < sc->num_slots; i++) { 145a9caca6aSWojciech A. Koszek struct sdhci_slot *slot = &sc->slots[i]; 146a9caca6aSWojciech A. Koszek sdhci_generic_intr(slot); 147a9caca6aSWojciech A. Koszek } 148a9caca6aSWojciech A. Koszek } 149a9caca6aSWojciech A. Koszek 150a9caca6aSWojciech A. Koszek static int 151a9caca6aSWojciech A. Koszek sdhci_fdt_probe(device_t dev) 152a9caca6aSWojciech A. Koszek { 153a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 154a9caca6aSWojciech A. Koszek phandle_t node; 155a9caca6aSWojciech A. Koszek pcell_t cid; 156a9caca6aSWojciech A. Koszek 157a9caca6aSWojciech A. Koszek sc->quirks = 0; 158a9caca6aSWojciech A. Koszek sc->num_slots = 1; 159a9caca6aSWojciech A. Koszek 160add35ed5SIan Lepore if (!ofw_bus_status_okay(dev)) 161add35ed5SIan Lepore return (ENXIO); 162add35ed5SIan Lepore 163a9caca6aSWojciech A. Koszek if (ofw_bus_is_compatible(dev, "sdhci_generic")) { 164a9caca6aSWojciech A. Koszek device_set_desc(dev, "generic fdt SDHCI controller"); 165a9caca6aSWojciech A. Koszek } else if (ofw_bus_is_compatible(dev, "xlnx,zy7_sdhci")) { 166a9caca6aSWojciech A. Koszek sc->quirks = SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK; 167a9caca6aSWojciech A. Koszek device_set_desc(dev, "Zynq-7000 generic fdt SDHCI controller"); 168a9caca6aSWojciech A. Koszek } else 169a9caca6aSWojciech A. Koszek return (ENXIO); 170a9caca6aSWojciech A. Koszek 171a9caca6aSWojciech A. Koszek node = ofw_bus_get_node(dev); 172a9caca6aSWojciech A. Koszek 173a9caca6aSWojciech A. Koszek /* Allow dts to patch quirks and slots. */ 174a9caca6aSWojciech A. Koszek if ((OF_getprop(node, "quirks", &cid, sizeof(cid))) > 0) 175a9caca6aSWojciech A. Koszek sc->quirks = fdt32_to_cpu(cid); 176a9caca6aSWojciech A. Koszek if ((OF_getprop(node, "num-slots", &cid, sizeof(cid))) > 0) 177a9caca6aSWojciech A. Koszek sc->num_slots = fdt32_to_cpu(cid); 178a9caca6aSWojciech A. Koszek 179a9caca6aSWojciech A. Koszek return (0); 180a9caca6aSWojciech A. Koszek } 181a9caca6aSWojciech A. Koszek 182a9caca6aSWojciech A. Koszek static int 183a9caca6aSWojciech A. Koszek sdhci_fdt_attach(device_t dev) 184a9caca6aSWojciech A. Koszek { 185a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 186a9caca6aSWojciech A. Koszek int err, slots, rid, i; 187a9caca6aSWojciech A. Koszek 188a9caca6aSWojciech A. Koszek sc->dev = dev; 189a9caca6aSWojciech A. Koszek 190a9caca6aSWojciech A. Koszek /* Allocate IRQ. */ 191a9caca6aSWojciech A. Koszek rid = 0; 192a9caca6aSWojciech A. Koszek sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 193a9caca6aSWojciech A. Koszek RF_ACTIVE); 194a9caca6aSWojciech A. Koszek if (sc->irq_res == NULL) { 195a9caca6aSWojciech A. Koszek device_printf(dev, "Can't allocate IRQ\n"); 196a9caca6aSWojciech A. Koszek return (ENOMEM); 197a9caca6aSWojciech A. Koszek } 198a9caca6aSWojciech A. Koszek 199a9caca6aSWojciech A. Koszek /* Scan all slots. */ 200a9caca6aSWojciech A. Koszek slots = sc->num_slots; /* number of slots determined in probe(). */ 201a9caca6aSWojciech A. Koszek sc->num_slots = 0; 202a9caca6aSWojciech A. Koszek for (i = 0; i < slots; i++) { 203a9caca6aSWojciech A. Koszek struct sdhci_slot *slot = &sc->slots[sc->num_slots]; 204a9caca6aSWojciech A. Koszek 205a9caca6aSWojciech A. Koszek /* Allocate memory. */ 206a9caca6aSWojciech A. Koszek rid = 0; 207a9caca6aSWojciech A. Koszek sc->mem_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 208a9caca6aSWojciech A. Koszek &rid, RF_ACTIVE); 209a9caca6aSWojciech A. Koszek if (sc->mem_res[i] == NULL) { 210a9caca6aSWojciech A. Koszek device_printf(dev, "Can't allocate memory for " 211a9caca6aSWojciech A. Koszek "slot %d\n", i); 212a9caca6aSWojciech A. Koszek continue; 213a9caca6aSWojciech A. Koszek } 214a9caca6aSWojciech A. Koszek 215a9caca6aSWojciech A. Koszek slot->quirks = sc->quirks; 216a9caca6aSWojciech A. Koszek slot->caps = sc->caps; 217a9caca6aSWojciech A. Koszek 218a9caca6aSWojciech A. Koszek if (sdhci_init_slot(dev, slot, i) != 0) 219a9caca6aSWojciech A. Koszek continue; 220a9caca6aSWojciech A. Koszek 221a9caca6aSWojciech A. Koszek sc->num_slots++; 222a9caca6aSWojciech A. Koszek } 223a9caca6aSWojciech A. Koszek device_printf(dev, "%d slot(s) allocated\n", sc->num_slots); 224a9caca6aSWojciech A. Koszek 225a9caca6aSWojciech A. Koszek /* Activate the interrupt */ 226a9caca6aSWojciech A. Koszek err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE, 227a9caca6aSWojciech A. Koszek NULL, sdhci_fdt_intr, sc, &sc->intrhand); 228a9caca6aSWojciech A. Koszek if (err) { 229a9caca6aSWojciech A. Koszek device_printf(dev, "Cannot setup IRQ\n"); 230a9caca6aSWojciech A. Koszek return (err); 231a9caca6aSWojciech A. Koszek } 232a9caca6aSWojciech A. Koszek 233a9caca6aSWojciech A. Koszek /* Process cards detection. */ 234a9caca6aSWojciech A. Koszek for (i = 0; i < sc->num_slots; i++) { 235a9caca6aSWojciech A. Koszek struct sdhci_slot *slot = &sc->slots[i]; 236a9caca6aSWojciech A. Koszek sdhci_start_slot(slot); 237a9caca6aSWojciech A. Koszek } 238a9caca6aSWojciech A. Koszek 239a9caca6aSWojciech A. Koszek return (0); 240a9caca6aSWojciech A. Koszek } 241a9caca6aSWojciech A. Koszek 242a9caca6aSWojciech A. Koszek static int 243a9caca6aSWojciech A. Koszek sdhci_fdt_detach(device_t dev) 244a9caca6aSWojciech A. Koszek { 245a9caca6aSWojciech A. Koszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 246a9caca6aSWojciech A. Koszek int i; 247a9caca6aSWojciech A. Koszek 248a9caca6aSWojciech A. Koszek bus_generic_detach(dev); 249a9caca6aSWojciech A. Koszek bus_teardown_intr(dev, sc->irq_res, sc->intrhand); 250a9caca6aSWojciech A. Koszek bus_release_resource(dev, SYS_RES_IRQ, rman_get_rid(sc->irq_res), 251a9caca6aSWojciech A. Koszek sc->irq_res); 252a9caca6aSWojciech A. Koszek 253a9caca6aSWojciech A. Koszek for (i = 0; i < sc->num_slots; i++) { 254a9caca6aSWojciech A. Koszek struct sdhci_slot *slot = &sc->slots[i]; 255a9caca6aSWojciech A. Koszek 256a9caca6aSWojciech A. Koszek sdhci_cleanup_slot(slot); 257a9caca6aSWojciech A. Koszek bus_release_resource(dev, SYS_RES_MEMORY, 258a9caca6aSWojciech A. Koszek rman_get_rid(sc->mem_res[i]), 259a9caca6aSWojciech A. Koszek sc->mem_res[i]); 260a9caca6aSWojciech A. Koszek } 261a9caca6aSWojciech A. Koszek 262a9caca6aSWojciech A. Koszek return (0); 263a9caca6aSWojciech A. Koszek } 264a9caca6aSWojciech A. Koszek 265a9caca6aSWojciech A. Koszek static device_method_t sdhci_fdt_methods[] = { 266a9caca6aSWojciech A. Koszek /* device_if */ 267a9caca6aSWojciech A. Koszek DEVMETHOD(device_probe, sdhci_fdt_probe), 268a9caca6aSWojciech A. Koszek DEVMETHOD(device_attach, sdhci_fdt_attach), 269a9caca6aSWojciech A. Koszek DEVMETHOD(device_detach, sdhci_fdt_detach), 270a9caca6aSWojciech A. Koszek 271a9caca6aSWojciech A. Koszek /* Bus interface */ 272a9caca6aSWojciech A. Koszek DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar), 273a9caca6aSWojciech A. Koszek DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar), 274a9caca6aSWojciech A. Koszek 275a9caca6aSWojciech A. Koszek /* mmcbr_if */ 276a9caca6aSWojciech A. Koszek DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios), 277a9caca6aSWojciech A. Koszek DEVMETHOD(mmcbr_request, sdhci_generic_request), 278a9caca6aSWojciech A. Koszek DEVMETHOD(mmcbr_get_ro, sdhci_generic_get_ro), 279a9caca6aSWojciech A. Koszek DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host), 280a9caca6aSWojciech A. Koszek DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host), 281a9caca6aSWojciech A. Koszek 282a9caca6aSWojciech A. Koszek /* SDHCI registers accessors */ 283a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_read_1, sdhci_fdt_read_1), 284a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_read_2, sdhci_fdt_read_2), 285a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_read_4, sdhci_fdt_read_4), 286a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_read_multi_4, sdhci_fdt_read_multi_4), 287a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_write_1, sdhci_fdt_write_1), 288a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_write_2, sdhci_fdt_write_2), 289a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_write_4, sdhci_fdt_write_4), 290a9caca6aSWojciech A. Koszek DEVMETHOD(sdhci_write_multi_4, sdhci_fdt_write_multi_4), 291a9caca6aSWojciech A. Koszek 292a9caca6aSWojciech A. Koszek DEVMETHOD_END 293a9caca6aSWojciech A. Koszek }; 294a9caca6aSWojciech A. Koszek 295a9caca6aSWojciech A. Koszek static driver_t sdhci_fdt_driver = { 296a9caca6aSWojciech A. Koszek "sdhci_fdt", 297a9caca6aSWojciech A. Koszek sdhci_fdt_methods, 298a9caca6aSWojciech A. Koszek sizeof(struct sdhci_fdt_softc), 299a9caca6aSWojciech A. Koszek }; 300a9caca6aSWojciech A. Koszek static devclass_t sdhci_fdt_devclass; 301a9caca6aSWojciech A. Koszek 302a9caca6aSWojciech A. Koszek DRIVER_MODULE(sdhci_fdt, simplebus, sdhci_fdt_driver, sdhci_fdt_devclass, 0,0); 303a9caca6aSWojciech A. Koszek MODULE_DEPEND(sdhci_fdt, sdhci, 1, 1, 1); 304