xref: /openbmc/linux/drivers/mmc/core/sdio_bus.c (revision 81d67439)
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/slab.h>
17 #include <linux/pm_runtime.h>
18 
19 #include <linux/mmc/card.h>
20 #include <linux/mmc/host.h>
21 #include <linux/mmc/sdio_func.h>
22 
23 #include "sdio_cis.h"
24 #include "sdio_bus.h"
25 
26 /* show configuration fields */
27 #define sdio_config_attr(field, format_string)				\
28 static ssize_t								\
29 field##_show(struct device *dev, struct device_attribute *attr, char *buf)				\
30 {									\
31 	struct sdio_func *func;						\
32 									\
33 	func = dev_to_sdio_func (dev);					\
34 	return sprintf (buf, format_string, func->field);		\
35 }
36 
37 sdio_config_attr(class, "0x%02x\n");
38 sdio_config_attr(vendor, "0x%04x\n");
39 sdio_config_attr(device, "0x%04x\n");
40 
41 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
42 {
43 	struct sdio_func *func = dev_to_sdio_func (dev);
44 
45 	return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n",
46 			func->class, func->vendor, func->device);
47 }
48 
49 static struct device_attribute sdio_dev_attrs[] = {
50 	__ATTR_RO(class),
51 	__ATTR_RO(vendor),
52 	__ATTR_RO(device),
53 	__ATTR_RO(modalias),
54 	__ATTR_NULL,
55 };
56 
57 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
58 	const struct sdio_device_id *id)
59 {
60 	if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
61 		return NULL;
62 	if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
63 		return NULL;
64 	if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
65 		return NULL;
66 	return id;
67 }
68 
69 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
70 	struct sdio_driver *sdrv)
71 {
72 	const struct sdio_device_id *ids;
73 
74 	ids = sdrv->id_table;
75 
76 	if (ids) {
77 		while (ids->class || ids->vendor || ids->device) {
78 			if (sdio_match_one(func, ids))
79 				return ids;
80 			ids++;
81 		}
82 	}
83 
84 	return NULL;
85 }
86 
87 static int sdio_bus_match(struct device *dev, struct device_driver *drv)
88 {
89 	struct sdio_func *func = dev_to_sdio_func(dev);
90 	struct sdio_driver *sdrv = to_sdio_driver(drv);
91 
92 	if (sdio_match_device(func, sdrv))
93 		return 1;
94 
95 	return 0;
96 }
97 
98 static int
99 sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
100 {
101 	struct sdio_func *func = dev_to_sdio_func(dev);
102 
103 	if (add_uevent_var(env,
104 			"SDIO_CLASS=%02X", func->class))
105 		return -ENOMEM;
106 
107 	if (add_uevent_var(env,
108 			"SDIO_ID=%04X:%04X", func->vendor, func->device))
109 		return -ENOMEM;
110 
111 	if (add_uevent_var(env,
112 			"MODALIAS=sdio:c%02Xv%04Xd%04X",
113 			func->class, func->vendor, func->device))
114 		return -ENOMEM;
115 
116 	return 0;
117 }
118 
119 static int sdio_bus_probe(struct device *dev)
120 {
121 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
122 	struct sdio_func *func = dev_to_sdio_func(dev);
123 	const struct sdio_device_id *id;
124 	int ret;
125 
126 	id = sdio_match_device(func, drv);
127 	if (!id)
128 		return -ENODEV;
129 
130 	/* Unbound SDIO functions are always suspended.
131 	 * During probe, the function is set active and the usage count
132 	 * is incremented.  If the driver supports runtime PM,
133 	 * it should call pm_runtime_put_noidle() in its probe routine and
134 	 * pm_runtime_get_noresume() in its remove routine.
135 	 */
136 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
137 		ret = pm_runtime_get_sync(dev);
138 		if (ret < 0)
139 			goto out;
140 	}
141 
142 	/* Set the default block size so the driver is sure it's something
143 	 * sensible. */
144 	sdio_claim_host(func);
145 	ret = sdio_set_block_size(func, 0);
146 	sdio_release_host(func);
147 	if (ret)
148 		goto disable_runtimepm;
149 
150 	ret = drv->probe(func, id);
151 	if (ret)
152 		goto disable_runtimepm;
153 
154 	return 0;
155 
156 disable_runtimepm:
157 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
158 		pm_runtime_put_noidle(dev);
159 out:
160 	return ret;
161 }
162 
163 static int sdio_bus_remove(struct device *dev)
164 {
165 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
166 	struct sdio_func *func = dev_to_sdio_func(dev);
167 	int ret = 0;
168 
169 	/* Make sure card is powered before invoking ->remove() */
170 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
171 		pm_runtime_get_sync(dev);
172 
173 	drv->remove(func);
174 
175 	if (func->irq_handler) {
176 		printk(KERN_WARNING "WARNING: driver %s did not remove "
177 			"its interrupt handler!\n", drv->name);
178 		sdio_claim_host(func);
179 		sdio_release_irq(func);
180 		sdio_release_host(func);
181 	}
182 
183 	/* First, undo the increment made directly above */
184 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
185 		pm_runtime_put_noidle(dev);
186 
187 	/* Then undo the runtime PM settings in sdio_bus_probe() */
188 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
189 		pm_runtime_put_sync(dev);
190 
191 	return ret;
192 }
193 
194 #ifdef CONFIG_PM_RUNTIME
195 
196 static const struct dev_pm_ops sdio_bus_pm_ops = {
197 	SET_RUNTIME_PM_OPS(
198 		pm_generic_runtime_suspend,
199 		pm_generic_runtime_resume,
200 		pm_generic_runtime_idle
201 	)
202 };
203 
204 #define SDIO_PM_OPS_PTR	(&sdio_bus_pm_ops)
205 
206 #else /* !CONFIG_PM_RUNTIME */
207 
208 #define SDIO_PM_OPS_PTR	NULL
209 
210 #endif /* !CONFIG_PM_RUNTIME */
211 
212 static struct bus_type sdio_bus_type = {
213 	.name		= "sdio",
214 	.dev_attrs	= sdio_dev_attrs,
215 	.match		= sdio_bus_match,
216 	.uevent		= sdio_bus_uevent,
217 	.probe		= sdio_bus_probe,
218 	.remove		= sdio_bus_remove,
219 	.pm		= SDIO_PM_OPS_PTR,
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 	if (func->info)
262 		kfree(func->info);
263 
264 	kfree(func);
265 }
266 
267 /*
268  * Allocate and initialise a new SDIO function structure.
269  */
270 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
271 {
272 	struct sdio_func *func;
273 
274 	func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
275 	if (!func)
276 		return ERR_PTR(-ENOMEM);
277 
278 	func->card = card;
279 
280 	device_initialize(&func->dev);
281 
282 	func->dev.parent = &card->dev;
283 	func->dev.bus = &sdio_bus_type;
284 	func->dev.release = sdio_release_func;
285 
286 	return func;
287 }
288 
289 /*
290  * Register a new SDIO function with the driver model.
291  */
292 int sdio_add_func(struct sdio_func *func)
293 {
294 	int ret;
295 
296 	dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
297 
298 	ret = device_add(&func->dev);
299 	if (ret == 0)
300 		sdio_func_set_present(func);
301 
302 	return ret;
303 }
304 
305 /*
306  * Unregister a SDIO function with the driver model, and
307  * (eventually) free it.
308  * This function can be called through error paths where sdio_add_func() was
309  * never executed (because a failure occurred at an earlier point).
310  */
311 void sdio_remove_func(struct sdio_func *func)
312 {
313 	if (!sdio_func_present(func))
314 		return;
315 
316 	device_del(&func->dev);
317 	put_device(&func->dev);
318 }
319 
320