bus.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 *  linux/drivers/mmc/core/bus.c
  4 *
  5 *  Copyright (C) 2003 Russell King, All Rights Reserved.
  6 *  Copyright (C) 2007 Pierre Ossman
  7 *
  8 *  MMC card bus driver model
  9 */
 10
 11#include <linux/export.h>
 12#include <linux/device.h>
 13#include <linux/err.h>
 14#include <linux/slab.h>
 15#include <linux/stat.h>
 16#include <linux/of.h>
 17#include <linux/pm_runtime.h>
 18#include <linux/sysfs.h>
 19
 20#include <linux/mmc/card.h>
 21#include <linux/mmc/host.h>
 22#include <linux/mmc/mmc.h>
 23
 24#include "core.h"
 25#include "card.h"
 26#include "host.h"
 27#include "sdio_cis.h"
 28#include "bus.h"
 29
 30#define to_mmc_driver(d)	container_of(d, struct mmc_driver, drv)
 31
 32static ssize_t type_show(struct device *dev,
 33	struct device_attribute *attr, char *buf)
 34{
 35	struct mmc_card *card = mmc_dev_to_card(dev);
 36
 37	switch (card->type) {
 38	case MMC_TYPE_MMC:
 39		return sysfs_emit(buf, "MMC\n");
 40	case MMC_TYPE_SD:
 41		return sysfs_emit(buf, "SD\n");
 42	case MMC_TYPE_SDIO:
 43		return sysfs_emit(buf, "SDIO\n");
 44	case MMC_TYPE_SD_COMBO:
 45		return sysfs_emit(buf, "SDcombo\n");
 46	default:
 47		return -EFAULT;
 48	}
 49}
 50static DEVICE_ATTR_RO(type);
 51
 52static struct attribute *mmc_dev_attrs[] = {
 53	&dev_attr_type.attr,
 54	NULL,
 55};
 56ATTRIBUTE_GROUPS(mmc_dev);
 57
 58static int
 59mmc_bus_uevent(const struct device *dev, struct kobj_uevent_env *env)
 60{
 61	const struct mmc_card *card = mmc_dev_to_card(dev);
 62	const char *type;
 63	unsigned int i;
 64	int retval = 0;
 65
 66	switch (card->type) {
 67	case MMC_TYPE_MMC:
 68		type = "MMC";
 69		break;
 70	case MMC_TYPE_SD:
 71		type = "SD";
 72		break;
 73	case MMC_TYPE_SDIO:
 74		type = "SDIO";
 75		break;
 76	case MMC_TYPE_SD_COMBO:
 77		type = "SDcombo";
 78		break;
 79	default:
 80		type = NULL;
 81	}
 82
 83	if (type) {
 84		retval = add_uevent_var(env, "MMC_TYPE=%s", type);
 85		if (retval)
 86			return retval;
 87	}
 88
 89	if (mmc_card_sdio(card) || mmc_card_sd_combo(card)) {
 90		retval = add_uevent_var(env, "SDIO_ID=%04X:%04X",
 91					card->cis.vendor, card->cis.device);
 92		if (retval)
 93			return retval;
 94
 95		retval = add_uevent_var(env, "SDIO_REVISION=%u.%u",
 96					card->major_rev, card->minor_rev);
 97		if (retval)
 98			return retval;
 99
100		for (i = 0; i < card->num_info; i++) {
101			retval = add_uevent_var(env, "SDIO_INFO%u=%s", i+1, card->info[i]);
102			if (retval)
103				return retval;
104		}
105	}
106
107	/*
108	 * SDIO (non-combo) cards are not handled by mmc_block driver and do not
109	 * have accessible CID register which used by mmc_card_name() function.
110	 */
111	if (mmc_card_sdio(card))
112		return 0;
113
114	retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
115	if (retval)
116		return retval;
117
118	/*
119	 * Request the mmc_block device.  Note: that this is a direct request
120	 * for the module it carries no information as to what is inserted.
121	 */
122	retval = add_uevent_var(env, "MODALIAS=mmc:block");
123
124	return retval;
125}
126
127static int mmc_bus_probe(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
132	return drv->probe(card);
133}
134
135static void mmc_bus_remove(struct device *dev)
136{
137	struct mmc_driver *drv = to_mmc_driver(dev->driver);
138	struct mmc_card *card = mmc_dev_to_card(dev);
139
140	drv->remove(card);
141}
142
143static void mmc_bus_shutdown(struct device *dev)
144{
145	struct mmc_driver *drv = to_mmc_driver(dev->driver);
146	struct mmc_card *card = mmc_dev_to_card(dev);
147	struct mmc_host *host = card->host;
148	int ret;
149
150	if (dev->driver && drv->shutdown)
151		drv->shutdown(card);
152
153	__mmc_stop_host(host);
154
155	if (host->bus_ops->shutdown) {
156		ret = host->bus_ops->shutdown(host);
157		if (ret)
158			pr_warn("%s: error %d during shutdown\n",
159				mmc_hostname(host), ret);
160	}
161}
162
163#ifdef CONFIG_PM_SLEEP
164static int mmc_bus_suspend(struct device *dev)
165{
166	struct mmc_card *card = mmc_dev_to_card(dev);
167	struct mmc_host *host = card->host;
168	int ret;
169
170	ret = pm_generic_suspend(dev);
171	if (ret)
172		return ret;
173
174	ret = host->bus_ops->suspend(host);
175	if (ret)
176		pm_generic_resume(dev);
177
178	return ret;
179}
180
181static int mmc_bus_resume(struct device *dev)
182{
183	struct mmc_card *card = mmc_dev_to_card(dev);
184	struct mmc_host *host = card->host;
185	int ret;
186
187	ret = host->bus_ops->resume(host);
188	if (ret)
189		pr_warn("%s: error %d during resume (card was removed?)\n",
190			mmc_hostname(host), ret);
191
192	ret = pm_generic_resume(dev);
193	return ret;
194}
195#endif
196
197#ifdef CONFIG_PM
198static int mmc_runtime_suspend(struct device *dev)
199{
200	struct mmc_card *card = mmc_dev_to_card(dev);
201	struct mmc_host *host = card->host;
202
203	return host->bus_ops->runtime_suspend(host);
204}
205
206static int mmc_runtime_resume(struct device *dev)
207{
208	struct mmc_card *card = mmc_dev_to_card(dev);
209	struct mmc_host *host = card->host;
210
211	return host->bus_ops->runtime_resume(host);
212}
213#endif /* !CONFIG_PM */
214
215static const struct dev_pm_ops mmc_bus_pm_ops = {
216	SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
217	SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
218};
219
220static const struct bus_type mmc_bus_type = {
221	.name		= "mmc",
222	.dev_groups	= mmc_dev_groups,
223	.uevent		= mmc_bus_uevent,
224	.probe		= mmc_bus_probe,
225	.remove		= mmc_bus_remove,
226	.shutdown	= mmc_bus_shutdown,
227	.pm		= &mmc_bus_pm_ops,
228};
229
230int mmc_register_bus(void)
231{
232	return bus_register(&mmc_bus_type);
233}
234
235void mmc_unregister_bus(void)
236{
237	bus_unregister(&mmc_bus_type);
238}
239
240/**
241 *	mmc_register_driver - register a media driver
242 *	@drv: MMC media driver
243 */
244int mmc_register_driver(struct mmc_driver *drv)
245{
246	drv->drv.bus = &mmc_bus_type;
247	return driver_register(&drv->drv);
248}
249
250EXPORT_SYMBOL(mmc_register_driver);
251
252/**
253 *	mmc_unregister_driver - unregister a media driver
254 *	@drv: MMC media driver
255 */
256void mmc_unregister_driver(struct mmc_driver *drv)
257{
258	drv->drv.bus = &mmc_bus_type;
259	driver_unregister(&drv->drv);
260}
261
262EXPORT_SYMBOL(mmc_unregister_driver);
263
264static void mmc_release_card(struct device *dev)
265{
266	struct mmc_card *card = mmc_dev_to_card(dev);
267
268	sdio_free_common_cis(card);
269
270	kfree(card->info);
271
272	kfree(card);
273}
274
275/*
276 * Allocate and initialise a new MMC card structure.
277 */
278struct mmc_card *mmc_alloc_card(struct mmc_host *host, const struct device_type *type)
279{
280	struct mmc_card *card;
281
282	card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
283	if (!card)
284		return ERR_PTR(-ENOMEM);
285
286	card->host = host;
287
288	device_initialize(&card->dev);
289
290	card->dev.parent = mmc_classdev(host);
291	card->dev.bus = &mmc_bus_type;
292	card->dev.release = mmc_release_card;
293	card->dev.type = type;
294
295	return card;
296}
297
298/*
299 * Register a new MMC card with the driver model.
300 */
301int mmc_add_card(struct mmc_card *card)
302{
303	int ret;
304	const char *type;
305	const char *speed_mode = "";
306	const char *uhs_bus_speed_mode = "";
307	static const char *const uhs_speeds[] = {
308		[UHS_SDR12_BUS_SPEED] = "SDR12 ",
309		[UHS_SDR25_BUS_SPEED] = "SDR25 ",
310		[UHS_SDR50_BUS_SPEED] = "SDR50 ",
311		[UHS_SDR104_BUS_SPEED] = "SDR104 ",
312		[UHS_DDR50_BUS_SPEED] = "DDR50 ",
313	};
314
315
316	dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
317	dev_set_removable(&card->dev,
318			  mmc_card_is_removable(card->host) ?
319			  DEVICE_REMOVABLE : DEVICE_FIXED);
320
321	switch (card->type) {
322	case MMC_TYPE_MMC:
323		type = "MMC";
324		break;
325	case MMC_TYPE_SD:
326		type = "SD";
327		if (mmc_card_blockaddr(card)) {
328			if (mmc_card_ult_capacity(card))
329				type = "SDUC";
330			else if (mmc_card_ext_capacity(card))
331				type = "SDXC";
332			else
333				type = "SDHC";
334		}
335		break;
336	case MMC_TYPE_SDIO:
337		type = "SDIO";
338		break;
339	case MMC_TYPE_SD_COMBO:
340		type = "SD-combo";
341		if (mmc_card_blockaddr(card))
342			type = "SDHC-combo";
343		break;
344	default:
345		type = "?";
346		break;
347	}
348
349	if (mmc_card_hs(card))
350		speed_mode = "high speed ";
351	else if (mmc_card_uhs(card))
352		speed_mode = "UHS-I speed ";
353	else if (mmc_card_uhs2(card->host))
354		speed_mode = "UHS-II speed ";
355	else if	(mmc_card_ddr52(card))
356		speed_mode = "high speed DDR ";
357	else if (mmc_card_hs200(card))
358		speed_mode = "HS200 ";
359	else if (mmc_card_hs400es(card))
360		speed_mode = "HS400 Enhanced strobe ";
361	else if (mmc_card_hs400(card))
362		speed_mode = "HS400 ";
363
364	if (mmc_card_uhs(card) &&
365		(card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
366		uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
367
368	if (mmc_host_is_spi(card->host))
369		pr_info("%s: new %s%s card on SPI\n",
370			mmc_hostname(card->host), speed_mode, type);
371	else
372		pr_info("%s: new %s%s%s card at address %04x\n",
373			mmc_hostname(card->host), speed_mode,
374			uhs_bus_speed_mode, type, card->rca);
375
376	mmc_add_card_debugfs(card);
377	card->dev.of_node = mmc_of_find_child_device(card->host, 0);
378
379	device_enable_async_suspend(&card->dev);
380
381	ret = device_add(&card->dev);
382	if (ret)
383		return ret;
384
385	mmc_card_set_present(card);
386
387	/*
388	 * Register for undervoltage notification if the card supports
389	 * power-off notification, enabling emergency shutdowns.
390	 */
391	if (mmc_card_mmc(card) &&
392	    card->ext_csd.power_off_notification == EXT_CSD_POWER_ON)
393		mmc_regulator_register_undervoltage_notifier(card->host);
394
395	return 0;
396}
397
398/*
399 * Unregister a new MMC card with the driver model, and
400 * (eventually) free it.
401 */
402void mmc_remove_card(struct mmc_card *card)
403{
404	struct mmc_host *host = card->host;
405
406	if (mmc_card_present(card))
407		mmc_regulator_unregister_undervoltage_notifier(host);
408
409	mmc_remove_card_debugfs(card);
410
411	if (mmc_card_present(card)) {
412		if (mmc_host_is_spi(card->host)) {
413			pr_info("%s: SPI card removed\n",
414				mmc_hostname(card->host));
415		} else {
416			pr_info("%s: card %04x removed\n",
417				mmc_hostname(card->host), card->rca);
418		}
419		device_del(&card->dev);
420		of_node_put(card->dev.of_node);
421	}
422
423	if (host->cqe_enabled) {
424		host->cqe_ops->cqe_disable(host);
425		host->cqe_enabled = false;
426	}
427
428	put_device(&card->dev);
429}