drivers/mmc/core/bus.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/drivers/mmc/core/bus.c
   4  *
   5  *  Copyright (C) 2003 Russell King, All Rights Reserved.
   6  *  Copyright (C) 2007 Pierre Ossman
   7  *
   8  *  MMC card bus driver model
   9  */
  10
  11 #include <linux/export.h>
  12 #include <linux/device.h>
  13 #include <linux/err.h>
  14 #include <linux/slab.h>
  15 #include <linux/stat.h>
  16 #include <linux/of.h>
  17 #include <linux/pm_runtime.h>
  18
  19 #include <linux/mmc/card.h>
  20 #include <linux/mmc/host.h>
  21
  22 #include "core.h"
  23 #include "card.h"
  24 #include "host.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         if (card->type == MMC_TYPE_SDIO || card->type == MMC_TYPE_SD_COMBO) {
  97                 retval = add_uevent_var(env, "SDIO_ID=%04X:%04X",
  98                                         card->cis.vendor, card->cis.device);
  99                 if (retval)
 100                         return retval;
 101         }
 102
 103         /*
 104          * SDIO (non-combo) cards are not handled by mmc_block driver and do not
 105          * have accessible CID register which used by mmc_card_name() function.
 106          */
 107         if (card->type == MMC_TYPE_SDIO)
 108                 return 0;
 109
 110         retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
 111         if (retval)
 112                 return retval;
 113
 114         /*
 115          * Request the mmc_block device.  Note: that this is a direct request
 116          * for the module it carries no information as to what is inserted.
 117          */
 118         retval = add_uevent_var(env, "MODALIAS=mmc:block");
 119
 120         return retval;
 121 }
 122
 123 static int mmc_bus_probe(struct device *dev)
 124 {
 125         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 126         struct mmc_card *card = mmc_dev_to_card(dev);
 127
 128         return drv->probe(card);
 129 }
 130
 131 static int mmc_bus_remove(struct device *dev)
 132 {
 133         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 134         struct mmc_card *card = mmc_dev_to_card(dev);
 135
 136         drv->remove(card);
 137
 138         return 0;
 139 }
 140
 141 static void mmc_bus_shutdown(struct device *dev)
 142 {
 143         struct mmc_driver *drv = to_mmc_driver(dev->driver);
 144         struct mmc_card *card = mmc_dev_to_card(dev);
 145         struct mmc_host *host = card->host;
 146         int ret;
 147
 148         if (dev->driver && drv->shutdown)
 149                 drv->shutdown(card);
 150
 151         if (host->bus_ops->shutdown) {
 152                 ret = host->bus_ops->shutdown(host);
 153                 if (ret)
 154                         pr_warn("%s: error %d during shutdown\n",
 155                                 mmc_hostname(host), ret);
 156         }
 157 }
 158
 159 #ifdef CONFIG_PM_SLEEP
 160 static int mmc_bus_suspend(struct device *dev)
 161 {
 162         struct mmc_card *card = mmc_dev_to_card(dev);
 163         struct mmc_host *host = card->host;
 164         int ret;
 165
 166         ret = pm_generic_suspend(dev);
 167         if (ret)
 168                 return ret;
 169
 170         ret = host->bus_ops->suspend(host);
 171         if (ret)
 172                 pm_generic_resume(dev);
 173
 174         return ret;
 175 }
 176
 177 static int mmc_bus_resume(struct device *dev)
 178 {
 179         struct mmc_card *card = mmc_dev_to_card(dev);
 180         struct mmc_host *host = card->host;
 181         int ret;
 182
 183         ret = host->bus_ops->resume(host);
 184         if (ret)
 185                 pr_warn("%s: error %d during resume (card was removed?)\n",
 186                         mmc_hostname(host), ret);
 187
 188         ret = pm_generic_resume(dev);
 189         return ret;
 190 }
 191 #endif
 192
 193 #ifdef CONFIG_PM
 194 static int mmc_runtime_suspend(struct device *dev)
 195 {
 196         struct mmc_card *card = mmc_dev_to_card(dev);
 197         struct mmc_host *host = card->host;
 198
 199         return host->bus_ops->runtime_suspend(host);
 200 }
 201
 202 static int mmc_runtime_resume(struct device *dev)
 203 {
 204         struct mmc_card *card = mmc_dev_to_card(dev);
 205         struct mmc_host *host = card->host;
 206
 207         return host->bus_ops->runtime_resume(host);
 208 }
 209 #endif /* !CONFIG_PM */
 210
 211 static const struct dev_pm_ops mmc_bus_pm_ops = {
 212         SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
 213         SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
 214 };
 215
 216 static struct bus_type mmc_bus_type = {
 217         .name           = "mmc",
 218         .dev_groups     = mmc_dev_groups,
 219         .match          = mmc_bus_match,
 220         .uevent         = mmc_bus_uevent,
 221         .probe          = mmc_bus_probe,
 222         .remove         = mmc_bus_remove,
 223         .shutdown       = mmc_bus_shutdown,
 224         .pm             = &mmc_bus_pm_ops,
 225 };
 226
 227 int mmc_register_bus(void)
 228 {
 229         return bus_register(&mmc_bus_type);
 230 }
 231
 232 void mmc_unregister_bus(void)
 233 {
 234         bus_unregister(&mmc_bus_type);
 235 }
 236
 237 /**
 238  *      mmc_register_driver - register a media driver
 239  *      @drv: MMC media driver
 240  */
 241 int mmc_register_driver(struct mmc_driver *drv)
 242 {
 243         drv->drv.bus = &mmc_bus_type;
 244         return driver_register(&drv->drv);
 245 }
 246
 247 EXPORT_SYMBOL(mmc_register_driver);
 248
 249 /**
 250  *      mmc_unregister_driver - unregister a media driver
 251  *      @drv: MMC media driver
 252  */
 253 void mmc_unregister_driver(struct mmc_driver *drv)
 254 {
 255         drv->drv.bus = &mmc_bus_type;
 256         driver_unregister(&drv->drv);
 257 }
 258
 259 EXPORT_SYMBOL(mmc_unregister_driver);
 260
 261 static void mmc_release_card(struct device *dev)
 262 {
 263         struct mmc_card *card = mmc_dev_to_card(dev);
 264
 265         sdio_free_common_cis(card);
 266
 267         kfree(card->info);
 268
 269         kfree(card);
 270 }
 271
 272 /*
 273  * Allocate and initialise a new MMC card structure.
 274  */
 275 struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
 276 {
 277         struct mmc_card *card;
 278
 279         card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
 280         if (!card)
 281                 return ERR_PTR(-ENOMEM);
 282
 283         card->host = host;
 284
 285         device_initialize(&card->dev);
 286
 287         card->dev.parent = mmc_classdev(host);
 288         card->dev.bus = &mmc_bus_type;
 289         card->dev.release = mmc_release_card;
 290         card->dev.type = type;
 291
 292         return card;
 293 }
 294
 295 /*
 296  * Register a new MMC card with the driver model.
 297  */
 298 int mmc_add_card(struct mmc_card *card)
 299 {
 300         int ret;
 301         const char *type;
 302         const char *uhs_bus_speed_mode = "";
 303         static const char *const uhs_speeds[] = {
 304                 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
 305                 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
 306                 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
 307                 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
 308                 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
 309         };
 310
 311
 312         dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
 313
 314         switch (card->type) {
 315         case MMC_TYPE_MMC:
 316                 type = "MMC";
 317                 break;
 318         case MMC_TYPE_SD:
 319                 type = "SD";
 320                 if (mmc_card_blockaddr(card)) {
 321                         if (mmc_card_ext_capacity(card))
 322                                 type = "SDXC";
 323                         else
 324                                 type = "SDHC";
 325                 }
 326                 break;
 327         case MMC_TYPE_SDIO:
 328                 type = "SDIO";
 329                 break;
 330         case MMC_TYPE_SD_COMBO:
 331                 type = "SD-combo";
 332                 if (mmc_card_blockaddr(card))
 333                         type = "SDHC-combo";
 334                 break;
 335         default:
 336                 type = "?";
 337                 break;
 338         }
 339
 340         if (mmc_card_uhs(card) &&
 341                 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
 342                 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
 343
 344         if (mmc_host_is_spi(card->host)) {
 345                 pr_info("%s: new %s%s%s card on SPI\n",
 346                         mmc_hostname(card->host),
 347                         mmc_card_hs(card) ? "high speed " : "",
 348                         mmc_card_ddr52(card) ? "DDR " : "",
 349                         type);
 350         } else {
 351                 pr_info("%s: new %s%s%s%s%s%s card at address %04x\n",
 352                         mmc_hostname(card->host),
 353                         mmc_card_uhs(card) ? "ultra high speed " :
 354                         (mmc_card_hs(card) ? "high speed " : ""),
 355                         mmc_card_hs400(card) ? "HS400 " :
 356                         (mmc_card_hs200(card) ? "HS200 " : ""),
 357                         mmc_card_hs400es(card) ? "Enhanced strobe " : "",
 358                         mmc_card_ddr52(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         card->dev.of_node = mmc_of_find_child_device(card->host, 0);
 366
 367         device_enable_async_suspend(&card->dev);
 368
 369         ret = device_add(&card->dev);
 370         if (ret)
 371                 return ret;
 372
 373         mmc_card_set_present(card);
 374
 375         return 0;
 376 }
 377
 378 /*
 379  * Unregister a new MMC card with the driver model, and
 380  * (eventually) free it.
 381  */
 382 void mmc_remove_card(struct mmc_card *card)
 383 {
 384         struct mmc_host *host = card->host;
 385
 386 #ifdef CONFIG_DEBUG_FS
 387         mmc_remove_card_debugfs(card);
 388 #endif
 389
 390         if (host->cqe_enabled) {
 391                 host->cqe_ops->cqe_disable(host);
 392                 host->cqe_enabled = false;
 393         }
 394
 395         if (mmc_card_present(card)) {
 396                 if (mmc_host_is_spi(card->host)) {
 397                         pr_info("%s: SPI card removed\n",
 398                                 mmc_hostname(card->host));
 399                 } else {
 400                         pr_info("%s: card %04x removed\n",
 401                                 mmc_hostname(card->host), card->rca);
 402                 }
 403                 device_del(&card->dev);
 404                 of_node_put(card->dev.of_node);
 405         }
 406
 407         put_device(&card->dev);
 408 }
 409