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