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