1249997Swkoszek/*- 2249997Swkoszek * Copyright (c) 2012 Thomas Skibo 3249997Swkoszek * Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org> 4249997Swkoszek * All rights reserved. 5249997Swkoszek * 6249997Swkoszek * Redistribution and use in source and binary forms, with or without 7249997Swkoszek * modification, are permitted provided that the following conditions 8249997Swkoszek * are met: 9249997Swkoszek * 1. Redistributions of source code must retain the above copyright 10249997Swkoszek * notice, this list of conditions and the following disclaimer. 11249997Swkoszek * 2. Redistributions in binary form must reproduce the above copyright 12249997Swkoszek * notice, this list of conditions and the following disclaimer in the 13249997Swkoszek * documentation and/or other materials provided with the distribution. 14249997Swkoszek * 15249997Swkoszek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16249997Swkoszek * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17249997Swkoszek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18249997Swkoszek * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19249997Swkoszek * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20249997Swkoszek * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21249997Swkoszek * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22249997Swkoszek * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23249997Swkoszek * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24249997Swkoszek * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25249997Swkoszek */ 26249997Swkoszek 27249997Swkoszek/* Generic driver to attach sdhci controllers on simplebus. 28249997Swkoszek * Derived mainly from sdhci_pci.c 29249997Swkoszek */ 30249997Swkoszek 31249997Swkoszek#include <sys/cdefs.h> 32249997Swkoszek__FBSDID("$FreeBSD: stable/11/sys/dev/sdhci/sdhci_fdt.c 343504 2019-01-27 19:04:28Z marius $"); 33249997Swkoszek 34249997Swkoszek#include <sys/param.h> 35249997Swkoszek#include <sys/systm.h> 36249997Swkoszek#include <sys/bus.h> 37249997Swkoszek#include <sys/kernel.h> 38249997Swkoszek#include <sys/lock.h> 39249997Swkoszek#include <sys/module.h> 40249997Swkoszek#include <sys/mutex.h> 41249997Swkoszek#include <sys/resource.h> 42249997Swkoszek#include <sys/rman.h> 43249997Swkoszek#include <sys/sysctl.h> 44249997Swkoszek#include <sys/taskqueue.h> 45249997Swkoszek 46249997Swkoszek#include <machine/bus.h> 47249997Swkoszek#include <machine/resource.h> 48249997Swkoszek 49249997Swkoszek#include <dev/fdt/fdt_common.h> 50249997Swkoszek#include <dev/ofw/ofw_bus.h> 51249997Swkoszek#include <dev/ofw/ofw_bus_subr.h> 52249997Swkoszek 53249997Swkoszek#include <dev/mmc/bridge.h> 54318197Smarius 55249997Swkoszek#include <dev/sdhci/sdhci.h> 56249997Swkoszek 57249997Swkoszek#include "mmcbr_if.h" 58249997Swkoszek#include "sdhci_if.h" 59249997Swkoszek 60318197Smarius#define MAX_SLOTS 6 61249997Swkoszek 62249997Swkoszekstruct sdhci_fdt_softc { 63249997Swkoszek device_t dev; /* Controller device */ 64249997Swkoszek u_int quirks; /* Chip specific quirks */ 65249997Swkoszek u_int caps; /* If we override SDHCI_CAPABILITIES */ 66265208Sian uint32_t max_clk; /* Max possible freq */ 67249997Swkoszek struct resource *irq_res; /* IRQ resource */ 68318197Smarius void *intrhand; /* Interrupt handle */ 69249997Swkoszek 70249997Swkoszek int num_slots; /* Number of slots on this controller*/ 71249997Swkoszek struct sdhci_slot slots[MAX_SLOTS]; 72249997Swkoszek struct resource *mem_res[MAX_SLOTS]; /* Memory resource */ 73337858Sloos 74337858Sloos bool wp_inverted; /* WP pin is inverted */ 75337858Sloos bool no_18v; /* No 1.8V support */ 76249997Swkoszek}; 77249997Swkoszek 78249997Swkoszekstatic uint8_t 79249997Swkoszeksdhci_fdt_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off) 80249997Swkoszek{ 81249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 82318197Smarius 83249997Swkoszek return (bus_read_1(sc->mem_res[slot->num], off)); 84249997Swkoszek} 85249997Swkoszek 86249997Swkoszekstatic void 87249997Swkoszeksdhci_fdt_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, 88318197Smarius uint8_t val) 89249997Swkoszek{ 90249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 91318197Smarius 92249997Swkoszek bus_write_1(sc->mem_res[slot->num], off, val); 93249997Swkoszek} 94249997Swkoszek 95249997Swkoszekstatic uint16_t 96249997Swkoszeksdhci_fdt_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off) 97249997Swkoszek{ 98249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 99318197Smarius 100249997Swkoszek return (bus_read_2(sc->mem_res[slot->num], off)); 101249997Swkoszek} 102249997Swkoszek 103249997Swkoszekstatic void 104249997Swkoszeksdhci_fdt_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, 105318197Smarius uint16_t val) 106249997Swkoszek{ 107249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 108318197Smarius 109249997Swkoszek bus_write_2(sc->mem_res[slot->num], off, val); 110249997Swkoszek} 111249997Swkoszek 112249997Swkoszekstatic uint32_t 113249997Swkoszeksdhci_fdt_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off) 114249997Swkoszek{ 115249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 116337858Sloos uint32_t val32; 117318197Smarius 118337858Sloos val32 = bus_read_4(sc->mem_res[slot->num], off); 119337858Sloos if (off == SDHCI_CAPABILITIES && sc->no_18v) 120337858Sloos val32 &= ~SDHCI_CAN_VDD_180; 121337858Sloos 122337858Sloos return (val32); 123249997Swkoszek} 124249997Swkoszek 125249997Swkoszekstatic void 126249997Swkoszeksdhci_fdt_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, 127318197Smarius uint32_t val) 128249997Swkoszek{ 129249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 130318197Smarius 131249997Swkoszek bus_write_4(sc->mem_res[slot->num], off, val); 132249997Swkoszek} 133249997Swkoszek 134249997Swkoszekstatic void 135249997Swkoszeksdhci_fdt_read_multi_4(device_t dev, struct sdhci_slot *slot, 136249997Swkoszek bus_size_t off, uint32_t *data, bus_size_t count) 137249997Swkoszek{ 138249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 139318197Smarius 140249997Swkoszek bus_read_multi_4(sc->mem_res[slot->num], off, data, count); 141249997Swkoszek} 142249997Swkoszek 143249997Swkoszekstatic void 144249997Swkoszeksdhci_fdt_write_multi_4(device_t dev, struct sdhci_slot *slot, 145249997Swkoszek bus_size_t off, uint32_t *data, bus_size_t count) 146249997Swkoszek{ 147249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 148318197Smarius 149249997Swkoszek bus_write_multi_4(sc->mem_res[slot->num], off, data, count); 150249997Swkoszek} 151249997Swkoszek 152249997Swkoszekstatic void 153249997Swkoszeksdhci_fdt_intr(void *arg) 154249997Swkoszek{ 155249997Swkoszek struct sdhci_fdt_softc *sc = (struct sdhci_fdt_softc *)arg; 156249997Swkoszek int i; 157249997Swkoszek 158318197Smarius for (i = 0; i < sc->num_slots; i++) 159318197Smarius sdhci_generic_intr(&sc->slots[i]); 160249997Swkoszek} 161249997Swkoszek 162249997Swkoszekstatic int 163337858Sloossdhci_fdt_get_ro(device_t bus, device_t dev) 164337858Sloos{ 165337858Sloos struct sdhci_fdt_softc *sc = device_get_softc(bus); 166337858Sloos 167337858Sloos return (sdhci_generic_get_ro(bus, dev) ^ sc->wp_inverted); 168337858Sloos} 169337858Sloos 170337858Sloosstatic int 171249997Swkoszeksdhci_fdt_probe(device_t dev) 172249997Swkoszek{ 173249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 174249997Swkoszek phandle_t node; 175249997Swkoszek pcell_t cid; 176249997Swkoszek 177249997Swkoszek sc->quirks = 0; 178249997Swkoszek sc->num_slots = 1; 179265208Sian sc->max_clk = 0; 180249997Swkoszek 181261410Sian if (!ofw_bus_status_okay(dev)) 182261410Sian return (ENXIO); 183261410Sian 184249997Swkoszek if (ofw_bus_is_compatible(dev, "sdhci_generic")) { 185249997Swkoszek device_set_desc(dev, "generic fdt SDHCI controller"); 186249997Swkoszek } else if (ofw_bus_is_compatible(dev, "xlnx,zy7_sdhci")) { 187249997Swkoszek sc->quirks = SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK; 188249997Swkoszek device_set_desc(dev, "Zynq-7000 generic fdt SDHCI controller"); 189249997Swkoszek } else 190249997Swkoszek return (ENXIO); 191249997Swkoszek 192249997Swkoszek node = ofw_bus_get_node(dev); 193249997Swkoszek 194265208Sian /* Allow dts to patch quirks, slots, and max-frequency. */ 195265208Sian if ((OF_getencprop(node, "quirks", &cid, sizeof(cid))) > 0) 196265208Sian sc->quirks = cid; 197265208Sian if ((OF_getencprop(node, "num-slots", &cid, sizeof(cid))) > 0) 198265208Sian sc->num_slots = cid; 199265208Sian if ((OF_getencprop(node, "max-frequency", &cid, sizeof(cid))) > 0) 200265208Sian sc->max_clk = cid; 201337858Sloos if (OF_hasprop(node, "no-1-8-v")) 202337858Sloos sc->no_18v = true; 203337858Sloos if (OF_hasprop(node, "wp-inverted")) 204337858Sloos sc->wp_inverted = true; 205265208Sian 206249997Swkoszek return (0); 207249997Swkoszek} 208249997Swkoszek 209249997Swkoszekstatic int 210249997Swkoszeksdhci_fdt_attach(device_t dev) 211249997Swkoszek{ 212249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 213318197Smarius struct sdhci_slot *slot; 214249997Swkoszek int err, slots, rid, i; 215270885Smarius 216249997Swkoszek sc->dev = dev; 217249997Swkoszek 218249997Swkoszek /* Allocate IRQ. */ 219249997Swkoszek rid = 0; 220249997Swkoszek sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 221318197Smarius RF_ACTIVE); 222249997Swkoszek if (sc->irq_res == NULL) { 223249997Swkoszek device_printf(dev, "Can't allocate IRQ\n"); 224249997Swkoszek return (ENOMEM); 225249997Swkoszek } 226249997Swkoszek 227249997Swkoszek /* Scan all slots. */ 228249997Swkoszek slots = sc->num_slots; /* number of slots determined in probe(). */ 229249997Swkoszek sc->num_slots = 0; 230249997Swkoszek for (i = 0; i < slots; i++) { 231318197Smarius slot = &sc->slots[sc->num_slots]; 232249997Swkoszek 233249997Swkoszek /* Allocate memory. */ 234249997Swkoszek rid = 0; 235249997Swkoszek sc->mem_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 236249997Swkoszek &rid, RF_ACTIVE); 237249997Swkoszek if (sc->mem_res[i] == NULL) { 238318197Smarius device_printf(dev, 239318197Smarius "Can't allocate memory for slot %d\n", i); 240249997Swkoszek continue; 241249997Swkoszek } 242249997Swkoszek 243249997Swkoszek slot->quirks = sc->quirks; 244249997Swkoszek slot->caps = sc->caps; 245265208Sian slot->max_clk = sc->max_clk; 246249997Swkoszek 247249997Swkoszek if (sdhci_init_slot(dev, slot, i) != 0) 248249997Swkoszek continue; 249249997Swkoszek 250249997Swkoszek sc->num_slots++; 251249997Swkoszek } 252249997Swkoszek device_printf(dev, "%d slot(s) allocated\n", sc->num_slots); 253249997Swkoszek 254249997Swkoszek /* Activate the interrupt */ 255249997Swkoszek err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE, 256249997Swkoszek NULL, sdhci_fdt_intr, sc, &sc->intrhand); 257249997Swkoszek if (err) { 258249997Swkoszek device_printf(dev, "Cannot setup IRQ\n"); 259249997Swkoszek return (err); 260249997Swkoszek } 261249997Swkoszek 262249997Swkoszek /* Process cards detection. */ 263318197Smarius for (i = 0; i < sc->num_slots; i++) 264318197Smarius sdhci_start_slot(&sc->slots[i]); 265270885Smarius 266249997Swkoszek return (0); 267249997Swkoszek} 268249997Swkoszek 269249997Swkoszekstatic int 270249997Swkoszeksdhci_fdt_detach(device_t dev) 271249997Swkoszek{ 272249997Swkoszek struct sdhci_fdt_softc *sc = device_get_softc(dev); 273249997Swkoszek int i; 274249997Swkoszek 275249997Swkoszek bus_generic_detach(dev); 276249997Swkoszek bus_teardown_intr(dev, sc->irq_res, sc->intrhand); 277249997Swkoszek bus_release_resource(dev, SYS_RES_IRQ, rman_get_rid(sc->irq_res), 278318197Smarius sc->irq_res); 279249997Swkoszek 280249997Swkoszek for (i = 0; i < sc->num_slots; i++) { 281318197Smarius sdhci_cleanup_slot(&sc->slots[i]); 282249997Swkoszek bus_release_resource(dev, SYS_RES_MEMORY, 283318197Smarius rman_get_rid(sc->mem_res[i]), sc->mem_res[i]); 284249997Swkoszek } 285249997Swkoszek 286249997Swkoszek return (0); 287249997Swkoszek} 288249997Swkoszek 289249997Swkoszekstatic device_method_t sdhci_fdt_methods[] = { 290249997Swkoszek /* device_if */ 291318197Smarius DEVMETHOD(device_probe, sdhci_fdt_probe), 292318197Smarius DEVMETHOD(device_attach, sdhci_fdt_attach), 293318197Smarius DEVMETHOD(device_detach, sdhci_fdt_detach), 294249997Swkoszek 295249997Swkoszek /* Bus interface */ 296249997Swkoszek DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar), 297249997Swkoszek DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar), 298249997Swkoszek 299249997Swkoszek /* mmcbr_if */ 300318197Smarius DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios), 301318197Smarius DEVMETHOD(mmcbr_request, sdhci_generic_request), 302337858Sloos DEVMETHOD(mmcbr_get_ro, sdhci_fdt_get_ro), 303318197Smarius DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host), 304318197Smarius DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host), 305249997Swkoszek 306249997Swkoszek /* SDHCI registers accessors */ 307249997Swkoszek DEVMETHOD(sdhci_read_1, sdhci_fdt_read_1), 308249997Swkoszek DEVMETHOD(sdhci_read_2, sdhci_fdt_read_2), 309249997Swkoszek DEVMETHOD(sdhci_read_4, sdhci_fdt_read_4), 310249997Swkoszek DEVMETHOD(sdhci_read_multi_4, sdhci_fdt_read_multi_4), 311249997Swkoszek DEVMETHOD(sdhci_write_1, sdhci_fdt_write_1), 312249997Swkoszek DEVMETHOD(sdhci_write_2, sdhci_fdt_write_2), 313249997Swkoszek DEVMETHOD(sdhci_write_4, sdhci_fdt_write_4), 314249997Swkoszek DEVMETHOD(sdhci_write_multi_4, sdhci_fdt_write_multi_4), 315249997Swkoszek 316249997Swkoszek DEVMETHOD_END 317249997Swkoszek}; 318249997Swkoszek 319249997Swkoszekstatic driver_t sdhci_fdt_driver = { 320249997Swkoszek "sdhci_fdt", 321249997Swkoszek sdhci_fdt_methods, 322249997Swkoszek sizeof(struct sdhci_fdt_softc), 323249997Swkoszek}; 324249997Swkoszekstatic devclass_t sdhci_fdt_devclass; 325249997Swkoszek 326270885SmariusDRIVER_MODULE(sdhci_fdt, simplebus, sdhci_fdt_driver, sdhci_fdt_devclass, 327270885Smarius NULL, NULL); 328343504SmariusSDHCI_DEPEND(sdhci_fdt); 329318197SmariusMMC_DECLARE_BRIDGE(sdhci_fdt); 330