Loading...
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 mmc_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
49static struct device_attribute mmc_dev_attrs[] = {
50 __ATTR(type, S_IRUGO, mmc_type_show, NULL),
51 __ATTR_NULL,
52};
53
54/*
55 * This currently matches any MMC driver to any MMC card - drivers
56 * themselves make the decision whether to drive this card in their
57 * probe method.
58 */
59static int mmc_bus_match(struct device *dev, struct device_driver *drv)
60{
61 return 1;
62}
63
64static int
65mmc_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
66{
67 struct mmc_card *card = mmc_dev_to_card(dev);
68 const char *type;
69 int retval = 0;
70
71 switch (card->type) {
72 case MMC_TYPE_MMC:
73 type = "MMC";
74 break;
75 case MMC_TYPE_SD:
76 type = "SD";
77 break;
78 case MMC_TYPE_SDIO:
79 type = "SDIO";
80 break;
81 case MMC_TYPE_SD_COMBO:
82 type = "SDcombo";
83 break;
84 default:
85 type = NULL;
86 }
87
88 if (type) {
89 retval = add_uevent_var(env, "MMC_TYPE=%s", type);
90 if (retval)
91 return retval;
92 }
93
94 retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
95 if (retval)
96 return retval;
97
98 /*
99 * Request the mmc_block device. Note: that this is a direct request
100 * for the module it carries no information as to what is inserted.
101 */
102 retval = add_uevent_var(env, "MODALIAS=mmc:block");
103
104 return retval;
105}
106
107static int mmc_bus_probe(struct device *dev)
108{
109 struct mmc_driver *drv = to_mmc_driver(dev->driver);
110 struct mmc_card *card = mmc_dev_to_card(dev);
111
112 return drv->probe(card);
113}
114
115static int mmc_bus_remove(struct device *dev)
116{
117 struct mmc_driver *drv = to_mmc_driver(dev->driver);
118 struct mmc_card *card = mmc_dev_to_card(dev);
119
120 drv->remove(card);
121
122 return 0;
123}
124
125#ifdef CONFIG_PM_SLEEP
126static int mmc_bus_suspend(struct device *dev)
127{
128 struct mmc_driver *drv = to_mmc_driver(dev->driver);
129 struct mmc_card *card = mmc_dev_to_card(dev);
130 int ret = 0;
131
132 if (dev->driver && drv->suspend)
133 ret = drv->suspend(card);
134 return ret;
135}
136
137static int mmc_bus_resume(struct device *dev)
138{
139 struct mmc_driver *drv = to_mmc_driver(dev->driver);
140 struct mmc_card *card = mmc_dev_to_card(dev);
141 int ret = 0;
142
143 if (dev->driver && drv->resume)
144 ret = drv->resume(card);
145 return ret;
146}
147#endif
148
149#ifdef CONFIG_PM_RUNTIME
150
151static int mmc_runtime_suspend(struct device *dev)
152{
153 struct mmc_card *card = mmc_dev_to_card(dev);
154
155 return mmc_power_save_host(card->host);
156}
157
158static int mmc_runtime_resume(struct device *dev)
159{
160 struct mmc_card *card = mmc_dev_to_card(dev);
161
162 return mmc_power_restore_host(card->host);
163}
164
165static int mmc_runtime_idle(struct device *dev)
166{
167 return pm_runtime_suspend(dev);
168}
169
170#endif /* !CONFIG_PM_RUNTIME */
171
172static const struct dev_pm_ops mmc_bus_pm_ops = {
173 SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume,
174 mmc_runtime_idle)
175 SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
176};
177
178static struct bus_type mmc_bus_type = {
179 .name = "mmc",
180 .dev_attrs = mmc_dev_attrs,
181 .match = mmc_bus_match,
182 .uevent = mmc_bus_uevent,
183 .probe = mmc_bus_probe,
184 .remove = mmc_bus_remove,
185 .pm = &mmc_bus_pm_ops,
186};
187
188int mmc_register_bus(void)
189{
190 return bus_register(&mmc_bus_type);
191}
192
193void mmc_unregister_bus(void)
194{
195 bus_unregister(&mmc_bus_type);
196}
197
198/**
199 * mmc_register_driver - register a media driver
200 * @drv: MMC media driver
201 */
202int mmc_register_driver(struct mmc_driver *drv)
203{
204 drv->drv.bus = &mmc_bus_type;
205 return driver_register(&drv->drv);
206}
207
208EXPORT_SYMBOL(mmc_register_driver);
209
210/**
211 * mmc_unregister_driver - unregister a media driver
212 * @drv: MMC media driver
213 */
214void mmc_unregister_driver(struct mmc_driver *drv)
215{
216 drv->drv.bus = &mmc_bus_type;
217 driver_unregister(&drv->drv);
218}
219
220EXPORT_SYMBOL(mmc_unregister_driver);
221
222static void mmc_release_card(struct device *dev)
223{
224 struct mmc_card *card = mmc_dev_to_card(dev);
225
226 sdio_free_common_cis(card);
227
228 if (card->info)
229 kfree(card->info);
230
231 kfree(card);
232}
233
234/*
235 * Allocate and initialise a new MMC card structure.
236 */
237struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
238{
239 struct mmc_card *card;
240
241 card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
242 if (!card)
243 return ERR_PTR(-ENOMEM);
244
245 card->host = host;
246
247 device_initialize(&card->dev);
248
249 card->dev.parent = mmc_classdev(host);
250 card->dev.bus = &mmc_bus_type;
251 card->dev.release = mmc_release_card;
252 card->dev.type = type;
253
254 return card;
255}
256
257/*
258 * Register a new MMC card with the driver model.
259 */
260int mmc_add_card(struct mmc_card *card)
261{
262 int ret;
263 const char *type;
264 const char *uhs_bus_speed_mode = "";
265 static const char *const uhs_speeds[] = {
266 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
267 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
268 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
269 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
270 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
271 };
272
273
274 dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
275
276 switch (card->type) {
277 case MMC_TYPE_MMC:
278 type = "MMC";
279 break;
280 case MMC_TYPE_SD:
281 type = "SD";
282 if (mmc_card_blockaddr(card)) {
283 if (mmc_card_ext_capacity(card))
284 type = "SDXC";
285 else
286 type = "SDHC";
287 }
288 break;
289 case MMC_TYPE_SDIO:
290 type = "SDIO";
291 break;
292 case MMC_TYPE_SD_COMBO:
293 type = "SD-combo";
294 if (mmc_card_blockaddr(card))
295 type = "SDHC-combo";
296 break;
297 default:
298 type = "?";
299 break;
300 }
301
302 if (mmc_sd_card_uhs(card) &&
303 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
304 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
305
306 if (mmc_host_is_spi(card->host)) {
307 pr_info("%s: new %s%s%s card on SPI\n",
308 mmc_hostname(card->host),
309 mmc_card_highspeed(card) ? "high speed " : "",
310 mmc_card_ddr_mode(card) ? "DDR " : "",
311 type);
312 } else {
313 pr_info("%s: new %s%s%s%s%s card at address %04x\n",
314 mmc_hostname(card->host),
315 mmc_card_uhs(card) ? "ultra high speed " :
316 (mmc_card_highspeed(card) ? "high speed " : ""),
317 (mmc_card_hs200(card) ? "HS200 " : ""),
318 mmc_card_ddr_mode(card) ? "DDR " : "",
319 uhs_bus_speed_mode, type, card->rca);
320 }
321
322#ifdef CONFIG_DEBUG_FS
323 mmc_add_card_debugfs(card);
324#endif
325
326 ret = device_add(&card->dev);
327 if (ret)
328 return ret;
329
330 mmc_card_set_present(card);
331
332 return 0;
333}
334
335/*
336 * Unregister a new MMC card with the driver model, and
337 * (eventually) free it.
338 */
339void mmc_remove_card(struct mmc_card *card)
340{
341#ifdef CONFIG_DEBUG_FS
342 mmc_remove_card_debugfs(card);
343#endif
344
345 if (mmc_card_present(card)) {
346 if (mmc_host_is_spi(card->host)) {
347 pr_info("%s: SPI card removed\n",
348 mmc_hostname(card->host));
349 } else {
350 pr_info("%s: card %04x removed\n",
351 mmc_hostname(card->host), card->rca);
352 }
353 device_del(&card->dev);
354 }
355
356 put_device(&card->dev);
357}
358
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
19#include <linux/mmc/card.h>
20#include <linux/mmc/host.h>
21
22#include "core.h"
23#include "card.h"
24#include "host.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 unsigned int i;
72 int retval = 0;
73
74 switch (card->type) {
75 case MMC_TYPE_MMC:
76 type = "MMC";
77 break;
78 case MMC_TYPE_SD:
79 type = "SD";
80 break;
81 case MMC_TYPE_SDIO:
82 type = "SDIO";
83 break;
84 case MMC_TYPE_SD_COMBO:
85 type = "SDcombo";
86 break;
87 default:
88 type = NULL;
89 }
90
91 if (type) {
92 retval = add_uevent_var(env, "MMC_TYPE=%s", type);
93 if (retval)
94 return retval;
95 }
96
97 if (card->type == MMC_TYPE_SDIO || card->type == MMC_TYPE_SD_COMBO) {
98 retval = add_uevent_var(env, "SDIO_ID=%04X:%04X",
99 card->cis.vendor, card->cis.device);
100 if (retval)
101 return retval;
102
103 retval = add_uevent_var(env, "SDIO_REVISION=%u.%u",
104 card->major_rev, card->minor_rev);
105 if (retval)
106 return retval;
107
108 for (i = 0; i < card->num_info; i++) {
109 retval = add_uevent_var(env, "SDIO_INFO%u=%s", i+1, card->info[i]);
110 if (retval)
111 return retval;
112 }
113 }
114
115 /*
116 * SDIO (non-combo) cards are not handled by mmc_block driver and do not
117 * have accessible CID register which used by mmc_card_name() function.
118 */
119 if (card->type == MMC_TYPE_SDIO)
120 return 0;
121
122 retval = add_uevent_var(env, "MMC_NAME=%s", mmc_card_name(card));
123 if (retval)
124 return retval;
125
126 /*
127 * Request the mmc_block device. Note: that this is a direct request
128 * for the module it carries no information as to what is inserted.
129 */
130 retval = add_uevent_var(env, "MODALIAS=mmc:block");
131
132 return retval;
133}
134
135static int mmc_bus_probe(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 return drv->probe(card);
141}
142
143static int mmc_bus_remove(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
148 drv->remove(card);
149
150 return 0;
151}
152
153static void mmc_bus_shutdown(struct device *dev)
154{
155 struct mmc_driver *drv = to_mmc_driver(dev->driver);
156 struct mmc_card *card = mmc_dev_to_card(dev);
157 struct mmc_host *host = card->host;
158 int ret;
159
160 if (dev->driver && drv->shutdown)
161 drv->shutdown(card);
162
163 if (host->bus_ops->shutdown) {
164 ret = host->bus_ops->shutdown(host);
165 if (ret)
166 pr_warn("%s: error %d during shutdown\n",
167 mmc_hostname(host), ret);
168 }
169}
170
171#ifdef CONFIG_PM_SLEEP
172static int mmc_bus_suspend(struct device *dev)
173{
174 struct mmc_card *card = mmc_dev_to_card(dev);
175 struct mmc_host *host = card->host;
176 int ret;
177
178 ret = pm_generic_suspend(dev);
179 if (ret)
180 return ret;
181
182 ret = host->bus_ops->suspend(host);
183 if (ret)
184 pm_generic_resume(dev);
185
186 return ret;
187}
188
189static int mmc_bus_resume(struct device *dev)
190{
191 struct mmc_card *card = mmc_dev_to_card(dev);
192 struct mmc_host *host = card->host;
193 int ret;
194
195 ret = host->bus_ops->resume(host);
196 if (ret)
197 pr_warn("%s: error %d during resume (card was removed?)\n",
198 mmc_hostname(host), ret);
199
200 ret = pm_generic_resume(dev);
201 return ret;
202}
203#endif
204
205#ifdef CONFIG_PM
206static int mmc_runtime_suspend(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_suspend(host);
212}
213
214static int mmc_runtime_resume(struct device *dev)
215{
216 struct mmc_card *card = mmc_dev_to_card(dev);
217 struct mmc_host *host = card->host;
218
219 return host->bus_ops->runtime_resume(host);
220}
221#endif /* !CONFIG_PM */
222
223static const struct dev_pm_ops mmc_bus_pm_ops = {
224 SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume, NULL)
225 SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
226};
227
228static struct bus_type mmc_bus_type = {
229 .name = "mmc",
230 .dev_groups = mmc_dev_groups,
231 .match = mmc_bus_match,
232 .uevent = mmc_bus_uevent,
233 .probe = mmc_bus_probe,
234 .remove = mmc_bus_remove,
235 .shutdown = mmc_bus_shutdown,
236 .pm = &mmc_bus_pm_ops,
237};
238
239int mmc_register_bus(void)
240{
241 return bus_register(&mmc_bus_type);
242}
243
244void mmc_unregister_bus(void)
245{
246 bus_unregister(&mmc_bus_type);
247}
248
249/**
250 * mmc_register_driver - register a media driver
251 * @drv: MMC media driver
252 */
253int mmc_register_driver(struct mmc_driver *drv)
254{
255 drv->drv.bus = &mmc_bus_type;
256 return driver_register(&drv->drv);
257}
258
259EXPORT_SYMBOL(mmc_register_driver);
260
261/**
262 * mmc_unregister_driver - unregister a media driver
263 * @drv: MMC media driver
264 */
265void mmc_unregister_driver(struct mmc_driver *drv)
266{
267 drv->drv.bus = &mmc_bus_type;
268 driver_unregister(&drv->drv);
269}
270
271EXPORT_SYMBOL(mmc_unregister_driver);
272
273static void mmc_release_card(struct device *dev)
274{
275 struct mmc_card *card = mmc_dev_to_card(dev);
276
277 sdio_free_common_cis(card);
278
279 kfree(card->info);
280
281 kfree(card);
282}
283
284/*
285 * Allocate and initialise a new MMC card structure.
286 */
287struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
288{
289 struct mmc_card *card;
290
291 card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
292 if (!card)
293 return ERR_PTR(-ENOMEM);
294
295 card->host = host;
296
297 device_initialize(&card->dev);
298
299 card->dev.parent = mmc_classdev(host);
300 card->dev.bus = &mmc_bus_type;
301 card->dev.release = mmc_release_card;
302 card->dev.type = type;
303
304 return card;
305}
306
307/*
308 * Register a new MMC card with the driver model.
309 */
310int mmc_add_card(struct mmc_card *card)
311{
312 int ret;
313 const char *type;
314 const char *uhs_bus_speed_mode = "";
315 static const char *const uhs_speeds[] = {
316 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
317 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
318 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
319 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
320 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
321 };
322
323
324 dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
325
326 switch (card->type) {
327 case MMC_TYPE_MMC:
328 type = "MMC";
329 break;
330 case MMC_TYPE_SD:
331 type = "SD";
332 if (mmc_card_blockaddr(card)) {
333 if (mmc_card_ext_capacity(card))
334 type = "SDXC";
335 else
336 type = "SDHC";
337 }
338 break;
339 case MMC_TYPE_SDIO:
340 type = "SDIO";
341 break;
342 case MMC_TYPE_SD_COMBO:
343 type = "SD-combo";
344 if (mmc_card_blockaddr(card))
345 type = "SDHC-combo";
346 break;
347 default:
348 type = "?";
349 break;
350 }
351
352 if (mmc_card_uhs(card) &&
353 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
354 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
355
356 if (mmc_host_is_spi(card->host)) {
357 pr_info("%s: new %s%s%s card on SPI\n",
358 mmc_hostname(card->host),
359 mmc_card_hs(card) ? "high speed " : "",
360 mmc_card_ddr52(card) ? "DDR " : "",
361 type);
362 } else {
363 pr_info("%s: new %s%s%s%s%s%s card at address %04x\n",
364 mmc_hostname(card->host),
365 mmc_card_uhs(card) ? "ultra high speed " :
366 (mmc_card_hs(card) ? "high speed " : ""),
367 mmc_card_hs400(card) ? "HS400 " :
368 (mmc_card_hs200(card) ? "HS200 " : ""),
369 mmc_card_hs400es(card) ? "Enhanced strobe " : "",
370 mmc_card_ddr52(card) ? "DDR " : "",
371 uhs_bus_speed_mode, type, card->rca);
372 }
373
374#ifdef CONFIG_DEBUG_FS
375 mmc_add_card_debugfs(card);
376#endif
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 return 0;
388}
389
390/*
391 * Unregister a new MMC card with the driver model, and
392 * (eventually) free it.
393 */
394void mmc_remove_card(struct mmc_card *card)
395{
396 struct mmc_host *host = card->host;
397
398#ifdef CONFIG_DEBUG_FS
399 mmc_remove_card_debugfs(card);
400#endif
401
402 if (mmc_card_present(card)) {
403 if (mmc_host_is_spi(card->host)) {
404 pr_info("%s: SPI card removed\n",
405 mmc_hostname(card->host));
406 } else {
407 pr_info("%s: card %04x removed\n",
408 mmc_hostname(card->host), card->rca);
409 }
410 device_del(&card->dev);
411 of_node_put(card->dev.of_node);
412 }
413
414 if (host->cqe_enabled) {
415 host->cqe_ops->cqe_disable(host);
416 host->cqe_enabled = false;
417 }
418
419 put_device(&card->dev);
420}