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