2 * Copyright 2015 John Wehle <john@feith.com>
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
28 * Amlogic aml8726-m8 (and later) SDXC host controller driver.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/resource.h>
47 #include <machine/bus.h>
48 #include <machine/cpu.h>
50 #include <dev/fdt/fdt_common.h>
51 #include <dev/ofw/ofw_bus.h>
52 #include <dev/ofw/ofw_bus_subr.h>
54 #include <dev/mmc/bridge.h>
55 #include <dev/mmc/mmcreg.h>
56 #include <dev/mmc/mmcbrvar.h>
58 #include <arm/amlogic/aml8726/aml8726_soc.h>
59 #include <arm/amlogic/aml8726/aml8726_sdxc-m8.h>
65 * The table is sorted from highest to lowest and
66 * last entry in the table is mark by freq == 0.
72 } aml8726_sdxc_clk_phases[] = {
74 MMC_OCR_LOW_VOLTAGE | MMC_OCR_320_330 | MMC_OCR_330_340,
79 MMC_OCR_320_330 | MMC_OCR_330_340,
89 MMC_OCR_LOW_VOLTAGE | MMC_OCR_320_330 | MMC_OCR_330_340,
94 MMC_OCR_LOW_VOLTAGE | MMC_OCR_320_330 | MMC_OCR_330_340,
99 MMC_OCR_LOW_VOLTAGE | MMC_OCR_320_330 | MMC_OCR_330_340,
104 MMC_OCR_LOW_VOLTAGE | MMC_OCR_320_330 | MMC_OCR_330_340,
110 struct aml8726_sdxc_gpio {
116 struct aml8726_sdxc_softc {
118 boolean_t auto_fill_flush;
119 struct resource *res[2];
122 unsigned int ref_freq;
123 struct aml8726_sdxc_gpio pwr_en;
125 struct aml8726_sdxc_gpio vselect;
126 struct aml8726_sdxc_gpio card_rst;
127 bus_dma_tag_t dmatag;
130 struct mmc_host host;
136 struct mmc_command *cmd;
139 static struct resource_spec aml8726_sdxc_spec[] = {
140 { SYS_RES_MEMORY, 0, RF_ACTIVE },
141 { SYS_RES_IRQ, 0, RF_ACTIVE },
145 #define AML_SDXC_LOCK(sc) mtx_lock(&(sc)->mtx)
146 #define AML_SDXC_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
147 #define AML_SDXC_LOCK_ASSERT(sc) mtx_assert(&(sc)->mtx, MA_OWNED)
148 #define AML_SDXC_LOCK_INIT(sc) \
149 mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), \
151 #define AML_SDXC_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx);
153 #define CSR_WRITE_4(sc, reg, val) bus_write_4((sc)->res[0], reg, (val))
154 #define CSR_READ_4(sc, reg) bus_read_4((sc)->res[0], reg)
155 #define CSR_BARRIER(sc, reg) bus_barrier((sc)->res[0], reg, 4, \
156 (BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE))
158 #define PIN_ON_FLAG(pol) ((pol) == 0 ? \
159 GPIO_PIN_LOW : GPIO_PIN_HIGH)
160 #define PIN_OFF_FLAG(pol) ((pol) == 0 ? \
161 GPIO_PIN_HIGH : GPIO_PIN_LOW)
163 #define msecs_to_ticks(ms) (((ms)*hz)/1000 + 1)
165 static void aml8726_sdxc_timeout(void *arg);
168 aml8726_sdxc_mapmem(void *arg, bus_dma_segment_t *segs, int nseg, int error)
170 bus_addr_t *busaddrp;
173 * There should only be one bus space address since
174 * bus_dma_tag_create was called with nsegments = 1.
177 busaddrp = (bus_addr_t *)arg;
178 *busaddrp = segs->ds_addr;
182 aml8726_sdxc_power_off(struct aml8726_sdxc_softc *sc)
185 if (sc->pwr_en.dev == NULL)
188 return (GPIO_PIN_SET(sc->pwr_en.dev, sc->pwr_en.pin,
189 PIN_OFF_FLAG(sc->pwr_en.pol)));
193 aml8726_sdxc_power_on(struct aml8726_sdxc_softc *sc)
196 if (sc->pwr_en.dev == NULL)
199 return (GPIO_PIN_SET(sc->pwr_en.dev, sc->pwr_en.pin,
200 PIN_ON_FLAG(sc->pwr_en.pol)));
204 aml8726_sdxc_soft_reset(struct aml8726_sdxc_softc *sc)
207 CSR_WRITE_4(sc, AML_SDXC_SOFT_RESET_REG, AML_SDXC_SOFT_RESET);
208 CSR_BARRIER(sc, AML_SDXC_SOFT_RESET_REG);
213 aml8726_sdxc_engage_dma(struct aml8726_sdxc_softc *sc)
218 struct mmc_data *data;
220 data = sc->cmd->data;
222 if (data == NULL || data->len == 0)
226 * Engaging the DMA hardware is recommended before writing
227 * to AML_SDXC_SEND_REG so that the FIFOs are ready to go.
229 * Presumably AML_SDXC_CNTRL_REG and AML_SDXC_DMA_ADDR_REG
230 * must be set up prior to this happening.
233 pdmar = CSR_READ_4(sc, AML_SDXC_PDMA_REG);
235 pdmar &= ~AML_SDXC_PDMA_RX_FLUSH_MODE_SW;
236 pdmar |= AML_SDXC_PDMA_DMA_EN;
238 if (sc->auto_fill_flush == true) {
239 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
240 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
244 if ((data->flags & MMC_DATA_READ) != 0) {
245 pdmar |= AML_SDXC_PDMA_RX_FLUSH_MODE_SW;
246 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
247 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
249 pdmar |= AML_SDXC_PDMA_TX_FILL;
250 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
251 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
254 * Wait up to 100us for data to show up.
256 for (i = 0; i < 100; i++) {
257 sr = CSR_READ_4(sc, AML_SDXC_STATUS_REG);
258 if ((sr & AML_SDXC_STATUS_TX_CNT_MASK) != 0)
263 device_printf(sc->dev, "TX FIFO fill timeout\n");
268 aml8726_sdxc_disengage_dma(struct aml8726_sdxc_softc *sc)
273 struct mmc_data *data;
275 data = sc->cmd->data;
277 if (data == NULL || data->len == 0)
280 pdmar = CSR_READ_4(sc, AML_SDXC_PDMA_REG);
282 if (sc->auto_fill_flush == true) {
283 pdmar &= ~AML_SDXC_PDMA_DMA_EN;
284 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
285 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
289 if ((data->flags & MMC_DATA_READ) != 0) {
290 pdmar |= AML_SDXC_PDMA_RX_FLUSH_NOW;
291 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
292 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
295 * Wait up to 100us for data to drain.
297 for (i = 0; i < 100; i++) {
298 sr = CSR_READ_4(sc, AML_SDXC_STATUS_REG);
299 if ((sr & AML_SDXC_STATUS_RX_CNT_MASK) == 0)
304 device_printf(sc->dev, "RX FIFO drain timeout\n");
307 pdmar &= ~(AML_SDXC_PDMA_DMA_EN | AML_SDXC_PDMA_RX_FLUSH_MODE_SW);
309 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
310 CSR_BARRIER(sc, AML_SDXC_PDMA_REG);
314 aml8726_sdxc_start_command(struct aml8726_sdxc_softc *sc,
315 struct mmc_command *cmd)
324 struct mmc_data *data;
326 AML_SDXC_LOCK_ASSERT(sc);
328 if (cmd->opcode > 0x3f)
329 return (MMC_ERR_INVALID);
332 * Ensure the hardware state machine is in a known state.
334 aml8726_sdxc_soft_reset(sc);
338 if ((cmd->flags & MMC_RSP_136) != 0) {
339 sndr |= AML_SDXC_SEND_CMD_HAS_RESP;
340 sndr |= AML_SDXC_SEND_RESP_136;
342 * According to the SD spec the 136 bit response is
343 * used for getting the CID or CSD in which case the
344 * CRC7 is embedded in the contents rather than being
345 * calculated over the entire response (the controller
346 * always checks the CRC7 over the entire response).
348 sndr |= AML_SDXC_SEND_RESP_NO_CRC7_CHECK;
349 } else if ((cmd->flags & MMC_RSP_PRESENT) != 0)
350 sndr |= AML_SDXC_SEND_CMD_HAS_RESP;
352 if ((cmd->flags & MMC_RSP_CRC) == 0)
353 sndr |= AML_SDXC_SEND_RESP_NO_CRC7_CHECK;
355 if (cmd->opcode == MMC_STOP_TRANSMISSION)
356 sndr |= AML_SDXC_SEND_DATA_STOP;
361 ctlr = CSR_READ_4(sc, AML_SDXC_CNTRL_REG);
362 ier = AML_SDXC_IRQ_ENABLE_STANDARD;
363 timeout = AML_SDXC_CMD_TIMEOUT;
365 ctlr &= ~AML_SDXC_CNTRL_PKG_LEN_MASK;
367 if (data && data->len &&
368 (data->flags & (MMC_DATA_READ | MMC_DATA_WRITE)) != 0) {
369 block_size = data->len;
371 if ((data->flags & MMC_DATA_MULTI) != 0) {
372 block_size = MMC_SECTOR_SIZE;
373 if ((data->len % block_size) != 0)
374 return (MMC_ERR_INVALID);
377 if (block_size > 512)
378 return (MMC_ERR_INVALID);
380 sndr |= AML_SDXC_SEND_CMD_HAS_DATA;
381 sndr |= ((data->flags & MMC_DATA_WRITE) != 0) ?
382 AML_SDXC_SEND_DATA_WRITE : 0;
383 sndr |= (((data->len / block_size) - 1) <<
384 AML_SDXC_SEND_REP_PKG_CNT_SHIFT);
386 ctlr |= ((block_size < 512) ? block_size : 0) <<
387 AML_SDXC_CNTRL_PKG_LEN_SHIFT;
389 ier &= ~AML_SDXC_IRQ_ENABLE_RESP_OK;
390 ier |= (sc->auto_fill_flush == true ||
391 (data->flags & MMC_DATA_WRITE) != 0) ?
392 AML_SDXC_IRQ_ENABLE_DMA_DONE :
393 AML_SDXC_IRQ_ENABLE_TRANSFER_DONE_OK;
395 error = bus_dmamap_load(sc->dmatag, sc->dmamap,
396 data->data, data->len, aml8726_sdxc_mapmem, &baddr,
399 return (MMC_ERR_NO_MEMORY);
401 if ((data->flags & MMC_DATA_READ) != 0) {
402 bus_dmamap_sync(sc->dmatag, sc->dmamap,
403 BUS_DMASYNC_PREREAD);
404 timeout = AML_SDXC_READ_TIMEOUT *
405 (data->len / block_size);
407 bus_dmamap_sync(sc->dmatag, sc->dmamap,
408 BUS_DMASYNC_PREWRITE);
409 timeout = AML_SDXC_WRITE_TIMEOUT *
410 (data->len / block_size);
416 cmd->error = MMC_ERR_NONE;
419 sc->busy.error = MMC_ERR_NONE;
421 if (timeout > AML_SDXC_MAX_TIMEOUT)
422 timeout = AML_SDXC_MAX_TIMEOUT;
424 callout_reset(&sc->ch, msecs_to_ticks(timeout),
425 aml8726_sdxc_timeout, sc);
427 CSR_WRITE_4(sc, AML_SDXC_IRQ_ENABLE_REG, ier);
429 CSR_WRITE_4(sc, AML_SDXC_CNTRL_REG, ctlr);
430 CSR_WRITE_4(sc, AML_SDXC_DMA_ADDR_REG, (uint32_t)baddr);
431 CSR_WRITE_4(sc, AML_SDXC_CMD_ARGUMENT_REG, cmd->arg);
433 aml8726_sdxc_engage_dma(sc);
435 CSR_WRITE_4(sc, AML_SDXC_SEND_REG, sndr);
436 CSR_BARRIER(sc, AML_SDXC_SEND_REG);
438 return (MMC_ERR_NONE);
442 aml8726_sdxc_finish_command(struct aml8726_sdxc_softc *sc, int mmc_error)
445 struct mmc_command *cmd;
446 struct mmc_command *stop_cmd;
447 struct mmc_data *data;
449 AML_SDXC_LOCK_ASSERT(sc);
451 /* Clear all interrupts since the request is no longer in flight. */
452 CSR_WRITE_4(sc, AML_SDXC_IRQ_STATUS_REG, AML_SDXC_IRQ_STATUS_CLEAR);
453 CSR_BARRIER(sc, AML_SDXC_IRQ_STATUS_REG);
455 /* In some cases (e.g. finish called via timeout) this is a NOP. */
456 callout_stop(&sc->ch);
461 cmd->error = mmc_error;
465 if (data && data->len
466 && (data->flags & (MMC_DATA_READ | MMC_DATA_WRITE)) != 0) {
467 if ((data->flags & MMC_DATA_READ) != 0)
468 bus_dmamap_sync(sc->dmatag, sc->dmamap,
469 BUS_DMASYNC_POSTREAD);
471 bus_dmamap_sync(sc->dmatag, sc->dmamap,
472 BUS_DMASYNC_POSTWRITE);
473 bus_dmamap_unload(sc->dmatag, sc->dmamap);
477 * If there's a linked stop command, then start the stop command.
478 * In order to establish a known state attempt the stop command
479 * even if the original request encountered an error.
482 stop_cmd = (cmd->mrq->stop != cmd) ? cmd->mrq->stop : NULL;
484 if (stop_cmd != NULL) {
487 * If the original command executed successfuly, then
488 * the hardware will also have automatically executed
489 * a stop command so don't bother with the one supplied
490 * with the original request.
493 if (mmc_error == MMC_ERR_NONE) {
494 stop_cmd->error = MMC_ERR_NONE;
495 stop_cmd->resp[0] = cmd->resp[0];
496 stop_cmd->resp[1] = cmd->resp[1];
497 stop_cmd->resp[2] = cmd->resp[2];
498 stop_cmd->resp[3] = cmd->resp[3];
500 mmc_stop_error = aml8726_sdxc_start_command(sc,
502 if (mmc_stop_error == MMC_ERR_NONE) {
506 stop_cmd->error = mmc_stop_error;
512 /* Execute the callback after dropping the lock. */
513 if (cmd->mrq != NULL)
514 cmd->mrq->done(cmd->mrq);
518 aml8726_sdxc_timeout(void *arg)
520 struct aml8726_sdxc_softc *sc = (struct aml8726_sdxc_softc *)arg;
523 * The command failed to complete in time so forcefully
526 aml8726_sdxc_soft_reset(sc);
529 * Ensure the command has terminated before continuing on
530 * to things such as bus_dmamap_sync / bus_dmamap_unload.
532 while ((CSR_READ_4(sc, AML_SDXC_STATUS_REG) &
533 AML_SDXC_STATUS_BUSY) != 0)
536 aml8726_sdxc_finish_command(sc, MMC_ERR_TIMEOUT);
540 aml8726_sdxc_busy_check(void *arg)
542 struct aml8726_sdxc_softc *sc = (struct aml8726_sdxc_softc *)arg;
545 sc->busy.time += AML_SDXC_BUSY_POLL_INTVL;
547 sr = CSR_READ_4(sc, AML_SDXC_STATUS_REG);
549 if ((sr & AML_SDXC_STATUS_DAT0) == 0) {
550 if (sc->busy.time < AML_SDXC_BUSY_TIMEOUT) {
551 callout_reset(&sc->ch,
552 msecs_to_ticks(AML_SDXC_BUSY_POLL_INTVL),
553 aml8726_sdxc_busy_check, sc);
557 if (sc->busy.error == MMC_ERR_NONE)
558 sc->busy.error = MMC_ERR_TIMEOUT;
561 aml8726_sdxc_finish_command(sc, sc->busy.error);
565 aml8726_sdxc_intr(void *arg)
567 struct aml8726_sdxc_softc *sc = (struct aml8726_sdxc_softc *)arg;
579 isr = CSR_READ_4(sc, AML_SDXC_IRQ_STATUS_REG);
580 sndr = CSR_READ_4(sc, AML_SDXC_SEND_REG);
581 sr = CSR_READ_4(sc, AML_SDXC_STATUS_REG);
586 mmc_error = MMC_ERR_NONE;
588 if ((isr & (AML_SDXC_IRQ_STATUS_TX_FIFO_EMPTY |
589 AML_SDXC_IRQ_STATUS_RX_FIFO_FULL)) != 0)
590 mmc_error = MMC_ERR_FIFO;
591 else if ((isr & (AML_SDXC_IRQ_ENABLE_A_PKG_CRC_ERR |
592 AML_SDXC_IRQ_ENABLE_RESP_CRC_ERR)) != 0)
593 mmc_error = MMC_ERR_BADCRC;
594 else if ((isr & (AML_SDXC_IRQ_ENABLE_A_PKG_TIMEOUT_ERR |
595 AML_SDXC_IRQ_ENABLE_RESP_TIMEOUT_ERR)) != 0)
596 mmc_error = MMC_ERR_TIMEOUT;
597 else if ((isr & (AML_SDXC_IRQ_STATUS_RESP_OK |
598 AML_SDXC_IRQ_STATUS_DMA_DONE |
599 AML_SDXC_IRQ_STATUS_TRANSFER_DONE_OK)) != 0) {
605 * Clear spurious interrupts while leaving intacted any
606 * interrupts that may have occurred after we read the
607 * interrupt status register.
610 CSR_WRITE_4(sc, AML_SDXC_IRQ_STATUS_REG,
611 (AML_SDXC_IRQ_STATUS_CLEAR & isr));
612 CSR_BARRIER(sc, AML_SDXC_IRQ_STATUS_REG);
617 aml8726_sdxc_disengage_dma(sc);
619 if ((sndr & AML_SDXC_SEND_CMD_HAS_RESP) != 0) {
622 if ((sndr & AML_SDXC_SEND_RESP_136) != 0) {
626 for (i = start; i < stop; i++) {
627 pdmar = CSR_READ_4(sc, AML_SDXC_PDMA_REG);
628 pdmar &= ~(AML_SDXC_PDMA_DMA_EN |
629 AML_SDXC_PDMA_RESP_INDEX_MASK);
630 pdmar |= i << AML_SDXC_PDMA_RESP_INDEX_SHIFT;
631 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
632 sc->cmd->resp[(stop - 1) - i] = CSR_READ_4(sc,
633 AML_SDXC_CMD_ARGUMENT_REG);
637 if ((sr & AML_SDXC_STATUS_BUSY) != 0 &&
639 * A multiblock operation may keep the hardware
640 * busy until stop transmission is executed.
642 (isr & (AML_SDXC_IRQ_STATUS_DMA_DONE |
643 AML_SDXC_IRQ_STATUS_TRANSFER_DONE_OK)) == 0) {
644 if (mmc_error == MMC_ERR_NONE)
645 mmc_error = MMC_ERR_FAILED;
648 * Issue a soft reset to terminate the command.
650 * Ensure the command has terminated before continuing on
651 * to things such as bus_dmamap_sync / bus_dmamap_unload.
654 aml8726_sdxc_soft_reset(sc);
656 while ((CSR_READ_4(sc, AML_SDXC_STATUS_REG) &
657 AML_SDXC_STATUS_BUSY) != 0)
662 * The stop command can be generated either manually or
663 * automatically by the hardware if MISC_MANUAL_STOP_MODE
664 * has not been set. In either case check for busy.
667 if (((sc->cmd->flags & MMC_RSP_BUSY) != 0 ||
668 (sndr & AML_SDXC_SEND_INDEX_MASK) == MMC_STOP_TRANSMISSION) &&
669 (sr & AML_SDXC_STATUS_DAT0) == 0) {
670 sc->busy.error = mmc_error;
671 callout_reset(&sc->ch,
672 msecs_to_ticks(AML_SDXC_BUSY_POLL_INTVL),
673 aml8726_sdxc_busy_check, sc);
674 CSR_WRITE_4(sc, AML_SDXC_IRQ_STATUS_REG,
675 (AML_SDXC_IRQ_STATUS_CLEAR & isr));
676 CSR_BARRIER(sc, AML_SDXC_IRQ_STATUS_REG);
681 aml8726_sdxc_finish_command(sc, mmc_error);
685 aml8726_sdxc_probe(device_t dev)
688 if (!ofw_bus_status_okay(dev))
691 if (!ofw_bus_is_compatible(dev, "amlogic,aml8726-sdxc-m8"))
694 device_set_desc(dev, "Amlogic aml8726-m8 SDXC");
696 return (BUS_PROBE_DEFAULT);
700 aml8726_sdxc_attach(device_t dev)
702 struct aml8726_sdxc_softc *sc = device_get_softc(dev);
717 sc->auto_fill_flush = false;
719 pdmar = AML_SDXC_PDMA_DMA_URGENT |
720 (49 << AML_SDXC_PDMA_TX_THOLD_SHIFT) |
721 (7 << AML_SDXC_PDMA_RX_THOLD_SHIFT) |
722 (15 << AML_SDXC_PDMA_RD_BURST_SHIFT) |
723 (7 << AML_SDXC_PDMA_WR_BURST_SHIFT);
725 miscr = (2 << AML_SDXC_MISC_WCRC_OK_PAT_SHIFT) |
726 (5 << AML_SDXC_MISC_WCRC_ERR_PAT_SHIFT);
728 ectlr = (12 << AML_SDXC_ENH_CNTRL_SDIO_IRQ_PERIOD_SHIFT);
731 * Certain bitfields are dependent on the hardware revision.
733 switch (aml8726_soc_hw_rev) {
734 case AML_SOC_HW_REV_M8:
735 switch (aml8726_soc_metal_rev) {
736 case AML_SOC_M8_METAL_REV_M2_A:
737 sc->auto_fill_flush = true;
738 miscr |= (6 << AML_SDXC_MISC_TXSTART_THOLD_SHIFT);
739 ectlr |= (64 << AML_SDXC_ENH_CNTRL_RX_FULL_THOLD_SHIFT) |
740 AML_SDXC_ENH_CNTRL_WR_RESP_MODE_SKIP_M8M2;
743 miscr |= (7 << AML_SDXC_MISC_TXSTART_THOLD_SHIFT);
744 ectlr |= (63 << AML_SDXC_ENH_CNTRL_RX_FULL_THOLD_SHIFT) |
745 AML_SDXC_ENH_CNTRL_DMA_NO_WR_RESP_CHECK_M8 |
746 (255 << AML_SDXC_ENH_CNTRL_RX_TIMEOUT_SHIFT_M8);
751 case AML_SOC_HW_REV_M8B:
752 miscr |= (7 << AML_SDXC_MISC_TXSTART_THOLD_SHIFT);
753 ectlr |= (63 << AML_SDXC_ENH_CNTRL_RX_FULL_THOLD_SHIFT) |
754 AML_SDXC_ENH_CNTRL_DMA_NO_WR_RESP_CHECK_M8 |
755 (255 << AML_SDXC_ENH_CNTRL_RX_TIMEOUT_SHIFT_M8);
758 device_printf(dev, "unsupported SoC\n");
764 node = ofw_bus_get_node(dev);
766 len = OF_getencprop(node, "clock-frequency", prop, sizeof(prop));
767 if ((len / sizeof(prop[0])) != 1 || prop[0] == 0) {
769 "missing clock-frequency attribute in FDT\n");
773 sc->ref_freq = prop[0];
775 sc->pwr_en.dev = NULL;
777 len = OF_getencprop(node, "mmc-pwr-en", prop, sizeof(prop));
779 if ((len / sizeof(prop[0])) == 3) {
780 sc->pwr_en.dev = OF_device_from_xref(prop[0]);
781 sc->pwr_en.pin = prop[1];
782 sc->pwr_en.pol = prop[2];
785 if (sc->pwr_en.dev == NULL) {
787 "unable to process mmc-pwr-en attribute in FDT\n");
791 /* Turn off power and then configure the output driver. */
792 if (aml8726_sdxc_power_off(sc) != 0 ||
793 GPIO_PIN_SETFLAGS(sc->pwr_en.dev, sc->pwr_en.pin,
794 GPIO_PIN_OUTPUT) != 0) {
796 "could not use gpio to control power\n");
801 len = OF_getprop_alloc(node, "mmc-voltages",
802 sizeof(char), (void **)&voltages);
805 device_printf(dev, "missing mmc-voltages attribute in FDT\n");
815 while (len && nvoltages < 2) {
816 if (strncmp("1.8", voltage, len) == 0)
817 sc->voltages[nvoltages] = MMC_OCR_LOW_VOLTAGE;
818 else if (strncmp("3.3", voltage, len) == 0)
819 sc->voltages[nvoltages] = MMC_OCR_320_330 |
823 "unknown voltage attribute %.*s in FDT\n",
825 free(voltages, M_OFWPROP);
831 /* queue up next string */
832 while (*voltage && len) {
842 free(voltages, M_OFWPROP);
844 sc->vselect.dev = NULL;
846 len = OF_getencprop(node, "mmc-vselect", prop, sizeof(prop));
848 if ((len / sizeof(prop[0])) == 2) {
849 sc->vselect.dev = OF_device_from_xref(prop[0]);
850 sc->vselect.pin = prop[1];
854 if (sc->vselect.dev == NULL) {
856 "unable to process mmc-vselect attribute in FDT\n");
861 * With the power off select voltage 0 and then
862 * configure the output driver.
864 if (GPIO_PIN_SET(sc->vselect.dev, sc->vselect.pin, 0) != 0 ||
865 GPIO_PIN_SETFLAGS(sc->vselect.dev, sc->vselect.pin,
866 GPIO_PIN_OUTPUT) != 0) {
868 "could not use gpio to set voltage\n");
873 if (nvoltages == 0) {
874 device_printf(dev, "no voltages in FDT\n");
876 } else if (nvoltages == 1 && sc->vselect.dev != NULL) {
877 device_printf(dev, "only one voltage in FDT\n");
879 } else if (nvoltages == 2 && sc->vselect.dev == NULL) {
880 device_printf(dev, "too many voltages in FDT\n");
884 sc->card_rst.dev = NULL;
886 len = OF_getencprop(node, "mmc-rst", prop, sizeof(prop));
888 if ((len / sizeof(prop[0])) == 3) {
889 sc->card_rst.dev = OF_device_from_xref(prop[0]);
890 sc->card_rst.pin = prop[1];
891 sc->card_rst.pol = prop[2];
894 if (sc->card_rst.dev == NULL) {
896 "unable to process mmc-rst attribute in FDT\n");
901 if (bus_alloc_resources(dev, aml8726_sdxc_spec, sc->res)) {
902 device_printf(dev, "could not allocate resources for device\n");
906 AML_SDXC_LOCK_INIT(sc);
908 error = bus_dma_tag_create(bus_get_dma_tag(dev), AML_SDXC_ALIGN_DMA, 0,
909 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
910 AML_SDXC_MAX_DMA, 1, AML_SDXC_MAX_DMA, 0, NULL, NULL, &sc->dmatag);
914 error = bus_dmamap_create(sc->dmatag, 0, &sc->dmamap);
919 error = bus_setup_intr(dev, sc->res[1], INTR_TYPE_MISC | INTR_MPSAFE,
920 NULL, aml8726_sdxc_intr, sc, &sc->ih_cookie);
922 device_printf(dev, "could not setup interrupt handler\n");
926 callout_init_mtx(&sc->ch, &sc->mtx, CALLOUT_RETURNUNLOCKED);
928 sc->host.f_min = 200000;
929 sc->host.f_max = 100000000;
930 sc->host.host_ocr = sc->voltages[0] | sc->voltages[1];
931 sc->host.caps = MMC_CAP_8_BIT_DATA | MMC_CAP_4_BIT_DATA |
934 aml8726_sdxc_soft_reset(sc);
936 CSR_WRITE_4(sc, AML_SDXC_PDMA_REG, pdmar);
938 CSR_WRITE_4(sc, AML_SDXC_MISC_REG, miscr);
940 CSR_WRITE_4(sc, AML_SDXC_ENH_CNTRL_REG, ectlr);
942 child = device_add_child(dev, "mmc", -1);
945 device_printf(dev, "could not add mmc\n");
950 error = device_probe_and_attach(child);
953 device_printf(dev, "could not attach mmc\n");
961 bus_teardown_intr(dev, sc->res[1], sc->ih_cookie);
964 bus_dmamap_destroy(sc->dmatag, sc->dmamap);
967 bus_dma_tag_destroy(sc->dmatag);
969 AML_SDXC_LOCK_DESTROY(sc);
971 (void)aml8726_sdxc_power_off(sc);
973 bus_release_resources(dev, aml8726_sdxc_spec, sc->res);
979 aml8726_sdxc_detach(device_t dev)
981 struct aml8726_sdxc_softc *sc = device_get_softc(dev);
985 if (sc->cmd != NULL) {
991 * Turn off the power, reset the hardware state machine,
992 * and disable the interrupts.
994 aml8726_sdxc_power_off(sc);
995 aml8726_sdxc_soft_reset(sc);
996 CSR_WRITE_4(sc, AML_SDXC_IRQ_ENABLE_REG, 0);
1000 bus_generic_detach(dev);
1002 bus_teardown_intr(dev, sc->res[1], sc->ih_cookie);
1004 bus_dmamap_destroy(sc->dmatag, sc->dmamap);
1006 bus_dma_tag_destroy(sc->dmatag);
1008 AML_SDXC_LOCK_DESTROY(sc);
1010 bus_release_resources(dev, aml8726_sdxc_spec, sc->res);
1016 aml8726_sdxc_shutdown(device_t dev)
1018 struct aml8726_sdxc_softc *sc = device_get_softc(dev);
1021 * Turn off the power, reset the hardware state machine,
1022 * and disable the interrupts.
1024 aml8726_sdxc_power_off(sc);
1025 aml8726_sdxc_soft_reset(sc);
1026 CSR_WRITE_4(sc, AML_SDXC_IRQ_ENABLE_REG, 0);
1032 aml8726_sdxc_update_ios(device_t bus, device_t child)
1034 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1035 struct mmc_ios *ios = &sc->host.ios;
1036 unsigned int divisor;
1044 ctlr = (7 << AML_SDXC_CNTRL_TX_ENDIAN_SHIFT) |
1045 (7 << AML_SDXC_CNTRL_RX_ENDIAN_SHIFT) |
1046 (0xf << AML_SDXC_CNTRL_RX_PERIOD_SHIFT) |
1047 (0x7f << AML_SDXC_CNTRL_RX_TIMEOUT_SHIFT);
1049 switch (ios->bus_width) {
1051 ctlr |= AML_SDXC_CNTRL_BUS_WIDTH_8;
1054 ctlr |= AML_SDXC_CNTRL_BUS_WIDTH_4;
1057 ctlr |= AML_SDXC_CNTRL_BUS_WIDTH_1;
1063 CSR_WRITE_4(sc, AML_SDXC_CNTRL_REG, ctlr);
1066 * Disable clocks and then clock module prior to setting desired values.
1068 cctlr = CSR_READ_4(sc, AML_SDXC_CLK_CNTRL_REG);
1069 cctlr &= ~(AML_SDXC_CLK_CNTRL_TX_CLK_EN | AML_SDXC_CLK_CNTRL_RX_CLK_EN |
1070 AML_SDXC_CLK_CNTRL_SD_CLK_EN);
1071 CSR_WRITE_4(sc, AML_SDXC_CLK_CNTRL_REG, cctlr);
1072 CSR_BARRIER(sc, AML_SDXC_CLK_CNTRL_REG);
1073 cctlr &= ~AML_SDXC_CLK_CNTRL_CLK_MODULE_EN;
1074 CSR_WRITE_4(sc, AML_SDXC_CLK_CNTRL_REG, cctlr);
1075 CSR_BARRIER(sc, AML_SDXC_CLK_CNTRL_REG);
1080 * Clock select 1 fclk_div2 (1.275 GHz)
1082 cctlr &= ~AML_SDXC_CLK_CNTRL_CLK_SEL_MASK;
1083 cctlr |= (1 << AML_SDXC_CLK_CNTRL_CLK_SEL_SHIFT);
1085 divisor = sc->ref_freq / ios->clock - 1;
1086 if (divisor == 0 || divisor == -1)
1088 if ((sc->ref_freq / (divisor + 1)) > ios->clock)
1090 if (divisor > (AML_SDXC_CLK_CNTRL_CLK_DIV_MASK >>
1091 AML_SDXC_CLK_CNTRL_CLK_DIV_SHIFT))
1092 divisor = AML_SDXC_CLK_CNTRL_CLK_DIV_MASK >>
1093 AML_SDXC_CLK_CNTRL_CLK_DIV_SHIFT;
1095 cctlr &= ~AML_SDXC_CLK_CNTRL_CLK_DIV_MASK;
1096 cctlr |= divisor << AML_SDXC_CLK_CNTRL_CLK_DIV_SHIFT;
1098 cctlr &= ~AML_SDXC_CLK_CNTRL_MEM_PWR_MASK;
1099 cctlr |= AML_SDXC_CLK_CNTRL_MEM_PWR_ON;
1101 CSR_WRITE_4(sc, AML_SDXC_CLK_CNTRL_REG, cctlr);
1102 CSR_BARRIER(sc, AML_SDXC_CLK_CNTRL_REG);
1105 * Enable clock module and then clocks after setting desired values.
1107 cctlr |= AML_SDXC_CLK_CNTRL_CLK_MODULE_EN;
1108 CSR_WRITE_4(sc, AML_SDXC_CLK_CNTRL_REG, cctlr);
1109 CSR_BARRIER(sc, AML_SDXC_CLK_CNTRL_REG);
1110 cctlr |= AML_SDXC_CLK_CNTRL_TX_CLK_EN | AML_SDXC_CLK_CNTRL_RX_CLK_EN |
1111 AML_SDXC_CLK_CNTRL_SD_CLK_EN;
1112 CSR_WRITE_4(sc, AML_SDXC_CLK_CNTRL_REG, cctlr);
1113 CSR_BARRIER(sc, AML_SDXC_CLK_CNTRL_REG);
1115 freq = sc->ref_freq / divisor;
1117 for (i = 0; aml8726_sdxc_clk_phases[i].voltage; i++) {
1118 if ((aml8726_sdxc_clk_phases[i].voltage &
1119 (1 << ios->vdd)) != 0 &&
1120 freq > aml8726_sdxc_clk_phases[i].freq)
1122 if (aml8726_sdxc_clk_phases[i].freq == 0)
1126 clk2r = (1 << AML_SDXC_CLK2_SD_PHASE_SHIFT) |
1127 (aml8726_sdxc_clk_phases[i].rx_phase <<
1128 AML_SDXC_CLK2_RX_PHASE_SHIFT);
1129 CSR_WRITE_4(sc, AML_SDXC_CLK2_REG, clk2r);
1130 CSR_BARRIER(sc, AML_SDXC_CLK2_REG);
1134 switch (ios->power_mode) {
1137 * Configure and power on the regulator so that the
1138 * voltage stabilizes prior to powering on the card.
1140 if (sc->vselect.dev != NULL) {
1141 for (i = 0; i < 2; i++)
1142 if ((sc->voltages[i] & (1 << ios->vdd)) != 0)
1146 error = GPIO_PIN_SET(sc->vselect.dev,
1147 sc->vselect.pin, i);
1151 error = aml8726_sdxc_power_on(sc);
1155 if (sc->card_rst.dev != NULL) {
1156 if (GPIO_PIN_SET(sc->card_rst.dev, sc->card_rst.pin,
1157 PIN_ON_FLAG(sc->card_rst.pol)) != 0 ||
1158 GPIO_PIN_SETFLAGS(sc->card_rst.dev,
1160 GPIO_PIN_OUTPUT) != 0)
1165 if (GPIO_PIN_SET(sc->card_rst.dev, sc->card_rst.pin,
1166 PIN_OFF_FLAG(sc->card_rst.pol)) != 0)
1172 device_printf(sc->dev,
1173 "could not use gpio to reset card\n");
1179 error = aml8726_sdxc_power_off(sc);
1189 aml8726_sdxc_request(device_t bus, device_t child, struct mmc_request *req)
1191 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1196 if (sc->cmd != NULL) {
1197 AML_SDXC_UNLOCK(sc);
1201 mmc_error = aml8726_sdxc_start_command(sc, req->cmd);
1203 AML_SDXC_UNLOCK(sc);
1205 /* Execute the callback after dropping the lock. */
1206 if (mmc_error != MMC_ERR_NONE) {
1207 req->cmd->error = mmc_error;
1215 aml8726_sdxc_read_ivar(device_t bus, device_t child,
1216 int which, uintptr_t *result)
1218 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1221 case MMCBR_IVAR_BUS_MODE:
1222 *(int *)result = sc->host.ios.bus_mode;
1224 case MMCBR_IVAR_BUS_WIDTH:
1225 *(int *)result = sc->host.ios.bus_width;
1227 case MMCBR_IVAR_CHIP_SELECT:
1228 *(int *)result = sc->host.ios.chip_select;
1230 case MMCBR_IVAR_CLOCK:
1231 *(int *)result = sc->host.ios.clock;
1233 case MMCBR_IVAR_F_MIN:
1234 *(int *)result = sc->host.f_min;
1236 case MMCBR_IVAR_F_MAX:
1237 *(int *)result = sc->host.f_max;
1239 case MMCBR_IVAR_HOST_OCR:
1240 *(int *)result = sc->host.host_ocr;
1242 case MMCBR_IVAR_MODE:
1243 *(int *)result = sc->host.mode;
1245 case MMCBR_IVAR_OCR:
1246 *(int *)result = sc->host.ocr;
1248 case MMCBR_IVAR_POWER_MODE:
1249 *(int *)result = sc->host.ios.power_mode;
1251 case MMCBR_IVAR_VDD:
1252 *(int *)result = sc->host.ios.vdd;
1254 case MMCBR_IVAR_CAPS:
1255 *(int *)result = sc->host.caps;
1257 case MMCBR_IVAR_MAX_DATA:
1258 *(int *)result = AML_SDXC_MAX_DMA / MMC_SECTOR_SIZE;
1268 aml8726_sdxc_write_ivar(device_t bus, device_t child,
1269 int which, uintptr_t value)
1271 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1274 case MMCBR_IVAR_BUS_MODE:
1275 sc->host.ios.bus_mode = value;
1277 case MMCBR_IVAR_BUS_WIDTH:
1278 sc->host.ios.bus_width = value;
1280 case MMCBR_IVAR_CHIP_SELECT:
1281 sc->host.ios.chip_select = value;
1283 case MMCBR_IVAR_CLOCK:
1284 sc->host.ios.clock = value;
1286 case MMCBR_IVAR_MODE:
1287 sc->host.mode = value;
1289 case MMCBR_IVAR_OCR:
1290 sc->host.ocr = value;
1292 case MMCBR_IVAR_POWER_MODE:
1293 sc->host.ios.power_mode = value;
1295 case MMCBR_IVAR_VDD:
1296 sc->host.ios.vdd = value;
1298 /* These are read-only */
1299 case MMCBR_IVAR_CAPS:
1300 case MMCBR_IVAR_HOST_OCR:
1301 case MMCBR_IVAR_F_MIN:
1302 case MMCBR_IVAR_F_MAX:
1303 case MMCBR_IVAR_MAX_DATA:
1312 aml8726_sdxc_get_ro(device_t bus, device_t child)
1319 aml8726_sdxc_acquire_host(device_t bus, device_t child)
1321 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1325 while (sc->bus_busy)
1326 mtx_sleep(sc, &sc->mtx, PZERO, "sdxc", hz / 5);
1329 AML_SDXC_UNLOCK(sc);
1335 aml8726_sdxc_release_host(device_t bus, device_t child)
1337 struct aml8726_sdxc_softc *sc = device_get_softc(bus);
1344 AML_SDXC_UNLOCK(sc);
1349 static device_method_t aml8726_sdxc_methods[] = {
1350 /* Device interface */
1351 DEVMETHOD(device_probe, aml8726_sdxc_probe),
1352 DEVMETHOD(device_attach, aml8726_sdxc_attach),
1353 DEVMETHOD(device_detach, aml8726_sdxc_detach),
1354 DEVMETHOD(device_shutdown, aml8726_sdxc_shutdown),
1357 DEVMETHOD(bus_read_ivar, aml8726_sdxc_read_ivar),
1358 DEVMETHOD(bus_write_ivar, aml8726_sdxc_write_ivar),
1360 /* MMC bridge interface */
1361 DEVMETHOD(mmcbr_update_ios, aml8726_sdxc_update_ios),
1362 DEVMETHOD(mmcbr_request, aml8726_sdxc_request),
1363 DEVMETHOD(mmcbr_get_ro, aml8726_sdxc_get_ro),
1364 DEVMETHOD(mmcbr_acquire_host, aml8726_sdxc_acquire_host),
1365 DEVMETHOD(mmcbr_release_host, aml8726_sdxc_release_host),
1370 static driver_t aml8726_sdxc_driver = {
1372 aml8726_sdxc_methods,
1373 sizeof(struct aml8726_sdxc_softc),
1376 static devclass_t aml8726_sdxc_devclass;
1378 DRIVER_MODULE(aml8726_sdxc, simplebus, aml8726_sdxc_driver,
1379 aml8726_sdxc_devclass, 0, 0);
1380 MODULE_DEPEND(aml8726_sdxc, aml8726_gpio, 1, 1, 1);