blob: 8aa090da1cd795e305c70d7987be6d005dd93f57 [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);
183 add_uevent_var(envp, num_envp, &i,
184 buffer, buffer_size, &length,
185 "PHYSDEVPATH=%s", path);
186 kfree(path);
187
188 add_uevent_var(envp, num_envp, &i,
189 buffer, buffer_size, &length,
190 "PHYSDEVBUS=%s", parent->bus->name);
191
192 if (parent->driver)
193 add_uevent_var(envp, num_envp, &i,
194 buffer, buffer_size, &length,
195 "PHYSDEVDRIVER=%s", parent->driver->name);
196 }
197 } else if (dev->bus) {
Kay Sievers312c0042005-11-16 09:00:00 +0100198 add_uevent_var(envp, num_envp, &i,
199 buffer, buffer_size, &length,
Kay Sievers239378f2006-10-07 21:54:55 +0200200 "PHYSDEVBUS=%s", dev->bus->name);
201
202 if (dev->driver)
203 add_uevent_var(envp, num_envp, &i,
204 buffer, buffer_size, &length,
205 "PHYSDEVDRIVER=%s", dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200206 }
Kay Sievers239378f2006-10-07 21:54:55 +0200207#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209 /* terminate, set to next free slot, shrink available space */
210 envp[i] = NULL;
211 envp = &envp[i];
212 num_envp -= i;
213 buffer = &buffer[length];
214 buffer_size -= length;
215
Kay Sievers312c0042005-11-16 09:00:00 +0100216 if (dev->bus && dev->bus->uevent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100218 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200219 if (retval)
220 pr_debug ("%s: bus uevent() returned %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 __FUNCTION__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 }
223
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700224 if (dev->class && dev->class->dev_uevent) {
225 /* have the class specific function add its stuff */
226 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200227 if (retval)
228 pr_debug("%s: class uevent() returned %d\n",
229 __FUNCTION__, retval);
230 }
231
232 if (dev->type && dev->type->uevent) {
233 /* have the device type specific fuction add its stuff */
234 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
235 if (retval)
236 pr_debug("%s: dev_type uevent() returned %d\n",
237 __FUNCTION__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700238 }
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return retval;
241}
242
Kay Sievers312c0042005-11-16 09:00:00 +0100243static struct kset_uevent_ops device_uevent_ops = {
244 .filter = dev_uevent_filter,
245 .name = dev_uevent_name,
246 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247};
248
Kay Sievers16574dc2007-04-06 01:40:38 +0200249static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
250 char *buf)
251{
252 struct kobject *top_kobj;
253 struct kset *kset;
254 char *envp[32];
255 char data[PAGE_SIZE];
256 char *pos;
257 int i;
258 size_t count = 0;
259 int retval;
260
261 /* search the kset, the device belongs to */
262 top_kobj = &dev->kobj;
263 if (!top_kobj->kset && top_kobj->parent) {
264 do {
265 top_kobj = top_kobj->parent;
266 } while (!top_kobj->kset && top_kobj->parent);
267 }
268 if (!top_kobj->kset)
269 goto out;
270 kset = top_kobj->kset;
271 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
272 goto out;
273
274 /* respect filter */
275 if (kset->uevent_ops && kset->uevent_ops->filter)
276 if (!kset->uevent_ops->filter(kset, &dev->kobj))
277 goto out;
278
279 /* let the kset specific function add its keys */
280 pos = data;
281 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
282 envp, ARRAY_SIZE(envp),
283 pos, PAGE_SIZE);
284 if (retval)
285 goto out;
286
287 /* copy keys to file */
288 for (i = 0; envp[i]; i++) {
289 pos = &buf[count];
290 count += sprintf(pos, "%s\n", envp[i]);
291 }
292out:
293 return count;
294}
295
Kay Sieversa7fd6702005-10-01 14:49:43 +0200296static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
297 const char *buf, size_t count)
298{
Kay Sievers22af74f2007-04-06 01:40:38 +0200299 if (memcmp(buf, "add", 3) != 0)
300 dev_err(dev, "uevent: unsupported action-string; this will "
301 "be ignored in a future kernel version");
Kay Sievers312c0042005-11-16 09:00:00 +0100302 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200303 return count;
304}
305
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500306static int device_add_attributes(struct device *dev,
307 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700308{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700309 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500310 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700311
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500312 if (attrs) {
313 for (i = 0; attr_name(attrs[i]); i++) {
314 error = device_create_file(dev, &attrs[i]);
315 if (error)
316 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700317 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500318 if (error)
319 while (--i >= 0)
320 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700321 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700322 return error;
323}
324
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500325static void device_remove_attributes(struct device *dev,
326 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700327{
328 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500329
330 if (attrs)
331 for (i = 0; attr_name(attrs[i]); i++)
332 device_remove_file(dev, &attrs[i]);
333}
334
335static int device_add_groups(struct device *dev,
336 struct attribute_group **groups)
337{
338 int error = 0;
339 int i;
340
341 if (groups) {
342 for (i = 0; groups[i]; i++) {
343 error = sysfs_create_group(&dev->kobj, groups[i]);
344 if (error) {
345 while (--i >= 0)
346 sysfs_remove_group(&dev->kobj, groups[i]);
347 break;
348 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700349 }
350 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500351 return error;
352}
353
354static void device_remove_groups(struct device *dev,
355 struct attribute_group **groups)
356{
357 int i;
358
359 if (groups)
360 for (i = 0; groups[i]; i++)
361 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700362}
363
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700364static int device_add_attrs(struct device *dev)
365{
366 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200367 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500368 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700369
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500370 if (class) {
371 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200372 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500373 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700374 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200375
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500376 if (type) {
377 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200378 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500379 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200380 }
381
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500382 error = device_add_groups(dev, dev->groups);
383 if (error)
384 goto err_remove_type_groups;
385
386 return 0;
387
388 err_remove_type_groups:
389 if (type)
390 device_remove_groups(dev, type->groups);
391 err_remove_class_attrs:
392 if (class)
393 device_remove_attributes(dev, class->dev_attrs);
394
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700395 return error;
396}
397
398static void device_remove_attrs(struct device *dev)
399{
400 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200401 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700402
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500403 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200404
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500405 if (type)
406 device_remove_groups(dev, type->groups);
407
408 if (class)
409 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700410}
411
412
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700413static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
414 char *buf)
415{
416 return print_dev_t(buf, dev->devt);
417}
418
Martin Waitz0863afb2006-01-09 20:53:55 -0800419/*
420 * devices_subsys - structure to be registered with kobject core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 */
422
Kay Sievers312c0042005-11-16 09:00:00 +0100423decl_subsys(devices, &ktype_device, &device_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
425
426/**
427 * device_create_file - create sysfs attribute file for device.
428 * @dev: device.
429 * @attr: device attribute descriptor.
430 */
431
432int device_create_file(struct device * dev, struct device_attribute * attr)
433{
434 int error = 0;
435 if (get_device(dev)) {
436 error = sysfs_create_file(&dev->kobj, &attr->attr);
437 put_device(dev);
438 }
439 return error;
440}
441
442/**
443 * device_remove_file - remove sysfs attribute file.
444 * @dev: device.
445 * @attr: device attribute descriptor.
446 */
447
448void device_remove_file(struct device * dev, struct device_attribute * attr)
449{
450 if (get_device(dev)) {
451 sysfs_remove_file(&dev->kobj, &attr->attr);
452 put_device(dev);
453 }
454}
455
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700456/**
457 * device_create_bin_file - create sysfs binary attribute file for device.
458 * @dev: device.
459 * @attr: device binary attribute descriptor.
460 */
461int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
462{
463 int error = -EINVAL;
464 if (dev)
465 error = sysfs_create_bin_file(&dev->kobj, attr);
466 return error;
467}
468EXPORT_SYMBOL_GPL(device_create_bin_file);
469
470/**
471 * device_remove_bin_file - remove sysfs binary attribute file
472 * @dev: device.
473 * @attr: device binary attribute descriptor.
474 */
475void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
476{
477 if (dev)
478 sysfs_remove_bin_file(&dev->kobj, attr);
479}
480EXPORT_SYMBOL_GPL(device_remove_bin_file);
481
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400482/**
Alan Stern523ded72007-04-26 00:12:04 -0700483 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400484 * @dev: device.
485 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700486 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400487 *
488 * Attribute methods must not unregister themselves or their parent device
489 * (which would amount to the same thing). Attempts to do so will deadlock,
490 * since unregistration is mutually exclusive with driver callbacks.
491 *
492 * Instead methods can call this routine, which will attempt to allocate
493 * and schedule a workqueue request to call back @func with @dev as its
494 * argument in the workqueue's process context. @dev will be pinned until
495 * @func returns.
496 *
Alan Stern523ded72007-04-26 00:12:04 -0700497 * This routine is usually called via the inline device_schedule_callback(),
498 * which automatically sets @owner to THIS_MODULE.
499 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400500 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700501 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400502 *
503 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
504 * underlying sysfs routine (since it is intended for use by attribute
505 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
506 */
Alan Stern523ded72007-04-26 00:12:04 -0700507int device_schedule_callback_owner(struct device *dev,
508 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400509{
510 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700511 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400512}
Alan Stern523ded72007-04-26 00:12:04 -0700513EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400514
James Bottomley34bb61f2005-09-06 16:56:51 -0700515static void klist_children_get(struct klist_node *n)
516{
517 struct device *dev = container_of(n, struct device, knode_parent);
518
519 get_device(dev);
520}
521
522static void klist_children_put(struct klist_node *n)
523{
524 struct device *dev = container_of(n, struct device, knode_parent);
525
526 put_device(dev);
527}
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530/**
531 * device_initialize - init device structure.
532 * @dev: device.
533 *
534 * This prepares the device for use by other layers,
535 * including adding it to the device hierarchy.
536 * It is the first half of device_register(), if called by
537 * that, though it can also be called separately, so one
538 * may use @dev's fields (e.g. the refcount).
539 */
540
541void device_initialize(struct device *dev)
542{
543 kobj_set_kset_s(dev, devices_subsys);
544 kobject_init(&dev->kobj);
James Bottomley34bb61f2005-09-06 16:56:51 -0700545 klist_init(&dev->klist_children, klist_children_get,
546 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700548 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800549 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900550 spin_lock_init(&dev->devres_lock);
551 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700552 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800553 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554}
555
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100556#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckc744aea2007-01-08 20:16:44 +0100557static struct kobject * get_device_parent(struct device *dev,
558 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100559{
560 /* Set the parent to the class, not the parent device */
561 /* this keeps sysfs from having a symlink to make old udevs happy */
562 if (dev->class)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100563 return &dev->class->subsys.kset.kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100564 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100565 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100566
Cornelia Huckc744aea2007-01-08 20:16:44 +0100567 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100568}
569#else
Kay Sievers86406242007-03-14 03:25:56 +0100570static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700571{
Kay Sievers86406242007-03-14 03:25:56 +0100572 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700573
Kay Sievers86406242007-03-14 03:25:56 +0100574 if (!virtual_dir)
575 virtual_dir = kobject_add_dir(&devices_subsys.kset.kobj, "virtual");
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700576
Kay Sievers86406242007-03-14 03:25:56 +0100577 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700578}
579
Cornelia Huckc744aea2007-01-08 20:16:44 +0100580static struct kobject * get_device_parent(struct device *dev,
581 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100582{
Kay Sievers86406242007-03-14 03:25:56 +0100583 if (dev->class) {
584 struct kobject *kobj = NULL;
585 struct kobject *parent_kobj;
586 struct kobject *k;
587
588 /*
589 * If we have no parent, we live in "virtual".
590 * Class-devices with a bus-device as parent, live
591 * in a class-directory to prevent namespace collisions.
592 */
593 if (parent == NULL)
594 parent_kobj = virtual_device_parent(dev);
595 else if (parent->class)
596 return &parent->kobj;
597 else
598 parent_kobj = &parent->kobj;
599
600 /* find our class-directory at the parent and reference it */
601 spin_lock(&dev->class->class_dirs.list_lock);
602 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
603 if (k->parent == parent_kobj) {
604 kobj = kobject_get(k);
605 break;
606 }
607 spin_unlock(&dev->class->class_dirs.list_lock);
608 if (kobj)
609 return kobj;
610
611 /* or create a new class-directory at the parent device */
612 return kobject_kset_add_dir(&dev->class->class_dirs,
613 parent_kobj, dev->class->name);
614 }
615
616 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100617 return &parent->kobj;
618 return NULL;
619}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100620#endif
Kay Sievers86406242007-03-14 03:25:56 +0100621
Cornelia Huckc744aea2007-01-08 20:16:44 +0100622static int setup_parent(struct device *dev, struct device *parent)
623{
624 struct kobject *kobj;
625 kobj = get_device_parent(dev, parent);
626 if (IS_ERR(kobj))
627 return PTR_ERR(kobj);
628 if (kobj)
629 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100630 return 0;
631}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/**
634 * device_add - add device to device hierarchy.
635 * @dev: device.
636 *
637 * This is part 2 of device_register(), though may be called
638 * separately _iff_ device_initialize() has been called separately.
639 *
640 * This adds it to the kobject hierarchy via kobject_add(), adds it
641 * to the global and sibling lists for the device, then
642 * adds it to the other relevant subsystems of the driver model.
643 */
644int device_add(struct device *dev)
645{
646 struct device *parent = NULL;
Greg Kroah-Hartmane9a7d302006-06-20 13:59:20 -0700647 char *class_name = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200648 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 int error = -EINVAL;
650
651 dev = get_device(dev);
652 if (!dev || !strlen(dev->bus_id))
653 goto Error;
654
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100655 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 parent = get_device(dev->parent);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100658 error = setup_parent(dev, parent);
659 if (error)
660 goto Error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
662 /* first, register with generic layer. */
663 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100664 error = kobject_add(&dev->kobj);
665 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200667
Brian Walsh37022642006-08-14 22:43:19 -0700668 /* notify platform of device entry */
669 if (platform_notify)
670 platform_notify(dev);
671
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000672 /* notify clients of device entry (new way) */
673 if (dev->bus)
674 blocking_notifier_call_chain(&dev->bus->bus_notifier,
675 BUS_NOTIFY_ADD_DEVICE, dev);
676
Kay Sieversa7fd6702005-10-01 14:49:43 +0200677 dev->uevent_attr.attr.name = "uevent";
Kay Sievers16574dc2007-04-06 01:40:38 +0200678 dev->uevent_attr.attr.mode = S_IRUGO | S_IWUSR;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200679 if (dev->driver)
680 dev->uevent_attr.attr.owner = dev->driver->owner;
681 dev->uevent_attr.store = store_uevent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200682 dev->uevent_attr.show = show_uevent;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200683 error = device_create_file(dev, &dev->uevent_attr);
684 if (error)
685 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200686
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700687 if (MAJOR(dev->devt)) {
688 struct device_attribute *attr;
689 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
690 if (!attr) {
691 error = -ENOMEM;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200692 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700693 }
694 attr->attr.name = "dev";
695 attr->attr.mode = S_IRUGO;
696 if (dev->driver)
697 attr->attr.owner = dev->driver->owner;
698 attr->show = show_dev;
699 error = device_create_file(dev, attr);
700 if (error) {
701 kfree(attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200702 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700703 }
704
705 dev->devt_attr = attr;
706 }
707
Kay Sieversb9d9c822006-06-15 15:31:56 +0200708 if (dev->class) {
709 sysfs_create_link(&dev->kobj, &dev->class->subsys.kset.kobj,
710 "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100711 /* If this is not a "fake" compatible device, then create the
712 * symlink from the class to the device. */
713 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
714 sysfs_create_link(&dev->class->subsys.kset.kobj,
715 &dev->kobj, dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700716 if (parent) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100717 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
718 "device");
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800719#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100720 class_name = make_class_name(dev->class->name,
721 &dev->kobj);
722 if (class_name)
723 sysfs_create_link(&dev->parent->kobj,
724 &dev->kobj, class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200725#endif
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800726 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200727 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700728
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700729 if ((error = device_add_attrs(dev)))
730 goto AttrsError;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if ((error = device_pm_add(dev)))
732 goto PMError;
733 if ((error = bus_add_device(dev)))
734 goto BusError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200735 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800736 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400738 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700740 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700741 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200742 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700743 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200744
745 /* notify any interfaces that the device is here */
746 list_for_each_entry(class_intf, &dev->class->interfaces, node)
747 if (class_intf->add_dev)
748 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700749 up(&dev->class->sem);
750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 Done:
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500752 kfree(class_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 put_device(dev);
754 return error;
755 BusError:
756 device_pm_remove(dev);
757 PMError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000758 if (dev->bus)
759 blocking_notifier_call_chain(&dev->bus->bus_notifier,
760 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000761 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700762 AttrsError:
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700763 if (dev->devt_attr) {
764 device_remove_file(dev, dev->devt_attr);
765 kfree(dev->devt_attr);
766 }
James Simmons82f0cf92007-02-21 17:44:51 +0000767
768 if (dev->class) {
769 sysfs_remove_link(&dev->kobj, "subsystem");
770 /* If this is not a "fake" compatible device, remove the
771 * symlink from the class to the device. */
772 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
773 sysfs_remove_link(&dev->class->subsys.kset.kobj,
774 dev->bus_id);
James Simmons82f0cf92007-02-21 17:44:51 +0000775 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800776#ifdef CONFIG_SYSFS_DEPRECATED
James Simmons82f0cf92007-02-21 17:44:51 +0000777 char *class_name = make_class_name(dev->class->name,
778 &dev->kobj);
779 if (class_name)
780 sysfs_remove_link(&dev->parent->kobj,
781 class_name);
782 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800783#endif
James Simmons82f0cf92007-02-21 17:44:51 +0000784 sysfs_remove_link(&dev->kobj, "device");
785 }
James Simmons82f0cf92007-02-21 17:44:51 +0000786 }
Cornelia Hucka306eea2006-09-22 11:37:13 +0200787 ueventattrError:
788 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700789 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100790 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 kobject_del(&dev->kobj);
792 Error:
793 if (parent)
794 put_device(parent);
795 goto Done;
796}
797
798
799/**
800 * device_register - register a device with the system.
801 * @dev: pointer to the device structure
802 *
803 * This happens in two clean steps - initialize the device
804 * and add it to the system. The two steps can be called
805 * separately, but this is the easiest and most common.
806 * I.e. you should only call the two helpers separately if
807 * have a clearly defined need to use and refcount the device
808 * before it is added to the hierarchy.
809 */
810
811int device_register(struct device *dev)
812{
813 device_initialize(dev);
814 return device_add(dev);
815}
816
817
818/**
819 * get_device - increment reference count for device.
820 * @dev: device.
821 *
822 * This simply forwards the call to kobject_get(), though
823 * we do take care to provide for the case that we get a NULL
824 * pointer passed in.
825 */
826
827struct device * get_device(struct device * dev)
828{
829 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
830}
831
832
833/**
834 * put_device - decrement reference count.
835 * @dev: device in question.
836 */
837void put_device(struct device * dev)
838{
839 if (dev)
840 kobject_put(&dev->kobj);
841}
842
843
844/**
845 * device_del - delete device from system.
846 * @dev: device.
847 *
848 * This is the first part of the device unregistration
849 * sequence. This removes the device from the lists we control
850 * from here, has it removed from the other driver model
851 * subsystems it was added to in device_add(), and removes it
852 * from the kobject hierarchy.
853 *
854 * NOTE: this should be called manually _iff_ device_add() was
855 * also called manually.
856 */
857
858void device_del(struct device * dev)
859{
860 struct device * parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200861 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700864 klist_del(&dev->knode_parent);
Catalin Marinas82189b92006-11-25 11:09:30 -0800865 if (dev->devt_attr) {
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700866 device_remove_file(dev, dev->devt_attr);
Catalin Marinas82189b92006-11-25 11:09:30 -0800867 kfree(dev->devt_attr);
868 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200869 if (dev->class) {
870 sysfs_remove_link(&dev->kobj, "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100871 /* If this is not a "fake" compatible device, remove the
872 * symlink from the class to the device. */
873 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
874 sysfs_remove_link(&dev->class->subsys.kset.kobj,
875 dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700876 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800877#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200878 char *class_name = make_class_name(dev->class->name,
879 &dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100880 if (class_name)
881 sysfs_remove_link(&dev->parent->kobj,
882 class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200883 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800884#endif
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200885 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700886 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200887
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700888 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200889 /* notify any interfaces that the device is now gone */
890 list_for_each_entry(class_intf, &dev->class->interfaces, node)
891 if (class_intf->remove_dev)
892 class_intf->remove_dev(dev, class_intf);
893 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700894 list_del_init(&dev->node);
895 up(&dev->class->sem);
Kay Sievers86406242007-03-14 03:25:56 +0100896
897 /* If we live in a parent class-directory, unreference it */
898 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
899 struct device *d;
900 int other = 0;
901
902 /*
903 * if we are the last child of our class, delete
904 * our class-directory at this parent
905 */
906 down(&dev->class->sem);
907 list_for_each_entry(d, &dev->class->devices, node) {
908 if (d == dev)
909 continue;
910 if (d->kobj.parent == dev->kobj.parent) {
911 other = 1;
912 break;
913 }
914 }
915 if (!other)
916 kobject_del(dev->kobj.parent);
917
918 kobject_put(dev->kobj.parent);
919 up(&dev->class->sem);
920 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200921 }
Kay Sieversa7fd6702005-10-01 14:49:43 +0200922 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700923 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800924 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900926 /*
927 * Some platform devices are driven without driver attached
928 * and managed resources may have been acquired. Make sure
929 * all resources are released.
930 */
931 devres_release_all(dev);
932
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 /* Notify the platform of the removal, in case they
934 * need to do anything...
935 */
936 if (platform_notify_remove)
937 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000938 if (dev->bus)
939 blocking_notifier_call_chain(&dev->bus->bus_notifier,
940 BUS_NOTIFY_DEL_DEVICE, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 device_pm_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100942 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 kobject_del(&dev->kobj);
944 if (parent)
945 put_device(parent);
946}
947
948/**
949 * device_unregister - unregister device from system.
950 * @dev: device going away.
951 *
952 * We do this in two parts, like we do device_register(). First,
953 * we remove it from all the subsystems with device_del(), then
954 * we decrement the reference count via put_device(). If that
955 * is the final reference count, the device will be cleaned up
956 * via device_release() above. Otherwise, the structure will
957 * stick around until the final reference to the device is dropped.
958 */
959void device_unregister(struct device * dev)
960{
961 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
962 device_del(dev);
963 put_device(dev);
964}
965
966
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800967static struct device * next_device(struct klist_iter * i)
968{
969 struct klist_node * n = klist_next(i);
970 return n ? container_of(n, struct device, knode_parent) : NULL;
971}
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/**
974 * device_for_each_child - device child iterator.
Randy Dunlapc41455f2005-10-23 11:59:14 -0700975 * @parent: parent struct device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 * @data: data for the callback.
977 * @fn: function to be called for each device.
978 *
Randy Dunlapc41455f2005-10-23 11:59:14 -0700979 * Iterate over @parent's child devices, and call @fn for each,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 * passing it @data.
981 *
982 * We check the return of @fn each time. If it returns anything
983 * other than 0, we break out and return that value.
984 */
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800985int device_for_each_child(struct device * parent, void * data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 int (*fn)(struct device *, void *))
987{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800988 struct klist_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 struct device * child;
990 int error = 0;
991
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800992 klist_iter_init(&parent->klist_children, &i);
993 while ((child = next_device(&i)) && !error)
994 error = fn(child, data);
995 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 return error;
997}
998
Cornelia Huck5ab69982006-11-16 15:42:07 +0100999/**
1000 * device_find_child - device iterator for locating a particular device.
1001 * @parent: parent struct device
1002 * @data: Data to pass to match function
1003 * @match: Callback function to check device
1004 *
1005 * This is similar to the device_for_each_child() function above, but it
1006 * returns a reference to a device that is 'found' for later use, as
1007 * determined by the @match callback.
1008 *
1009 * The callback should return 0 if the device doesn't match and non-zero
1010 * if it does. If the callback returns non-zero and a reference to the
1011 * current device can be obtained, this function will return to the caller
1012 * and not iterate over any more devices.
1013 */
1014struct device * device_find_child(struct device *parent, void *data,
1015 int (*match)(struct device *, void *))
1016{
1017 struct klist_iter i;
1018 struct device *child;
1019
1020 if (!parent)
1021 return NULL;
1022
1023 klist_iter_init(&parent->klist_children, &i);
1024 while ((child = next_device(&i)))
1025 if (match(child, data) && get_device(child))
1026 break;
1027 klist_iter_exit(&i);
1028 return child;
1029}
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031int __init devices_init(void)
1032{
1033 return subsystem_register(&devices_subsys);
1034}
1035
1036EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001037EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
1039EXPORT_SYMBOL_GPL(device_initialize);
1040EXPORT_SYMBOL_GPL(device_add);
1041EXPORT_SYMBOL_GPL(device_register);
1042
1043EXPORT_SYMBOL_GPL(device_del);
1044EXPORT_SYMBOL_GPL(device_unregister);
1045EXPORT_SYMBOL_GPL(get_device);
1046EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048EXPORT_SYMBOL_GPL(device_create_file);
1049EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001050
1051
1052static void device_create_release(struct device *dev)
1053{
1054 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1055 kfree(dev);
1056}
1057
1058/**
1059 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001060 * @class: pointer to the struct class that this device should be registered to
1061 * @parent: pointer to the parent struct device of this new device, if any
1062 * @devt: the dev_t for the char device to be added
1063 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001064 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001065 * This function can be used by char device classes. A struct device
1066 * will be created in sysfs, registered to the specified class.
1067 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001068 * A "dev" file will be created, showing the dev_t for the device, if
1069 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001070 * If a pointer to a parent struct device is passed in, the newly created
1071 * struct device will be a child of that device in sysfs.
1072 * The pointer to the struct device will be returned from the call.
1073 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001074 * pointer.
1075 *
1076 * Note: the struct class passed to this function must have previously
1077 * been created with a call to class_create().
1078 */
1079struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001080 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001081{
1082 va_list args;
1083 struct device *dev = NULL;
1084 int retval = -ENODEV;
1085
1086 if (class == NULL || IS_ERR(class))
1087 goto error;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001088
1089 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1090 if (!dev) {
1091 retval = -ENOMEM;
1092 goto error;
1093 }
1094
1095 dev->devt = devt;
1096 dev->class = class;
1097 dev->parent = parent;
1098 dev->release = device_create_release;
1099
1100 va_start(args, fmt);
1101 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1102 va_end(args);
1103 retval = device_register(dev);
1104 if (retval)
1105 goto error;
1106
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001107 return dev;
1108
1109error:
1110 kfree(dev);
1111 return ERR_PTR(retval);
1112}
1113EXPORT_SYMBOL_GPL(device_create);
1114
1115/**
1116 * device_destroy - removes a device that was created with device_create()
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001117 * @class: pointer to the struct class that this device was registered with
1118 * @devt: the dev_t of the device that was previously registered
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001119 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001120 * This call unregisters and cleans up a device that was created with a
1121 * call to device_create().
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001122 */
1123void device_destroy(struct class *class, dev_t devt)
1124{
1125 struct device *dev = NULL;
1126 struct device *dev_tmp;
1127
1128 down(&class->sem);
1129 list_for_each_entry(dev_tmp, &class->devices, node) {
1130 if (dev_tmp->devt == devt) {
1131 dev = dev_tmp;
1132 break;
1133 }
1134 }
1135 up(&class->sem);
1136
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001137 if (dev)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001138 device_unregister(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001139}
1140EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001141
1142/**
1143 * device_rename - renames a device
1144 * @dev: the pointer to the struct device to be renamed
1145 * @new_name: the new name of the device
1146 */
1147int device_rename(struct device *dev, char *new_name)
1148{
1149 char *old_class_name = NULL;
1150 char *new_class_name = NULL;
1151 char *old_symlink_name = NULL;
1152 int error;
1153
1154 dev = get_device(dev);
1155 if (!dev)
1156 return -EINVAL;
1157
1158 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1159
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001160#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001161 if ((dev->class) && (dev->parent))
1162 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001163#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001164
1165 if (dev->class) {
1166 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
Jesper Juhl952ab432006-09-28 23:56:01 +02001167 if (!old_symlink_name) {
1168 error = -ENOMEM;
1169 goto out_free_old_class;
1170 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001171 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1172 }
1173
1174 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1175
1176 error = kobject_rename(&dev->kobj, new_name);
1177
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001178#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001179 if (old_class_name) {
1180 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1181 if (new_class_name) {
1182 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1183 new_class_name);
1184 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1185 }
1186 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001187#endif
1188
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001189 if (dev->class) {
1190 sysfs_remove_link(&dev->class->subsys.kset.kobj,
1191 old_symlink_name);
1192 sysfs_create_link(&dev->class->subsys.kset.kobj, &dev->kobj,
1193 dev->bus_id);
1194 }
1195 put_device(dev);
1196
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001197 kfree(new_class_name);
1198 kfree(old_symlink_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001199 out_free_old_class:
1200 kfree(old_class_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001201
1202 return error;
1203}
Johannes Berga2807db2007-02-28 12:38:31 +01001204EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001205
1206static int device_move_class_links(struct device *dev,
1207 struct device *old_parent,
1208 struct device *new_parent)
1209{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001210 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001211#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001212 char *class_name;
1213
1214 class_name = make_class_name(dev->class->name, &dev->kobj);
1215 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001216 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001217 goto out;
1218 }
1219 if (old_parent) {
1220 sysfs_remove_link(&dev->kobj, "device");
1221 sysfs_remove_link(&old_parent->kobj, class_name);
1222 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001223 if (new_parent) {
1224 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1225 "device");
1226 if (error)
1227 goto out;
1228 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1229 class_name);
1230 if (error)
1231 sysfs_remove_link(&dev->kobj, "device");
1232 }
1233 else
1234 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001235out:
1236 kfree(class_name);
1237 return error;
1238#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001239 if (old_parent)
1240 sysfs_remove_link(&dev->kobj, "device");
1241 if (new_parent)
1242 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1243 "device");
1244 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001245#endif
1246}
1247
1248/**
1249 * device_move - moves a device to a new parent
1250 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001251 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001252 */
1253int device_move(struct device *dev, struct device *new_parent)
1254{
1255 int error;
1256 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001257 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001258
1259 dev = get_device(dev);
1260 if (!dev)
1261 return -EINVAL;
1262
Cornelia Huck8a824722006-11-20 17:07:51 +01001263 new_parent = get_device(new_parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +01001264 new_parent_kobj = get_device_parent (dev, new_parent);
1265 if (IS_ERR(new_parent_kobj)) {
1266 error = PTR_ERR(new_parent_kobj);
1267 put_device(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001268 goto out;
1269 }
1270 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
Cornelia Huckc744aea2007-01-08 20:16:44 +01001271 new_parent ? new_parent->bus_id : "<NULL>");
1272 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001273 if (error) {
1274 put_device(new_parent);
1275 goto out;
1276 }
1277 old_parent = dev->parent;
1278 dev->parent = new_parent;
1279 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001280 klist_remove(&dev->knode_parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +01001281 if (new_parent)
1282 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Cornelia Huck8a824722006-11-20 17:07:51 +01001283 if (!dev->class)
1284 goto out_put;
1285 error = device_move_class_links(dev, old_parent, new_parent);
1286 if (error) {
1287 /* We ignore errors on cleanup since we're hosed anyway... */
1288 device_move_class_links(dev, new_parent, old_parent);
1289 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001290 if (new_parent)
1291 klist_remove(&dev->knode_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001292 if (old_parent)
1293 klist_add_tail(&dev->knode_parent,
1294 &old_parent->klist_children);
1295 }
1296 put_device(new_parent);
1297 goto out;
1298 }
1299out_put:
1300 put_device(old_parent);
1301out:
1302 put_device(dev);
1303 return error;
1304}
1305
1306EXPORT_SYMBOL_GPL(device_move);