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
30static 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}
48static DEVICE_ATTR_RO(type);
49
50static struct attribute *mmc_dev_attrs[] = {
51	&dev_attr_type.attr,
52	NULL,
53};
54ATTRIBUTE_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 */
61static int mmc_bus_match(struct device *dev, struct device_driver *drv)
62{
63	return 1;
64}
65
66static int
67mmc_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
109static 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
117static 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
127static 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
146static 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
163static 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
183static int mmc_runtime_suspend(struct device *dev)
184{
185	struct mmc_card *card = mmc_dev_to_card(dev);
186	struct mmc_host *host = card->host;
187
188	return host->bus_ops->runtime_suspend(host);
189}
190
191static int mmc_runtime_resume(struct device *dev)
192{
193	struct mmc_card *card = mmc_dev_to_card(dev);
194	struct mmc_host *host = card->host;
195
196	return host->bus_ops->runtime_resume(host);
197}
198#endif /* !CONFIG_PM_RUNTIME */
199
200static const struct dev_pm_ops mmc_bus_pm_ops = {
201	SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
202	SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
203};
204
205static struct bus_type mmc_bus_type = {
206	.name		= "mmc",
207	.dev_groups	= mmc_dev_groups,
208	.match		= mmc_bus_match,
209	.uevent		= mmc_bus_uevent,
210	.probe		= mmc_bus_probe,
211	.remove		= mmc_bus_remove,
212	.shutdown	= mmc_bus_shutdown,
213	.pm		= &mmc_bus_pm_ops,
214};
215
216int mmc_register_bus(void)
217{
218	return bus_register(&mmc_bus_type);
219}
220
221void mmc_unregister_bus(void)
222{
223	bus_unregister(&mmc_bus_type);
224}
225
226/**
227 *	mmc_register_driver - register a media driver
228 *	@drv: MMC media driver
229 */
230int mmc_register_driver(struct mmc_driver *drv)
231{
232	drv->drv.bus = &mmc_bus_type;
233	return driver_register(&drv->drv);
234}
235
236EXPORT_SYMBOL(mmc_register_driver);
237
238/**
239 *	mmc_unregister_driver - unregister a media driver
240 *	@drv: MMC media driver
241 */
242void mmc_unregister_driver(struct mmc_driver *drv)
243{
244	drv->drv.bus = &mmc_bus_type;
245	driver_unregister(&drv->drv);
246}
247
248EXPORT_SYMBOL(mmc_unregister_driver);
249
250static void mmc_release_card(struct device *dev)
251{
252	struct mmc_card *card = mmc_dev_to_card(dev);
253
254	sdio_free_common_cis(card);
255
256	kfree(card->info);
257
258	kfree(card);
259}
260
261/*
262 * Allocate and initialise a new MMC card structure.
263 */
264struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
265{
266	struct mmc_card *card;
267
268	card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
269	if (!card)
270		return ERR_PTR(-ENOMEM);
271
272	card->host = host;
273
274	device_initialize(&card->dev);
275
276	card->dev.parent = mmc_classdev(host);
277	card->dev.bus = &mmc_bus_type;
278	card->dev.release = mmc_release_card;
279	card->dev.type = type;
280
281	return card;
282}
283
284/*
285 * Register a new MMC card with the driver model.
286 */
287int mmc_add_card(struct mmc_card *card)
288{
289	int ret;
290	const char *type;
291	const char *uhs_bus_speed_mode = "";
292	static const char *const uhs_speeds[] = {
293		[UHS_SDR12_BUS_SPEED] = "SDR12 ",
294		[UHS_SDR25_BUS_SPEED] = "SDR25 ",
295		[UHS_SDR50_BUS_SPEED] = "SDR50 ",
296		[UHS_SDR104_BUS_SPEED] = "SDR104 ",
297		[UHS_DDR50_BUS_SPEED] = "DDR50 ",
298	};
299
300
301	dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
302
303	switch (card->type) {
304	case MMC_TYPE_MMC:
305		type = "MMC";
306		break;
307	case MMC_TYPE_SD:
308		type = "SD";
309		if (mmc_card_blockaddr(card)) {
310			if (mmc_card_ext_capacity(card))
311				type = "SDXC";
312			else
313				type = "SDHC";
314		}
315		break;
316	case MMC_TYPE_SDIO:
317		type = "SDIO";
318		break;
319	case MMC_TYPE_SD_COMBO:
320		type = "SD-combo";
321		if (mmc_card_blockaddr(card))
322			type = "SDHC-combo";
323		break;
324	default:
325		type = "?";
326		break;
327	}
328
329	if (mmc_card_uhs(card) &&
330		(card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
331		uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
332
333	if (mmc_host_is_spi(card->host)) {
334		pr_info("%s: new %s%s%s card on SPI\n",
335			mmc_hostname(card->host),
336			mmc_card_hs(card) ? "high speed " : "",
337			mmc_card_ddr52(card) ? "DDR " : "",
338			type);
339	} else {
340		pr_info("%s: new %s%s%s%s%s card at address %04x\n",
341			mmc_hostname(card->host),
342			mmc_card_uhs(card) ? "ultra high speed " :
343			(mmc_card_hs(card) ? "high speed " : ""),
344			mmc_card_hs400(card) ? "HS400 " :
345			(mmc_card_hs200(card) ? "HS200 " : ""),
346			mmc_card_ddr52(card) ? "DDR " : "",
347			uhs_bus_speed_mode, type, card->rca);
348	}
349
350#ifdef CONFIG_DEBUG_FS
351	mmc_add_card_debugfs(card);
352#endif
353	mmc_init_context_info(card->host);
354
355	ret = device_add(&card->dev);
356	if (ret)
357		return ret;
358
359	mmc_card_set_present(card);
360
361	return 0;
362}
363
364/*
365 * Unregister a new MMC card with the driver model, and
366 * (eventually) free it.
367 */
368void mmc_remove_card(struct mmc_card *card)
369{
370#ifdef CONFIG_DEBUG_FS
371	mmc_remove_card_debugfs(card);
372#endif
373
374	if (mmc_card_present(card)) {
375		if (mmc_host_is_spi(card->host)) {
376			pr_info("%s: SPI card removed\n",
377				mmc_hostname(card->host));
378		} else {
379			pr_info("%s: card %04x removed\n",
380				mmc_hostname(card->host), card->rca);
381		}
382		device_del(&card->dev);
383	}
384
385	put_device(&card->dev);
386}
387
388