mmc: core: Add bus_ops for runtime pm callbacks
[firefly-linux-kernel-4.4.55.git] / drivers / mmc / core / bus.c
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 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
49 static 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  */
59 static int mmc_bus_match(struct device *dev, struct device_driver *drv)
60 {
61         return 1;
62 }
63
64 static int
65 mmc_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
107 static 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
115 static 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
126 static 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
137 static 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
151 static int mmc_runtime_suspend(struct device *dev)
152 {
153         struct mmc_card *card = mmc_dev_to_card(dev);
154         struct mmc_host *host = card->host;
155         int ret = 0;
156
157         if (host->bus_ops->runtime_suspend)
158                 ret = host->bus_ops->runtime_suspend(host);
159
160         return ret;
161 }
162
163 static int mmc_runtime_resume(struct device *dev)
164 {
165         struct mmc_card *card = mmc_dev_to_card(dev);
166         struct mmc_host *host = card->host;
167         int ret = 0;
168
169         if (host->bus_ops->runtime_resume)
170                 ret = host->bus_ops->runtime_resume(host);
171
172         return ret;
173 }
174
175 static int mmc_runtime_idle(struct device *dev)
176 {
177         return pm_runtime_suspend(dev);
178 }
179
180 #endif /* !CONFIG_PM_RUNTIME */
181
182 static const struct dev_pm_ops mmc_bus_pm_ops = {
183         SET_RUNTIME_PM_OPS(mmc_runtime_suspend, mmc_runtime_resume,
184                         mmc_runtime_idle)
185         SET_SYSTEM_SLEEP_PM_OPS(mmc_bus_suspend, mmc_bus_resume)
186 };
187
188 static struct bus_type mmc_bus_type = {
189         .name           = "mmc",
190         .dev_attrs      = mmc_dev_attrs,
191         .match          = mmc_bus_match,
192         .uevent         = mmc_bus_uevent,
193         .probe          = mmc_bus_probe,
194         .remove         = mmc_bus_remove,
195         .pm             = &mmc_bus_pm_ops,
196 };
197
198 int mmc_register_bus(void)
199 {
200         return bus_register(&mmc_bus_type);
201 }
202
203 void mmc_unregister_bus(void)
204 {
205         bus_unregister(&mmc_bus_type);
206 }
207
208 /**
209  *      mmc_register_driver - register a media driver
210  *      @drv: MMC media driver
211  */
212 int mmc_register_driver(struct mmc_driver *drv)
213 {
214         drv->drv.bus = &mmc_bus_type;
215         return driver_register(&drv->drv);
216 }
217
218 EXPORT_SYMBOL(mmc_register_driver);
219
220 /**
221  *      mmc_unregister_driver - unregister a media driver
222  *      @drv: MMC media driver
223  */
224 void mmc_unregister_driver(struct mmc_driver *drv)
225 {
226         drv->drv.bus = &mmc_bus_type;
227         driver_unregister(&drv->drv);
228 }
229
230 EXPORT_SYMBOL(mmc_unregister_driver);
231
232 static void mmc_release_card(struct device *dev)
233 {
234         struct mmc_card *card = mmc_dev_to_card(dev);
235
236         sdio_free_common_cis(card);
237
238         kfree(card->info);
239
240         kfree(card);
241 }
242
243 /*
244  * Allocate and initialise a new MMC card structure.
245  */
246 struct mmc_card *mmc_alloc_card(struct mmc_host *host, struct device_type *type)
247 {
248         struct mmc_card *card;
249
250         card = kzalloc(sizeof(struct mmc_card), GFP_KERNEL);
251         if (!card)
252                 return ERR_PTR(-ENOMEM);
253
254         card->host = host;
255
256         device_initialize(&card->dev);
257
258         card->dev.parent = mmc_classdev(host);
259         card->dev.bus = &mmc_bus_type;
260         card->dev.release = mmc_release_card;
261         card->dev.type = type;
262
263         return card;
264 }
265
266 /*
267  * Register a new MMC card with the driver model.
268  */
269 int mmc_add_card(struct mmc_card *card)
270 {
271         int ret;
272         const char *type;
273         const char *uhs_bus_speed_mode = "";
274         static const char *const uhs_speeds[] = {
275                 [UHS_SDR12_BUS_SPEED] = "SDR12 ",
276                 [UHS_SDR25_BUS_SPEED] = "SDR25 ",
277                 [UHS_SDR50_BUS_SPEED] = "SDR50 ",
278                 [UHS_SDR104_BUS_SPEED] = "SDR104 ",
279                 [UHS_DDR50_BUS_SPEED] = "DDR50 ",
280         };
281
282
283         dev_set_name(&card->dev, "%s:%04x", mmc_hostname(card->host), card->rca);
284
285         switch (card->type) {
286         case MMC_TYPE_MMC:
287                 type = "MMC";
288                 break;
289         case MMC_TYPE_SD:
290                 type = "SD";
291                 if (mmc_card_blockaddr(card)) {
292                         if (mmc_card_ext_capacity(card))
293                                 type = "SDXC";
294                         else
295                                 type = "SDHC";
296                 }
297                 break;
298         case MMC_TYPE_SDIO:
299                 type = "SDIO";
300                 break;
301         case MMC_TYPE_SD_COMBO:
302                 type = "SD-combo";
303                 if (mmc_card_blockaddr(card))
304                         type = "SDHC-combo";
305                 break;
306         default:
307                 type = "?";
308                 break;
309         }
310
311         if (mmc_sd_card_uhs(card) &&
312                 (card->sd_bus_speed < ARRAY_SIZE(uhs_speeds)))
313                 uhs_bus_speed_mode = uhs_speeds[card->sd_bus_speed];
314
315         if (mmc_host_is_spi(card->host)) {
316                 pr_info("%s: new %s%s%s card on SPI\n",
317                         mmc_hostname(card->host),
318                         mmc_card_highspeed(card) ? "high speed " : "",
319                         mmc_card_ddr_mode(card) ? "DDR " : "",
320                         type);
321         } else {
322                 pr_info("%s: new %s%s%s%s%s card at address %04x\n",
323                         mmc_hostname(card->host),
324                         mmc_card_uhs(card) ? "ultra high speed " :
325                         (mmc_card_highspeed(card) ? "high speed " : ""),
326                         (mmc_card_hs200(card) ? "HS200 " : ""),
327                         mmc_card_ddr_mode(card) ? "DDR " : "",
328                         uhs_bus_speed_mode, type, card->rca);
329         }
330
331 #ifdef CONFIG_DEBUG_FS
332         mmc_add_card_debugfs(card);
333 #endif
334         mmc_init_context_info(card->host);
335
336         ret = device_add(&card->dev);
337         if (ret)
338                 return ret;
339
340         mmc_card_set_present(card);
341
342         return 0;
343 }
344
345 /*
346  * Unregister a new MMC card with the driver model, and
347  * (eventually) free it.
348  */
349 void mmc_remove_card(struct mmc_card *card)
350 {
351 #ifdef CONFIG_DEBUG_FS
352         mmc_remove_card_debugfs(card);
353 #endif
354
355         if (mmc_card_present(card)) {
356                 if (mmc_host_is_spi(card->host)) {
357                         pr_info("%s: SPI card removed\n",
358                                 mmc_hostname(card->host));
359                 } else {
360                         pr_info("%s: card %04x removed\n",
361                                 mmc_hostname(card->host), card->rca);
362                 }
363                 device_del(&card->dev);
364         }
365
366         put_device(&card->dev);
367 }
368