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