Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * drivers/base/core.c - core driver model code (device registration, etc) | |
3 | * | |
4 | * Copyright (c) 2002-3 Patrick Mochel | |
5 | * Copyright (c) 2002-3 Open Source Development Labs | |
64bb5d2c GKH |
6 | * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de> |
7 | * Copyright (c) 2006 Novell, Inc. | |
1da177e4 LT |
8 | * |
9 | * This file is released under the GPLv2 | |
10 | * | |
11 | */ | |
12 | ||
1da177e4 LT |
13 | #include <linux/device.h> |
14 | #include <linux/err.h> | |
15 | #include <linux/init.h> | |
16 | #include <linux/module.h> | |
17 | #include <linux/slab.h> | |
18 | #include <linux/string.h> | |
23681e47 | 19 | #include <linux/kdev_t.h> |
116af378 | 20 | #include <linux/notifier.h> |
da231fd5 | 21 | #include <linux/genhd.h> |
815d2d50 | 22 | #include <linux/kallsyms.h> |
6188e10d | 23 | #include <linux/semaphore.h> |
f75b1c60 | 24 | #include <linux/mutex.h> |
1da177e4 LT |
25 | |
26 | #include "base.h" | |
27 | #include "power/power.h" | |
28 | ||
4a3ad20c GKH |
29 | int (*platform_notify)(struct device *dev) = NULL; |
30 | int (*platform_notify_remove)(struct device *dev) = NULL; | |
e105b8bf DW |
31 | static struct kobject *dev_kobj; |
32 | struct kobject *sysfs_dev_char_kobj; | |
33 | struct kobject *sysfs_dev_block_kobj; | |
1da177e4 | 34 | |
4e886c29 GKH |
35 | #ifdef CONFIG_BLOCK |
36 | static inline int device_is_not_partition(struct device *dev) | |
37 | { | |
38 | return !(dev->type == &part_type); | |
39 | } | |
40 | #else | |
41 | static inline int device_is_not_partition(struct device *dev) | |
42 | { | |
43 | return 1; | |
44 | } | |
45 | #endif | |
1da177e4 | 46 | |
3e95637a AS |
47 | /** |
48 | * dev_driver_string - Return a device's driver name, if at all possible | |
49 | * @dev: struct device to get the name of | |
50 | * | |
51 | * Will return the device's driver's name if it is bound to a device. If | |
52 | * the device is not bound to a device, it will return the name of the bus | |
53 | * it is attached to. If it is not attached to a bus either, an empty | |
54 | * string will be returned. | |
55 | */ | |
bf9ca69f | 56 | const char *dev_driver_string(const struct device *dev) |
3e95637a AS |
57 | { |
58 | return dev->driver ? dev->driver->name : | |
a456b702 JD |
59 | (dev->bus ? dev->bus->name : |
60 | (dev->class ? dev->class->name : "")); | |
3e95637a | 61 | } |
310a922d | 62 | EXPORT_SYMBOL(dev_driver_string); |
3e95637a | 63 | |
1da177e4 LT |
64 | #define to_dev(obj) container_of(obj, struct device, kobj) |
65 | #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr) | |
66 | ||
4a3ad20c GKH |
67 | static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr, |
68 | char *buf) | |
1da177e4 | 69 | { |
4a3ad20c GKH |
70 | struct device_attribute *dev_attr = to_dev_attr(attr); |
71 | struct device *dev = to_dev(kobj); | |
4a0c20bf | 72 | ssize_t ret = -EIO; |
1da177e4 LT |
73 | |
74 | if (dev_attr->show) | |
54b6f35c | 75 | ret = dev_attr->show(dev, dev_attr, buf); |
815d2d50 AM |
76 | if (ret >= (ssize_t)PAGE_SIZE) { |
77 | print_symbol("dev_attr_show: %s returned bad count\n", | |
78 | (unsigned long)dev_attr->show); | |
79 | } | |
1da177e4 LT |
80 | return ret; |
81 | } | |
82 | ||
4a3ad20c GKH |
83 | static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr, |
84 | const char *buf, size_t count) | |
1da177e4 | 85 | { |
4a3ad20c GKH |
86 | struct device_attribute *dev_attr = to_dev_attr(attr); |
87 | struct device *dev = to_dev(kobj); | |
4a0c20bf | 88 | ssize_t ret = -EIO; |
1da177e4 LT |
89 | |
90 | if (dev_attr->store) | |
54b6f35c | 91 | ret = dev_attr->store(dev, dev_attr, buf, count); |
1da177e4 LT |
92 | return ret; |
93 | } | |
94 | ||
95 | static struct sysfs_ops dev_sysfs_ops = { | |
96 | .show = dev_attr_show, | |
97 | .store = dev_attr_store, | |
98 | }; | |
99 | ||
100 | ||
101 | /** | |
102 | * device_release - free device structure. | |
103 | * @kobj: device's kobject. | |
104 | * | |
105 | * This is called once the reference count for the object | |
106 | * reaches 0. We forward the call to the device's release | |
107 | * method, which should handle actually freeing the structure. | |
108 | */ | |
4a3ad20c | 109 | static void device_release(struct kobject *kobj) |
1da177e4 | 110 | { |
4a3ad20c | 111 | struct device *dev = to_dev(kobj); |
1da177e4 LT |
112 | |
113 | if (dev->release) | |
114 | dev->release(dev); | |
f9f852df KS |
115 | else if (dev->type && dev->type->release) |
116 | dev->type->release(dev); | |
2620efef GKH |
117 | else if (dev->class && dev->class->dev_release) |
118 | dev->class->dev_release(dev); | |
f810a5cf AV |
119 | else |
120 | WARN(1, KERN_ERR "Device '%s' does not have a release() " | |
4a3ad20c | 121 | "function, it is broken and must be fixed.\n", |
1da177e4 | 122 | dev->bus_id); |
1da177e4 LT |
123 | } |
124 | ||
8f4afc41 | 125 | static struct kobj_type device_ktype = { |
1da177e4 LT |
126 | .release = device_release, |
127 | .sysfs_ops = &dev_sysfs_ops, | |
1da177e4 LT |
128 | }; |
129 | ||
130 | ||
312c004d | 131 | static int dev_uevent_filter(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
132 | { |
133 | struct kobj_type *ktype = get_ktype(kobj); | |
134 | ||
8f4afc41 | 135 | if (ktype == &device_ktype) { |
1da177e4 | 136 | struct device *dev = to_dev(kobj); |
83b5fb4c CH |
137 | if (dev->uevent_suppress) |
138 | return 0; | |
1da177e4 LT |
139 | if (dev->bus) |
140 | return 1; | |
23681e47 GKH |
141 | if (dev->class) |
142 | return 1; | |
1da177e4 LT |
143 | } |
144 | return 0; | |
145 | } | |
146 | ||
312c004d | 147 | static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
148 | { |
149 | struct device *dev = to_dev(kobj); | |
150 | ||
23681e47 GKH |
151 | if (dev->bus) |
152 | return dev->bus->name; | |
153 | if (dev->class) | |
154 | return dev->class->name; | |
155 | return NULL; | |
1da177e4 LT |
156 | } |
157 | ||
7eff2e7a KS |
158 | static int dev_uevent(struct kset *kset, struct kobject *kobj, |
159 | struct kobj_uevent_env *env) | |
1da177e4 LT |
160 | { |
161 | struct device *dev = to_dev(kobj); | |
1da177e4 LT |
162 | int retval = 0; |
163 | ||
23681e47 GKH |
164 | /* add the major/minor if present */ |
165 | if (MAJOR(dev->devt)) { | |
7eff2e7a KS |
166 | add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt)); |
167 | add_uevent_var(env, "MINOR=%u", MINOR(dev->devt)); | |
23681e47 GKH |
168 | } |
169 | ||
414264f9 | 170 | if (dev->type && dev->type->name) |
7eff2e7a | 171 | add_uevent_var(env, "DEVTYPE=%s", dev->type->name); |
414264f9 | 172 | |
239378f1 | 173 | if (dev->driver) |
7eff2e7a | 174 | add_uevent_var(env, "DRIVER=%s", dev->driver->name); |
239378f1 | 175 | |
a87cb2ac | 176 | #ifdef CONFIG_SYSFS_DEPRECATED |
239378f1 KS |
177 | if (dev->class) { |
178 | struct device *parent = dev->parent; | |
179 | ||
180 | /* find first bus device in parent chain */ | |
181 | while (parent && !parent->bus) | |
182 | parent = parent->parent; | |
183 | if (parent && parent->bus) { | |
184 | const char *path; | |
185 | ||
186 | path = kobject_get_path(&parent->kobj, GFP_KERNEL); | |
2c7afd12 | 187 | if (path) { |
7eff2e7a | 188 | add_uevent_var(env, "PHYSDEVPATH=%s", path); |
2c7afd12 KS |
189 | kfree(path); |
190 | } | |
239378f1 | 191 | |
7eff2e7a | 192 | add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name); |
239378f1 KS |
193 | |
194 | if (parent->driver) | |
7eff2e7a KS |
195 | add_uevent_var(env, "PHYSDEVDRIVER=%s", |
196 | parent->driver->name); | |
239378f1 KS |
197 | } |
198 | } else if (dev->bus) { | |
7eff2e7a | 199 | add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name); |
239378f1 KS |
200 | |
201 | if (dev->driver) | |
4a3ad20c GKH |
202 | add_uevent_var(env, "PHYSDEVDRIVER=%s", |
203 | dev->driver->name); | |
d81d9d6b | 204 | } |
239378f1 | 205 | #endif |
1da177e4 | 206 | |
7eff2e7a | 207 | /* have the bus specific function add its stuff */ |
312c004d | 208 | if (dev->bus && dev->bus->uevent) { |
7eff2e7a | 209 | retval = dev->bus->uevent(dev, env); |
f9f852df | 210 | if (retval) |
7dc72b28 | 211 | pr_debug("device: '%s': %s: bus uevent() returned %d\n", |
2b3a302a | 212 | dev->bus_id, __func__, retval); |
1da177e4 LT |
213 | } |
214 | ||
7eff2e7a | 215 | /* have the class specific function add its stuff */ |
2620efef | 216 | if (dev->class && dev->class->dev_uevent) { |
7eff2e7a | 217 | retval = dev->class->dev_uevent(dev, env); |
f9f852df | 218 | if (retval) |
7dc72b28 GKH |
219 | pr_debug("device: '%s': %s: class uevent() " |
220 | "returned %d\n", dev->bus_id, | |
2b3a302a | 221 | __func__, retval); |
f9f852df KS |
222 | } |
223 | ||
7eff2e7a | 224 | /* have the device type specific fuction add its stuff */ |
f9f852df | 225 | if (dev->type && dev->type->uevent) { |
7eff2e7a | 226 | retval = dev->type->uevent(dev, env); |
f9f852df | 227 | if (retval) |
7dc72b28 GKH |
228 | pr_debug("device: '%s': %s: dev_type uevent() " |
229 | "returned %d\n", dev->bus_id, | |
2b3a302a | 230 | __func__, retval); |
2620efef GKH |
231 | } |
232 | ||
1da177e4 LT |
233 | return retval; |
234 | } | |
235 | ||
312c004d KS |
236 | static struct kset_uevent_ops device_uevent_ops = { |
237 | .filter = dev_uevent_filter, | |
238 | .name = dev_uevent_name, | |
239 | .uevent = dev_uevent, | |
1da177e4 LT |
240 | }; |
241 | ||
16574dcc KS |
242 | static ssize_t show_uevent(struct device *dev, struct device_attribute *attr, |
243 | char *buf) | |
244 | { | |
245 | struct kobject *top_kobj; | |
246 | struct kset *kset; | |
7eff2e7a | 247 | struct kobj_uevent_env *env = NULL; |
16574dcc KS |
248 | int i; |
249 | size_t count = 0; | |
250 | int retval; | |
251 | ||
252 | /* search the kset, the device belongs to */ | |
253 | top_kobj = &dev->kobj; | |
5c5daf65 KS |
254 | while (!top_kobj->kset && top_kobj->parent) |
255 | top_kobj = top_kobj->parent; | |
16574dcc KS |
256 | if (!top_kobj->kset) |
257 | goto out; | |
5c5daf65 | 258 | |
16574dcc KS |
259 | kset = top_kobj->kset; |
260 | if (!kset->uevent_ops || !kset->uevent_ops->uevent) | |
261 | goto out; | |
262 | ||
263 | /* respect filter */ | |
264 | if (kset->uevent_ops && kset->uevent_ops->filter) | |
265 | if (!kset->uevent_ops->filter(kset, &dev->kobj)) | |
266 | goto out; | |
267 | ||
7eff2e7a KS |
268 | env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL); |
269 | if (!env) | |
c7308c81 GKH |
270 | return -ENOMEM; |
271 | ||
16574dcc | 272 | /* let the kset specific function add its keys */ |
7eff2e7a | 273 | retval = kset->uevent_ops->uevent(kset, &dev->kobj, env); |
16574dcc KS |
274 | if (retval) |
275 | goto out; | |
276 | ||
277 | /* copy keys to file */ | |
7eff2e7a KS |
278 | for (i = 0; i < env->envp_idx; i++) |
279 | count += sprintf(&buf[count], "%s\n", env->envp[i]); | |
16574dcc | 280 | out: |
7eff2e7a | 281 | kfree(env); |
16574dcc KS |
282 | return count; |
283 | } | |
284 | ||
a7fd6706 KS |
285 | static ssize_t store_uevent(struct device *dev, struct device_attribute *attr, |
286 | const char *buf, size_t count) | |
287 | { | |
60a96a59 KS |
288 | enum kobject_action action; |
289 | ||
5c5daf65 | 290 | if (kobject_action_type(buf, count, &action) == 0) { |
60a96a59 KS |
291 | kobject_uevent(&dev->kobj, action); |
292 | goto out; | |
293 | } | |
294 | ||
295 | dev_err(dev, "uevent: unsupported action-string; this will " | |
296 | "be ignored in a future kernel version\n"); | |
312c004d | 297 | kobject_uevent(&dev->kobj, KOBJ_ADD); |
60a96a59 | 298 | out: |
a7fd6706 KS |
299 | return count; |
300 | } | |
301 | ||
ad6a1e1c TH |
302 | static struct device_attribute uevent_attr = |
303 | __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent); | |
304 | ||
621a1672 DT |
305 | static int device_add_attributes(struct device *dev, |
306 | struct device_attribute *attrs) | |
de0ff00d | 307 | { |
621a1672 | 308 | int error = 0; |
de0ff00d | 309 | int i; |
621a1672 DT |
310 | |
311 | if (attrs) { | |
312 | for (i = 0; attr_name(attrs[i]); i++) { | |
313 | error = device_create_file(dev, &attrs[i]); | |
314 | if (error) | |
315 | break; | |
316 | } | |
317 | if (error) | |
318 | while (--i >= 0) | |
319 | device_remove_file(dev, &attrs[i]); | |
320 | } | |
321 | return error; | |
322 | } | |
323 | ||
324 | static void device_remove_attributes(struct device *dev, | |
325 | struct device_attribute *attrs) | |
326 | { | |
327 | int i; | |
328 | ||
329 | if (attrs) | |
330 | for (i = 0; attr_name(attrs[i]); i++) | |
331 | device_remove_file(dev, &attrs[i]); | |
332 | } | |
333 | ||
334 | static int device_add_groups(struct device *dev, | |
335 | struct attribute_group **groups) | |
336 | { | |
de0ff00d | 337 | int error = 0; |
621a1672 | 338 | int i; |
de0ff00d | 339 | |
621a1672 DT |
340 | if (groups) { |
341 | for (i = 0; groups[i]; i++) { | |
342 | error = sysfs_create_group(&dev->kobj, groups[i]); | |
de0ff00d GKH |
343 | if (error) { |
344 | while (--i >= 0) | |
4a3ad20c GKH |
345 | sysfs_remove_group(&dev->kobj, |
346 | groups[i]); | |
621a1672 | 347 | break; |
de0ff00d GKH |
348 | } |
349 | } | |
350 | } | |
de0ff00d GKH |
351 | return error; |
352 | } | |
353 | ||
621a1672 DT |
354 | static void device_remove_groups(struct device *dev, |
355 | struct attribute_group **groups) | |
de0ff00d GKH |
356 | { |
357 | int i; | |
621a1672 DT |
358 | |
359 | if (groups) | |
360 | for (i = 0; groups[i]; i++) | |
361 | sysfs_remove_group(&dev->kobj, groups[i]); | |
de0ff00d GKH |
362 | } |
363 | ||
2620efef GKH |
364 | static int device_add_attrs(struct device *dev) |
365 | { | |
366 | struct class *class = dev->class; | |
f9f852df | 367 | struct device_type *type = dev->type; |
621a1672 | 368 | int error; |
2620efef | 369 | |
621a1672 DT |
370 | if (class) { |
371 | error = device_add_attributes(dev, class->dev_attrs); | |
f9f852df | 372 | if (error) |
621a1672 | 373 | return error; |
2620efef | 374 | } |
f9f852df | 375 | |
621a1672 DT |
376 | if (type) { |
377 | error = device_add_groups(dev, type->groups); | |
f9f852df | 378 | if (error) |
621a1672 | 379 | goto err_remove_class_attrs; |
f9f852df KS |
380 | } |
381 | ||
621a1672 DT |
382 | error = device_add_groups(dev, dev->groups); |
383 | if (error) | |
384 | goto err_remove_type_groups; | |
385 | ||
386 | return 0; | |
387 | ||
388 | err_remove_type_groups: | |
389 | if (type) | |
390 | device_remove_groups(dev, type->groups); | |
391 | err_remove_class_attrs: | |
392 | if (class) | |
393 | device_remove_attributes(dev, class->dev_attrs); | |
394 | ||
2620efef GKH |
395 | return error; |
396 | } | |
397 | ||
398 | static void device_remove_attrs(struct device *dev) | |
399 | { | |
400 | struct class *class = dev->class; | |
f9f852df | 401 | struct device_type *type = dev->type; |
2620efef | 402 | |
621a1672 | 403 | device_remove_groups(dev, dev->groups); |
f9f852df | 404 | |
621a1672 DT |
405 | if (type) |
406 | device_remove_groups(dev, type->groups); | |
407 | ||
408 | if (class) | |
409 | device_remove_attributes(dev, class->dev_attrs); | |
2620efef GKH |
410 | } |
411 | ||
412 | ||
23681e47 GKH |
413 | static ssize_t show_dev(struct device *dev, struct device_attribute *attr, |
414 | char *buf) | |
415 | { | |
416 | return print_dev_t(buf, dev->devt); | |
417 | } | |
418 | ||
ad6a1e1c TH |
419 | static struct device_attribute devt_attr = |
420 | __ATTR(dev, S_IRUGO, show_dev, NULL); | |
421 | ||
881c6cfd GKH |
422 | /* kset to create /sys/devices/ */ |
423 | struct kset *devices_kset; | |
1da177e4 | 424 | |
1da177e4 | 425 | /** |
4a3ad20c GKH |
426 | * device_create_file - create sysfs attribute file for device. |
427 | * @dev: device. | |
428 | * @attr: device attribute descriptor. | |
1da177e4 | 429 | */ |
4a3ad20c | 430 | int device_create_file(struct device *dev, struct device_attribute *attr) |
1da177e4 LT |
431 | { |
432 | int error = 0; | |
0c98b19f | 433 | if (dev) |
1da177e4 | 434 | error = sysfs_create_file(&dev->kobj, &attr->attr); |
1da177e4 LT |
435 | return error; |
436 | } | |
437 | ||
438 | /** | |
4a3ad20c GKH |
439 | * device_remove_file - remove sysfs attribute file. |
440 | * @dev: device. | |
441 | * @attr: device attribute descriptor. | |
1da177e4 | 442 | */ |
4a3ad20c | 443 | void device_remove_file(struct device *dev, struct device_attribute *attr) |
1da177e4 | 444 | { |
0c98b19f | 445 | if (dev) |
1da177e4 | 446 | sysfs_remove_file(&dev->kobj, &attr->attr); |
1da177e4 LT |
447 | } |
448 | ||
2589f188 GKH |
449 | /** |
450 | * device_create_bin_file - create sysfs binary attribute file for device. | |
451 | * @dev: device. | |
452 | * @attr: device binary attribute descriptor. | |
453 | */ | |
454 | int device_create_bin_file(struct device *dev, struct bin_attribute *attr) | |
455 | { | |
456 | int error = -EINVAL; | |
457 | if (dev) | |
458 | error = sysfs_create_bin_file(&dev->kobj, attr); | |
459 | return error; | |
460 | } | |
461 | EXPORT_SYMBOL_GPL(device_create_bin_file); | |
462 | ||
463 | /** | |
464 | * device_remove_bin_file - remove sysfs binary attribute file | |
465 | * @dev: device. | |
466 | * @attr: device binary attribute descriptor. | |
467 | */ | |
468 | void device_remove_bin_file(struct device *dev, struct bin_attribute *attr) | |
469 | { | |
470 | if (dev) | |
471 | sysfs_remove_bin_file(&dev->kobj, attr); | |
472 | } | |
473 | EXPORT_SYMBOL_GPL(device_remove_bin_file); | |
474 | ||
d9a9cdfb | 475 | /** |
523ded71 | 476 | * device_schedule_callback_owner - helper to schedule a callback for a device |
d9a9cdfb AS |
477 | * @dev: device. |
478 | * @func: callback function to invoke later. | |
523ded71 | 479 | * @owner: module owning the callback routine |
d9a9cdfb AS |
480 | * |
481 | * Attribute methods must not unregister themselves or their parent device | |
482 | * (which would amount to the same thing). Attempts to do so will deadlock, | |
483 | * since unregistration is mutually exclusive with driver callbacks. | |
484 | * | |
485 | * Instead methods can call this routine, which will attempt to allocate | |
486 | * and schedule a workqueue request to call back @func with @dev as its | |
487 | * argument in the workqueue's process context. @dev will be pinned until | |
488 | * @func returns. | |
489 | * | |
523ded71 AS |
490 | * This routine is usually called via the inline device_schedule_callback(), |
491 | * which automatically sets @owner to THIS_MODULE. | |
492 | * | |
d9a9cdfb | 493 | * Returns 0 if the request was submitted, -ENOMEM if storage could not |
523ded71 | 494 | * be allocated, -ENODEV if a reference to @owner isn't available. |
d9a9cdfb AS |
495 | * |
496 | * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an | |
497 | * underlying sysfs routine (since it is intended for use by attribute | |
498 | * methods), and if sysfs isn't available you'll get nothing but -ENOSYS. | |
499 | */ | |
523ded71 AS |
500 | int device_schedule_callback_owner(struct device *dev, |
501 | void (*func)(struct device *), struct module *owner) | |
d9a9cdfb AS |
502 | { |
503 | return sysfs_schedule_callback(&dev->kobj, | |
523ded71 | 504 | (void (*)(void *)) func, dev, owner); |
d9a9cdfb | 505 | } |
523ded71 | 506 | EXPORT_SYMBOL_GPL(device_schedule_callback_owner); |
d9a9cdfb | 507 | |
34bb61f9 JB |
508 | static void klist_children_get(struct klist_node *n) |
509 | { | |
510 | struct device *dev = container_of(n, struct device, knode_parent); | |
511 | ||
512 | get_device(dev); | |
513 | } | |
514 | ||
515 | static void klist_children_put(struct klist_node *n) | |
516 | { | |
517 | struct device *dev = container_of(n, struct device, knode_parent); | |
518 | ||
519 | put_device(dev); | |
520 | } | |
521 | ||
1da177e4 | 522 | /** |
4a3ad20c GKH |
523 | * device_initialize - init device structure. |
524 | * @dev: device. | |
1da177e4 | 525 | * |
5739411a CH |
526 | * This prepares the device for use by other layers by initializing |
527 | * its fields. | |
4a3ad20c | 528 | * It is the first half of device_register(), if called by |
5739411a CH |
529 | * that function, though it can also be called separately, so one |
530 | * may use @dev's fields. In particular, get_device()/put_device() | |
531 | * may be used for reference counting of @dev after calling this | |
532 | * function. | |
533 | * | |
534 | * NOTE: Use put_device() to give up your reference instead of freeing | |
535 | * @dev directly once you have called this function. | |
1da177e4 | 536 | */ |
1da177e4 LT |
537 | void device_initialize(struct device *dev) |
538 | { | |
881c6cfd | 539 | dev->kobj.kset = devices_kset; |
f9cb074b | 540 | kobject_init(&dev->kobj, &device_ktype); |
34bb61f9 JB |
541 | klist_init(&dev->klist_children, klist_children_get, |
542 | klist_children_put); | |
1da177e4 | 543 | INIT_LIST_HEAD(&dev->dma_pools); |
af70316a | 544 | init_MUTEX(&dev->sem); |
9ac7849e TH |
545 | spin_lock_init(&dev->devres_lock); |
546 | INIT_LIST_HEAD(&dev->devres_head); | |
0ac85241 | 547 | device_init_wakeup(dev, 0); |
3b98aeaf | 548 | device_pm_init(dev); |
87348136 | 549 | set_dev_node(dev, -1); |
1da177e4 LT |
550 | } |
551 | ||
40fa5422 | 552 | #ifdef CONFIG_SYSFS_DEPRECATED |
da231fd5 KS |
553 | static struct kobject *get_device_parent(struct device *dev, |
554 | struct device *parent) | |
40fa5422 | 555 | { |
da231fd5 | 556 | /* class devices without a parent live in /sys/class/<classname>/ */ |
3eb215de | 557 | if (dev->class && (!parent || parent->class != dev->class)) |
1fbfee6c | 558 | return &dev->class->p->class_subsys.kobj; |
da231fd5 | 559 | /* all other devices keep their parent */ |
40fa5422 | 560 | else if (parent) |
c744aeae | 561 | return &parent->kobj; |
40fa5422 | 562 | |
c744aeae | 563 | return NULL; |
40fa5422 | 564 | } |
da231fd5 KS |
565 | |
566 | static inline void cleanup_device_parent(struct device *dev) {} | |
63b6971a CH |
567 | static inline void cleanup_glue_dir(struct device *dev, |
568 | struct kobject *glue_dir) {} | |
40fa5422 | 569 | #else |
86406245 | 570 | static struct kobject *virtual_device_parent(struct device *dev) |
f0ee61a6 | 571 | { |
86406245 | 572 | static struct kobject *virtual_dir = NULL; |
f0ee61a6 | 573 | |
86406245 | 574 | if (!virtual_dir) |
4ff6abff | 575 | virtual_dir = kobject_create_and_add("virtual", |
881c6cfd | 576 | &devices_kset->kobj); |
f0ee61a6 | 577 | |
86406245 | 578 | return virtual_dir; |
f0ee61a6 GKH |
579 | } |
580 | ||
da231fd5 KS |
581 | static struct kobject *get_device_parent(struct device *dev, |
582 | struct device *parent) | |
40fa5422 | 583 | { |
43968d2f GKH |
584 | int retval; |
585 | ||
86406245 KS |
586 | if (dev->class) { |
587 | struct kobject *kobj = NULL; | |
588 | struct kobject *parent_kobj; | |
589 | struct kobject *k; | |
590 | ||
591 | /* | |
592 | * If we have no parent, we live in "virtual". | |
0f4dafc0 KS |
593 | * Class-devices with a non class-device as parent, live |
594 | * in a "glue" directory to prevent namespace collisions. | |
86406245 KS |
595 | */ |
596 | if (parent == NULL) | |
597 | parent_kobj = virtual_device_parent(dev); | |
598 | else if (parent->class) | |
599 | return &parent->kobj; | |
600 | else | |
601 | parent_kobj = &parent->kobj; | |
602 | ||
603 | /* find our class-directory at the parent and reference it */ | |
7c71448b GKH |
604 | spin_lock(&dev->class->p->class_dirs.list_lock); |
605 | list_for_each_entry(k, &dev->class->p->class_dirs.list, entry) | |
86406245 KS |
606 | if (k->parent == parent_kobj) { |
607 | kobj = kobject_get(k); | |
608 | break; | |
609 | } | |
7c71448b | 610 | spin_unlock(&dev->class->p->class_dirs.list_lock); |
86406245 KS |
611 | if (kobj) |
612 | return kobj; | |
613 | ||
614 | /* or create a new class-directory at the parent device */ | |
43968d2f GKH |
615 | k = kobject_create(); |
616 | if (!k) | |
617 | return NULL; | |
7c71448b | 618 | k->kset = &dev->class->p->class_dirs; |
b2d6db58 | 619 | retval = kobject_add(k, parent_kobj, "%s", dev->class->name); |
43968d2f GKH |
620 | if (retval < 0) { |
621 | kobject_put(k); | |
622 | return NULL; | |
623 | } | |
0f4dafc0 | 624 | /* do not emit an uevent for this simple "glue" directory */ |
43968d2f | 625 | return k; |
86406245 KS |
626 | } |
627 | ||
628 | if (parent) | |
c744aeae CH |
629 | return &parent->kobj; |
630 | return NULL; | |
631 | } | |
da231fd5 | 632 | |
63b6971a | 633 | static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir) |
da231fd5 | 634 | { |
0f4dafc0 | 635 | /* see if we live in a "glue" directory */ |
c1fe539a | 636 | if (!glue_dir || !dev->class || |
7c71448b | 637 | glue_dir->kset != &dev->class->p->class_dirs) |
da231fd5 KS |
638 | return; |
639 | ||
0f4dafc0 | 640 | kobject_put(glue_dir); |
da231fd5 | 641 | } |
63b6971a CH |
642 | |
643 | static void cleanup_device_parent(struct device *dev) | |
644 | { | |
645 | cleanup_glue_dir(dev, dev->kobj.parent); | |
646 | } | |
c744aeae | 647 | #endif |
86406245 | 648 | |
63b6971a | 649 | static void setup_parent(struct device *dev, struct device *parent) |
c744aeae CH |
650 | { |
651 | struct kobject *kobj; | |
652 | kobj = get_device_parent(dev, parent); | |
c744aeae CH |
653 | if (kobj) |
654 | dev->kobj.parent = kobj; | |
40fa5422 | 655 | } |
40fa5422 | 656 | |
2ee97caf CH |
657 | static int device_add_class_symlinks(struct device *dev) |
658 | { | |
659 | int error; | |
660 | ||
661 | if (!dev->class) | |
662 | return 0; | |
da231fd5 | 663 | |
1fbfee6c GKH |
664 | error = sysfs_create_link(&dev->kobj, |
665 | &dev->class->p->class_subsys.kobj, | |
2ee97caf CH |
666 | "subsystem"); |
667 | if (error) | |
668 | goto out; | |
da231fd5 KS |
669 | |
670 | #ifdef CONFIG_SYSFS_DEPRECATED | |
671 | /* stacked class devices need a symlink in the class directory */ | |
1fbfee6c | 672 | if (dev->kobj.parent != &dev->class->p->class_subsys.kobj && |
4e886c29 | 673 | device_is_not_partition(dev)) { |
1fbfee6c | 674 | error = sysfs_create_link(&dev->class->p->class_subsys.kobj, |
7c71448b | 675 | &dev->kobj, dev->bus_id); |
2ee97caf CH |
676 | if (error) |
677 | goto out_subsys; | |
678 | } | |
da231fd5 | 679 | |
4e886c29 | 680 | if (dev->parent && device_is_not_partition(dev)) { |
da231fd5 KS |
681 | struct device *parent = dev->parent; |
682 | char *class_name; | |
4f01a757 | 683 | |
da231fd5 KS |
684 | /* |
685 | * stacked class devices have the 'device' link | |
686 | * pointing to the bus device instead of the parent | |
687 | */ | |
688 | while (parent->class && !parent->bus && parent->parent) | |
689 | parent = parent->parent; | |
690 | ||
691 | error = sysfs_create_link(&dev->kobj, | |
692 | &parent->kobj, | |
4f01a757 DT |
693 | "device"); |
694 | if (error) | |
695 | goto out_busid; | |
da231fd5 KS |
696 | |
697 | class_name = make_class_name(dev->class->name, | |
698 | &dev->kobj); | |
699 | if (class_name) | |
700 | error = sysfs_create_link(&dev->parent->kobj, | |
701 | &dev->kobj, class_name); | |
702 | kfree(class_name); | |
703 | if (error) | |
704 | goto out_device; | |
2ee97caf CH |
705 | } |
706 | return 0; | |
707 | ||
2ee97caf | 708 | out_device: |
4e886c29 | 709 | if (dev->parent && device_is_not_partition(dev)) |
2ee97caf | 710 | sysfs_remove_link(&dev->kobj, "device"); |
2ee97caf | 711 | out_busid: |
1fbfee6c | 712 | if (dev->kobj.parent != &dev->class->p->class_subsys.kobj && |
4e886c29 | 713 | device_is_not_partition(dev)) |
1fbfee6c GKH |
714 | sysfs_remove_link(&dev->class->p->class_subsys.kobj, |
715 | dev->bus_id); | |
da231fd5 KS |
716 | #else |
717 | /* link in the class directory pointing to the device */ | |
1fbfee6c GKH |
718 | error = sysfs_create_link(&dev->class->p->class_subsys.kobj, |
719 | &dev->kobj, dev->bus_id); | |
da231fd5 KS |
720 | if (error) |
721 | goto out_subsys; | |
722 | ||
4e886c29 | 723 | if (dev->parent && device_is_not_partition(dev)) { |
da231fd5 KS |
724 | error = sysfs_create_link(&dev->kobj, &dev->parent->kobj, |
725 | "device"); | |
726 | if (error) | |
727 | goto out_busid; | |
728 | } | |
729 | return 0; | |
730 | ||
731 | out_busid: | |
1fbfee6c | 732 | sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id); |
da231fd5 KS |
733 | #endif |
734 | ||
2ee97caf CH |
735 | out_subsys: |
736 | sysfs_remove_link(&dev->kobj, "subsystem"); | |
737 | out: | |
738 | return error; | |
739 | } | |
740 | ||
741 | static void device_remove_class_symlinks(struct device *dev) | |
742 | { | |
743 | if (!dev->class) | |
744 | return; | |
da231fd5 | 745 | |
2ee97caf | 746 | #ifdef CONFIG_SYSFS_DEPRECATED |
4e886c29 | 747 | if (dev->parent && device_is_not_partition(dev)) { |
2ee97caf CH |
748 | char *class_name; |
749 | ||
750 | class_name = make_class_name(dev->class->name, &dev->kobj); | |
751 | if (class_name) { | |
752 | sysfs_remove_link(&dev->parent->kobj, class_name); | |
753 | kfree(class_name); | |
754 | } | |
2ee97caf CH |
755 | sysfs_remove_link(&dev->kobj, "device"); |
756 | } | |
da231fd5 | 757 | |
1fbfee6c | 758 | if (dev->kobj.parent != &dev->class->p->class_subsys.kobj && |
4e886c29 | 759 | device_is_not_partition(dev)) |
1fbfee6c GKH |
760 | sysfs_remove_link(&dev->class->p->class_subsys.kobj, |
761 | dev->bus_id); | |
da231fd5 | 762 | #else |
4e886c29 | 763 | if (dev->parent && device_is_not_partition(dev)) |
da231fd5 KS |
764 | sysfs_remove_link(&dev->kobj, "device"); |
765 | ||
1fbfee6c | 766 | sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id); |
da231fd5 KS |
767 | #endif |
768 | ||
2ee97caf CH |
769 | sysfs_remove_link(&dev->kobj, "subsystem"); |
770 | } | |
771 | ||
413c239f SR |
772 | /** |
773 | * dev_set_name - set a device name | |
774 | * @dev: device | |
46232366 | 775 | * @fmt: format string for the device's name |
413c239f SR |
776 | */ |
777 | int dev_set_name(struct device *dev, const char *fmt, ...) | |
778 | { | |
779 | va_list vargs; | |
780 | ||
781 | va_start(vargs, fmt); | |
782 | vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs); | |
783 | va_end(vargs); | |
784 | return 0; | |
785 | } | |
786 | EXPORT_SYMBOL_GPL(dev_set_name); | |
787 | ||
e105b8bf DW |
788 | /** |
789 | * device_to_dev_kobj - select a /sys/dev/ directory for the device | |
790 | * @dev: device | |
791 | * | |
792 | * By default we select char/ for new entries. Setting class->dev_obj | |
793 | * to NULL prevents an entry from being created. class->dev_kobj must | |
794 | * be set (or cleared) before any devices are registered to the class | |
795 | * otherwise device_create_sys_dev_entry() and | |
796 | * device_remove_sys_dev_entry() will disagree about the the presence | |
797 | * of the link. | |
798 | */ | |
799 | static struct kobject *device_to_dev_kobj(struct device *dev) | |
800 | { | |
801 | struct kobject *kobj; | |
802 | ||
803 | if (dev->class) | |
804 | kobj = dev->class->dev_kobj; | |
805 | else | |
806 | kobj = sysfs_dev_char_kobj; | |
807 | ||
808 | return kobj; | |
809 | } | |
810 | ||
811 | static int device_create_sys_dev_entry(struct device *dev) | |
812 | { | |
813 | struct kobject *kobj = device_to_dev_kobj(dev); | |
814 | int error = 0; | |
815 | char devt_str[15]; | |
816 | ||
817 | if (kobj) { | |
818 | format_dev_t(devt_str, dev->devt); | |
819 | error = sysfs_create_link(kobj, &dev->kobj, devt_str); | |
820 | } | |
821 | ||
822 | return error; | |
823 | } | |
824 | ||
825 | static void device_remove_sys_dev_entry(struct device *dev) | |
826 | { | |
827 | struct kobject *kobj = device_to_dev_kobj(dev); | |
828 | char devt_str[15]; | |
829 | ||
830 | if (kobj) { | |
831 | format_dev_t(devt_str, dev->devt); | |
832 | sysfs_remove_link(kobj, devt_str); | |
833 | } | |
834 | } | |
835 | ||
1da177e4 | 836 | /** |
4a3ad20c GKH |
837 | * device_add - add device to device hierarchy. |
838 | * @dev: device. | |
1da177e4 | 839 | * |
4a3ad20c GKH |
840 | * This is part 2 of device_register(), though may be called |
841 | * separately _iff_ device_initialize() has been called separately. | |
1da177e4 | 842 | * |
5739411a | 843 | * This adds @dev to the kobject hierarchy via kobject_add(), adds it |
4a3ad20c GKH |
844 | * to the global and sibling lists for the device, then |
845 | * adds it to the other relevant subsystems of the driver model. | |
5739411a CH |
846 | * |
847 | * NOTE: _Never_ directly free @dev after calling this function, even | |
848 | * if it returned an error! Always use put_device() to give up your | |
849 | * reference instead. | |
1da177e4 LT |
850 | */ |
851 | int device_add(struct device *dev) | |
852 | { | |
853 | struct device *parent = NULL; | |
c47ed219 | 854 | struct class_interface *class_intf; |
c906a48a | 855 | int error = -EINVAL; |
775b64d2 | 856 | |
1da177e4 | 857 | dev = get_device(dev); |
c906a48a GKH |
858 | if (!dev) |
859 | goto done; | |
860 | ||
861 | /* Temporarily support init_name if it is set. | |
862 | * It will override bus_id for now */ | |
863 | if (dev->init_name) | |
864 | dev_set_name(dev, "%s", dev->init_name); | |
865 | ||
866 | if (!strlen(dev->bus_id)) | |
867 | goto done; | |
1da177e4 | 868 | |
2b3a302a | 869 | pr_debug("device: '%s': %s\n", dev->bus_id, __func__); |
c205ef48 | 870 | |
1da177e4 | 871 | parent = get_device(dev->parent); |
63b6971a | 872 | setup_parent(dev, parent); |
1da177e4 | 873 | |
0d358f22 YL |
874 | /* use parent numa_node */ |
875 | if (parent) | |
876 | set_dev_node(dev, dev_to_node(parent)); | |
877 | ||
1da177e4 | 878 | /* first, register with generic layer. */ |
b2d6db58 | 879 | error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id); |
40fa5422 | 880 | if (error) |
1da177e4 | 881 | goto Error; |
a7fd6706 | 882 | |
37022644 BW |
883 | /* notify platform of device entry */ |
884 | if (platform_notify) | |
885 | platform_notify(dev); | |
886 | ||
116af378 BH |
887 | /* notify clients of device entry (new way) */ |
888 | if (dev->bus) | |
c6f7e72a | 889 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 BH |
890 | BUS_NOTIFY_ADD_DEVICE, dev); |
891 | ||
ad6a1e1c | 892 | error = device_create_file(dev, &uevent_attr); |
a306eea4 CH |
893 | if (error) |
894 | goto attrError; | |
a7fd6706 | 895 | |
23681e47 | 896 | if (MAJOR(dev->devt)) { |
ad6a1e1c TH |
897 | error = device_create_file(dev, &devt_attr); |
898 | if (error) | |
a306eea4 | 899 | goto ueventattrError; |
e105b8bf DW |
900 | |
901 | error = device_create_sys_dev_entry(dev); | |
902 | if (error) | |
903 | goto devtattrError; | |
23681e47 GKH |
904 | } |
905 | ||
2ee97caf CH |
906 | error = device_add_class_symlinks(dev); |
907 | if (error) | |
908 | goto SymlinkError; | |
dc0afa83 CH |
909 | error = device_add_attrs(dev); |
910 | if (error) | |
2620efef | 911 | goto AttrsError; |
dc0afa83 CH |
912 | error = bus_add_device(dev); |
913 | if (error) | |
1da177e4 | 914 | goto BusError; |
3b98aeaf | 915 | error = dpm_sysfs_add(dev); |
57eee3d2 | 916 | if (error) |
3b98aeaf AS |
917 | goto DPMError; |
918 | device_pm_add(dev); | |
83b5fb4c | 919 | kobject_uevent(&dev->kobj, KOBJ_ADD); |
c6a46696 | 920 | bus_attach_device(dev); |
1da177e4 | 921 | if (parent) |
d856f1e3 | 922 | klist_add_tail(&dev->knode_parent, &parent->klist_children); |
1da177e4 | 923 | |
5d9fd169 | 924 | if (dev->class) { |
f75b1c60 | 925 | mutex_lock(&dev->class->p->class_mutex); |
c47ed219 | 926 | /* tie the class to the device */ |
5a3ceb86 TH |
927 | klist_add_tail(&dev->knode_class, |
928 | &dev->class->p->class_devices); | |
c47ed219 GKH |
929 | |
930 | /* notify any interfaces that the device is here */ | |
184f1f77 GKH |
931 | list_for_each_entry(class_intf, |
932 | &dev->class->p->class_interfaces, node) | |
c47ed219 GKH |
933 | if (class_intf->add_dev) |
934 | class_intf->add_dev(dev, class_intf); | |
f75b1c60 | 935 | mutex_unlock(&dev->class->p->class_mutex); |
5d9fd169 | 936 | } |
c906a48a | 937 | done: |
1da177e4 LT |
938 | put_device(dev); |
939 | return error; | |
3b98aeaf | 940 | DPMError: |
57eee3d2 RW |
941 | bus_remove_device(dev); |
942 | BusError: | |
116af378 | 943 | if (dev->bus) |
c6f7e72a | 944 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 | 945 | BUS_NOTIFY_DEL_DEVICE, dev); |
82f0cf9b | 946 | device_remove_attrs(dev); |
2620efef | 947 | AttrsError: |
2ee97caf CH |
948 | device_remove_class_symlinks(dev); |
949 | SymlinkError: | |
e105b8bf DW |
950 | if (MAJOR(dev->devt)) |
951 | device_remove_sys_dev_entry(dev); | |
952 | devtattrError: | |
ad6a1e1c TH |
953 | if (MAJOR(dev->devt)) |
954 | device_remove_file(dev, &devt_attr); | |
a306eea4 | 955 | ueventattrError: |
ad6a1e1c | 956 | device_remove_file(dev, &uevent_attr); |
23681e47 | 957 | attrError: |
312c004d | 958 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
1da177e4 LT |
959 | kobject_del(&dev->kobj); |
960 | Error: | |
63b6971a | 961 | cleanup_device_parent(dev); |
1da177e4 LT |
962 | if (parent) |
963 | put_device(parent); | |
c906a48a | 964 | goto done; |
1da177e4 LT |
965 | } |
966 | ||
1da177e4 | 967 | /** |
4a3ad20c GKH |
968 | * device_register - register a device with the system. |
969 | * @dev: pointer to the device structure | |
1da177e4 | 970 | * |
4a3ad20c GKH |
971 | * This happens in two clean steps - initialize the device |
972 | * and add it to the system. The two steps can be called | |
973 | * separately, but this is the easiest and most common. | |
974 | * I.e. you should only call the two helpers separately if | |
975 | * have a clearly defined need to use and refcount the device | |
976 | * before it is added to the hierarchy. | |
5739411a CH |
977 | * |
978 | * NOTE: _Never_ directly free @dev after calling this function, even | |
979 | * if it returned an error! Always use put_device() to give up the | |
980 | * reference initialized in this function instead. | |
1da177e4 | 981 | */ |
1da177e4 LT |
982 | int device_register(struct device *dev) |
983 | { | |
984 | device_initialize(dev); | |
985 | return device_add(dev); | |
986 | } | |
987 | ||
1da177e4 | 988 | /** |
4a3ad20c GKH |
989 | * get_device - increment reference count for device. |
990 | * @dev: device. | |
1da177e4 | 991 | * |
4a3ad20c GKH |
992 | * This simply forwards the call to kobject_get(), though |
993 | * we do take care to provide for the case that we get a NULL | |
994 | * pointer passed in. | |
1da177e4 | 995 | */ |
4a3ad20c | 996 | struct device *get_device(struct device *dev) |
1da177e4 LT |
997 | { |
998 | return dev ? to_dev(kobject_get(&dev->kobj)) : NULL; | |
999 | } | |
1000 | ||
1da177e4 | 1001 | /** |
4a3ad20c GKH |
1002 | * put_device - decrement reference count. |
1003 | * @dev: device in question. | |
1da177e4 | 1004 | */ |
4a3ad20c | 1005 | void put_device(struct device *dev) |
1da177e4 | 1006 | { |
edfaa7c3 | 1007 | /* might_sleep(); */ |
1da177e4 LT |
1008 | if (dev) |
1009 | kobject_put(&dev->kobj); | |
1010 | } | |
1011 | ||
1da177e4 | 1012 | /** |
4a3ad20c GKH |
1013 | * device_del - delete device from system. |
1014 | * @dev: device. | |
1da177e4 | 1015 | * |
4a3ad20c GKH |
1016 | * This is the first part of the device unregistration |
1017 | * sequence. This removes the device from the lists we control | |
1018 | * from here, has it removed from the other driver model | |
1019 | * subsystems it was added to in device_add(), and removes it | |
1020 | * from the kobject hierarchy. | |
1da177e4 | 1021 | * |
4a3ad20c GKH |
1022 | * NOTE: this should be called manually _iff_ device_add() was |
1023 | * also called manually. | |
1da177e4 | 1024 | */ |
4a3ad20c | 1025 | void device_del(struct device *dev) |
1da177e4 | 1026 | { |
4a3ad20c | 1027 | struct device *parent = dev->parent; |
c47ed219 | 1028 | struct class_interface *class_intf; |
1da177e4 | 1029 | |
775b64d2 | 1030 | device_pm_remove(dev); |
3b98aeaf | 1031 | dpm_sysfs_remove(dev); |
1da177e4 | 1032 | if (parent) |
d62c0f9f | 1033 | klist_del(&dev->knode_parent); |
e105b8bf DW |
1034 | if (MAJOR(dev->devt)) { |
1035 | device_remove_sys_dev_entry(dev); | |
ad6a1e1c | 1036 | device_remove_file(dev, &devt_attr); |
e105b8bf | 1037 | } |
b9d9c82b | 1038 | if (dev->class) { |
da231fd5 | 1039 | device_remove_class_symlinks(dev); |
99ef3ef8 | 1040 | |
f75b1c60 | 1041 | mutex_lock(&dev->class->p->class_mutex); |
c47ed219 | 1042 | /* notify any interfaces that the device is now gone */ |
184f1f77 GKH |
1043 | list_for_each_entry(class_intf, |
1044 | &dev->class->p->class_interfaces, node) | |
c47ed219 GKH |
1045 | if (class_intf->remove_dev) |
1046 | class_intf->remove_dev(dev, class_intf); | |
1047 | /* remove the device from the class list */ | |
5a3ceb86 | 1048 | klist_del(&dev->knode_class); |
f75b1c60 | 1049 | mutex_unlock(&dev->class->p->class_mutex); |
b9d9c82b | 1050 | } |
ad6a1e1c | 1051 | device_remove_file(dev, &uevent_attr); |
2620efef | 1052 | device_remove_attrs(dev); |
28953533 | 1053 | bus_remove_device(dev); |
1da177e4 | 1054 | |
2f8d16a9 TH |
1055 | /* |
1056 | * Some platform devices are driven without driver attached | |
1057 | * and managed resources may have been acquired. Make sure | |
1058 | * all resources are released. | |
1059 | */ | |
1060 | devres_release_all(dev); | |
1061 | ||
1da177e4 LT |
1062 | /* Notify the platform of the removal, in case they |
1063 | * need to do anything... | |
1064 | */ | |
1065 | if (platform_notify_remove) | |
1066 | platform_notify_remove(dev); | |
116af378 | 1067 | if (dev->bus) |
c6f7e72a | 1068 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 | 1069 | BUS_NOTIFY_DEL_DEVICE, dev); |
312c004d | 1070 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
da231fd5 | 1071 | cleanup_device_parent(dev); |
1da177e4 | 1072 | kobject_del(&dev->kobj); |
da231fd5 | 1073 | put_device(parent); |
1da177e4 LT |
1074 | } |
1075 | ||
1076 | /** | |
4a3ad20c GKH |
1077 | * device_unregister - unregister device from system. |
1078 | * @dev: device going away. | |
1da177e4 | 1079 | * |
4a3ad20c GKH |
1080 | * We do this in two parts, like we do device_register(). First, |
1081 | * we remove it from all the subsystems with device_del(), then | |
1082 | * we decrement the reference count via put_device(). If that | |
1083 | * is the final reference count, the device will be cleaned up | |
1084 | * via device_release() above. Otherwise, the structure will | |
1085 | * stick around until the final reference to the device is dropped. | |
1da177e4 | 1086 | */ |
4a3ad20c | 1087 | void device_unregister(struct device *dev) |
1da177e4 | 1088 | { |
2b3a302a | 1089 | pr_debug("device: '%s': %s\n", dev->bus_id, __func__); |
1da177e4 LT |
1090 | device_del(dev); |
1091 | put_device(dev); | |
1092 | } | |
1093 | ||
4a3ad20c | 1094 | static struct device *next_device(struct klist_iter *i) |
36239577 | 1095 | { |
4a3ad20c | 1096 | struct klist_node *n = klist_next(i); |
36239577 | 1097 | return n ? container_of(n, struct device, knode_parent) : NULL; |
1098 | } | |
1099 | ||
1da177e4 | 1100 | /** |
4a3ad20c GKH |
1101 | * device_for_each_child - device child iterator. |
1102 | * @parent: parent struct device. | |
1103 | * @data: data for the callback. | |
1104 | * @fn: function to be called for each device. | |
1da177e4 | 1105 | * |
4a3ad20c GKH |
1106 | * Iterate over @parent's child devices, and call @fn for each, |
1107 | * passing it @data. | |
1da177e4 | 1108 | * |
4a3ad20c GKH |
1109 | * We check the return of @fn each time. If it returns anything |
1110 | * other than 0, we break out and return that value. | |
1da177e4 | 1111 | */ |
4a3ad20c GKH |
1112 | int device_for_each_child(struct device *parent, void *data, |
1113 | int (*fn)(struct device *dev, void *data)) | |
1da177e4 | 1114 | { |
36239577 | 1115 | struct klist_iter i; |
4a3ad20c | 1116 | struct device *child; |
1da177e4 LT |
1117 | int error = 0; |
1118 | ||
36239577 | 1119 | klist_iter_init(&parent->klist_children, &i); |
1120 | while ((child = next_device(&i)) && !error) | |
1121 | error = fn(child, data); | |
1122 | klist_iter_exit(&i); | |
1da177e4 LT |
1123 | return error; |
1124 | } | |
1125 | ||
5ab69981 CH |
1126 | /** |
1127 | * device_find_child - device iterator for locating a particular device. | |
1128 | * @parent: parent struct device | |
1129 | * @data: Data to pass to match function | |
1130 | * @match: Callback function to check device | |
1131 | * | |
1132 | * This is similar to the device_for_each_child() function above, but it | |
1133 | * returns a reference to a device that is 'found' for later use, as | |
1134 | * determined by the @match callback. | |
1135 | * | |
1136 | * The callback should return 0 if the device doesn't match and non-zero | |
1137 | * if it does. If the callback returns non-zero and a reference to the | |
1138 | * current device can be obtained, this function will return to the caller | |
1139 | * and not iterate over any more devices. | |
1140 | */ | |
4a3ad20c GKH |
1141 | struct device *device_find_child(struct device *parent, void *data, |
1142 | int (*match)(struct device *dev, void *data)) | |
5ab69981 CH |
1143 | { |
1144 | struct klist_iter i; | |
1145 | struct device *child; | |
1146 | ||
1147 | if (!parent) | |
1148 | return NULL; | |
1149 | ||
1150 | klist_iter_init(&parent->klist_children, &i); | |
1151 | while ((child = next_device(&i))) | |
1152 | if (match(child, data) && get_device(child)) | |
1153 | break; | |
1154 | klist_iter_exit(&i); | |
1155 | return child; | |
1156 | } | |
1157 | ||
1da177e4 LT |
1158 | int __init devices_init(void) |
1159 | { | |
881c6cfd GKH |
1160 | devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL); |
1161 | if (!devices_kset) | |
1162 | return -ENOMEM; | |
e105b8bf DW |
1163 | dev_kobj = kobject_create_and_add("dev", NULL); |
1164 | if (!dev_kobj) | |
1165 | goto dev_kobj_err; | |
1166 | sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj); | |
1167 | if (!sysfs_dev_block_kobj) | |
1168 | goto block_kobj_err; | |
1169 | sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj); | |
1170 | if (!sysfs_dev_char_kobj) | |
1171 | goto char_kobj_err; | |
1172 | ||
881c6cfd | 1173 | return 0; |
e105b8bf DW |
1174 | |
1175 | char_kobj_err: | |
1176 | kobject_put(sysfs_dev_block_kobj); | |
1177 | block_kobj_err: | |
1178 | kobject_put(dev_kobj); | |
1179 | dev_kobj_err: | |
1180 | kset_unregister(devices_kset); | |
1181 | return -ENOMEM; | |
1da177e4 LT |
1182 | } |
1183 | ||
1184 | EXPORT_SYMBOL_GPL(device_for_each_child); | |
5ab69981 | 1185 | EXPORT_SYMBOL_GPL(device_find_child); |
1da177e4 LT |
1186 | |
1187 | EXPORT_SYMBOL_GPL(device_initialize); | |
1188 | EXPORT_SYMBOL_GPL(device_add); | |
1189 | EXPORT_SYMBOL_GPL(device_register); | |
1190 | ||
1191 | EXPORT_SYMBOL_GPL(device_del); | |
1192 | EXPORT_SYMBOL_GPL(device_unregister); | |
1193 | EXPORT_SYMBOL_GPL(get_device); | |
1194 | EXPORT_SYMBOL_GPL(put_device); | |
1da177e4 LT |
1195 | |
1196 | EXPORT_SYMBOL_GPL(device_create_file); | |
1197 | EXPORT_SYMBOL_GPL(device_remove_file); | |
23681e47 GKH |
1198 | |
1199 | ||
1200 | static void device_create_release(struct device *dev) | |
1201 | { | |
2b3a302a | 1202 | pr_debug("device: '%s': %s\n", dev->bus_id, __func__); |
23681e47 GKH |
1203 | kfree(dev); |
1204 | } | |
1205 | ||
1206 | /** | |
8882b394 | 1207 | * device_create_vargs - creates a device and registers it with sysfs |
42734daf HK |
1208 | * @class: pointer to the struct class that this device should be registered to |
1209 | * @parent: pointer to the parent struct device of this new device, if any | |
1210 | * @devt: the dev_t for the char device to be added | |
8882b394 | 1211 | * @drvdata: the data to be added to the device for callbacks |
42734daf | 1212 | * @fmt: string for the device's name |
8882b394 | 1213 | * @args: va_list for the device's name |
42734daf HK |
1214 | * |
1215 | * This function can be used by char device classes. A struct device | |
1216 | * will be created in sysfs, registered to the specified class. | |
23681e47 | 1217 | * |
23681e47 GKH |
1218 | * A "dev" file will be created, showing the dev_t for the device, if |
1219 | * the dev_t is not 0,0. | |
42734daf HK |
1220 | * If a pointer to a parent struct device is passed in, the newly created |
1221 | * struct device will be a child of that device in sysfs. | |
1222 | * The pointer to the struct device will be returned from the call. | |
1223 | * Any further sysfs files that might be required can be created using this | |
23681e47 GKH |
1224 | * pointer. |
1225 | * | |
1226 | * Note: the struct class passed to this function must have previously | |
1227 | * been created with a call to class_create(). | |
1228 | */ | |
8882b394 GKH |
1229 | struct device *device_create_vargs(struct class *class, struct device *parent, |
1230 | dev_t devt, void *drvdata, const char *fmt, | |
1231 | va_list args) | |
23681e47 | 1232 | { |
23681e47 GKH |
1233 | struct device *dev = NULL; |
1234 | int retval = -ENODEV; | |
1235 | ||
1236 | if (class == NULL || IS_ERR(class)) | |
1237 | goto error; | |
23681e47 GKH |
1238 | |
1239 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); | |
1240 | if (!dev) { | |
1241 | retval = -ENOMEM; | |
1242 | goto error; | |
1243 | } | |
1244 | ||
1245 | dev->devt = devt; | |
1246 | dev->class = class; | |
1247 | dev->parent = parent; | |
1248 | dev->release = device_create_release; | |
8882b394 | 1249 | dev_set_drvdata(dev, drvdata); |
23681e47 | 1250 | |
23681e47 | 1251 | vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args); |
23681e47 GKH |
1252 | retval = device_register(dev); |
1253 | if (retval) | |
1254 | goto error; | |
1255 | ||
23681e47 GKH |
1256 | return dev; |
1257 | ||
1258 | error: | |
286661b3 | 1259 | put_device(dev); |
23681e47 GKH |
1260 | return ERR_PTR(retval); |
1261 | } | |
8882b394 GKH |
1262 | EXPORT_SYMBOL_GPL(device_create_vargs); |
1263 | ||
1264 | /** | |
4e106739 | 1265 | * device_create - creates a device and registers it with sysfs |
8882b394 GKH |
1266 | * @class: pointer to the struct class that this device should be registered to |
1267 | * @parent: pointer to the parent struct device of this new device, if any | |
1268 | * @devt: the dev_t for the char device to be added | |
1269 | * @drvdata: the data to be added to the device for callbacks | |
1270 | * @fmt: string for the device's name | |
1271 | * | |
1272 | * This function can be used by char device classes. A struct device | |
1273 | * will be created in sysfs, registered to the specified class. | |
1274 | * | |
1275 | * A "dev" file will be created, showing the dev_t for the device, if | |
1276 | * the dev_t is not 0,0. | |
1277 | * If a pointer to a parent struct device is passed in, the newly created | |
1278 | * struct device will be a child of that device in sysfs. | |
1279 | * The pointer to the struct device will be returned from the call. | |
1280 | * Any further sysfs files that might be required can be created using this | |
1281 | * pointer. | |
1282 | * | |
1283 | * Note: the struct class passed to this function must have previously | |
1284 | * been created with a call to class_create(). | |
1285 | */ | |
4e106739 GKH |
1286 | struct device *device_create(struct class *class, struct device *parent, |
1287 | dev_t devt, void *drvdata, const char *fmt, ...) | |
8882b394 GKH |
1288 | { |
1289 | va_list vargs; | |
1290 | struct device *dev; | |
1291 | ||
1292 | va_start(vargs, fmt); | |
1293 | dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs); | |
1294 | va_end(vargs); | |
1295 | return dev; | |
1296 | } | |
4e106739 | 1297 | EXPORT_SYMBOL_GPL(device_create); |
8882b394 | 1298 | |
cd35449b | 1299 | static int __match_devt(struct device *dev, void *data) |
23681e47 | 1300 | { |
cd35449b | 1301 | dev_t *devt = data; |
23681e47 | 1302 | |
cd35449b | 1303 | return dev->devt == *devt; |
775b64d2 RW |
1304 | } |
1305 | ||
1306 | /** | |
1307 | * device_destroy - removes a device that was created with device_create() | |
1308 | * @class: pointer to the struct class that this device was registered with | |
1309 | * @devt: the dev_t of the device that was previously registered | |
1310 | * | |
1311 | * This call unregisters and cleans up a device that was created with a | |
1312 | * call to device_create(). | |
1313 | */ | |
1314 | void device_destroy(struct class *class, dev_t devt) | |
1315 | { | |
1316 | struct device *dev; | |
23681e47 | 1317 | |
695794ae | 1318 | dev = class_find_device(class, NULL, &devt, __match_devt); |
cd35449b DY |
1319 | if (dev) { |
1320 | put_device(dev); | |
23681e47 | 1321 | device_unregister(dev); |
cd35449b | 1322 | } |
23681e47 GKH |
1323 | } |
1324 | EXPORT_SYMBOL_GPL(device_destroy); | |
a2de48ca GKH |
1325 | |
1326 | /** | |
1327 | * device_rename - renames a device | |
1328 | * @dev: the pointer to the struct device to be renamed | |
1329 | * @new_name: the new name of the device | |
1330 | */ | |
1331 | int device_rename(struct device *dev, char *new_name) | |
1332 | { | |
1333 | char *old_class_name = NULL; | |
1334 | char *new_class_name = NULL; | |
2ee97caf | 1335 | char *old_device_name = NULL; |
a2de48ca GKH |
1336 | int error; |
1337 | ||
1338 | dev = get_device(dev); | |
1339 | if (!dev) | |
1340 | return -EINVAL; | |
1341 | ||
7dc72b28 | 1342 | pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id, |
2b3a302a | 1343 | __func__, new_name); |
a2de48ca | 1344 | |
99ef3ef8 | 1345 | #ifdef CONFIG_SYSFS_DEPRECATED |
a2de48ca GKH |
1346 | if ((dev->class) && (dev->parent)) |
1347 | old_class_name = make_class_name(dev->class->name, &dev->kobj); | |
99ef3ef8 | 1348 | #endif |
a2de48ca | 1349 | |
2ee97caf CH |
1350 | old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL); |
1351 | if (!old_device_name) { | |
1352 | error = -ENOMEM; | |
1353 | goto out; | |
a2de48ca | 1354 | } |
2ee97caf | 1355 | strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE); |
a2de48ca GKH |
1356 | strlcpy(dev->bus_id, new_name, BUS_ID_SIZE); |
1357 | ||
1358 | error = kobject_rename(&dev->kobj, new_name); | |
2ee97caf CH |
1359 | if (error) { |
1360 | strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE); | |
1361 | goto out; | |
1362 | } | |
a2de48ca | 1363 | |
99ef3ef8 | 1364 | #ifdef CONFIG_SYSFS_DEPRECATED |
a2de48ca GKH |
1365 | if (old_class_name) { |
1366 | new_class_name = make_class_name(dev->class->name, &dev->kobj); | |
1367 | if (new_class_name) { | |
36ce6dad CH |
1368 | error = sysfs_create_link_nowarn(&dev->parent->kobj, |
1369 | &dev->kobj, | |
1370 | new_class_name); | |
2ee97caf CH |
1371 | if (error) |
1372 | goto out; | |
a2de48ca GKH |
1373 | sysfs_remove_link(&dev->parent->kobj, old_class_name); |
1374 | } | |
1375 | } | |
60b8cabd | 1376 | #else |
a2de48ca | 1377 | if (dev->class) { |
36ce6dad CH |
1378 | error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj, |
1379 | &dev->kobj, dev->bus_id); | |
0599ad53 SH |
1380 | if (error) |
1381 | goto out; | |
1fbfee6c | 1382 | sysfs_remove_link(&dev->class->p->class_subsys.kobj, |
7c71448b | 1383 | old_device_name); |
a2de48ca | 1384 | } |
60b8cabd KS |
1385 | #endif |
1386 | ||
2ee97caf | 1387 | out: |
a2de48ca GKH |
1388 | put_device(dev); |
1389 | ||
a2de48ca | 1390 | kfree(new_class_name); |
952ab431 | 1391 | kfree(old_class_name); |
2ee97caf | 1392 | kfree(old_device_name); |
a2de48ca GKH |
1393 | |
1394 | return error; | |
1395 | } | |
a2807dbc | 1396 | EXPORT_SYMBOL_GPL(device_rename); |
8a82472f CH |
1397 | |
1398 | static int device_move_class_links(struct device *dev, | |
1399 | struct device *old_parent, | |
1400 | struct device *new_parent) | |
1401 | { | |
f7f3461d | 1402 | int error = 0; |
8a82472f | 1403 | #ifdef CONFIG_SYSFS_DEPRECATED |
8a82472f CH |
1404 | char *class_name; |
1405 | ||
1406 | class_name = make_class_name(dev->class->name, &dev->kobj); | |
1407 | if (!class_name) { | |
cb360bbf | 1408 | error = -ENOMEM; |
8a82472f CH |
1409 | goto out; |
1410 | } | |
1411 | if (old_parent) { | |
1412 | sysfs_remove_link(&dev->kobj, "device"); | |
1413 | sysfs_remove_link(&old_parent->kobj, class_name); | |
1414 | } | |
c744aeae CH |
1415 | if (new_parent) { |
1416 | error = sysfs_create_link(&dev->kobj, &new_parent->kobj, | |
1417 | "device"); | |
1418 | if (error) | |
1419 | goto out; | |
1420 | error = sysfs_create_link(&new_parent->kobj, &dev->kobj, | |
1421 | class_name); | |
1422 | if (error) | |
1423 | sysfs_remove_link(&dev->kobj, "device"); | |
4a3ad20c | 1424 | } else |
c744aeae | 1425 | error = 0; |
8a82472f CH |
1426 | out: |
1427 | kfree(class_name); | |
1428 | return error; | |
1429 | #else | |
f7f3461d GKH |
1430 | if (old_parent) |
1431 | sysfs_remove_link(&dev->kobj, "device"); | |
1432 | if (new_parent) | |
1433 | error = sysfs_create_link(&dev->kobj, &new_parent->kobj, | |
1434 | "device"); | |
1435 | return error; | |
8a82472f CH |
1436 | #endif |
1437 | } | |
1438 | ||
1439 | /** | |
1440 | * device_move - moves a device to a new parent | |
1441 | * @dev: the pointer to the struct device to be moved | |
c744aeae | 1442 | * @new_parent: the new parent of the device (can by NULL) |
8a82472f CH |
1443 | */ |
1444 | int device_move(struct device *dev, struct device *new_parent) | |
1445 | { | |
1446 | int error; | |
1447 | struct device *old_parent; | |
c744aeae | 1448 | struct kobject *new_parent_kobj; |
8a82472f CH |
1449 | |
1450 | dev = get_device(dev); | |
1451 | if (!dev) | |
1452 | return -EINVAL; | |
1453 | ||
8a82472f | 1454 | new_parent = get_device(new_parent); |
4a3ad20c | 1455 | new_parent_kobj = get_device_parent(dev, new_parent); |
63b6971a | 1456 | |
7dc72b28 | 1457 | pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id, |
2b3a302a | 1458 | __func__, new_parent ? new_parent->bus_id : "<NULL>"); |
c744aeae | 1459 | error = kobject_move(&dev->kobj, new_parent_kobj); |
8a82472f | 1460 | if (error) { |
63b6971a | 1461 | cleanup_glue_dir(dev, new_parent_kobj); |
8a82472f CH |
1462 | put_device(new_parent); |
1463 | goto out; | |
1464 | } | |
1465 | old_parent = dev->parent; | |
1466 | dev->parent = new_parent; | |
1467 | if (old_parent) | |
acf02d23 | 1468 | klist_remove(&dev->knode_parent); |
0d358f22 | 1469 | if (new_parent) { |
c744aeae | 1470 | klist_add_tail(&dev->knode_parent, &new_parent->klist_children); |
0d358f22 YL |
1471 | set_dev_node(dev, dev_to_node(new_parent)); |
1472 | } | |
1473 | ||
8a82472f CH |
1474 | if (!dev->class) |
1475 | goto out_put; | |
1476 | error = device_move_class_links(dev, old_parent, new_parent); | |
1477 | if (error) { | |
1478 | /* We ignore errors on cleanup since we're hosed anyway... */ | |
1479 | device_move_class_links(dev, new_parent, old_parent); | |
1480 | if (!kobject_move(&dev->kobj, &old_parent->kobj)) { | |
c744aeae CH |
1481 | if (new_parent) |
1482 | klist_remove(&dev->knode_parent); | |
0d358f22 YL |
1483 | dev->parent = old_parent; |
1484 | if (old_parent) { | |
8a82472f CH |
1485 | klist_add_tail(&dev->knode_parent, |
1486 | &old_parent->klist_children); | |
0d358f22 YL |
1487 | set_dev_node(dev, dev_to_node(old_parent)); |
1488 | } | |
8a82472f | 1489 | } |
63b6971a | 1490 | cleanup_glue_dir(dev, new_parent_kobj); |
8a82472f CH |
1491 | put_device(new_parent); |
1492 | goto out; | |
1493 | } | |
1494 | out_put: | |
1495 | put_device(old_parent); | |
1496 | out: | |
1497 | put_device(dev); | |
1498 | return error; | |
1499 | } | |
8a82472f | 1500 | EXPORT_SYMBOL_GPL(device_move); |
37b0c020 GKH |
1501 | |
1502 | /** | |
1503 | * device_shutdown - call ->shutdown() on each device to shutdown. | |
1504 | */ | |
1505 | void device_shutdown(void) | |
1506 | { | |
4a3ad20c | 1507 | struct device *dev, *devn; |
37b0c020 GKH |
1508 | |
1509 | list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list, | |
1510 | kobj.entry) { | |
1511 | if (dev->bus && dev->bus->shutdown) { | |
1512 | dev_dbg(dev, "shutdown\n"); | |
1513 | dev->bus->shutdown(dev); | |
1514 | } else if (dev->driver && dev->driver->shutdown) { | |
1515 | dev_dbg(dev, "shutdown\n"); | |
1516 | dev->driver->shutdown(dev); | |
1517 | } | |
1518 | } | |
e105b8bf DW |
1519 | kobject_put(sysfs_dev_char_kobj); |
1520 | kobject_put(sysfs_dev_block_kobj); | |
1521 | kobject_put(dev_kobj); | |
37b0c020 | 1522 | } |