xref: /linux/drivers/mmc/core/sdio_bus.c (revision ca220141fa8ebae09765a242076b2b77338106b0) 
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  linux/drivers/mmc/core/sdio_bus.c
4  *
5  *  Copyright 2007 Pierre Ossman
6  *
7  * SDIO function driver model
8  */
9 
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/export.h>
13 #include <linux/slab.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/pm_domain.h>
16 #include <linux/acpi.h>
17 #include <linux/sysfs.h>
18 
19 #include <linux/mmc/card.h>
20 #include <linux/mmc/host.h>
21 #include <linux/mmc/sdio_func.h>
22 #include <linux/of.h>
23 
24 #include "core.h"
25 #include "card.h"
26 #include "sdio_cis.h"
27 #include "sdio_bus.h"
28 
29 #define to_sdio_driver(d)	container_of_const(d, struct sdio_driver, drv)
30 
31 /* show configuration fields */
32 #define sdio_config_attr(field, format_string, args...)			\
33 static ssize_t								\
34 field##_show(struct device *dev, struct device_attribute *attr, char *buf)				\
35 {									\
36 	struct sdio_func *func;						\
37 									\
38 	func = dev_to_sdio_func (dev);					\
39 	return sysfs_emit(buf, format_string, args);			\
40 }									\
41 static DEVICE_ATTR_RO(field)
42 
43 sdio_config_attr(class, "0x%02x\n", func->class);
44 sdio_config_attr(vendor, "0x%04x\n", func->vendor);
45 sdio_config_attr(device, "0x%04x\n", func->device);
46 sdio_config_attr(revision, "%u.%u\n", func->major_rev, func->minor_rev);
47 sdio_config_attr(modalias, "sdio:c%02Xv%04Xd%04X\n", func->class, func->vendor, func->device);
48 
49 #define sdio_info_attr(num)									\
50 static ssize_t info##num##_show(struct device *dev, struct device_attribute *attr, char *buf)	\
51 {												\
52 	struct sdio_func *func = dev_to_sdio_func(dev);						\
53 												\
54 	if (num > func->num_info)								\
55 		return -ENODATA;								\
56 	if (!func->info[num - 1][0])								\
57 		return 0;									\
58 	return sysfs_emit(buf, "%s\n", func->info[num - 1]);					\
59 }												\
60 static DEVICE_ATTR_RO(info##num)
61 
62 sdio_info_attr(1);
63 sdio_info_attr(2);
64 sdio_info_attr(3);
65 sdio_info_attr(4);
66 
67 static struct attribute *sdio_dev_attrs[] = {
68 	&dev_attr_class.attr,
69 	&dev_attr_vendor.attr,
70 	&dev_attr_device.attr,
71 	&dev_attr_revision.attr,
72 	&dev_attr_info1.attr,
73 	&dev_attr_info2.attr,
74 	&dev_attr_info3.attr,
75 	&dev_attr_info4.attr,
76 	&dev_attr_modalias.attr,
77 	NULL,
78 };
79 ATTRIBUTE_GROUPS(sdio_dev);
80 
81 static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
82 	const struct sdio_device_id *id)
83 {
84 	if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
85 		return NULL;
86 	if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
87 		return NULL;
88 	if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
89 		return NULL;
90 	return id;
91 }
92 
93 static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
94 	const struct sdio_driver *sdrv)
95 {
96 	const struct sdio_device_id *ids;
97 
98 	ids = sdrv->id_table;
99 
100 	if (ids) {
101 		while (ids->class || ids->vendor || ids->device) {
102 			if (sdio_match_one(func, ids))
103 				return ids;
104 			ids++;
105 		}
106 	}
107 
108 	return NULL;
109 }
110 
111 static int sdio_bus_match(struct device *dev, const struct device_driver *drv)
112 {
113 	struct sdio_func *func = dev_to_sdio_func(dev);
114 	const struct sdio_driver *sdrv = to_sdio_driver(drv);
115 
116 	if (sdio_match_device(func, sdrv))
117 		return 1;
118 
119 	return 0;
120 }
121 
122 static int
123 sdio_bus_uevent(const struct device *dev, struct kobj_uevent_env *env)
124 {
125 	const struct sdio_func *func = dev_to_sdio_func(dev);
126 	unsigned int i;
127 
128 	if (add_uevent_var(env,
129 			"SDIO_CLASS=%02X", func->class))
130 		return -ENOMEM;
131 
132 	if (add_uevent_var(env,
133 			"SDIO_ID=%04X:%04X", func->vendor, func->device))
134 		return -ENOMEM;
135 
136 	if (add_uevent_var(env,
137 			"SDIO_REVISION=%u.%u", func->major_rev, func->minor_rev))
138 		return -ENOMEM;
139 
140 	for (i = 0; i < func->num_info; i++) {
141 		if (add_uevent_var(env, "SDIO_INFO%u=%s", i+1, func->info[i]))
142 			return -ENOMEM;
143 	}
144 
145 	if (add_uevent_var(env,
146 			"MODALIAS=sdio:c%02Xv%04Xd%04X",
147 			func->class, func->vendor, func->device))
148 		return -ENOMEM;
149 
150 	return 0;
151 }
152 
153 static int sdio_bus_probe(struct device *dev)
154 {
155 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
156 	struct sdio_func *func = dev_to_sdio_func(dev);
157 	const struct sdio_device_id *id;
158 	int ret;
159 
160 	id = sdio_match_device(func, drv);
161 	if (!id)
162 		return -ENODEV;
163 
164 	ret = dev_pm_domain_attach(dev, 0);
165 	if (ret)
166 		return ret;
167 
168 	atomic_inc(&func->card->sdio_funcs_probed);
169 
170 	/* Unbound SDIO functions are always suspended.
171 	 * During probe, the function is set active and the usage count
172 	 * is incremented.  If the driver supports runtime PM,
173 	 * it should call pm_runtime_put_noidle() in its probe routine and
174 	 * pm_runtime_get_noresume() in its remove routine.
175 	 */
176 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
177 		ret = pm_runtime_get_sync(dev);
178 		if (ret < 0)
179 			goto disable_runtimepm;
180 	}
181 
182 	/* Set the default block size so the driver is sure it's something
183 	 * sensible. */
184 	sdio_claim_host(func);
185 	if (mmc_card_removed(func->card))
186 		ret = -ENOMEDIUM;
187 	else
188 		ret = sdio_set_block_size(func, 0);
189 	sdio_release_host(func);
190 	if (ret)
191 		goto disable_runtimepm;
192 
193 	ret = drv->probe(func, id);
194 	if (ret)
195 		goto disable_runtimepm;
196 
197 	return 0;
198 
199 disable_runtimepm:
200 	atomic_dec(&func->card->sdio_funcs_probed);
201 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
202 		pm_runtime_put_noidle(dev);
203 	return ret;
204 }
205 
206 static void sdio_bus_remove(struct device *dev)
207 {
208 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
209 	struct sdio_func *func = dev_to_sdio_func(dev);
210 
211 	/* Make sure card is powered before invoking ->remove() */
212 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
213 		pm_runtime_get_sync(dev);
214 
215 	drv->remove(func);
216 	atomic_dec(&func->card->sdio_funcs_probed);
217 
218 	if (func->irq_handler) {
219 		pr_warn("WARNING: driver %s did not remove its interrupt handler!\n",
220 			drv->name);
221 		sdio_claim_host(func);
222 		sdio_release_irq(func);
223 		sdio_release_host(func);
224 	}
225 
226 	/* First, undo the increment made directly above */
227 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
228 		pm_runtime_put_noidle(dev);
229 
230 	/* Then undo the runtime PM settings in sdio_bus_probe() */
231 	if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
232 		pm_runtime_put_sync(dev);
233 }
234 
235 static void sdio_bus_shutdown(struct device *dev)
236 {
237 	struct sdio_driver *drv = to_sdio_driver(dev->driver);
238 	struct sdio_func *func = dev_to_sdio_func(dev);
239 
240 	if (dev->driver && drv->shutdown)
241 		drv->shutdown(func);
242 }
243 
244 static const struct dev_pm_ops sdio_bus_pm_ops = {
245 	SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume)
246 	SET_RUNTIME_PM_OPS(
247 		pm_generic_runtime_suspend,
248 		pm_generic_runtime_resume,
249 		NULL
250 	)
251 };
252 
253 static const struct bus_type sdio_bus_type = {
254 	.name		= "sdio",
255 	.dev_groups	= sdio_dev_groups,
256 	.match		= sdio_bus_match,
257 	.uevent		= sdio_bus_uevent,
258 	.probe		= sdio_bus_probe,
259 	.remove		= sdio_bus_remove,
260 	.shutdown	= sdio_bus_shutdown,
261 	.pm		= &sdio_bus_pm_ops,
262 };
263 
264 int sdio_register_bus(void)
265 {
266 	return bus_register(&sdio_bus_type);
267 }
268 
269 void sdio_unregister_bus(void)
270 {
271 	bus_unregister(&sdio_bus_type);
272 }
273 
274 static void sdio_legacy_shutdown(struct sdio_func *func)
275 {
276 	struct device *dev = &func->dev;
277 	struct device_driver *driver = dev->driver;
278 
279 	driver->shutdown(dev);
280 }
281 
282 /**
283  *	__sdio_register_driver - register a function driver
284  *	@drv: SDIO function driver
285  *	@owner: owning module/driver
286  */
287 int __sdio_register_driver(struct sdio_driver *drv, struct module *owner)
288 {
289 	drv->drv.name = drv->name;
290 	drv->drv.bus = &sdio_bus_type;
291 	drv->drv.owner = owner;
292 
293 	/*
294 	 * This driver needs updating. Note that driver_register() warns about
295 	 * this, so we're not adding another warning here.
296 	 */
297 	if (!drv->shutdown && drv->drv.shutdown)
298 		drv->shutdown = sdio_legacy_shutdown;
299 
300 	return driver_register(&drv->drv);
301 }
302 EXPORT_SYMBOL_GPL(__sdio_register_driver);
303 
304 /**
305  *	sdio_unregister_driver - unregister a function driver
306  *	@drv: SDIO function driver
307  */
308 void sdio_unregister_driver(struct sdio_driver *drv)
309 {
310 	drv->drv.bus = &sdio_bus_type;
311 	driver_unregister(&drv->drv);
312 }
313 EXPORT_SYMBOL_GPL(sdio_unregister_driver);
314 
315 static void sdio_release_func(struct device *dev)
316 {
317 	struct sdio_func *func = dev_to_sdio_func(dev);
318 
319 	if (!(func->card->quirks & MMC_QUIRK_NONSTD_SDIO))
320 		sdio_free_func_cis(func);
321 
322 	/*
323 	 * We have now removed the link to the tuples in the
324 	 * card structure, so remove the reference.
325 	 */
326 	put_device(&func->card->dev);
327 
328 	kfree(func->info);
329 	kfree(func->tmpbuf);
330 	kfree(func);
331 }
332 
333 /*
334  * Allocate and initialise a new SDIO function structure.
335  */
336 struct sdio_func *sdio_alloc_func(struct mmc_card *card)
337 {
338 	struct sdio_func *func;
339 
340 	func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
341 	if (!func)
342 		return ERR_PTR(-ENOMEM);
343 
344 	/*
345 	 * allocate buffer separately to make sure it's properly aligned for
346 	 * DMA usage (incl. 64 bit DMA)
347 	 */
348 	func->tmpbuf = kmalloc(4, GFP_KERNEL);
349 	if (!func->tmpbuf) {
350 		kfree(func);
351 		return ERR_PTR(-ENOMEM);
352 	}
353 
354 	func->card = card;
355 
356 	device_initialize(&func->dev);
357 
358 	/*
359 	 * We may link to tuples in the card structure,
360 	 * we need make sure we have a reference to it.
361 	 */
362 	get_device(&func->card->dev);
363 
364 	func->dev.parent = &card->dev;
365 	func->dev.bus = &sdio_bus_type;
366 	func->dev.release = sdio_release_func;
367 
368 	return func;
369 }
370 
371 #ifdef CONFIG_ACPI
372 static void sdio_acpi_set_handle(struct sdio_func *func)
373 {
374 	struct mmc_host *host = func->card->host;
375 	u64 addr = ((u64)host->slotno << 16) | func->num;
376 
377 	acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
378 }
379 #else
380 static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
381 #endif
382 
383 static void sdio_set_of_node(struct sdio_func *func)
384 {
385 	struct mmc_host *host = func->card->host;
386 
387 	func->dev.of_node = mmc_of_find_child_device(host, func->num);
388 }
389 
390 /*
391  * Register a new SDIO function with the driver model.
392  */
393 int sdio_add_func(struct sdio_func *func)
394 {
395 	int ret;
396 
397 	dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
398 
399 	sdio_set_of_node(func);
400 	sdio_acpi_set_handle(func);
401 	device_enable_async_suspend(&func->dev);
402 	ret = device_add(&func->dev);
403 	if (ret == 0)
404 		sdio_func_set_present(func);
405 
406 	return ret;
407 }
408 
409 /*
410  * Unregister a SDIO function with the driver model, and
411  * (eventually) free it.
412  * This function can be called through error paths where sdio_add_func() was
413  * never executed (because a failure occurred at an earlier point).
414  */
415 void sdio_remove_func(struct sdio_func *func)
416 {
417 	if (sdio_func_present(func))
418 		device_del(&func->dev);
419 
420 	of_node_put(func->dev.of_node);
421 	put_device(&func->dev);
422 }
423 
424