blob: dd40d78a023dd1f2fde9712ac7700d5ade4893cf [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
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500313static int device_add_attributes(struct device *dev,
314 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700315{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700316 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500317 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700318
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500319 if (attrs) {
320 for (i = 0; attr_name(attrs[i]); i++) {
321 error = device_create_file(dev, &attrs[i]);
322 if (error)
323 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700324 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500325 if (error)
326 while (--i >= 0)
327 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700328 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700329 return error;
330}
331
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500332static void device_remove_attributes(struct device *dev,
333 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700334{
335 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500336
337 if (attrs)
338 for (i = 0; attr_name(attrs[i]); i++)
339 device_remove_file(dev, &attrs[i]);
340}
341
342static int device_add_groups(struct device *dev,
343 struct attribute_group **groups)
344{
345 int error = 0;
346 int i;
347
348 if (groups) {
349 for (i = 0; groups[i]; i++) {
350 error = sysfs_create_group(&dev->kobj, groups[i]);
351 if (error) {
352 while (--i >= 0)
353 sysfs_remove_group(&dev->kobj, groups[i]);
354 break;
355 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700356 }
357 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500358 return error;
359}
360
361static void device_remove_groups(struct device *dev,
362 struct attribute_group **groups)
363{
364 int i;
365
366 if (groups)
367 for (i = 0; groups[i]; i++)
368 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700369}
370
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700371static int device_add_attrs(struct device *dev)
372{
373 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200374 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500375 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700376
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500377 if (class) {
378 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200379 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500380 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700381 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200382
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500383 if (type) {
384 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200385 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500386 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200387 }
388
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500389 error = device_add_groups(dev, dev->groups);
390 if (error)
391 goto err_remove_type_groups;
392
393 return 0;
394
395 err_remove_type_groups:
396 if (type)
397 device_remove_groups(dev, type->groups);
398 err_remove_class_attrs:
399 if (class)
400 device_remove_attributes(dev, class->dev_attrs);
401
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700402 return error;
403}
404
405static void device_remove_attrs(struct device *dev)
406{
407 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200408 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700409
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500410 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200411
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500412 if (type)
413 device_remove_groups(dev, type->groups);
414
415 if (class)
416 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700417}
418
419
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700420static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
421 char *buf)
422{
423 return print_dev_t(buf, dev->devt);
424}
425
Martin Waitz0863afb2006-01-09 20:53:55 -0800426/*
427 * devices_subsys - structure to be registered with kobject core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 */
429
Kay Sievers312c0042005-11-16 09:00:00 +0100430decl_subsys(devices, &ktype_device, &device_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432
433/**
434 * device_create_file - create sysfs attribute file for device.
435 * @dev: device.
436 * @attr: device attribute descriptor.
437 */
438
439int device_create_file(struct device * dev, struct device_attribute * attr)
440{
441 int error = 0;
442 if (get_device(dev)) {
443 error = sysfs_create_file(&dev->kobj, &attr->attr);
444 put_device(dev);
445 }
446 return error;
447}
448
449/**
450 * device_remove_file - remove sysfs attribute file.
451 * @dev: device.
452 * @attr: device attribute descriptor.
453 */
454
455void device_remove_file(struct device * dev, struct device_attribute * attr)
456{
457 if (get_device(dev)) {
458 sysfs_remove_file(&dev->kobj, &attr->attr);
459 put_device(dev);
460 }
461}
462
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700463/**
464 * device_create_bin_file - create sysfs binary attribute file for device.
465 * @dev: device.
466 * @attr: device binary attribute descriptor.
467 */
468int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
469{
470 int error = -EINVAL;
471 if (dev)
472 error = sysfs_create_bin_file(&dev->kobj, attr);
473 return error;
474}
475EXPORT_SYMBOL_GPL(device_create_bin_file);
476
477/**
478 * device_remove_bin_file - remove sysfs binary attribute file
479 * @dev: device.
480 * @attr: device binary attribute descriptor.
481 */
482void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
483{
484 if (dev)
485 sysfs_remove_bin_file(&dev->kobj, attr);
486}
487EXPORT_SYMBOL_GPL(device_remove_bin_file);
488
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400489/**
Alan Stern523ded72007-04-26 00:12:04 -0700490 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400491 * @dev: device.
492 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700493 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400494 *
495 * Attribute methods must not unregister themselves or their parent device
496 * (which would amount to the same thing). Attempts to do so will deadlock,
497 * since unregistration is mutually exclusive with driver callbacks.
498 *
499 * Instead methods can call this routine, which will attempt to allocate
500 * and schedule a workqueue request to call back @func with @dev as its
501 * argument in the workqueue's process context. @dev will be pinned until
502 * @func returns.
503 *
Alan Stern523ded72007-04-26 00:12:04 -0700504 * This routine is usually called via the inline device_schedule_callback(),
505 * which automatically sets @owner to THIS_MODULE.
506 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400507 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700508 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400509 *
510 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
511 * underlying sysfs routine (since it is intended for use by attribute
512 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
513 */
Alan Stern523ded72007-04-26 00:12:04 -0700514int device_schedule_callback_owner(struct device *dev,
515 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400516{
517 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700518 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400519}
Alan Stern523ded72007-04-26 00:12:04 -0700520EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400521
James Bottomley34bb61f2005-09-06 16:56:51 -0700522static void klist_children_get(struct klist_node *n)
523{
524 struct device *dev = container_of(n, struct device, knode_parent);
525
526 get_device(dev);
527}
528
529static void klist_children_put(struct klist_node *n)
530{
531 struct device *dev = container_of(n, struct device, knode_parent);
532
533 put_device(dev);
534}
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
537/**
538 * device_initialize - init device structure.
539 * @dev: device.
540 *
541 * This prepares the device for use by other layers,
542 * including adding it to the device hierarchy.
543 * It is the first half of device_register(), if called by
544 * that, though it can also be called separately, so one
545 * may use @dev's fields (e.g. the refcount).
546 */
547
548void device_initialize(struct device *dev)
549{
550 kobj_set_kset_s(dev, devices_subsys);
551 kobject_init(&dev->kobj);
James Bottomley34bb61f2005-09-06 16:56:51 -0700552 klist_init(&dev->klist_children, klist_children_get,
553 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700555 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800556 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900557 spin_lock_init(&dev->devres_lock);
558 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700559 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800560 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
562
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100563#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100564static struct kobject * get_device_parent(struct device *dev,
565 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100566{
567 /* Set the parent to the class, not the parent device */
568 /* this keeps sysfs from having a symlink to make old udevs happy */
569 if (dev->class)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700570 return &dev->class->subsys.kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100571 else if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100572 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100573
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100574 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100575}
576#else
Kay Sievers86406242007-03-14 03:25:56 +0100577static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700578{
Kay Sievers86406242007-03-14 03:25:56 +0100579 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700580
Kay Sievers86406242007-03-14 03:25:56 +0100581 if (!virtual_dir)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700582 virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700583
Kay Sievers86406242007-03-14 03:25:56 +0100584 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700585}
586
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100587static struct kobject * get_device_parent(struct device *dev,
588 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100589{
Kay Sievers86406242007-03-14 03:25:56 +0100590 if (dev->class) {
591 struct kobject *kobj = NULL;
592 struct kobject *parent_kobj;
593 struct kobject *k;
594
595 /*
596 * If we have no parent, we live in "virtual".
597 * Class-devices with a bus-device as parent, live
598 * in a class-directory to prevent namespace collisions.
599 */
600 if (parent == NULL)
601 parent_kobj = virtual_device_parent(dev);
602 else if (parent->class)
603 return &parent->kobj;
604 else
605 parent_kobj = &parent->kobj;
606
607 /* find our class-directory at the parent and reference it */
608 spin_lock(&dev->class->class_dirs.list_lock);
609 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
610 if (k->parent == parent_kobj) {
611 kobj = kobject_get(k);
612 break;
613 }
614 spin_unlock(&dev->class->class_dirs.list_lock);
615 if (kobj)
616 return kobj;
617
618 /* or create a new class-directory at the parent device */
619 return kobject_kset_add_dir(&dev->class->class_dirs,
620 parent_kobj, dev->class->name);
621 }
622
623 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100624 return &parent->kobj;
625 return NULL;
626}
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100627#endif
Kay Sievers86406242007-03-14 03:25:56 +0100628
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100629static int setup_parent(struct device *dev, struct device *parent)
630{
631 struct kobject *kobj;
632 kobj = get_device_parent(dev, parent);
633 if (IS_ERR(kobj))
634 return PTR_ERR(kobj);
635 if (kobj)
636 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100637 return 0;
638}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640/**
641 * device_add - add device to device hierarchy.
642 * @dev: device.
643 *
644 * This is part 2 of device_register(), though may be called
645 * separately _iff_ device_initialize() has been called separately.
646 *
647 * This adds it to the kobject hierarchy via kobject_add(), adds it
648 * to the global and sibling lists for the device, then
649 * adds it to the other relevant subsystems of the driver model.
650 */
651int device_add(struct device *dev)
652{
653 struct device *parent = NULL;
Greg Kroah-Hartmane9a7d302006-06-20 13:59:20 -0700654 char *class_name = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200655 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 int error = -EINVAL;
657
658 dev = get_device(dev);
659 if (!dev || !strlen(dev->bus_id))
660 goto Error;
661
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100662 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 parent = get_device(dev->parent);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100665 error = setup_parent(dev, parent);
666 if (error)
667 goto Error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669 /* first, register with generic layer. */
670 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100671 error = kobject_add(&dev->kobj);
672 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200674
Brian Walsh37022642006-08-14 22:43:19 -0700675 /* notify platform of device entry */
676 if (platform_notify)
677 platform_notify(dev);
678
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000679 /* notify clients of device entry (new way) */
680 if (dev->bus)
681 blocking_notifier_call_chain(&dev->bus->bus_notifier,
682 BUS_NOTIFY_ADD_DEVICE, dev);
683
Kay Sieversa7fd6702005-10-01 14:49:43 +0200684 dev->uevent_attr.attr.name = "uevent";
Kay Sievers16574dc2007-04-06 01:40:38 +0200685 dev->uevent_attr.attr.mode = S_IRUGO | S_IWUSR;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200686 if (dev->driver)
687 dev->uevent_attr.attr.owner = dev->driver->owner;
688 dev->uevent_attr.store = store_uevent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200689 dev->uevent_attr.show = show_uevent;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200690 error = device_create_file(dev, &dev->uevent_attr);
691 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)) {
695 struct device_attribute *attr;
696 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
697 if (!attr) {
698 error = -ENOMEM;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200699 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700700 }
701 attr->attr.name = "dev";
702 attr->attr.mode = S_IRUGO;
703 if (dev->driver)
704 attr->attr.owner = dev->driver->owner;
705 attr->show = show_dev;
706 error = device_create_file(dev, attr);
707 if (error) {
708 kfree(attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200709 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700710 }
711
712 dev->devt_attr = attr;
713 }
714
Kay Sieversb9d9c822006-06-15 15:31:56 +0200715 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700716 sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
Kay Sieversb9d9c822006-06-15 15:31:56 +0200717 "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100718 /* If this is not a "fake" compatible device, then create the
719 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700720 if (dev->kobj.parent != &dev->class->subsys.kobj)
721 sysfs_create_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100722 &dev->kobj, dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700723 if (parent) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100724 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
725 "device");
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800726#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100727 class_name = make_class_name(dev->class->name,
728 &dev->kobj);
729 if (class_name)
730 sysfs_create_link(&dev->parent->kobj,
731 &dev->kobj, class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200732#endif
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800733 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200734 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700735
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700736 if ((error = device_add_attrs(dev)))
737 goto AttrsError;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if ((error = device_pm_add(dev)))
739 goto PMError;
740 if ((error = bus_add_device(dev)))
741 goto BusError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200742 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800743 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 if (parent)
James Bottomleyd856f1e32005-08-19 09:14:01 -0400745 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700747 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700748 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200749 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700750 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200751
752 /* notify any interfaces that the device is here */
753 list_for_each_entry(class_intf, &dev->class->interfaces, node)
754 if (class_intf->add_dev)
755 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700756 up(&dev->class->sem);
757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 Done:
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500759 kfree(class_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 put_device(dev);
761 return error;
762 BusError:
763 device_pm_remove(dev);
764 PMError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000765 if (dev->bus)
766 blocking_notifier_call_chain(&dev->bus->bus_notifier,
767 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000768 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700769 AttrsError:
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700770 if (dev->devt_attr) {
771 device_remove_file(dev, dev->devt_attr);
772 kfree(dev->devt_attr);
773 }
James Simmons82f0cf92007-02-21 17:44:51 +0000774
775 if (dev->class) {
776 sysfs_remove_link(&dev->kobj, "subsystem");
777 /* If this is not a "fake" compatible device, remove the
778 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700779 if (dev->kobj.parent != &dev->class->subsys.kobj)
780 sysfs_remove_link(&dev->class->subsys.kobj,
James Simmons82f0cf92007-02-21 17:44:51 +0000781 dev->bus_id);
James Simmons82f0cf92007-02-21 17:44:51 +0000782 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800783#ifdef CONFIG_SYSFS_DEPRECATED
James Simmons82f0cf92007-02-21 17:44:51 +0000784 char *class_name = make_class_name(dev->class->name,
785 &dev->kobj);
786 if (class_name)
787 sysfs_remove_link(&dev->parent->kobj,
788 class_name);
789 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800790#endif
James Simmons82f0cf92007-02-21 17:44:51 +0000791 sysfs_remove_link(&dev->kobj, "device");
792 }
James Simmons82f0cf92007-02-21 17:44:51 +0000793 }
Cornelia Hucka306eea2006-09-22 11:37:13 +0200794 ueventattrError:
795 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700796 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100797 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 kobject_del(&dev->kobj);
799 Error:
800 if (parent)
801 put_device(parent);
802 goto Done;
803}
804
805
806/**
807 * device_register - register a device with the system.
808 * @dev: pointer to the device structure
809 *
810 * This happens in two clean steps - initialize the device
811 * and add it to the system. The two steps can be called
812 * separately, but this is the easiest and most common.
813 * I.e. you should only call the two helpers separately if
814 * have a clearly defined need to use and refcount the device
815 * before it is added to the hierarchy.
816 */
817
818int device_register(struct device *dev)
819{
820 device_initialize(dev);
821 return device_add(dev);
822}
823
824
825/**
826 * get_device - increment reference count for device.
827 * @dev: device.
828 *
829 * This simply forwards the call to kobject_get(), though
830 * we do take care to provide for the case that we get a NULL
831 * pointer passed in.
832 */
833
834struct device * get_device(struct device * dev)
835{
836 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
837}
838
839
840/**
841 * put_device - decrement reference count.
842 * @dev: device in question.
843 */
844void put_device(struct device * dev)
845{
846 if (dev)
847 kobject_put(&dev->kobj);
848}
849
850
851/**
852 * device_del - delete device from system.
853 * @dev: device.
854 *
855 * This is the first part of the device unregistration
856 * sequence. This removes the device from the lists we control
857 * from here, has it removed from the other driver model
858 * subsystems it was added to in device_add(), and removes it
859 * from the kobject hierarchy.
860 *
861 * NOTE: this should be called manually _iff_ device_add() was
862 * also called manually.
863 */
864
865void device_del(struct device * dev)
866{
867 struct device * parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200868 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700871 klist_del(&dev->knode_parent);
Catalin Marinas82189b92006-11-25 11:09:30 -0800872 if (dev->devt_attr) {
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700873 device_remove_file(dev, dev->devt_attr);
Catalin Marinas82189b92006-11-25 11:09:30 -0800874 kfree(dev->devt_attr);
875 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200876 if (dev->class) {
877 sysfs_remove_link(&dev->kobj, "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100878 /* If this is not a "fake" compatible device, remove the
879 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700880 if (dev->kobj.parent != &dev->class->subsys.kobj)
881 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100882 dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700883 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800884#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200885 char *class_name = make_class_name(dev->class->name,
886 &dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100887 if (class_name)
888 sysfs_remove_link(&dev->parent->kobj,
889 class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200890 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800891#endif
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200892 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700893 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200894
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700895 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200896 /* notify any interfaces that the device is now gone */
897 list_for_each_entry(class_intf, &dev->class->interfaces, node)
898 if (class_intf->remove_dev)
899 class_intf->remove_dev(dev, class_intf);
900 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700901 list_del_init(&dev->node);
902 up(&dev->class->sem);
Kay Sievers86406242007-03-14 03:25:56 +0100903
904 /* If we live in a parent class-directory, unreference it */
905 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
906 struct device *d;
907 int other = 0;
908
909 /*
910 * if we are the last child of our class, delete
911 * our class-directory at this parent
912 */
913 down(&dev->class->sem);
914 list_for_each_entry(d, &dev->class->devices, node) {
915 if (d == dev)
916 continue;
917 if (d->kobj.parent == dev->kobj.parent) {
918 other = 1;
919 break;
920 }
921 }
922 if (!other)
923 kobject_del(dev->kobj.parent);
924
925 kobject_put(dev->kobj.parent);
926 up(&dev->class->sem);
927 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200928 }
Kay Sieversa7fd6702005-10-01 14:49:43 +0200929 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700930 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800931 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900933 /*
934 * Some platform devices are driven without driver attached
935 * and managed resources may have been acquired. Make sure
936 * all resources are released.
937 */
938 devres_release_all(dev);
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 /* Notify the platform of the removal, in case they
941 * need to do anything...
942 */
943 if (platform_notify_remove)
944 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000945 if (dev->bus)
946 blocking_notifier_call_chain(&dev->bus->bus_notifier,
947 BUS_NOTIFY_DEL_DEVICE, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 device_pm_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100949 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 kobject_del(&dev->kobj);
951 if (parent)
952 put_device(parent);
953}
954
955/**
956 * device_unregister - unregister device from system.
957 * @dev: device going away.
958 *
959 * We do this in two parts, like we do device_register(). First,
960 * we remove it from all the subsystems with device_del(), then
961 * we decrement the reference count via put_device(). If that
962 * is the final reference count, the device will be cleaned up
963 * via device_release() above. Otherwise, the structure will
964 * stick around until the final reference to the device is dropped.
965 */
966void device_unregister(struct device * dev)
967{
968 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
969 device_del(dev);
970 put_device(dev);
971}
972
973
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800974static struct device * next_device(struct klist_iter * i)
975{
976 struct klist_node * n = klist_next(i);
977 return n ? container_of(n, struct device, knode_parent) : NULL;
978}
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980/**
981 * device_for_each_child - device child iterator.
Randy Dunlapc41455f2005-10-23 11:59:14 -0700982 * @parent: parent struct device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 * @data: data for the callback.
984 * @fn: function to be called for each device.
985 *
Randy Dunlapc41455f2005-10-23 11:59:14 -0700986 * Iterate over @parent's child devices, and call @fn for each,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 * passing it @data.
988 *
989 * We check the return of @fn each time. If it returns anything
990 * other than 0, we break out and return that value.
991 */
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800992int device_for_each_child(struct device * parent, void * data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 int (*fn)(struct device *, void *))
994{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800995 struct klist_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 struct device * child;
997 int error = 0;
998
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800999 klist_iter_init(&parent->klist_children, &i);
1000 while ((child = next_device(&i)) && !error)
1001 error = fn(child, data);
1002 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 return error;
1004}
1005
Cornelia Huck5ab69982006-11-16 15:42:07 +01001006/**
1007 * device_find_child - device iterator for locating a particular device.
1008 * @parent: parent struct device
1009 * @data: Data to pass to match function
1010 * @match: Callback function to check device
1011 *
1012 * This is similar to the device_for_each_child() function above, but it
1013 * returns a reference to a device that is 'found' for later use, as
1014 * determined by the @match callback.
1015 *
1016 * The callback should return 0 if the device doesn't match and non-zero
1017 * if it does. If the callback returns non-zero and a reference to the
1018 * current device can be obtained, this function will return to the caller
1019 * and not iterate over any more devices.
1020 */
1021struct device * device_find_child(struct device *parent, void *data,
1022 int (*match)(struct device *, void *))
1023{
1024 struct klist_iter i;
1025 struct device *child;
1026
1027 if (!parent)
1028 return NULL;
1029
1030 klist_iter_init(&parent->klist_children, &i);
1031 while ((child = next_device(&i)))
1032 if (match(child, data) && get_device(child))
1033 break;
1034 klist_iter_exit(&i);
1035 return child;
1036}
1037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038int __init devices_init(void)
1039{
1040 return subsystem_register(&devices_subsys);
1041}
1042
1043EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001044EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
1046EXPORT_SYMBOL_GPL(device_initialize);
1047EXPORT_SYMBOL_GPL(device_add);
1048EXPORT_SYMBOL_GPL(device_register);
1049
1050EXPORT_SYMBOL_GPL(device_del);
1051EXPORT_SYMBOL_GPL(device_unregister);
1052EXPORT_SYMBOL_GPL(get_device);
1053EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
1055EXPORT_SYMBOL_GPL(device_create_file);
1056EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001057
1058
1059static void device_create_release(struct device *dev)
1060{
1061 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1062 kfree(dev);
1063}
1064
1065/**
1066 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001067 * @class: pointer to the struct class that this device should be registered to
1068 * @parent: pointer to the parent struct device of this new device, if any
1069 * @devt: the dev_t for the char device to be added
1070 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001071 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001072 * This function can be used by char device classes. A struct device
1073 * will be created in sysfs, registered to the specified class.
1074 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001075 * A "dev" file will be created, showing the dev_t for the device, if
1076 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001077 * If a pointer to a parent struct device is passed in, the newly created
1078 * struct device will be a child of that device in sysfs.
1079 * The pointer to the struct device will be returned from the call.
1080 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001081 * pointer.
1082 *
1083 * Note: the struct class passed to this function must have previously
1084 * been created with a call to class_create().
1085 */
1086struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001087 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001088{
1089 va_list args;
1090 struct device *dev = NULL;
1091 int retval = -ENODEV;
1092
1093 if (class == NULL || IS_ERR(class))
1094 goto error;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001095
1096 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1097 if (!dev) {
1098 retval = -ENOMEM;
1099 goto error;
1100 }
1101
1102 dev->devt = devt;
1103 dev->class = class;
1104 dev->parent = parent;
1105 dev->release = device_create_release;
1106
1107 va_start(args, fmt);
1108 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1109 va_end(args);
1110 retval = device_register(dev);
1111 if (retval)
1112 goto error;
1113
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001114 return dev;
1115
1116error:
1117 kfree(dev);
1118 return ERR_PTR(retval);
1119}
1120EXPORT_SYMBOL_GPL(device_create);
1121
1122/**
1123 * device_destroy - removes a device that was created with device_create()
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001124 * @class: pointer to the struct class that this device was registered with
1125 * @devt: the dev_t of the device that was previously registered
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001126 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001127 * This call unregisters and cleans up a device that was created with a
1128 * call to device_create().
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001129 */
1130void device_destroy(struct class *class, dev_t devt)
1131{
1132 struct device *dev = NULL;
1133 struct device *dev_tmp;
1134
1135 down(&class->sem);
1136 list_for_each_entry(dev_tmp, &class->devices, node) {
1137 if (dev_tmp->devt == devt) {
1138 dev = dev_tmp;
1139 break;
1140 }
1141 }
1142 up(&class->sem);
1143
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001144 if (dev)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001145 device_unregister(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001146}
1147EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001148
1149/**
1150 * device_rename - renames a device
1151 * @dev: the pointer to the struct device to be renamed
1152 * @new_name: the new name of the device
1153 */
1154int device_rename(struct device *dev, char *new_name)
1155{
1156 char *old_class_name = NULL;
1157 char *new_class_name = NULL;
1158 char *old_symlink_name = NULL;
1159 int error;
1160
1161 dev = get_device(dev);
1162 if (!dev)
1163 return -EINVAL;
1164
1165 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1166
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001167#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001168 if ((dev->class) && (dev->parent))
1169 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001170#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001171
1172 if (dev->class) {
1173 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
Jesper Juhl952ab432006-09-28 23:56:01 +02001174 if (!old_symlink_name) {
1175 error = -ENOMEM;
1176 goto out_free_old_class;
1177 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001178 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1179 }
1180
1181 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1182
1183 error = kobject_rename(&dev->kobj, new_name);
1184
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001185#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001186 if (old_class_name) {
1187 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1188 if (new_class_name) {
1189 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1190 new_class_name);
1191 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1192 }
1193 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001194#endif
1195
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001196 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001197 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001198 old_symlink_name);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001199 sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001200 dev->bus_id);
1201 }
1202 put_device(dev);
1203
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001204 kfree(new_class_name);
1205 kfree(old_symlink_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001206 out_free_old_class:
1207 kfree(old_class_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001208
1209 return error;
1210}
Johannes Berga2807db2007-02-28 12:38:31 +01001211EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001212
1213static int device_move_class_links(struct device *dev,
1214 struct device *old_parent,
1215 struct device *new_parent)
1216{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001217 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001218#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001219 char *class_name;
1220
1221 class_name = make_class_name(dev->class->name, &dev->kobj);
1222 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001223 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001224 goto out;
1225 }
1226 if (old_parent) {
1227 sysfs_remove_link(&dev->kobj, "device");
1228 sysfs_remove_link(&old_parent->kobj, class_name);
1229 }
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001230 if (new_parent) {
1231 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1232 "device");
1233 if (error)
1234 goto out;
1235 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1236 class_name);
1237 if (error)
1238 sysfs_remove_link(&dev->kobj, "device");
1239 }
1240 else
1241 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001242out:
1243 kfree(class_name);
1244 return error;
1245#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001246 if (old_parent)
1247 sysfs_remove_link(&dev->kobj, "device");
1248 if (new_parent)
1249 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1250 "device");
1251 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001252#endif
1253}
1254
1255/**
1256 * device_move - moves a device to a new parent
1257 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001258 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001259 */
1260int device_move(struct device *dev, struct device *new_parent)
1261{
1262 int error;
1263 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001264 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001265
1266 dev = get_device(dev);
1267 if (!dev)
1268 return -EINVAL;
1269
Cornelia Huck8a824722006-11-20 17:07:51 +01001270 new_parent = get_device(new_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001271 new_parent_kobj = get_device_parent (dev, new_parent);
1272 if (IS_ERR(new_parent_kobj)) {
1273 error = PTR_ERR(new_parent_kobj);
1274 put_device(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001275 goto out;
1276 }
1277 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001278 new_parent ? new_parent->bus_id : "<NULL>");
1279 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001280 if (error) {
1281 put_device(new_parent);
1282 goto out;
1283 }
1284 old_parent = dev->parent;
1285 dev->parent = new_parent;
1286 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001287 klist_remove(&dev->knode_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001288 if (new_parent)
1289 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Cornelia Huck8a824722006-11-20 17:07:51 +01001290 if (!dev->class)
1291 goto out_put;
1292 error = device_move_class_links(dev, old_parent, new_parent);
1293 if (error) {
1294 /* We ignore errors on cleanup since we're hosed anyway... */
1295 device_move_class_links(dev, new_parent, old_parent);
1296 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001297 if (new_parent)
1298 klist_remove(&dev->knode_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001299 if (old_parent)
1300 klist_add_tail(&dev->knode_parent,
1301 &old_parent->klist_children);
1302 }
1303 put_device(new_parent);
1304 goto out;
1305 }
1306out_put:
1307 put_device(old_parent);
1308out:
1309 put_device(dev);
1310 return error;
1311}
1312
1313EXPORT_SYMBOL_GPL(device_move);