xref: /linux/drivers/mmc/core/bus.c (revision 00a6d7b6762c27d441e9ac8faff36384bc0fc180)
1 /*
2  *  linux/drivers/mmc/core/bus.c
3  *
4  *  Copyright (C) 2003 Russell King, All Rights Reserved.
5  *  Copyright (C) 2007 Pierre Ossman
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  *  MMC card bus driver model
12  */
13 
14 #include <linux/export.h>
15 #include <linux/device.h>
16 #include <linux/err.h>
17 #include <linux/slab.h>
18 #include <linux/stat.h>
19 #include <linux/pm_runtime.h>
20 
21 #include <linux/mmc/card.h>
22 #include <linux/mmc/host.h>
23 
24 #include "core.h"
25 #include "sdio_cis.h"
26 #include "bus.h"
27 
28 #define to_mmc_driver(d)	container_of(d, struct mmc_driver, drv)
29 
30 static ssize_t type_show(struct device *dev,
31 	struct device_attribute *attr, char *buf)
32 {
33 	struct mmc_card *card = mmc_dev_to_card(dev);
34 
35 	switch (card->type) {
36 	case MMC_TYPE_MMC:
37 		return sprintf(buf, "MMC\n");
38 	case MMC_TYPE_SD:
39 		return sprintf(buf, "SD\n");
40 	case MMC_TYPE_SDIO:
41 		return sprintf(buf, "SDIO\n");
42 	case MMC_TYPE_SD_COMBO:
43 		return sprintf(buf, "SDcombo\n");
44 	default:
45 		return -EFAULT;
46 	}
47 }
48 static DEVICE_ATTR_RO(type);
49 
50 static struct attribute *mmc_dev_attrs[] = {
51 	&dev_attr_type.attr,
52 	NULL,
53 };
54 ATTRIBUTE_GROUPS(mmc_dev);
55 
56 /*
57  * This currently matches any MMC driver to any MMC card - drivers
58  * themselves make the decision whether to drive this card in their
59  * probe method.
60  */
61 static int mmc_bus_match(struct device *dev, struct device_driver *drv)
62 {
63 	return 1;
64 }
65 
66 static int
67 mmc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
68 {
69 	struct mmc_card *card = mmc_dev_to_card(dev);
70 	const char *type;
71 	int retval = 0;
72 
73 	switch (card->type) {
74 	case MMC_TYPE_MMC:
75 		type = "MMC";
76 		break;
77 	case MMC_TYPE_SD:
78 		type = "SD";
79 		break;
80 	case MMC_TYPE_SDIO:
81 		type = "SDIO";
82 		break;
83 	case MMC_TYPE_SD_COMBO:
84 		type = "SDcombo";
85 		break;
86 	default:
87 		type = NULL;
88 	}
89 
90 	if (type) {
91 		retval = add_uevent_var(env, "MMC_TYPE=%s", type);
92 		if (retval)
93 			return retval;
94 	}
95 
96 	retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
97 	if (retval)
98 		return retval;
99 
100 	/*
101 	 * Request the mmc_block device.  Note: that this is a direct request
102 	 * for the module it carries no information as to what is inserted.
103 	 */
104 	retval = add_uevent_var(env, "MODALIAS=mmc:block");
105 
106 	return retval;
107 }
108 
109 static int mmc_bus_probe(struct device *dev)
110 {
111 	struct mmc_driver *drv = to_mmc_driver(dev->driver);
112 	struct mmc_card *card = mmc_dev_to_card(dev);
113 
114 	return drv->probe(card);
115 }
116 
117 static int mmc_bus_remove(struct device *dev)
118 {
119 	struct mmc_driver *drv = to_mmc_driver(dev->driver);
120 	struct mmc_card *card = mmc_dev_to_card(dev);
121 
122 	drv->remove(card);
123 
124 	return 0;
125 }
126 
127 static void mmc_bus_shutdown(struct device *dev)
128 {
129 	struct mmc_driver *drv = to_mmc_driver(dev->driver);
130 	struct mmc_card *card = mmc_dev_to_card(dev);
131 	struct mmc_host *host = card->host;
132 	int ret;
133 
134 	if (dev->driver && drv->shutdown)
135 		drv->shutdown(card);
136 
137 	if (host->bus_ops->shutdown) {
138 		ret = host->bus_ops->shutdown(host);
139 		if (ret)
140 			pr_warn("%s: error %d during shutdown\n",
141 				mmc_hostname(host), ret);
142 	}
143 }
144 
145 #ifdef CONFIG_PM_SLEEP
146 static int mmc_bus_suspend(struct device *dev)
147 {
148 	struct mmc_driver *drv = to_mmc_driver(dev->driver);
149 	struct mmc_card *card = mmc_dev_to_card(dev);
150 	struct mmc_host *host = card->host;
151 	int ret;
152 
153 	if (dev->driver && drv->suspend) {
154 		ret = drv->suspend(card);
155 		if (ret)
156 			return ret;
157 	}
158 
159 	ret = host->bus_ops->suspend(host);
160 	return ret;
161 }
162 
163 static int mmc_bus_resume(struct device *dev)
164 {
165 	struct mmc_driver *drv = to_mmc_driver(dev->driver);
166 	struct mmc_card *card = mmc_dev_to_card(dev);
167 	struct mmc_host *host = card->host;
168 	int ret;
169 
170 	ret = host->bus_ops->resume(host);
171 	if (ret)
172 		pr_warn("%s: error %d during resume (card was removed?)\n",
173 			mmc_hostname(host), ret);
174 
175 	if (dev->driver && drv->resume)
176 		ret = drv->resume(card);
177 
178 	return ret;
179 }
180 #endif
181 
182 #ifdef CONFIG_PM_RUNTIME
183 
184 static int mmc_runtime_suspend(struct device *dev)
185 {
186 	struct mmc_card *card = mmc_dev_to_card(dev);
187 	struct mmc_host *host = card->host;
188 
189 	return host->bus_ops->runtime_suspend(host);
190 }
191 
192 static int mmc_runtime_resume(struct device *dev)
193 {
194 	struct mmc_card *card = mmc_dev_to_card(dev);
195 	struct mmc_host *host = card->host;
196 
197 	return host->bus_ops->runtime_resume(host);
198 }
199 
200 static int mmc_runtime_idle(struct device *dev)
201 {
202 	return 0;
203 }
204 
205 #endif /* !CONFIG_PM_RUNTIME */
206 
207 static const struct dev_pm_ops mmc_bus_pm_ops = {
208 	SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume,
209 			mmc_runtime_idle)
210 	SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
211 };
212 
213 static struct bus_type mmc_bus_type = {
214 	.name		= "mmc",
215 	.dev_groups	= mmc_dev_groups,
216 	.match		= mmc_bus_match,
217 	.uevent		= mmc_bus_uevent,
218 	.probe		= mmc_bus_probe,
219 	.remove		= mmc_bus_remove,
220 	.shutdown	= mmc_bus_shutdown,
221 	.pm		= &mmc_bus_pm_ops,
222 };
223 
224 int mmc_register_bus(void)
225 {
226 	return bus_register(&mmc_bus_type);
227 }
228 
229 void mmc_unregister_bus(void)
230 {
231 	bus_unregister(&mmc_bus_type);
232 }
233 
234 /**
235  *	mmc_register_driver - register a media driver
236  *	@drv: MMC media driver
237  */
238 int mmc_register_driver(struct mmc_driver *drv)
239 {
240 	drv->drv.bus = &mmc_bus_type;
241 	return driver_register(&drv->drv);
242 }
243 
244 EXPORT_SYMBOL(mmc_register_driver);
245 
246 /**
247  *	mmc_unregister_driver - unregister a media driver
248  *	@drv: MMC media driver
249  */
250 void mmc_unregister_driver(struct mmc_driver *drv)
251 {
252 	drv->drv.bus = &mmc_bus_type;
253 	driver_unregister(&drv->drv);
254 }
255 
256 EXPORT_SYMBOL(mmc_unregister_driver);
257 
258 static void mmc_release_card(struct device *dev)
259 {
260 	struct mmc_card *card = mmc_dev_to_card(dev);
261 
262 	sdio_free_common_cis(card);
263 
264 	kfree(card->info);
265 
266 	kfree(card);
267 }
268 
269 /*
270  * Allocate and initialise a new MMC card structure.
271  */
272 struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
273 {
274 	struct mmc_card *card;
275 
276 	card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
277 	if (!card)
278 		return ERR_PTR(-ENOMEM);
279 
280 	card->host = host;
281 
282 	device_initialize(&card->dev);
283 
284 	card->dev.parent = mmc_classdev(host);
285 	card->dev.bus = &mmc_bus_type;
286 	card->dev.release = mmc_release_card;
287 	card->dev.type = type;
288 
289 	return card;
290 }
291 
292 /*
293  * Register a new MMC card with the driver model.
294  */
295 int mmc_add_card(struct mmc_card *card)
296 {
297 	int ret;
298 	const char *type;
299 	const char *uhs_bus_speed_mode = "";
300 	static const char *const uhs_speeds[] = {
301 		[UHS_SDR12_BUS_SPEED] = "SDR12 ",
302 		[UHS_SDR25_BUS_SPEED] = "SDR25 ",
303 		[UHS_SDR50_BUS_SPEED] = "SDR50 ",
304 		[UHS_SDR104_BUS_SPEED] = "SDR104 ",
305 		[UHS_DDR50_BUS_SPEED] = "DDR50 ",
306 	};
307 
308 
309 	dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
310 
311 	switch (card->type) {
312 	case MMC_TYPE_MMC:
313 		type = "MMC";
314 		break;
315 	case MMC_TYPE_SD:
316 		type = "SD";
317 		if (mmc_card_blockaddr(card)) {
318 			if (mmc_card_ext_capacity(card))
319 				type = "SDXC";
320 			else
321 				type = "SDHC";
322 		}
323 		break;
324 	case MMC_TYPE_SDIO:
325 		type = "SDIO";
326 		break;
327 	case MMC_TYPE_SD_COMBO:
328 		type = "SD-combo";
329 		if (mmc_card_blockaddr(card))
330 			type = "SDHC-combo";
331 		break;
332 	default:
333 		type = "?";
334 		break;
335 	}
336 
337 	if (mmc_card_uhs(card) &&
338 		(card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
339 		uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
340 
341 	if (mmc_host_is_spi(card->host)) {
342 		pr_info("%s: new %s%s%s card on SPI\n",
343 			mmc_hostname(card->host),
344 			mmc_card_highspeed(card) ? "high speed " : "",
345 			mmc_card_ddr_mode(card) ? "DDR " : "",
346 			type);
347 	} else {
348 		pr_info("%s: new %s%s%s%s%s card at address %04x\n",
349 			mmc_hostname(card->host),
350 			mmc_card_uhs(card) ? "ultra high speed " :
351 			(mmc_card_highspeed(card) ? "high speed " : ""),
352 			(mmc_card_hs200(card) ? "HS200 " : ""),
353 			mmc_card_ddr_mode(card) ? "DDR " : "",
354 			uhs_bus_speed_mode, type, card->rca);
355 	}
356 
357 #ifdef CONFIG_DEBUG_FS
358 	mmc_add_card_debugfs(card);
359 #endif
360 	mmc_init_context_info(card->host);
361 
362 	ret = device_add(&card->dev);
363 	if (ret)
364 		return ret;
365 
366 	mmc_card_set_present(card);
367 
368 	return 0;
369 }
370 
371 /*
372  * Unregister a new MMC card with the driver model, and
373  * (eventually) free it.
374  */
375 void mmc_remove_card(struct mmc_card *card)
376 {
377 #ifdef CONFIG_DEBUG_FS
378 	mmc_remove_card_debugfs(card);
379 #endif
380 
381 	if (mmc_card_present(card)) {
382 		if (mmc_host_is_spi(card->host)) {
383 			pr_info("%s: SPI card removed\n",
384 				mmc_hostname(card->host));
385 		} else {
386 			pr_info("%s: card %04x removed\n",
387 				mmc_hostname(card->host), card->rca);
388 		}
389 		device_del(&card->dev);
390 	}
391 
392 	put_device(&card->dev);
393 }
394 
395