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