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> |
f75b1c60 | 23 | #include <linux/mutex.h> |
401097ea | 24 | #include <linux/async.h> |
af8db150 | 25 | #include <linux/pm_runtime.h> |
1da177e4 LT |
26 | |
27 | #include "base.h" | |
28 | #include "power/power.h" | |
29 | ||
e52eec13 AK |
30 | #ifdef CONFIG_SYSFS_DEPRECATED |
31 | #ifdef CONFIG_SYSFS_DEPRECATED_V2 | |
32 | long sysfs_deprecated = 1; | |
33 | #else | |
34 | long sysfs_deprecated = 0; | |
35 | #endif | |
36 | static __init int sysfs_deprecated_setup(char *arg) | |
37 | { | |
38 | return strict_strtol(arg, 10, &sysfs_deprecated); | |
39 | } | |
40 | early_param("sysfs.deprecated", sysfs_deprecated_setup); | |
41 | #endif | |
42 | ||
4a3ad20c GKH |
43 | int (*platform_notify)(struct device *dev) = NULL; |
44 | int (*platform_notify_remove)(struct device *dev) = NULL; | |
e105b8bf DW |
45 | static struct kobject *dev_kobj; |
46 | struct kobject *sysfs_dev_char_kobj; | |
47 | struct kobject *sysfs_dev_block_kobj; | |
1da177e4 | 48 | |
4e886c29 GKH |
49 | #ifdef CONFIG_BLOCK |
50 | static inline int device_is_not_partition(struct device *dev) | |
51 | { | |
52 | return !(dev->type == &part_type); | |
53 | } | |
54 | #else | |
55 | static inline int device_is_not_partition(struct device *dev) | |
56 | { | |
57 | return 1; | |
58 | } | |
59 | #endif | |
1da177e4 | 60 | |
3e95637a AS |
61 | /** |
62 | * dev_driver_string - Return a device's driver name, if at all possible | |
63 | * @dev: struct device to get the name of | |
64 | * | |
65 | * Will return the device's driver's name if it is bound to a device. If | |
66 | * the device is not bound to a device, it will return the name of the bus | |
67 | * it is attached to. If it is not attached to a bus either, an empty | |
68 | * string will be returned. | |
69 | */ | |
bf9ca69f | 70 | const char *dev_driver_string(const struct device *dev) |
3e95637a | 71 | { |
3589972e AS |
72 | struct device_driver *drv; |
73 | ||
74 | /* dev->driver can change to NULL underneath us because of unbinding, | |
75 | * so be careful about accessing it. dev->bus and dev->class should | |
76 | * never change once they are set, so they don't need special care. | |
77 | */ | |
78 | drv = ACCESS_ONCE(dev->driver); | |
79 | return drv ? drv->name : | |
a456b702 JD |
80 | (dev->bus ? dev->bus->name : |
81 | (dev->class ? dev->class->name : "")); | |
3e95637a | 82 | } |
310a922d | 83 | EXPORT_SYMBOL(dev_driver_string); |
3e95637a | 84 | |
1da177e4 LT |
85 | #define to_dev(obj) container_of(obj, struct device, kobj) |
86 | #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr) | |
87 | ||
4a3ad20c GKH |
88 | static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr, |
89 | char *buf) | |
1da177e4 | 90 | { |
4a3ad20c GKH |
91 | struct device_attribute *dev_attr = to_dev_attr(attr); |
92 | struct device *dev = to_dev(kobj); | |
4a0c20bf | 93 | ssize_t ret = -EIO; |
1da177e4 LT |
94 | |
95 | if (dev_attr->show) | |
54b6f35c | 96 | ret = dev_attr->show(dev, dev_attr, buf); |
815d2d50 AM |
97 | if (ret >= (ssize_t)PAGE_SIZE) { |
98 | print_symbol("dev_attr_show: %s returned bad count\n", | |
99 | (unsigned long)dev_attr->show); | |
100 | } | |
1da177e4 LT |
101 | return ret; |
102 | } | |
103 | ||
4a3ad20c GKH |
104 | static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr, |
105 | const char *buf, size_t count) | |
1da177e4 | 106 | { |
4a3ad20c GKH |
107 | struct device_attribute *dev_attr = to_dev_attr(attr); |
108 | struct device *dev = to_dev(kobj); | |
4a0c20bf | 109 | ssize_t ret = -EIO; |
1da177e4 LT |
110 | |
111 | if (dev_attr->store) | |
54b6f35c | 112 | ret = dev_attr->store(dev, dev_attr, buf, count); |
1da177e4 LT |
113 | return ret; |
114 | } | |
115 | ||
52cf25d0 | 116 | static const struct sysfs_ops dev_sysfs_ops = { |
1da177e4 LT |
117 | .show = dev_attr_show, |
118 | .store = dev_attr_store, | |
119 | }; | |
120 | ||
ca22e56d KS |
121 | #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr) |
122 | ||
123 | ssize_t device_store_ulong(struct device *dev, | |
124 | struct device_attribute *attr, | |
125 | const char *buf, size_t size) | |
126 | { | |
127 | struct dev_ext_attribute *ea = to_ext_attr(attr); | |
128 | char *end; | |
129 | unsigned long new = simple_strtoul(buf, &end, 0); | |
130 | if (end == buf) | |
131 | return -EINVAL; | |
132 | *(unsigned long *)(ea->var) = new; | |
133 | /* Always return full write size even if we didn't consume all */ | |
134 | return size; | |
135 | } | |
136 | EXPORT_SYMBOL_GPL(device_store_ulong); | |
137 | ||
138 | ssize_t device_show_ulong(struct device *dev, | |
139 | struct device_attribute *attr, | |
140 | char *buf) | |
141 | { | |
142 | struct dev_ext_attribute *ea = to_ext_attr(attr); | |
143 | return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var)); | |
144 | } | |
145 | EXPORT_SYMBOL_GPL(device_show_ulong); | |
146 | ||
147 | ssize_t device_store_int(struct device *dev, | |
148 | struct device_attribute *attr, | |
149 | const char *buf, size_t size) | |
150 | { | |
151 | struct dev_ext_attribute *ea = to_ext_attr(attr); | |
152 | char *end; | |
153 | long new = simple_strtol(buf, &end, 0); | |
154 | if (end == buf || new > INT_MAX || new < INT_MIN) | |
155 | return -EINVAL; | |
156 | *(int *)(ea->var) = new; | |
157 | /* Always return full write size even if we didn't consume all */ | |
158 | return size; | |
159 | } | |
160 | EXPORT_SYMBOL_GPL(device_store_int); | |
161 | ||
162 | ssize_t device_show_int(struct device *dev, | |
163 | struct device_attribute *attr, | |
164 | char *buf) | |
165 | { | |
166 | struct dev_ext_attribute *ea = to_ext_attr(attr); | |
167 | ||
168 | return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var)); | |
169 | } | |
170 | EXPORT_SYMBOL_GPL(device_show_int); | |
1da177e4 LT |
171 | |
172 | /** | |
173 | * device_release - free device structure. | |
174 | * @kobj: device's kobject. | |
175 | * | |
176 | * This is called once the reference count for the object | |
177 | * reaches 0. We forward the call to the device's release | |
178 | * method, which should handle actually freeing the structure. | |
179 | */ | |
4a3ad20c | 180 | static void device_release(struct kobject *kobj) |
1da177e4 | 181 | { |
4a3ad20c | 182 | struct device *dev = to_dev(kobj); |
fb069a5d | 183 | struct device_private *p = dev->p; |
1da177e4 LT |
184 | |
185 | if (dev->release) | |
186 | dev->release(dev); | |
f9f852df KS |
187 | else if (dev->type && dev->type->release) |
188 | dev->type->release(dev); | |
2620efef GKH |
189 | else if (dev->class && dev->class->dev_release) |
190 | dev->class->dev_release(dev); | |
f810a5cf AV |
191 | else |
192 | WARN(1, KERN_ERR "Device '%s' does not have a release() " | |
4a3ad20c | 193 | "function, it is broken and must be fixed.\n", |
1e0b2cf9 | 194 | dev_name(dev)); |
fb069a5d | 195 | kfree(p); |
1da177e4 LT |
196 | } |
197 | ||
bc451f20 EB |
198 | static const void *device_namespace(struct kobject *kobj) |
199 | { | |
200 | struct device *dev = to_dev(kobj); | |
201 | const void *ns = NULL; | |
202 | ||
203 | if (dev->class && dev->class->ns_type) | |
204 | ns = dev->class->namespace(dev); | |
205 | ||
206 | return ns; | |
207 | } | |
208 | ||
8f4afc41 | 209 | static struct kobj_type device_ktype = { |
1da177e4 LT |
210 | .release = device_release, |
211 | .sysfs_ops = &dev_sysfs_ops, | |
bc451f20 | 212 | .namespace = device_namespace, |
1da177e4 LT |
213 | }; |
214 | ||
215 | ||
312c004d | 216 | static int dev_uevent_filter(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
217 | { |
218 | struct kobj_type *ktype = get_ktype(kobj); | |
219 | ||
8f4afc41 | 220 | if (ktype == &device_ktype) { |
1da177e4 LT |
221 | struct device *dev = to_dev(kobj); |
222 | if (dev->bus) | |
223 | return 1; | |
23681e47 GKH |
224 | if (dev->class) |
225 | return 1; | |
1da177e4 LT |
226 | } |
227 | return 0; | |
228 | } | |
229 | ||
312c004d | 230 | static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
231 | { |
232 | struct device *dev = to_dev(kobj); | |
233 | ||
23681e47 GKH |
234 | if (dev->bus) |
235 | return dev->bus->name; | |
236 | if (dev->class) | |
237 | return dev->class->name; | |
238 | return NULL; | |
1da177e4 LT |
239 | } |
240 | ||
7eff2e7a KS |
241 | static int dev_uevent(struct kset *kset, struct kobject *kobj, |
242 | struct kobj_uevent_env *env) | |
1da177e4 LT |
243 | { |
244 | struct device *dev = to_dev(kobj); | |
1da177e4 LT |
245 | int retval = 0; |
246 | ||
6fcf53ac | 247 | /* add device node properties if present */ |
23681e47 | 248 | if (MAJOR(dev->devt)) { |
6fcf53ac KS |
249 | const char *tmp; |
250 | const char *name; | |
2c9ede55 | 251 | umode_t mode = 0; |
6fcf53ac | 252 | |
7eff2e7a KS |
253 | add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt)); |
254 | add_uevent_var(env, "MINOR=%u", MINOR(dev->devt)); | |
e454cea2 | 255 | name = device_get_devnode(dev, &mode, &tmp); |
6fcf53ac KS |
256 | if (name) { |
257 | add_uevent_var(env, "DEVNAME=%s", name); | |
258 | kfree(tmp); | |
e454cea2 KS |
259 | if (mode) |
260 | add_uevent_var(env, "DEVMODE=%#o", mode & 0777); | |
6fcf53ac | 261 | } |
23681e47 GKH |
262 | } |
263 | ||
414264f9 | 264 | if (dev->type && dev->type->name) |
7eff2e7a | 265 | add_uevent_var(env, "DEVTYPE=%s", dev->type->name); |
414264f9 | 266 | |
239378f1 | 267 | if (dev->driver) |
7eff2e7a | 268 | add_uevent_var(env, "DRIVER=%s", dev->driver->name); |
239378f1 | 269 | |
7eff2e7a | 270 | /* have the bus specific function add its stuff */ |
312c004d | 271 | if (dev->bus && dev->bus->uevent) { |
7eff2e7a | 272 | retval = dev->bus->uevent(dev, env); |
f9f852df | 273 | if (retval) |
7dc72b28 | 274 | pr_debug("device: '%s': %s: bus uevent() returned %d\n", |
1e0b2cf9 | 275 | dev_name(dev), __func__, retval); |
1da177e4 LT |
276 | } |
277 | ||
7eff2e7a | 278 | /* have the class specific function add its stuff */ |
2620efef | 279 | if (dev->class && dev->class->dev_uevent) { |
7eff2e7a | 280 | retval = dev->class->dev_uevent(dev, env); |
f9f852df | 281 | if (retval) |
7dc72b28 | 282 | pr_debug("device: '%s': %s: class uevent() " |
1e0b2cf9 | 283 | "returned %d\n", dev_name(dev), |
2b3a302a | 284 | __func__, retval); |
f9f852df KS |
285 | } |
286 | ||
eef35c2d | 287 | /* have the device type specific function add its stuff */ |
f9f852df | 288 | if (dev->type && dev->type->uevent) { |
7eff2e7a | 289 | retval = dev->type->uevent(dev, env); |
f9f852df | 290 | if (retval) |
7dc72b28 | 291 | pr_debug("device: '%s': %s: dev_type uevent() " |
1e0b2cf9 | 292 | "returned %d\n", dev_name(dev), |
2b3a302a | 293 | __func__, retval); |
2620efef GKH |
294 | } |
295 | ||
1da177e4 LT |
296 | return retval; |
297 | } | |
298 | ||
9cd43611 | 299 | static const struct kset_uevent_ops device_uevent_ops = { |
312c004d KS |
300 | .filter = dev_uevent_filter, |
301 | .name = dev_uevent_name, | |
302 | .uevent = dev_uevent, | |
1da177e4 LT |
303 | }; |
304 | ||
16574dcc KS |
305 | static ssize_t show_uevent(struct device *dev, struct device_attribute *attr, |
306 | char *buf) | |
307 | { | |
308 | struct kobject *top_kobj; | |
309 | struct kset *kset; | |
7eff2e7a | 310 | struct kobj_uevent_env *env = NULL; |
16574dcc KS |
311 | int i; |
312 | size_t count = 0; | |
313 | int retval; | |
314 | ||
315 | /* search the kset, the device belongs to */ | |
316 | top_kobj = &dev->kobj; | |
5c5daf65 KS |
317 | while (!top_kobj->kset && top_kobj->parent) |
318 | top_kobj = top_kobj->parent; | |
16574dcc KS |
319 | if (!top_kobj->kset) |
320 | goto out; | |
5c5daf65 | 321 | |
16574dcc KS |
322 | kset = top_kobj->kset; |
323 | if (!kset->uevent_ops || !kset->uevent_ops->uevent) | |
324 | goto out; | |
325 | ||
326 | /* respect filter */ | |
327 | if (kset->uevent_ops && kset->uevent_ops->filter) | |
328 | if (!kset->uevent_ops->filter(kset, &dev->kobj)) | |
329 | goto out; | |
330 | ||
7eff2e7a KS |
331 | env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL); |
332 | if (!env) | |
c7308c81 GKH |
333 | return -ENOMEM; |
334 | ||
16574dcc | 335 | /* let the kset specific function add its keys */ |
7eff2e7a | 336 | retval = kset->uevent_ops->uevent(kset, &dev->kobj, env); |
16574dcc KS |
337 | if (retval) |
338 | goto out; | |
339 | ||
340 | /* copy keys to file */ | |
7eff2e7a KS |
341 | for (i = 0; i < env->envp_idx; i++) |
342 | count += sprintf(&buf[count], "%s\n", env->envp[i]); | |
16574dcc | 343 | out: |
7eff2e7a | 344 | kfree(env); |
16574dcc KS |
345 | return count; |
346 | } | |
347 | ||
a7fd6706 KS |
348 | static ssize_t store_uevent(struct device *dev, struct device_attribute *attr, |
349 | const char *buf, size_t count) | |
350 | { | |
60a96a59 KS |
351 | enum kobject_action action; |
352 | ||
3f5468c9 | 353 | if (kobject_action_type(buf, count, &action) == 0) |
60a96a59 | 354 | kobject_uevent(&dev->kobj, action); |
3f5468c9 KS |
355 | else |
356 | dev_err(dev, "uevent: unknown action-string\n"); | |
a7fd6706 KS |
357 | return count; |
358 | } | |
359 | ||
ad6a1e1c TH |
360 | static struct device_attribute uevent_attr = |
361 | __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent); | |
362 | ||
621a1672 DT |
363 | static int device_add_attributes(struct device *dev, |
364 | struct device_attribute *attrs) | |
de0ff00d | 365 | { |
621a1672 | 366 | int error = 0; |
de0ff00d | 367 | int i; |
621a1672 DT |
368 | |
369 | if (attrs) { | |
370 | for (i = 0; attr_name(attrs[i]); i++) { | |
371 | error = device_create_file(dev, &attrs[i]); | |
372 | if (error) | |
373 | break; | |
374 | } | |
375 | if (error) | |
376 | while (--i >= 0) | |
377 | device_remove_file(dev, &attrs[i]); | |
378 | } | |
379 | return error; | |
380 | } | |
381 | ||
382 | static void device_remove_attributes(struct device *dev, | |
383 | struct device_attribute *attrs) | |
384 | { | |
385 | int i; | |
386 | ||
387 | if (attrs) | |
388 | for (i = 0; attr_name(attrs[i]); i++) | |
389 | device_remove_file(dev, &attrs[i]); | |
390 | } | |
391 | ||
c97415a7 SA |
392 | static int device_add_bin_attributes(struct device *dev, |
393 | struct bin_attribute *attrs) | |
394 | { | |
395 | int error = 0; | |
396 | int i; | |
397 | ||
398 | if (attrs) { | |
399 | for (i = 0; attr_name(attrs[i]); i++) { | |
400 | error = device_create_bin_file(dev, &attrs[i]); | |
401 | if (error) | |
402 | break; | |
403 | } | |
404 | if (error) | |
405 | while (--i >= 0) | |
406 | device_remove_bin_file(dev, &attrs[i]); | |
407 | } | |
408 | return error; | |
409 | } | |
410 | ||
411 | static void device_remove_bin_attributes(struct device *dev, | |
412 | struct bin_attribute *attrs) | |
413 | { | |
414 | int i; | |
415 | ||
416 | if (attrs) | |
417 | for (i = 0; attr_name(attrs[i]); i++) | |
418 | device_remove_bin_file(dev, &attrs[i]); | |
419 | } | |
420 | ||
621a1672 | 421 | static int device_add_groups(struct device *dev, |
a4dbd674 | 422 | const struct attribute_group **groups) |
621a1672 | 423 | { |
de0ff00d | 424 | int error = 0; |
621a1672 | 425 | int i; |
de0ff00d | 426 | |
621a1672 DT |
427 | if (groups) { |
428 | for (i = 0; groups[i]; i++) { | |
429 | error = sysfs_create_group(&dev->kobj, groups[i]); | |
de0ff00d GKH |
430 | if (error) { |
431 | while (--i >= 0) | |
4a3ad20c GKH |
432 | sysfs_remove_group(&dev->kobj, |
433 | groups[i]); | |
621a1672 | 434 | break; |
de0ff00d GKH |
435 | } |
436 | } | |
437 | } | |
de0ff00d GKH |
438 | return error; |
439 | } | |
440 | ||
621a1672 | 441 | static void device_remove_groups(struct device *dev, |
a4dbd674 | 442 | const struct attribute_group **groups) |
de0ff00d GKH |
443 | { |
444 | int i; | |
621a1672 DT |
445 | |
446 | if (groups) | |
447 | for (i = 0; groups[i]; i++) | |
448 | sysfs_remove_group(&dev->kobj, groups[i]); | |
de0ff00d GKH |
449 | } |
450 | ||
2620efef GKH |
451 | static int device_add_attrs(struct device *dev) |
452 | { | |
453 | struct class *class = dev->class; | |
aed65af1 | 454 | const struct device_type *type = dev->type; |
621a1672 | 455 | int error; |
2620efef | 456 | |
621a1672 DT |
457 | if (class) { |
458 | error = device_add_attributes(dev, class->dev_attrs); | |
f9f852df | 459 | if (error) |
621a1672 | 460 | return error; |
c97415a7 SA |
461 | error = device_add_bin_attributes(dev, class->dev_bin_attrs); |
462 | if (error) | |
463 | goto err_remove_class_attrs; | |
2620efef | 464 | } |
f9f852df | 465 | |
621a1672 DT |
466 | if (type) { |
467 | error = device_add_groups(dev, type->groups); | |
f9f852df | 468 | if (error) |
c97415a7 | 469 | goto err_remove_class_bin_attrs; |
f9f852df KS |
470 | } |
471 | ||
621a1672 DT |
472 | error = device_add_groups(dev, dev->groups); |
473 | if (error) | |
474 | goto err_remove_type_groups; | |
475 | ||
476 | return 0; | |
477 | ||
478 | err_remove_type_groups: | |
479 | if (type) | |
480 | device_remove_groups(dev, type->groups); | |
c97415a7 SA |
481 | err_remove_class_bin_attrs: |
482 | if (class) | |
483 | device_remove_bin_attributes(dev, class->dev_bin_attrs); | |
621a1672 DT |
484 | err_remove_class_attrs: |
485 | if (class) | |
486 | device_remove_attributes(dev, class->dev_attrs); | |
487 | ||
2620efef GKH |
488 | return error; |
489 | } | |
490 | ||
491 | static void device_remove_attrs(struct device *dev) | |
492 | { | |
493 | struct class *class = dev->class; | |
aed65af1 | 494 | const struct device_type *type = dev->type; |
2620efef | 495 | |
621a1672 | 496 | device_remove_groups(dev, dev->groups); |
f9f852df | 497 | |
621a1672 DT |
498 | if (type) |
499 | device_remove_groups(dev, type->groups); | |
500 | ||
c97415a7 | 501 | if (class) { |
621a1672 | 502 | device_remove_attributes(dev, class->dev_attrs); |
c97415a7 SA |
503 | device_remove_bin_attributes(dev, class->dev_bin_attrs); |
504 | } | |
2620efef GKH |
505 | } |
506 | ||
507 | ||
23681e47 GKH |
508 | static ssize_t show_dev(struct device *dev, struct device_attribute *attr, |
509 | char *buf) | |
510 | { | |
511 | return print_dev_t(buf, dev->devt); | |
512 | } | |
513 | ||
ad6a1e1c TH |
514 | static struct device_attribute devt_attr = |
515 | __ATTR(dev, S_IRUGO, show_dev, NULL); | |
516 | ||
ca22e56d | 517 | /* /sys/devices/ */ |
881c6cfd | 518 | struct kset *devices_kset; |
1da177e4 | 519 | |
1da177e4 | 520 | /** |
4a3ad20c GKH |
521 | * device_create_file - create sysfs attribute file for device. |
522 | * @dev: device. | |
523 | * @attr: device attribute descriptor. | |
1da177e4 | 524 | */ |
26579ab7 PC |
525 | int device_create_file(struct device *dev, |
526 | const struct device_attribute *attr) | |
1da177e4 LT |
527 | { |
528 | int error = 0; | |
0c98b19f | 529 | if (dev) |
1da177e4 | 530 | error = sysfs_create_file(&dev->kobj, &attr->attr); |
1da177e4 LT |
531 | return error; |
532 | } | |
533 | ||
534 | /** | |
4a3ad20c GKH |
535 | * device_remove_file - remove sysfs attribute file. |
536 | * @dev: device. | |
537 | * @attr: device attribute descriptor. | |
1da177e4 | 538 | */ |
26579ab7 PC |
539 | void device_remove_file(struct device *dev, |
540 | const struct device_attribute *attr) | |
1da177e4 | 541 | { |
0c98b19f | 542 | if (dev) |
1da177e4 | 543 | sysfs_remove_file(&dev->kobj, &attr->attr); |
1da177e4 LT |
544 | } |
545 | ||
2589f188 GKH |
546 | /** |
547 | * device_create_bin_file - create sysfs binary attribute file for device. | |
548 | * @dev: device. | |
549 | * @attr: device binary attribute descriptor. | |
550 | */ | |
66ecb92b PC |
551 | int device_create_bin_file(struct device *dev, |
552 | const struct bin_attribute *attr) | |
2589f188 GKH |
553 | { |
554 | int error = -EINVAL; | |
555 | if (dev) | |
556 | error = sysfs_create_bin_file(&dev->kobj, attr); | |
557 | return error; | |
558 | } | |
559 | EXPORT_SYMBOL_GPL(device_create_bin_file); | |
560 | ||
561 | /** | |
562 | * device_remove_bin_file - remove sysfs binary attribute file | |
563 | * @dev: device. | |
564 | * @attr: device binary attribute descriptor. | |
565 | */ | |
66ecb92b PC |
566 | void device_remove_bin_file(struct device *dev, |
567 | const struct bin_attribute *attr) | |
2589f188 GKH |
568 | { |
569 | if (dev) | |
570 | sysfs_remove_bin_file(&dev->kobj, attr); | |
571 | } | |
572 | EXPORT_SYMBOL_GPL(device_remove_bin_file); | |
573 | ||
d9a9cdfb | 574 | /** |
523ded71 | 575 | * device_schedule_callback_owner - helper to schedule a callback for a device |
d9a9cdfb AS |
576 | * @dev: device. |
577 | * @func: callback function to invoke later. | |
523ded71 | 578 | * @owner: module owning the callback routine |
d9a9cdfb AS |
579 | * |
580 | * Attribute methods must not unregister themselves or their parent device | |
581 | * (which would amount to the same thing). Attempts to do so will deadlock, | |
582 | * since unregistration is mutually exclusive with driver callbacks. | |
583 | * | |
584 | * Instead methods can call this routine, which will attempt to allocate | |
585 | * and schedule a workqueue request to call back @func with @dev as its | |
586 | * argument in the workqueue's process context. @dev will be pinned until | |
587 | * @func returns. | |
588 | * | |
523ded71 AS |
589 | * This routine is usually called via the inline device_schedule_callback(), |
590 | * which automatically sets @owner to THIS_MODULE. | |
591 | * | |
d9a9cdfb | 592 | * Returns 0 if the request was submitted, -ENOMEM if storage could not |
523ded71 | 593 | * be allocated, -ENODEV if a reference to @owner isn't available. |
d9a9cdfb AS |
594 | * |
595 | * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an | |
596 | * underlying sysfs routine (since it is intended for use by attribute | |
597 | * methods), and if sysfs isn't available you'll get nothing but -ENOSYS. | |
598 | */ | |
523ded71 AS |
599 | int device_schedule_callback_owner(struct device *dev, |
600 | void (*func)(struct device *), struct module *owner) | |
d9a9cdfb AS |
601 | { |
602 | return sysfs_schedule_callback(&dev->kobj, | |
523ded71 | 603 | (void (*)(void *)) func, dev, owner); |
d9a9cdfb | 604 | } |
523ded71 | 605 | EXPORT_SYMBOL_GPL(device_schedule_callback_owner); |
d9a9cdfb | 606 | |
34bb61f9 JB |
607 | static void klist_children_get(struct klist_node *n) |
608 | { | |
f791b8c8 GKH |
609 | struct device_private *p = to_device_private_parent(n); |
610 | struct device *dev = p->device; | |
34bb61f9 JB |
611 | |
612 | get_device(dev); | |
613 | } | |
614 | ||
615 | static void klist_children_put(struct klist_node *n) | |
616 | { | |
f791b8c8 GKH |
617 | struct device_private *p = to_device_private_parent(n); |
618 | struct device *dev = p->device; | |
34bb61f9 JB |
619 | |
620 | put_device(dev); | |
621 | } | |
622 | ||
1da177e4 | 623 | /** |
4a3ad20c GKH |
624 | * device_initialize - init device structure. |
625 | * @dev: device. | |
1da177e4 | 626 | * |
5739411a CH |
627 | * This prepares the device for use by other layers by initializing |
628 | * its fields. | |
4a3ad20c | 629 | * It is the first half of device_register(), if called by |
5739411a CH |
630 | * that function, though it can also be called separately, so one |
631 | * may use @dev's fields. In particular, get_device()/put_device() | |
632 | * may be used for reference counting of @dev after calling this | |
633 | * function. | |
634 | * | |
b10d5efd AS |
635 | * All fields in @dev must be initialized by the caller to 0, except |
636 | * for those explicitly set to some other value. The simplest | |
637 | * approach is to use kzalloc() to allocate the structure containing | |
638 | * @dev. | |
639 | * | |
5739411a CH |
640 | * NOTE: Use put_device() to give up your reference instead of freeing |
641 | * @dev directly once you have called this function. | |
1da177e4 | 642 | */ |
1da177e4 LT |
643 | void device_initialize(struct device *dev) |
644 | { | |
881c6cfd | 645 | dev->kobj.kset = devices_kset; |
f9cb074b | 646 | kobject_init(&dev->kobj, &device_ktype); |
d1c3414c | 647 | INIT_LIST_HEAD(&dev->deferred_probe); |
1da177e4 | 648 | INIT_LIST_HEAD(&dev->dma_pools); |
3142788b | 649 | mutex_init(&dev->mutex); |
1704f47b | 650 | lockdep_set_novalidate_class(&dev->mutex); |
9ac7849e TH |
651 | spin_lock_init(&dev->devres_lock); |
652 | INIT_LIST_HEAD(&dev->devres_head); | |
3b98aeaf | 653 | device_pm_init(dev); |
87348136 | 654 | set_dev_node(dev, -1); |
1da177e4 LT |
655 | } |
656 | ||
86406245 | 657 | static struct kobject *virtual_device_parent(struct device *dev) |
f0ee61a6 | 658 | { |
86406245 | 659 | static struct kobject *virtual_dir = NULL; |
f0ee61a6 | 660 | |
86406245 | 661 | if (!virtual_dir) |
4ff6abff | 662 | virtual_dir = kobject_create_and_add("virtual", |
881c6cfd | 663 | &devices_kset->kobj); |
f0ee61a6 | 664 | |
86406245 | 665 | return virtual_dir; |
f0ee61a6 GKH |
666 | } |
667 | ||
bc451f20 EB |
668 | struct class_dir { |
669 | struct kobject kobj; | |
670 | struct class *class; | |
671 | }; | |
672 | ||
673 | #define to_class_dir(obj) container_of(obj, struct class_dir, kobj) | |
674 | ||
675 | static void class_dir_release(struct kobject *kobj) | |
676 | { | |
677 | struct class_dir *dir = to_class_dir(kobj); | |
678 | kfree(dir); | |
679 | } | |
680 | ||
681 | static const | |
682 | struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj) | |
40fa5422 | 683 | { |
bc451f20 EB |
684 | struct class_dir *dir = to_class_dir(kobj); |
685 | return dir->class->ns_type; | |
686 | } | |
687 | ||
688 | static struct kobj_type class_dir_ktype = { | |
689 | .release = class_dir_release, | |
690 | .sysfs_ops = &kobj_sysfs_ops, | |
691 | .child_ns_type = class_dir_child_ns_type | |
692 | }; | |
693 | ||
694 | static struct kobject * | |
695 | class_dir_create_and_add(struct class *class, struct kobject *parent_kobj) | |
696 | { | |
697 | struct class_dir *dir; | |
43968d2f GKH |
698 | int retval; |
699 | ||
bc451f20 EB |
700 | dir = kzalloc(sizeof(*dir), GFP_KERNEL); |
701 | if (!dir) | |
702 | return NULL; | |
703 | ||
704 | dir->class = class; | |
705 | kobject_init(&dir->kobj, &class_dir_ktype); | |
706 | ||
6b6e39a6 | 707 | dir->kobj.kset = &class->p->glue_dirs; |
bc451f20 EB |
708 | |
709 | retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name); | |
710 | if (retval < 0) { | |
711 | kobject_put(&dir->kobj); | |
712 | return NULL; | |
713 | } | |
714 | return &dir->kobj; | |
715 | } | |
716 | ||
717 | ||
718 | static struct kobject *get_device_parent(struct device *dev, | |
719 | struct device *parent) | |
720 | { | |
86406245 | 721 | if (dev->class) { |
77d3d7c1 | 722 | static DEFINE_MUTEX(gdp_mutex); |
86406245 KS |
723 | struct kobject *kobj = NULL; |
724 | struct kobject *parent_kobj; | |
725 | struct kobject *k; | |
726 | ||
ead454fe | 727 | #ifdef CONFIG_BLOCK |
39aba963 | 728 | /* block disks show up in /sys/block */ |
e52eec13 | 729 | if (sysfs_deprecated && dev->class == &block_class) { |
39aba963 KS |
730 | if (parent && parent->class == &block_class) |
731 | return &parent->kobj; | |
6b6e39a6 | 732 | return &block_class.p->subsys.kobj; |
39aba963 | 733 | } |
ead454fe | 734 | #endif |
e52eec13 | 735 | |
86406245 KS |
736 | /* |
737 | * If we have no parent, we live in "virtual". | |
0f4dafc0 KS |
738 | * Class-devices with a non class-device as parent, live |
739 | * in a "glue" directory to prevent namespace collisions. | |
86406245 KS |
740 | */ |
741 | if (parent == NULL) | |
742 | parent_kobj = virtual_device_parent(dev); | |
24b1442d | 743 | else if (parent->class && !dev->class->ns_type) |
86406245 KS |
744 | return &parent->kobj; |
745 | else | |
746 | parent_kobj = &parent->kobj; | |
747 | ||
77d3d7c1 TH |
748 | mutex_lock(&gdp_mutex); |
749 | ||
86406245 | 750 | /* find our class-directory at the parent and reference it */ |
6b6e39a6 KS |
751 | spin_lock(&dev->class->p->glue_dirs.list_lock); |
752 | list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry) | |
86406245 KS |
753 | if (k->parent == parent_kobj) { |
754 | kobj = kobject_get(k); | |
755 | break; | |
756 | } | |
6b6e39a6 | 757 | spin_unlock(&dev->class->p->glue_dirs.list_lock); |
77d3d7c1 TH |
758 | if (kobj) { |
759 | mutex_unlock(&gdp_mutex); | |
86406245 | 760 | return kobj; |
77d3d7c1 | 761 | } |
86406245 KS |
762 | |
763 | /* or create a new class-directory at the parent device */ | |
bc451f20 | 764 | k = class_dir_create_and_add(dev->class, parent_kobj); |
0f4dafc0 | 765 | /* do not emit an uevent for this simple "glue" directory */ |
77d3d7c1 | 766 | mutex_unlock(&gdp_mutex); |
43968d2f | 767 | return k; |
86406245 KS |
768 | } |
769 | ||
ca22e56d KS |
770 | /* subsystems can specify a default root directory for their devices */ |
771 | if (!parent && dev->bus && dev->bus->dev_root) | |
772 | return &dev->bus->dev_root->kobj; | |
773 | ||
86406245 | 774 | if (parent) |
c744aeae CH |
775 | return &parent->kobj; |
776 | return NULL; | |
777 | } | |
da231fd5 | 778 | |
63b6971a | 779 | static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir) |
da231fd5 | 780 | { |
0f4dafc0 | 781 | /* see if we live in a "glue" directory */ |
c1fe539a | 782 | if (!glue_dir || !dev->class || |
6b6e39a6 | 783 | glue_dir->kset != &dev->class->p->glue_dirs) |
da231fd5 KS |
784 | return; |
785 | ||
0f4dafc0 | 786 | kobject_put(glue_dir); |
da231fd5 | 787 | } |
63b6971a CH |
788 | |
789 | static void cleanup_device_parent(struct device *dev) | |
790 | { | |
791 | cleanup_glue_dir(dev, dev->kobj.parent); | |
792 | } | |
86406245 | 793 | |
2ee97caf CH |
794 | static int device_add_class_symlinks(struct device *dev) |
795 | { | |
796 | int error; | |
797 | ||
798 | if (!dev->class) | |
799 | return 0; | |
da231fd5 | 800 | |
1fbfee6c | 801 | error = sysfs_create_link(&dev->kobj, |
6b6e39a6 | 802 | &dev->class->p->subsys.kobj, |
2ee97caf CH |
803 | "subsystem"); |
804 | if (error) | |
805 | goto out; | |
da231fd5 | 806 | |
4e886c29 | 807 | if (dev->parent && device_is_not_partition(dev)) { |
39aba963 | 808 | error = sysfs_create_link(&dev->kobj, &dev->parent->kobj, |
4f01a757 DT |
809 | "device"); |
810 | if (error) | |
39aba963 | 811 | goto out_subsys; |
2ee97caf | 812 | } |
2ee97caf | 813 | |
ead454fe | 814 | #ifdef CONFIG_BLOCK |
39aba963 | 815 | /* /sys/block has directories and does not need symlinks */ |
e52eec13 | 816 | if (sysfs_deprecated && dev->class == &block_class) |
39aba963 | 817 | return 0; |
ead454fe | 818 | #endif |
39aba963 | 819 | |
da231fd5 | 820 | /* link in the class directory pointing to the device */ |
6b6e39a6 | 821 | error = sysfs_create_link(&dev->class->p->subsys.kobj, |
1e0b2cf9 | 822 | &dev->kobj, dev_name(dev)); |
da231fd5 | 823 | if (error) |
39aba963 | 824 | goto out_device; |
da231fd5 | 825 | |
da231fd5 KS |
826 | return 0; |
827 | ||
39aba963 KS |
828 | out_device: |
829 | sysfs_remove_link(&dev->kobj, "device"); | |
da231fd5 | 830 | |
2ee97caf CH |
831 | out_subsys: |
832 | sysfs_remove_link(&dev->kobj, "subsystem"); | |
833 | out: | |
834 | return error; | |
835 | } | |
836 | ||
837 | static void device_remove_class_symlinks(struct device *dev) | |
838 | { | |
839 | if (!dev->class) | |
840 | return; | |
da231fd5 | 841 | |
4e886c29 | 842 | if (dev->parent && device_is_not_partition(dev)) |
da231fd5 | 843 | sysfs_remove_link(&dev->kobj, "device"); |
2ee97caf | 844 | sysfs_remove_link(&dev->kobj, "subsystem"); |
ead454fe | 845 | #ifdef CONFIG_BLOCK |
e52eec13 | 846 | if (sysfs_deprecated && dev->class == &block_class) |
39aba963 | 847 | return; |
ead454fe | 848 | #endif |
6b6e39a6 | 849 | sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev)); |
2ee97caf CH |
850 | } |
851 | ||
413c239f SR |
852 | /** |
853 | * dev_set_name - set a device name | |
854 | * @dev: device | |
46232366 | 855 | * @fmt: format string for the device's name |
413c239f SR |
856 | */ |
857 | int dev_set_name(struct device *dev, const char *fmt, ...) | |
858 | { | |
859 | va_list vargs; | |
1fa5ae85 | 860 | int err; |
413c239f SR |
861 | |
862 | va_start(vargs, fmt); | |
1fa5ae85 | 863 | err = kobject_set_name_vargs(&dev->kobj, fmt, vargs); |
413c239f | 864 | va_end(vargs); |
1fa5ae85 | 865 | return err; |
413c239f SR |
866 | } |
867 | EXPORT_SYMBOL_GPL(dev_set_name); | |
868 | ||
e105b8bf DW |
869 | /** |
870 | * device_to_dev_kobj - select a /sys/dev/ directory for the device | |
871 | * @dev: device | |
872 | * | |
873 | * By default we select char/ for new entries. Setting class->dev_obj | |
874 | * to NULL prevents an entry from being created. class->dev_kobj must | |
875 | * be set (or cleared) before any devices are registered to the class | |
876 | * otherwise device_create_sys_dev_entry() and | |
877 | * device_remove_sys_dev_entry() will disagree about the the presence | |
878 | * of the link. | |
879 | */ | |
880 | static struct kobject *device_to_dev_kobj(struct device *dev) | |
881 | { | |
882 | struct kobject *kobj; | |
883 | ||
884 | if (dev->class) | |
885 | kobj = dev->class->dev_kobj; | |
886 | else | |
887 | kobj = sysfs_dev_char_kobj; | |
888 | ||
889 | return kobj; | |
890 | } | |
891 | ||
892 | static int device_create_sys_dev_entry(struct device *dev) | |
893 | { | |
894 | struct kobject *kobj = device_to_dev_kobj(dev); | |
895 | int error = 0; | |
896 | char devt_str[15]; | |
897 | ||
898 | if (kobj) { | |
899 | format_dev_t(devt_str, dev->devt); | |
900 | error = sysfs_create_link(kobj, &dev->kobj, devt_str); | |
901 | } | |
902 | ||
903 | return error; | |
904 | } | |
905 | ||
906 | static void device_remove_sys_dev_entry(struct device *dev) | |
907 | { | |
908 | struct kobject *kobj = device_to_dev_kobj(dev); | |
909 | char devt_str[15]; | |
910 | ||
911 | if (kobj) { | |
912 | format_dev_t(devt_str, dev->devt); | |
913 | sysfs_remove_link(kobj, devt_str); | |
914 | } | |
915 | } | |
916 | ||
b4028437 GKH |
917 | int device_private_init(struct device *dev) |
918 | { | |
919 | dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL); | |
920 | if (!dev->p) | |
921 | return -ENOMEM; | |
922 | dev->p->device = dev; | |
923 | klist_init(&dev->p->klist_children, klist_children_get, | |
924 | klist_children_put); | |
925 | return 0; | |
926 | } | |
927 | ||
1da177e4 | 928 | /** |
4a3ad20c GKH |
929 | * device_add - add device to device hierarchy. |
930 | * @dev: device. | |
1da177e4 | 931 | * |
4a3ad20c GKH |
932 | * This is part 2 of device_register(), though may be called |
933 | * separately _iff_ device_initialize() has been called separately. | |
1da177e4 | 934 | * |
5739411a | 935 | * This adds @dev to the kobject hierarchy via kobject_add(), adds it |
4a3ad20c GKH |
936 | * to the global and sibling lists for the device, then |
937 | * adds it to the other relevant subsystems of the driver model. | |
5739411a | 938 | * |
b10d5efd AS |
939 | * Do not call this routine or device_register() more than once for |
940 | * any device structure. The driver model core is not designed to work | |
941 | * with devices that get unregistered and then spring back to life. | |
942 | * (Among other things, it's very hard to guarantee that all references | |
943 | * to the previous incarnation of @dev have been dropped.) Allocate | |
944 | * and register a fresh new struct device instead. | |
945 | * | |
5739411a CH |
946 | * NOTE: _Never_ directly free @dev after calling this function, even |
947 | * if it returned an error! Always use put_device() to give up your | |
948 | * reference instead. | |
1da177e4 LT |
949 | */ |
950 | int device_add(struct device *dev) | |
951 | { | |
952 | struct device *parent = NULL; | |
ca22e56d | 953 | struct kobject *kobj; |
c47ed219 | 954 | struct class_interface *class_intf; |
c906a48a | 955 | int error = -EINVAL; |
775b64d2 | 956 | |
1da177e4 | 957 | dev = get_device(dev); |
c906a48a GKH |
958 | if (!dev) |
959 | goto done; | |
960 | ||
fb069a5d | 961 | if (!dev->p) { |
b4028437 GKH |
962 | error = device_private_init(dev); |
963 | if (error) | |
964 | goto done; | |
fb069a5d | 965 | } |
fb069a5d | 966 | |
1fa5ae85 KS |
967 | /* |
968 | * for statically allocated devices, which should all be converted | |
969 | * some day, we need to initialize the name. We prevent reading back | |
970 | * the name, and force the use of dev_name() | |
971 | */ | |
972 | if (dev->init_name) { | |
acc0e90f | 973 | dev_set_name(dev, "%s", dev->init_name); |
1fa5ae85 KS |
974 | dev->init_name = NULL; |
975 | } | |
c906a48a | 976 | |
ca22e56d KS |
977 | /* subsystems can specify simple device enumeration */ |
978 | if (!dev_name(dev) && dev->bus && dev->bus->dev_name) | |
979 | dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id); | |
980 | ||
e6309e75 TG |
981 | if (!dev_name(dev)) { |
982 | error = -EINVAL; | |
5c8563d7 | 983 | goto name_error; |
e6309e75 | 984 | } |
1da177e4 | 985 | |
1e0b2cf9 | 986 | pr_debug("device: '%s': %s\n", dev_name(dev), __func__); |
c205ef48 | 987 | |
1da177e4 | 988 | parent = get_device(dev->parent); |
ca22e56d KS |
989 | kobj = get_device_parent(dev, parent); |
990 | if (kobj) | |
991 | dev->kobj.parent = kobj; | |
1da177e4 | 992 | |
0d358f22 YL |
993 | /* use parent numa_node */ |
994 | if (parent) | |
995 | set_dev_node(dev, dev_to_node(parent)); | |
996 | ||
1da177e4 | 997 | /* first, register with generic layer. */ |
8a577ffc KS |
998 | /* we require the name to be set before, and pass NULL */ |
999 | error = kobject_add(&dev->kobj, dev->kobj.parent, NULL); | |
40fa5422 | 1000 | if (error) |
1da177e4 | 1001 | goto Error; |
a7fd6706 | 1002 | |
37022644 BW |
1003 | /* notify platform of device entry */ |
1004 | if (platform_notify) | |
1005 | platform_notify(dev); | |
1006 | ||
ad6a1e1c | 1007 | error = device_create_file(dev, &uevent_attr); |
a306eea4 CH |
1008 | if (error) |
1009 | goto attrError; | |
a7fd6706 | 1010 | |
23681e47 | 1011 | if (MAJOR(dev->devt)) { |
ad6a1e1c TH |
1012 | error = device_create_file(dev, &devt_attr); |
1013 | if (error) | |
a306eea4 | 1014 | goto ueventattrError; |
e105b8bf DW |
1015 | |
1016 | error = device_create_sys_dev_entry(dev); | |
1017 | if (error) | |
1018 | goto devtattrError; | |
2b2af54a KS |
1019 | |
1020 | devtmpfs_create_node(dev); | |
23681e47 GKH |
1021 | } |
1022 | ||
2ee97caf CH |
1023 | error = device_add_class_symlinks(dev); |
1024 | if (error) | |
1025 | goto SymlinkError; | |
dc0afa83 CH |
1026 | error = device_add_attrs(dev); |
1027 | if (error) | |
2620efef | 1028 | goto AttrsError; |
dc0afa83 CH |
1029 | error = bus_add_device(dev); |
1030 | if (error) | |
1da177e4 | 1031 | goto BusError; |
3b98aeaf | 1032 | error = dpm_sysfs_add(dev); |
57eee3d2 | 1033 | if (error) |
3b98aeaf AS |
1034 | goto DPMError; |
1035 | device_pm_add(dev); | |
ec0676ee AS |
1036 | |
1037 | /* Notify clients of device addition. This call must come | |
268863f4 | 1038 | * after dpm_sysfs_add() and before kobject_uevent(). |
ec0676ee AS |
1039 | */ |
1040 | if (dev->bus) | |
1041 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
1042 | BUS_NOTIFY_ADD_DEVICE, dev); | |
1043 | ||
83b5fb4c | 1044 | kobject_uevent(&dev->kobj, KOBJ_ADD); |
2023c610 | 1045 | bus_probe_device(dev); |
1da177e4 | 1046 | if (parent) |
f791b8c8 GKH |
1047 | klist_add_tail(&dev->p->knode_parent, |
1048 | &parent->p->klist_children); | |
1da177e4 | 1049 | |
5d9fd169 | 1050 | if (dev->class) { |
ca22e56d | 1051 | mutex_lock(&dev->class->p->mutex); |
c47ed219 | 1052 | /* tie the class to the device */ |
5a3ceb86 | 1053 | klist_add_tail(&dev->knode_class, |
6b6e39a6 | 1054 | &dev->class->p->klist_devices); |
c47ed219 GKH |
1055 | |
1056 | /* notify any interfaces that the device is here */ | |
184f1f77 | 1057 | list_for_each_entry(class_intf, |
ca22e56d | 1058 | &dev->class->p->interfaces, node) |
c47ed219 GKH |
1059 | if (class_intf->add_dev) |
1060 | class_intf->add_dev(dev, class_intf); | |
ca22e56d | 1061 | mutex_unlock(&dev->class->p->mutex); |
5d9fd169 | 1062 | } |
c906a48a | 1063 | done: |
1da177e4 LT |
1064 | put_device(dev); |
1065 | return error; | |
3b98aeaf | 1066 | DPMError: |
57eee3d2 RW |
1067 | bus_remove_device(dev); |
1068 | BusError: | |
82f0cf9b | 1069 | device_remove_attrs(dev); |
2620efef | 1070 | AttrsError: |
2ee97caf CH |
1071 | device_remove_class_symlinks(dev); |
1072 | SymlinkError: | |
ad72956d KS |
1073 | if (MAJOR(dev->devt)) |
1074 | devtmpfs_delete_node(dev); | |
e105b8bf DW |
1075 | if (MAJOR(dev->devt)) |
1076 | device_remove_sys_dev_entry(dev); | |
1077 | devtattrError: | |
ad6a1e1c TH |
1078 | if (MAJOR(dev->devt)) |
1079 | device_remove_file(dev, &devt_attr); | |
a306eea4 | 1080 | ueventattrError: |
ad6a1e1c | 1081 | device_remove_file(dev, &uevent_attr); |
23681e47 | 1082 | attrError: |
312c004d | 1083 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
1da177e4 LT |
1084 | kobject_del(&dev->kobj); |
1085 | Error: | |
63b6971a | 1086 | cleanup_device_parent(dev); |
1da177e4 LT |
1087 | if (parent) |
1088 | put_device(parent); | |
5c8563d7 KS |
1089 | name_error: |
1090 | kfree(dev->p); | |
1091 | dev->p = NULL; | |
c906a48a | 1092 | goto done; |
1da177e4 LT |
1093 | } |
1094 | ||
1da177e4 | 1095 | /** |
4a3ad20c GKH |
1096 | * device_register - register a device with the system. |
1097 | * @dev: pointer to the device structure | |
1da177e4 | 1098 | * |
4a3ad20c GKH |
1099 | * This happens in two clean steps - initialize the device |
1100 | * and add it to the system. The two steps can be called | |
1101 | * separately, but this is the easiest and most common. | |
1102 | * I.e. you should only call the two helpers separately if | |
1103 | * have a clearly defined need to use and refcount the device | |
1104 | * before it is added to the hierarchy. | |
5739411a | 1105 | * |
b10d5efd AS |
1106 | * For more information, see the kerneldoc for device_initialize() |
1107 | * and device_add(). | |
1108 | * | |
5739411a CH |
1109 | * NOTE: _Never_ directly free @dev after calling this function, even |
1110 | * if it returned an error! Always use put_device() to give up the | |
1111 | * reference initialized in this function instead. | |
1da177e4 | 1112 | */ |
1da177e4 LT |
1113 | int device_register(struct device *dev) |
1114 | { | |
1115 | device_initialize(dev); | |
1116 | return device_add(dev); | |
1117 | } | |
1118 | ||
1da177e4 | 1119 | /** |
4a3ad20c GKH |
1120 | * get_device - increment reference count for device. |
1121 | * @dev: device. | |
1da177e4 | 1122 | * |
4a3ad20c GKH |
1123 | * This simply forwards the call to kobject_get(), though |
1124 | * we do take care to provide for the case that we get a NULL | |
1125 | * pointer passed in. | |
1da177e4 | 1126 | */ |
4a3ad20c | 1127 | struct device *get_device(struct device *dev) |
1da177e4 LT |
1128 | { |
1129 | return dev ? to_dev(kobject_get(&dev->kobj)) : NULL; | |
1130 | } | |
1131 | ||
1da177e4 | 1132 | /** |
4a3ad20c GKH |
1133 | * put_device - decrement reference count. |
1134 | * @dev: device in question. | |
1da177e4 | 1135 | */ |
4a3ad20c | 1136 | void put_device(struct device *dev) |
1da177e4 | 1137 | { |
edfaa7c3 | 1138 | /* might_sleep(); */ |
1da177e4 LT |
1139 | if (dev) |
1140 | kobject_put(&dev->kobj); | |
1141 | } | |
1142 | ||
1da177e4 | 1143 | /** |
4a3ad20c GKH |
1144 | * device_del - delete device from system. |
1145 | * @dev: device. | |
1da177e4 | 1146 | * |
4a3ad20c GKH |
1147 | * This is the first part of the device unregistration |
1148 | * sequence. This removes the device from the lists we control | |
1149 | * from here, has it removed from the other driver model | |
1150 | * subsystems it was added to in device_add(), and removes it | |
1151 | * from the kobject hierarchy. | |
1da177e4 | 1152 | * |
4a3ad20c GKH |
1153 | * NOTE: this should be called manually _iff_ device_add() was |
1154 | * also called manually. | |
1da177e4 | 1155 | */ |
4a3ad20c | 1156 | void device_del(struct device *dev) |
1da177e4 | 1157 | { |
4a3ad20c | 1158 | struct device *parent = dev->parent; |
c47ed219 | 1159 | struct class_interface *class_intf; |
1da177e4 | 1160 | |
ec0676ee AS |
1161 | /* Notify clients of device removal. This call must come |
1162 | * before dpm_sysfs_remove(). | |
1163 | */ | |
1164 | if (dev->bus) | |
1165 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, | |
1166 | BUS_NOTIFY_DEL_DEVICE, dev); | |
775b64d2 | 1167 | device_pm_remove(dev); |
3b98aeaf | 1168 | dpm_sysfs_remove(dev); |
1da177e4 | 1169 | if (parent) |
f791b8c8 | 1170 | klist_del(&dev->p->knode_parent); |
e105b8bf | 1171 | if (MAJOR(dev->devt)) { |
2b2af54a | 1172 | devtmpfs_delete_node(dev); |
e105b8bf | 1173 | device_remove_sys_dev_entry(dev); |
ad6a1e1c | 1174 | device_remove_file(dev, &devt_attr); |
e105b8bf | 1175 | } |
b9d9c82b | 1176 | if (dev->class) { |
da231fd5 | 1177 | device_remove_class_symlinks(dev); |
99ef3ef8 | 1178 | |
ca22e56d | 1179 | mutex_lock(&dev->class->p->mutex); |
c47ed219 | 1180 | /* notify any interfaces that the device is now gone */ |
184f1f77 | 1181 | list_for_each_entry(class_intf, |
ca22e56d | 1182 | &dev->class->p->interfaces, node) |
c47ed219 GKH |
1183 | if (class_intf->remove_dev) |
1184 | class_intf->remove_dev(dev, class_intf); | |
1185 | /* remove the device from the class list */ | |
5a3ceb86 | 1186 | klist_del(&dev->knode_class); |
ca22e56d | 1187 | mutex_unlock(&dev->class->p->mutex); |
b9d9c82b | 1188 | } |
ad6a1e1c | 1189 | device_remove_file(dev, &uevent_attr); |
2620efef | 1190 | device_remove_attrs(dev); |
28953533 | 1191 | bus_remove_device(dev); |
d1c3414c | 1192 | driver_deferred_probe_del(dev); |
1da177e4 | 1193 | |
2f8d16a9 TH |
1194 | /* |
1195 | * Some platform devices are driven without driver attached | |
1196 | * and managed resources may have been acquired. Make sure | |
1197 | * all resources are released. | |
1198 | */ | |
1199 | devres_release_all(dev); | |
1200 | ||
1da177e4 LT |
1201 | /* Notify the platform of the removal, in case they |
1202 | * need to do anything... | |
1203 | */ | |
1204 | if (platform_notify_remove) | |
1205 | platform_notify_remove(dev); | |
312c004d | 1206 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
da231fd5 | 1207 | cleanup_device_parent(dev); |
1da177e4 | 1208 | kobject_del(&dev->kobj); |
da231fd5 | 1209 | put_device(parent); |
1da177e4 LT |
1210 | } |
1211 | ||
1212 | /** | |
4a3ad20c GKH |
1213 | * device_unregister - unregister device from system. |
1214 | * @dev: device going away. | |
1da177e4 | 1215 | * |
4a3ad20c GKH |
1216 | * We do this in two parts, like we do device_register(). First, |
1217 | * we remove it from all the subsystems with device_del(), then | |
1218 | * we decrement the reference count via put_device(). If that | |
1219 | * is the final reference count, the device will be cleaned up | |
1220 | * via device_release() above. Otherwise, the structure will | |
1221 | * stick around until the final reference to the device is dropped. | |
1da177e4 | 1222 | */ |
4a3ad20c | 1223 | void device_unregister(struct device *dev) |
1da177e4 | 1224 | { |
1e0b2cf9 | 1225 | pr_debug("device: '%s': %s\n", dev_name(dev), __func__); |
1da177e4 LT |
1226 | device_del(dev); |
1227 | put_device(dev); | |
1228 | } | |
1229 | ||
4a3ad20c | 1230 | static struct device *next_device(struct klist_iter *i) |
36239577 | 1231 | { |
4a3ad20c | 1232 | struct klist_node *n = klist_next(i); |
f791b8c8 GKH |
1233 | struct device *dev = NULL; |
1234 | struct device_private *p; | |
1235 | ||
1236 | if (n) { | |
1237 | p = to_device_private_parent(n); | |
1238 | dev = p->device; | |
1239 | } | |
1240 | return dev; | |
36239577 | 1241 | } |
1242 | ||
6fcf53ac | 1243 | /** |
e454cea2 | 1244 | * device_get_devnode - path of device node file |
6fcf53ac | 1245 | * @dev: device |
e454cea2 | 1246 | * @mode: returned file access mode |
6fcf53ac KS |
1247 | * @tmp: possibly allocated string |
1248 | * | |
1249 | * Return the relative path of a possible device node. | |
1250 | * Non-default names may need to allocate a memory to compose | |
1251 | * a name. This memory is returned in tmp and needs to be | |
1252 | * freed by the caller. | |
1253 | */ | |
e454cea2 | 1254 | const char *device_get_devnode(struct device *dev, |
2c9ede55 | 1255 | umode_t *mode, const char **tmp) |
6fcf53ac KS |
1256 | { |
1257 | char *s; | |
1258 | ||
1259 | *tmp = NULL; | |
1260 | ||
1261 | /* the device type may provide a specific name */ | |
e454cea2 KS |
1262 | if (dev->type && dev->type->devnode) |
1263 | *tmp = dev->type->devnode(dev, mode); | |
6fcf53ac KS |
1264 | if (*tmp) |
1265 | return *tmp; | |
1266 | ||
1267 | /* the class may provide a specific name */ | |
e454cea2 KS |
1268 | if (dev->class && dev->class->devnode) |
1269 | *tmp = dev->class->devnode(dev, mode); | |
6fcf53ac KS |
1270 | if (*tmp) |
1271 | return *tmp; | |
1272 | ||
1273 | /* return name without allocation, tmp == NULL */ | |
1274 | if (strchr(dev_name(dev), '!') == NULL) | |
1275 | return dev_name(dev); | |
1276 | ||
1277 | /* replace '!' in the name with '/' */ | |
1278 | *tmp = kstrdup(dev_name(dev), GFP_KERNEL); | |
1279 | if (!*tmp) | |
1280 | return NULL; | |
1281 | while ((s = strchr(*tmp, '!'))) | |
1282 | s[0] = '/'; | |
1283 | return *tmp; | |
1284 | } | |
1285 | ||
1da177e4 | 1286 | /** |
4a3ad20c GKH |
1287 | * device_for_each_child - device child iterator. |
1288 | * @parent: parent struct device. | |
1289 | * @data: data for the callback. | |
1290 | * @fn: function to be called for each device. | |
1da177e4 | 1291 | * |
4a3ad20c GKH |
1292 | * Iterate over @parent's child devices, and call @fn for each, |
1293 | * passing it @data. | |
1da177e4 | 1294 | * |
4a3ad20c GKH |
1295 | * We check the return of @fn each time. If it returns anything |
1296 | * other than 0, we break out and return that value. | |
1da177e4 | 1297 | */ |
4a3ad20c GKH |
1298 | int device_for_each_child(struct device *parent, void *data, |
1299 | int (*fn)(struct device *dev, void *data)) | |
1da177e4 | 1300 | { |
36239577 | 1301 | struct klist_iter i; |
4a3ad20c | 1302 | struct device *child; |
1da177e4 LT |
1303 | int error = 0; |
1304 | ||
014c90db GKH |
1305 | if (!parent->p) |
1306 | return 0; | |
1307 | ||
f791b8c8 | 1308 | klist_iter_init(&parent->p->klist_children, &i); |
36239577 | 1309 | while ((child = next_device(&i)) && !error) |
1310 | error = fn(child, data); | |
1311 | klist_iter_exit(&i); | |
1da177e4 LT |
1312 | return error; |
1313 | } | |
1314 | ||
5ab69981 CH |
1315 | /** |
1316 | * device_find_child - device iterator for locating a particular device. | |
1317 | * @parent: parent struct device | |
1318 | * @data: Data to pass to match function | |
1319 | * @match: Callback function to check device | |
1320 | * | |
1321 | * This is similar to the device_for_each_child() function above, but it | |
1322 | * returns a reference to a device that is 'found' for later use, as | |
1323 | * determined by the @match callback. | |
1324 | * | |
1325 | * The callback should return 0 if the device doesn't match and non-zero | |
1326 | * if it does. If the callback returns non-zero and a reference to the | |
1327 | * current device can be obtained, this function will return to the caller | |
1328 | * and not iterate over any more devices. | |
1329 | */ | |
4a3ad20c GKH |
1330 | struct device *device_find_child(struct device *parent, void *data, |
1331 | int (*match)(struct device *dev, void *data)) | |
5ab69981 CH |
1332 | { |
1333 | struct klist_iter i; | |
1334 | struct device *child; | |
1335 | ||
1336 | if (!parent) | |
1337 | return NULL; | |
1338 | ||
f791b8c8 | 1339 | klist_iter_init(&parent->p->klist_children, &i); |
5ab69981 CH |
1340 | while ((child = next_device(&i))) |
1341 | if (match(child, data) && get_device(child)) | |
1342 | break; | |
1343 | klist_iter_exit(&i); | |
1344 | return child; | |
1345 | } | |
1346 | ||
1da177e4 LT |
1347 | int __init devices_init(void) |
1348 | { | |
881c6cfd GKH |
1349 | devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL); |
1350 | if (!devices_kset) | |
1351 | return -ENOMEM; | |
e105b8bf DW |
1352 | dev_kobj = kobject_create_and_add("dev", NULL); |
1353 | if (!dev_kobj) | |
1354 | goto dev_kobj_err; | |
1355 | sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj); | |
1356 | if (!sysfs_dev_block_kobj) | |
1357 | goto block_kobj_err; | |
1358 | sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj); | |
1359 | if (!sysfs_dev_char_kobj) | |
1360 | goto char_kobj_err; | |
1361 | ||
881c6cfd | 1362 | return 0; |
e105b8bf DW |
1363 | |
1364 | char_kobj_err: | |
1365 | kobject_put(sysfs_dev_block_kobj); | |
1366 | block_kobj_err: | |
1367 | kobject_put(dev_kobj); | |
1368 | dev_kobj_err: | |
1369 | kset_unregister(devices_kset); | |
1370 | return -ENOMEM; | |
1da177e4 LT |
1371 | } |
1372 | ||
1373 | EXPORT_SYMBOL_GPL(device_for_each_child); | |
5ab69981 | 1374 | EXPORT_SYMBOL_GPL(device_find_child); |
1da177e4 LT |
1375 | |
1376 | EXPORT_SYMBOL_GPL(device_initialize); | |
1377 | EXPORT_SYMBOL_GPL(device_add); | |
1378 | EXPORT_SYMBOL_GPL(device_register); | |
1379 | ||
1380 | EXPORT_SYMBOL_GPL(device_del); | |
1381 | EXPORT_SYMBOL_GPL(device_unregister); | |
1382 | EXPORT_SYMBOL_GPL(get_device); | |
1383 | EXPORT_SYMBOL_GPL(put_device); | |
1da177e4 LT |
1384 | |
1385 | EXPORT_SYMBOL_GPL(device_create_file); | |
1386 | EXPORT_SYMBOL_GPL(device_remove_file); | |
23681e47 | 1387 | |
7f100d15 | 1388 | struct root_device { |
0aa0dc41 MM |
1389 | struct device dev; |
1390 | struct module *owner; | |
1391 | }; | |
1392 | ||
481e2079 FW |
1393 | inline struct root_device *to_root_device(struct device *d) |
1394 | { | |
1395 | return container_of(d, struct root_device, dev); | |
1396 | } | |
0aa0dc41 MM |
1397 | |
1398 | static void root_device_release(struct device *dev) | |
1399 | { | |
1400 | kfree(to_root_device(dev)); | |
1401 | } | |
1402 | ||
1403 | /** | |
1404 | * __root_device_register - allocate and register a root device | |
1405 | * @name: root device name | |
1406 | * @owner: owner module of the root device, usually THIS_MODULE | |
1407 | * | |
1408 | * This function allocates a root device and registers it | |
1409 | * using device_register(). In order to free the returned | |
1410 | * device, use root_device_unregister(). | |
1411 | * | |
1412 | * Root devices are dummy devices which allow other devices | |
1413 | * to be grouped under /sys/devices. Use this function to | |
1414 | * allocate a root device and then use it as the parent of | |
1415 | * any device which should appear under /sys/devices/{name} | |
1416 | * | |
1417 | * The /sys/devices/{name} directory will also contain a | |
1418 | * 'module' symlink which points to the @owner directory | |
1419 | * in sysfs. | |
1420 | * | |
f0eae0ed JN |
1421 | * Returns &struct device pointer on success, or ERR_PTR() on error. |
1422 | * | |
0aa0dc41 MM |
1423 | * Note: You probably want to use root_device_register(). |
1424 | */ | |
1425 | struct device *__root_device_register(const char *name, struct module *owner) | |
1426 | { | |
1427 | struct root_device *root; | |
1428 | int err = -ENOMEM; | |
1429 | ||
1430 | root = kzalloc(sizeof(struct root_device), GFP_KERNEL); | |
1431 | if (!root) | |
1432 | return ERR_PTR(err); | |
1433 | ||
acc0e90f | 1434 | err = dev_set_name(&root->dev, "%s", name); |
0aa0dc41 MM |
1435 | if (err) { |
1436 | kfree(root); | |
1437 | return ERR_PTR(err); | |
1438 | } | |
1439 | ||
1440 | root->dev.release = root_device_release; | |
1441 | ||
1442 | err = device_register(&root->dev); | |
1443 | if (err) { | |
1444 | put_device(&root->dev); | |
1445 | return ERR_PTR(err); | |
1446 | } | |
1447 | ||
1d9e882b | 1448 | #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */ |
0aa0dc41 MM |
1449 | if (owner) { |
1450 | struct module_kobject *mk = &owner->mkobj; | |
1451 | ||
1452 | err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module"); | |
1453 | if (err) { | |
1454 | device_unregister(&root->dev); | |
1455 | return ERR_PTR(err); | |
1456 | } | |
1457 | root->owner = owner; | |
1458 | } | |
1459 | #endif | |
1460 | ||
1461 | return &root->dev; | |
1462 | } | |
1463 | EXPORT_SYMBOL_GPL(__root_device_register); | |
1464 | ||
1465 | /** | |
1466 | * root_device_unregister - unregister and free a root device | |
7cbcf225 | 1467 | * @dev: device going away |
0aa0dc41 MM |
1468 | * |
1469 | * This function unregisters and cleans up a device that was created by | |
1470 | * root_device_register(). | |
1471 | */ | |
1472 | void root_device_unregister(struct device *dev) | |
1473 | { | |
1474 | struct root_device *root = to_root_device(dev); | |
1475 | ||
1476 | if (root->owner) | |
1477 | sysfs_remove_link(&root->dev.kobj, "module"); | |
1478 | ||
1479 | device_unregister(dev); | |
1480 | } | |
1481 | EXPORT_SYMBOL_GPL(root_device_unregister); | |
1482 | ||
23681e47 GKH |
1483 | |
1484 | static void device_create_release(struct device *dev) | |
1485 | { | |
1e0b2cf9 | 1486 | pr_debug("device: '%s': %s\n", dev_name(dev), __func__); |
23681e47 GKH |
1487 | kfree(dev); |
1488 | } | |
1489 | ||
1490 | /** | |
8882b394 | 1491 | * device_create_vargs - creates a device and registers it with sysfs |
42734daf HK |
1492 | * @class: pointer to the struct class that this device should be registered to |
1493 | * @parent: pointer to the parent struct device of this new device, if any | |
1494 | * @devt: the dev_t for the char device to be added | |
8882b394 | 1495 | * @drvdata: the data to be added to the device for callbacks |
42734daf | 1496 | * @fmt: string for the device's name |
8882b394 | 1497 | * @args: va_list for the device's name |
42734daf HK |
1498 | * |
1499 | * This function can be used by char device classes. A struct device | |
1500 | * will be created in sysfs, registered to the specified class. | |
23681e47 | 1501 | * |
23681e47 GKH |
1502 | * A "dev" file will be created, showing the dev_t for the device, if |
1503 | * the dev_t is not 0,0. | |
42734daf HK |
1504 | * If a pointer to a parent struct device is passed in, the newly created |
1505 | * struct device will be a child of that device in sysfs. | |
1506 | * The pointer to the struct device will be returned from the call. | |
1507 | * Any further sysfs files that might be required can be created using this | |
23681e47 GKH |
1508 | * pointer. |
1509 | * | |
f0eae0ed JN |
1510 | * Returns &struct device pointer on success, or ERR_PTR() on error. |
1511 | * | |
23681e47 GKH |
1512 | * Note: the struct class passed to this function must have previously |
1513 | * been created with a call to class_create(). | |
1514 | */ | |
8882b394 GKH |
1515 | struct device *device_create_vargs(struct class *class, struct device *parent, |
1516 | dev_t devt, void *drvdata, const char *fmt, | |
1517 | va_list args) | |
23681e47 | 1518 | { |
23681e47 GKH |
1519 | struct device *dev = NULL; |
1520 | int retval = -ENODEV; | |
1521 | ||
1522 | if (class == NULL || IS_ERR(class)) | |
1523 | goto error; | |
23681e47 GKH |
1524 | |
1525 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); | |
1526 | if (!dev) { | |
1527 | retval = -ENOMEM; | |
1528 | goto error; | |
1529 | } | |
1530 | ||
1531 | dev->devt = devt; | |
1532 | dev->class = class; | |
1533 | dev->parent = parent; | |
1534 | dev->release = device_create_release; | |
8882b394 | 1535 | dev_set_drvdata(dev, drvdata); |
23681e47 | 1536 | |
1fa5ae85 KS |
1537 | retval = kobject_set_name_vargs(&dev->kobj, fmt, args); |
1538 | if (retval) | |
1539 | goto error; | |
1540 | ||
23681e47 GKH |
1541 | retval = device_register(dev); |
1542 | if (retval) | |
1543 | goto error; | |
1544 | ||
23681e47 GKH |
1545 | return dev; |
1546 | ||
1547 | error: | |
286661b3 | 1548 | put_device(dev); |
23681e47 GKH |
1549 | return ERR_PTR(retval); |
1550 | } | |
8882b394 GKH |
1551 | EXPORT_SYMBOL_GPL(device_create_vargs); |
1552 | ||
1553 | /** | |
4e106739 | 1554 | * device_create - creates a device and registers it with sysfs |
8882b394 GKH |
1555 | * @class: pointer to the struct class that this device should be registered to |
1556 | * @parent: pointer to the parent struct device of this new device, if any | |
1557 | * @devt: the dev_t for the char device to be added | |
1558 | * @drvdata: the data to be added to the device for callbacks | |
1559 | * @fmt: string for the device's name | |
1560 | * | |
1561 | * This function can be used by char device classes. A struct device | |
1562 | * will be created in sysfs, registered to the specified class. | |
1563 | * | |
1564 | * A "dev" file will be created, showing the dev_t for the device, if | |
1565 | * the dev_t is not 0,0. | |
1566 | * If a pointer to a parent struct device is passed in, the newly created | |
1567 | * struct device will be a child of that device in sysfs. | |
1568 | * The pointer to the struct device will be returned from the call. | |
1569 | * Any further sysfs files that might be required can be created using this | |
1570 | * pointer. | |
1571 | * | |
f0eae0ed JN |
1572 | * Returns &struct device pointer on success, or ERR_PTR() on error. |
1573 | * | |
8882b394 GKH |
1574 | * Note: the struct class passed to this function must have previously |
1575 | * been created with a call to class_create(). | |
1576 | */ | |
4e106739 GKH |
1577 | struct device *device_create(struct class *class, struct device *parent, |
1578 | dev_t devt, void *drvdata, const char *fmt, ...) | |
8882b394 GKH |
1579 | { |
1580 | va_list vargs; | |
1581 | struct device *dev; | |
1582 | ||
1583 | va_start(vargs, fmt); | |
1584 | dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs); | |
1585 | va_end(vargs); | |
1586 | return dev; | |
1587 | } | |
4e106739 | 1588 | EXPORT_SYMBOL_GPL(device_create); |
8882b394 | 1589 | |
cd35449b | 1590 | static int __match_devt(struct device *dev, void *data) |
23681e47 | 1591 | { |
cd35449b | 1592 | dev_t *devt = data; |
23681e47 | 1593 | |
cd35449b | 1594 | return dev->devt == *devt; |
775b64d2 RW |
1595 | } |
1596 | ||
1597 | /** | |
1598 | * device_destroy - removes a device that was created with device_create() | |
1599 | * @class: pointer to the struct class that this device was registered with | |
1600 | * @devt: the dev_t of the device that was previously registered | |
1601 | * | |
1602 | * This call unregisters and cleans up a device that was created with a | |
1603 | * call to device_create(). | |
1604 | */ | |
1605 | void device_destroy(struct class *class, dev_t devt) | |
1606 | { | |
1607 | struct device *dev; | |
23681e47 | 1608 | |
695794ae | 1609 | dev = class_find_device(class, NULL, &devt, __match_devt); |
cd35449b DY |
1610 | if (dev) { |
1611 | put_device(dev); | |
23681e47 | 1612 | device_unregister(dev); |
cd35449b | 1613 | } |
23681e47 GKH |
1614 | } |
1615 | EXPORT_SYMBOL_GPL(device_destroy); | |
a2de48ca GKH |
1616 | |
1617 | /** | |
1618 | * device_rename - renames a device | |
1619 | * @dev: the pointer to the struct device to be renamed | |
1620 | * @new_name: the new name of the device | |
030c1d2b EB |
1621 | * |
1622 | * It is the responsibility of the caller to provide mutual | |
1623 | * exclusion between two different calls of device_rename | |
1624 | * on the same device to ensure that new_name is valid and | |
1625 | * won't conflict with other devices. | |
c6c0ac66 | 1626 | * |
a5462516 TT |
1627 | * Note: Don't call this function. Currently, the networking layer calls this |
1628 | * function, but that will change. The following text from Kay Sievers offers | |
1629 | * some insight: | |
1630 | * | |
1631 | * Renaming devices is racy at many levels, symlinks and other stuff are not | |
1632 | * replaced atomically, and you get a "move" uevent, but it's not easy to | |
1633 | * connect the event to the old and new device. Device nodes are not renamed at | |
1634 | * all, there isn't even support for that in the kernel now. | |
1635 | * | |
1636 | * In the meantime, during renaming, your target name might be taken by another | |
1637 | * driver, creating conflicts. Or the old name is taken directly after you | |
1638 | * renamed it -- then you get events for the same DEVPATH, before you even see | |
1639 | * the "move" event. It's just a mess, and nothing new should ever rely on | |
1640 | * kernel device renaming. Besides that, it's not even implemented now for | |
1641 | * other things than (driver-core wise very simple) network devices. | |
1642 | * | |
1643 | * We are currently about to change network renaming in udev to completely | |
1644 | * disallow renaming of devices in the same namespace as the kernel uses, | |
1645 | * because we can't solve the problems properly, that arise with swapping names | |
1646 | * of multiple interfaces without races. Means, renaming of eth[0-9]* will only | |
1647 | * be allowed to some other name than eth[0-9]*, for the aforementioned | |
1648 | * reasons. | |
1649 | * | |
1650 | * Make up a "real" name in the driver before you register anything, or add | |
1651 | * some other attributes for userspace to find the device, or use udev to add | |
1652 | * symlinks -- but never rename kernel devices later, it's a complete mess. We | |
1653 | * don't even want to get into that and try to implement the missing pieces in | |
1654 | * the core. We really have other pieces to fix in the driver core mess. :) | |
a2de48ca | 1655 | */ |
6937e8f8 | 1656 | int device_rename(struct device *dev, const char *new_name) |
a2de48ca GKH |
1657 | { |
1658 | char *old_class_name = NULL; | |
1659 | char *new_class_name = NULL; | |
2ee97caf | 1660 | char *old_device_name = NULL; |
a2de48ca GKH |
1661 | int error; |
1662 | ||
1663 | dev = get_device(dev); | |
1664 | if (!dev) | |
1665 | return -EINVAL; | |
1666 | ||
1e0b2cf9 | 1667 | pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev), |
2b3a302a | 1668 | __func__, new_name); |
a2de48ca | 1669 | |
1fa5ae85 | 1670 | old_device_name = kstrdup(dev_name(dev), GFP_KERNEL); |
2ee97caf CH |
1671 | if (!old_device_name) { |
1672 | error = -ENOMEM; | |
1673 | goto out; | |
a2de48ca | 1674 | } |
a2de48ca | 1675 | |
f349cf34 | 1676 | if (dev->class) { |
6b6e39a6 | 1677 | error = sysfs_rename_link(&dev->class->p->subsys.kobj, |
f349cf34 EB |
1678 | &dev->kobj, old_device_name, new_name); |
1679 | if (error) | |
1680 | goto out; | |
1681 | } | |
39aba963 | 1682 | |
a2de48ca | 1683 | error = kobject_rename(&dev->kobj, new_name); |
1fa5ae85 | 1684 | if (error) |
2ee97caf | 1685 | goto out; |
a2de48ca | 1686 | |
2ee97caf | 1687 | out: |
a2de48ca GKH |
1688 | put_device(dev); |
1689 | ||
a2de48ca | 1690 | kfree(new_class_name); |
952ab431 | 1691 | kfree(old_class_name); |
2ee97caf | 1692 | kfree(old_device_name); |
a2de48ca GKH |
1693 | |
1694 | return error; | |
1695 | } | |
a2807dbc | 1696 | EXPORT_SYMBOL_GPL(device_rename); |
8a82472f CH |
1697 | |
1698 | static int device_move_class_links(struct device *dev, | |
1699 | struct device *old_parent, | |
1700 | struct device *new_parent) | |
1701 | { | |
f7f3461d | 1702 | int error = 0; |
8a82472f | 1703 | |
f7f3461d GKH |
1704 | if (old_parent) |
1705 | sysfs_remove_link(&dev->kobj, "device"); | |
1706 | if (new_parent) | |
1707 | error = sysfs_create_link(&dev->kobj, &new_parent->kobj, | |
1708 | "device"); | |
1709 | return error; | |
8a82472f CH |
1710 | } |
1711 | ||
1712 | /** | |
1713 | * device_move - moves a device to a new parent | |
1714 | * @dev: the pointer to the struct device to be moved | |
c744aeae | 1715 | * @new_parent: the new parent of the device (can by NULL) |
ffa6a705 | 1716 | * @dpm_order: how to reorder the dpm_list |
8a82472f | 1717 | */ |
ffa6a705 CH |
1718 | int device_move(struct device *dev, struct device *new_parent, |
1719 | enum dpm_order dpm_order) | |
8a82472f CH |
1720 | { |
1721 | int error; | |
1722 | struct device *old_parent; | |
c744aeae | 1723 | struct kobject *new_parent_kobj; |
8a82472f CH |
1724 | |
1725 | dev = get_device(dev); | |
1726 | if (!dev) | |
1727 | return -EINVAL; | |
1728 | ||
ffa6a705 | 1729 | device_pm_lock(); |
8a82472f | 1730 | new_parent = get_device(new_parent); |
4a3ad20c | 1731 | new_parent_kobj = get_device_parent(dev, new_parent); |
63b6971a | 1732 | |
1e0b2cf9 KS |
1733 | pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev), |
1734 | __func__, new_parent ? dev_name(new_parent) : "<NULL>"); | |
c744aeae | 1735 | error = kobject_move(&dev->kobj, new_parent_kobj); |
8a82472f | 1736 | if (error) { |
63b6971a | 1737 | cleanup_glue_dir(dev, new_parent_kobj); |
8a82472f CH |
1738 | put_device(new_parent); |
1739 | goto out; | |
1740 | } | |
1741 | old_parent = dev->parent; | |
1742 | dev->parent = new_parent; | |
1743 | if (old_parent) | |
f791b8c8 | 1744 | klist_remove(&dev->p->knode_parent); |
0d358f22 | 1745 | if (new_parent) { |
f791b8c8 GKH |
1746 | klist_add_tail(&dev->p->knode_parent, |
1747 | &new_parent->p->klist_children); | |
0d358f22 YL |
1748 | set_dev_node(dev, dev_to_node(new_parent)); |
1749 | } | |
1750 | ||
8a82472f CH |
1751 | if (!dev->class) |
1752 | goto out_put; | |
1753 | error = device_move_class_links(dev, old_parent, new_parent); | |
1754 | if (error) { | |
1755 | /* We ignore errors on cleanup since we're hosed anyway... */ | |
1756 | device_move_class_links(dev, new_parent, old_parent); | |
1757 | if (!kobject_move(&dev->kobj, &old_parent->kobj)) { | |
c744aeae | 1758 | if (new_parent) |
f791b8c8 | 1759 | klist_remove(&dev->p->knode_parent); |
0d358f22 YL |
1760 | dev->parent = old_parent; |
1761 | if (old_parent) { | |
f791b8c8 GKH |
1762 | klist_add_tail(&dev->p->knode_parent, |
1763 | &old_parent->p->klist_children); | |
0d358f22 YL |
1764 | set_dev_node(dev, dev_to_node(old_parent)); |
1765 | } | |
8a82472f | 1766 | } |
63b6971a | 1767 | cleanup_glue_dir(dev, new_parent_kobj); |
8a82472f CH |
1768 | put_device(new_parent); |
1769 | goto out; | |
1770 | } | |
ffa6a705 CH |
1771 | switch (dpm_order) { |
1772 | case DPM_ORDER_NONE: | |
1773 | break; | |
1774 | case DPM_ORDER_DEV_AFTER_PARENT: | |
1775 | device_pm_move_after(dev, new_parent); | |
1776 | break; | |
1777 | case DPM_ORDER_PARENT_BEFORE_DEV: | |
1778 | device_pm_move_before(new_parent, dev); | |
1779 | break; | |
1780 | case DPM_ORDER_DEV_LAST: | |
1781 | device_pm_move_last(dev); | |
1782 | break; | |
1783 | } | |
8a82472f CH |
1784 | out_put: |
1785 | put_device(old_parent); | |
1786 | out: | |
ffa6a705 | 1787 | device_pm_unlock(); |
8a82472f CH |
1788 | put_device(dev); |
1789 | return error; | |
1790 | } | |
8a82472f | 1791 | EXPORT_SYMBOL_GPL(device_move); |
37b0c020 GKH |
1792 | |
1793 | /** | |
1794 | * device_shutdown - call ->shutdown() on each device to shutdown. | |
1795 | */ | |
1796 | void device_shutdown(void) | |
1797 | { | |
6245838f HD |
1798 | struct device *dev; |
1799 | ||
1800 | spin_lock(&devices_kset->list_lock); | |
1801 | /* | |
1802 | * Walk the devices list backward, shutting down each in turn. | |
1803 | * Beware that device unplug events may also start pulling | |
1804 | * devices offline, even as the system is shutting down. | |
1805 | */ | |
1806 | while (!list_empty(&devices_kset->list)) { | |
1807 | dev = list_entry(devices_kset->list.prev, struct device, | |
1808 | kobj.entry); | |
1809 | get_device(dev); | |
1810 | /* | |
1811 | * Make sure the device is off the kset list, in the | |
1812 | * event that dev->*->shutdown() doesn't remove it. | |
1813 | */ | |
1814 | list_del_init(&dev->kobj.entry); | |
1815 | spin_unlock(&devices_kset->list_lock); | |
fe6b91f4 AS |
1816 | |
1817 | /* Don't allow any more runtime suspends */ | |
1818 | pm_runtime_get_noresume(dev); | |
1819 | pm_runtime_barrier(dev); | |
37b0c020 | 1820 | |
37b0c020 GKH |
1821 | if (dev->bus && dev->bus->shutdown) { |
1822 | dev_dbg(dev, "shutdown\n"); | |
1823 | dev->bus->shutdown(dev); | |
1824 | } else if (dev->driver && dev->driver->shutdown) { | |
1825 | dev_dbg(dev, "shutdown\n"); | |
1826 | dev->driver->shutdown(dev); | |
1827 | } | |
6245838f HD |
1828 | put_device(dev); |
1829 | ||
1830 | spin_lock(&devices_kset->list_lock); | |
37b0c020 | 1831 | } |
6245838f | 1832 | spin_unlock(&devices_kset->list_lock); |
401097ea | 1833 | async_synchronize_full(); |
37b0c020 | 1834 | } |
99bcf217 JP |
1835 | |
1836 | /* | |
1837 | * Device logging functions | |
1838 | */ | |
1839 | ||
1840 | #ifdef CONFIG_PRINTK | |
1841 | ||
cbc46635 JP |
1842 | int __dev_printk(const char *level, const struct device *dev, |
1843 | struct va_format *vaf) | |
99bcf217 JP |
1844 | { |
1845 | if (!dev) | |
1846 | return printk("%s(NULL device *): %pV", level, vaf); | |
1847 | ||
1848 | return printk("%s%s %s: %pV", | |
1849 | level, dev_driver_string(dev), dev_name(dev), vaf); | |
1850 | } | |
cbc46635 | 1851 | EXPORT_SYMBOL(__dev_printk); |
99bcf217 JP |
1852 | |
1853 | int dev_printk(const char *level, const struct device *dev, | |
1854 | const char *fmt, ...) | |
1855 | { | |
1856 | struct va_format vaf; | |
1857 | va_list args; | |
1858 | int r; | |
1859 | ||
1860 | va_start(args, fmt); | |
1861 | ||
1862 | vaf.fmt = fmt; | |
1863 | vaf.va = &args; | |
1864 | ||
1865 | r = __dev_printk(level, dev, &vaf); | |
1866 | va_end(args); | |
1867 | ||
1868 | return r; | |
1869 | } | |
1870 | EXPORT_SYMBOL(dev_printk); | |
1871 | ||
1872 | #define define_dev_printk_level(func, kern_level) \ | |
1873 | int func(const struct device *dev, const char *fmt, ...) \ | |
1874 | { \ | |
1875 | struct va_format vaf; \ | |
1876 | va_list args; \ | |
1877 | int r; \ | |
1878 | \ | |
1879 | va_start(args, fmt); \ | |
1880 | \ | |
1881 | vaf.fmt = fmt; \ | |
1882 | vaf.va = &args; \ | |
1883 | \ | |
1884 | r = __dev_printk(kern_level, dev, &vaf); \ | |
1885 | va_end(args); \ | |
1886 | \ | |
1887 | return r; \ | |
1888 | } \ | |
1889 | EXPORT_SYMBOL(func); | |
1890 | ||
1891 | define_dev_printk_level(dev_emerg, KERN_EMERG); | |
1892 | define_dev_printk_level(dev_alert, KERN_ALERT); | |
1893 | define_dev_printk_level(dev_crit, KERN_CRIT); | |
1894 | define_dev_printk_level(dev_err, KERN_ERR); | |
1895 | define_dev_printk_level(dev_warn, KERN_WARNING); | |
1896 | define_dev_printk_level(dev_notice, KERN_NOTICE); | |
1897 | define_dev_printk_level(_dev_info, KERN_INFO); | |
1898 | ||
1899 | #endif |