drivers/mmc/core/bus.c

   1 /*
   2  *  linux/drivers/mmc/core/bus.c
   3  *
   4  *  Copyright (C) 2003 Russell King, All Rights Reserved.
   5  *  Copyright (C) 2007 Pierre Ossman
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11  *  MMC card bus driver model
  12  */
  13
  14 #include <linux/export.h>
  15 #include <linux/device.h>
  16 #include <linux/err.h>
  17 #include <linux/slab.h>
  18 #include <linux/stat.h>
  19 #include <linux/of.h>
  20 #include <linux/pm_runtime.h>
  21
  22 #include <linux/mmc/card.h>
  23 #include <linux/mmc/host.h>
  24
  25 #include "core.h"
  26 #include "sdio_cis.h"
  27 #include "bus.h"
  28
  29 #define to_mmc_driver(d)        container_of(d, struct mmc_driver, drv)
  30
  31 static ssize_t type_show(struct device *dev,
  32         struct device_attribute *attr, char *buf)
  33 {
  34         struct mmc_card *card = mmc_dev_to_card(dev);
  35
  36         switch (card->type) {
  37         case MMC_TYPE_MMC:
  38                 return sprintf(buf, "MMC\n");
  39         case MMC_TYPE_SD:
  40                 return sprintf(buf, "SD\n");
  41         case MMC_TYPE_SDIO:
  42                 return sprintf(buf, "SDIO\n");
  43         case MMC_TYPE_SD_COMBO:
  44                 return sprintf(buf, "SDcombo\n");
  45         default:
  46                 return -EFAULT;
  47         }
  48 }
  49 static DEVICE_ATTR_RO(type);
  50
  51 static struct attribute *mmc_dev_attrs[] = {
  52         &dev_attr_type.attr,
  53         NULL,
  54 };
  55 ATTRIBUTE_GROUPS(mmc_dev);
  56
  57 /*
  58  * This currently matches any MMC driver to any MMC card - drivers
  59  * themselves make the decision whether to drive this card in their
  60  * probe method.
  61  */
  62 static int mmc_bus_match(struct device *dev, struct device_driver *drv)
  63 {
  64         return 1;
  65 }
  66
  67 static int
  68 mmc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
  69 {
  70         struct mmc_card *card = mmc_dev_to_card(dev);
  71         const char *type;
  72         int retval = 0;
  73
  74         switch (card->type) {
  75         case MMC_TYPE_MMC:
  76                 type = "MMC";
  77                 break;
  78         case MMC_TYPE_SD:
  79                 type = "SD";
  80                 break;
  81         case MMC_TYPE_SDIO:
  82                 type = "SDIO";
  83                 break;
  84         case MMC_TYPE_SD_COMBO:
  85                 type = "SDcombo";
  86                 break;
  87         default:
  88                 type = NULL;
  89         }
  90
  91         if (type) {
  92                 retval = add_uevent_var(env, "MMC_TYPE=%s", type);
  93                 if (retval)
  94                         return retval;
  95         }
  96
  97         retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
  98         if (retval)
  99                 return retval;
 100
 101         /*
 102          * Request the mmc_block device.  Note: that this is a direct request
 103          * for the module it carries no information as to what is inserted.
 104          */
 105         retval = add_uevent_var(env, "MODALIAS=mmc:block");
 106
 107         return retval;
 108 }
 109
 110 static int mmc_bus_probe(struct device *dev)
 111 {
 112         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 113         struct mmc_card *card = mmc_dev_to_card(dev);
 114
 115         return drv->probe(card);
 116 }
 117
 118 static int mmc_bus_remove(struct device *dev)
 119 {
 120         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 121         struct mmc_card *card = mmc_dev_to_card(dev);
 122
 123         drv->remove(card);
 124
 125         return 0;
 126 }
 127
 128 static void mmc_bus_shutdown(struct device *dev)
 129 {
 130         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 131         struct mmc_card *card = mmc_dev_to_card(dev);
 132         struct mmc_host *host = card->host;
 133         int ret;
 134
 135         if (dev->driver && drv->shutdown)
 136                 drv->shutdown(card);
 137
 138         if (host->bus_ops->shutdown) {
 139                 ret = host->bus_ops->shutdown(host);
 140                 if (ret)
 141                         pr_warn("%s: error %d during shutdown\n",
 142                                 mmc_hostname(host), ret);
 143         }
 144 }
 145
 146 #ifdef CONFIG_PM_SLEEP
 147 static int mmc_bus_suspend(struct device *dev)
 148 {
 149         struct mmc_card *card = mmc_dev_to_card(dev);
 150         struct mmc_host *host = card->host;
 151         int ret;
 152
 153         ret = pm_generic_suspend(dev);
 154         if (ret)
 155                 return ret;
 156
 157         ret = host->bus_ops->suspend(host);
 158         return ret;
 159 }
 160
 161 static int mmc_bus_resume(struct device *dev)
 162 {
 163         struct mmc_card *card = mmc_dev_to_card(dev);
 164         struct mmc_host *host = card->host;
 165         int ret;
 166
 167         ret = host->bus_ops->resume(host);
 168         if (ret)
 169                 pr_warn("%s: error %d during resume (card was removed?)\n",
 170                         mmc_hostname(host), ret);
 171
 172         ret = pm_generic_resume(dev);
 173         return ret;
 174 }
 175 #endif
 176
 177 #ifdef CONFIG_PM
 178 static int mmc_runtime_suspend(struct device *dev)
 179 {
 180         struct mmc_card *card = mmc_dev_to_card(dev);
 181         struct mmc_host *host = card->host;
 182
 183         return host->bus_ops->runtime_suspend(host);
 184 }
 185
 186 static int mmc_runtime_resume(struct device *dev)
 187 {
 188         struct mmc_card *card = mmc_dev_to_card(dev);
 189         struct mmc_host *host = card->host;
 190
 191         return host->bus_ops->runtime_resume(host);
 192 }
 193 #endif /* !CONFIG_PM */
 194
 195 static const struct dev_pm_ops mmc_bus_pm_ops = {
 196         SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
 197         SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
 198 };
 199
 200 static struct bus_type mmc_bus_type = {
 201         .name           = "mmc",
 202         .dev_groups     = mmc_dev_groups,
 203         .match          = mmc_bus_match,
 204         .uevent         = mmc_bus_uevent,
 205         .probe          = mmc_bus_probe,
 206         .remove         = mmc_bus_remove,
 207         .shutdown       = mmc_bus_shutdown,
 208         .pm             = &mmc_bus_pm_ops,
 209 };
 210
 211 int mmc_register_bus(void)
 212 {
 213         return bus_register(&mmc_bus_type);
 214 }
 215
 216 void mmc_unregister_bus(void)
 217 {
 218         bus_unregister(&mmc_bus_type);
 219 }
 220
 221 /**
 222  *      mmc_register_driver - register a media driver
 223  *      @drv: MMC media driver
 224  */
 225 int mmc_register_driver(struct mmc_driver *drv)
 226 {
 227         drv->drv.bus = &mmc_bus_type;
 228         return driver_register(&drv->drv);
 229 }
 230
 231 EXPORT_SYMBOL(mmc_register_driver);
 232
 233 /**
 234  *      mmc_unregister_driver - unregister a media driver
 235  *      @drv: MMC media driver
 236  */
 237 void mmc_unregister_driver(struct mmc_driver *drv)
 238 {
 239         drv->drv.bus = &mmc_bus_type;
 240         driver_unregister(&drv->drv);
 241 }
 242
 243 EXPORT_SYMBOL(mmc_unregister_driver);
 244
 245 static void mmc_release_card(struct device *dev)
 246 {
 247         struct mmc_card *card = mmc_dev_to_card(dev);
 248
 249         sdio_free_common_cis(card);
 250
 251         kfree(card->info);
 252
 253         kfree(card);
 254 }
 255
 256 /*
 257  * Allocate and initialise a new MMC card structure.
 258  */
 259 struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
 260 {
 261         struct mmc_card *card;
 262
 263         card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
 264         if (!card)
 265                 return ERR_PTR(-ENOMEM);
 266
 267         card->host = host;
 268
 269         device_initialize(&card->dev);
 270
 271         card->dev.parent = mmc_classdev(host);
 272         card->dev.bus = &mmc_bus_type;
 273         card->dev.release = mmc_release_card;
 274         card->dev.type = type;
 275
 276         return card;
 277 }
 278
 279 /*
 280  * Register a new MMC card with the driver model.
 281  */
 282 int mmc_add_card(struct mmc_card *card)
 283 {
 284         int ret;
 285         const char *type;
 286         const char *uhs_bus_speed_mode = "";
 287         static const char *const uhs_speeds[] = {
 288                 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
 289                 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
 290                 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
 291                 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
 292                 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
 293         };
 294
 295
 296         dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
 297
 298         switch (card->type) {
 299         case MMC_TYPE_MMC:
 300                 type = "MMC";
 301                 break;
 302         case MMC_TYPE_SD:
 303                 type = "SD";
 304                 if (mmc_card_blockaddr(card)) {
 305                         if (mmc_card_ext_capacity(card))
 306                                 type = "SDXC";
 307                         else
 308                                 type = "SDHC";
 309                 }
 310                 break;
 311         case MMC_TYPE_SDIO:
 312                 type = "SDIO";
 313                 break;
 314         case MMC_TYPE_SD_COMBO:
 315                 type = "SD-combo";
 316                 if (mmc_card_blockaddr(card))
 317                         type = "SDHC-combo";
 318                 break;
 319         default:
 320                 type = "?";
 321                 break;
 322         }
 323
 324         if (mmc_card_uhs(card) &&
 325                 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
 326                 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
 327
 328         if (mmc_host_is_spi(card->host)) {
 329                 pr_info("%s: new %s%s%s card on SPI\n",
 330                         mmc_hostname(card->host),
 331                         mmc_card_hs(card) ? "high speed " : "",
 332                         mmc_card_ddr52(card) ? "DDR " : "",
 333                         type);
 334         } else {
 335                 pr_info("%s: new %s%s%s%s%s%s card at address %04x\n",
 336                         mmc_hostname(card->host),
 337                         mmc_card_uhs(card) ? "ultra high speed " :
 338                         (mmc_card_hs(card) ? "high speed " : ""),
 339                         mmc_card_hs400(card) ? "HS400 " :
 340                         (mmc_card_hs200(card) ? "HS200 " : ""),
 341                         mmc_card_hs400es(card) ? "Enhanced strobe " : "",
 342                         mmc_card_ddr52(card) ? "DDR " : "",
 343                         uhs_bus_speed_mode, type, card->rca);
 344         }
 345
 346 #ifdef CONFIG_DEBUG_FS
 347         mmc_add_card_debugfs(card);
 348 #endif
 349         mmc_init_context_info(card->host);
 350
 351         card->dev.of_node = mmc_of_find_child_device(card->host, 0);
 352
 353         ret = device_add(&card->dev);
 354         if (ret)
 355                 return ret;
 356
 357         mmc_card_set_present(card);
 358
 359         return 0;
 360 }
 361
 362 /*
 363  * Unregister a new MMC card with the driver model, and
 364  * (eventually) free it.
 365  */
 366 void mmc_remove_card(struct mmc_card *card)
 367 {
 368 #ifdef CONFIG_DEBUG_FS
 369         mmc_remove_card_debugfs(card);
 370 #endif
 371
 372         if (mmc_card_present(card)) {
 373                 if (mmc_host_is_spi(card->host)) {
 374                         pr_info("%s: SPI card removed\n",
 375                                 mmc_hostname(card->host));
 376                 } else {
 377                         pr_info("%s: card %04x removed\n",
 378                                 mmc_hostname(card->host), card->rca);
 379                 }
 380                 device_del(&card->dev);
 381                 of_node_put(card->dev.of_node);
 382         }
 383
 384         put_device(&card->dev);
 385 }
 386