Loading...
1/*
2 * linux/drivers/mmc/core/sdio_bus.c
3 *
4 * Copyright 2007 Pierre Ossman
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
10 *
11 * SDIO function driver model
12 */
13
14#include <linux/device.h>
15#include <linux/err.h>
16#include <linux/export.h>
17#include <linux/slab.h>
18#include <linux/pm_runtime.h>
19#include <linux/acpi.h>
20
21#include <linux/mmc/card.h>
22#include <linux/mmc/host.h>
23#include <linux/mmc/sdio_func.h>
24
25#include "sdio_cis.h"
26#include "sdio_bus.h"
27
28/* show configuration fields */
29#define sdio_config_attr(field, format_string) \
30static ssize_t \
31field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
32{ \
33 struct sdio_func *func; \
34 \
35 func = dev_to_sdio_func (dev); \
36 return sprintf (buf, format_string, func->field); \
37} \
38static DEVICE_ATTR_RO(field)
39
40sdio_config_attr(class, "0x%02x\n");
41sdio_config_attr(vendor, "0x%04x\n");
42sdio_config_attr(device, "0x%04x\n");
43
44static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
45{
46 struct sdio_func *func = dev_to_sdio_func (dev);
47
48 return sprintf(buf, "sdio:c%02Xv%04Xd%04X\n",
49 func->class, func->vendor, func->device);
50}
51static DEVICE_ATTR_RO(modalias);
52
53static struct attribute *sdio_dev_attrs[] = {
54 &dev_attr_class.attr,
55 &dev_attr_vendor.attr,
56 &dev_attr_device.attr,
57 &dev_attr_modalias.attr,
58 NULL,
59};
60ATTRIBUTE_GROUPS(sdio_dev);
61
62static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
63 const struct sdio_device_id *id)
64{
65 if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
66 return NULL;
67 if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
68 return NULL;
69 if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
70 return NULL;
71 return id;
72}
73
74static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
75 struct sdio_driver *sdrv)
76{
77 const struct sdio_device_id *ids;
78
79 ids = sdrv->id_table;
80
81 if (ids) {
82 while (ids->class || ids->vendor || ids->device) {
83 if (sdio_match_one(func, ids))
84 return ids;
85 ids++;
86 }
87 }
88
89 return NULL;
90}
91
92static int sdio_bus_match(struct device *dev, struct device_driver *drv)
93{
94 struct sdio_func *func = dev_to_sdio_func(dev);
95 struct sdio_driver *sdrv = to_sdio_driver(drv);
96
97 if (sdio_match_device(func, sdrv))
98 return 1;
99
100 return 0;
101}
102
103static int
104sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
105{
106 struct sdio_func *func = dev_to_sdio_func(dev);
107
108 if (add_uevent_var(env,
109 "SDIO_CLASS=%02X", func->class))
110 return -ENOMEM;
111
112 if (add_uevent_var(env,
113 "SDIO_ID=%04X:%04X", func->vendor, func->device))
114 return -ENOMEM;
115
116 if (add_uevent_var(env,
117 "MODALIAS=sdio:c%02Xv%04Xd%04X",
118 func->class, func->vendor, func->device))
119 return -ENOMEM;
120
121 return 0;
122}
123
124static int sdio_bus_probe(struct device *dev)
125{
126 struct sdio_driver *drv = to_sdio_driver(dev->driver);
127 struct sdio_func *func = dev_to_sdio_func(dev);
128 const struct sdio_device_id *id;
129 int ret;
130
131 id = sdio_match_device(func, drv);
132 if (!id)
133 return -ENODEV;
134
135 /* Unbound SDIO functions are always suspended.
136 * During probe, the function is set active and the usage count
137 * is incremented. If the driver supports runtime PM,
138 * it should call pm_runtime_put_noidle() in its probe routine and
139 * pm_runtime_get_noresume() in its remove routine.
140 */
141 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
142 ret = pm_runtime_get_sync(dev);
143 if (ret < 0)
144 goto disable_runtimepm;
145 }
146
147 /* Set the default block size so the driver is sure it's something
148 * sensible. */
149 sdio_claim_host(func);
150 ret = sdio_set_block_size(func, 0);
151 sdio_release_host(func);
152 if (ret)
153 goto disable_runtimepm;
154
155 ret = drv->probe(func, id);
156 if (ret)
157 goto disable_runtimepm;
158
159 return 0;
160
161disable_runtimepm:
162 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
163 pm_runtime_put_noidle(dev);
164 return ret;
165}
166
167static int sdio_bus_remove(struct device *dev)
168{
169 struct sdio_driver *drv = to_sdio_driver(dev->driver);
170 struct sdio_func *func = dev_to_sdio_func(dev);
171 int ret = 0;
172
173 /* Make sure card is powered before invoking ->remove() */
174 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
175 pm_runtime_get_sync(dev);
176
177 drv->remove(func);
178
179 if (func->irq_handler) {
180 pr_warning("WARNING: driver %s did not remove "
181 "its interrupt handler!\n", drv->name);
182 sdio_claim_host(func);
183 sdio_release_irq(func);
184 sdio_release_host(func);
185 }
186
187 /* First, undo the increment made directly above */
188 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
189 pm_runtime_put_noidle(dev);
190
191 /* Then undo the runtime PM settings in sdio_bus_probe() */
192 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
193 pm_runtime_put_sync(dev);
194
195 return ret;
196}
197
198#ifdef CONFIG_PM
199
200#ifdef CONFIG_PM_SLEEP
201static int pm_no_operation(struct device *dev)
202{
203 /*
204 * Prevent the PM core from calling SDIO device drivers' suspend
205 * callback routines, which it is not supposed to do, by using this
206 * empty function as the bus type suspend callaback for SDIO.
207 */
208 return 0;
209}
210#endif
211
212static const struct dev_pm_ops sdio_bus_pm_ops = {
213 SET_SYSTEM_SLEEP_PM_OPS(pm_no_operation, pm_no_operation)
214 SET_RUNTIME_PM_OPS(
215 pm_generic_runtime_suspend,
216 pm_generic_runtime_resume,
217 NULL
218 )
219};
220
221#define SDIO_PM_OPS_PTR (&sdio_bus_pm_ops)
222
223#else /* !CONFIG_PM */
224
225#define SDIO_PM_OPS_PTR NULL
226
227#endif /* !CONFIG_PM */
228
229static struct bus_type sdio_bus_type = {
230 .name = "sdio",
231 .dev_groups = sdio_dev_groups,
232 .match = sdio_bus_match,
233 .uevent = sdio_bus_uevent,
234 .probe = sdio_bus_probe,
235 .remove = sdio_bus_remove,
236 .pm = SDIO_PM_OPS_PTR,
237};
238
239int sdio_register_bus(void)
240{
241 return bus_register(&sdio_bus_type);
242}
243
244void sdio_unregister_bus(void)
245{
246 bus_unregister(&sdio_bus_type);
247}
248
249/**
250 * sdio_register_driver - register a function driver
251 * @drv: SDIO function driver
252 */
253int sdio_register_driver(struct sdio_driver *drv)
254{
255 drv->drv.name = drv->name;
256 drv->drv.bus = &sdio_bus_type;
257 return driver_register(&drv->drv);
258}
259EXPORT_SYMBOL_GPL(sdio_register_driver);
260
261/**
262 * sdio_unregister_driver - unregister a function driver
263 * @drv: SDIO function driver
264 */
265void sdio_unregister_driver(struct sdio_driver *drv)
266{
267 drv->drv.bus = &sdio_bus_type;
268 driver_unregister(&drv->drv);
269}
270EXPORT_SYMBOL_GPL(sdio_unregister_driver);
271
272static void sdio_release_func(struct device *dev)
273{
274 struct sdio_func *func = dev_to_sdio_func(dev);
275
276 sdio_free_func_cis(func);
277
278 kfree(func->info);
279
280 kfree(func);
281}
282
283/*
284 * Allocate and initialise a new SDIO function structure.
285 */
286struct sdio_func *sdio_alloc_func(struct mmc_card *card)
287{
288 struct sdio_func *func;
289
290 func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
291 if (!func)
292 return ERR_PTR(-ENOMEM);
293
294 func->card = card;
295
296 device_initialize(&func->dev);
297
298 func->dev.parent = &card->dev;
299 func->dev.bus = &sdio_bus_type;
300 func->dev.release = sdio_release_func;
301
302 return func;
303}
304
305#ifdef CONFIG_ACPI
306static void sdio_acpi_set_handle(struct sdio_func *func)
307{
308 struct mmc_host *host = func->card->host;
309 u64 addr = (host->slotno << 16) | func->num;
310
311 acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
312}
313#else
314static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
315#endif
316
317/*
318 * Register a new SDIO function with the driver model.
319 */
320int sdio_add_func(struct sdio_func *func)
321{
322 int ret;
323
324 dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
325
326 sdio_acpi_set_handle(func);
327 ret = device_add(&func->dev);
328 if (ret == 0) {
329 sdio_func_set_present(func);
330 acpi_dev_pm_attach(&func->dev, false);
331 }
332
333 return ret;
334}
335
336/*
337 * Unregister a SDIO function with the driver model, and
338 * (eventually) free it.
339 * This function can be called through error paths where sdio_add_func() was
340 * never executed (because a failure occurred at an earlier point).
341 */
342void sdio_remove_func(struct sdio_func *func)
343{
344 if (!sdio_func_present(func))
345 return;
346
347 acpi_dev_pm_detach(&func->dev, false);
348 device_del(&func->dev);
349 put_device(&func->dev);
350}
351
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * linux/drivers/mmc/core/sdio_bus.c
4 *
5 * Copyright 2007 Pierre Ossman
6 *
7 * SDIO function driver model
8 */
9
10#include <linux/device.h>
11#include <linux/err.h>
12#include <linux/export.h>
13#include <linux/slab.h>
14#include <linux/pm_runtime.h>
15#include <linux/pm_domain.h>
16#include <linux/acpi.h>
17
18#include <linux/mmc/card.h>
19#include <linux/mmc/host.h>
20#include <linux/mmc/sdio_func.h>
21#include <linux/of.h>
22
23#include "core.h"
24#include "card.h"
25#include "sdio_cis.h"
26#include "sdio_bus.h"
27
28#define to_sdio_driver(d) container_of(d, struct sdio_driver, drv)
29
30/* show configuration fields */
31#define sdio_config_attr(field, format_string, args...) \
32static ssize_t \
33field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
34{ \
35 struct sdio_func *func; \
36 \
37 func = dev_to_sdio_func (dev); \
38 return sprintf(buf, format_string, args); \
39} \
40static DEVICE_ATTR_RO(field)
41
42sdio_config_attr(class, "0x%02x\n", func->class);
43sdio_config_attr(vendor, "0x%04x\n", func->vendor);
44sdio_config_attr(device, "0x%04x\n", func->device);
45sdio_config_attr(revision, "%u.%u\n", func->major_rev, func->minor_rev);
46sdio_config_attr(modalias, "sdio:c%02Xv%04Xd%04X\n", func->class, func->vendor, func->device);
47
48#define sdio_info_attr(num) \
49static ssize_t info##num##_show(struct device *dev, struct device_attribute *attr, char *buf) \
50{ \
51 struct sdio_func *func = dev_to_sdio_func(dev); \
52 \
53 if (num > func->num_info) \
54 return -ENODATA; \
55 if (!func->info[num-1][0]) \
56 return 0; \
57 return sprintf(buf, "%s\n", func->info[num-1]); \
58} \
59static DEVICE_ATTR_RO(info##num)
60
61sdio_info_attr(1);
62sdio_info_attr(2);
63sdio_info_attr(3);
64sdio_info_attr(4);
65
66static struct attribute *sdio_dev_attrs[] = {
67 &dev_attr_class.attr,
68 &dev_attr_vendor.attr,
69 &dev_attr_device.attr,
70 &dev_attr_revision.attr,
71 &dev_attr_info1.attr,
72 &dev_attr_info2.attr,
73 &dev_attr_info3.attr,
74 &dev_attr_info4.attr,
75 &dev_attr_modalias.attr,
76 NULL,
77};
78ATTRIBUTE_GROUPS(sdio_dev);
79
80static const struct sdio_device_id *sdio_match_one(struct sdio_func *func,
81 const struct sdio_device_id *id)
82{
83 if (id->class != (__u8)SDIO_ANY_ID && id->class != func->class)
84 return NULL;
85 if (id->vendor != (__u16)SDIO_ANY_ID && id->vendor != func->vendor)
86 return NULL;
87 if (id->device != (__u16)SDIO_ANY_ID && id->device != func->device)
88 return NULL;
89 return id;
90}
91
92static const struct sdio_device_id *sdio_match_device(struct sdio_func *func,
93 struct sdio_driver *sdrv)
94{
95 const struct sdio_device_id *ids;
96
97 ids = sdrv->id_table;
98
99 if (ids) {
100 while (ids->class || ids->vendor || ids->device) {
101 if (sdio_match_one(func, ids))
102 return ids;
103 ids++;
104 }
105 }
106
107 return NULL;
108}
109
110static int sdio_bus_match(struct device *dev, struct device_driver *drv)
111{
112 struct sdio_func *func = dev_to_sdio_func(dev);
113 struct sdio_driver *sdrv = to_sdio_driver(drv);
114
115 if (sdio_match_device(func, sdrv))
116 return 1;
117
118 return 0;
119}
120
121static int
122sdio_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
123{
124 struct sdio_func *func = dev_to_sdio_func(dev);
125 unsigned int i;
126
127 if (add_uevent_var(env,
128 "SDIO_CLASS=%02X", func->class))
129 return -ENOMEM;
130
131 if (add_uevent_var(env,
132 "SDIO_ID=%04X:%04X", func->vendor, func->device))
133 return -ENOMEM;
134
135 if (add_uevent_var(env,
136 "SDIO_REVISION=%u.%u", func->major_rev, func->minor_rev))
137 return -ENOMEM;
138
139 for (i = 0; i < func->num_info; i++) {
140 if (add_uevent_var(env, "SDIO_INFO%u=%s", i+1, func->info[i]))
141 return -ENOMEM;
142 }
143
144 if (add_uevent_var(env,
145 "MODALIAS=sdio:c%02Xv%04Xd%04X",
146 func->class, func->vendor, func->device))
147 return -ENOMEM;
148
149 return 0;
150}
151
152static int sdio_bus_probe(struct device *dev)
153{
154 struct sdio_driver *drv = to_sdio_driver(dev->driver);
155 struct sdio_func *func = dev_to_sdio_func(dev);
156 const struct sdio_device_id *id;
157 int ret;
158
159 id = sdio_match_device(func, drv);
160 if (!id)
161 return -ENODEV;
162
163 ret = dev_pm_domain_attach(dev, false);
164 if (ret)
165 return ret;
166
167 atomic_inc(&func->card->sdio_funcs_probed);
168
169 /* Unbound SDIO functions are always suspended.
170 * During probe, the function is set active and the usage count
171 * is incremented. If the driver supports runtime PM,
172 * it should call pm_runtime_put_noidle() in its probe routine and
173 * pm_runtime_get_noresume() in its remove routine.
174 */
175 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD) {
176 ret = pm_runtime_get_sync(dev);
177 if (ret < 0)
178 goto disable_runtimepm;
179 }
180
181 /* Set the default block size so the driver is sure it's something
182 * sensible. */
183 sdio_claim_host(func);
184 if (mmc_card_removed(func->card))
185 ret = -ENOMEDIUM;
186 else
187 ret = sdio_set_block_size(func, 0);
188 sdio_release_host(func);
189 if (ret)
190 goto disable_runtimepm;
191
192 ret = drv->probe(func, id);
193 if (ret)
194 goto disable_runtimepm;
195
196 return 0;
197
198disable_runtimepm:
199 atomic_dec(&func->card->sdio_funcs_probed);
200 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
201 pm_runtime_put_noidle(dev);
202 dev_pm_domain_detach(dev, false);
203 return ret;
204}
205
206static int sdio_bus_remove(struct device *dev)
207{
208 struct sdio_driver *drv = to_sdio_driver(dev->driver);
209 struct sdio_func *func = dev_to_sdio_func(dev);
210
211 /* Make sure card is powered before invoking ->remove() */
212 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
213 pm_runtime_get_sync(dev);
214
215 drv->remove(func);
216 atomic_dec(&func->card->sdio_funcs_probed);
217
218 if (func->irq_handler) {
219 pr_warn("WARNING: driver %s did not remove its interrupt handler!\n",
220 drv->name);
221 sdio_claim_host(func);
222 sdio_release_irq(func);
223 sdio_release_host(func);
224 }
225
226 /* First, undo the increment made directly above */
227 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
228 pm_runtime_put_noidle(dev);
229
230 /* Then undo the runtime PM settings in sdio_bus_probe() */
231 if (func->card->host->caps & MMC_CAP_POWER_OFF_CARD)
232 pm_runtime_put_sync(dev);
233
234 dev_pm_domain_detach(dev, false);
235
236 return 0;
237}
238
239static const struct dev_pm_ops sdio_bus_pm_ops = {
240 SET_SYSTEM_SLEEP_PM_OPS(pm_generic_suspend, pm_generic_resume)
241 SET_RUNTIME_PM_OPS(
242 pm_generic_runtime_suspend,
243 pm_generic_runtime_resume,
244 NULL
245 )
246};
247
248static struct bus_type sdio_bus_type = {
249 .name = "sdio",
250 .dev_groups = sdio_dev_groups,
251 .match = sdio_bus_match,
252 .uevent = sdio_bus_uevent,
253 .probe = sdio_bus_probe,
254 .remove = sdio_bus_remove,
255 .pm = &sdio_bus_pm_ops,
256};
257
258int sdio_register_bus(void)
259{
260 return bus_register(&sdio_bus_type);
261}
262
263void sdio_unregister_bus(void)
264{
265 bus_unregister(&sdio_bus_type);
266}
267
268/**
269 * sdio_register_driver - register a function driver
270 * @drv: SDIO function driver
271 */
272int sdio_register_driver(struct sdio_driver *drv)
273{
274 drv->drv.name = drv->name;
275 drv->drv.bus = &sdio_bus_type;
276 return driver_register(&drv->drv);
277}
278EXPORT_SYMBOL_GPL(sdio_register_driver);
279
280/**
281 * sdio_unregister_driver - unregister a function driver
282 * @drv: SDIO function driver
283 */
284void sdio_unregister_driver(struct sdio_driver *drv)
285{
286 drv->drv.bus = &sdio_bus_type;
287 driver_unregister(&drv->drv);
288}
289EXPORT_SYMBOL_GPL(sdio_unregister_driver);
290
291static void sdio_release_func(struct device *dev)
292{
293 struct sdio_func *func = dev_to_sdio_func(dev);
294
295 sdio_free_func_cis(func);
296
297 kfree(func->info);
298 kfree(func->tmpbuf);
299 kfree(func);
300}
301
302/*
303 * Allocate and initialise a new SDIO function structure.
304 */
305struct sdio_func *sdio_alloc_func(struct mmc_card *card)
306{
307 struct sdio_func *func;
308
309 func = kzalloc(sizeof(struct sdio_func), GFP_KERNEL);
310 if (!func)
311 return ERR_PTR(-ENOMEM);
312
313 /*
314 * allocate buffer separately to make sure it's properly aligned for
315 * DMA usage (incl. 64 bit DMA)
316 */
317 func->tmpbuf = kmalloc(4, GFP_KERNEL);
318 if (!func->tmpbuf) {
319 kfree(func);
320 return ERR_PTR(-ENOMEM);
321 }
322
323 func->card = card;
324
325 device_initialize(&func->dev);
326
327 func->dev.parent = &card->dev;
328 func->dev.bus = &sdio_bus_type;
329 func->dev.release = sdio_release_func;
330
331 return func;
332}
333
334#ifdef CONFIG_ACPI
335static void sdio_acpi_set_handle(struct sdio_func *func)
336{
337 struct mmc_host *host = func->card->host;
338 u64 addr = ((u64)host->slotno << 16) | func->num;
339
340 acpi_preset_companion(&func->dev, ACPI_COMPANION(host->parent), addr);
341}
342#else
343static inline void sdio_acpi_set_handle(struct sdio_func *func) {}
344#endif
345
346static void sdio_set_of_node(struct sdio_func *func)
347{
348 struct mmc_host *host = func->card->host;
349
350 func->dev.of_node = mmc_of_find_child_device(host, func->num);
351}
352
353/*
354 * Register a new SDIO function with the driver model.
355 */
356int sdio_add_func(struct sdio_func *func)
357{
358 int ret;
359
360 dev_set_name(&func->dev, "%s:%d", mmc_card_id(func->card), func->num);
361
362 sdio_set_of_node(func);
363 sdio_acpi_set_handle(func);
364 device_enable_async_suspend(&func->dev);
365 ret = device_add(&func->dev);
366 if (ret == 0)
367 sdio_func_set_present(func);
368
369 return ret;
370}
371
372/*
373 * Unregister a SDIO function with the driver model, and
374 * (eventually) free it.
375 * This function can be called through error paths where sdio_add_func() was
376 * never executed (because a failure occurred at an earlier point).
377 */
378void sdio_remove_func(struct sdio_func *func)
379{
380 if (!sdio_func_present(func))
381 return;
382
383 device_del(&func->dev);
384 of_node_put(func->dev.of_node);
385 put_device(&func->dev);
386}
387