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 26#include "sdio_cis.h" 27#include "sdio_bus.h" 28 29#ifdef CONFIG_MMC_EMBEDDED_SDIO 30#include <linux/mmc/host.h> 31#endif 32 33/* show configuration fields */ 34#define sdio_config_attr(field, format_string) \ 35static ssize_t \ 36field##_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} \ 43static DEVICE_ATTR_RO(field) 44 45sdio_config_attr(class, "0x%02x\n"); 46sdio_config_attr(vendor, "0x%04x\n"); 47sdio_config_attr(device, "0x%04x\n"); 48 49static 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} 56static DEVICE_ATTR_RO(modalias); 57 58static 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}; 65ATTRIBUTE_GROUPS(sdio_dev); 66 67static 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 79static 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 97static 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 108static int 109sdio_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 129static 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 166disable_runtimepm: 167 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) 168 pm_runtime_put_noidle(dev); 169 return ret; 170} 171 172static 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#ifdef CONFIG_PM 204 205static const struct dev_pm_ops sdio_bus_pm_ops = { 206 SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume) 207 SET_RUNTIME_PM_OPS( 208 pm_generic_runtime_suspend, 209 pm_generic_runtime_resume, 210 NULL 211 ) 212}; 213 214#define SDIO_PM_OPS_PTR (&sdio_bus_pm_ops) 215 216#else /* !CONFIG_PM */ 217 218#define SDIO_PM_OPS_PTR NULL 219 220#endif /* !CONFIG_PM */ 221 222static struct bus_type sdio_bus_type = { 223 .name = "sdio", 224 .dev_groups = sdio_dev_groups, 225 .match = sdio_bus_match, 226 .uevent = sdio_bus_uevent, 227 .probe = sdio_bus_probe, 228 .remove = sdio_bus_remove, 229 .pm = SDIO_PM_OPS_PTR, 230}; 231 232int sdio_register_bus(void) 233{ 234 return bus_register(&sdio_bus_type); 235} 236 237void sdio_unregister_bus(void) 238{ 239 bus_unregister(&sdio_bus_type); 240} 241 242/** 243 * sdio_register_driver - register a function driver 244 * @drv: SDIO function driver 245 */ 246int sdio_register_driver(struct sdio_driver *drv) 247{ 248 drv->drv.name = drv->name; 249 drv->drv.bus = &sdio_bus_type; 250 return driver_register(&drv->drv); 251} 252EXPORT_SYMBOL_GPL(sdio_register_driver); 253 254/** 255 * sdio_unregister_driver - unregister a function driver 256 * @drv: SDIO function driver 257 */ 258void sdio_unregister_driver(struct sdio_driver *drv) 259{ 260 drv->drv.bus = &sdio_bus_type; 261 driver_unregister(&drv->drv); 262} 263EXPORT_SYMBOL_GPL(sdio_unregister_driver); 264 265static void sdio_release_func(struct device *dev) 266{ 267 struct sdio_func *func = dev_to_sdio_func(dev); 268 269#ifdef CONFIG_MMC_EMBEDDED_SDIO 270 /* 271 * If this device is embedded then we never allocated 272 * cis tables for this func 273 */ 274 if (!func->card->host->embedded_sdio_data.funcs) 275#endif 276 sdio_free_func_cis(func); 277 278 kfree(func->info); 279 280 kfree(func); 281} 282 283/* 284 * Allocate and initialise a new SDIO function structure. 285 */ 286struct sdio_func *sdio_alloc_func(struct mmc_card *card) 287{ 288 struct sdio_func *func; 289 290 func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL); 291 if (!func) 292 return ERR_PTR(-ENOMEM); 293 294 func->card = card; 295 296 device_initialize(&func->dev); 297 298 func->dev.parent = &card->dev; 299 func->dev.bus = &sdio_bus_type; 300 func->dev.release = sdio_release_func; 301 302 return func; 303} 304 305#ifdef CONFIG_ACPI 306static void sdio_acpi_set_handle(struct sdio_func *func) 307{ 308 struct mmc_host *host = func->card->host; 309 u64 addr = (host->slotno << 16) | func->num; 310 311 acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr); 312} 313#else 314static inline void sdio_acpi_set_handle(struct sdio_func *func) {} 315#endif 316 317/* 318 * Register a new SDIO function with the driver model. 319 */ 320int sdio_add_func(struct sdio_func *func) 321{ 322 int ret; 323 324 dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num); 325 326 sdio_acpi_set_handle(func); 327 ret = device_add(&func->dev); 328 if (ret == 0) { 329 sdio_func_set_present(func); 330 dev_pm_domain_attach(&func->dev, false); 331 } 332 333 return ret; 334} 335 336/* 337 * Unregister a SDIO function with the driver model, and 338 * (eventually) free it. 339 * This function can be called through error paths where sdio_add_func() was 340 * never executed (because a failure occurred at an earlier point). 341 */ 342void sdio_remove_func(struct sdio_func *func) 343{ 344 if (!sdio_func_present(func)) 345 return; 346 347 dev_pm_domain_detach(&func->dev, false); 348 device_del(&func->dev); 349 put_device(&func->dev); 350} 351 352