2 * linux/drivers/mmc/core/sdio_bus.c
4 * Copyright 2007 Pierre Ossman
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.
11 * SDIO function driver model
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>
21 #include <linux/mmc/card.h>
22 #include <linux/mmc/host.h>
23 #include <linux/mmc/sdio_func.h>
28 /* show configuration fields */
29 #define sdio_config_attr(field, format_string) \
31 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
33 struct sdio_func *func; \
35 func = dev_to_sdio_func (dev); \
36 return sprintf (buf, format_string, func->field); \
38 static DEVICE_ATTR_RO(field)
40 sdio_config_attr(class, "0x%02x\n");
41 sdio_config_attr(vendor, "0x%04x\n");
42 sdio_config_attr(device, "0x%04x\n");
44 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
46 struct sdio_func *func = dev_to_sdio_func (dev);
48 return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n",
49 func->class, func->vendor, func->device);
51 static DEVICE_ATTR_RO(modalias);
53 static struct attribute *sdio_dev_attrs[] = {
55 &dev_attr_vendor.attr,
56 &dev_attr_device.attr,
57 &dev_attr_modalias.attr,
60 ATTRIBUTE_GROUPS(sdio_dev);
62 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
63 const struct sdio_device_id *id)
65 if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
67 if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
69 if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
74 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
75 struct sdio_driver *sdrv)
77 const struct sdio_device_id *ids;
82 while (ids->class || ids->vendor || ids->device) {
83 if (sdio_match_one(func, ids))
92 static int sdio_bus_match(struct device *dev, struct device_driver *drv)
94 struct sdio_func *func = dev_to_sdio_func(dev);
95 struct sdio_driver *sdrv = to_sdio_driver(drv);
97 if (sdio_match_device(func, sdrv))
104 sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
106 struct sdio_func *func = dev_to_sdio_func(dev);
108 if (add_uevent_var(env,
109 "SDIO_CLASS=%02X", func->class))
112 if (add_uevent_var(env,
113 "SDIO_ID=%04X:%04X", func->vendor, func->device))
116 if (add_uevent_var(env,
117 "MODALIAS=sdio:c%02Xv%04Xd%04X",
118 func->class, func->vendor, func->device))
124 static int sdio_bus_probe(struct device *dev)
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;
131 id = sdio_match_device(func, drv);
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.
141 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
142 ret = pm_runtime_get_sync(dev);
144 goto disable_runtimepm;
147 /* Set the default block size so the driver is sure it's something
149 sdio_claim_host(func);
150 ret = sdio_set_block_size(func, 0);
151 sdio_release_host(func);
153 goto disable_runtimepm;
155 ret = drv->probe(func, id);
157 goto disable_runtimepm;
162 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
163 pm_runtime_put_noidle(dev);
167 static int sdio_bus_remove(struct device *dev)
169 struct sdio_driver *drv = to_sdio_driver(dev->driver);
170 struct sdio_func *func = dev_to_sdio_func(dev);
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);
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);
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);
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);
200 static const struct dev_pm_ops sdio_bus_pm_ops = {
201 SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume)
203 pm_generic_runtime_suspend,
204 pm_generic_runtime_resume,
209 #define SDIO_PM_OPS_PTR (&sdio_bus_pm_ops)
211 #else /* !CONFIG_PM */
213 #define SDIO_PM_OPS_PTR NULL
215 #endif /* !CONFIG_PM */
217 static struct bus_type sdio_bus_type = {
219 .dev_groups = sdio_dev_groups,
220 .match = sdio_bus_match,
221 .uevent = sdio_bus_uevent,
222 .probe = sdio_bus_probe,
223 .remove = sdio_bus_remove,
224 .pm = SDIO_PM_OPS_PTR,
227 int sdio_register_bus(void)
229 return bus_register(&sdio_bus_type);
232 void sdio_unregister_bus(void)
234 bus_unregister(&sdio_bus_type);
238 * sdio_register_driver - register a function driver
239 * @drv: SDIO function driver
241 int sdio_register_driver(struct sdio_driver *drv)
243 drv->drv.name = drv->name;
244 drv->drv.bus = &sdio_bus_type;
245 return driver_register(&drv->drv);
247 EXPORT_SYMBOL_GPL(sdio_register_driver);
250 * sdio_unregister_driver - unregister a function driver
251 * @drv: SDIO function driver
253 void sdio_unregister_driver(struct sdio_driver *drv)
255 drv->drv.bus = &sdio_bus_type;
256 driver_unregister(&drv->drv);
258 EXPORT_SYMBOL_GPL(sdio_unregister_driver);
260 static void sdio_release_func(struct device *dev)
262 struct sdio_func *func = dev_to_sdio_func(dev);
264 sdio_free_func_cis(func);
272 * Allocate and initialise a new SDIO function structure.
274 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
276 struct sdio_func *func;
278 func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
280 return ERR_PTR(-ENOMEM);
284 device_initialize(&func->dev);
286 func->dev.parent = &card->dev;
287 func->dev.bus = &sdio_bus_type;
288 func->dev.release = sdio_release_func;
294 static void sdio_acpi_set_handle(struct sdio_func *func)
296 struct mmc_host *host = func->card->host;
297 u64 addr = (host->slotno << 16) | func->num;
299 acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
302 static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
306 * Register a new SDIO function with the driver model.
308 int sdio_add_func(struct sdio_func *func)
312 dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
314 sdio_acpi_set_handle(func);
315 ret = device_add(&func->dev);
317 sdio_func_set_present(func);
318 acpi_dev_pm_attach(&func->dev, false);
325 * Unregister a SDIO function with the driver model, and
326 * (eventually) free it.
327 * This function can be called through error paths where sdio_add_func() was
328 * never executed (because a failure occurred at an earlier point).
330 void sdio_remove_func(struct sdio_func *func)
332 if (!sdio_func_present(func))
335 acpi_dev_pm_detach(&func->dev, false);
336 device_del(&func->dev);
337 put_device(&func->dev);