blob: 91a0367d583ef681948c50abbba9535816d671cb [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
Kay Sievers60a96a52007-07-08 22:29:26 +020027extern const char *kobject_actions[];
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029int (*platform_notify)(struct device * dev) = NULL;
30int (*platform_notify_remove)(struct device * dev) = NULL;
31
32/*
33 * sysfs bindings for devices.
34 */
35
Alan Stern3e956372006-06-16 17:10:48 -040036/**
37 * dev_driver_string - Return a device's driver name, if at all possible
38 * @dev: struct device to get the name of
39 *
40 * Will return the device's driver's name if it is bound to a device. If
41 * the device is not bound to a device, it will return the name of the bus
42 * it is attached to. If it is not attached to a bus either, an empty
43 * string will be returned.
44 */
45const char *dev_driver_string(struct device *dev)
46{
47 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010048 (dev->bus ? dev->bus->name :
49 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040050}
Matthew Wilcox310a9222006-09-23 23:35:04 -060051EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define to_dev(obj) container_of(obj, struct device, kobj)
54#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static ssize_t
57dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
58{
59 struct device_attribute * dev_attr = to_dev_attr(attr);
60 struct device * dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050061 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040064 ret = dev_attr->show(dev, dev_attr, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 return ret;
66}
67
68static ssize_t
69dev_attr_store(struct kobject * kobj, struct attribute * attr,
70 const char * buf, size_t count)
71{
72 struct device_attribute * dev_attr = to_dev_attr(attr);
73 struct device * dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050074 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040077 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 return ret;
79}
80
81static struct sysfs_ops dev_sysfs_ops = {
82 .show = dev_attr_show,
83 .store = dev_attr_store,
84};
85
86
87/**
88 * device_release - free device structure.
89 * @kobj: device's kobject.
90 *
91 * This is called once the reference count for the object
92 * reaches 0. We forward the call to the device's release
93 * method, which should handle actually freeing the structure.
94 */
95static void device_release(struct kobject * kobj)
96{
97 struct device * dev = to_dev(kobj);
98
99 if (dev->release)
100 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200101 else if (dev->type && dev->type->release)
102 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700103 else if (dev->class && dev->class->dev_release)
104 dev->class->dev_release(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 else {
106 printk(KERN_ERR "Device '%s' does not have a release() function, "
107 "it is broken and must be fixed.\n",
108 dev->bus_id);
109 WARN_ON(1);
110 }
111}
112
113static struct kobj_type ktype_device = {
114 .release = device_release,
115 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
118
Kay Sievers312c0042005-11-16 09:00:00 +0100119static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
121 struct kobj_type *ktype = get_ktype(kobj);
122
123 if (ktype == &ktype_device) {
124 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200125 if (dev->uevent_suppress)
126 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 if (dev->bus)
128 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700129 if (dev->class)
130 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 }
132 return 0;
133}
134
Kay Sievers312c0042005-11-16 09:00:00 +0100135static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136{
137 struct device *dev = to_dev(kobj);
138
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700139 if (dev->bus)
140 return dev->bus->name;
141 if (dev->class)
142 return dev->class->name;
143 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144}
145
Kay Sievers312c0042005-11-16 09:00:00 +0100146static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int num_envp, char *buffer, int buffer_size)
148{
149 struct device *dev = to_dev(kobj);
150 int i = 0;
151 int length = 0;
152 int retval = 0;
153
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700154 /* add the major/minor if present */
155 if (MAJOR(dev->devt)) {
156 add_uevent_var(envp, num_envp, &i,
157 buffer, buffer_size, &length,
158 "MAJOR=%u", MAJOR(dev->devt));
159 add_uevent_var(envp, num_envp, &i,
160 buffer, buffer_size, &length,
161 "MINOR=%u", MINOR(dev->devt));
162 }
163
Kay Sievers414264f2007-03-12 21:08:57 +0100164 if (dev->type && dev->type->name)
165 add_uevent_var(envp, num_envp, &i,
166 buffer, buffer_size, &length,
167 "DEVTYPE=%s", dev->type->name);
168
Kay Sievers239378f2006-10-07 21:54:55 +0200169 if (dev->driver)
Kay Sieversd81d9d62006-08-13 06:17:09 +0200170 add_uevent_var(envp, num_envp, &i,
171 buffer, buffer_size, &length,
172 "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200173
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200174#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200175 if (dev->class) {
176 struct device *parent = dev->parent;
177
178 /* find first bus device in parent chain */
179 while (parent && !parent->bus)
180 parent = parent->parent;
181 if (parent && parent->bus) {
182 const char *path;
183
184 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200185 if (path) {
186 add_uevent_var(envp, num_envp, &i,
187 buffer, buffer_size, &length,
188 "PHYSDEVPATH=%s", path);
189 kfree(path);
190 }
Kay Sievers239378f2006-10-07 21:54:55 +0200191
192 add_uevent_var(envp, num_envp, &i,
193 buffer, buffer_size, &length,
194 "PHYSDEVBUS=%s", parent->bus->name);
195
196 if (parent->driver)
197 add_uevent_var(envp, num_envp, &i,
198 buffer, buffer_size, &length,
199 "PHYSDEVDRIVER=%s", parent->driver->name);
200 }
201 } else if (dev->bus) {
Kay Sievers312c0042005-11-16 09:00:00 +0100202 add_uevent_var(envp, num_envp, &i,
203 buffer, buffer_size, &length,
Kay Sievers239378f2006-10-07 21:54:55 +0200204 "PHYSDEVBUS=%s", dev->bus->name);
205
206 if (dev->driver)
207 add_uevent_var(envp, num_envp, &i,
208 buffer, buffer_size, &length,
209 "PHYSDEVDRIVER=%s", dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200210 }
Kay Sievers239378f2006-10-07 21:54:55 +0200211#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213 /* terminate, set to next free slot, shrink available space */
214 envp[i] = NULL;
215 envp = &envp[i];
216 num_envp -= i;
217 buffer = &buffer[length];
218 buffer_size -= length;
219
Kay Sievers312c0042005-11-16 09:00:00 +0100220 if (dev->bus && dev->bus->uevent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100222 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200223 if (retval)
224 pr_debug ("%s: bus uevent() returned %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 __FUNCTION__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 }
227
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700228 if (dev->class && dev->class->dev_uevent) {
229 /* have the class specific function add its stuff */
230 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200231 if (retval)
232 pr_debug("%s: class uevent() returned %d\n",
233 __FUNCTION__, retval);
234 }
235
236 if (dev->type && dev->type->uevent) {
237 /* have the device type specific fuction add its stuff */
238 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
239 if (retval)
240 pr_debug("%s: dev_type uevent() returned %d\n",
241 __FUNCTION__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700242 }
243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 return retval;
245}
246
Kay Sievers312c0042005-11-16 09:00:00 +0100247static struct kset_uevent_ops device_uevent_ops = {
248 .filter = dev_uevent_filter,
249 .name = dev_uevent_name,
250 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252
Kay Sievers16574dc2007-04-06 01:40:38 +0200253static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
254 char *buf)
255{
256 struct kobject *top_kobj;
257 struct kset *kset;
258 char *envp[32];
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200259 char *data = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200260 char *pos;
261 int i;
262 size_t count = 0;
263 int retval;
264
265 /* search the kset, the device belongs to */
266 top_kobj = &dev->kobj;
267 if (!top_kobj->kset && top_kobj->parent) {
268 do {
269 top_kobj = top_kobj->parent;
270 } while (!top_kobj->kset && top_kobj->parent);
271 }
272 if (!top_kobj->kset)
273 goto out;
274 kset = top_kobj->kset;
275 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
276 goto out;
277
278 /* respect filter */
279 if (kset->uevent_ops && kset->uevent_ops->filter)
280 if (!kset->uevent_ops->filter(kset, &dev->kobj))
281 goto out;
282
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200283 data = (char *)get_zeroed_page(GFP_KERNEL);
284 if (!data)
285 return -ENOMEM;
286
Kay Sievers16574dc2007-04-06 01:40:38 +0200287 /* let the kset specific function add its keys */
288 pos = data;
289 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
290 envp, ARRAY_SIZE(envp),
291 pos, PAGE_SIZE);
292 if (retval)
293 goto out;
294
295 /* copy keys to file */
296 for (i = 0; envp[i]; i++) {
297 pos = &buf[count];
298 count += sprintf(pos, "%s\n", envp[i]);
299 }
300out:
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200301 free_page((unsigned long)data);
Kay Sievers16574dc2007-04-06 01:40:38 +0200302 return count;
303}
304
Kay Sieversa7fd6702005-10-01 14:49:43 +0200305static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
306 const char *buf, size_t count)
307{
Kay Sievers60a96a52007-07-08 22:29:26 +0200308 size_t len = count;
309 enum kobject_action action;
310
311 if (len && buf[len-1] == '\n')
312 len--;
313
314 for (action = 0; action < KOBJ_MAX; action++) {
315 if (strncmp(kobject_actions[action], buf, len) != 0)
316 continue;
317 if (kobject_actions[action][len] != '\0')
318 continue;
319 kobject_uevent(&dev->kobj, action);
320 goto out;
321 }
322
323 dev_err(dev, "uevent: unsupported action-string; this will "
324 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100325 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200326out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200327 return count;
328}
329
Tejun Heoad6a1e12007-06-14 03:45:17 +0900330static struct device_attribute uevent_attr =
331 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
332
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500333static int device_add_attributes(struct device *dev,
334 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700335{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700336 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500337 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700338
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500339 if (attrs) {
340 for (i = 0; attr_name(attrs[i]); i++) {
341 error = device_create_file(dev, &attrs[i]);
342 if (error)
343 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700344 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500345 if (error)
346 while (--i >= 0)
347 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700348 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700349 return error;
350}
351
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500352static void device_remove_attributes(struct device *dev,
353 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700354{
355 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500356
357 if (attrs)
358 for (i = 0; attr_name(attrs[i]); i++)
359 device_remove_file(dev, &attrs[i]);
360}
361
362static int device_add_groups(struct device *dev,
363 struct attribute_group **groups)
364{
365 int error = 0;
366 int i;
367
368 if (groups) {
369 for (i = 0; groups[i]; i++) {
370 error = sysfs_create_group(&dev->kobj, groups[i]);
371 if (error) {
372 while (--i >= 0)
373 sysfs_remove_group(&dev->kobj, groups[i]);
374 break;
375 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700376 }
377 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500378 return error;
379}
380
381static void device_remove_groups(struct device *dev,
382 struct attribute_group **groups)
383{
384 int i;
385
386 if (groups)
387 for (i = 0; groups[i]; i++)
388 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700389}
390
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700391static int device_add_attrs(struct device *dev)
392{
393 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200394 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500395 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700396
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500397 if (class) {
398 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200399 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500400 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700401 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200402
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500403 if (type) {
404 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200405 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500406 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200407 }
408
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500409 error = device_add_groups(dev, dev->groups);
410 if (error)
411 goto err_remove_type_groups;
412
413 return 0;
414
415 err_remove_type_groups:
416 if (type)
417 device_remove_groups(dev, type->groups);
418 err_remove_class_attrs:
419 if (class)
420 device_remove_attributes(dev, class->dev_attrs);
421
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700422 return error;
423}
424
425static void device_remove_attrs(struct device *dev)
426{
427 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200428 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700429
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500430 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200431
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500432 if (type)
433 device_remove_groups(dev, type->groups);
434
435 if (class)
436 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700437}
438
439
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700440static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
441 char *buf)
442{
443 return print_dev_t(buf, dev->devt);
444}
445
Tejun Heoad6a1e12007-06-14 03:45:17 +0900446static struct device_attribute devt_attr =
447 __ATTR(dev, S_IRUGO, show_dev, NULL);
448
Martin Waitz0863afb2006-01-09 20:53:55 -0800449/*
450 * devices_subsys - structure to be registered with kobject core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 */
452
Kay Sievers312c0042005-11-16 09:00:00 +0100453decl_subsys(devices, &ktype_device, &device_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455
456/**
457 * device_create_file - create sysfs attribute file for device.
458 * @dev: device.
459 * @attr: device attribute descriptor.
460 */
461
462int device_create_file(struct device * dev, struct device_attribute * attr)
463{
464 int error = 0;
465 if (get_device(dev)) {
466 error = sysfs_create_file(&dev->kobj, &attr->attr);
467 put_device(dev);
468 }
469 return error;
470}
471
472/**
473 * device_remove_file - remove sysfs attribute file.
474 * @dev: device.
475 * @attr: device attribute descriptor.
476 */
477
478void device_remove_file(struct device * dev, struct device_attribute * attr)
479{
480 if (get_device(dev)) {
481 sysfs_remove_file(&dev->kobj, &attr->attr);
482 put_device(dev);
483 }
484}
485
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700486/**
487 * device_create_bin_file - create sysfs binary attribute file for device.
488 * @dev: device.
489 * @attr: device binary attribute descriptor.
490 */
491int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
492{
493 int error = -EINVAL;
494 if (dev)
495 error = sysfs_create_bin_file(&dev->kobj, attr);
496 return error;
497}
498EXPORT_SYMBOL_GPL(device_create_bin_file);
499
500/**
501 * device_remove_bin_file - remove sysfs binary attribute file
502 * @dev: device.
503 * @attr: device binary attribute descriptor.
504 */
505void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
506{
507 if (dev)
508 sysfs_remove_bin_file(&dev->kobj, attr);
509}
510EXPORT_SYMBOL_GPL(device_remove_bin_file);
511
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400512/**
Alan Stern523ded72007-04-26 00:12:04 -0700513 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400514 * @dev: device.
515 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700516 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400517 *
518 * Attribute methods must not unregister themselves or their parent device
519 * (which would amount to the same thing). Attempts to do so will deadlock,
520 * since unregistration is mutually exclusive with driver callbacks.
521 *
522 * Instead methods can call this routine, which will attempt to allocate
523 * and schedule a workqueue request to call back @func with @dev as its
524 * argument in the workqueue's process context. @dev will be pinned until
525 * @func returns.
526 *
Alan Stern523ded72007-04-26 00:12:04 -0700527 * This routine is usually called via the inline device_schedule_callback(),
528 * which automatically sets @owner to THIS_MODULE.
529 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400530 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700531 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400532 *
533 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
534 * underlying sysfs routine (since it is intended for use by attribute
535 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
536 */
Alan Stern523ded72007-04-26 00:12:04 -0700537int device_schedule_callback_owner(struct device *dev,
538 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400539{
540 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700541 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400542}
Alan Stern523ded72007-04-26 00:12:04 -0700543EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400544
James Bottomley34bb61f2005-09-06 16:56:51 -0700545static void klist_children_get(struct klist_node *n)
546{
547 struct device *dev = container_of(n, struct device, knode_parent);
548
549 get_device(dev);
550}
551
552static void klist_children_put(struct klist_node *n)
553{
554 struct device *dev = container_of(n, struct device, knode_parent);
555
556 put_device(dev);
557}
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560/**
561 * device_initialize - init device structure.
562 * @dev: device.
563 *
564 * This prepares the device for use by other layers,
565 * including adding it to the device hierarchy.
566 * It is the first half of device_register(), if called by
567 * that, though it can also be called separately, so one
568 * may use @dev's fields (e.g. the refcount).
569 */
570
571void device_initialize(struct device *dev)
572{
573 kobj_set_kset_s(dev, devices_subsys);
574 kobject_init(&dev->kobj);
James Bottomley34bb61f2005-09-06 16:56:51 -0700575 klist_init(&dev->klist_children, klist_children_get,
576 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700578 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800579 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900580 spin_lock_init(&dev->devres_lock);
581 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700582 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800583 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
585
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100586#ifdef CONFIG_SYSFS_DEPRECATED
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{
590 /* Set the parent to the class, not the parent device */
591 /* this keeps sysfs from having a symlink to make old udevs happy */
592 if (dev->class)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700593 return &dev->class->subsys.kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100594 else if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100595 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100596
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100597 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100598}
599#else
Kay Sievers86406242007-03-14 03:25:56 +0100600static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700601{
Kay Sievers86406242007-03-14 03:25:56 +0100602 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700603
Kay Sievers86406242007-03-14 03:25:56 +0100604 if (!virtual_dir)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700605 virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700606
Kay Sievers86406242007-03-14 03:25:56 +0100607 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700608}
609
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100610static struct kobject * get_device_parent(struct device *dev,
611 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100612{
Kay Sievers86406242007-03-14 03:25:56 +0100613 if (dev->class) {
614 struct kobject *kobj = NULL;
615 struct kobject *parent_kobj;
616 struct kobject *k;
617
618 /*
619 * If we have no parent, we live in "virtual".
620 * Class-devices with a bus-device as parent, live
621 * in a class-directory to prevent namespace collisions.
622 */
623 if (parent == NULL)
624 parent_kobj = virtual_device_parent(dev);
625 else if (parent->class)
626 return &parent->kobj;
627 else
628 parent_kobj = &parent->kobj;
629
630 /* find our class-directory at the parent and reference it */
631 spin_lock(&dev->class->class_dirs.list_lock);
632 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
633 if (k->parent == parent_kobj) {
634 kobj = kobject_get(k);
635 break;
636 }
637 spin_unlock(&dev->class->class_dirs.list_lock);
638 if (kobj)
639 return kobj;
640
641 /* or create a new class-directory at the parent device */
642 return kobject_kset_add_dir(&dev->class->class_dirs,
643 parent_kobj, dev->class->name);
644 }
645
646 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100647 return &parent->kobj;
648 return NULL;
649}
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100650#endif
Kay Sievers86406242007-03-14 03:25:56 +0100651
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100652static int setup_parent(struct device *dev, struct device *parent)
653{
654 struct kobject *kobj;
655 kobj = get_device_parent(dev, parent);
656 if (IS_ERR(kobj))
657 return PTR_ERR(kobj);
658 if (kobj)
659 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100660 return 0;
661}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663/**
664 * device_add - add device to device hierarchy.
665 * @dev: device.
666 *
667 * This is part 2 of device_register(), though may be called
668 * separately _iff_ device_initialize() has been called separately.
669 *
670 * This adds it to the kobject hierarchy via kobject_add(), adds it
671 * to the global and sibling lists for the device, then
672 * adds it to the other relevant subsystems of the driver model.
673 */
674int device_add(struct device *dev)
675{
676 struct device *parent = NULL;
Greg Kroah-Hartmane9a7d302006-06-20 13:59:20 -0700677 char *class_name = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200678 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 int error = -EINVAL;
680
681 dev = get_device(dev);
682 if (!dev || !strlen(dev->bus_id))
683 goto Error;
684
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100685 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 parent = get_device(dev->parent);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100688 error = setup_parent(dev, parent);
689 if (error)
690 goto Error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
692 /* first, register with generic layer. */
693 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100694 error = kobject_add(&dev->kobj);
695 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200697
Brian Walsh37022642006-08-14 22:43:19 -0700698 /* notify platform of device entry */
699 if (platform_notify)
700 platform_notify(dev);
701
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000702 /* notify clients of device entry (new way) */
703 if (dev->bus)
704 blocking_notifier_call_chain(&dev->bus->bus_notifier,
705 BUS_NOTIFY_ADD_DEVICE, dev);
706
Tejun Heoad6a1e12007-06-14 03:45:17 +0900707 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200708 if (error)
709 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200710
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700711 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900712 error = device_create_file(dev, &devt_attr);
713 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200714 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700715 }
716
Kay Sieversb9d9c822006-06-15 15:31:56 +0200717 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700718 sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
Kay Sieversb9d9c822006-06-15 15:31:56 +0200719 "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100720 /* If this is not a "fake" compatible device, then create the
721 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700722 if (dev->kobj.parent != &dev->class->subsys.kobj)
723 sysfs_create_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100724 &dev->kobj, dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700725 if (parent) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100726 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
727 "device");
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800728#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100729 class_name = make_class_name(dev->class->name,
730 &dev->kobj);
731 if (class_name)
732 sysfs_create_link(&dev->parent->kobj,
733 &dev->kobj, class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200734#endif
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800735 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200736 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700737
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700738 error = device_add_attrs(dev);
739 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700740 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700741 error = device_pm_add(dev);
742 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 goto PMError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700744 error = bus_add_device(dev);
745 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 goto BusError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200747 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800748 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 if (parent)
James Bottomleyd856f1e32005-08-19 09:14:01 -0400750 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700752 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700753 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200754 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700755 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200756
757 /* notify any interfaces that the device is here */
758 list_for_each_entry(class_intf, &dev->class->interfaces, node)
759 if (class_intf->add_dev)
760 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700761 up(&dev->class->sem);
762 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 Done:
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500764 kfree(class_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 put_device(dev);
766 return error;
767 BusError:
768 device_pm_remove(dev);
769 PMError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000770 if (dev->bus)
771 blocking_notifier_call_chain(&dev->bus->bus_notifier,
772 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000773 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700774 AttrsError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900775 if (MAJOR(dev->devt))
776 device_remove_file(dev, &devt_attr);
James Simmons82f0cf92007-02-21 17:44:51 +0000777
778 if (dev->class) {
779 sysfs_remove_link(&dev->kobj, "subsystem");
780 /* If this is not a "fake" compatible device, remove the
781 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700782 if (dev->kobj.parent != &dev->class->subsys.kobj)
783 sysfs_remove_link(&dev->class->subsys.kobj,
James Simmons82f0cf92007-02-21 17:44:51 +0000784 dev->bus_id);
James Simmons82f0cf92007-02-21 17:44:51 +0000785 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800786#ifdef CONFIG_SYSFS_DEPRECATED
James Simmons82f0cf92007-02-21 17:44:51 +0000787 char *class_name = make_class_name(dev->class->name,
788 &dev->kobj);
789 if (class_name)
790 sysfs_remove_link(&dev->parent->kobj,
791 class_name);
792 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800793#endif
James Simmons82f0cf92007-02-21 17:44:51 +0000794 sysfs_remove_link(&dev->kobj, "device");
795 }
James Simmons82f0cf92007-02-21 17:44:51 +0000796 }
Cornelia Hucka306eea2006-09-22 11:37:13 +0200797 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900798 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700799 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100800 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 kobject_del(&dev->kobj);
802 Error:
803 if (parent)
804 put_device(parent);
805 goto Done;
806}
807
808
809/**
810 * device_register - register a device with the system.
811 * @dev: pointer to the device structure
812 *
813 * This happens in two clean steps - initialize the device
814 * and add it to the system. The two steps can be called
815 * separately, but this is the easiest and most common.
816 * I.e. you should only call the two helpers separately if
817 * have a clearly defined need to use and refcount the device
818 * before it is added to the hierarchy.
819 */
820
821int device_register(struct device *dev)
822{
823 device_initialize(dev);
824 return device_add(dev);
825}
826
827
828/**
829 * get_device - increment reference count for device.
830 * @dev: device.
831 *
832 * This simply forwards the call to kobject_get(), though
833 * we do take care to provide for the case that we get a NULL
834 * pointer passed in.
835 */
836
837struct device * get_device(struct device * dev)
838{
839 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
840}
841
842
843/**
844 * put_device - decrement reference count.
845 * @dev: device in question.
846 */
847void put_device(struct device * dev)
848{
849 if (dev)
850 kobject_put(&dev->kobj);
851}
852
853
854/**
855 * device_del - delete device from system.
856 * @dev: device.
857 *
858 * This is the first part of the device unregistration
859 * sequence. This removes the device from the lists we control
860 * from here, has it removed from the other driver model
861 * subsystems it was added to in device_add(), and removes it
862 * from the kobject hierarchy.
863 *
864 * NOTE: this should be called manually _iff_ device_add() was
865 * also called manually.
866 */
867
868void device_del(struct device * dev)
869{
870 struct device * parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200871 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700874 klist_del(&dev->knode_parent);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900875 if (MAJOR(dev->devt))
876 device_remove_file(dev, &devt_attr);
Kay Sieversb9d9c822006-06-15 15:31:56 +0200877 if (dev->class) {
878 sysfs_remove_link(&dev->kobj, "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100879 /* If this is not a "fake" compatible device, remove the
880 * symlink from the class to the device. */
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700881 if (dev->kobj.parent != &dev->class->subsys.kobj)
882 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100883 dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700884 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800885#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200886 char *class_name = make_class_name(dev->class->name,
887 &dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100888 if (class_name)
889 sysfs_remove_link(&dev->parent->kobj,
890 class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200891 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800892#endif
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200893 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700894 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200895
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700896 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200897 /* notify any interfaces that the device is now gone */
898 list_for_each_entry(class_intf, &dev->class->interfaces, node)
899 if (class_intf->remove_dev)
900 class_intf->remove_dev(dev, class_intf);
901 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700902 list_del_init(&dev->node);
903 up(&dev->class->sem);
Kay Sievers86406242007-03-14 03:25:56 +0100904
905 /* If we live in a parent class-directory, unreference it */
906 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
907 struct device *d;
908 int other = 0;
909
910 /*
911 * if we are the last child of our class, delete
912 * our class-directory at this parent
913 */
914 down(&dev->class->sem);
915 list_for_each_entry(d, &dev->class->devices, node) {
916 if (d == dev)
917 continue;
918 if (d->kobj.parent == dev->kobj.parent) {
919 other = 1;
920 break;
921 }
922 }
923 if (!other)
924 kobject_del(dev->kobj.parent);
925
926 kobject_put(dev->kobj.parent);
927 up(&dev->class->sem);
928 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200929 }
Tejun Heoad6a1e12007-06-14 03:45:17 +0900930 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700931 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800932 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900934 /*
935 * Some platform devices are driven without driver attached
936 * and managed resources may have been acquired. Make sure
937 * all resources are released.
938 */
939 devres_release_all(dev);
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 /* Notify the platform of the removal, in case they
942 * need to do anything...
943 */
944 if (platform_notify_remove)
945 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000946 if (dev->bus)
947 blocking_notifier_call_chain(&dev->bus->bus_notifier,
948 BUS_NOTIFY_DEL_DEVICE, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 device_pm_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100950 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 kobject_del(&dev->kobj);
952 if (parent)
953 put_device(parent);
954}
955
956/**
957 * device_unregister - unregister device from system.
958 * @dev: device going away.
959 *
960 * We do this in two parts, like we do device_register(). First,
961 * we remove it from all the subsystems with device_del(), then
962 * we decrement the reference count via put_device(). If that
963 * is the final reference count, the device will be cleaned up
964 * via device_release() above. Otherwise, the structure will
965 * stick around until the final reference to the device is dropped.
966 */
967void device_unregister(struct device * dev)
968{
969 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
970 device_del(dev);
971 put_device(dev);
972}
973
974
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800975static struct device * next_device(struct klist_iter * i)
976{
977 struct klist_node * n = klist_next(i);
978 return n ? container_of(n, struct device, knode_parent) : NULL;
979}
980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981/**
982 * device_for_each_child - device child iterator.
Randy Dunlapc41455f2005-10-23 11:59:14 -0700983 * @parent: parent struct device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 * @data: data for the callback.
985 * @fn: function to be called for each device.
986 *
Randy Dunlapc41455f2005-10-23 11:59:14 -0700987 * Iterate over @parent's child devices, and call @fn for each,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 * passing it @data.
989 *
990 * We check the return of @fn each time. If it returns anything
991 * other than 0, we break out and return that value.
992 */
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800993int device_for_each_child(struct device * parent, void * data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 int (*fn)(struct device *, void *))
995{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800996 struct klist_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 struct device * child;
998 int error = 0;
999
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001000 klist_iter_init(&parent->klist_children, &i);
1001 while ((child = next_device(&i)) && !error)
1002 error = fn(child, data);
1003 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 return error;
1005}
1006
Cornelia Huck5ab69982006-11-16 15:42:07 +01001007/**
1008 * device_find_child - device iterator for locating a particular device.
1009 * @parent: parent struct device
1010 * @data: Data to pass to match function
1011 * @match: Callback function to check device
1012 *
1013 * This is similar to the device_for_each_child() function above, but it
1014 * returns a reference to a device that is 'found' for later use, as
1015 * determined by the @match callback.
1016 *
1017 * The callback should return 0 if the device doesn't match and non-zero
1018 * if it does. If the callback returns non-zero and a reference to the
1019 * current device can be obtained, this function will return to the caller
1020 * and not iterate over any more devices.
1021 */
1022struct device * device_find_child(struct device *parent, void *data,
1023 int (*match)(struct device *, void *))
1024{
1025 struct klist_iter i;
1026 struct device *child;
1027
1028 if (!parent)
1029 return NULL;
1030
1031 klist_iter_init(&parent->klist_children, &i);
1032 while ((child = next_device(&i)))
1033 if (match(child, data) && get_device(child))
1034 break;
1035 klist_iter_exit(&i);
1036 return child;
1037}
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039int __init devices_init(void)
1040{
1041 return subsystem_register(&devices_subsys);
1042}
1043
1044EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001045EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
1047EXPORT_SYMBOL_GPL(device_initialize);
1048EXPORT_SYMBOL_GPL(device_add);
1049EXPORT_SYMBOL_GPL(device_register);
1050
1051EXPORT_SYMBOL_GPL(device_del);
1052EXPORT_SYMBOL_GPL(device_unregister);
1053EXPORT_SYMBOL_GPL(get_device);
1054EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
1056EXPORT_SYMBOL_GPL(device_create_file);
1057EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001058
1059
1060static void device_create_release(struct device *dev)
1061{
1062 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1063 kfree(dev);
1064}
1065
1066/**
1067 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001068 * @class: pointer to the struct class that this device should be registered to
1069 * @parent: pointer to the parent struct device of this new device, if any
1070 * @devt: the dev_t for the char device to be added
1071 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001072 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001073 * This function can be used by char device classes. A struct device
1074 * will be created in sysfs, registered to the specified class.
1075 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001076 * A "dev" file will be created, showing the dev_t for the device, if
1077 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001078 * If a pointer to a parent struct device is passed in, the newly created
1079 * struct device will be a child of that device in sysfs.
1080 * The pointer to the struct device will be returned from the call.
1081 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001082 * pointer.
1083 *
1084 * Note: the struct class passed to this function must have previously
1085 * been created with a call to class_create().
1086 */
1087struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001088 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001089{
1090 va_list args;
1091 struct device *dev = NULL;
1092 int retval = -ENODEV;
1093
1094 if (class == NULL || IS_ERR(class))
1095 goto error;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001096
1097 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1098 if (!dev) {
1099 retval = -ENOMEM;
1100 goto error;
1101 }
1102
1103 dev->devt = devt;
1104 dev->class = class;
1105 dev->parent = parent;
1106 dev->release = device_create_release;
1107
1108 va_start(args, fmt);
1109 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1110 va_end(args);
1111 retval = device_register(dev);
1112 if (retval)
1113 goto error;
1114
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001115 return dev;
1116
1117error:
1118 kfree(dev);
1119 return ERR_PTR(retval);
1120}
1121EXPORT_SYMBOL_GPL(device_create);
1122
1123/**
1124 * device_destroy - removes a device that was created with device_create()
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001125 * @class: pointer to the struct class that this device was registered with
1126 * @devt: the dev_t of the device that was previously registered
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001127 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001128 * This call unregisters and cleans up a device that was created with a
1129 * call to device_create().
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001130 */
1131void device_destroy(struct class *class, dev_t devt)
1132{
1133 struct device *dev = NULL;
1134 struct device *dev_tmp;
1135
1136 down(&class->sem);
1137 list_for_each_entry(dev_tmp, &class->devices, node) {
1138 if (dev_tmp->devt == devt) {
1139 dev = dev_tmp;
1140 break;
1141 }
1142 }
1143 up(&class->sem);
1144
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001145 if (dev)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001146 device_unregister(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001147}
1148EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001149
1150/**
1151 * device_rename - renames a device
1152 * @dev: the pointer to the struct device to be renamed
1153 * @new_name: the new name of the device
1154 */
1155int device_rename(struct device *dev, char *new_name)
1156{
1157 char *old_class_name = NULL;
1158 char *new_class_name = NULL;
1159 char *old_symlink_name = NULL;
1160 int error;
1161
1162 dev = get_device(dev);
1163 if (!dev)
1164 return -EINVAL;
1165
1166 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1167
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001168#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001169 if ((dev->class) && (dev->parent))
1170 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001171#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001172
1173 if (dev->class) {
1174 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
Jesper Juhl952ab432006-09-28 23:56:01 +02001175 if (!old_symlink_name) {
1176 error = -ENOMEM;
1177 goto out_free_old_class;
1178 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001179 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1180 }
1181
1182 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1183
1184 error = kobject_rename(&dev->kobj, new_name);
1185
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001186#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001187 if (old_class_name) {
1188 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1189 if (new_class_name) {
1190 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1191 new_class_name);
1192 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1193 }
1194 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001195#endif
1196
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001197 if (dev->class) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001198 sysfs_remove_link(&dev->class->subsys.kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001199 old_symlink_name);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001200 sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001201 dev->bus_id);
1202 }
1203 put_device(dev);
1204
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001205 kfree(new_class_name);
1206 kfree(old_symlink_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001207 out_free_old_class:
1208 kfree(old_class_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001209
1210 return error;
1211}
Johannes Berga2807db2007-02-28 12:38:31 +01001212EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001213
1214static int device_move_class_links(struct device *dev,
1215 struct device *old_parent,
1216 struct device *new_parent)
1217{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001218 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001219#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001220 char *class_name;
1221
1222 class_name = make_class_name(dev->class->name, &dev->kobj);
1223 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001224 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001225 goto out;
1226 }
1227 if (old_parent) {
1228 sysfs_remove_link(&dev->kobj, "device");
1229 sysfs_remove_link(&old_parent->kobj, class_name);
1230 }
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001231 if (new_parent) {
1232 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1233 "device");
1234 if (error)
1235 goto out;
1236 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1237 class_name);
1238 if (error)
1239 sysfs_remove_link(&dev->kobj, "device");
1240 }
1241 else
1242 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001243out:
1244 kfree(class_name);
1245 return error;
1246#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001247 if (old_parent)
1248 sysfs_remove_link(&dev->kobj, "device");
1249 if (new_parent)
1250 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1251 "device");
1252 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001253#endif
1254}
1255
1256/**
1257 * device_move - moves a device to a new parent
1258 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001259 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001260 */
1261int device_move(struct device *dev, struct device *new_parent)
1262{
1263 int error;
1264 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001265 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001266
1267 dev = get_device(dev);
1268 if (!dev)
1269 return -EINVAL;
1270
Cornelia Huck8a824722006-11-20 17:07:51 +01001271 new_parent = get_device(new_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001272 new_parent_kobj = get_device_parent (dev, new_parent);
1273 if (IS_ERR(new_parent_kobj)) {
1274 error = PTR_ERR(new_parent_kobj);
1275 put_device(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001276 goto out;
1277 }
1278 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001279 new_parent ? new_parent->bus_id : "<NULL>");
1280 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001281 if (error) {
1282 put_device(new_parent);
1283 goto out;
1284 }
1285 old_parent = dev->parent;
1286 dev->parent = new_parent;
1287 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001288 klist_remove(&dev->knode_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001289 if (new_parent)
1290 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Cornelia Huck8a824722006-11-20 17:07:51 +01001291 if (!dev->class)
1292 goto out_put;
1293 error = device_move_class_links(dev, old_parent, new_parent);
1294 if (error) {
1295 /* We ignore errors on cleanup since we're hosed anyway... */
1296 device_move_class_links(dev, new_parent, old_parent);
1297 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001298 if (new_parent)
1299 klist_remove(&dev->knode_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001300 if (old_parent)
1301 klist_add_tail(&dev->knode_parent,
1302 &old_parent->klist_children);
1303 }
1304 put_device(new_parent);
1305 goto out;
1306 }
1307out_put:
1308 put_device(old_parent);
1309out:
1310 put_device(dev);
1311 return error;
1312}
1313
1314EXPORT_SYMBOL_GPL(device_move);