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> |
1da177e4 LT |
21 | |
22 | #include <asm/semaphore.h> | |
23 | ||
24 | #include "base.h" | |
25 | #include "power/power.h" | |
26 | ||
27 | int (*platform_notify)(struct device * dev) = NULL; | |
28 | int (*platform_notify_remove)(struct device * dev) = NULL; | |
29 | ||
30 | /* | |
31 | * sysfs bindings for devices. | |
32 | */ | |
33 | ||
3e95637a AS |
34 | /** |
35 | * dev_driver_string - Return a device's driver name, if at all possible | |
36 | * @dev: struct device to get the name of | |
37 | * | |
38 | * Will return the device's driver's name if it is bound to a device. If | |
39 | * the device is not bound to a device, it will return the name of the bus | |
40 | * it is attached to. If it is not attached to a bus either, an empty | |
41 | * string will be returned. | |
42 | */ | |
43 | const char *dev_driver_string(struct device *dev) | |
44 | { | |
45 | return dev->driver ? dev->driver->name : | |
46 | (dev->bus ? dev->bus->name : ""); | |
47 | } | |
310a922d | 48 | EXPORT_SYMBOL(dev_driver_string); |
3e95637a | 49 | |
1da177e4 LT |
50 | #define to_dev(obj) container_of(obj, struct device, kobj) |
51 | #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr) | |
52 | ||
1da177e4 LT |
53 | static ssize_t |
54 | dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf) | |
55 | { | |
56 | struct device_attribute * dev_attr = to_dev_attr(attr); | |
57 | struct device * dev = to_dev(kobj); | |
4a0c20bf | 58 | ssize_t ret = -EIO; |
1da177e4 LT |
59 | |
60 | if (dev_attr->show) | |
54b6f35c | 61 | ret = dev_attr->show(dev, dev_attr, buf); |
1da177e4 LT |
62 | return ret; |
63 | } | |
64 | ||
65 | static ssize_t | |
66 | dev_attr_store(struct kobject * kobj, struct attribute * attr, | |
67 | const char * buf, size_t count) | |
68 | { | |
69 | struct device_attribute * dev_attr = to_dev_attr(attr); | |
70 | struct device * dev = to_dev(kobj); | |
4a0c20bf | 71 | ssize_t ret = -EIO; |
1da177e4 LT |
72 | |
73 | if (dev_attr->store) | |
54b6f35c | 74 | ret = dev_attr->store(dev, dev_attr, buf, count); |
1da177e4 LT |
75 | return ret; |
76 | } | |
77 | ||
78 | static struct sysfs_ops dev_sysfs_ops = { | |
79 | .show = dev_attr_show, | |
80 | .store = dev_attr_store, | |
81 | }; | |
82 | ||
83 | ||
84 | /** | |
85 | * device_release - free device structure. | |
86 | * @kobj: device's kobject. | |
87 | * | |
88 | * This is called once the reference count for the object | |
89 | * reaches 0. We forward the call to the device's release | |
90 | * method, which should handle actually freeing the structure. | |
91 | */ | |
92 | static void device_release(struct kobject * kobj) | |
93 | { | |
94 | struct device * dev = to_dev(kobj); | |
95 | ||
96 | if (dev->release) | |
97 | dev->release(dev); | |
2620efef GKH |
98 | else if (dev->class && dev->class->dev_release) |
99 | dev->class->dev_release(dev); | |
1da177e4 LT |
100 | else { |
101 | printk(KERN_ERR "Device '%s' does not have a release() function, " | |
102 | "it is broken and must be fixed.\n", | |
103 | dev->bus_id); | |
104 | WARN_ON(1); | |
105 | } | |
106 | } | |
107 | ||
108 | static struct kobj_type ktype_device = { | |
109 | .release = device_release, | |
110 | .sysfs_ops = &dev_sysfs_ops, | |
1da177e4 LT |
111 | }; |
112 | ||
113 | ||
312c004d | 114 | static int dev_uevent_filter(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
115 | { |
116 | struct kobj_type *ktype = get_ktype(kobj); | |
117 | ||
118 | if (ktype == &ktype_device) { | |
119 | struct device *dev = to_dev(kobj); | |
120 | if (dev->bus) | |
121 | return 1; | |
23681e47 GKH |
122 | if (dev->class) |
123 | return 1; | |
1da177e4 LT |
124 | } |
125 | return 0; | |
126 | } | |
127 | ||
312c004d | 128 | static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj) |
1da177e4 LT |
129 | { |
130 | struct device *dev = to_dev(kobj); | |
131 | ||
23681e47 GKH |
132 | if (dev->bus) |
133 | return dev->bus->name; | |
134 | if (dev->class) | |
135 | return dev->class->name; | |
136 | return NULL; | |
1da177e4 LT |
137 | } |
138 | ||
312c004d | 139 | static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp, |
1da177e4 LT |
140 | int num_envp, char *buffer, int buffer_size) |
141 | { | |
142 | struct device *dev = to_dev(kobj); | |
143 | int i = 0; | |
144 | int length = 0; | |
145 | int retval = 0; | |
146 | ||
23681e47 GKH |
147 | /* add the major/minor if present */ |
148 | if (MAJOR(dev->devt)) { | |
149 | add_uevent_var(envp, num_envp, &i, | |
150 | buffer, buffer_size, &length, | |
151 | "MAJOR=%u", MAJOR(dev->devt)); | |
152 | add_uevent_var(envp, num_envp, &i, | |
153 | buffer, buffer_size, &length, | |
154 | "MINOR=%u", MINOR(dev->devt)); | |
155 | } | |
156 | ||
d81d9d6b | 157 | /* add bus name (same as SUBSYSTEM, deprecated) */ |
1da177e4 | 158 | if (dev->bus) |
312c004d KS |
159 | add_uevent_var(envp, num_envp, &i, |
160 | buffer, buffer_size, &length, | |
161 | "PHYSDEVBUS=%s", dev->bus->name); | |
1da177e4 | 162 | |
d81d9d6b KS |
163 | /* add driver name (PHYSDEV* values are deprecated)*/ |
164 | if (dev->driver) { | |
165 | add_uevent_var(envp, num_envp, &i, | |
166 | buffer, buffer_size, &length, | |
167 | "DRIVER=%s", dev->driver->name); | |
312c004d KS |
168 | add_uevent_var(envp, num_envp, &i, |
169 | buffer, buffer_size, &length, | |
170 | "PHYSDEVDRIVER=%s", dev->driver->name); | |
d81d9d6b | 171 | } |
1da177e4 LT |
172 | |
173 | /* terminate, set to next free slot, shrink available space */ | |
174 | envp[i] = NULL; | |
175 | envp = &envp[i]; | |
176 | num_envp -= i; | |
177 | buffer = &buffer[length]; | |
178 | buffer_size -= length; | |
179 | ||
312c004d | 180 | if (dev->bus && dev->bus->uevent) { |
1da177e4 | 181 | /* have the bus specific function add its stuff */ |
312c004d | 182 | retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size); |
1da177e4 | 183 | if (retval) { |
312c004d | 184 | pr_debug ("%s - uevent() returned %d\n", |
1da177e4 LT |
185 | __FUNCTION__, retval); |
186 | } | |
187 | } | |
188 | ||
2620efef GKH |
189 | if (dev->class && dev->class->dev_uevent) { |
190 | /* have the class specific function add its stuff */ | |
191 | retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size); | |
192 | if (retval) { | |
193 | pr_debug("%s - dev_uevent() returned %d\n", | |
194 | __FUNCTION__, retval); | |
195 | } | |
196 | } | |
197 | ||
1da177e4 LT |
198 | return retval; |
199 | } | |
200 | ||
312c004d KS |
201 | static struct kset_uevent_ops device_uevent_ops = { |
202 | .filter = dev_uevent_filter, | |
203 | .name = dev_uevent_name, | |
204 | .uevent = dev_uevent, | |
1da177e4 LT |
205 | }; |
206 | ||
a7fd6706 KS |
207 | static ssize_t store_uevent(struct device *dev, struct device_attribute *attr, |
208 | const char *buf, size_t count) | |
209 | { | |
312c004d | 210 | kobject_uevent(&dev->kobj, KOBJ_ADD); |
a7fd6706 KS |
211 | return count; |
212 | } | |
213 | ||
de0ff00d GKH |
214 | static int device_add_groups(struct device *dev) |
215 | { | |
216 | int i; | |
217 | int error = 0; | |
218 | ||
219 | if (dev->groups) { | |
220 | for (i = 0; dev->groups[i]; i++) { | |
221 | error = sysfs_create_group(&dev->kobj, dev->groups[i]); | |
222 | if (error) { | |
223 | while (--i >= 0) | |
224 | sysfs_remove_group(&dev->kobj, dev->groups[i]); | |
225 | goto out; | |
226 | } | |
227 | } | |
228 | } | |
229 | out: | |
230 | return error; | |
231 | } | |
232 | ||
233 | static void device_remove_groups(struct device *dev) | |
234 | { | |
235 | int i; | |
236 | if (dev->groups) { | |
237 | for (i = 0; dev->groups[i]; i++) { | |
238 | sysfs_remove_group(&dev->kobj, dev->groups[i]); | |
239 | } | |
240 | } | |
241 | } | |
242 | ||
2620efef GKH |
243 | static int device_add_attrs(struct device *dev) |
244 | { | |
245 | struct class *class = dev->class; | |
246 | int error = 0; | |
247 | int i; | |
248 | ||
249 | if (!class) | |
250 | return 0; | |
251 | ||
252 | if (class->dev_attrs) { | |
253 | for (i = 0; attr_name(class->dev_attrs[i]); i++) { | |
254 | error = device_create_file(dev, &class->dev_attrs[i]); | |
255 | if (error) | |
256 | break; | |
257 | } | |
258 | } | |
259 | if (error) | |
260 | while (--i >= 0) | |
261 | device_remove_file(dev, &class->dev_attrs[i]); | |
262 | return error; | |
263 | } | |
264 | ||
265 | static void device_remove_attrs(struct device *dev) | |
266 | { | |
267 | struct class *class = dev->class; | |
268 | int i; | |
269 | ||
270 | if (!class) | |
271 | return; | |
272 | ||
273 | if (class->dev_attrs) { | |
274 | for (i = 0; attr_name(class->dev_attrs[i]); i++) | |
275 | device_remove_file(dev, &class->dev_attrs[i]); | |
276 | } | |
277 | } | |
278 | ||
279 | ||
23681e47 GKH |
280 | static ssize_t show_dev(struct device *dev, struct device_attribute *attr, |
281 | char *buf) | |
282 | { | |
283 | return print_dev_t(buf, dev->devt); | |
284 | } | |
285 | ||
0863afb3 MW |
286 | /* |
287 | * devices_subsys - structure to be registered with kobject core. | |
1da177e4 LT |
288 | */ |
289 | ||
312c004d | 290 | decl_subsys(devices, &ktype_device, &device_uevent_ops); |
1da177e4 LT |
291 | |
292 | ||
293 | /** | |
294 | * device_create_file - create sysfs attribute file for device. | |
295 | * @dev: device. | |
296 | * @attr: device attribute descriptor. | |
297 | */ | |
298 | ||
299 | int device_create_file(struct device * dev, struct device_attribute * attr) | |
300 | { | |
301 | int error = 0; | |
302 | if (get_device(dev)) { | |
303 | error = sysfs_create_file(&dev->kobj, &attr->attr); | |
304 | put_device(dev); | |
305 | } | |
306 | return error; | |
307 | } | |
308 | ||
309 | /** | |
310 | * device_remove_file - remove sysfs attribute file. | |
311 | * @dev: device. | |
312 | * @attr: device attribute descriptor. | |
313 | */ | |
314 | ||
315 | void device_remove_file(struct device * dev, struct device_attribute * attr) | |
316 | { | |
317 | if (get_device(dev)) { | |
318 | sysfs_remove_file(&dev->kobj, &attr->attr); | |
319 | put_device(dev); | |
320 | } | |
321 | } | |
322 | ||
2589f188 GKH |
323 | /** |
324 | * device_create_bin_file - create sysfs binary attribute file for device. | |
325 | * @dev: device. | |
326 | * @attr: device binary attribute descriptor. | |
327 | */ | |
328 | int device_create_bin_file(struct device *dev, struct bin_attribute *attr) | |
329 | { | |
330 | int error = -EINVAL; | |
331 | if (dev) | |
332 | error = sysfs_create_bin_file(&dev->kobj, attr); | |
333 | return error; | |
334 | } | |
335 | EXPORT_SYMBOL_GPL(device_create_bin_file); | |
336 | ||
337 | /** | |
338 | * device_remove_bin_file - remove sysfs binary attribute file | |
339 | * @dev: device. | |
340 | * @attr: device binary attribute descriptor. | |
341 | */ | |
342 | void device_remove_bin_file(struct device *dev, struct bin_attribute *attr) | |
343 | { | |
344 | if (dev) | |
345 | sysfs_remove_bin_file(&dev->kobj, attr); | |
346 | } | |
347 | EXPORT_SYMBOL_GPL(device_remove_bin_file); | |
348 | ||
34bb61f9 JB |
349 | static void klist_children_get(struct klist_node *n) |
350 | { | |
351 | struct device *dev = container_of(n, struct device, knode_parent); | |
352 | ||
353 | get_device(dev); | |
354 | } | |
355 | ||
356 | static void klist_children_put(struct klist_node *n) | |
357 | { | |
358 | struct device *dev = container_of(n, struct device, knode_parent); | |
359 | ||
360 | put_device(dev); | |
361 | } | |
362 | ||
1da177e4 LT |
363 | |
364 | /** | |
365 | * device_initialize - init device structure. | |
366 | * @dev: device. | |
367 | * | |
368 | * This prepares the device for use by other layers, | |
369 | * including adding it to the device hierarchy. | |
370 | * It is the first half of device_register(), if called by | |
371 | * that, though it can also be called separately, so one | |
372 | * may use @dev's fields (e.g. the refcount). | |
373 | */ | |
374 | ||
375 | void device_initialize(struct device *dev) | |
376 | { | |
377 | kobj_set_kset_s(dev, devices_subsys); | |
378 | kobject_init(&dev->kobj); | |
34bb61f9 JB |
379 | klist_init(&dev->klist_children, klist_children_get, |
380 | klist_children_put); | |
1da177e4 | 381 | INIT_LIST_HEAD(&dev->dma_pools); |
23681e47 | 382 | INIT_LIST_HEAD(&dev->node); |
af70316a | 383 | init_MUTEX(&dev->sem); |
0ac85241 | 384 | device_init_wakeup(dev, 0); |
1da177e4 LT |
385 | } |
386 | ||
40fa5422 GKH |
387 | #ifdef CONFIG_SYSFS_DEPRECATED |
388 | int setup_parent(struct device *dev, struct device *parent) | |
389 | { | |
390 | /* Set the parent to the class, not the parent device */ | |
391 | /* this keeps sysfs from having a symlink to make old udevs happy */ | |
392 | if (dev->class) | |
393 | dev->kobj.parent = &dev->class->subsys.kset.kobj; | |
394 | else if (parent) | |
395 | dev->kobj.parent = &parent->kobj; | |
396 | ||
397 | return 0; | |
398 | } | |
399 | #else | |
f0ee61a6 GKH |
400 | static int virtual_device_parent(struct device *dev) |
401 | { | |
402 | if (!dev->class) | |
403 | return -ENODEV; | |
404 | ||
405 | if (!dev->class->virtual_dir) { | |
406 | static struct kobject *virtual_dir = NULL; | |
407 | ||
408 | if (!virtual_dir) | |
409 | virtual_dir = kobject_add_dir(&devices_subsys.kset.kobj, "virtual"); | |
410 | dev->class->virtual_dir = kobject_add_dir(virtual_dir, dev->class->name); | |
411 | } | |
412 | ||
413 | dev->kobj.parent = dev->class->virtual_dir; | |
414 | return 0; | |
415 | } | |
416 | ||
40fa5422 GKH |
417 | int setup_parent(struct device *dev, struct device *parent) |
418 | { | |
419 | int error; | |
420 | ||
421 | /* if this is a class device, and has no parent, create one */ | |
422 | if ((dev->class) && (parent == NULL)) { | |
423 | error = virtual_device_parent(dev); | |
424 | if (error) | |
425 | return error; | |
426 | } else if (parent) | |
427 | dev->kobj.parent = &parent->kobj; | |
428 | ||
429 | return 0; | |
430 | } | |
431 | #endif | |
432 | ||
1da177e4 LT |
433 | /** |
434 | * device_add - add device to device hierarchy. | |
435 | * @dev: device. | |
436 | * | |
437 | * This is part 2 of device_register(), though may be called | |
438 | * separately _iff_ device_initialize() has been called separately. | |
439 | * | |
440 | * This adds it to the kobject hierarchy via kobject_add(), adds it | |
441 | * to the global and sibling lists for the device, then | |
442 | * adds it to the other relevant subsystems of the driver model. | |
443 | */ | |
444 | int device_add(struct device *dev) | |
445 | { | |
446 | struct device *parent = NULL; | |
e9a7d305 | 447 | char *class_name = NULL; |
c47ed219 | 448 | struct class_interface *class_intf; |
1da177e4 LT |
449 | int error = -EINVAL; |
450 | ||
451 | dev = get_device(dev); | |
452 | if (!dev || !strlen(dev->bus_id)) | |
453 | goto Error; | |
454 | ||
40fa5422 | 455 | pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id); |
c205ef48 | 456 | |
1da177e4 LT |
457 | parent = get_device(dev->parent); |
458 | ||
40fa5422 GKH |
459 | error = setup_parent(dev, parent); |
460 | if (error) | |
461 | goto Error; | |
1da177e4 LT |
462 | |
463 | /* first, register with generic layer. */ | |
464 | kobject_set_name(&dev->kobj, "%s", dev->bus_id); | |
40fa5422 GKH |
465 | error = kobject_add(&dev->kobj); |
466 | if (error) | |
1da177e4 | 467 | goto Error; |
a7fd6706 | 468 | |
37022644 BW |
469 | /* notify platform of device entry */ |
470 | if (platform_notify) | |
471 | platform_notify(dev); | |
472 | ||
116af378 BH |
473 | /* notify clients of device entry (new way) */ |
474 | if (dev->bus) | |
475 | blocking_notifier_call_chain(&dev->bus->bus_notifier, | |
476 | BUS_NOTIFY_ADD_DEVICE, dev); | |
477 | ||
a7fd6706 KS |
478 | dev->uevent_attr.attr.name = "uevent"; |
479 | dev->uevent_attr.attr.mode = S_IWUSR; | |
480 | if (dev->driver) | |
481 | dev->uevent_attr.attr.owner = dev->driver->owner; | |
482 | dev->uevent_attr.store = store_uevent; | |
a306eea4 CH |
483 | error = device_create_file(dev, &dev->uevent_attr); |
484 | if (error) | |
485 | goto attrError; | |
a7fd6706 | 486 | |
23681e47 GKH |
487 | if (MAJOR(dev->devt)) { |
488 | struct device_attribute *attr; | |
489 | attr = kzalloc(sizeof(*attr), GFP_KERNEL); | |
490 | if (!attr) { | |
491 | error = -ENOMEM; | |
a306eea4 | 492 | goto ueventattrError; |
23681e47 GKH |
493 | } |
494 | attr->attr.name = "dev"; | |
495 | attr->attr.mode = S_IRUGO; | |
496 | if (dev->driver) | |
497 | attr->attr.owner = dev->driver->owner; | |
498 | attr->show = show_dev; | |
499 | error = device_create_file(dev, attr); | |
500 | if (error) { | |
501 | kfree(attr); | |
a306eea4 | 502 | goto ueventattrError; |
23681e47 GKH |
503 | } |
504 | ||
505 | dev->devt_attr = attr; | |
506 | } | |
507 | ||
b9d9c82b KS |
508 | if (dev->class) { |
509 | sysfs_create_link(&dev->kobj, &dev->class->subsys.kset.kobj, | |
510 | "subsystem"); | |
40fa5422 GKH |
511 | /* If this is not a "fake" compatible device, then create the |
512 | * symlink from the class to the device. */ | |
513 | if (dev->kobj.parent != &dev->class->subsys.kset.kobj) | |
514 | sysfs_create_link(&dev->class->subsys.kset.kobj, | |
515 | &dev->kobj, dev->bus_id); | |
99ef3ef8 | 516 | #ifdef CONFIG_SYSFS_DEPRECATED |
64bb5d2c GKH |
517 | if (parent) { |
518 | sysfs_create_link(&dev->kobj, &dev->parent->kobj, "device"); | |
519 | class_name = make_class_name(dev->class->name, &dev->kobj); | |
520 | sysfs_create_link(&dev->parent->kobj, &dev->kobj, class_name); | |
521 | } | |
99ef3ef8 | 522 | #endif |
b9d9c82b | 523 | } |
23681e47 | 524 | |
2620efef GKH |
525 | if ((error = device_add_attrs(dev))) |
526 | goto AttrsError; | |
de0ff00d GKH |
527 | if ((error = device_add_groups(dev))) |
528 | goto GroupError; | |
1da177e4 LT |
529 | if ((error = device_pm_add(dev))) |
530 | goto PMError; | |
531 | if ((error = bus_add_device(dev))) | |
532 | goto BusError; | |
53877d06 | 533 | kobject_uevent(&dev->kobj, KOBJ_ADD); |
f70fa629 AS |
534 | if ((error = bus_attach_device(dev))) |
535 | goto AttachError; | |
1da177e4 | 536 | if (parent) |
d856f1e3 | 537 | klist_add_tail(&dev->knode_parent, &parent->klist_children); |
1da177e4 | 538 | |
5d9fd169 | 539 | if (dev->class) { |
5d9fd169 | 540 | down(&dev->class->sem); |
c47ed219 | 541 | /* tie the class to the device */ |
5d9fd169 | 542 | list_add_tail(&dev->node, &dev->class->devices); |
c47ed219 GKH |
543 | |
544 | /* notify any interfaces that the device is here */ | |
545 | list_for_each_entry(class_intf, &dev->class->interfaces, node) | |
546 | if (class_intf->add_dev) | |
547 | class_intf->add_dev(dev, class_intf); | |
5d9fd169 GKH |
548 | up(&dev->class->sem); |
549 | } | |
1da177e4 | 550 | Done: |
e9a7d305 | 551 | kfree(class_name); |
1da177e4 LT |
552 | put_device(dev); |
553 | return error; | |
f70fa629 AS |
554 | AttachError: |
555 | bus_remove_device(dev); | |
1da177e4 LT |
556 | BusError: |
557 | device_pm_remove(dev); | |
558 | PMError: | |
116af378 BH |
559 | if (dev->bus) |
560 | blocking_notifier_call_chain(&dev->bus->bus_notifier, | |
561 | BUS_NOTIFY_DEL_DEVICE, dev); | |
de0ff00d GKH |
562 | device_remove_groups(dev); |
563 | GroupError: | |
2620efef GKH |
564 | device_remove_attrs(dev); |
565 | AttrsError: | |
23681e47 GKH |
566 | if (dev->devt_attr) { |
567 | device_remove_file(dev, dev->devt_attr); | |
568 | kfree(dev->devt_attr); | |
569 | } | |
a306eea4 CH |
570 | ueventattrError: |
571 | device_remove_file(dev, &dev->uevent_attr); | |
23681e47 | 572 | attrError: |
312c004d | 573 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
1da177e4 LT |
574 | kobject_del(&dev->kobj); |
575 | Error: | |
576 | if (parent) | |
577 | put_device(parent); | |
578 | goto Done; | |
579 | } | |
580 | ||
581 | ||
582 | /** | |
583 | * device_register - register a device with the system. | |
584 | * @dev: pointer to the device structure | |
585 | * | |
586 | * This happens in two clean steps - initialize the device | |
587 | * and add it to the system. The two steps can be called | |
588 | * separately, but this is the easiest and most common. | |
589 | * I.e. you should only call the two helpers separately if | |
590 | * have a clearly defined need to use and refcount the device | |
591 | * before it is added to the hierarchy. | |
592 | */ | |
593 | ||
594 | int device_register(struct device *dev) | |
595 | { | |
596 | device_initialize(dev); | |
597 | return device_add(dev); | |
598 | } | |
599 | ||
600 | ||
601 | /** | |
602 | * get_device - increment reference count for device. | |
603 | * @dev: device. | |
604 | * | |
605 | * This simply forwards the call to kobject_get(), though | |
606 | * we do take care to provide for the case that we get a NULL | |
607 | * pointer passed in. | |
608 | */ | |
609 | ||
610 | struct device * get_device(struct device * dev) | |
611 | { | |
612 | return dev ? to_dev(kobject_get(&dev->kobj)) : NULL; | |
613 | } | |
614 | ||
615 | ||
616 | /** | |
617 | * put_device - decrement reference count. | |
618 | * @dev: device in question. | |
619 | */ | |
620 | void put_device(struct device * dev) | |
621 | { | |
622 | if (dev) | |
623 | kobject_put(&dev->kobj); | |
624 | } | |
625 | ||
626 | ||
627 | /** | |
628 | * device_del - delete device from system. | |
629 | * @dev: device. | |
630 | * | |
631 | * This is the first part of the device unregistration | |
632 | * sequence. This removes the device from the lists we control | |
633 | * from here, has it removed from the other driver model | |
634 | * subsystems it was added to in device_add(), and removes it | |
635 | * from the kobject hierarchy. | |
636 | * | |
637 | * NOTE: this should be called manually _iff_ device_add() was | |
638 | * also called manually. | |
639 | */ | |
640 | ||
641 | void device_del(struct device * dev) | |
642 | { | |
643 | struct device * parent = dev->parent; | |
c47ed219 | 644 | struct class_interface *class_intf; |
1da177e4 | 645 | |
1da177e4 | 646 | if (parent) |
d62c0f9f | 647 | klist_del(&dev->knode_parent); |
82189b98 | 648 | if (dev->devt_attr) { |
23681e47 | 649 | device_remove_file(dev, dev->devt_attr); |
82189b98 CM |
650 | kfree(dev->devt_attr); |
651 | } | |
b9d9c82b KS |
652 | if (dev->class) { |
653 | sysfs_remove_link(&dev->kobj, "subsystem"); | |
40fa5422 GKH |
654 | /* If this is not a "fake" compatible device, remove the |
655 | * symlink from the class to the device. */ | |
656 | if (dev->kobj.parent != &dev->class->subsys.kset.kobj) | |
657 | sysfs_remove_link(&dev->class->subsys.kset.kobj, | |
658 | dev->bus_id); | |
99ef3ef8 | 659 | #ifdef CONFIG_SYSFS_DEPRECATED |
64bb5d2c | 660 | if (parent) { |
99ef3ef8 KS |
661 | char *class_name = make_class_name(dev->class->name, |
662 | &dev->kobj); | |
64bb5d2c | 663 | sysfs_remove_link(&dev->parent->kobj, class_name); |
99ef3ef8 KS |
664 | kfree(class_name); |
665 | sysfs_remove_link(&dev->kobj, "device"); | |
64bb5d2c | 666 | } |
99ef3ef8 KS |
667 | #endif |
668 | ||
5d9fd169 | 669 | down(&dev->class->sem); |
c47ed219 GKH |
670 | /* notify any interfaces that the device is now gone */ |
671 | list_for_each_entry(class_intf, &dev->class->interfaces, node) | |
672 | if (class_intf->remove_dev) | |
673 | class_intf->remove_dev(dev, class_intf); | |
674 | /* remove the device from the class list */ | |
5d9fd169 GKH |
675 | list_del_init(&dev->node); |
676 | up(&dev->class->sem); | |
b9d9c82b | 677 | } |
a7fd6706 | 678 | device_remove_file(dev, &dev->uevent_attr); |
de0ff00d | 679 | device_remove_groups(dev); |
2620efef | 680 | device_remove_attrs(dev); |
1da177e4 LT |
681 | |
682 | /* Notify the platform of the removal, in case they | |
683 | * need to do anything... | |
684 | */ | |
685 | if (platform_notify_remove) | |
686 | platform_notify_remove(dev); | |
116af378 BH |
687 | if (dev->bus) |
688 | blocking_notifier_call_chain(&dev->bus->bus_notifier, | |
689 | BUS_NOTIFY_DEL_DEVICE, dev); | |
1da177e4 LT |
690 | bus_remove_device(dev); |
691 | device_pm_remove(dev); | |
312c004d | 692 | kobject_uevent(&dev->kobj, KOBJ_REMOVE); |
1da177e4 LT |
693 | kobject_del(&dev->kobj); |
694 | if (parent) | |
695 | put_device(parent); | |
696 | } | |
697 | ||
698 | /** | |
699 | * device_unregister - unregister device from system. | |
700 | * @dev: device going away. | |
701 | * | |
702 | * We do this in two parts, like we do device_register(). First, | |
703 | * we remove it from all the subsystems with device_del(), then | |
704 | * we decrement the reference count via put_device(). If that | |
705 | * is the final reference count, the device will be cleaned up | |
706 | * via device_release() above. Otherwise, the structure will | |
707 | * stick around until the final reference to the device is dropped. | |
708 | */ | |
709 | void device_unregister(struct device * dev) | |
710 | { | |
711 | pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id); | |
712 | device_del(dev); | |
713 | put_device(dev); | |
714 | } | |
715 | ||
716 | ||
36239577 PM |
717 | static struct device * next_device(struct klist_iter * i) |
718 | { | |
719 | struct klist_node * n = klist_next(i); | |
720 | return n ? container_of(n, struct device, knode_parent) : NULL; | |
721 | } | |
722 | ||
1da177e4 LT |
723 | /** |
724 | * device_for_each_child - device child iterator. | |
c41455fb | 725 | * @parent: parent struct device. |
1da177e4 LT |
726 | * @data: data for the callback. |
727 | * @fn: function to be called for each device. | |
728 | * | |
c41455fb | 729 | * Iterate over @parent's child devices, and call @fn for each, |
1da177e4 LT |
730 | * passing it @data. |
731 | * | |
732 | * We check the return of @fn each time. If it returns anything | |
733 | * other than 0, we break out and return that value. | |
734 | */ | |
36239577 | 735 | int device_for_each_child(struct device * parent, void * data, |
1da177e4 LT |
736 | int (*fn)(struct device *, void *)) |
737 | { | |
36239577 | 738 | struct klist_iter i; |
1da177e4 LT |
739 | struct device * child; |
740 | int error = 0; | |
741 | ||
36239577 PM |
742 | klist_iter_init(&parent->klist_children, &i); |
743 | while ((child = next_device(&i)) && !error) | |
744 | error = fn(child, data); | |
745 | klist_iter_exit(&i); | |
1da177e4 LT |
746 | return error; |
747 | } | |
748 | ||
1da177e4 LT |
749 | int __init devices_init(void) |
750 | { | |
751 | return subsystem_register(&devices_subsys); | |
752 | } | |
753 | ||
754 | EXPORT_SYMBOL_GPL(device_for_each_child); | |
755 | ||
756 | EXPORT_SYMBOL_GPL(device_initialize); | |
757 | EXPORT_SYMBOL_GPL(device_add); | |
758 | EXPORT_SYMBOL_GPL(device_register); | |
759 | ||
760 | EXPORT_SYMBOL_GPL(device_del); | |
761 | EXPORT_SYMBOL_GPL(device_unregister); | |
762 | EXPORT_SYMBOL_GPL(get_device); | |
763 | EXPORT_SYMBOL_GPL(put_device); | |
1da177e4 LT |
764 | |
765 | EXPORT_SYMBOL_GPL(device_create_file); | |
766 | EXPORT_SYMBOL_GPL(device_remove_file); | |
23681e47 GKH |
767 | |
768 | ||
769 | static void device_create_release(struct device *dev) | |
770 | { | |
771 | pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id); | |
772 | kfree(dev); | |
773 | } | |
774 | ||
775 | /** | |
776 | * device_create - creates a device and registers it with sysfs | |
42734daf HK |
777 | * @class: pointer to the struct class that this device should be registered to |
778 | * @parent: pointer to the parent struct device of this new device, if any | |
779 | * @devt: the dev_t for the char device to be added | |
780 | * @fmt: string for the device's name | |
781 | * | |
782 | * This function can be used by char device classes. A struct device | |
783 | * will be created in sysfs, registered to the specified class. | |
23681e47 | 784 | * |
23681e47 GKH |
785 | * A "dev" file will be created, showing the dev_t for the device, if |
786 | * the dev_t is not 0,0. | |
42734daf HK |
787 | * If a pointer to a parent struct device is passed in, the newly created |
788 | * struct device will be a child of that device in sysfs. | |
789 | * The pointer to the struct device will be returned from the call. | |
790 | * Any further sysfs files that might be required can be created using this | |
23681e47 GKH |
791 | * pointer. |
792 | * | |
793 | * Note: the struct class passed to this function must have previously | |
794 | * been created with a call to class_create(). | |
795 | */ | |
796 | struct device *device_create(struct class *class, struct device *parent, | |
5cbe5f8a | 797 | dev_t devt, const char *fmt, ...) |
23681e47 GKH |
798 | { |
799 | va_list args; | |
800 | struct device *dev = NULL; | |
801 | int retval = -ENODEV; | |
802 | ||
803 | if (class == NULL || IS_ERR(class)) | |
804 | goto error; | |
23681e47 GKH |
805 | |
806 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); | |
807 | if (!dev) { | |
808 | retval = -ENOMEM; | |
809 | goto error; | |
810 | } | |
811 | ||
812 | dev->devt = devt; | |
813 | dev->class = class; | |
814 | dev->parent = parent; | |
815 | dev->release = device_create_release; | |
816 | ||
817 | va_start(args, fmt); | |
818 | vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args); | |
819 | va_end(args); | |
820 | retval = device_register(dev); | |
821 | if (retval) | |
822 | goto error; | |
823 | ||
23681e47 GKH |
824 | return dev; |
825 | ||
826 | error: | |
827 | kfree(dev); | |
828 | return ERR_PTR(retval); | |
829 | } | |
830 | EXPORT_SYMBOL_GPL(device_create); | |
831 | ||
832 | /** | |
833 | * device_destroy - removes a device that was created with device_create() | |
42734daf HK |
834 | * @class: pointer to the struct class that this device was registered with |
835 | * @devt: the dev_t of the device that was previously registered | |
23681e47 | 836 | * |
42734daf HK |
837 | * This call unregisters and cleans up a device that was created with a |
838 | * call to device_create(). | |
23681e47 GKH |
839 | */ |
840 | void device_destroy(struct class *class, dev_t devt) | |
841 | { | |
842 | struct device *dev = NULL; | |
843 | struct device *dev_tmp; | |
844 | ||
845 | down(&class->sem); | |
846 | list_for_each_entry(dev_tmp, &class->devices, node) { | |
847 | if (dev_tmp->devt == devt) { | |
848 | dev = dev_tmp; | |
849 | break; | |
850 | } | |
851 | } | |
852 | up(&class->sem); | |
853 | ||
5d9fd169 | 854 | if (dev) |
23681e47 | 855 | device_unregister(dev); |
23681e47 GKH |
856 | } |
857 | EXPORT_SYMBOL_GPL(device_destroy); | |
a2de48ca GKH |
858 | |
859 | /** | |
860 | * device_rename - renames a device | |
861 | * @dev: the pointer to the struct device to be renamed | |
862 | * @new_name: the new name of the device | |
863 | */ | |
864 | int device_rename(struct device *dev, char *new_name) | |
865 | { | |
866 | char *old_class_name = NULL; | |
867 | char *new_class_name = NULL; | |
868 | char *old_symlink_name = NULL; | |
869 | int error; | |
870 | ||
871 | dev = get_device(dev); | |
872 | if (!dev) | |
873 | return -EINVAL; | |
874 | ||
875 | pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name); | |
876 | ||
99ef3ef8 | 877 | #ifdef CONFIG_SYSFS_DEPRECATED |
a2de48ca GKH |
878 | if ((dev->class) && (dev->parent)) |
879 | old_class_name = make_class_name(dev->class->name, &dev->kobj); | |
99ef3ef8 | 880 | #endif |
a2de48ca GKH |
881 | |
882 | if (dev->class) { | |
883 | old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL); | |
952ab431 JJ |
884 | if (!old_symlink_name) { |
885 | error = -ENOMEM; | |
886 | goto out_free_old_class; | |
887 | } | |
a2de48ca GKH |
888 | strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE); |
889 | } | |
890 | ||
891 | strlcpy(dev->bus_id, new_name, BUS_ID_SIZE); | |
892 | ||
893 | error = kobject_rename(&dev->kobj, new_name); | |
894 | ||
99ef3ef8 | 895 | #ifdef CONFIG_SYSFS_DEPRECATED |
a2de48ca GKH |
896 | if (old_class_name) { |
897 | new_class_name = make_class_name(dev->class->name, &dev->kobj); | |
898 | if (new_class_name) { | |
899 | sysfs_create_link(&dev->parent->kobj, &dev->kobj, | |
900 | new_class_name); | |
901 | sysfs_remove_link(&dev->parent->kobj, old_class_name); | |
902 | } | |
903 | } | |
99ef3ef8 KS |
904 | #endif |
905 | ||
a2de48ca GKH |
906 | if (dev->class) { |
907 | sysfs_remove_link(&dev->class->subsys.kset.kobj, | |
908 | old_symlink_name); | |
909 | sysfs_create_link(&dev->class->subsys.kset.kobj, &dev->kobj, | |
910 | dev->bus_id); | |
911 | } | |
912 | put_device(dev); | |
913 | ||
a2de48ca GKH |
914 | kfree(new_class_name); |
915 | kfree(old_symlink_name); | |
952ab431 JJ |
916 | out_free_old_class: |
917 | kfree(old_class_name); | |
a2de48ca GKH |
918 | |
919 | return error; | |
920 | } |