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