blob: bffb69e4bde2d68f192bd5d2168317d37ca8ea14 [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);
123 if (dev->bus)
124 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700125 if (dev->class)
126 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 }
128 return 0;
129}
130
Kay Sievers312c0042005-11-16 09:00:00 +0100131static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
133 struct device *dev = to_dev(kobj);
134
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700135 if (dev->bus)
136 return dev->bus->name;
137 if (dev->class)
138 return dev->class->name;
139 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
Kay Sievers312c0042005-11-16 09:00:00 +0100142static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 int num_envp, char *buffer, int buffer_size)
144{
145 struct device *dev = to_dev(kobj);
146 int i = 0;
147 int length = 0;
148 int retval = 0;
149
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700150 /* add the major/minor if present */
151 if (MAJOR(dev->devt)) {
152 add_uevent_var(envp, num_envp, &i,
153 buffer, buffer_size, &length,
154 "MAJOR=%u", MAJOR(dev->devt));
155 add_uevent_var(envp, num_envp, &i,
156 buffer, buffer_size, &length,
157 "MINOR=%u", MINOR(dev->devt));
158 }
159
Kay Sievers414264f2007-03-12 21:08:57 +0100160 if (dev->type && dev->type->name)
161 add_uevent_var(envp, num_envp, &i,
162 buffer, buffer_size, &length,
163 "DEVTYPE=%s", dev->type->name);
164
Kay Sievers239378f2006-10-07 21:54:55 +0200165 if (dev->driver)
Kay Sieversd81d9d62006-08-13 06:17:09 +0200166 add_uevent_var(envp, num_envp, &i,
167 buffer, buffer_size, &length,
168 "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200169
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200170#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200171 if (dev->class) {
172 struct device *parent = dev->parent;
173
174 /* find first bus device in parent chain */
175 while (parent && !parent->bus)
176 parent = parent->parent;
177 if (parent && parent->bus) {
178 const char *path;
179
180 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
181 add_uevent_var(envp, num_envp, &i,
182 buffer, buffer_size, &length,
183 "PHYSDEVPATH=%s", path);
184 kfree(path);
185
186 add_uevent_var(envp, num_envp, &i,
187 buffer, buffer_size, &length,
188 "PHYSDEVBUS=%s", parent->bus->name);
189
190 if (parent->driver)
191 add_uevent_var(envp, num_envp, &i,
192 buffer, buffer_size, &length,
193 "PHYSDEVDRIVER=%s", parent->driver->name);
194 }
195 } else if (dev->bus) {
Kay Sievers312c0042005-11-16 09:00:00 +0100196 add_uevent_var(envp, num_envp, &i,
197 buffer, buffer_size, &length,
Kay Sievers239378f2006-10-07 21:54:55 +0200198 "PHYSDEVBUS=%s", dev->bus->name);
199
200 if (dev->driver)
201 add_uevent_var(envp, num_envp, &i,
202 buffer, buffer_size, &length,
203 "PHYSDEVDRIVER=%s", dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200204 }
Kay Sievers239378f2006-10-07 21:54:55 +0200205#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207 /* terminate, set to next free slot, shrink available space */
208 envp[i] = NULL;
209 envp = &envp[i];
210 num_envp -= i;
211 buffer = &buffer[length];
212 buffer_size -= length;
213
Kay Sievers312c0042005-11-16 09:00:00 +0100214 if (dev->bus && dev->bus->uevent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100216 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200217 if (retval)
218 pr_debug ("%s: bus uevent() returned %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 __FUNCTION__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 }
221
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700222 if (dev->class && dev->class->dev_uevent) {
223 /* have the class specific function add its stuff */
224 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200225 if (retval)
226 pr_debug("%s: class uevent() returned %d\n",
227 __FUNCTION__, retval);
228 }
229
230 if (dev->type && dev->type->uevent) {
231 /* have the device type specific fuction add its stuff */
232 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
233 if (retval)
234 pr_debug("%s: dev_type uevent() returned %d\n",
235 __FUNCTION__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700236 }
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 return retval;
239}
240
Kay Sievers312c0042005-11-16 09:00:00 +0100241static struct kset_uevent_ops device_uevent_ops = {
242 .filter = dev_uevent_filter,
243 .name = dev_uevent_name,
244 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245};
246
Kay Sieversa7fd6702005-10-01 14:49:43 +0200247static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
248 const char *buf, size_t count)
249{
Kay Sievers312c0042005-11-16 09:00:00 +0100250 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200251 return count;
252}
253
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500254static int device_add_attributes(struct device *dev,
255 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700256{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700257 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500258 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700259
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500260 if (attrs) {
261 for (i = 0; attr_name(attrs[i]); i++) {
262 error = device_create_file(dev, &attrs[i]);
263 if (error)
264 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700265 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500266 if (error)
267 while (--i >= 0)
268 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700269 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700270 return error;
271}
272
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500273static void device_remove_attributes(struct device *dev,
274 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700275{
276 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500277
278 if (attrs)
279 for (i = 0; attr_name(attrs[i]); i++)
280 device_remove_file(dev, &attrs[i]);
281}
282
283static int device_add_groups(struct device *dev,
284 struct attribute_group **groups)
285{
286 int error = 0;
287 int i;
288
289 if (groups) {
290 for (i = 0; groups[i]; i++) {
291 error = sysfs_create_group(&dev->kobj, groups[i]);
292 if (error) {
293 while (--i >= 0)
294 sysfs_remove_group(&dev->kobj, groups[i]);
295 break;
296 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700297 }
298 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500299 return error;
300}
301
302static void device_remove_groups(struct device *dev,
303 struct attribute_group **groups)
304{
305 int i;
306
307 if (groups)
308 for (i = 0; groups[i]; i++)
309 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700310}
311
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700312static int device_add_attrs(struct device *dev)
313{
314 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200315 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500316 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700317
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500318 if (class) {
319 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200320 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500321 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700322 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200323
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500324 if (type) {
325 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200326 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500327 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200328 }
329
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500330 error = device_add_groups(dev, dev->groups);
331 if (error)
332 goto err_remove_type_groups;
333
334 return 0;
335
336 err_remove_type_groups:
337 if (type)
338 device_remove_groups(dev, type->groups);
339 err_remove_class_attrs:
340 if (class)
341 device_remove_attributes(dev, class->dev_attrs);
342
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700343 return error;
344}
345
346static void device_remove_attrs(struct device *dev)
347{
348 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200349 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700350
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500351 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200352
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500353 if (type)
354 device_remove_groups(dev, type->groups);
355
356 if (class)
357 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700358}
359
360
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700361static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
362 char *buf)
363{
364 return print_dev_t(buf, dev->devt);
365}
366
Martin Waitz0863afb2006-01-09 20:53:55 -0800367/*
368 * devices_subsys - structure to be registered with kobject core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 */
370
Kay Sievers312c0042005-11-16 09:00:00 +0100371decl_subsys(devices, &ktype_device, &device_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373
374/**
375 * device_create_file - create sysfs attribute file for device.
376 * @dev: device.
377 * @attr: device attribute descriptor.
378 */
379
380int device_create_file(struct device * dev, struct device_attribute * attr)
381{
382 int error = 0;
383 if (get_device(dev)) {
384 error = sysfs_create_file(&dev->kobj, &attr->attr);
385 put_device(dev);
386 }
387 return error;
388}
389
390/**
391 * device_remove_file - remove sysfs attribute file.
392 * @dev: device.
393 * @attr: device attribute descriptor.
394 */
395
396void device_remove_file(struct device * dev, struct device_attribute * attr)
397{
398 if (get_device(dev)) {
399 sysfs_remove_file(&dev->kobj, &attr->attr);
400 put_device(dev);
401 }
402}
403
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700404/**
405 * device_create_bin_file - create sysfs binary attribute file for device.
406 * @dev: device.
407 * @attr: device binary attribute descriptor.
408 */
409int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
410{
411 int error = -EINVAL;
412 if (dev)
413 error = sysfs_create_bin_file(&dev->kobj, attr);
414 return error;
415}
416EXPORT_SYMBOL_GPL(device_create_bin_file);
417
418/**
419 * device_remove_bin_file - remove sysfs binary attribute file
420 * @dev: device.
421 * @attr: device binary attribute descriptor.
422 */
423void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
424{
425 if (dev)
426 sysfs_remove_bin_file(&dev->kobj, attr);
427}
428EXPORT_SYMBOL_GPL(device_remove_bin_file);
429
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400430/**
431 * device_schedule_callback - helper to schedule a callback for a device
432 * @dev: device.
433 * @func: callback function to invoke later.
434 *
435 * Attribute methods must not unregister themselves or their parent device
436 * (which would amount to the same thing). Attempts to do so will deadlock,
437 * since unregistration is mutually exclusive with driver callbacks.
438 *
439 * Instead methods can call this routine, which will attempt to allocate
440 * and schedule a workqueue request to call back @func with @dev as its
441 * argument in the workqueue's process context. @dev will be pinned until
442 * @func returns.
443 *
444 * Returns 0 if the request was submitted, -ENOMEM if storage could not
445 * be allocated.
446 *
447 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
448 * underlying sysfs routine (since it is intended for use by attribute
449 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
450 */
451int device_schedule_callback(struct device *dev,
452 void (*func)(struct device *))
453{
454 return sysfs_schedule_callback(&dev->kobj,
455 (void (*)(void *)) func, dev);
456}
457EXPORT_SYMBOL_GPL(device_schedule_callback);
458
James Bottomley34bb61f2005-09-06 16:56:51 -0700459static void klist_children_get(struct klist_node *n)
460{
461 struct device *dev = container_of(n, struct device, knode_parent);
462
463 get_device(dev);
464}
465
466static void klist_children_put(struct klist_node *n)
467{
468 struct device *dev = container_of(n, struct device, knode_parent);
469
470 put_device(dev);
471}
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474/**
475 * device_initialize - init device structure.
476 * @dev: device.
477 *
478 * This prepares the device for use by other layers,
479 * including adding it to the device hierarchy.
480 * It is the first half of device_register(), if called by
481 * that, though it can also be called separately, so one
482 * may use @dev's fields (e.g. the refcount).
483 */
484
485void device_initialize(struct device *dev)
486{
487 kobj_set_kset_s(dev, devices_subsys);
488 kobject_init(&dev->kobj);
James Bottomley34bb61f2005-09-06 16:56:51 -0700489 klist_init(&dev->klist_children, klist_children_get,
490 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700492 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800493 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900494 spin_lock_init(&dev->devres_lock);
495 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700496 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800497 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498}
499
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100500#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100501static struct kobject * get_device_parent(struct device *dev,
502 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100503{
504 /* Set the parent to the class, not the parent device */
505 /* this keeps sysfs from having a symlink to make old udevs happy */
506 if (dev->class)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100507 return &dev->class->subsys.kset.kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100508 else if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100509 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100510
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100511 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100512}
513#else
Kay Sievers86406242007-03-14 03:25:56 +0100514static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700515{
Kay Sievers86406242007-03-14 03:25:56 +0100516 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700517
Kay Sievers86406242007-03-14 03:25:56 +0100518 if (!virtual_dir)
519 virtual_dir = kobject_add_dir(&devices_subsys.kset.kobj, "virtual");
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700520
Kay Sievers86406242007-03-14 03:25:56 +0100521 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700522}
523
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100524static struct kobject * get_device_parent(struct device *dev,
525 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100526{
Kay Sievers86406242007-03-14 03:25:56 +0100527 if (dev->class) {
528 struct kobject *kobj = NULL;
529 struct kobject *parent_kobj;
530 struct kobject *k;
531
532 /*
533 * If we have no parent, we live in "virtual".
534 * Class-devices with a bus-device as parent, live
535 * in a class-directory to prevent namespace collisions.
536 */
537 if (parent == NULL)
538 parent_kobj = virtual_device_parent(dev);
539 else if (parent->class)
540 return &parent->kobj;
541 else
542 parent_kobj = &parent->kobj;
543
544 /* find our class-directory at the parent and reference it */
545 spin_lock(&dev->class->class_dirs.list_lock);
546 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
547 if (k->parent == parent_kobj) {
548 kobj = kobject_get(k);
549 break;
550 }
551 spin_unlock(&dev->class->class_dirs.list_lock);
552 if (kobj)
553 return kobj;
554
555 /* or create a new class-directory at the parent device */
556 return kobject_kset_add_dir(&dev->class->class_dirs,
557 parent_kobj, dev->class->name);
558 }
559
560 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100561 return &parent->kobj;
562 return NULL;
563}
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100564#endif
Kay Sievers86406242007-03-14 03:25:56 +0100565
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100566static int setup_parent(struct device *dev, struct device *parent)
567{
568 struct kobject *kobj;
569 kobj = get_device_parent(dev, parent);
570 if (IS_ERR(kobj))
571 return PTR_ERR(kobj);
572 if (kobj)
573 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100574 return 0;
575}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/**
578 * device_add - add device to device hierarchy.
579 * @dev: device.
580 *
581 * This is part 2 of device_register(), though may be called
582 * separately _iff_ device_initialize() has been called separately.
583 *
584 * This adds it to the kobject hierarchy via kobject_add(), adds it
585 * to the global and sibling lists for the device, then
586 * adds it to the other relevant subsystems of the driver model.
587 */
588int device_add(struct device *dev)
589{
590 struct device *parent = NULL;
Greg Kroah-Hartmane9a7d302006-06-20 13:59:20 -0700591 char *class_name = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200592 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 int error = -EINVAL;
594
595 dev = get_device(dev);
596 if (!dev || !strlen(dev->bus_id))
597 goto Error;
598
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100599 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 parent = get_device(dev->parent);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100602 error = setup_parent(dev, parent);
603 if (error)
604 goto Error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
606 /* first, register with generic layer. */
607 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100608 error = kobject_add(&dev->kobj);
609 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200611
Brian Walsh37022642006-08-14 22:43:19 -0700612 /* notify platform of device entry */
613 if (platform_notify)
614 platform_notify(dev);
615
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000616 /* notify clients of device entry (new way) */
617 if (dev->bus)
618 blocking_notifier_call_chain(&dev->bus->bus_notifier,
619 BUS_NOTIFY_ADD_DEVICE, dev);
620
Kay Sieversa7fd6702005-10-01 14:49:43 +0200621 dev->uevent_attr.attr.name = "uevent";
622 dev->uevent_attr.attr.mode = S_IWUSR;
623 if (dev->driver)
624 dev->uevent_attr.attr.owner = dev->driver->owner;
625 dev->uevent_attr.store = store_uevent;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200626 error = device_create_file(dev, &dev->uevent_attr);
627 if (error)
628 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200629
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700630 if (MAJOR(dev->devt)) {
631 struct device_attribute *attr;
632 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
633 if (!attr) {
634 error = -ENOMEM;
Cornelia Hucka306eea2006-09-22 11:37:13 +0200635 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700636 }
637 attr->attr.name = "dev";
638 attr->attr.mode = S_IRUGO;
639 if (dev->driver)
640 attr->attr.owner = dev->driver->owner;
641 attr->show = show_dev;
642 error = device_create_file(dev, attr);
643 if (error) {
644 kfree(attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200645 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700646 }
647
648 dev->devt_attr = attr;
649 }
650
Kay Sieversb9d9c822006-06-15 15:31:56 +0200651 if (dev->class) {
652 sysfs_create_link(&dev->kobj, &dev->class->subsys.kset.kobj,
653 "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100654 /* If this is not a "fake" compatible device, then create the
655 * symlink from the class to the device. */
656 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
657 sysfs_create_link(&dev->class->subsys.kset.kobj,
658 &dev->kobj, dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700659 if (parent) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100660 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
661 "device");
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800662#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100663 class_name = make_class_name(dev->class->name,
664 &dev->kobj);
665 if (class_name)
666 sysfs_create_link(&dev->parent->kobj,
667 &dev->kobj, class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200668#endif
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800669 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200670 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700671
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700672 if ((error = device_add_attrs(dev)))
673 goto AttrsError;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 if ((error = device_pm_add(dev)))
675 goto PMError;
676 if ((error = bus_add_device(dev)))
677 goto BusError;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200678 if (!dev->uevent_suppress)
679 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Sternf70fa622006-10-05 17:03:24 -0400680 if ((error = bus_attach_device(dev)))
681 goto AttachError;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 if (parent)
James Bottomleyd856f1e32005-08-19 09:14:01 -0400683 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700685 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700686 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200687 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700688 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200689
690 /* notify any interfaces that the device is here */
691 list_for_each_entry(class_intf, &dev->class->interfaces, node)
692 if (class_intf->add_dev)
693 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700694 up(&dev->class->sem);
695 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 Done:
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500697 kfree(class_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 put_device(dev);
699 return error;
Alan Sternf70fa622006-10-05 17:03:24 -0400700 AttachError:
701 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 BusError:
703 device_pm_remove(dev);
704 PMError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000705 if (dev->bus)
706 blocking_notifier_call_chain(&dev->bus->bus_notifier,
707 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000708 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700709 AttrsError:
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700710 if (dev->devt_attr) {
711 device_remove_file(dev, dev->devt_attr);
712 kfree(dev->devt_attr);
713 }
James Simmons82f0cf92007-02-21 17:44:51 +0000714
715 if (dev->class) {
716 sysfs_remove_link(&dev->kobj, "subsystem");
717 /* If this is not a "fake" compatible device, remove the
718 * symlink from the class to the device. */
719 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
720 sysfs_remove_link(&dev->class->subsys.kset.kobj,
721 dev->bus_id);
James Simmons82f0cf92007-02-21 17:44:51 +0000722 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800723#ifdef CONFIG_SYSFS_DEPRECATED
James Simmons82f0cf92007-02-21 17:44:51 +0000724 char *class_name = make_class_name(dev->class->name,
725 &dev->kobj);
726 if (class_name)
727 sysfs_remove_link(&dev->parent->kobj,
728 class_name);
729 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800730#endif
James Simmons82f0cf92007-02-21 17:44:51 +0000731 sysfs_remove_link(&dev->kobj, "device");
732 }
James Simmons82f0cf92007-02-21 17:44:51 +0000733 }
Cornelia Hucka306eea2006-09-22 11:37:13 +0200734 ueventattrError:
735 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700736 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100737 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 kobject_del(&dev->kobj);
739 Error:
740 if (parent)
741 put_device(parent);
742 goto Done;
743}
744
745
746/**
747 * device_register - register a device with the system.
748 * @dev: pointer to the device structure
749 *
750 * This happens in two clean steps - initialize the device
751 * and add it to the system. The two steps can be called
752 * separately, but this is the easiest and most common.
753 * I.e. you should only call the two helpers separately if
754 * have a clearly defined need to use and refcount the device
755 * before it is added to the hierarchy.
756 */
757
758int device_register(struct device *dev)
759{
760 device_initialize(dev);
761 return device_add(dev);
762}
763
764
765/**
766 * get_device - increment reference count for device.
767 * @dev: device.
768 *
769 * This simply forwards the call to kobject_get(), though
770 * we do take care to provide for the case that we get a NULL
771 * pointer passed in.
772 */
773
774struct device * get_device(struct device * dev)
775{
776 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
777}
778
779
780/**
781 * put_device - decrement reference count.
782 * @dev: device in question.
783 */
784void put_device(struct device * dev)
785{
786 if (dev)
787 kobject_put(&dev->kobj);
788}
789
790
791/**
792 * device_del - delete device from system.
793 * @dev: device.
794 *
795 * This is the first part of the device unregistration
796 * sequence. This removes the device from the lists we control
797 * from here, has it removed from the other driver model
798 * subsystems it was added to in device_add(), and removes it
799 * from the kobject hierarchy.
800 *
801 * NOTE: this should be called manually _iff_ device_add() was
802 * also called manually.
803 */
804
805void device_del(struct device * dev)
806{
807 struct device * parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200808 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700811 klist_del(&dev->knode_parent);
Catalin Marinas82189b92006-11-25 11:09:30 -0800812 if (dev->devt_attr) {
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700813 device_remove_file(dev, dev->devt_attr);
Catalin Marinas82189b92006-11-25 11:09:30 -0800814 kfree(dev->devt_attr);
815 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200816 if (dev->class) {
817 sysfs_remove_link(&dev->kobj, "subsystem");
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100818 /* If this is not a "fake" compatible device, remove the
819 * symlink from the class to the device. */
820 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
821 sysfs_remove_link(&dev->class->subsys.kset.kobj,
822 dev->bus_id);
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700823 if (parent) {
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800824#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200825 char *class_name = make_class_name(dev->class->name,
826 &dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100827 if (class_name)
828 sysfs_remove_link(&dev->parent->kobj,
829 class_name);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200830 kfree(class_name);
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -0800831#endif
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200832 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -0700833 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200834
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700835 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200836 /* notify any interfaces that the device is now gone */
837 list_for_each_entry(class_intf, &dev->class->interfaces, node)
838 if (class_intf->remove_dev)
839 class_intf->remove_dev(dev, class_intf);
840 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700841 list_del_init(&dev->node);
842 up(&dev->class->sem);
Kay Sievers86406242007-03-14 03:25:56 +0100843
844 /* If we live in a parent class-directory, unreference it */
845 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
846 struct device *d;
847 int other = 0;
848
849 /*
850 * if we are the last child of our class, delete
851 * our class-directory at this parent
852 */
853 down(&dev->class->sem);
854 list_for_each_entry(d, &dev->class->devices, node) {
855 if (d == dev)
856 continue;
857 if (d->kobj.parent == dev->kobj.parent) {
858 other = 1;
859 break;
860 }
861 }
862 if (!other)
863 kobject_del(dev->kobj.parent);
864
865 kobject_put(dev->kobj.parent);
866 up(&dev->class->sem);
867 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200868 }
Kay Sieversa7fd6702005-10-01 14:49:43 +0200869 device_remove_file(dev, &dev->uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700870 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800871 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900873 /*
874 * Some platform devices are driven without driver attached
875 * and managed resources may have been acquired. Make sure
876 * all resources are released.
877 */
878 devres_release_all(dev);
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 /* Notify the platform of the removal, in case they
881 * need to do anything...
882 */
883 if (platform_notify_remove)
884 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000885 if (dev->bus)
886 blocking_notifier_call_chain(&dev->bus->bus_notifier,
887 BUS_NOTIFY_DEL_DEVICE, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 device_pm_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100889 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 kobject_del(&dev->kobj);
891 if (parent)
892 put_device(parent);
893}
894
895/**
896 * device_unregister - unregister device from system.
897 * @dev: device going away.
898 *
899 * We do this in two parts, like we do device_register(). First,
900 * we remove it from all the subsystems with device_del(), then
901 * we decrement the reference count via put_device(). If that
902 * is the final reference count, the device will be cleaned up
903 * via device_release() above. Otherwise, the structure will
904 * stick around until the final reference to the device is dropped.
905 */
906void device_unregister(struct device * dev)
907{
908 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
909 device_del(dev);
910 put_device(dev);
911}
912
913
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800914static struct device * next_device(struct klist_iter * i)
915{
916 struct klist_node * n = klist_next(i);
917 return n ? container_of(n, struct device, knode_parent) : NULL;
918}
919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920/**
921 * device_for_each_child - device child iterator.
Randy Dunlapc41455f2005-10-23 11:59:14 -0700922 * @parent: parent struct device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 * @data: data for the callback.
924 * @fn: function to be called for each device.
925 *
Randy Dunlapc41455f2005-10-23 11:59:14 -0700926 * Iterate over @parent's child devices, and call @fn for each,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 * passing it @data.
928 *
929 * We check the return of @fn each time. If it returns anything
930 * other than 0, we break out and return that value.
931 */
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800932int device_for_each_child(struct device * parent, void * data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 int (*fn)(struct device *, void *))
934{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800935 struct klist_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 struct device * child;
937 int error = 0;
938
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800939 klist_iter_init(&parent->klist_children, &i);
940 while ((child = next_device(&i)) && !error)
941 error = fn(child, data);
942 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 return error;
944}
945
Cornelia Huck5ab69982006-11-16 15:42:07 +0100946/**
947 * device_find_child - device iterator for locating a particular device.
948 * @parent: parent struct device
949 * @data: Data to pass to match function
950 * @match: Callback function to check device
951 *
952 * This is similar to the device_for_each_child() function above, but it
953 * returns a reference to a device that is 'found' for later use, as
954 * determined by the @match callback.
955 *
956 * The callback should return 0 if the device doesn't match and non-zero
957 * if it does. If the callback returns non-zero and a reference to the
958 * current device can be obtained, this function will return to the caller
959 * and not iterate over any more devices.
960 */
961struct device * device_find_child(struct device *parent, void *data,
962 int (*match)(struct device *, void *))
963{
964 struct klist_iter i;
965 struct device *child;
966
967 if (!parent)
968 return NULL;
969
970 klist_iter_init(&parent->klist_children, &i);
971 while ((child = next_device(&i)))
972 if (match(child, data) && get_device(child))
973 break;
974 klist_iter_exit(&i);
975 return child;
976}
977
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978int __init devices_init(void)
979{
980 return subsystem_register(&devices_subsys);
981}
982
983EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +0100984EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
986EXPORT_SYMBOL_GPL(device_initialize);
987EXPORT_SYMBOL_GPL(device_add);
988EXPORT_SYMBOL_GPL(device_register);
989
990EXPORT_SYMBOL_GPL(device_del);
991EXPORT_SYMBOL_GPL(device_unregister);
992EXPORT_SYMBOL_GPL(get_device);
993EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
995EXPORT_SYMBOL_GPL(device_create_file);
996EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700997
998
999static void device_create_release(struct device *dev)
1000{
1001 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1002 kfree(dev);
1003}
1004
1005/**
1006 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001007 * @class: pointer to the struct class that this device should be registered to
1008 * @parent: pointer to the parent struct device of this new device, if any
1009 * @devt: the dev_t for the char device to be added
1010 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001011 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001012 * This function can be used by char device classes. A struct device
1013 * will be created in sysfs, registered to the specified class.
1014 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001015 * A "dev" file will be created, showing the dev_t for the device, if
1016 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001017 * If a pointer to a parent struct device is passed in, the newly created
1018 * struct device will be a child of that device in sysfs.
1019 * The pointer to the struct device will be returned from the call.
1020 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001021 * pointer.
1022 *
1023 * Note: the struct class passed to this function must have previously
1024 * been created with a call to class_create().
1025 */
1026struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001027 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001028{
1029 va_list args;
1030 struct device *dev = NULL;
1031 int retval = -ENODEV;
1032
1033 if (class == NULL || IS_ERR(class))
1034 goto error;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001035
1036 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1037 if (!dev) {
1038 retval = -ENOMEM;
1039 goto error;
1040 }
1041
1042 dev->devt = devt;
1043 dev->class = class;
1044 dev->parent = parent;
1045 dev->release = device_create_release;
1046
1047 va_start(args, fmt);
1048 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1049 va_end(args);
1050 retval = device_register(dev);
1051 if (retval)
1052 goto error;
1053
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001054 return dev;
1055
1056error:
1057 kfree(dev);
1058 return ERR_PTR(retval);
1059}
1060EXPORT_SYMBOL_GPL(device_create);
1061
1062/**
1063 * device_destroy - removes a device that was created with device_create()
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001064 * @class: pointer to the struct class that this device was registered with
1065 * @devt: the dev_t of the device that was previously registered
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001066 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001067 * This call unregisters and cleans up a device that was created with a
1068 * call to device_create().
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001069 */
1070void device_destroy(struct class *class, dev_t devt)
1071{
1072 struct device *dev = NULL;
1073 struct device *dev_tmp;
1074
1075 down(&class->sem);
1076 list_for_each_entry(dev_tmp, &class->devices, node) {
1077 if (dev_tmp->devt == devt) {
1078 dev = dev_tmp;
1079 break;
1080 }
1081 }
1082 up(&class->sem);
1083
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001084 if (dev)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001085 device_unregister(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001086}
1087EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001088
1089/**
1090 * device_rename - renames a device
1091 * @dev: the pointer to the struct device to be renamed
1092 * @new_name: the new name of the device
1093 */
1094int device_rename(struct device *dev, char *new_name)
1095{
1096 char *old_class_name = NULL;
1097 char *new_class_name = NULL;
1098 char *old_symlink_name = NULL;
1099 int error;
1100
1101 dev = get_device(dev);
1102 if (!dev)
1103 return -EINVAL;
1104
1105 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1106
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001107#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001108 if ((dev->class) && (dev->parent))
1109 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001110#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001111
1112 if (dev->class) {
1113 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
Jesper Juhl952ab432006-09-28 23:56:01 +02001114 if (!old_symlink_name) {
1115 error = -ENOMEM;
1116 goto out_free_old_class;
1117 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001118 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1119 }
1120
1121 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1122
1123 error = kobject_rename(&dev->kobj, new_name);
1124
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001125#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001126 if (old_class_name) {
1127 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1128 if (new_class_name) {
1129 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1130 new_class_name);
1131 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1132 }
1133 }
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001134#endif
1135
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001136 if (dev->class) {
1137 sysfs_remove_link(&dev->class->subsys.kset.kobj,
1138 old_symlink_name);
1139 sysfs_create_link(&dev->class->subsys.kset.kobj, &dev->kobj,
1140 dev->bus_id);
1141 }
1142 put_device(dev);
1143
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001144 kfree(new_class_name);
1145 kfree(old_symlink_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001146 out_free_old_class:
1147 kfree(old_class_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001148
1149 return error;
1150}
Johannes Berga2807db2007-02-28 12:38:31 +01001151EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001152
1153static int device_move_class_links(struct device *dev,
1154 struct device *old_parent,
1155 struct device *new_parent)
1156{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001157 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001158#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001159 char *class_name;
1160
1161 class_name = make_class_name(dev->class->name, &dev->kobj);
1162 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001163 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001164 goto out;
1165 }
1166 if (old_parent) {
1167 sysfs_remove_link(&dev->kobj, "device");
1168 sysfs_remove_link(&old_parent->kobj, class_name);
1169 }
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001170 if (new_parent) {
1171 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1172 "device");
1173 if (error)
1174 goto out;
1175 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1176 class_name);
1177 if (error)
1178 sysfs_remove_link(&dev->kobj, "device");
1179 }
1180 else
1181 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001182out:
1183 kfree(class_name);
1184 return error;
1185#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001186 if (old_parent)
1187 sysfs_remove_link(&dev->kobj, "device");
1188 if (new_parent)
1189 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1190 "device");
1191 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001192#endif
1193}
1194
1195/**
1196 * device_move - moves a device to a new parent
1197 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001198 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001199 */
1200int device_move(struct device *dev, struct device *new_parent)
1201{
1202 int error;
1203 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001204 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001205
1206 dev = get_device(dev);
1207 if (!dev)
1208 return -EINVAL;
1209
Cornelia Huck8a824722006-11-20 17:07:51 +01001210 new_parent = get_device(new_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001211 new_parent_kobj = get_device_parent (dev, new_parent);
1212 if (IS_ERR(new_parent_kobj)) {
1213 error = PTR_ERR(new_parent_kobj);
1214 put_device(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001215 goto out;
1216 }
1217 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001218 new_parent ? new_parent->bus_id : "<NULL>");
1219 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001220 if (error) {
1221 put_device(new_parent);
1222 goto out;
1223 }
1224 old_parent = dev->parent;
1225 dev->parent = new_parent;
1226 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001227 klist_remove(&dev->knode_parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001228 if (new_parent)
1229 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Cornelia Huck8a824722006-11-20 17:07:51 +01001230 if (!dev->class)
1231 goto out_put;
1232 error = device_move_class_links(dev, old_parent, new_parent);
1233 if (error) {
1234 /* We ignore errors on cleanup since we're hosed anyway... */
1235 device_move_class_links(dev, new_parent, old_parent);
1236 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001237 if (new_parent)
1238 klist_remove(&dev->knode_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +01001239 if (old_parent)
1240 klist_add_tail(&dev->knode_parent,
1241 &old_parent->klist_children);
1242 }
1243 put_device(new_parent);
1244 goto out;
1245 }
1246out_put:
1247 put_device(old_parent);
1248out:
1249 put_device(dev);
1250 return error;
1251}
1252
1253EXPORT_SYMBOL_GPL(device_move);