1 // SPDX-License-Identifier: GPL-2.0+
3 * Freescale i.MX28 SSP MMC driver
5 * Copyright (C) 2019 DENX Software Engineering
9 * on behalf of DENX Software Engineering GmbH
11 * Based on code from LTIB:
12 * (C) Copyright 2008-2010 Freescale Semiconductor, Inc.
15 * Copyright 2007, Freescale Semiconductor, Inc
18 * Based vaguely on the pxa mmc code:
26 #include <linux/bitops.h>
27 #include <linux/delay.h>
28 #include <linux/errno.h>
30 #include <asm/arch/clock.h>
31 #include <asm/arch/imx-regs.h>
32 #include <asm/arch/sys_proto.h>
33 #include <asm/mach-imx/dma.h>
34 #include <bouncebuf.h>
36 #define MXSMMC_MAX_TIMEOUT 10000
37 #define MXSMMC_SMALL_TRANSFER 512
39 #if !CONFIG_IS_ENABLED(DM_MMC)
42 int (*mmc_is_wp)(int);
44 struct mmc_config cfg; /* mmc configuration */
45 struct mxs_dma_desc *desc;
47 struct mxs_ssp_regs *regs;
49 #else /* CONFIG_IS_ENABLED(DM_MMC) */
50 #include <dm/device.h>
52 #include <dt-structs.h>
55 #if CONFIG_IS_ENABLED(OF_PLATDATA)
56 struct dtd_fsl_imx23_mmc dtplat;
58 struct mmc_config cfg;
69 struct mxs_dma_desc *desc;
71 struct mxs_ssp_regs *regs;
72 unsigned int dma_channel;
76 #if !CONFIG_IS_ENABLED(DM_MMC)
77 static int mxsmmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd,
78 struct mmc_data *data);
80 static int mxsmmc_cd(struct mxsmmc_priv *priv)
82 struct mxs_ssp_regs *ssp_regs = priv->regs;
85 return priv->mmc_cd(priv->id);
87 return !(readl(&ssp_regs->hw_ssp_status) & SSP_STATUS_CARD_DETECT);
90 static int mxsmmc_set_ios(struct mmc *mmc)
92 struct mxsmmc_priv *priv = mmc->priv;
93 struct mxs_ssp_regs *ssp_regs = priv->regs;
95 /* Set the clock speed */
97 mxs_set_ssp_busclock(priv->id, mmc->clock / 1000);
99 switch (mmc->bus_width) {
101 priv->buswidth = SSP_CTRL0_BUS_WIDTH_ONE_BIT;
104 priv->buswidth = SSP_CTRL0_BUS_WIDTH_FOUR_BIT;
107 priv->buswidth = SSP_CTRL0_BUS_WIDTH_EIGHT_BIT;
111 /* Set the bus width */
112 clrsetbits_le32(&ssp_regs->hw_ssp_ctrl0,
113 SSP_CTRL0_BUS_WIDTH_MASK, priv->buswidth);
115 debug("MMC%d: Set %d bits bus width\n",
116 mmc->block_dev.devnum, mmc->bus_width);
121 static int mxsmmc_init(struct mmc *mmc)
123 struct mxsmmc_priv *priv = mmc->priv;
124 struct mxs_ssp_regs *ssp_regs = priv->regs;
127 mxs_reset_block(&ssp_regs->hw_ssp_ctrl0_reg);
129 /* Reconfigure the SSP block for MMC operation */
130 writel(SSP_CTRL1_SSP_MODE_SD_MMC |
131 SSP_CTRL1_WORD_LENGTH_EIGHT_BITS |
132 SSP_CTRL1_DMA_ENABLE |
134 SSP_CTRL1_RECV_TIMEOUT_IRQ_EN |
135 SSP_CTRL1_DATA_CRC_IRQ_EN |
136 SSP_CTRL1_DATA_TIMEOUT_IRQ_EN |
137 SSP_CTRL1_RESP_TIMEOUT_IRQ_EN |
138 SSP_CTRL1_RESP_ERR_IRQ_EN,
139 &ssp_regs->hw_ssp_ctrl1_set);
141 /* Set initial bit clock 400 KHz */
142 mxs_set_ssp_busclock(priv->id, 400);
144 /* Send initial 74 clock cycles (185 us @ 400 KHz)*/
145 writel(SSP_CMD0_CONT_CLKING_EN, &ssp_regs->hw_ssp_cmd0_set);
147 writel(SSP_CMD0_CONT_CLKING_EN, &ssp_regs->hw_ssp_cmd0_clr);
152 static const struct mmc_ops mxsmmc_ops = {
153 .send_cmd = mxsmmc_send_cmd,
154 .set_ios = mxsmmc_set_ios,
158 int mxsmmc_initialize(struct bd_info *bis, int id, int (*wp)(int),
161 struct mmc *mmc = NULL;
162 struct mxsmmc_priv *priv = NULL;
164 const unsigned int mxsmmc_clk_id = mxs_ssp_clock_by_bus(id);
166 if (!mxs_ssp_bus_id_valid(id))
169 priv = malloc(sizeof(struct mxsmmc_priv));
173 priv->desc = mxs_dma_desc_alloc();
179 ret = mxs_dma_init_channel(MXS_DMA_CHANNEL_AHB_APBH_SSP0 + id);
183 priv->mmc_is_wp = wp;
186 priv->regs = mxs_ssp_regs_by_bus(id);
188 priv->cfg.name = "MXS MMC";
189 priv->cfg.ops = &mxsmmc_ops;
191 priv->cfg.voltages = MMC_VDD_32_33 | MMC_VDD_33_34;
193 priv->cfg.host_caps = MMC_MODE_4BIT | MMC_MODE_8BIT |
194 MMC_MODE_HS_52MHz | MMC_MODE_HS;
197 * SSPCLK = 480 * 18 / 29 / 1 = 297.731 MHz
198 * SSP bit rate = SSPCLK / (CLOCK_DIVIDE * (1 + CLOCK_RATE)),
199 * CLOCK_DIVIDE has to be an even value from 2 to 254, and
200 * CLOCK_RATE could be any integer from 0 to 255.
202 priv->cfg.f_min = 400000;
203 priv->cfg.f_max = mxc_get_clock(MXC_SSP0_CLK + mxsmmc_clk_id)
205 priv->cfg.b_max = 0x20;
207 mmc = mmc_create(&priv->cfg, priv);
209 mxs_dma_desc_free(priv->desc);
215 #endif /* CONFIG_IS_ENABLED(DM_MMC) */
217 static int mxsmmc_send_cmd_pio(struct mxsmmc_priv *priv, struct mmc_data *data)
219 struct mxs_ssp_regs *ssp_regs = priv->regs;
221 int timeout = MXSMMC_MAX_TIMEOUT;
223 uint32_t data_count = data->blocksize * data->blocks;
225 if (data->flags & MMC_DATA_READ) {
226 data_ptr = (uint32_t *)data->dest;
227 while (data_count && --timeout) {
228 reg = readl(&ssp_regs->hw_ssp_status);
229 if (!(reg & SSP_STATUS_FIFO_EMPTY)) {
230 *data_ptr++ = readl(&ssp_regs->hw_ssp_data);
232 timeout = MXSMMC_MAX_TIMEOUT;
237 data_ptr = (uint32_t *)data->src;
239 while (data_count && --timeout) {
240 reg = readl(&ssp_regs->hw_ssp_status);
241 if (!(reg & SSP_STATUS_FIFO_FULL)) {
242 writel(*data_ptr++, &ssp_regs->hw_ssp_data);
244 timeout = MXSMMC_MAX_TIMEOUT;
250 return timeout ? 0 : -ECOMM;
253 static int mxsmmc_send_cmd_dma(struct mxsmmc_priv *priv, struct mmc_data *data)
255 uint32_t data_count = data->blocksize * data->blocks;
257 struct mxs_dma_desc *desc = priv->desc;
260 struct bounce_buffer bbstate;
262 memset(desc, 0, sizeof(struct mxs_dma_desc));
263 desc->address = (dma_addr_t)desc;
265 if (data->flags & MMC_DATA_READ) {
266 priv->desc->cmd.data = MXS_DMA_DESC_COMMAND_DMA_WRITE;
268 flags = GEN_BB_WRITE;
270 priv->desc->cmd.data = MXS_DMA_DESC_COMMAND_DMA_READ;
271 addr = (void *)data->src;
275 bounce_buffer_start(&bbstate, addr, data_count, flags);
277 priv->desc->cmd.address = (dma_addr_t)bbstate.bounce_buffer;
279 priv->desc->cmd.data |= MXS_DMA_DESC_IRQ | MXS_DMA_DESC_DEC_SEM |
280 (data_count << MXS_DMA_DESC_BYTES_OFFSET);
282 #if !CONFIG_IS_ENABLED(DM_MMC)
283 dmach = MXS_DMA_CHANNEL_AHB_APBH_SSP0 + priv->id;
285 dmach = priv->dma_channel;
287 mxs_dma_desc_append(dmach, priv->desc);
288 if (mxs_dma_go(dmach)) {
289 bounce_buffer_stop(&bbstate);
293 bounce_buffer_stop(&bbstate);
298 #if !CONFIG_IS_ENABLED(DM_MMC)
300 * Sends a command out on the bus. Takes the mmc pointer,
301 * a command pointer, and an optional data pointer.
304 mxsmmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data)
306 struct mxsmmc_priv *priv = mmc->priv;
307 struct mxs_ssp_regs *ssp_regs = priv->regs;
310 mxsmmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd, struct mmc_data *data)
312 struct mxsmmc_plat *plat = dev_get_plat(dev);
313 struct mxsmmc_priv *priv = dev_get_priv(dev);
314 struct mxs_ssp_regs *ssp_regs = priv->regs;
315 struct mmc *mmc = &plat->mmc;
321 #if !CONFIG_IS_ENABLED(DM_MMC)
322 int devnum = mmc->block_dev.devnum;
324 int devnum = mmc_get_blk_desc(mmc)->devnum;
326 debug("MMC%d: CMD%d\n", devnum, cmd->cmdidx);
329 timeout = MXSMMC_MAX_TIMEOUT;
332 reg = readl(&ssp_regs->hw_ssp_status);
334 (SSP_STATUS_BUSY | SSP_STATUS_DATA_BUSY |
335 SSP_STATUS_CMD_BUSY))) {
341 printf("MMC%d: Bus busy timeout!\n", devnum);
344 #if !CONFIG_IS_ENABLED(DM_MMC)
345 /* See if card is present */
346 if (!mxsmmc_cd(priv)) {
347 printf("MMC%d: No card detected!\n", devnum);
351 /* Start building CTRL0 contents */
352 ctrl0 = priv->buswidth;
355 if (!(cmd->resp_type & MMC_RSP_CRC))
356 ctrl0 |= SSP_CTRL0_IGNORE_CRC;
357 if (cmd->resp_type & MMC_RSP_PRESENT) /* Need to get response */
358 ctrl0 |= SSP_CTRL0_GET_RESP;
359 if (cmd->resp_type & MMC_RSP_136) /* It's a 136 bits response */
360 ctrl0 |= SSP_CTRL0_LONG_RESP;
362 if (data && (data->blocksize * data->blocks < MXSMMC_SMALL_TRANSFER))
363 writel(SSP_CTRL1_DMA_ENABLE, &ssp_regs->hw_ssp_ctrl1_clr);
365 writel(SSP_CTRL1_DMA_ENABLE, &ssp_regs->hw_ssp_ctrl1_set);
368 reg = readl(&ssp_regs->hw_ssp_cmd0);
369 reg &= ~(SSP_CMD0_CMD_MASK | SSP_CMD0_APPEND_8CYC);
370 reg |= cmd->cmdidx << SSP_CMD0_CMD_OFFSET;
371 if (cmd->cmdidx == MMC_CMD_STOP_TRANSMISSION)
372 reg |= SSP_CMD0_APPEND_8CYC;
373 writel(reg, &ssp_regs->hw_ssp_cmd0);
375 /* Command argument */
376 writel(cmd->cmdarg, &ssp_regs->hw_ssp_cmd1);
381 if (data->flags & MMC_DATA_READ) {
382 ctrl0 |= SSP_CTRL0_READ;
383 #if !CONFIG_IS_ENABLED(DM_MMC)
384 } else if (priv->mmc_is_wp &&
385 priv->mmc_is_wp(devnum)) {
386 printf("MMC%d: Can not write a locked card!\n", devnum);
390 ctrl0 |= SSP_CTRL0_DATA_XFER;
392 reg = data->blocksize * data->blocks;
393 #if defined(CONFIG_MX23)
394 ctrl0 |= reg & SSP_CTRL0_XFER_COUNT_MASK;
396 clrsetbits_le32(&ssp_regs->hw_ssp_cmd0,
397 SSP_CMD0_BLOCK_SIZE_MASK | SSP_CMD0_BLOCK_COUNT_MASK,
398 ((data->blocks - 1) << SSP_CMD0_BLOCK_COUNT_OFFSET) |
399 ((ffs(data->blocksize) - 1) <<
400 SSP_CMD0_BLOCK_SIZE_OFFSET));
401 #elif defined(CONFIG_MX28)
402 writel(reg, &ssp_regs->hw_ssp_xfer_size);
404 reg = ((data->blocks - 1) <<
405 SSP_BLOCK_SIZE_BLOCK_COUNT_OFFSET) |
406 ((ffs(data->blocksize) - 1) <<
407 SSP_BLOCK_SIZE_BLOCK_SIZE_OFFSET);
408 writel(reg, &ssp_regs->hw_ssp_block_size);
412 /* Kick off the command */
413 ctrl0 |= SSP_CTRL0_WAIT_FOR_IRQ | SSP_CTRL0_ENABLE | SSP_CTRL0_RUN;
414 writel(ctrl0, &ssp_regs->hw_ssp_ctrl0);
416 /* Wait for the command to complete */
417 timeout = MXSMMC_MAX_TIMEOUT;
420 reg = readl(&ssp_regs->hw_ssp_status);
421 if (!(reg & SSP_STATUS_CMD_BUSY))
426 printf("MMC%d: Command %d busy\n", devnum, cmd->cmdidx);
430 /* Check command timeout */
431 if (reg & SSP_STATUS_RESP_TIMEOUT) {
432 debug("MMC%d: Command %d timeout (status 0x%08x)\n",
433 devnum, cmd->cmdidx, reg);
437 /* Check command errors */
438 if (reg & (SSP_STATUS_RESP_CRC_ERR | SSP_STATUS_RESP_ERR)) {
439 printf("MMC%d: Command %d error (status 0x%08x)!\n",
440 devnum, cmd->cmdidx, reg);
444 /* Copy response to response buffer */
445 if (cmd->resp_type & MMC_RSP_136) {
446 cmd->response[3] = readl(&ssp_regs->hw_ssp_sdresp0);
447 cmd->response[2] = readl(&ssp_regs->hw_ssp_sdresp1);
448 cmd->response[1] = readl(&ssp_regs->hw_ssp_sdresp2);
449 cmd->response[0] = readl(&ssp_regs->hw_ssp_sdresp3);
451 cmd->response[0] = readl(&ssp_regs->hw_ssp_sdresp0);
453 /* Return if no data to process */
457 if (data->blocksize * data->blocks < MXSMMC_SMALL_TRANSFER) {
458 ret = mxsmmc_send_cmd_pio(priv, data);
460 printf("MMC%d: Data timeout with command %d "
461 "(status 0x%08x)!\n", devnum, cmd->cmdidx, reg);
465 ret = mxsmmc_send_cmd_dma(priv, data);
467 printf("MMC%d: DMA transfer failed\n", devnum);
472 /* Check data errors */
473 reg = readl(&ssp_regs->hw_ssp_status);
475 (SSP_STATUS_TIMEOUT | SSP_STATUS_DATA_CRC_ERR |
476 SSP_STATUS_FIFO_OVRFLW | SSP_STATUS_FIFO_UNDRFLW)) {
477 printf("MMC%d: Data error with command %d (status 0x%08x)!\n",
478 devnum, cmd->cmdidx, reg);
485 #if CONFIG_IS_ENABLED(DM_MMC)
486 /* Base numbers of i.MX2[38] clk for ssp0 IP block */
487 #define MXS_SSP_IMX23_CLKID_SSP0 33
488 #define MXS_SSP_IMX28_CLKID_SSP0 46
490 static int mxsmmc_get_cd(struct udevice *dev)
492 struct mxsmmc_plat *plat = dev_get_plat(dev);
493 struct mxsmmc_priv *priv = dev_get_priv(dev);
494 struct mxs_ssp_regs *ssp_regs = priv->regs;
496 if (plat->non_removable)
499 return !(readl(&ssp_regs->hw_ssp_status) & SSP_STATUS_CARD_DETECT);
502 static int mxsmmc_set_ios(struct udevice *dev)
504 struct mxsmmc_plat *plat = dev_get_plat(dev);
505 struct mxsmmc_priv *priv = dev_get_priv(dev);
506 struct mxs_ssp_regs *ssp_regs = priv->regs;
507 struct mmc *mmc = &plat->mmc;
509 /* Set the clock speed */
511 mxs_set_ssp_busclock(priv->clkid, mmc->clock / 1000);
513 switch (mmc->bus_width) {
515 priv->buswidth = SSP_CTRL0_BUS_WIDTH_ONE_BIT;
518 priv->buswidth = SSP_CTRL0_BUS_WIDTH_FOUR_BIT;
521 priv->buswidth = SSP_CTRL0_BUS_WIDTH_EIGHT_BIT;
525 /* Set the bus width */
526 clrsetbits_le32(&ssp_regs->hw_ssp_ctrl0,
527 SSP_CTRL0_BUS_WIDTH_MASK, priv->buswidth);
529 debug("MMC%d: Set %d bits bus width\n", mmc_get_blk_desc(mmc)->devnum,
535 static int mxsmmc_init(struct udevice *dev)
537 struct mxsmmc_priv *priv = dev_get_priv(dev);
538 struct mxs_ssp_regs *ssp_regs = priv->regs;
541 mxs_reset_block(&ssp_regs->hw_ssp_ctrl0_reg);
543 /* Reconfigure the SSP block for MMC operation */
544 writel(SSP_CTRL1_SSP_MODE_SD_MMC |
545 SSP_CTRL1_WORD_LENGTH_EIGHT_BITS |
546 SSP_CTRL1_DMA_ENABLE |
548 SSP_CTRL1_RECV_TIMEOUT_IRQ_EN |
549 SSP_CTRL1_DATA_CRC_IRQ_EN |
550 SSP_CTRL1_DATA_TIMEOUT_IRQ_EN |
551 SSP_CTRL1_RESP_TIMEOUT_IRQ_EN |
552 SSP_CTRL1_RESP_ERR_IRQ_EN,
553 &ssp_regs->hw_ssp_ctrl1_set);
555 /* Set initial bit clock 400 KHz */
556 mxs_set_ssp_busclock(priv->clkid, 400);
558 /* Send initial 74 clock cycles (185 us @ 400 KHz)*/
559 writel(SSP_CMD0_CONT_CLKING_EN, &ssp_regs->hw_ssp_cmd0_set);
561 writel(SSP_CMD0_CONT_CLKING_EN, &ssp_regs->hw_ssp_cmd0_clr);
566 static int mxsmmc_probe(struct udevice *dev)
568 struct mmc_uclass_priv *upriv = dev_get_uclass_priv(dev);
569 struct mxsmmc_plat *plat = dev_get_plat(dev);
570 struct mxsmmc_priv *priv = dev_get_priv(dev);
571 struct blk_desc *bdesc;
575 debug("%s: probe\n", __func__);
577 #if CONFIG_IS_ENABLED(OF_PLATDATA)
578 struct dtd_fsl_imx23_mmc *dtplat = &plat->dtplat;
579 struct phandle_1_arg *p1a = &dtplat->clocks[0];
581 priv->buswidth = dtplat->bus_width;
582 priv->regs = (struct mxs_ssp_regs *)dtplat->reg[0];
583 priv->dma_channel = dtplat->dmas[1];
585 plat->non_removable = dtplat->non_removable;
587 debug("OF_PLATDATA: regs: 0x%p bw: %d clkid: %d non_removable: %d\n",
588 priv->regs, priv->buswidth, clkid, plat->non_removable);
590 priv->regs = (struct mxs_ssp_regs *)plat->base;
591 priv->dma_channel = plat->dma_id;
592 clkid = plat->clk_id;
596 priv->clkid = clkid - MXS_SSP_IMX28_CLKID_SSP0;
597 #else /* CONFIG_MX23 */
598 priv->clkid = clkid - MXS_SSP_IMX23_CLKID_SSP0;
601 mmc->cfg = &plat->cfg;
604 priv->desc = mxs_dma_desc_alloc();
606 printf("%s: Cannot allocate DMA descriptor\n", __func__);
610 ret = mxs_dma_init_channel(priv->dma_channel);
614 plat->cfg.name = "MXS MMC";
615 plat->cfg.voltages = MMC_VDD_32_33 | MMC_VDD_33_34;
617 plat->cfg.host_caps = MMC_MODE_4BIT | MMC_MODE_8BIT |
618 MMC_MODE_HS_52MHz | MMC_MODE_HS;
621 * SSPCLK = 480 * 18 / 29 / 1 = 297.731 MHz
622 * SSP bit rate = SSPCLK / (CLOCK_DIVIDE * (1 + CLOCK_RATE)),
623 * CLOCK_DIVIDE has to be an even value from 2 to 254, and
624 * CLOCK_RATE could be any integer from 0 to 255.
626 plat->cfg.f_min = 400000;
627 plat->cfg.f_max = mxc_get_clock(MXC_SSP0_CLK + priv->clkid) * 1000 / 2;
628 plat->cfg.b_max = 0x20;
630 bdesc = mmc_get_blk_desc(mmc);
632 printf("%s: No block device descriptor!\n", __func__);
636 if (plat->non_removable)
637 bdesc->removable = 0;
639 ret = mxsmmc_init(dev);
641 printf("%s: MMC%d init error %d\n", __func__,
644 /* Set the initial clock speed */
645 mmc_set_clock(mmc, 400000, MMC_CLK_ENABLE);
652 #if CONFIG_IS_ENABLED(BLK)
653 static int mxsmmc_bind(struct udevice *dev)
655 struct mxsmmc_plat *plat = dev_get_plat(dev);
657 return mmc_bind(dev, &plat->mmc, &plat->cfg);
661 static const struct dm_mmc_ops mxsmmc_ops = {
662 .get_cd = mxsmmc_get_cd,
663 .send_cmd = mxsmmc_send_cmd,
664 .set_ios = mxsmmc_set_ios,
667 #if CONFIG_IS_ENABLED(OF_REAL)
668 static int mxsmmc_of_to_plat(struct udevice *bus)
670 struct mxsmmc_plat *plat = dev_get_plat(bus);
674 plat->base = dev_read_addr(bus);
676 dev_read_u32_default(bus, "bus-width", 1);
677 plat->non_removable = dev_read_bool(bus, "non-removable");
679 ret = dev_read_u32_array(bus, "dmas", prop, ARRAY_SIZE(prop));
681 printf("%s: Reading 'dmas' property failed!\n", __func__);
684 plat->dma_id = prop[1];
686 ret = dev_read_u32_array(bus, "clocks", prop, ARRAY_SIZE(prop));
688 printf("%s: Reading 'clocks' property failed!\n", __func__);
691 plat->clk_id = prop[1];
693 debug("%s: base=0x%x, bus_width=%d %s dma_id=%d clk_id=%d\n",
694 __func__, (uint)plat->base, plat->buswidth,
695 plat->non_removable ? "non-removable" : NULL,
696 plat->dma_id, plat->clk_id);
701 static const struct udevice_id mxsmmc_ids[] = {
702 { .compatible = "fsl,imx23-mmc", },
703 { .compatible = "fsl,imx28-mmc", },
708 U_BOOT_DRIVER(fsl_imx23_mmc) = {
709 .name = "fsl_imx23_mmc",
711 #if CONFIG_IS_ENABLED(OF_REAL)
712 .of_match = mxsmmc_ids,
713 .of_to_plat = mxsmmc_of_to_plat,
716 #if CONFIG_IS_ENABLED(BLK)
719 .probe = mxsmmc_probe,
720 .priv_auto = sizeof(struct mxsmmc_priv),
721 .plat_auto = sizeof(struct mxsmmc_plat),
724 DM_DRIVER_ALIAS(fsl_imx23_mmc, fsl_imx28_mmc)
725 #endif /* CONFIG_DM_MMC */