xref: /linux/drivers/mmc/core/sdio_bus.c (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732) 
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 #include <linux/of.h>
26 
27 #include "core.h"
28 #include "sdio_cis.h"
29 #include "sdio_bus.h"
30 
31 #define to_sdio_driver(d)	container_of(d, struct sdio_driver, drv)
32 
33 /* show configuration fields */
34 #define sdio_config_attr(field, format_string)				\
35 static ssize_t								\
36 field##_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 }									\
43 static DEVICE_ATTR_RO(field)
44 
45 sdio_config_attr(class, "0x%02x\n");
46 sdio_config_attr(vendor, "0x%04x\n");
47 sdio_config_attr(device, "0x%04x\n");
48 
49 static 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 }
56 static DEVICE_ATTR_RO(modalias);
57 
58 static 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 };
65 ATTRIBUTE_GROUPS(sdio_dev);
66 
67 static 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 
79 static 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 
97 static 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 
108 static int
109 sdio_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 
129 static 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 	ret = dev_pm_domain_attach(dev, false);
141 	if (ret == -EPROBE_DEFER)
142 		return ret;
143 
144 	/* Unbound SDIO functions are always suspended.
145 	 * During probe, the function is set active and the usage count
146 	 * is incremented.  If the driver supports runtime PM,
147 	 * it should call pm_runtime_put_noidle() in its probe routine and
148 	 * pm_runtime_get_noresume() in its remove routine.
149 	 */
150 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
151 		ret = pm_runtime_get_sync(dev);
152 		if (ret < 0)
153 			goto disable_runtimepm;
154 	}
155 
156 	/* Set the default block size so the driver is sure it's something
157 	 * sensible. */
158 	sdio_claim_host(func);
159 	ret = sdio_set_block_size(func, 0);
160 	sdio_release_host(func);
161 	if (ret)
162 		goto disable_runtimepm;
163 
164 	ret = drv->probe(func, id);
165 	if (ret)
166 		goto disable_runtimepm;
167 
168 	return 0;
169 
170 disable_runtimepm:
171 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
172 		pm_runtime_put_noidle(dev);
173 	dev_pm_domain_detach(dev, false);
174 	return ret;
175 }
176 
177 static int sdio_bus_remove(struct device *dev)
178 {
179 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
180 	struct sdio_func *func = dev_to_sdio_func(dev);
181 	int ret = 0;
182 
183 	/* Make sure card is powered before invoking ->remove() */
184 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
185 		pm_runtime_get_sync(dev);
186 
187 	drv->remove(func);
188 
189 	if (func->irq_handler) {
190 		pr_warn("WARNING: driver %s did not remove its interrupt handler!\n",
191 			drv->name);
192 		sdio_claim_host(func);
193 		sdio_release_irq(func);
194 		sdio_release_host(func);
195 	}
196 
197 	/* First, undo the increment made directly above */
198 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
199 		pm_runtime_put_noidle(dev);
200 
201 	/* Then undo the runtime PM settings in sdio_bus_probe() */
202 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
203 		pm_runtime_put_sync(dev);
204 
205 	dev_pm_domain_detach(dev, false);
206 
207 	return ret;
208 }
209 
210 static const struct dev_pm_ops sdio_bus_pm_ops = {
211 	SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume)
212 	SET_RUNTIME_PM_OPS(
213 		pm_generic_runtime_suspend,
214 		pm_generic_runtime_resume,
215 		NULL
216 	)
217 };
218 
219 static struct bus_type sdio_bus_type = {
220 	.name		= "sdio",
221 	.dev_groups	= sdio_dev_groups,
222 	.match		= sdio_bus_match,
223 	.uevent		= sdio_bus_uevent,
224 	.probe		= sdio_bus_probe,
225 	.remove		= sdio_bus_remove,
226 	.pm		= &sdio_bus_pm_ops,
227 };
228 
229 int sdio_register_bus(void)
230 {
231 	return bus_register(&sdio_bus_type);
232 }
233 
234 void sdio_unregister_bus(void)
235 {
236 	bus_unregister(&sdio_bus_type);
237 }
238 
239 /**
240  *	sdio_register_driver - register a function driver
241  *	@drv: SDIO function driver
242  */
243 int sdio_register_driver(struct sdio_driver *drv)
244 {
245 	drv->drv.name = drv->name;
246 	drv->drv.bus = &sdio_bus_type;
247 	return driver_register(&drv->drv);
248 }
249 EXPORT_SYMBOL_GPL(sdio_register_driver);
250 
251 /**
252  *	sdio_unregister_driver - unregister a function driver
253  *	@drv: SDIO function driver
254  */
255 void sdio_unregister_driver(struct sdio_driver *drv)
256 {
257 	drv->drv.bus = &sdio_bus_type;
258 	driver_unregister(&drv->drv);
259 }
260 EXPORT_SYMBOL_GPL(sdio_unregister_driver);
261 
262 static void sdio_release_func(struct device *dev)
263 {
264 	struct sdio_func *func = dev_to_sdio_func(dev);
265 
266 	sdio_free_func_cis(func);
267 
268 	kfree(func->info);
269 
270 	kfree(func);
271 }
272 
273 /*
274  * Allocate and initialise a new SDIO function structure.
275  */
276 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
277 {
278 	struct sdio_func *func;
279 
280 	func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
281 	if (!func)
282 		return ERR_PTR(-ENOMEM);
283 
284 	func->card = card;
285 
286 	device_initialize(&func->dev);
287 
288 	func->dev.parent = &card->dev;
289 	func->dev.bus = &sdio_bus_type;
290 	func->dev.release = sdio_release_func;
291 
292 	return func;
293 }
294 
295 #ifdef CONFIG_ACPI
296 static void sdio_acpi_set_handle(struct sdio_func *func)
297 {
298 	struct mmc_host *host = func->card->host;
299 	u64 addr = ((u64)host->slotno << 16) | func->num;
300 
301 	acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
302 }
303 #else
304 static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
305 #endif
306 
307 static void sdio_set_of_node(struct sdio_func *func)
308 {
309 	struct mmc_host *host = func->card->host;
310 
311 	func->dev.of_node = mmc_of_find_child_device(host, func->num);
312 }
313 
314 /*
315  * Register a new SDIO function with the driver model.
316  */
317 int sdio_add_func(struct sdio_func *func)
318 {
319 	int ret;
320 
321 	dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
322 
323 	sdio_set_of_node(func);
324 	sdio_acpi_set_handle(func);
325 	ret = device_add(&func->dev);
326 	if (ret == 0)
327 		sdio_func_set_present(func);
328 
329 	return ret;
330 }
331 
332 /*
333  * Unregister a SDIO function with the driver model, and
334  * (eventually) free it.
335  * This function can be called through error paths where sdio_add_func() was
336  * never executed (because a failure occurred at an earlier point).
337  */
338 void sdio_remove_func(struct sdio_func *func)
339 {
340 	if (!sdio_func_present(func))
341 		return;
342 
343 	device_del(&func->dev);
344 	of_node_put(func->dev.of_node);
345 	put_device(&func->dev);
346 }
347 
348