arch/arm/mach-omap2/mmc-twl4030.c

   1 /*
   2  * linux/arch/arm/mach-omap2/mmc-twl4030.c
   3  *
   4  * Copyright (C) 2007-2008 Texas Instruments
   5  * Copyright (C) 2008 Nokia Corporation
   6  * Author: Texas Instruments
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12 #include <linux/err.h>
  13 #include <linux/io.h>
  14 #include <linux/module.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/delay.h>
  18 #include <linux/gpio.h>
  19 #include <linux/mmc/host.h>
  20 #include <linux/regulator/consumer.h>
  21
  22 #include <mach/hardware.h>
  23 #include <plat/control.h>
  24 #include <plat/mmc.h>
  25 #include <plat/board.h>
  26
  27 #include "mmc-twl4030.h"
  28
  29
  30 #if defined(CONFIG_REGULATOR) && \
  31         (defined(CONFIG_MMC_OMAP_HS) || defined(CONFIG_MMC_OMAP_HS_MODULE))
  32
  33 static u16 control_pbias_offset;
  34 static u16 control_devconf1_offset;
  35
  36 #define HSMMC_NAME_LEN  9
  37
  38 static struct twl_mmc_controller {
  39         struct omap_mmc_platform_data   *mmc;
  40         /* Vcc == configured supply
  41          * Vcc_alt == optional
  42          *   -  MMC1, supply for DAT4..DAT7
  43          *   -  MMC2/MMC2, external level shifter voltage supply, for
  44          *      chip (SDIO, eMMC, etc) or transceiver (MMC2 only)
  45          */
  46         struct regulator                *vcc;
  47         struct regulator                *vcc_aux;
  48         char                            name[HSMMC_NAME_LEN + 1];
  49 } hsmmc[OMAP34XX_NR_MMC];
  50
  51 static int twl_mmc_card_detect(int irq)
  52 {
  53         unsigned i;
  54
  55         for (i = 0; i < ARRAY_SIZE(hsmmc); i++) {
  56                 struct omap_mmc_platform_data *mmc;
  57
  58                 mmc = hsmmc[i].mmc;
  59                 if (!mmc)
  60                         continue;
  61                 if (irq != mmc->slots[0].card_detect_irq)
  62                         continue;
  63
  64                 /* NOTE: assumes card detect signal is active-low */
  65                 return !gpio_get_value_cansleep(mmc->slots[0].switch_pin);
  66         }
  67         return -ENOSYS;
  68 }
  69
  70 static int twl_mmc_get_ro(struct device *dev, int slot)
  71 {
  72         struct omap_mmc_platform_data *mmc = dev->platform_data;
  73
  74         /* NOTE: assumes write protect signal is active-high */
  75         return gpio_get_value_cansleep(mmc->slots[0].gpio_wp);
  76 }
  77
  78 static int twl_mmc_get_cover_state(struct device *dev, int slot)
  79 {
  80         struct omap_mmc_platform_data *mmc = dev->platform_data;
  81
  82         /* NOTE: assumes card detect signal is active-low */
  83         return !gpio_get_value_cansleep(mmc->slots[0].switch_pin);
  84 }
  85
  86 /*
  87  * MMC Slot Initialization.
  88  */
  89 static int twl_mmc_late_init(struct device *dev)
  90 {
  91         struct omap_mmc_platform_data *mmc = dev->platform_data;
  92         int ret = 0;
  93         int i;
  94
  95         /* MMC/SD/SDIO doesn't require a card detect switch */
  96         if (gpio_is_valid(mmc->slots[0].switch_pin)) {
  97                 ret = gpio_request(mmc->slots[0].switch_pin, "mmc_cd");
  98                 if (ret)
  99                         goto done;
 100                 ret = gpio_direction_input(mmc->slots[0].switch_pin);
 101                 if (ret)
 102                         goto err;
 103         }
 104
 105         /* require at least main regulator */
 106         for (i = 0; i < ARRAY_SIZE(hsmmc); i++) {
 107                 if (hsmmc[i].name == mmc->slots[0].name) {
 108                         struct regulator *reg;
 109
 110                         hsmmc[i].mmc = mmc;
 111
 112                         reg = regulator_get(dev, "vmmc");
 113                         if (IS_ERR(reg)) {
 114                                 dev_dbg(dev, "vmmc regulator missing\n");
 115                                 /* HACK: until fixed.c regulator is usable,
 116                                  * we don't require a main regulator
 117                                  * for MMC2 or MMC3
 118                                  */
 119                                 if (i != 0)
 120                                         break;
 121                                 ret = PTR_ERR(reg);
 122                                 hsmmc[i].vcc = NULL;
 123                                 goto err;
 124                         }
 125                         hsmmc[i].vcc = reg;
 126                         mmc->slots[0].ocr_mask = mmc_regulator_get_ocrmask(reg);
 127
 128                         /* allow an aux regulator */
 129                         reg = regulator_get(dev, "vmmc_aux");
 130                         hsmmc[i].vcc_aux = IS_ERR(reg) ? NULL : reg;
 131
 132                         /* UGLY HACK:  workaround regulator framework bugs.
 133                          * When the bootloader leaves a supply active, it's
 134                          * initialized with zero usecount ... and we can't
 135                          * disable it without first enabling it.  Until the
 136                          * framework is fixed, we need a workaround like this
 137                          * (which is safe for MMC, but not in general).
 138                          */
 139                         if (regulator_is_enabled(hsmmc[i].vcc) > 0) {
 140                                 regulator_enable(hsmmc[i].vcc);
 141                                 regulator_disable(hsmmc[i].vcc);
 142                         }
 143                         if (hsmmc[i].vcc_aux) {
 144                                 if (regulator_is_enabled(reg) > 0) {
 145                                         regulator_enable(reg);
 146                                         regulator_disable(reg);
 147                                 }
 148                         }
 149
 150                         break;
 151                 }
 152         }
 153
 154         return 0;
 155
 156 err:
 157         gpio_free(mmc->slots[0].switch_pin);
 158 done:
 159         mmc->slots[0].card_detect_irq = 0;
 160         mmc->slots[0].card_detect = NULL;
 161
 162         dev_err(dev, "err %d configuring card detect\n", ret);
 163         return ret;
 164 }
 165
 166 static void twl_mmc_cleanup(struct device *dev)
 167 {
 168         struct omap_mmc_platform_data *mmc = dev->platform_data;
 169         int i;
 170
 171         gpio_free(mmc->slots[0].switch_pin);
 172         for(i = 0; i < ARRAY_SIZE(hsmmc); i++) {
 173                 regulator_put(hsmmc[i].vcc);
 174                 regulator_put(hsmmc[i].vcc_aux);
 175         }
 176 }
 177
 178 #ifdef CONFIG_PM
 179
 180 static int twl_mmc_suspend(struct device *dev, int slot)
 181 {
 182         struct omap_mmc_platform_data *mmc = dev->platform_data;
 183
 184         disable_irq(mmc->slots[0].card_detect_irq);
 185         return 0;
 186 }
 187
 188 static int twl_mmc_resume(struct device *dev, int slot)
 189 {
 190         struct omap_mmc_platform_data *mmc = dev->platform_data;
 191
 192         enable_irq(mmc->slots[0].card_detect_irq);
 193         return 0;
 194 }
 195
 196 #else
 197 #define twl_mmc_suspend NULL
 198 #define twl_mmc_resume  NULL
 199 #endif
 200
 201 #if defined(CONFIG_ARCH_OMAP3) && defined(CONFIG_PM)
 202
 203 static int twl4030_mmc_get_context_loss(struct device *dev)
 204 {
 205         /* FIXME: PM DPS not implemented yet */
 206         return 0;
 207 }
 208
 209 #else
 210 #define twl4030_mmc_get_context_loss NULL
 211 #endif
 212
 213 static int twl_mmc1_set_power(struct device *dev, int slot, int power_on,
 214                                 int vdd)
 215 {
 216         u32 reg, prog_io;
 217         int ret = 0;
 218         struct twl_mmc_controller *c = &hsmmc[0];
 219         struct omap_mmc_platform_data *mmc = dev->platform_data;
 220
 221         /*
 222          * Assume we power both OMAP VMMC1 (for CMD, CLK, DAT0..3) and the
 223          * card with Vcc regulator (from twl4030 or whatever).  OMAP has both
 224          * 1.8V and 3.0V modes, controlled by the PBIAS register.
 225          *
 226          * In 8-bit modes, OMAP VMMC1A (for DAT4..7) needs a supply, which
 227          * is most naturally TWL VSIM; those pins also use PBIAS.
 228          *
 229          * FIXME handle VMMC1A as needed ...
 230          */
 231         if (power_on) {
 232                 if (cpu_is_omap2430()) {
 233                         reg = omap_ctrl_readl(OMAP243X_CONTROL_DEVCONF1);
 234                         if ((1 << vdd) >= MMC_VDD_30_31)
 235                                 reg |= OMAP243X_MMC1_ACTIVE_OVERWRITE;
 236                         else
 237                                 reg &= ~OMAP243X_MMC1_ACTIVE_OVERWRITE;
 238                         omap_ctrl_writel(reg, OMAP243X_CONTROL_DEVCONF1);
 239                 }
 240
 241                 if (mmc->slots[0].internal_clock) {
 242                         reg = omap_ctrl_readl(OMAP2_CONTROL_DEVCONF0);
 243                         reg |= OMAP2_MMCSDIO1ADPCLKISEL;
 244                         omap_ctrl_writel(reg, OMAP2_CONTROL_DEVCONF0);
 245                 }
 246
 247                 reg = omap_ctrl_readl(control_pbias_offset);
 248                 if (cpu_is_omap3630()) {
 249                         /* Set MMC I/O to 52Mhz */
 250                         prog_io = omap_ctrl_readl(OMAP343X_CONTROL_PROG_IO1);
 251                         prog_io |= OMAP3630_PRG_SDMMC1_SPEEDCTRL;
 252                         omap_ctrl_writel(prog_io, OMAP343X_CONTROL_PROG_IO1);
 253                 } else {
 254                         reg |= OMAP2_PBIASSPEEDCTRL0;
 255                 }
 256                 reg &= ~OMAP2_PBIASLITEPWRDNZ0;
 257                 omap_ctrl_writel(reg, control_pbias_offset);
 258
 259                 ret = mmc_regulator_set_ocr(c->vcc, vdd);
 260
 261                 /* 100ms delay required for PBIAS configuration */
 262                 msleep(100);
 263                 reg = omap_ctrl_readl(control_pbias_offset);
 264                 reg |= (OMAP2_PBIASLITEPWRDNZ0 | OMAP2_PBIASSPEEDCTRL0);
 265                 if ((1 << vdd) <= MMC_VDD_165_195)
 266                         reg &= ~OMAP2_PBIASLITEVMODE0;
 267                 else
 268                         reg |= OMAP2_PBIASLITEVMODE0;
 269                 omap_ctrl_writel(reg, control_pbias_offset);
 270         } else {
 271                 reg = omap_ctrl_readl(control_pbias_offset);
 272                 reg &= ~OMAP2_PBIASLITEPWRDNZ0;
 273                 omap_ctrl_writel(reg, control_pbias_offset);
 274
 275                 ret = mmc_regulator_set_ocr(c->vcc, 0);
 276
 277                 /* 100ms delay required for PBIAS configuration */
 278                 msleep(100);
 279                 reg = omap_ctrl_readl(control_pbias_offset);
 280                 reg |= (OMAP2_PBIASSPEEDCTRL0 | OMAP2_PBIASLITEPWRDNZ0 |
 281                         OMAP2_PBIASLITEVMODE0);
 282                 omap_ctrl_writel(reg, control_pbias_offset);
 283         }
 284
 285         return ret;
 286 }
 287
 288 static int twl_mmc23_set_power(struct device *dev, int slot, int power_on, int vdd)
 289 {
 290         int ret = 0;
 291         struct twl_mmc_controller *c = NULL;
 292         struct omap_mmc_platform_data *mmc = dev->platform_data;
 293         int i;
 294
 295         for (i = 1; i < ARRAY_SIZE(hsmmc); i++) {
 296                 if (mmc == hsmmc[i].mmc) {
 297                         c = &hsmmc[i];
 298                         break;
 299                 }
 300         }
 301
 302         if (c == NULL)
 303                 return -ENODEV;
 304
 305         /* If we don't see a Vcc regulator, assume it's a fixed
 306          * voltage always-on regulator.
 307          */
 308         if (!c->vcc)
 309                 return 0;
 310
 311         /*
 312          * Assume Vcc regulator is used only to power the card ... OMAP
 313          * VDDS is used to power the pins, optionally with a transceiver to
 314          * support cards using voltages other than VDDS (1.8V nominal).  When a
 315          * transceiver is used, DAT3..7 are muxed as transceiver control pins.
 316          *
 317          * In some cases this regulator won't support enable/disable;
 318          * e.g. it's a fixed rail for a WLAN chip.
 319          *
 320          * In other cases vcc_aux switches interface power.  Example, for
 321          * eMMC cards it represents VccQ.  Sometimes transceivers or SDIO
 322          * chips/cards need an interface voltage rail too.
 323          */
 324         if (power_on) {
 325                 /* only MMC2 supports a CLKIN */
 326                 if (mmc->slots[0].internal_clock) {
 327                         u32 reg;
 328
 329                         reg = omap_ctrl_readl(control_devconf1_offset);
 330                         reg |= OMAP2_MMCSDIO2ADPCLKISEL;
 331                         omap_ctrl_writel(reg, control_devconf1_offset);
 332                 }
 333                 ret = mmc_regulator_set_ocr(c->vcc, vdd);
 334                 /* enable interface voltage rail, if needed */
 335                 if (ret == 0 && c->vcc_aux) {
 336                         ret = regulator_enable(c->vcc_aux);
 337                         if (ret < 0)
 338                                 ret = mmc_regulator_set_ocr(c->vcc, 0);
 339                 }
 340         } else {
 341                 if (c->vcc_aux && (ret = regulator_is_enabled(c->vcc_aux)) > 0)
 342                         ret = regulator_disable(c->vcc_aux);
 343                 if (ret == 0)
 344                         ret = mmc_regulator_set_ocr(c->vcc, 0);
 345         }
 346
 347         return ret;
 348 }
 349
 350 static int twl_mmc1_set_sleep(struct device *dev, int slot, int sleep, int vdd,
 351                               int cardsleep)
 352 {
 353         struct twl_mmc_controller *c = &hsmmc[0];
 354         int mode = sleep ? REGULATOR_MODE_STANDBY : REGULATOR_MODE_NORMAL;
 355
 356         return regulator_set_mode(c->vcc, mode);
 357 }
 358
 359 static int twl_mmc23_set_sleep(struct device *dev, int slot, int sleep, int vdd,
 360                                int cardsleep)
 361 {
 362         struct twl_mmc_controller *c = NULL;
 363         struct omap_mmc_platform_data *mmc = dev->platform_data;
 364         int i, err, mode;
 365
 366         for (i = 1; i < ARRAY_SIZE(hsmmc); i++) {
 367                 if (mmc == hsmmc[i].mmc) {
 368                         c = &hsmmc[i];
 369                         break;
 370                 }
 371         }
 372
 373         if (c == NULL)
 374                 return -ENODEV;
 375
 376         /*
 377          * If we don't see a Vcc regulator, assume it's a fixed
 378          * voltage always-on regulator.
 379          */
 380         if (!c->vcc)
 381                 return 0;
 382
 383         mode = sleep ? REGULATOR_MODE_STANDBY : REGULATOR_MODE_NORMAL;
 384
 385         if (!c->vcc_aux)
 386                 return regulator_set_mode(c->vcc, mode);
 387
 388         if (cardsleep) {
 389                 /* VCC can be turned off if card is asleep */
 390                 struct regulator *vcc_aux = c->vcc_aux;
 391
 392                 c->vcc_aux = NULL;
 393                 if (sleep)
 394                         err = twl_mmc23_set_power(dev, slot, 0, 0);
 395                 else
 396                         err = twl_mmc23_set_power(dev, slot, 1, vdd);
 397                 c->vcc_aux = vcc_aux;
 398         } else
 399                 err = regulator_set_mode(c->vcc, mode);
 400         if (err)
 401                 return err;
 402         return regulator_set_mode(c->vcc_aux, mode);
 403 }
 404
 405 static struct omap_mmc_platform_data *hsmmc_data[OMAP34XX_NR_MMC] __initdata;
 406
 407 void __init twl4030_mmc_init(struct twl4030_hsmmc_info *controllers)
 408 {
 409         struct twl4030_hsmmc_info *c;
 410         int nr_hsmmc = ARRAY_SIZE(hsmmc_data);
 411
 412         if (cpu_is_omap2430()) {
 413                 control_pbias_offset = OMAP243X_CONTROL_PBIAS_LITE;
 414                 control_devconf1_offset = OMAP243X_CONTROL_DEVCONF1;
 415                 nr_hsmmc = 2;
 416         } else {
 417                 control_pbias_offset = OMAP343X_CONTROL_PBIAS_LITE;
 418                 control_devconf1_offset = OMAP343X_CONTROL_DEVCONF1;
 419         }
 420
 421         for (c = controllers; c->mmc; c++) {
 422                 struct twl_mmc_controller *twl = hsmmc + c->mmc - 1;
 423                 struct omap_mmc_platform_data *mmc = hsmmc_data[c->mmc - 1];
 424
 425                 if (!c->mmc || c->mmc > nr_hsmmc) {
 426                         pr_debug("MMC%d: no such controller\n", c->mmc);
 427                         continue;
 428                 }
 429                 if (mmc) {
 430                         pr_debug("MMC%d: already configured\n", c->mmc);
 431                         continue;
 432                 }
 433
 434                 mmc = kzalloc(sizeof(struct omap_mmc_platform_data), GFP_KERNEL);
 435                 if (!mmc) {
 436                         pr_err("Cannot allocate memory for mmc device!\n");
 437                         return;
 438                 }
 439
 440                 if (c->name)
 441                         strncpy(twl->name, c->name, HSMMC_NAME_LEN);
 442                 else
 443                         snprintf(twl->name, ARRAY_SIZE(twl->name),
 444                                 "mmc%islot%i", c->mmc, 1);
 445                 mmc->slots[0].name = twl->name;
 446                 mmc->nr_slots = 1;
 447                 mmc->slots[0].wires = c->wires;
 448                 mmc->slots[0].internal_clock = !c->ext_clock;
 449                 mmc->dma_mask = 0xffffffff;
 450                 mmc->init = twl_mmc_late_init;
 451
 452                 /* note: twl4030 card detect GPIOs can disable VMMCx ... */
 453                 if (gpio_is_valid(c->gpio_cd)) {
 454                         mmc->cleanup = twl_mmc_cleanup;
 455                         mmc->suspend = twl_mmc_suspend;
 456                         mmc->resume = twl_mmc_resume;
 457
 458                         mmc->slots[0].switch_pin = c->gpio_cd;
 459                         mmc->slots[0].card_detect_irq = gpio_to_irq(c->gpio_cd);
 460                         if (c->cover_only)
 461                                 mmc->slots[0].get_cover_state = twl_mmc_get_cover_state;
 462                         else
 463                                 mmc->slots[0].card_detect = twl_mmc_card_detect;
 464                 } else
 465                         mmc->slots[0].switch_pin = -EINVAL;
 466
 467                 mmc->get_context_loss_count =
 468                                 twl4030_mmc_get_context_loss;
 469
 470                 /* write protect normally uses an OMAP gpio */
 471                 if (gpio_is_valid(c->gpio_wp)) {
 472                         gpio_request(c->gpio_wp, "mmc_wp");
 473                         gpio_direction_input(c->gpio_wp);
 474
 475                         mmc->slots[0].gpio_wp = c->gpio_wp;
 476                         mmc->slots[0].get_ro = twl_mmc_get_ro;
 477                 } else
 478                         mmc->slots[0].gpio_wp = -EINVAL;
 479
 480                 if (c->nonremovable)
 481                         mmc->slots[0].nonremovable = 1;
 482
 483                 if (c->power_saving)
 484                         mmc->slots[0].power_saving = 1;
 485
 486                 /* NOTE:  MMC slots should have a Vcc regulator set up.
 487                  * This may be from a TWL4030-family chip, another
 488                  * controllable regulator, or a fixed supply.
 489                  *
 490                  * temporary HACK: ocr_mask instead of fixed supply
 491                  */
 492                 mmc->slots[0].ocr_mask = c->ocr_mask;
 493
 494                 switch (c->mmc) {
 495                 case 1:
 496                         /* on-chip level shifting via PBIAS0/PBIAS1 */
 497                         mmc->slots[0].set_power = twl_mmc1_set_power;
 498                         mmc->slots[0].set_sleep = twl_mmc1_set_sleep;
 499
 500                         /* Omap3630 HSMMC1 supports only 4-bit */
 501                         if (cpu_is_omap3630() && c->wires > 4) {
 502                                 c->wires = 4;
 503                                 mmc->slots[0].wires = c->wires;
 504                         }
 505                         break;
 506                 case 2:
 507                         if (c->ext_clock)
 508                                 c->transceiver = 1;
 509                         if (c->transceiver && c->wires > 4)
 510                                 c->wires = 4;
 511                         /* FALLTHROUGH */
 512                 case 3:
 513                         /* off-chip level shifting, or none */
 514                         mmc->slots[0].set_power = twl_mmc23_set_power;
 515                         mmc->slots[0].set_sleep = twl_mmc23_set_sleep;
 516                         break;
 517                 default:
 518                         pr_err("MMC%d configuration not supported!\n", c->mmc);
 519                         kfree(mmc);
 520                         continue;
 521                 }
 522                 hsmmc_data[c->mmc - 1] = mmc;
 523         }
 524
 525         omap2_init_mmc(hsmmc_data, OMAP34XX_NR_MMC);
 526
 527         /* pass the device nodes back to board setup code */
 528         for (c = controllers; c->mmc; c++) {
 529                 struct omap_mmc_platform_data *mmc = hsmmc_data[c->mmc - 1];
 530
 531                 if (!c->mmc || c->mmc > nr_hsmmc)
 532                         continue;
 533                 c->dev = mmc->dev;
 534         }
 535 }
 536
 537 #endif