2 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
35 #include <sys/endian.h>
36 #include <sys/kernel.h>
37 #include <sys/kthread.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/queue.h>
43 #include <sys/resource.h>
45 #include <sys/sysctl.h>
46 #include <sys/taskqueue.h>
48 #include <sys/timetc.h>
49 #include <sys/watchdog.h>
53 #include <machine/bus.h>
54 #include <machine/cpu.h>
55 #include <machine/cpufunc.h>
56 #include <machine/resource.h>
57 #include <machine/intr.h>
59 #include <dev/fdt/fdt_common.h>
60 #include <dev/ofw/ofw_bus.h>
61 #include <dev/ofw/ofw_bus_subr.h>
63 #include <dev/mmc/bridge.h>
64 #include <dev/mmc/mmcreg.h>
65 #include <dev/mmc/mmcbrvar.h>
67 #include <dev/sdhci/sdhci.h>
70 #include "bcm2835_dma.h"
71 #include "bcm2835_vcbus.h"
73 #define BCM2835_DEFAULT_SDHCI_FREQ 50
75 #define BCM_SDHCI_BUFFER_SIZE 512
78 #define dprintf(fmt, args...) do { printf("%s(): ", __func__); \
79 printf(fmt,##args); } while (0)
81 #define dprintf(fmt, args...)
85 * Arasan HC seems to have problem with Data CRC on lower frequencies.
86 * Use this tunable to cap initialization sequence frequency at higher
87 * value. Default is standard 400kHz
89 static int bcm2835_sdhci_min_freq = 400000;
90 static int bcm2835_sdhci_hs = 1;
91 static int bcm2835_sdhci_pio_mode = 0;
93 TUNABLE_INT("hw.bcm2835.sdhci.min_freq", &bcm2835_sdhci_min_freq);
94 TUNABLE_INT("hw.bcm2835.sdhci.hs", &bcm2835_sdhci_hs);
95 TUNABLE_INT("hw.bcm2835.sdhci.pio_mode", &bcm2835_sdhci_pio_mode);
97 struct bcm_sdhci_dmamap_arg {
98 bus_addr_t sc_dma_busaddr;
101 struct bcm_sdhci_softc {
104 struct resource * sc_mem_res;
105 struct resource * sc_irq_res;
106 bus_space_tag_t sc_bst;
107 bus_space_handle_t sc_bsh;
109 struct mmc_request * sc_req;
110 struct mmc_data * sc_data;
112 #define LPC_SD_FLAGS_IGNORECRC (1 << 0)
113 int sc_xfer_direction;
114 #define DIRECTION_READ 0
115 #define DIRECTION_WRITE 1
118 struct sdhci_slot sc_slot;
121 bus_dma_tag_t sc_dma_tag;
122 bus_dmamap_t sc_dma_map;
123 vm_paddr_t sc_sdhci_buffer_phys;
124 uint32_t cmd_and_mode;
127 static int bcm_sdhci_probe(device_t);
128 static int bcm_sdhci_attach(device_t);
129 static int bcm_sdhci_detach(device_t);
130 static void bcm_sdhci_intr(void *);
132 static int bcm_sdhci_get_ro(device_t, device_t);
133 static void bcm_sdhci_dma_intr(int ch, void *arg);
135 #define bcm_sdhci_lock(_sc) \
136 mtx_lock(&_sc->sc_mtx);
137 #define bcm_sdhci_unlock(_sc) \
138 mtx_unlock(&_sc->sc_mtx);
141 bcm_dmamap_cb(void *arg, bus_dma_segment_t *segs,
149 addr = (bus_addr_t*)arg;
150 *addr = segs[0].ds_addr;
154 bcm_sdhci_probe(device_t dev)
157 if (!ofw_bus_status_okay(dev))
160 if (!ofw_bus_is_compatible(dev, "broadcom,bcm2835-sdhci"))
163 device_set_desc(dev, "Broadcom 2708 SDHCI controller");
164 return (BUS_PROBE_DEFAULT);
168 bcm_sdhci_attach(device_t dev)
170 struct bcm_sdhci_softc *sc = device_get_softc(dev);
180 default_freq = BCM2835_DEFAULT_SDHCI_FREQ;
181 node = ofw_bus_get_node(sc->sc_dev);
182 if ((OF_getprop(node, "clock-frequency", &cell, sizeof(cell))) > 0)
183 default_freq = (int)fdt32_to_cpu(cell)/1000000;
185 dprintf("SDHCI frequency: %dMHz\n", default_freq);
187 mtx_init(&sc->sc_mtx, "bcm sdhci", "sdhci", MTX_DEF);
190 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
192 if (!sc->sc_mem_res) {
193 device_printf(dev, "cannot allocate memory window\n");
198 sc->sc_bst = rman_get_bustag(sc->sc_mem_res);
199 sc->sc_bsh = rman_get_bushandle(sc->sc_mem_res);
202 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
204 if (!sc->sc_irq_res) {
205 device_printf(dev, "cannot allocate interrupt\n");
206 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
211 if (bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
212 NULL, bcm_sdhci_intr, sc, &sc->sc_intrhand))
214 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
215 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
216 device_printf(dev, "cannot setup interrupt handler\n");
221 if (!bcm2835_sdhci_pio_mode)
222 sc->sc_slot.opt = SDHCI_PLATFORM_TRANSFER;
224 sc->sc_slot.caps = SDHCI_CAN_VDD_330 | SDHCI_CAN_VDD_180;
225 if (bcm2835_sdhci_hs)
226 sc->sc_slot.caps |= SDHCI_CAN_DO_HISPD;
227 sc->sc_slot.caps |= (default_freq << SDHCI_CLOCK_BASE_SHIFT);
228 sc->sc_slot.quirks = SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK
229 | SDHCI_QUIRK_BROKEN_TIMEOUT_VAL
230 | SDHCI_QUIRK_MISSING_CAPS;
232 sdhci_init_slot(dev, &sc->sc_slot, 0);
234 sc->sc_dma_ch = bcm_dma_allocate(BCM_DMA_CH_FAST1);
235 if (sc->sc_dma_ch == BCM_DMA_CH_INVALID)
236 sc->sc_dma_ch = bcm_dma_allocate(BCM_DMA_CH_FAST2);
237 if (sc->sc_dma_ch == BCM_DMA_CH_INVALID)
238 sc->sc_dma_ch = bcm_dma_allocate(BCM_DMA_CH_ANY);
239 if (sc->sc_dma_ch == BCM_DMA_CH_INVALID)
242 bcm_dma_setup_intr(sc->sc_dma_ch, bcm_sdhci_dma_intr, sc);
244 /* Allocate bus_dma resources. */
245 err = bus_dma_tag_create(bus_get_dma_tag(dev),
246 1, 0, BUS_SPACE_MAXADDR_32BIT,
247 BUS_SPACE_MAXADDR, NULL, NULL,
248 BCM_SDHCI_BUFFER_SIZE, 1, BCM_SDHCI_BUFFER_SIZE,
249 BUS_DMA_ALLOCNOW, NULL, NULL,
253 device_printf(dev, "failed allocate DMA tag");
257 err = bus_dmamap_create(sc->sc_dma_tag, 0, &sc->sc_dma_map);
259 device_printf(dev, "bus_dmamap_create failed\n");
263 sc->sc_sdhci_buffer_phys = BUS_SPACE_PHYSADDR(sc->sc_mem_res,
266 bus_generic_probe(dev);
267 bus_generic_attach(dev);
269 sdhci_start_slot(&sc->sc_slot);
275 bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intrhand);
277 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
279 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
285 bcm_sdhci_detach(device_t dev)
292 bcm_sdhci_intr(void *arg)
294 struct bcm_sdhci_softc *sc = arg;
296 sdhci_generic_intr(&sc->sc_slot);
300 bcm_sdhci_get_ro(device_t bus, device_t child)
306 static inline uint32_t
307 RD4(struct bcm_sdhci_softc *sc, bus_size_t off)
309 uint32_t val = bus_space_read_4(sc->sc_bst, sc->sc_bsh, off);
314 WR4(struct bcm_sdhci_softc *sc, bus_size_t off, uint32_t val)
316 bus_space_write_4(sc->sc_bst, sc->sc_bsh, off, val);
318 if ((off != SDHCI_BUFFER && off != SDHCI_INT_STATUS && off != SDHCI_CLOCK_CONTROL))
320 int timeout = 100000;
321 while (val != bus_space_read_4(sc->sc_bst, sc->sc_bsh, off)
326 printf("sdhci_brcm: writing 0x%X to reg 0x%X "
327 "always gives 0x%X\n",
329 bus_space_read_4(sc->sc_bst, sc->sc_bsh, off));
334 bcm_sdhci_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off)
336 struct bcm_sdhci_softc *sc = device_get_softc(dev);
337 uint32_t val = RD4(sc, off & ~3);
339 return ((val >> (off & 3)*8) & 0xff);
343 bcm_sdhci_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off)
345 struct bcm_sdhci_softc *sc = device_get_softc(dev);
346 uint32_t val = RD4(sc, off & ~3);
349 * Standard 32-bit handling of command and transfer mode.
351 if (off == SDHCI_TRANSFER_MODE) {
352 return (sc->cmd_and_mode >> 16);
353 } else if (off == SDHCI_COMMAND_FLAGS) {
354 return (sc->cmd_and_mode & 0x0000ffff);
356 return ((val >> (off & 3)*8) & 0xffff);
360 bcm_sdhci_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off)
362 struct bcm_sdhci_softc *sc = device_get_softc(dev);
368 bcm_sdhci_read_multi_4(device_t dev, struct sdhci_slot *slot, bus_size_t off,
369 uint32_t *data, bus_size_t count)
371 struct bcm_sdhci_softc *sc = device_get_softc(dev);
373 bus_space_read_multi_4(sc->sc_bst, sc->sc_bsh, off, data, count);
377 bcm_sdhci_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint8_t val)
379 struct bcm_sdhci_softc *sc = device_get_softc(dev);
380 uint32_t val32 = RD4(sc, off & ~3);
381 val32 &= ~(0xff << (off & 3)*8);
382 val32 |= (val << (off & 3)*8);
383 WR4(sc, off & ~3, val32);
387 bcm_sdhci_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint16_t val)
389 struct bcm_sdhci_softc *sc = device_get_softc(dev);
391 if (off == SDHCI_COMMAND_FLAGS)
392 val32 = sc->cmd_and_mode;
394 val32 = RD4(sc, off & ~3);
395 val32 &= ~(0xffff << (off & 3)*8);
396 val32 |= (val << (off & 3)*8);
397 if (off == SDHCI_TRANSFER_MODE)
398 sc->cmd_and_mode = val32;
400 WR4(sc, off & ~3, val32);
404 bcm_sdhci_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint32_t val)
406 struct bcm_sdhci_softc *sc = device_get_softc(dev);
411 bcm_sdhci_write_multi_4(device_t dev, struct sdhci_slot *slot, bus_size_t off,
412 uint32_t *data, bus_size_t count)
414 struct bcm_sdhci_softc *sc = device_get_softc(dev);
416 bus_space_write_multi_4(sc->sc_bst, sc->sc_bsh, off, data, count);
420 bcm_sdhci_min_freq(device_t dev, struct sdhci_slot *slot)
423 return bcm2835_sdhci_min_freq;
427 bcm_sdhci_dma_intr(int ch, void *arg)
429 struct bcm_sdhci_softc *sc = (struct bcm_sdhci_softc *)arg;
430 struct sdhci_slot *slot = &sc->sc_slot;
433 vm_paddr_t pdst, psrc;
437 mtx_lock(&slot->mtx);
439 len = bcm_dma_length(sc->sc_dma_ch);
440 if (slot->curcmd->data->flags & MMC_DATA_READ) {
441 sync_op = BUS_DMASYNC_POSTREAD;
442 mask = SDHCI_INT_DATA_AVAIL;
444 sync_op = BUS_DMASYNC_POSTWRITE;
445 mask = SDHCI_INT_SPACE_AVAIL;
447 bus_dmamap_sync(sc->sc_dma_tag, sc->sc_dma_map, sync_op);
448 bus_dmamap_unload(sc->sc_dma_tag, sc->sc_dma_map);
451 sc->sc_dma_inuse = 0;
453 left = min(BCM_SDHCI_BUFFER_SIZE,
454 slot->curcmd->data->len - slot->offset);
457 reg = bcm_sdhci_read_4(slot->bus, slot, SDHCI_INT_STATUS);
459 if (reg & SDHCI_INT_DATA_END) {
460 /* ACK for all outstanding interrupts */
461 bcm_sdhci_write_4(slot->bus, slot, SDHCI_INT_STATUS, reg);
464 slot->intmask |= SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL
465 | SDHCI_INT_DATA_END;
466 bcm_sdhci_write_4(slot->bus, slot, SDHCI_SIGNAL_ENABLE,
469 /* finish this data */
470 sdhci_finish_data(slot);
473 /* already available? */
475 sc->sc_dma_inuse = 1;
477 /* ACK for DATA_AVAIL or SPACE_AVAIL */
478 bcm_sdhci_write_4(slot->bus, slot,
479 SDHCI_INT_STATUS, mask);
481 /* continue next DMA transfer */
482 bus_dmamap_load(sc->sc_dma_tag, sc->sc_dma_map,
483 (uint8_t *)slot->curcmd->data->data +
484 slot->offset, left, bcm_dmamap_cb, &pmem, 0);
485 if (slot->curcmd->data->flags & MMC_DATA_READ) {
486 psrc = sc->sc_sdhci_buffer_phys;
488 sync_op = BUS_DMASYNC_PREREAD;
491 pdst = sc->sc_sdhci_buffer_phys;
492 sync_op = BUS_DMASYNC_PREWRITE;
494 bus_dmamap_sync(sc->sc_dma_tag, sc->sc_dma_map, sync_op);
495 if (bcm_dma_start(sc->sc_dma_ch, psrc, pdst, left)) {
496 /* XXX stop xfer, other error recovery? */
497 device_printf(sc->sc_dev, "failed DMA start\n");
500 /* wait for next data by INT */
503 slot->intmask |= SDHCI_INT_DATA_AVAIL |
504 SDHCI_INT_SPACE_AVAIL | SDHCI_INT_DATA_END;
505 bcm_sdhci_write_4(slot->bus, slot, SDHCI_SIGNAL_ENABLE,
510 mtx_unlock(&slot->mtx);
514 bcm_sdhci_read_dma(struct sdhci_slot *slot)
516 struct bcm_sdhci_softc *sc = device_get_softc(slot->bus);
520 if (sc->sc_dma_inuse) {
521 device_printf(sc->sc_dev, "DMA in use\n");
525 sc->sc_dma_inuse = 1;
527 left = min(BCM_SDHCI_BUFFER_SIZE,
528 slot->curcmd->data->len - slot->offset);
530 KASSERT((left & 3) == 0,
531 ("%s: len = %d, not word-aligned", __func__, left));
533 bcm_dma_setup_src(sc->sc_dma_ch, BCM_DMA_DREQ_EMMC,
534 BCM_DMA_SAME_ADDR, BCM_DMA_32BIT);
535 bcm_dma_setup_dst(sc->sc_dma_ch, BCM_DMA_DREQ_NONE,
537 (left & 0xf) ? BCM_DMA_32BIT : BCM_DMA_128BIT);
539 bus_dmamap_load(sc->sc_dma_tag, sc->sc_dma_map,
540 (uint8_t *)slot->curcmd->data->data + slot->offset, left,
541 bcm_dmamap_cb, &paddr, 0);
543 bus_dmamap_sync(sc->sc_dma_tag, sc->sc_dma_map,
544 BUS_DMASYNC_PREREAD);
547 if (bcm_dma_start(sc->sc_dma_ch, sc->sc_sdhci_buffer_phys,
549 device_printf(sc->sc_dev, "failed DMA start\n");
553 bcm_sdhci_write_dma(struct sdhci_slot *slot)
555 struct bcm_sdhci_softc *sc = device_get_softc(slot->bus);
559 if (sc->sc_dma_inuse) {
560 device_printf(sc->sc_dev, "DMA in use\n");
564 sc->sc_dma_inuse = 1;
566 left = min(BCM_SDHCI_BUFFER_SIZE,
567 slot->curcmd->data->len - slot->offset);
569 KASSERT((left & 3) == 0,
570 ("%s: len = %d, not word-aligned", __func__, left));
572 bus_dmamap_load(sc->sc_dma_tag, sc->sc_dma_map,
573 (uint8_t *)slot->curcmd->data->data + slot->offset, left,
574 bcm_dmamap_cb, &paddr, 0);
576 bcm_dma_setup_src(sc->sc_dma_ch, BCM_DMA_DREQ_NONE,
578 (left & 0xf) ? BCM_DMA_32BIT : BCM_DMA_128BIT);
579 bcm_dma_setup_dst(sc->sc_dma_ch, BCM_DMA_DREQ_EMMC,
580 BCM_DMA_SAME_ADDR, BCM_DMA_32BIT);
582 bus_dmamap_sync(sc->sc_dma_tag, sc->sc_dma_map,
583 BUS_DMASYNC_PREWRITE);
586 if (bcm_dma_start(sc->sc_dma_ch, paddr,
587 sc->sc_sdhci_buffer_phys, left) != 0)
588 device_printf(sc->sc_dev, "failed DMA start\n");
592 bcm_sdhci_will_handle_transfer(device_t dev, struct sdhci_slot *slot)
597 * Do not use DMA for transfers less than block size or with a length
598 * that is not a multiple of four.
600 left = min(BCM_DMA_BLOCK_SIZE,
601 slot->curcmd->data->len - slot->offset);
602 if (left < BCM_DMA_BLOCK_SIZE)
611 bcm_sdhci_start_transfer(device_t dev, struct sdhci_slot *slot,
616 slot->intmask &= ~(SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | SDHCI_INT_DATA_END);
617 bcm_sdhci_write_4(dev, slot, SDHCI_SIGNAL_ENABLE, slot->intmask);
619 /* DMA transfer FIFO 1KB */
620 if (slot->curcmd->data->flags & MMC_DATA_READ)
621 bcm_sdhci_read_dma(slot);
623 bcm_sdhci_write_dma(slot);
627 bcm_sdhci_finish_transfer(device_t dev, struct sdhci_slot *slot)
630 sdhci_finish_data(slot);
633 static device_method_t bcm_sdhci_methods[] = {
634 /* Device interface */
635 DEVMETHOD(device_probe, bcm_sdhci_probe),
636 DEVMETHOD(device_attach, bcm_sdhci_attach),
637 DEVMETHOD(device_detach, bcm_sdhci_detach),
640 DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar),
641 DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar),
642 DEVMETHOD(bus_print_child, bus_generic_print_child),
644 /* MMC bridge interface */
645 DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios),
646 DEVMETHOD(mmcbr_request, sdhci_generic_request),
647 DEVMETHOD(mmcbr_get_ro, bcm_sdhci_get_ro),
648 DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host),
649 DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host),
651 DEVMETHOD(sdhci_min_freq, bcm_sdhci_min_freq),
652 /* Platform transfer methods */
653 DEVMETHOD(sdhci_platform_will_handle, bcm_sdhci_will_handle_transfer),
654 DEVMETHOD(sdhci_platform_start_transfer, bcm_sdhci_start_transfer),
655 DEVMETHOD(sdhci_platform_finish_transfer, bcm_sdhci_finish_transfer),
656 /* SDHCI registers accessors */
657 DEVMETHOD(sdhci_read_1, bcm_sdhci_read_1),
658 DEVMETHOD(sdhci_read_2, bcm_sdhci_read_2),
659 DEVMETHOD(sdhci_read_4, bcm_sdhci_read_4),
660 DEVMETHOD(sdhci_read_multi_4, bcm_sdhci_read_multi_4),
661 DEVMETHOD(sdhci_write_1, bcm_sdhci_write_1),
662 DEVMETHOD(sdhci_write_2, bcm_sdhci_write_2),
663 DEVMETHOD(sdhci_write_4, bcm_sdhci_write_4),
664 DEVMETHOD(sdhci_write_multi_4, bcm_sdhci_write_multi_4),
669 static devclass_t bcm_sdhci_devclass;
671 static driver_t bcm_sdhci_driver = {
674 sizeof(struct bcm_sdhci_softc),
677 DRIVER_MODULE(sdhci_bcm, simplebus, bcm_sdhci_driver, bcm_sdhci_devclass, 0, 0);
678 MODULE_DEPEND(sdhci_bcm, sdhci, 1, 1, 1);