drivers/mmc/core/sdio_bus.c

   1 /*
   2  *  linux/drivers/mmc/core/sdio_bus.c
   3  *
   4  *  Copyright 2007 Pierre Ossman
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or (at
   9  * your option) any later version.
  10  *
  11  * SDIO function driver model
  12  */
  13
  14 #include <linux/device.h>
  15 #include <linux/err.h>
  16 #include <linux/export.h>
  17 #include <linux/slab.h>
  18 #include <linux/pm_runtime.h>
  19 #include <linux/pm_domain.h>
  20 #include <linux/acpi.h>
  21
  22 #include <linux/mmc/card.h>
  23 #include <linux/mmc/host.h>
  24 #include <linux/mmc/sdio_func.h>
  25 #include <linux/of.h>
  26
  27 #include "core.h"
  28 #include "sdio_cis.h"
  29 #include "sdio_bus.h"
  30
  31 #ifdef CONFIG_MMC_EMBEDDED_SDIO
  32 #include <linux/mmc/host.h>
  33 #endif
  34
  35 #define to_sdio_driver(d)       container_of(d, struct sdio_driver, drv)
  36
  37 /* show configuration fields */
  38 #define sdio_config_attr(field, format_string)                          \
  39 static ssize_t                                                          \
  40 field##_show(struct device *dev, struct device_attribute *attr, char *buf)                              \
  41 {                                                                       \
  42         struct sdio_func *func;                                         \
  43                                                                         \
  44         func = dev_to_sdio_func (dev);                                  \
  45         return sprintf (buf, format_string, func->field);               \
  46 }                                                                       \
  47 static DEVICE_ATTR_RO(field)
  48
  49 sdio_config_attr(class, "0x%02x\n");
  50 sdio_config_attr(vendor, "0x%04x\n");
  51 sdio_config_attr(device, "0x%04x\n");
  52
  53 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
  54 {
  55         struct sdio_func *func = dev_to_sdio_func (dev);
  56
  57         return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n",
  58                         func->class, func->vendor, func->device);
  59 }
  60 static DEVICE_ATTR_RO(modalias);
  61
  62 static struct attribute *sdio_dev_attrs[] = {
  63         &dev_attr_class.attr,
  64         &dev_attr_vendor.attr,
  65         &dev_attr_device.attr,
  66         &dev_attr_modalias.attr,
  67         NULL,
  68 };
  69 ATTRIBUTE_GROUPS(sdio_dev);
  70
  71 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
  72         const struct sdio_device_id *id)
  73 {
  74         if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
  75                 return NULL;
  76         if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
  77                 return NULL;
  78         if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
  79                 return NULL;
  80         return id;
  81 }
  82
  83 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
  84         struct sdio_driver *sdrv)
  85 {
  86         const struct sdio_device_id *ids;
  87
  88         ids = sdrv->id_table;
  89
  90         if (ids) {
  91                 while (ids->class || ids->vendor || ids->device) {
  92                         if (sdio_match_one(func, ids))
  93                                 return ids;
  94                         ids++;
  95                 }
  96         }
  97
  98         return NULL;
  99 }
 100
 101 static int sdio_bus_match(struct device *dev, struct device_driver *drv)
 102 {
 103         struct sdio_func *func = dev_to_sdio_func(dev);
 104         struct sdio_driver *sdrv = to_sdio_driver(drv);
 105
 106         if (sdio_match_device(func, sdrv))
 107                 return 1;
 108
 109         return 0;
 110 }
 111
 112 static int
 113 sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
 114 {
 115         struct sdio_func *func = dev_to_sdio_func(dev);
 116
 117         if (add_uevent_var(env,
 118                         "SDIO_CLASS=%02X", func->class))
 119                 return -ENOMEM;
 120
 121         if (add_uevent_var(env,
 122                         "SDIO_ID=%04X:%04X", func->vendor, func->device))
 123                 return -ENOMEM;
 124
 125         if (add_uevent_var(env,
 126                         "MODALIAS=sdio:c%02Xv%04Xd%04X",
 127                         func->class, func->vendor, func->device))
 128                 return -ENOMEM;
 129
 130         return 0;
 131 }
 132
 133 static int sdio_bus_probe(struct device *dev)
 134 {
 135         struct sdio_driver *drv = to_sdio_driver(dev->driver);
 136         struct sdio_func *func = dev_to_sdio_func(dev);
 137         const struct sdio_device_id *id;
 138         int ret;
 139
 140         id = sdio_match_device(func, drv);
 141         if (!id)
 142                 return -ENODEV;
 143
 144         ret = dev_pm_domain_attach(dev, false);
 145         if (ret == -EPROBE_DEFER)
 146                 return ret;
 147
 148         /* Unbound SDIO functions are always suspended.
 149          * During probe, the function is set active and the usage count
 150          * is incremented.  If the driver supports runtime PM,
 151          * it should call pm_runtime_put_noidle() in its probe routine and
 152          * pm_runtime_get_noresume() in its remove routine.
 153          */
 154         if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
 155                 ret = pm_runtime_get_sync(dev);
 156                 if (ret < 0)
 157                         goto disable_runtimepm;
 158         }
 159
 160         /* Set the default block size so the driver is sure it's something
 161          * sensible. */
 162         sdio_claim_host(func);
 163         ret = sdio_set_block_size(func, 0);
 164         sdio_release_host(func);
 165         if (ret)
 166                 goto disable_runtimepm;
 167
 168         ret = drv->probe(func, id);
 169         if (ret)
 170                 goto disable_runtimepm;
 171
 172         return 0;
 173
 174 disable_runtimepm:
 175         if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
 176                 pm_runtime_put_noidle(dev);
 177         dev_pm_domain_detach(dev, false);
 178         return ret;
 179 }
 180
 181 static int sdio_bus_remove(struct device *dev)
 182 {
 183         struct sdio_driver *drv = to_sdio_driver(dev->driver);
 184         struct sdio_func *func = dev_to_sdio_func(dev);
 185         int ret = 0;
 186
 187         /* Make sure card is powered before invoking ->remove() */
 188         if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
 189                 pm_runtime_get_sync(dev);
 190
 191         drv->remove(func);
 192
 193         if (func->irq_handler) {
 194                 pr_warn("WARNING: driver %s did not remove its interrupt handler!\n",
 195                         drv->name);
 196                 sdio_claim_host(func);
 197                 sdio_release_irq(func);
 198                 sdio_release_host(func);
 199         }
 200
 201         /* First, undo the increment made directly above */
 202         if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
 203                 pm_runtime_put_noidle(dev);
 204
 205         /* Then undo the runtime PM settings in sdio_bus_probe() */
 206         if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
 207                 pm_runtime_put_sync(dev);
 208
 209         dev_pm_domain_detach(dev, false);
 210
 211         return ret;
 212 }
 213
 214 static const struct dev_pm_ops sdio_bus_pm_ops = {
 215         SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume)
 216         SET_RUNTIME_PM_OPS(
 217                 pm_generic_runtime_suspend,
 218                 pm_generic_runtime_resume,
 219                 NULL
 220         )
 221 };
 222
 223 static struct bus_type sdio_bus_type = {
 224         .name           = "sdio",
 225         .dev_groups     = sdio_dev_groups,
 226         .match          = sdio_bus_match,
 227         .uevent         = sdio_bus_uevent,
 228         .probe          = sdio_bus_probe,
 229         .remove         = sdio_bus_remove,
 230         .pm             = &sdio_bus_pm_ops,
 231 };
 232
 233 int sdio_register_bus(void)
 234 {
 235         return bus_register(&sdio_bus_type);
 236 }
 237
 238 void sdio_unregister_bus(void)
 239 {
 240         bus_unregister(&sdio_bus_type);
 241 }
 242
 243 /**
 244  *      sdio_register_driver - register a function driver
 245  *      @drv: SDIO function driver
 246  */
 247 int sdio_register_driver(struct sdio_driver *drv)
 248 {
 249         drv->drv.name = drv->name;
 250         drv->drv.bus = &sdio_bus_type;
 251         return driver_register(&drv->drv);
 252 }
 253 EXPORT_SYMBOL_GPL(sdio_register_driver);
 254
 255 /**
 256  *      sdio_unregister_driver - unregister a function driver
 257  *      @drv: SDIO function driver
 258  */
 259 void sdio_unregister_driver(struct sdio_driver *drv)
 260 {
 261         drv->drv.bus = &sdio_bus_type;
 262         driver_unregister(&drv->drv);
 263 }
 264 EXPORT_SYMBOL_GPL(sdio_unregister_driver);
 265
 266 static void sdio_release_func(struct device *dev)
 267 {
 268         struct sdio_func *func = dev_to_sdio_func(dev);
 269
 270 #ifdef CONFIG_MMC_EMBEDDED_SDIO
 271         /*
 272          * If this device is embedded then we never allocated
 273          * cis tables for this func
 274          */
 275         if (!func->card->host->embedded_sdio_data.funcs)
 276 #endif
 277                 sdio_free_func_cis(func);
 278
 279         kfree(func->info);
 280
 281         kfree(func);
 282 }
 283
 284 /*
 285  * Allocate and initialise a new SDIO function structure.
 286  */
 287 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
 288 {
 289         struct sdio_func *func;
 290
 291         func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
 292         if (!func)
 293                 return ERR_PTR(-ENOMEM);
 294
 295         func->card = card;
 296
 297         device_initialize(&func->dev);
 298
 299         func->dev.parent = &card->dev;
 300         func->dev.bus = &sdio_bus_type;
 301         func->dev.release = sdio_release_func;
 302
 303         return func;
 304 }
 305
 306 #ifdef CONFIG_ACPI
 307 static void sdio_acpi_set_handle(struct sdio_func *func)
 308 {
 309         struct mmc_host *host = func->card->host;
 310         u64 addr = ((u64)host->slotno << 16) | func->num;
 311
 312         acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
 313 }
 314 #else
 315 static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
 316 #endif
 317
 318 static void sdio_set_of_node(struct sdio_func *func)
 319 {
 320         struct mmc_host *host = func->card->host;
 321
 322         func->dev.of_node = mmc_of_find_child_device(host, func->num);
 323 }
 324
 325 /*
 326  * Register a new SDIO function with the driver model.
 327  */
 328 int sdio_add_func(struct sdio_func *func)
 329 {
 330         int ret;
 331
 332         dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
 333
 334         sdio_set_of_node(func);
 335         sdio_acpi_set_handle(func);
 336         ret = device_add(&func->dev);
 337         if (ret == 0)
 338                 sdio_func_set_present(func);
 339
 340         return ret;
 341 }
 342
 343 /*
 344  * Unregister a SDIO function with the driver model, and
 345  * (eventually) free it.
 346  * This function can be called through error paths where sdio_add_func() was
 347  * never executed (because a failure occurred at an earlier point).
 348  */
 349 void sdio_remove_func(struct sdio_func *func)
 350 {
 351         if (!sdio_func_present(func))
 352                 return;
 353
 354         device_del(&func->dev);
 355         of_node_put(func->dev.of_node);
 356         put_device(&func->dev);
 357 }
 358