drivers/mmc/imx_esdhc.c

   1 /*
   2  * (C) Copyright 2008-2010 Freescale Semiconductor, Inc.
   3  * Terry Lv, Jason Liu
   4  *
   5  * Copyright 2007, Freescale Semiconductor, Inc
   6  * Andy Fleming
   7  *
   8  * Based vaguely on the pxa mmc code:
   9  * (C) Copyright 2003
  10  * Kyle Harris, Nexus Technologies, Inc. kharris@nexus-tech.net
  11  *
  12  * See file CREDITS for list of people who contributed to this
  13  * project.
  14  *
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License as
  17  * published by the Free Software Foundation; either version 2 of
  18  * the License, or (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program; if not, write to the Free Software
  27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  28  * MA 02111-1307 USA
  29  */
  30
  31 #include <config.h>
  32 #include <common.h>
  33 #include <command.h>
  34 #include <hwconfig.h>
  35 #include <mmc.h>
  36 #include <part.h>
  37 #include <malloc.h>
  38 #include <mmc.h>
  39 #include <fsl_esdhc.h>
  40 #include <fdt_support.h>
  41 #include <asm/io.h>
  42
  43
  44 DECLARE_GLOBAL_DATA_PTR;
  45
  46 #define SDHCI_IRQ_EN_BITS               (IRQSTATEN_CC | IRQSTATEN_TC | \
  47                                 IRQSTATEN_BWR | IRQSTATEN_BRR | IRQSTATEN_CINT | \
  48                                 IRQSTATEN_CTOE | IRQSTATEN_CCE | IRQSTATEN_CEBE | \
  49                                 IRQSTATEN_CIE | IRQSTATEN_DTOE | IRQSTATEN_DCE | IRQSTATEN_DEBE)
  50
  51 struct fsl_esdhc {
  52         uint    dsaddr;
  53         uint    blkattr;
  54         uint    cmdarg;
  55         uint    xfertyp;
  56         uint    cmdrsp0;
  57         uint    cmdrsp1;
  58         uint    cmdrsp2;
  59         uint    cmdrsp3;
  60         uint    datport;
  61         uint    prsstat;
  62         uint    proctl;
  63         uint    sysctl;
  64         uint    irqstat;
  65         uint    irqstaten;
  66         uint    irqsigen;
  67         uint    autoc12err;
  68         uint    hostcapblt;
  69         uint    wml;
  70         char    reserved1[8];
  71         uint    fevt;
  72         char    reserved2[12];
  73         uint dllctrl;
  74         uint dllstatus;
  75         char    reserved3[148];
  76         uint    hostver;
  77 };
  78
  79 /* Return the XFERTYP flags for a given command and data packet */
  80 uint esdhc_xfertyp(struct mmc_cmd *cmd, struct mmc_data *data)
  81 {
  82         uint xfertyp = 0;
  83
  84         if (data) {
  85                 xfertyp |= XFERTYP_DPSEL;
  86
  87                 if (data->blocks > 1) {
  88                         xfertyp |= XFERTYP_MSBSEL;
  89                         xfertyp |= XFERTYP_BCEN;
  90                 }
  91
  92                 if (data->flags & MMC_DATA_READ)
  93                         xfertyp |= XFERTYP_DTDSEL;
  94         }
  95
  96         if (cmd->resp_type & MMC_RSP_CRC)
  97                 xfertyp |= XFERTYP_CCCEN;
  98         if (cmd->resp_type & MMC_RSP_OPCODE)
  99                 xfertyp |= XFERTYP_CICEN;
 100         if (cmd->resp_type & MMC_RSP_136)
 101                 xfertyp |= XFERTYP_RSPTYP_136;
 102         else if (cmd->resp_type & MMC_RSP_BUSY)
 103                 xfertyp |= XFERTYP_RSPTYP_48_BUSY;
 104         else if (cmd->resp_type & MMC_RSP_PRESENT)
 105                 xfertyp |= XFERTYP_RSPTYP_48;
 106
 107         return XFERTYP_CMD(cmd->cmdidx) | xfertyp;
 108 }
 109
 110 static int esdhc_setup_data(struct mmc *mmc, struct mmc_data *data)
 111 {
 112         uint wml_value;
 113         int timeout;
 114         u32 tmp;
 115         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 116         struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 117
 118         wml_value = data->blocksize / 4;
 119
 120         if (wml_value > 0x80)
 121                 wml_value = 0x80;
 122
 123         if (!(data->flags & MMC_DATA_READ)) {
 124                 if ((readl(&regs->prsstat) & PRSSTAT_WPSPL) == 0) {
 125                         printf("\nThe SD card is locked. Can not write to a locked card.\n\n");
 126                         return TIMEOUT;
 127                 }
 128                 wml_value = wml_value << 16;
 129         }
 130
 131         writel(wml_value, &regs->wml);
 132
 133         writel(data->blocks << 16 | data->blocksize, &regs->blkattr);
 134
 135         /* Calculate the timeout period for data transactions */
 136         /*
 137         timeout = fls(mmc->tran_speed / 10) - 1;
 138         timeout -= 13;
 139
 140         if (timeout > 14)
 141                 timeout = 14;
 142
 143         if (timeout < 0)
 144                 timeout = 0;
 145         */
 146         timeout = 14;
 147
 148         tmp = (readl(&regs->sysctl) & (~SYSCTL_TIMEOUT_MASK)) | (timeout << 16);
 149         writel(tmp, &regs->sysctl);
 150
 151         return 0;
 152 }
 153
 154
 155 /*
 156  * Sends a command out on the bus.  Takes the mmc pointer,
 157  * a command pointer, and an optional data pointer.
 158  */
 159 static int
 160 esdhc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data)
 161 {
 162         uint    xfertyp;
 163         uint    irqstat;
 164         u32     tmp;
 165         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 166         volatile struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 167
 168         writel(-1, &regs->irqstat);
 169
 170         sync();
 171
 172         tmp = readl(&regs->irqstaten) | SDHCI_IRQ_EN_BITS;
 173         writel(tmp, &regs->irqstaten);
 174
 175         /* Wait for the bus to be idle */
 176         while ((readl(&regs->prsstat) & PRSSTAT_CICHB) ||
 177                         (readl(&regs->prsstat) & PRSSTAT_CIDHB))
 178                         ;
 179
 180         while (readl(&regs->prsstat) & PRSSTAT_DLA);
 181
 182         /* Wait at least 8 SD clock cycles before the next command */
 183         /*
 184          * Note: This is way more than 8 cycles, but 1ms seems to
 185          * resolve timing issues with some cards
 186          */
 187         udelay(10000);
 188
 189         /* Set up for a data transfer if we have one */
 190         if (data) {
 191                 int err;
 192
 193                 err = esdhc_setup_data(mmc, data);
 194                 if(err)
 195                         return err;
 196         }
 197
 198         /* Figure out the transfer arguments */
 199         xfertyp = esdhc_xfertyp(cmd, data);
 200
 201         if (mmc->bus_width == EMMC_MODE_4BIT_DDR ||
 202                 mmc->bus_width == EMMC_MODE_8BIT_DDR)
 203                 xfertyp |= XFERTYP_DDR_EN;
 204
 205         /* Send the command */
 206         writel(cmd->cmdarg, &regs->cmdarg);
 207         writel(xfertyp, &regs->xfertyp);
 208
 209         /* Mask all irqs */
 210         writel(0, &regs->irqsigen);
 211
 212         /* Wait for the command to complete */
 213         while (!(readl(&regs->irqstat) & IRQSTAT_CC));
 214
 215         irqstat = readl(&regs->irqstat);
 216         writel(irqstat, &regs->irqstat);
 217
 218         if (irqstat & CMD_ERR)
 219                 return COMM_ERR;
 220
 221         if (irqstat & IRQSTAT_CTOE)
 222                 return TIMEOUT;
 223
 224         /* Copy the response to the response buffer */
 225         if (cmd->resp_type & MMC_RSP_136) {
 226                 u32 cmdrsp3, cmdrsp2, cmdrsp1, cmdrsp0;
 227
 228                 cmdrsp3 = readl(&regs->cmdrsp3);
 229                 cmdrsp2 = readl(&regs->cmdrsp2);
 230                 cmdrsp1 = readl(&regs->cmdrsp1);
 231                 cmdrsp0 = readl(&regs->cmdrsp0);
 232                 cmd->response[0] = (cmdrsp3 << 8) | (cmdrsp2 >> 24);
 233                 cmd->response[1] = (cmdrsp2 << 8) | (cmdrsp1 >> 24);
 234                 cmd->response[2] = (cmdrsp1 << 8) | (cmdrsp0 >> 24);
 235                 cmd->response[3] = (cmdrsp0 << 8);
 236         } else
 237                 cmd->response[0] = readl(&regs->cmdrsp0);
 238
 239         /* Wait until all of the blocks are transferred */
 240         if (data) {
 241                 int i = 0, j = 0;
 242                 u32 *tmp_ptr = NULL;
 243                 uint block_size = data->blocksize;
 244                 uint block_cnt = data->blocks;
 245
 246                 tmp = readl(&regs->irqstaten) | SDHCI_IRQ_EN_BITS;
 247                 writel(tmp, &regs->irqstaten);
 248
 249                 if (data->flags & MMC_DATA_READ) {
 250                         tmp_ptr = (u32 *)data->dest;
 251
 252                         for (i = 0; i < (block_cnt); ++i) {
 253                                 while (!(readl(&regs->irqstat) & IRQSTAT_BRR))
 254                                         ;
 255
 256                                 for (j = 0; j < (block_size >> 2); ++j, ++tmp_ptr) {
 257                                         *tmp_ptr = readl(&regs->datport);
 258                                 }
 259
 260                                 tmp = readl(&regs->irqstat) & (IRQSTAT_BRR);
 261                                 writel(tmp, &regs->irqstat);
 262                         }
 263                 } else {
 264                         tmp_ptr = (u32 *)data->src;
 265
 266                         for (i = 0; i < (block_cnt); ++i) {
 267                                 while (!(readl(&regs->irqstat) & IRQSTAT_BWR))
 268                                         ;
 269
 270                                 for (j = 0; j < (block_size >> 2); ++j, ++tmp_ptr) {
 271                                         writel(*tmp_ptr, &regs->datport);
 272                                 }
 273
 274                                 tmp = readl(&regs->irqstat) & (IRQSTAT_BWR);
 275                                 writel(tmp, &regs->irqstat);
 276                         }
 277                 }
 278
 279                 while (!(readl(&regs->irqstat) & IRQSTAT_TC)) ;
 280         }
 281
 282         if (readl(&regs->irqstat) & 0xFFFF0000)
 283                 return COMM_ERR;
 284
 285         writel(-1, &regs->irqstat);
 286
 287         return 0;
 288 }
 289
 290 void set_sysctl(struct mmc *mmc, uint clock)
 291 {
 292         int sdhc_clk = mxc_get_clock(MXC_ESDHC_CLK);
 293         int div, pre_div;
 294         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 295         volatile struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 296         uint clk;
 297         u32 tmp;
 298
 299         if (sdhc_clk / 16 > clock) {
 300                 for (pre_div = 2; pre_div < 256; pre_div *= 2)
 301                         if ((sdhc_clk / pre_div) <= (clock * 16))
 302                                 break;
 303         } else
 304                 pre_div = 2;
 305
 306         for (div = 1; div <= 16; div++)
 307                 if ((sdhc_clk / (div * pre_div)) <= clock)
 308                         break;
 309
 310         pre_div >>= 1;
 311         div -= 1;
 312
 313         clk = (pre_div << 8) | (div << 4);
 314
 315 #ifndef CONFIG_IMX_ESDHC_V1
 316         tmp = readl(&regs->sysctl) & (~SYSCTL_SDCLKEN);
 317         writel(tmp, &regs->sysctl);
 318 #endif
 319
 320         tmp = (readl(&regs->sysctl) & (~SYSCTL_CLOCK_MASK)) | clk;
 321         writel(tmp, &regs->sysctl);
 322
 323         udelay(10000);
 324
 325 #ifdef CONFIG_IMX_ESDHC_V1
 326         tmp = readl(&regs->sysctl) | SYSCTL_PEREN;
 327         writel(tmp, &regs->sysctl);
 328 #else
 329         while (!(readl(&regs->prsstat) & PRSSTAT_SDSTB)) ;
 330
 331         tmp = readl(&regs->sysctl) | (SYSCTL_SDCLKEN);
 332         writel(tmp, &regs->sysctl);
 333 #endif
 334 }
 335
 336 static void esdhc_dll_setup(struct mmc *mmc)
 337 {
 338         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 339         struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 340
 341         uint dll_control = readl(&regs->dllctrl);
 342         dll_control &= ~(ESDHC_DLLCTRL_SLV_OVERRIDE_VAL_MASK |
 343                 ESDHC_DLLCTRL_SLV_OVERRIDE);
 344         dll_control |= ((ESDHC_DLLCTRL_SLV_OVERRIDE_VAL <<
 345                 ESDHC_DLLCTRL_SLV_OVERRIDE_VAL_SHIFT) |
 346                 ESDHC_DLLCTRL_SLV_OVERRIDE);
 347
 348         writel(dll_control, &regs->dllctrl);
 349
 350 }
 351
 352 static void esdhc_set_ios(struct mmc *mmc)
 353 {
 354         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 355         struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 356         u32 tmp;
 357
 358         /* Set the clock speed */
 359         set_sysctl(mmc, mmc->clock);
 360
 361         /* Set the bus width */
 362         tmp = readl(&regs->proctl) & (~(PROCTL_DTW_4 | PROCTL_DTW_8));
 363         writel(tmp, &regs->proctl);
 364
 365         if (mmc->bus_width == 4) {
 366                 tmp = readl(&regs->proctl) | PROCTL_DTW_4;
 367                 writel(tmp, &regs->proctl);
 368         } else if (mmc->bus_width == 8) {
 369                 tmp = readl(&regs->proctl) | PROCTL_DTW_8;
 370                 writel(tmp, &regs->proctl);
 371         } else if (mmc->bus_width == EMMC_MODE_4BIT_DDR) {
 372                 tmp = readl(&regs->proctl) | PROCTL_DTW_4;
 373                 writel(tmp, &regs->proctl);
 374                 esdhc_dll_setup(mmc);
 375         } else if (mmc->bus_width == EMMC_MODE_8BIT_DDR) {
 376                 tmp = readl(&regs->proctl) | PROCTL_DTW_8;
 377                 writel(tmp, &regs->proctl);
 378                 esdhc_dll_setup(mmc);
 379         }
 380 }
 381
 382 static int esdhc_init(struct mmc *mmc)
 383 {
 384         struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
 385         struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
 386         u32 tmp;
 387
 388         /* Reset the eSDHC by writing 1 to RSTA bit of SYSCTRL Register */
 389         tmp = readl(&regs->sysctl) | SYSCTL_RSTA;
 390         writel(tmp, &regs->sysctl);
 391
 392         while (readl(&regs->sysctl) & SYSCTL_RSTA)
 393                 ;
 394
 395 #ifdef CONFIG_IMX_ESDHC_V1
 396         tmp = readl(&regs->sysctl) | (SYSCTL_HCKEN | SYSCTL_IPGEN);
 397         writel(tmp, &regs->sysctl);
 398 #endif
 399
 400         /* Set the initial clock speed */
 401         set_sysctl(mmc, 400000);
 402
 403         /* Put the PROCTL reg back to the default */
 404         writel(PROCTL_INIT, &regs->proctl);
 405
 406         /* FIXME: For our CINS bit doesn't work. So this section is disabled. */
 407         /*
 408         while (!(readl(&regs->prsstat) & PRSSTAT_CINS) && --timeout)
 409                 ;
 410
 411         if (timeout <= 0) {
 412                 printf("No MMC card detected!\n");
 413                 return NO_CARD_ERR;
 414         }
 415         */
 416
 417 #ifndef CONFIG_IMX_ESDHC_V1
 418         tmp = readl(&regs->sysctl) | SYSCTL_INITA;
 419         writel(tmp, &regs->sysctl);
 420
 421         while (readl(&regs->sysctl) & SYSCTL_INITA)
 422                 ;
 423 #endif
 424
 425         return 0;
 426 }
 427
 428 int fsl_esdhc_initialize(bd_t *bis, struct fsl_esdhc_cfg *cfg)
 429 {
 430         struct fsl_esdhc *regs;
 431         struct mmc *mmc;
 432         u32 caps;
 433
 434         if (!cfg)
 435                 return -1;
 436
 437         mmc = malloc(sizeof(struct mmc));
 438
 439         sprintf(mmc->name, "FSL_ESDHC");
 440         regs = (struct fsl_esdhc *)cfg->esdhc_base;
 441         mmc->priv = cfg;
 442         mmc->send_cmd = esdhc_send_cmd;
 443         mmc->set_ios = esdhc_set_ios;
 444         mmc->init = esdhc_init;
 445
 446         caps = readl(&regs->hostcapblt);
 447         if (caps & ESDHC_HOSTCAPBLT_VS30)
 448                 mmc->voltages |= MMC_VDD_29_30 | MMC_VDD_30_31;
 449         if (caps & ESDHC_HOSTCAPBLT_VS33)
 450                 mmc->voltages |= MMC_VDD_32_33 | MMC_VDD_33_34;
 451
 452         mmc->host_caps = MMC_MODE_4BIT;
 453
 454         if (caps & ESDHC_HOSTCAPBLT_HSS)
 455                 mmc->host_caps |= MMC_MODE_HS_52MHz | MMC_MODE_HS;
 456
 457         if (((readl(&regs->hostver) & ESDHC_HOSTVER_VVN_MASK)
 458                 >> ESDHC_HOSTVER_VVN_SHIFT) >= ESDHC_HOSTVER_DDR_SUPPORT)
 459                 mmc->host_caps |= EMMC_MODE_4BIT_DDR;
 460
 461         mmc->f_min = 400000;
 462         mmc->f_max = MIN(mxc_get_clock(MXC_ESDHC_CLK), 50000000);
 463
 464         mmc_register(mmc);
 465
 466 #ifdef CONFIG_MMC_8BIT_PORTS
 467         if ((1 << mmc->block_dev.dev) & CONFIG_MMC_8BIT_PORTS) {
 468                 mmc->host_caps |= MMC_MODE_8BIT;
 469
 470                 if (mmc->host_caps & EMMC_MODE_4BIT_DDR)
 471                         mmc->host_caps |= EMMC_MODE_8BIT_DDR;
 472         }
 473 #endif
 474
 475         return 0;
 476 }
 477
 478 int fsl_esdhc_mmc_init(bd_t *bis)
 479 {
 480         struct fsl_esdhc_cfg *cfg;
 481
 482         cfg = malloc(sizeof(struct fsl_esdhc_cfg));
 483         memset(cfg, 0, sizeof(struct fsl_esdhc_cfg));
 484         cfg->esdhc_base = CONFIG_SYS_FSL_ESDHC_ADDR;
 485         return fsl_esdhc_initialize(bis, cfg);
 486 }
 487
 488 #ifdef CONFIG_OF_LIBFDT
 489 void fdt_fixup_esdhc(void *blob, bd_t *bd)
 490 {
 491         const char *compat = "fsl,esdhc";
 492         const char *status = "okay";
 493
 494         if (!hwconfig("esdhc")) {
 495                 status = "disabled";
 496                 goto out;
 497         }
 498
 499         do_fixup_by_compat_u32(blob, compat, "clock-frequency",
 500                                gd->sdhc_clk, 1);
 501 out:
 502         do_fixup_by_compat(blob, compat, "status", status,
 503                            strlen(status) + 1, 1);
 504 }
 505 #endif