blob: 0455aa78fa135cb04529efb281386d25423b2970 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -07006 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2
10 *
11 */
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#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>
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -070019#include <linux/kdev_t.h>
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100020#include <linux/notifier.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22#include <asm/semaphore.h>
23
24#include "base.h"
25#include "power/power.h"
26
27int (*platform_notify)(struct device * dev) = NULL;
28int (*platform_notify_remove)(struct device * dev) = NULL;
29
30/*
31 * sysfs bindings for devices.
32 */
33
Alan Stern3e956372006-06-16 17:10:48 -040034/**
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 */
43const char *dev_driver_string(struct device *dev)
44{
45 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010046 (dev->bus ? dev->bus->name :
47 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040048}
Matthew Wilcox310a9222006-09-23 23:35:04 -060049EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#define to_dev(obj) container_of(obj, struct device, kobj)
52#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054static ssize_t
55dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
56{
57 struct device_attribute * dev_attr = to_dev_attr(attr);
58 struct device * dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050059 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040062 ret = dev_attr->show(dev, dev_attr, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 return ret;
64}
65
66static ssize_t
67dev_attr_store(struct kobject * kobj, struct attribute * attr,
68 const char * buf, size_t count)
69{
70 struct device_attribute * dev_attr = to_dev_attr(attr);
71 struct device * dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050072 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040075 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 return ret;
77}
78
79static struct sysfs_ops dev_sysfs_ops = {
80 .show = dev_attr_show,
81 .store = dev_attr_store,
82};
83
84
85/**
86 * device_release - free device structure.
87 * @kobj: device's kobject.
88 *
89 * This is called once the reference count for the object
90 * reaches 0. We forward the call to the device's release
91 * method, which should handle actually freeing the structure.
92 */
93static void device_release(struct kobject * kobj)
94{
95 struct device * dev = to_dev(kobj);
96
97 if (dev->release)
98 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +020099 else if (dev->type && dev->type->release)
100 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700101 else if (dev->class && dev->class->dev_release)
102 dev->class->dev_release(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 else {
104 printk(KERN_ERR "Device '%s' does not have a release() function, "
105 "it is broken and must be fixed.\n",
106 dev->bus_id);
107 WARN_ON(1);
108 }
109}
110
111static struct kobj_type ktype_device = {
112 .release = device_release,
113 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
116
Kay Sievers312c0042005-11-16 09:00:00 +0100117static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
119 struct kobj_type *ktype = get_ktype(kobj);
120
121 if (ktype == &ktype_device) {
122 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200123 if (dev->uevent_suppress)
124 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 if (dev->bus)
126 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700127 if (dev->class)
128 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 }
130 return 0;
131}
132
Kay Sievers312c0042005-11-16 09:00:00 +0100133static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134{
135 struct device *dev = to_dev(kobj);
136
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700137 if (dev->bus)
138 return dev->bus->name;
139 if (dev->class)
140 return dev->class->name;
141 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
Kay Sievers312c0042005-11-16 09:00:00 +0100144static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 int num_envp, char *buffer, int buffer_size)
146{
147 struct device *dev = to_dev(kobj);
148 int i = 0;
149 int length = 0;
150 int retval = 0;
151
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700152 /* add the major/minor if present */
153 if (MAJOR(dev->devt)) {
154 add_uevent_var(envp, num_envp, &i,
155 buffer, buffer_size, &length,
156 "MAJOR=%u", MAJOR(dev->devt));
157 add_uevent_var(envp, num_envp, &i,
158 buffer, buffer_size, &length,
159 "MINOR=%u", MINOR(dev->devt));
160 }
161
Kay Sievers414264f2007-03-12 21:08:57 +0100162 if (dev->type && dev->type->name)
163 add_uevent_var(envp, num_envp, &i,
164 buffer, buffer_size, &length,
165 "DEVTYPE=%s", dev->type->name);
166
Kay Sievers239378f2006-10-07 21:54:55 +0200167 if (dev->driver)
Kay Sieversd81d9d62006-08-13 06:17:09 +0200168 add_uevent_var(envp, num_envp, &i,
169 buffer, buffer_size, &length,
170 "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200171
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200172#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200173 if (dev->class) {
174 struct device *parent = dev->parent;
175
176 /* find first bus device in parent chain */
177 while (parent && !parent->bus)
178 parent = parent->parent;
179 if (parent && parent->bus) {
180 const char *path;
181
182 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200183 if (path) {
184 add_uevent_var(envp, num_envp, &i,
185 buffer, buffer_size, &length,
186 "PHYSDEVPATH=%s", path);
187 kfree(path);
188 }
Kay Sievers239378f2006-10-07 21:54:55 +0200189
190 add_uevent_var(envp, num_envp, &i,
191 buffer, buffer_size, &length,
192 "PHYSDEVBUS=%s", parent->bus->name);
193
194 if (parent->driver)
195 add_uevent_var(envp, num_envp, &i,
196 buffer, buffer_size, &length,
197 "PHYSDEVDRIVER=%s", parent->driver->name);
198 }
199 } else if (dev->bus) {
Kay Sievers312c0042005-11-16 09:00:00 +0100200 add_uevent_var(envp, num_envp, &i,
201 buffer, buffer_size, &length,
Kay Sievers239378f2006-10-07 21:54:55 +0200202 "PHYSDEVBUS=%s", dev->bus->name);
203
204 if (dev->driver)
205 add_uevent_var(envp, num_envp, &i,
206 buffer, buffer_size, &length,
207 "PHYSDEVDRIVER=%s", dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200208 }
Kay Sievers239378f2006-10-07 21:54:55 +0200209#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211 /* terminate, set to next free slot, shrink available space */
212 envp[i] = NULL;
213 envp = &envp[i];
214 num_envp -= i;
215 buffer = &buffer[length];
216 buffer_size -= length;
217
Kay Sievers312c0042005-11-16 09:00:00 +0100218 if (dev->bus && dev->bus->uevent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100220 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200221 if (retval)
222 pr_debug ("%s: bus uevent() returned %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 __FUNCTION__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 }
225
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700226 if (dev->class && dev->class->dev_uevent) {
227 /* have the class specific function add its stuff */
228 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200229 if (retval)
230 pr_debug("%s: class uevent() returned %d\n",
231 __FUNCTION__, retval);
232 }
233
234 if (dev->type && dev->type->uevent) {
235 /* have the device type specific fuction add its stuff */
236 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
237 if (retval)
238 pr_debug("%s: dev_type uevent() returned %d\n",
239 __FUNCTION__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700240 }
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 return retval;
243}
244
Kay Sievers312c0042005-11-16 09:00:00 +0100245static struct kset_uevent_ops device_uevent_ops = {
246 .filter = dev_uevent_filter,
247 .name = dev_uevent_name,
248 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249};
250
Kay Sievers16574dc2007-04-06 01:40:38 +0200251static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
252 char *buf)
253{
254 struct kobject *top_kobj;
255 struct kset *kset;
256 char *envp[32];
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200257 char *data = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200258 char *pos;
259 int i;
260 size_t count = 0;
261 int retval;
262
263 /* search the kset, the device belongs to */
264 top_kobj = &dev->kobj;
265 if (!top_kobj->kset && top_kobj->parent) {
266 do {
267 top_kobj = top_kobj->parent;
268 } while (!top_kobj->kset && top_kobj->parent);
269 }
270 if (!top_kobj->kset)
271 goto out;
272 kset = top_kobj->kset;
273 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
274 goto out;
275
276 /* respect filter */
277 if (kset->uevent_ops && kset->uevent_ops->filter)
278 if (!kset->uevent_ops->filter(kset, &dev->kobj))
279 goto out;
280
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200281 data = (char *)get_zeroed_page(GFP_KERNEL);
282 if (!data)
283 return -ENOMEM;
284
Kay Sievers16574dc2007-04-06 01:40:38 +0200285 /* let the kset specific function add its keys */
286 pos = data;
287 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
288 envp, ARRAY_SIZE(envp),
289 pos, PAGE_SIZE);
290 if (retval)
291 goto out;
292
293 /* copy keys to file */
294 for (i = 0; envp[i]; i++) {
295 pos = &buf[count];
296 count += sprintf(pos, "%s\n", envp[i]);
297 }
298out:
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200299 free_page((unsigned long)data);
Kay Sievers16574dc2007-04-06 01:40:38 +0200300 return count;
301}
302
Kay Sieversa7fd6702005-10-01 14:49:43 +0200303static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
304 const char *buf, size_t count)
305{
Kay Sievers22af74f2007-04-06 01:40:38 +0200306 if (memcmp(buf, "add", 3) != 0)
307 dev_err(dev, "uevent: unsupported action-string; this will "
308 "be ignored in a future kernel version");
Kay Sievers312c0042005-11-16 09:00:00 +0100309 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200310 return count;
311}
312
Tejun Heoad6a1e12007-06-14 03:45:17 +0900313static struct device_attribute uevent_attr =
314 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
315
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500316static int device_add_attributes(struct device *dev,
317 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700318{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700319 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500320 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700321
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500322 if (attrs) {
323 for (i = 0; attr_name(attrs[i]); i++) {
324 error = device_create_file(dev, &attrs[i]);
325 if (error)
326 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700327 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500328 if (error)
329 while (--i >= 0)
330 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700331 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700332 return error;
333}
334
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500335static void device_remove_attributes(struct device *dev,
336 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700337{
338 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500339
340 if (attrs)
341 for (i = 0; attr_name(attrs[i]); i++)
342 device_remove_file(dev, &attrs[i]);
343}
344
345static int device_add_groups(struct device *dev,
346 struct attribute_group **groups)
347{
348 int error = 0;
349 int i;
350
351 if (groups) {
352 for (i = 0; groups[i]; i++) {
353 error = sysfs_create_group(&dev->kobj, groups[i]);
354 if (error) {
355 while (--i >= 0)
356 sysfs_remove_group(&dev->kobj, groups[i]);
357 break;
358 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700359 }
360 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500361 return error;
362}
363
364static void device_remove_groups(struct device *dev,
365 struct attribute_group **groups)
366{
367 int i;
368
369 if (groups)
370 for (i = 0; groups[i]; i++)
371 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700372}
373
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700374static int device_add_attrs(struct device *dev)
375{
376 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200377 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500378 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700379
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500380 if (class) {
381 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200382 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500383 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700384 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200385
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500386 if (type) {
387 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200388 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500389 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200390 }
391
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500392 error = device_add_groups(dev, dev->groups);
393 if (error)
394 goto err_remove_type_groups;
395
396 return 0;
397
398 err_remove_type_groups:
399 if (type)
400 device_remove_groups(dev, type->groups);
401 err_remove_class_attrs:
402 if (class)
403 device_remove_attributes(dev, class->dev_attrs);
404
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700405 return error;
406}
407
408static void device_remove_attrs(struct device *dev)
409{
410 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200411 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700412
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500413 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200414
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500415 if (type)
416 device_remove_groups(dev, type->groups);
417
418 if (class)
419 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700420}
421
422
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700423static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
424 char *buf)
425{
426 return print_dev_t(buf, dev->devt);
427}
428
Tejun Heoad6a1e12007-06-14 03:45:17 +0900429static struct device_attribute devt_attr =
430 __ATTR(dev, S_IRUGO, show_dev, NULL);
431
Martin Waitz0863afb2006-01-09 20:53:55 -0800432/*
433 * devices_subsys - structure to be registered with kobject core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 */
435
Kay Sievers312c0042005-11-16 09:00:00 +0100436decl_subsys(devices, &ktype_device, &device_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438
439/**
440 * device_create_file - create sysfs attribute file for device.
441 * @dev: device.
442 * @attr: device attribute descriptor.
443 */
444
445int device_create_file(struct device * dev, struct device_attribute * attr)
446{
447 int error = 0;
448 if (get_device(dev)) {
449 error = sysfs_create_file(&dev->kobj, &attr->attr);
450 put_device(dev);
451 }
452 return error;
453}
454
455/**
456 * device_remove_file - remove sysfs attribute file.
457 * @dev: device.
458 * @attr: device attribute descriptor.
459 */
460
461void device_remove_file(struct device * dev, struct device_attribute * attr)
462{
463 if (get_device(dev)) {
464 sysfs_remove_file(&dev->kobj, &attr->attr);
465 put_device(dev);
466 }
467}
468
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700469/**
470 * device_create_bin_file - create sysfs binary attribute file for device.
471 * @dev: device.
472 * @attr: device binary attribute descriptor.
473 */
474int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
475{
476 int error = -EINVAL;
477 if (dev)
478 error = sysfs_create_bin_file(&dev->kobj, attr);
479 return error;
480}
481EXPORT_SYMBOL_GPL(device_create_bin_file);
482
483/**
484 * device_remove_bin_file - remove sysfs binary attribute file
485 * @dev: device.
486 * @attr: device binary attribute descriptor.
487 */
488void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
489{
490 if (dev)
491 sysfs_remove_bin_file(&dev->kobj, attr);
492}
493EXPORT_SYMBOL_GPL(device_remove_bin_file);
494
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400495/**
Alan Stern523ded72007-04-26 00:12:04 -0700496 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400497 * @dev: device.
498 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700499 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400500 *
501 * Attribute methods must not unregister themselves or their parent device
502 * (which would amount to the same thing). Attempts to do so will deadlock,
503 * since unregistration is mutually exclusive with driver callbacks.
504 *
505 * Instead methods can call this routine, which will attempt to allocate
506 * and schedule a workqueue request to call back @func with @dev as its
507 * argument in the workqueue's process context. @dev will be pinned until
508 * @func returns.
509 *
Alan Stern523ded72007-04-26 00:12:04 -0700510 * This routine is usually called via the inline device_schedule_callback(),
511 * which automatically sets @owner to THIS_MODULE.
512 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400513 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700514 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400515 *
516 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
517 * underlying sysfs routine (since it is intended for use by attribute
518 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
519 */
Alan Stern523ded72007-04-26 00:12:04 -0700520int device_schedule_callback_owner(struct device *dev,
521 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400522{
523 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700524 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400525}
Alan Stern523ded72007-04-26 00:12:04 -0700526EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400527
James Bottomley34bb61f2005-09-06 16:56:51 -0700528static void klist_children_get(struct klist_node *n)
529{
530 struct device *dev = container_of(n, struct device, knode_parent);
531
532 get_device(dev);
533}
534
535static void klist_children_put(struct klist_node *n)
536{
537 struct device *dev = container_of(n, struct device, knode_parent);
538
539 put_device(dev);
540}
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543/**
544 * device_initialize - init device structure.
545 * @dev: device.
546 *
547 * This prepares the device for use by other layers,
548 * including adding it to the device hierarchy.
549 * It is the first half of device_register(), if called by
550 * that, though it can also be called separately, so one
551 * may use @dev's fields (e.g. the refcount).
552 */
553
554void device_initialize(struct device *dev)
555{
556 kobj_set_kset_s(dev, devices_subsys);
557 kobject_init(&dev->kobj);
James Bottomley34bb61f2005-09-06 16:56:51 -0700558 klist_init(&dev->klist_children, klist_children_get,
559 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700561 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800562 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900563 spin_lock_init(&dev->devres_lock);
564 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700565 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800566 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567}
568
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100569#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckc744aea2007-01-08 20:16:44 +0100570static struct kobject * get_device_parent(struct device *dev,
571 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100572{
573 /* Set the parent to the class, not the parent device */
574 /* this keeps sysfs from having a symlink to make old udevs happy */
575 if (dev->class)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700576 return &dev->class->subsys.kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100577 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100578 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100579
Cornelia Huckc744aea2007-01-08 20:16:44 +0100580 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100581}
582#else
Kay Sievers86406242007-03-14 03:25:56 +0100583static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700584{
Kay Sievers86406242007-03-14 03:25:56 +0100585 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700586
Kay Sievers86406242007-03-14 03:25:56 +0100587 if (!virtual_dir)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700588 virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700589
Kay Sievers86406242007-03-14 03:25:56 +0100590 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700591}
592
Cornelia Huckc744aea2007-01-08 20:16:44 +0100593static struct kobject * get_device_parent(struct device *dev,
594 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100595{
Kay Sievers86406242007-03-14 03:25:56 +0100596 if (dev->class) {
597 struct kobject *kobj = NULL;
598 struct kobject *parent_kobj;
599 struct kobject *k;
600
601 /*
602 * If we have no parent, we live in "virtual".
603 * Class-devices with a bus-device as parent, live
604 * in a class-directory to prevent namespace collisions.
605 */
606 if (parent == NULL)
607 parent_kobj = virtual_device_parent(dev);
608 else if (parent->class)
609 return &parent->kobj;
610 else
611 parent_kobj = &parent->kobj;
612
613 /* find our class-directory at the parent and reference it */
614 spin_lock(&dev->class->class_dirs.list_lock);
615 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
616 if (k->parent == parent_kobj) {
617 kobj = kobject_get(k);
618 break;
619 }
620 spin_unlock(&dev->class->class_dirs.list_lock);
621 if (kobj)
622 return kobj;
623
624 /* or create a new class-directory at the parent device */
625 return kobject_kset_add_dir(&dev->class->class_dirs,
626 parent_kobj, dev->class->name);
627 }
628
629 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100630 return &parent->kobj;
631 return NULL;
632}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100633#endif
Kay Sievers86406242007-03-14 03:25:56 +0100634
Cornelia Huckc744aea2007-01-08 20:16:44 +0100635static int setup_parent(struct device *dev, struct device *parent)
636{
637 struct kobject *kobj;
638 kobj = get_device_parent(dev, parent);
639 if (IS_ERR(kobj))
640 return PTR_ERR(kobj);
641 if (kobj)
642 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100643 return 0;
644}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646/**
647 * device_add - add device to device hierarchy.
648 * @dev: device.
649 *
650 * This is part 2 of device_register(), though may be called
651 * separately _iff_ device_initialize() has been called separately.
652 *
653 * This adds it to the kobject hierarchy via kobject_add(), adds it
654 * to the global and sibling lists for the device, then
655 * adds it to the other relevant subsystems of the driver model.
656 */
657int device_add(struct device *dev)
658{
659 struct device *parent = NULL;
Greg Kroah-Hartmane9a7d302006-06-20 13:59:20 -0700660 char *class_name = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200661 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 int error = -EINVAL;
663
664 dev = get_device(dev);
665 if (!dev || !strlen(dev->bus_id))
666 goto Error;
667
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100668 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 parent = get_device(dev->parent);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100671 error = setup_parent(dev, parent);
672 if (error)
673 goto Error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 /* first, register with generic layer. */
676 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100677 error = kobject_add(&dev->kobj);
678 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200680
Brian Walsh37022642006-08-14 22:43:19 -0700681 /* notify platform of device entry */
682 if (platform_notify)
683 platform_notify(dev);
684
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000685 /* notify clients of device entry (new way) */
686 if (dev->bus)
687 blocking_notifier_call_chain(&dev->bus->bus_notifier,
688 BUS_NOTIFY_ADD_DEVICE, dev);
689
Tejun Heoad6a1e12007-06-14 03:45:17 +0900690 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200691 if (error)
692 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200693
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700694 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900695 error = device_create_file(dev, &devt_attr);
696 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200697 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700698 }
699
Kay Sieversb9d9c822006-06-15 15:31:56 +0200700 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700701 sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
Kay Sieversb9d9c822006-06-15 15:31:56 +0200702 "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100703 /* If this is not a "fake" compatible device, then create the
704 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700705 if (dev->kobj.parent != &dev->class->subsys.kobj)
706 sysfs_create_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100707 &dev->kobj, dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700708 if (parent) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100709 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
710 "device");
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800711#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100712 class_name = make_class_name(dev->class->name,
713 &dev->kobj);
714 if (class_name)
715 sysfs_create_link(&dev->parent->kobj,
716 &dev->kobj, class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200717#endif
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800718 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200719 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700720
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700721 error = device_add_attrs(dev);
722 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700723 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700724 error = device_pm_add(dev);
725 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 goto PMError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700727 error = bus_add_device(dev);
728 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 goto BusError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200730 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800731 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400733 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700735 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700736 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200737 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700738 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200739
740 /* notify any interfaces that the device is here */
741 list_for_each_entry(class_intf, &dev->class->interfaces, node)
742 if (class_intf->add_dev)
743 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700744 up(&dev->class->sem);
745 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 Done:
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500747 kfree(class_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 put_device(dev);
749 return error;
750 BusError:
751 device_pm_remove(dev);
752 PMError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000753 if (dev->bus)
754 blocking_notifier_call_chain(&dev->bus->bus_notifier,
755 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000756 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700757 AttrsError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900758 if (MAJOR(dev->devt))
759 device_remove_file(dev, &devt_attr);
James Simmons82f0cf92007-02-21 17:44:51 +0000760
761 if (dev->class) {
762 sysfs_remove_link(&dev->kobj, "subsystem");
763 /* If this is not a "fake" compatible device, remove the
764 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700765 if (dev->kobj.parent != &dev->class->subsys.kobj)
766 sysfs_remove_link(&dev->class->subsys.kobj,
James Simmons82f0cf92007-02-21 17:44:51 +0000767 dev->bus_id);
James Simmons82f0cf92007-02-21 17:44:51 +0000768 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800769#ifdef CONFIG_SYSFS_DEPRECATED
James Simmons82f0cf92007-02-21 17:44:51 +0000770 char *class_name = make_class_name(dev->class->name,
771 &dev->kobj);
772 if (class_name)
773 sysfs_remove_link(&dev->parent->kobj,
774 class_name);
775 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800776#endif
James Simmons82f0cf92007-02-21 17:44:51 +0000777 sysfs_remove_link(&dev->kobj, "device");
778 }
James Simmons82f0cf92007-02-21 17:44:51 +0000779 }
Cornelia Hucka306eea2006-09-22 11:37:13 +0200780 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900781 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700782 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100783 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 kobject_del(&dev->kobj);
785 Error:
786 if (parent)
787 put_device(parent);
788 goto Done;
789}
790
791
792/**
793 * device_register - register a device with the system.
794 * @dev: pointer to the device structure
795 *
796 * This happens in two clean steps - initialize the device
797 * and add it to the system. The two steps can be called
798 * separately, but this is the easiest and most common.
799 * I.e. you should only call the two helpers separately if
800 * have a clearly defined need to use and refcount the device
801 * before it is added to the hierarchy.
802 */
803
804int device_register(struct device *dev)
805{
806 device_initialize(dev);
807 return device_add(dev);
808}
809
810
811/**
812 * get_device - increment reference count for device.
813 * @dev: device.
814 *
815 * This simply forwards the call to kobject_get(), though
816 * we do take care to provide for the case that we get a NULL
817 * pointer passed in.
818 */
819
820struct device * get_device(struct device * dev)
821{
822 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
823}
824
825
826/**
827 * put_device - decrement reference count.
828 * @dev: device in question.
829 */
830void put_device(struct device * dev)
831{
832 if (dev)
833 kobject_put(&dev->kobj);
834}
835
836
837/**
838 * device_del - delete device from system.
839 * @dev: device.
840 *
841 * This is the first part of the device unregistration
842 * sequence. This removes the device from the lists we control
843 * from here, has it removed from the other driver model
844 * subsystems it was added to in device_add(), and removes it
845 * from the kobject hierarchy.
846 *
847 * NOTE: this should be called manually _iff_ device_add() was
848 * also called manually.
849 */
850
851void device_del(struct device * dev)
852{
853 struct device * parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200854 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700857 klist_del(&dev->knode_parent);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900858 if (MAJOR(dev->devt))
859 device_remove_file(dev, &devt_attr);
Kay Sieversb9d9c822006-06-15 15:31:56 +0200860 if (dev->class) {
861 sysfs_remove_link(&dev->kobj, "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100862 /* If this is not a "fake" compatible device, remove the
863 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700864 if (dev->kobj.parent != &dev->class->subsys.kobj)
865 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100866 dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700867 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800868#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200869 char *class_name = make_class_name(dev->class->name,
870 &dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100871 if (class_name)
872 sysfs_remove_link(&dev->parent->kobj,
873 class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200874 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800875#endif
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200876 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700877 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200878
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700879 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200880 /* notify any interfaces that the device is now gone */
881 list_for_each_entry(class_intf, &dev->class->interfaces, node)
882 if (class_intf->remove_dev)
883 class_intf->remove_dev(dev, class_intf);
884 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700885 list_del_init(&dev->node);
886 up(&dev->class->sem);
Kay Sievers86406242007-03-14 03:25:56 +0100887
888 /* If we live in a parent class-directory, unreference it */
889 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
890 struct device *d;
891 int other = 0;
892
893 /*
894 * if we are the last child of our class, delete
895 * our class-directory at this parent
896 */
897 down(&dev->class->sem);
898 list_for_each_entry(d, &dev->class->devices, node) {
899 if (d == dev)
900 continue;
901 if (d->kobj.parent == dev->kobj.parent) {
902 other = 1;
903 break;
904 }
905 }
906 if (!other)
907 kobject_del(dev->kobj.parent);
908
909 kobject_put(dev->kobj.parent);
910 up(&dev->class->sem);
911 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200912 }
Tejun Heoad6a1e12007-06-14 03:45:17 +0900913 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700914 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800915 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900917 /*
918 * Some platform devices are driven without driver attached
919 * and managed resources may have been acquired. Make sure
920 * all resources are released.
921 */
922 devres_release_all(dev);
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 /* Notify the platform of the removal, in case they
925 * need to do anything...
926 */
927 if (platform_notify_remove)
928 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000929 if (dev->bus)
930 blocking_notifier_call_chain(&dev->bus->bus_notifier,
931 BUS_NOTIFY_DEL_DEVICE, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 device_pm_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100933 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 kobject_del(&dev->kobj);
935 if (parent)
936 put_device(parent);
937}
938
939/**
940 * device_unregister - unregister device from system.
941 * @dev: device going away.
942 *
943 * We do this in two parts, like we do device_register(). First,
944 * we remove it from all the subsystems with device_del(), then
945 * we decrement the reference count via put_device(). If that
946 * is the final reference count, the device will be cleaned up
947 * via device_release() above. Otherwise, the structure will
948 * stick around until the final reference to the device is dropped.
949 */
950void device_unregister(struct device * dev)
951{
952 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
953 device_del(dev);
954 put_device(dev);
955}
956
957
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800958static struct device * next_device(struct klist_iter * i)
959{
960 struct klist_node * n = klist_next(i);
961 return n ? container_of(n, struct device, knode_parent) : NULL;
962}
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/**
965 * device_for_each_child - device child iterator.
Randy Dunlapc41455f2005-10-23 11:59:14 -0700966 * @parent: parent struct device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 * @data: data for the callback.
968 * @fn: function to be called for each device.
969 *
Randy Dunlapc41455f2005-10-23 11:59:14 -0700970 * Iterate over @parent's child devices, and call @fn for each,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 * passing it @data.
972 *
973 * We check the return of @fn each time. If it returns anything
974 * other than 0, we break out and return that value.
975 */
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800976int device_for_each_child(struct device * parent, void * data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 int (*fn)(struct device *, void *))
978{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800979 struct klist_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 struct device * child;
981 int error = 0;
982
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800983 klist_iter_init(&parent->klist_children, &i);
984 while ((child = next_device(&i)) && !error)
985 error = fn(child, data);
986 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 return error;
988}
989
Cornelia Huck5ab69982006-11-16 15:42:07 +0100990/**
991 * device_find_child - device iterator for locating a particular device.
992 * @parent: parent struct device
993 * @data: Data to pass to match function
994 * @match: Callback function to check device
995 *
996 * This is similar to the device_for_each_child() function above, but it
997 * returns a reference to a device that is 'found' for later use, as
998 * determined by the @match callback.
999 *
1000 * The callback should return 0 if the device doesn't match and non-zero
1001 * if it does. If the callback returns non-zero and a reference to the
1002 * current device can be obtained, this function will return to the caller
1003 * and not iterate over any more devices.
1004 */
1005struct device * device_find_child(struct device *parent, void *data,
1006 int (*match)(struct device *, void *))
1007{
1008 struct klist_iter i;
1009 struct device *child;
1010
1011 if (!parent)
1012 return NULL;
1013
1014 klist_iter_init(&parent->klist_children, &i);
1015 while ((child = next_device(&i)))
1016 if (match(child, data) && get_device(child))
1017 break;
1018 klist_iter_exit(&i);
1019 return child;
1020}
1021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022int __init devices_init(void)
1023{
1024 return subsystem_register(&devices_subsys);
1025}
1026
1027EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001028EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030EXPORT_SYMBOL_GPL(device_initialize);
1031EXPORT_SYMBOL_GPL(device_add);
1032EXPORT_SYMBOL_GPL(device_register);
1033
1034EXPORT_SYMBOL_GPL(device_del);
1035EXPORT_SYMBOL_GPL(device_unregister);
1036EXPORT_SYMBOL_GPL(get_device);
1037EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
1039EXPORT_SYMBOL_GPL(device_create_file);
1040EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001041
1042
1043static void device_create_release(struct device *dev)
1044{
1045 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1046 kfree(dev);
1047}
1048
1049/**
1050 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001051 * @class: pointer to the struct class that this device should be registered to
1052 * @parent: pointer to the parent struct device of this new device, if any
1053 * @devt: the dev_t for the char device to be added
1054 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001055 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001056 * This function can be used by char device classes. A struct device
1057 * will be created in sysfs, registered to the specified class.
1058 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001059 * A "dev" file will be created, showing the dev_t for the device, if
1060 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001061 * If a pointer to a parent struct device is passed in, the newly created
1062 * struct device will be a child of that device in sysfs.
1063 * The pointer to the struct device will be returned from the call.
1064 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001065 * pointer.
1066 *
1067 * Note: the struct class passed to this function must have previously
1068 * been created with a call to class_create().
1069 */
1070struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001071 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001072{
1073 va_list args;
1074 struct device *dev = NULL;
1075 int retval = -ENODEV;
1076
1077 if (class == NULL || IS_ERR(class))
1078 goto error;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001079
1080 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1081 if (!dev) {
1082 retval = -ENOMEM;
1083 goto error;
1084 }
1085
1086 dev->devt = devt;
1087 dev->class = class;
1088 dev->parent = parent;
1089 dev->release = device_create_release;
1090
1091 va_start(args, fmt);
1092 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1093 va_end(args);
1094 retval = device_register(dev);
1095 if (retval)
1096 goto error;
1097
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001098 return dev;
1099
1100error:
1101 kfree(dev);
1102 return ERR_PTR(retval);
1103}
1104EXPORT_SYMBOL_GPL(device_create);
1105
1106/**
1107 * device_destroy - removes a device that was created with device_create()
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001108 * @class: pointer to the struct class that this device was registered with
1109 * @devt: the dev_t of the device that was previously registered
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001110 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001111 * This call unregisters and cleans up a device that was created with a
1112 * call to device_create().
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001113 */
1114void device_destroy(struct class *class, dev_t devt)
1115{
1116 struct device *dev = NULL;
1117 struct device *dev_tmp;
1118
1119 down(&class->sem);
1120 list_for_each_entry(dev_tmp, &class->devices, node) {
1121 if (dev_tmp->devt == devt) {
1122 dev = dev_tmp;
1123 break;
1124 }
1125 }
1126 up(&class->sem);
1127
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001128 if (dev)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001129 device_unregister(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001130}
1131EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001132
1133/**
1134 * device_rename - renames a device
1135 * @dev: the pointer to the struct device to be renamed
1136 * @new_name: the new name of the device
1137 */
1138int device_rename(struct device *dev, char *new_name)
1139{
1140 char *old_class_name = NULL;
1141 char *new_class_name = NULL;
1142 char *old_symlink_name = NULL;
1143 int error;
1144
1145 dev = get_device(dev);
1146 if (!dev)
1147 return -EINVAL;
1148
1149 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1150
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001151#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001152 if ((dev->class) && (dev->parent))
1153 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001154#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001155
1156 if (dev->class) {
1157 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
Jesper Juhl952ab432006-09-28 23:56:01 +02001158 if (!old_symlink_name) {
1159 error = -ENOMEM;
1160 goto out_free_old_class;
1161 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001162 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1163 }
1164
1165 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1166
1167 error = kobject_rename(&dev->kobj, new_name);
1168
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001169#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001170 if (old_class_name) {
1171 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1172 if (new_class_name) {
1173 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1174 new_class_name);
1175 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1176 }
1177 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001178#endif
1179
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001180 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001181 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001182 old_symlink_name);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001183 sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001184 dev->bus_id);
1185 }
1186 put_device(dev);
1187
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001188 kfree(new_class_name);
1189 kfree(old_symlink_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001190 out_free_old_class:
1191 kfree(old_class_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001192
1193 return error;
1194}
Johannes Berga2807db2007-02-28 12:38:31 +01001195EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001196
1197static int device_move_class_links(struct device *dev,
1198 struct device *old_parent,
1199 struct device *new_parent)
1200{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001201 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001202#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001203 char *class_name;
1204
1205 class_name = make_class_name(dev->class->name, &dev->kobj);
1206 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001207 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001208 goto out;
1209 }
1210 if (old_parent) {
1211 sysfs_remove_link(&dev->kobj, "device");
1212 sysfs_remove_link(&old_parent->kobj, class_name);
1213 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001214 if (new_parent) {
1215 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1216 "device");
1217 if (error)
1218 goto out;
1219 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1220 class_name);
1221 if (error)
1222 sysfs_remove_link(&dev->kobj, "device");
1223 }
1224 else
1225 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001226out:
1227 kfree(class_name);
1228 return error;
1229#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001230 if (old_parent)
1231 sysfs_remove_link(&dev->kobj, "device");
1232 if (new_parent)
1233 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1234 "device");
1235 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001236#endif
1237}
1238
1239/**
1240 * device_move - moves a device to a new parent
1241 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001242 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001243 */
1244int device_move(struct device *dev, struct device *new_parent)
1245{
1246 int error;
1247 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001248 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001249
1250 dev = get_device(dev);
1251 if (!dev)
1252 return -EINVAL;
1253
Cornelia Huck8a824722006-11-20 17:07:51 +01001254 new_parent = get_device(new_parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +01001255 new_parent_kobj = get_device_parent (dev, new_parent);
1256 if (IS_ERR(new_parent_kobj)) {
1257 error = PTR_ERR(new_parent_kobj);
1258 put_device(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001259 goto out;
1260 }
1261 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
Cornelia Huckc744aea2007-01-08 20:16:44 +01001262 new_parent ? new_parent->bus_id : "<NULL>");
1263 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001264 if (error) {
1265 put_device(new_parent);
1266 goto out;
1267 }
1268 old_parent = dev->parent;
1269 dev->parent = new_parent;
1270 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001271 klist_remove(&dev->knode_parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +01001272 if (new_parent)
1273 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Cornelia Huck8a824722006-11-20 17:07:51 +01001274 if (!dev->class)
1275 goto out_put;
1276 error = device_move_class_links(dev, old_parent, new_parent);
1277 if (error) {
1278 /* We ignore errors on cleanup since we're hosed anyway... */
1279 device_move_class_links(dev, new_parent, old_parent);
1280 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001281 if (new_parent)
1282 klist_remove(&dev->knode_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001283 if (old_parent)
1284 klist_add_tail(&dev->knode_parent,
1285 &old_parent->klist_children);
1286 }
1287 put_device(new_parent);
1288 goto out;
1289 }
1290out_put:
1291 put_device(old_parent);
1292out:
1293 put_device(dev);
1294 return error;
1295}
1296
1297EXPORT_SYMBOL_GPL(device_move);