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/acpi.h> 20 21 #include <linux/mmc/card.h> 22 #include <linux/mmc/host.h> 23 #include <linux/mmc/sdio_func.h> 24 25 #include "sdio_cis.h" 26 #include "sdio_bus.h" 27 28 /* show configuration fields */ 29 #define sdio_config_attr(field, format_string) \ 30 static ssize_t \ 31 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \ 32 { \ 33 struct sdio_func *func; \ 34 \ 35 func = dev_to_sdio_func (dev); \ 36 return sprintf (buf, format_string, func->field); \ 37 } \ 38 static DEVICE_ATTR_RO(field) 39 40 sdio_config_attr(class, "0x%02x\n"); 41 sdio_config_attr(vendor, "0x%04x\n"); 42 sdio_config_attr(device, "0x%04x\n"); 43 44 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf) 45 { 46 struct sdio_func *func = dev_to_sdio_func (dev); 47 48 return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n", 49 func->class, func->vendor, func->device); 50 } 51 static DEVICE_ATTR_RO(modalias); 52 53 static struct attribute *sdio_dev_attrs[] = { 54 &dev_attr_class.attr, 55 &dev_attr_vendor.attr, 56 &dev_attr_device.attr, 57 &dev_attr_modalias.attr, 58 NULL, 59 }; 60 ATTRIBUTE_GROUPS(sdio_dev); 61 62 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func, 63 const struct sdio_device_id *id) 64 { 65 if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class) 66 return NULL; 67 if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor) 68 return NULL; 69 if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device) 70 return NULL; 71 return id; 72 } 73 74 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func, 75 struct sdio_driver *sdrv) 76 { 77 const struct sdio_device_id *ids; 78 79 ids = sdrv->id_table; 80 81 if (ids) { 82 while (ids->class || ids->vendor || ids->device) { 83 if (sdio_match_one(func, ids)) 84 return ids; 85 ids++; 86 } 87 } 88 89 return NULL; 90 } 91 92 static int sdio_bus_match(struct device *dev, struct device_driver *drv) 93 { 94 struct sdio_func *func = dev_to_sdio_func(dev); 95 struct sdio_driver *sdrv = to_sdio_driver(drv); 96 97 if (sdio_match_device(func, sdrv)) 98 return 1; 99 100 return 0; 101 } 102 103 static int 104 sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env) 105 { 106 struct sdio_func *func = dev_to_sdio_func(dev); 107 108 if (add_uevent_var(env, 109 "SDIO_CLASS=%02X", func->class)) 110 return -ENOMEM; 111 112 if (add_uevent_var(env, 113 "SDIO_ID=%04X:%04X", func->vendor, func->device)) 114 return -ENOMEM; 115 116 if (add_uevent_var(env, 117 "MODALIAS=sdio:c%02Xv%04Xd%04X", 118 func->class, func->vendor, func->device)) 119 return -ENOMEM; 120 121 return 0; 122 } 123 124 static int sdio_bus_probe(struct device *dev) 125 { 126 struct sdio_driver *drv = to_sdio_driver(dev->driver); 127 struct sdio_func *func = dev_to_sdio_func(dev); 128 const struct sdio_device_id *id; 129 int ret; 130 131 id = sdio_match_device(func, drv); 132 if (!id) 133 return -ENODEV; 134 135 /* Unbound SDIO functions are always suspended. 136 * During probe, the function is set active and the usage count 137 * is incremented. If the driver supports runtime PM, 138 * it should call pm_runtime_put_noidle() in its probe routine and 139 * pm_runtime_get_noresume() in its remove routine. 140 */ 141 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) { 142 ret = pm_runtime_get_sync(dev); 143 if (ret < 0) 144 goto disable_runtimepm; 145 } 146 147 /* Set the default block size so the driver is sure it's something 148 * sensible. */ 149 sdio_claim_host(func); 150 ret = sdio_set_block_size(func, 0); 151 sdio_release_host(func); 152 if (ret) 153 goto disable_runtimepm; 154 155 ret = drv->probe(func, id); 156 if (ret) 157 goto disable_runtimepm; 158 159 return 0; 160 161 disable_runtimepm: 162 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) 163 pm_runtime_put_noidle(dev); 164 return ret; 165 } 166 167 static int sdio_bus_remove(struct device *dev) 168 { 169 struct sdio_driver *drv = to_sdio_driver(dev->driver); 170 struct sdio_func *func = dev_to_sdio_func(dev); 171 int ret = 0; 172 173 /* Make sure card is powered before invoking ->remove() */ 174 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) 175 pm_runtime_get_sync(dev); 176 177 drv->remove(func); 178 179 if (func->irq_handler) { 180 pr_warning("WARNING: driver %s did not remove " 181 "its interrupt handler!\n", drv->name); 182 sdio_claim_host(func); 183 sdio_release_irq(func); 184 sdio_release_host(func); 185 } 186 187 /* First, undo the increment made directly above */ 188 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) 189 pm_runtime_put_noidle(dev); 190 191 /* Then undo the runtime PM settings in sdio_bus_probe() */ 192 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) 193 pm_runtime_put_sync(dev); 194 195 return ret; 196 } 197 198 #ifdef CONFIG_PM 199 200 #ifdef CONFIG_PM_SLEEP 201 static int pm_no_operation(struct device *dev) 202 { 203 /* 204 * Prevent the PM core from calling SDIO device drivers' suspend 205 * callback routines, which it is not supposed to do, by using this 206 * empty function as the bus type suspend callaback for SDIO. 207 */ 208 return 0; 209 } 210 #endif 211 212 static const struct dev_pm_ops sdio_bus_pm_ops = { 213 SET_SYSTEM_SLEEP_PM_OPS(pm_no_operation, pm_no_operation) 214 SET_RUNTIME_PM_OPS( 215 pm_generic_runtime_suspend, 216 pm_generic_runtime_resume, 217 NULL 218 ) 219 }; 220 221 #define SDIO_PM_OPS_PTR (&sdio_bus_pm_ops) 222 223 #else /* !CONFIG_PM */ 224 225 #define SDIO_PM_OPS_PTR NULL 226 227 #endif /* !CONFIG_PM */ 228 229 static struct bus_type sdio_bus_type = { 230 .name = "sdio", 231 .dev_groups = sdio_dev_groups, 232 .match = sdio_bus_match, 233 .uevent = sdio_bus_uevent, 234 .probe = sdio_bus_probe, 235 .remove = sdio_bus_remove, 236 .pm = SDIO_PM_OPS_PTR, 237 }; 238 239 int sdio_register_bus(void) 240 { 241 return bus_register(&sdio_bus_type); 242 } 243 244 void sdio_unregister_bus(void) 245 { 246 bus_unregister(&sdio_bus_type); 247 } 248 249 /** 250 * sdio_register_driver - register a function driver 251 * @drv: SDIO function driver 252 */ 253 int sdio_register_driver(struct sdio_driver *drv) 254 { 255 drv->drv.name = drv->name; 256 drv->drv.bus = &sdio_bus_type; 257 return driver_register(&drv->drv); 258 } 259 EXPORT_SYMBOL_GPL(sdio_register_driver); 260 261 /** 262 * sdio_unregister_driver - unregister a function driver 263 * @drv: SDIO function driver 264 */ 265 void sdio_unregister_driver(struct sdio_driver *drv) 266 { 267 drv->drv.bus = &sdio_bus_type; 268 driver_unregister(&drv->drv); 269 } 270 EXPORT_SYMBOL_GPL(sdio_unregister_driver); 271 272 static void sdio_release_func(struct device *dev) 273 { 274 struct sdio_func *func = dev_to_sdio_func(dev); 275 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 */ 286 struct 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 306 static 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_HANDLE(host->parent), addr); 312 } 313 #else 314 static 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 */ 320 int 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 acpi_dev_pm_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 */ 342 void sdio_remove_func(struct sdio_func *func) 343 { 344 if (!sdio_func_present(func)) 345 return; 346 347 acpi_dev_pm_detach(&func->dev, false); 348 device_del(&func->dev); 349 put_device(&func->dev); 350 } 351 352