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/slab.h>
17 #include <linux/pm_runtime.h>
19 #include <linux/mmc/card.h>
20 #include <linux/mmc/sdio_func.h>
25 /* show configuration fields */
26 #define sdio_config_attr(field, format_string) \
28 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
30 struct sdio_func *func; \
32 func = dev_to_sdio_func (dev); \
33 return sprintf (buf, format_string, func->field); \
36 sdio_config_attr(class, "0x%02x\n");
37 sdio_config_attr(vendor, "0x%04x\n");
38 sdio_config_attr(device, "0x%04x\n");
40 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
42 struct sdio_func *func = dev_to_sdio_func (dev);
44 return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n",
45 func->class, func->vendor, func->device);
48 static struct device_attribute sdio_dev_attrs[] = {
56 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
57 const struct sdio_device_id *id)
59 if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
61 if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
63 if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
68 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
69 struct sdio_driver *sdrv)
71 const struct sdio_device_id *ids;
76 while (ids->class || ids->vendor || ids->device) {
77 if (sdio_match_one(func, ids))
86 static int sdio_bus_match(struct device *dev, struct device_driver *drv)
88 struct sdio_func *func = dev_to_sdio_func(dev);
89 struct sdio_driver *sdrv = to_sdio_driver(drv);
91 if (sdio_match_device(func, sdrv))
98 sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
100 struct sdio_func *func = dev_to_sdio_func(dev);
102 if (add_uevent_var(env,
103 "SDIO_CLASS=%02X", func->class))
106 if (add_uevent_var(env,
107 "SDIO_ID=%04X:%04X", func->vendor, func->device))
110 if (add_uevent_var(env,
111 "MODALIAS=sdio:c%02Xv%04Xd%04X",
112 func->class, func->vendor, func->device))
118 static int sdio_bus_probe(struct device *dev)
120 struct sdio_driver *drv = to_sdio_driver(dev->driver);
121 struct sdio_func *func = dev_to_sdio_func(dev);
122 const struct sdio_device_id *id;
125 id = sdio_match_device(func, drv);
129 /* Unbound SDIO functions are always suspended.
130 * During probe, the function is set active and the usage count
131 * is incremented. If the driver supports runtime PM,
132 * it should call pm_runtime_put_noidle() in its probe routine and
133 * pm_runtime_get_noresume() in its remove routine.
135 ret = pm_runtime_get_sync(dev);
139 /* Set the default block size so the driver is sure it's something
141 sdio_claim_host(func);
142 ret = sdio_set_block_size(func, 0);
143 sdio_release_host(func);
145 goto disable_runtimepm;
147 ret = drv->probe(func, id);
149 goto disable_runtimepm;
154 pm_runtime_put_noidle(dev);
159 static int sdio_bus_remove(struct device *dev)
161 struct sdio_driver *drv = to_sdio_driver(dev->driver);
162 struct sdio_func *func = dev_to_sdio_func(dev);
165 /* Make sure card is powered before invoking ->remove() */
166 ret = pm_runtime_get_sync(dev);
172 if (func->irq_handler) {
173 printk(KERN_WARNING "WARNING: driver %s did not remove "
174 "its interrupt handler!\n", drv->name);
175 sdio_claim_host(func);
176 sdio_release_irq(func);
177 sdio_release_host(func);
180 /* First, undo the increment made directly above */
181 pm_runtime_put_noidle(dev);
183 /* Then undo the runtime PM settings in sdio_bus_probe() */
184 pm_runtime_put_noidle(dev);
190 #ifdef CONFIG_PM_RUNTIME
192 static int sdio_bus_pm_prepare(struct device *dev)
195 * Resume an SDIO device which was suspended at run time at this
196 * point, in order to allow standard SDIO suspend/resume paths
197 * to keep working as usual.
199 * Ultimately, the SDIO driver itself will decide (in its
200 * suspend handler, or lack thereof) whether the card should be
201 * removed or kept, and if kept, at what power state.
203 * At this point, PM core have increased our use count, so it's
204 * safe to directly resume the device. After system is resumed
205 * again, PM core will drop back its runtime PM use count, and if
206 * needed device will be suspended again.
208 * The end result is guaranteed to be a power state that is
209 * coherent with the device's runtime PM use count.
211 * The return value of pm_runtime_resume is deliberately unchecked
212 * since there is little point in failing system suspend if a
213 * device can't be resumed.
215 pm_runtime_resume(dev);
220 static const struct dev_pm_ops sdio_bus_pm_ops = {
222 pm_generic_runtime_suspend,
223 pm_generic_runtime_resume,
224 pm_generic_runtime_idle
226 .prepare = sdio_bus_pm_prepare,
229 #define SDIO_PM_OPS_PTR (&sdio_bus_pm_ops)
231 #else /* !CONFIG_PM_RUNTIME */
233 #define SDIO_PM_OPS_PTR NULL
235 #endif /* !CONFIG_PM_RUNTIME */
237 static struct bus_type sdio_bus_type = {
239 .dev_attrs = sdio_dev_attrs,
240 .match = sdio_bus_match,
241 .uevent = sdio_bus_uevent,
242 .probe = sdio_bus_probe,
243 .remove = sdio_bus_remove,
244 .pm = SDIO_PM_OPS_PTR,
247 int sdio_register_bus(void)
249 return bus_register(&sdio_bus_type);
252 void sdio_unregister_bus(void)
254 bus_unregister(&sdio_bus_type);
258 * sdio_register_driver - register a function driver
259 * @drv: SDIO function driver
261 int sdio_register_driver(struct sdio_driver *drv)
263 drv->drv.name = drv->name;
264 drv->drv.bus = &sdio_bus_type;
265 return driver_register(&drv->drv);
267 EXPORT_SYMBOL_GPL(sdio_register_driver);
270 * sdio_unregister_driver - unregister a function driver
271 * @drv: SDIO function driver
273 void sdio_unregister_driver(struct sdio_driver *drv)
275 drv->drv.bus = &sdio_bus_type;
276 driver_unregister(&drv->drv);
278 EXPORT_SYMBOL_GPL(sdio_unregister_driver);
280 static void sdio_release_func(struct device *dev)
282 struct sdio_func *func = dev_to_sdio_func(dev);
284 sdio_free_func_cis(func);
293 * Allocate and initialise a new SDIO function structure.
295 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
297 struct sdio_func *func;
299 func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
301 return ERR_PTR(-ENOMEM);
305 device_initialize(&func->dev);
307 func->dev.parent = &card->dev;
308 func->dev.bus = &sdio_bus_type;
309 func->dev.release = sdio_release_func;
315 * Register a new SDIO function with the driver model.
317 int sdio_add_func(struct sdio_func *func)
321 dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
323 ret = device_add(&func->dev);
325 sdio_func_set_present(func);
331 * Unregister a SDIO function with the driver model, and
332 * (eventually) free it.
333 * This function can be called through error paths where sdio_add_func() was
334 * never executed (because a failure occurred at an earlier point).
336 void sdio_remove_func(struct sdio_func *func)
338 if (!sdio_func_present(func))
341 device_del(&func->dev);
342 put_device(&func->dev);