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         if (ret)
 159                 pm_generic_resume(dev);
 160
 161         return ret;
 162 }
 163
 164 static int mmc_bus_resume(struct device *dev)
 165 {
 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         ret = pm_generic_resume(dev);
 176         return ret;
 177 }
 178 #endif
 179
 180 #ifdef CONFIG_PM
 181 static int mmc_runtime_suspend(struct device *dev)
 182 {
 183         struct mmc_card *card = mmc_dev_to_card(dev);
 184         struct mmc_host *host = card->host;
 185
 186         return host->bus_ops->runtime_suspend(host);
 187 }
 188
 189 static int mmc_runtime_resume(struct device *dev)
 190 {
 191         struct mmc_card *card = mmc_dev_to_card(dev);
 192         struct mmc_host *host = card->host;
 193
 194         return host->bus_ops->runtime_resume(host);
 195 }
 196 #endif /* !CONFIG_PM */
 197
 198 static const struct dev_pm_ops mmc_bus_pm_ops = {
 199         SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
 200         SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
 201 };
 202
 203 static struct bus_type mmc_bus_type = {
 204         .name           = "mmc",
 205         .dev_groups     = mmc_dev_groups,
 206         .match          = mmc_bus_match,
 207         .uevent         = mmc_bus_uevent,
 208         .probe          = mmc_bus_probe,
 209         .remove         = mmc_bus_remove,
 210         .shutdown       = mmc_bus_shutdown,
 211         .pm             = &mmc_bus_pm_ops,
 212 };
 213
 214 int mmc_register_bus(void)
 215 {
 216         return bus_register(&mmc_bus_type);
 217 }
 218
 219 void mmc_unregister_bus(void)
 220 {
 221         bus_unregister(&mmc_bus_type);
 222 }
 223
 224 /**
 225  *      mmc_register_driver - register a media driver
 226  *      @drv: MMC media driver
 227  */
 228 int mmc_register_driver(struct mmc_driver *drv)
 229 {
 230         drv->drv.bus = &mmc_bus_type;
 231         return driver_register(&drv->drv);
 232 }
 233
 234 EXPORT_SYMBOL(mmc_register_driver);
 235
 236 /**
 237  *      mmc_unregister_driver - unregister a media driver
 238  *      @drv: MMC media driver
 239  */
 240 void mmc_unregister_driver(struct mmc_driver *drv)
 241 {
 242         drv->drv.bus = &mmc_bus_type;
 243         driver_unregister(&drv->drv);
 244 }
 245
 246 EXPORT_SYMBOL(mmc_unregister_driver);
 247
 248 static void mmc_release_card(struct device *dev)
 249 {
 250         struct mmc_card *card = mmc_dev_to_card(dev);
 251
 252         sdio_free_common_cis(card);
 253
 254         kfree(card->info);
 255
 256         kfree(card);
 257 }
 258
 259 /*
 260  * Allocate and initialise a new MMC card structure.
 261  */
 262 struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
 263 {
 264         struct mmc_card *card;
 265
 266         card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
 267         if (!card)
 268                 return ERR_PTR(-ENOMEM);
 269
 270         card->host = host;
 271
 272         device_initialize(&card->dev);
 273
 274         card->dev.parent = mmc_classdev(host);
 275         card->dev.bus = &mmc_bus_type;
 276         card->dev.release = mmc_release_card;
 277         card->dev.type = type;
 278
 279         return card;
 280 }
 281
 282 /*
 283  * Register a new MMC card with the driver model.
 284  */
 285 int mmc_add_card(struct mmc_card *card)
 286 {
 287         int ret;
 288         const char *type;
 289         const char *uhs_bus_speed_mode = "";
 290         static const char *const uhs_speeds[] = {
 291                 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
 292                 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
 293                 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
 294                 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
 295                 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
 296         };
 297
 298
 299         dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
 300
 301         switch (card->type) {
 302         case MMC_TYPE_MMC:
 303                 type = "MMC";
 304                 break;
 305         case MMC_TYPE_SD:
 306                 type = "SD";
 307                 if (mmc_card_blockaddr(card)) {
 308                         if (mmc_card_ext_capacity(card))
 309                                 type = "SDXC";
 310                         else
 311                                 type = "SDHC";
 312                 }
 313                 break;
 314         case MMC_TYPE_SDIO:
 315                 type = "SDIO";
 316                 break;
 317         case MMC_TYPE_SD_COMBO:
 318                 type = "SD-combo";
 319                 if (mmc_card_blockaddr(card))
 320                         type = "SDHC-combo";
 321                 break;
 322         default:
 323                 type = "?";
 324                 break;
 325         }
 326
 327         if (mmc_card_uhs(card) &&
 328                 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
 329                 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
 330
 331         if (mmc_host_is_spi(card->host)) {
 332                 pr_info("%s: new %s%s%s card on SPI\n",
 333                         mmc_hostname(card->host),
 334                         mmc_card_hs(card) ? "high speed " : "",
 335                         mmc_card_ddr52(card) ? "DDR " : "",
 336                         type);
 337         } else {
 338                 pr_info("%s: new %s%s%s%s%s card at address %04x\n",
 339                         mmc_hostname(card->host),
 340                         mmc_card_uhs(card) ? "ultra high speed " :
 341                         (mmc_card_hs(card) ? "high speed " : ""),
 342                         mmc_card_hs400(card) ? "HS400 " :
 343                         (mmc_card_hs200(card) ? "HS200 " : ""),
 344                         mmc_card_ddr52(card) ? "DDR " : "",
 345                         uhs_bus_speed_mode, type, card->rca);
 346         }
 347
 348 #ifdef CONFIG_DEBUG_FS
 349         mmc_add_card_debugfs(card);
 350 #endif
 351         mmc_init_context_info(card->host);
 352
 353         card->dev.of_node = mmc_of_find_child_device(card->host, 0);
 354
 355         ret = device_add(&card->dev);
 356         if (ret)
 357                 return ret;
 358
 359         mmc_card_set_present(card);
 360
 361         return 0;
 362 }
 363
 364 /*
 365  * Unregister a new MMC card with the driver model, and
 366  * (eventually) free it.
 367  */
 368 void mmc_remove_card(struct mmc_card *card)
 369 {
 370 #ifdef CONFIG_DEBUG_FS
 371         mmc_remove_card_debugfs(card);
 372 #endif
 373
 374         if (mmc_card_present(card)) {
 375                 if (mmc_host_is_spi(card->host)) {
 376                         pr_info("%s: SPI card removed\n",
 377                                 mmc_hostname(card->host));
 378                 } else {
 379                         pr_info("%s: card %04x removed\n",
 380                                 mmc_hostname(card->host), card->rca);
 381                 }
 382                 device_del(&card->dev);
 383                 of_node_put(card->dev.of_node);
 384         }
 385
 386         put_device(&card->dev);
 387 }
 388