blob: c05b1159023e9ee07dbdb65728834e2bf06baa39 [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>
Kay Sieversda231fd2007-11-21 17:29:15 +010021#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080022#include <linux/kallsyms.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040023#include <linux/semaphore.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070024#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include "base.h"
27#include "power/power.h"
28
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080029int (*platform_notify)(struct device *dev) = NULL;
30int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070031static struct kobject *dev_kobj;
32struct kobject *sysfs_dev_char_kobj;
33struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080035#ifdef CONFIG_BLOCK
36static inline int device_is_not_partition(struct device *dev)
37{
38 return !(dev->type == &part_type);
39}
40#else
41static inline int device_is_not_partition(struct device *dev)
42{
43 return 1;
44}
45#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Alan Stern3e956372006-06-16 17:10:48 -040047/**
48 * dev_driver_string - Return a device's driver name, if at all possible
49 * @dev: struct device to get the name of
50 *
51 * Will return the device's driver's name if it is bound to a device. If
52 * the device is not bound to a device, it will return the name of the bus
53 * it is attached to. If it is not attached to a bus either, an empty
54 * string will be returned.
55 */
56const char *dev_driver_string(struct device *dev)
57{
58 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010059 (dev->bus ? dev->bus->name :
60 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040061}
Matthew Wilcox310a9222006-09-23 23:35:04 -060062EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040063
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#define to_dev(obj) container_of(obj, struct device, kobj)
65#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
66
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080067static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
68 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080070 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->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040075 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080076 if (ret >= (ssize_t)PAGE_SIZE) {
77 print_symbol("dev_attr_show: %s returned bad count\n",
78 (unsigned long)dev_attr->show);
79 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 return ret;
81}
82
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080083static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
84 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080086 struct device_attribute *dev_attr = to_dev_attr(attr);
87 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050088 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040091 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return ret;
93}
94
95static struct sysfs_ops dev_sysfs_ops = {
96 .show = dev_attr_show,
97 .store = dev_attr_store,
98};
99
100
101/**
102 * device_release - free device structure.
103 * @kobj: device's kobject.
104 *
105 * This is called once the reference count for the object
106 * reaches 0. We forward the call to the device's release
107 * method, which should handle actually freeing the structure.
108 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800109static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800111 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 if (dev->release)
114 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200115 else if (dev->type && dev->type->release)
116 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700117 else if (dev->class && dev->class->dev_release)
118 dev->class->dev_release(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 else {
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800120 printk(KERN_ERR "Device '%s' does not have a release() "
121 "function, it is broken and must be fixed.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 dev->bus_id);
123 WARN_ON(1);
124 }
125}
126
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600127static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 .release = device_release,
129 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130};
131
132
Kay Sievers312c0042005-11-16 09:00:00 +0100133static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134{
135 struct kobj_type *ktype = get_ktype(kobj);
136
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600137 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200139 if (dev->uevent_suppress)
140 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 if (dev->bus)
142 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700143 if (dev->class)
144 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 }
146 return 0;
147}
148
Kay Sievers312c0042005-11-16 09:00:00 +0100149static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
151 struct device *dev = to_dev(kobj);
152
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700153 if (dev->bus)
154 return dev->bus->name;
155 if (dev->class)
156 return dev->class->name;
157 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158}
159
Kay Sievers7eff2e72007-08-14 15:15:12 +0200160static int dev_uevent(struct kset *kset, struct kobject *kobj,
161 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 int retval = 0;
165
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700166 /* add the major/minor if present */
167 if (MAJOR(dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200168 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
169 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700170 }
171
Kay Sievers414264f2007-03-12 21:08:57 +0100172 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200173 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100174
Kay Sievers239378f2006-10-07 21:54:55 +0200175 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200176 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200177
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200178#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200179 if (dev->class) {
180 struct device *parent = dev->parent;
181
182 /* find first bus device in parent chain */
183 while (parent && !parent->bus)
184 parent = parent->parent;
185 if (parent && parent->bus) {
186 const char *path;
187
188 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200189 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200190 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200191 kfree(path);
192 }
Kay Sievers239378f2006-10-07 21:54:55 +0200193
Kay Sievers7eff2e72007-08-14 15:15:12 +0200194 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200195
196 if (parent->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200197 add_uevent_var(env, "PHYSDEVDRIVER=%s",
198 parent->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200199 }
200 } else if (dev->bus) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200201 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200202
203 if (dev->driver)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800204 add_uevent_var(env, "PHYSDEVDRIVER=%s",
205 dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200206 }
Kay Sievers239378f2006-10-07 21:54:55 +0200207#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Kay Sievers7eff2e72007-08-14 15:15:12 +0200209 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100210 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200211 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200212 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800213 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800214 dev->bus_id, __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 }
216
Kay Sievers7eff2e72007-08-14 15:15:12 +0200217 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700218 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200219 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200220 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800221 pr_debug("device: '%s': %s: class uevent() "
222 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800223 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200224 }
225
Kay Sievers7eff2e72007-08-14 15:15:12 +0200226 /* have the device type specific fuction add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200227 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200228 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200229 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800230 pr_debug("device: '%s': %s: dev_type uevent() "
231 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800232 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700233 }
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 return retval;
236}
237
Kay Sievers312c0042005-11-16 09:00:00 +0100238static struct kset_uevent_ops device_uevent_ops = {
239 .filter = dev_uevent_filter,
240 .name = dev_uevent_name,
241 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242};
243
Kay Sievers16574dc2007-04-06 01:40:38 +0200244static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
245 char *buf)
246{
247 struct kobject *top_kobj;
248 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200249 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200250 int i;
251 size_t count = 0;
252 int retval;
253
254 /* search the kset, the device belongs to */
255 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200256 while (!top_kobj->kset && top_kobj->parent)
257 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200258 if (!top_kobj->kset)
259 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200260
Kay Sievers16574dc2007-04-06 01:40:38 +0200261 kset = top_kobj->kset;
262 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
263 goto out;
264
265 /* respect filter */
266 if (kset->uevent_ops && kset->uevent_ops->filter)
267 if (!kset->uevent_ops->filter(kset, &dev->kobj))
268 goto out;
269
Kay Sievers7eff2e72007-08-14 15:15:12 +0200270 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
271 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200272 return -ENOMEM;
273
Kay Sievers16574dc2007-04-06 01:40:38 +0200274 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200275 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200276 if (retval)
277 goto out;
278
279 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200280 for (i = 0; i < env->envp_idx; i++)
281 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200282out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200283 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200284 return count;
285}
286
Kay Sieversa7fd6702005-10-01 14:49:43 +0200287static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
288 const char *buf, size_t count)
289{
Kay Sievers60a96a52007-07-08 22:29:26 +0200290 enum kobject_action action;
291
Kay Sievers5c5daf62007-08-12 20:43:55 +0200292 if (kobject_action_type(buf, count, &action) == 0) {
Kay Sievers60a96a52007-07-08 22:29:26 +0200293 kobject_uevent(&dev->kobj, action);
294 goto out;
295 }
296
297 dev_err(dev, "uevent: unsupported action-string; this will "
298 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100299 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200300out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200301 return count;
302}
303
Tejun Heoad6a1e12007-06-14 03:45:17 +0900304static struct device_attribute uevent_attr =
305 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
306
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500307static int device_add_attributes(struct device *dev,
308 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700309{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700310 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500311 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700312
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500313 if (attrs) {
314 for (i = 0; attr_name(attrs[i]); i++) {
315 error = device_create_file(dev, &attrs[i]);
316 if (error)
317 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700318 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500319 if (error)
320 while (--i >= 0)
321 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700322 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700323 return error;
324}
325
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500326static void device_remove_attributes(struct device *dev,
327 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700328{
329 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500330
331 if (attrs)
332 for (i = 0; attr_name(attrs[i]); i++)
333 device_remove_file(dev, &attrs[i]);
334}
335
336static int device_add_groups(struct device *dev,
337 struct attribute_group **groups)
338{
339 int error = 0;
340 int i;
341
342 if (groups) {
343 for (i = 0; groups[i]; i++) {
344 error = sysfs_create_group(&dev->kobj, groups[i]);
345 if (error) {
346 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800347 sysfs_remove_group(&dev->kobj,
348 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500349 break;
350 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700351 }
352 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500353 return error;
354}
355
356static void device_remove_groups(struct device *dev,
357 struct attribute_group **groups)
358{
359 int i;
360
361 if (groups)
362 for (i = 0; groups[i]; i++)
363 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700364}
365
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700366static int device_add_attrs(struct device *dev)
367{
368 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200369 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500370 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700371
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500372 if (class) {
373 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200374 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500375 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700376 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200377
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500378 if (type) {
379 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200380 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500381 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200382 }
383
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500384 error = device_add_groups(dev, dev->groups);
385 if (error)
386 goto err_remove_type_groups;
387
388 return 0;
389
390 err_remove_type_groups:
391 if (type)
392 device_remove_groups(dev, type->groups);
393 err_remove_class_attrs:
394 if (class)
395 device_remove_attributes(dev, class->dev_attrs);
396
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700397 return error;
398}
399
400static void device_remove_attrs(struct device *dev)
401{
402 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200403 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700404
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500405 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200406
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500407 if (type)
408 device_remove_groups(dev, type->groups);
409
410 if (class)
411 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700412}
413
414
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700415static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
416 char *buf)
417{
418 return print_dev_t(buf, dev->devt);
419}
420
Tejun Heoad6a1e12007-06-14 03:45:17 +0900421static struct device_attribute devt_attr =
422 __ATTR(dev, S_IRUGO, show_dev, NULL);
423
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600424/* kset to create /sys/devices/ */
425struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800428 * device_create_file - create sysfs attribute file for device.
429 * @dev: device.
430 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800432int device_create_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
434 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100435 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return error;
438}
439
440/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800441 * device_remove_file - remove sysfs attribute file.
442 * @dev: device.
443 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800445void device_remove_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100447 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449}
450
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700451/**
452 * device_create_bin_file - create sysfs binary attribute file for device.
453 * @dev: device.
454 * @attr: device binary attribute descriptor.
455 */
456int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
457{
458 int error = -EINVAL;
459 if (dev)
460 error = sysfs_create_bin_file(&dev->kobj, attr);
461 return error;
462}
463EXPORT_SYMBOL_GPL(device_create_bin_file);
464
465/**
466 * device_remove_bin_file - remove sysfs binary attribute file
467 * @dev: device.
468 * @attr: device binary attribute descriptor.
469 */
470void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
471{
472 if (dev)
473 sysfs_remove_bin_file(&dev->kobj, attr);
474}
475EXPORT_SYMBOL_GPL(device_remove_bin_file);
476
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400477/**
Alan Stern523ded72007-04-26 00:12:04 -0700478 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400479 * @dev: device.
480 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700481 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400482 *
483 * Attribute methods must not unregister themselves or their parent device
484 * (which would amount to the same thing). Attempts to do so will deadlock,
485 * since unregistration is mutually exclusive with driver callbacks.
486 *
487 * Instead methods can call this routine, which will attempt to allocate
488 * and schedule a workqueue request to call back @func with @dev as its
489 * argument in the workqueue's process context. @dev will be pinned until
490 * @func returns.
491 *
Alan Stern523ded72007-04-26 00:12:04 -0700492 * This routine is usually called via the inline device_schedule_callback(),
493 * which automatically sets @owner to THIS_MODULE.
494 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400495 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700496 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400497 *
498 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
499 * underlying sysfs routine (since it is intended for use by attribute
500 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
501 */
Alan Stern523ded72007-04-26 00:12:04 -0700502int device_schedule_callback_owner(struct device *dev,
503 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400504{
505 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700506 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400507}
Alan Stern523ded72007-04-26 00:12:04 -0700508EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400509
James Bottomley34bb61f2005-09-06 16:56:51 -0700510static void klist_children_get(struct klist_node *n)
511{
512 struct device *dev = container_of(n, struct device, knode_parent);
513
514 get_device(dev);
515}
516
517static void klist_children_put(struct klist_node *n)
518{
519 struct device *dev = container_of(n, struct device, knode_parent);
520
521 put_device(dev);
522}
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800525 * device_initialize - init device structure.
526 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800528 * This prepares the device for use by other layers,
529 * including adding it to the device hierarchy.
530 * It is the first half of device_register(), if called by
531 * that, though it can also be called separately, so one
532 * may use @dev's fields (e.g. the refcount).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534void device_initialize(struct device *dev)
535{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600536 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700537 kobject_init(&dev->kobj, &device_ktype);
James Bottomley34bb61f2005-09-06 16:56:51 -0700538 klist_init(&dev->klist_children, klist_children_get,
539 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700541 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800542 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900543 spin_lock_init(&dev->devres_lock);
544 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700545 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800546 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
548
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100549#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sieversda231fd2007-11-21 17:29:15 +0100550static struct kobject *get_device_parent(struct device *dev,
551 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100552{
Kay Sieversda231fd2007-11-21 17:29:15 +0100553 /* class devices without a parent live in /sys/class/<classname>/ */
Dmitry Torokhov3eb215d2007-10-07 12:22:21 -0400554 if (dev->class && (!parent || parent->class != dev->class))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700555 return &dev->class->p->class_subsys.kobj;
Kay Sieversda231fd2007-11-21 17:29:15 +0100556 /* all other devices keep their parent */
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100557 else if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100558 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100559
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100560 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100561}
Kay Sieversda231fd2007-11-21 17:29:15 +0100562
563static inline void cleanup_device_parent(struct device *dev) {}
Cornelia Huck63b69712008-01-21 16:09:44 +0100564static inline void cleanup_glue_dir(struct device *dev,
565 struct kobject *glue_dir) {}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100566#else
Kay Sievers86406242007-03-14 03:25:56 +0100567static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700568{
Kay Sievers86406242007-03-14 03:25:56 +0100569 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700570
Kay Sievers86406242007-03-14 03:25:56 +0100571 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800572 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600573 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700574
Kay Sievers86406242007-03-14 03:25:56 +0100575 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700576}
577
Kay Sieversda231fd2007-11-21 17:29:15 +0100578static struct kobject *get_device_parent(struct device *dev,
579 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100580{
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800581 int retval;
582
Kay Sievers86406242007-03-14 03:25:56 +0100583 if (dev->class) {
584 struct kobject *kobj = NULL;
585 struct kobject *parent_kobj;
586 struct kobject *k;
587
588 /*
589 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100590 * Class-devices with a non class-device as parent, live
591 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100592 */
593 if (parent == NULL)
594 parent_kobj = virtual_device_parent(dev);
595 else if (parent->class)
596 return &parent->kobj;
597 else
598 parent_kobj = &parent->kobj;
599
600 /* find our class-directory at the parent and reference it */
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500601 spin_lock(&dev->class->p->class_dirs.list_lock);
602 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100603 if (k->parent == parent_kobj) {
604 kobj = kobject_get(k);
605 break;
606 }
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500607 spin_unlock(&dev->class->p->class_dirs.list_lock);
Kay Sievers86406242007-03-14 03:25:56 +0100608 if (kobj)
609 return kobj;
610
611 /* or create a new class-directory at the parent device */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800612 k = kobject_create();
613 if (!k)
614 return NULL;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500615 k->kset = &dev->class->p->class_dirs;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700616 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800617 if (retval < 0) {
618 kobject_put(k);
619 return NULL;
620 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100621 /* do not emit an uevent for this simple "glue" directory */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800622 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100623 }
624
625 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100626 return &parent->kobj;
627 return NULL;
628}
Kay Sieversda231fd2007-11-21 17:29:15 +0100629
Cornelia Huck63b69712008-01-21 16:09:44 +0100630static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100631{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100632 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100633 if (!glue_dir || !dev->class ||
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500634 glue_dir->kset != &dev->class->p->class_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100635 return;
636
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100637 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100638}
Cornelia Huck63b69712008-01-21 16:09:44 +0100639
640static void cleanup_device_parent(struct device *dev)
641{
642 cleanup_glue_dir(dev, dev->kobj.parent);
643}
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100644#endif
Kay Sievers86406242007-03-14 03:25:56 +0100645
Cornelia Huck63b69712008-01-21 16:09:44 +0100646static void setup_parent(struct device *dev, struct device *parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100647{
648 struct kobject *kobj;
649 kobj = get_device_parent(dev, parent);
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100650 if (kobj)
651 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100652}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100653
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700654static int device_add_class_symlinks(struct device *dev)
655{
656 int error;
657
658 if (!dev->class)
659 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100660
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700661 error = sysfs_create_link(&dev->kobj,
662 &dev->class->p->class_subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700663 "subsystem");
664 if (error)
665 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100666
667#ifdef CONFIG_SYSFS_DEPRECATED
668 /* stacked class devices need a symlink in the class directory */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700669 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800670 device_is_not_partition(dev)) {
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700671 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500672 &dev->kobj, dev->bus_id);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700673 if (error)
674 goto out_subsys;
675 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100676
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800677 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100678 struct device *parent = dev->parent;
679 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700680
Kay Sieversda231fd2007-11-21 17:29:15 +0100681 /*
682 * stacked class devices have the 'device' link
683 * pointing to the bus device instead of the parent
684 */
685 while (parent->class && !parent->bus && parent->parent)
686 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700687
Kay Sieversda231fd2007-11-21 17:29:15 +0100688 error = sysfs_create_link(&dev->kobj,
689 &parent->kobj,
690 "device");
691 if (error)
692 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700693
Kay Sieversda231fd2007-11-21 17:29:15 +0100694 class_name = make_class_name(dev->class->name,
695 &dev->kobj);
696 if (class_name)
697 error = sysfs_create_link(&dev->parent->kobj,
698 &dev->kobj, class_name);
699 kfree(class_name);
700 if (error)
701 goto out_device;
702 }
703 return 0;
704
705out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800706 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100707 sysfs_remove_link(&dev->kobj, "device");
708out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700709 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800710 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700711 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
712 dev->bus_id);
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700713#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100714 /* link in the class directory pointing to the device */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700715 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
716 &dev->kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100717 if (error)
718 goto out_subsys;
719
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800720 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700721 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
722 "device");
723 if (error)
724 goto out_busid;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700725 }
726 return 0;
727
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700728out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700729 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100730#endif
731
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700732out_subsys:
733 sysfs_remove_link(&dev->kobj, "subsystem");
734out:
735 return error;
736}
737
738static void device_remove_class_symlinks(struct device *dev)
739{
740 if (!dev->class)
741 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100742
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700743#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800744 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700745 char *class_name;
746
747 class_name = make_class_name(dev->class->name, &dev->kobj);
748 if (class_name) {
749 sysfs_remove_link(&dev->parent->kobj, class_name);
750 kfree(class_name);
751 }
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700752 sysfs_remove_link(&dev->kobj, "device");
753 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100754
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700755 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800756 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700757 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
758 dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100759#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800760 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100761 sysfs_remove_link(&dev->kobj, "device");
762
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700763 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100764#endif
765
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700766 sysfs_remove_link(&dev->kobj, "subsystem");
767}
768
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000770 * dev_set_name - set a device name
771 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700772 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000773 */
774int dev_set_name(struct device *dev, const char *fmt, ...)
775{
776 va_list vargs;
777
778 va_start(vargs, fmt);
779 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
780 va_end(vargs);
781 return 0;
782}
783EXPORT_SYMBOL_GPL(dev_set_name);
784
785/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700786 * device_to_dev_kobj - select a /sys/dev/ directory for the device
787 * @dev: device
788 *
789 * By default we select char/ for new entries. Setting class->dev_obj
790 * to NULL prevents an entry from being created. class->dev_kobj must
791 * be set (or cleared) before any devices are registered to the class
792 * otherwise device_create_sys_dev_entry() and
793 * device_remove_sys_dev_entry() will disagree about the the presence
794 * of the link.
795 */
796static struct kobject *device_to_dev_kobj(struct device *dev)
797{
798 struct kobject *kobj;
799
800 if (dev->class)
801 kobj = dev->class->dev_kobj;
802 else
803 kobj = sysfs_dev_char_kobj;
804
805 return kobj;
806}
807
808static int device_create_sys_dev_entry(struct device *dev)
809{
810 struct kobject *kobj = device_to_dev_kobj(dev);
811 int error = 0;
812 char devt_str[15];
813
814 if (kobj) {
815 format_dev_t(devt_str, dev->devt);
816 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
817 }
818
819 return error;
820}
821
822static void device_remove_sys_dev_entry(struct device *dev)
823{
824 struct kobject *kobj = device_to_dev_kobj(dev);
825 char devt_str[15];
826
827 if (kobj) {
828 format_dev_t(devt_str, dev->devt);
829 sysfs_remove_link(kobj, devt_str);
830 }
831}
832
833/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800834 * device_add - add device to device hierarchy.
835 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800837 * This is part 2 of device_register(), though may be called
838 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800840 * This adds it to the kobject hierarchy via kobject_add(), adds it
841 * to the global and sibling lists for the device, then
842 * adds it to the other relevant subsystems of the driver model.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 */
844int device_add(struct device *dev)
845{
846 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200847 struct class_interface *class_intf;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100848 int error;
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 dev = get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100851 if (!dev || !strlen(dev->bus_id)) {
852 error = -EINVAL;
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100853 goto Done;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800856 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100859 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Yinghai Lu0d358f22008-02-19 03:20:41 -0800861 /* use parent numa_node */
862 if (parent)
863 set_dev_node(dev, dev_to_node(parent));
864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 /* first, register with generic layer. */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700866 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100867 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200869
Brian Walsh37022642006-08-14 22:43:19 -0700870 /* notify platform of device entry */
871 if (platform_notify)
872 platform_notify(dev);
873
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000874 /* notify clients of device entry (new way) */
875 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700876 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000877 BUS_NOTIFY_ADD_DEVICE, dev);
878
Tejun Heoad6a1e12007-06-14 03:45:17 +0900879 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200880 if (error)
881 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200882
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700883 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900884 error = device_create_file(dev, &devt_attr);
885 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200886 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -0700887
888 error = device_create_sys_dev_entry(dev);
889 if (error)
890 goto devtattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700891 }
892
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700893 error = device_add_class_symlinks(dev);
894 if (error)
895 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700896 error = device_add_attrs(dev);
897 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700898 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700899 error = bus_add_device(dev);
900 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 goto BusError;
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100902 error = device_pm_add(dev);
903 if (error)
904 goto PMError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200905 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800906 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 if (parent)
James Bottomleyd856f1e32005-08-19 09:14:01 -0400908 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700910 if (dev->class) {
Dave Youngf75b1c62008-05-28 09:28:39 -0700911 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200912 /* tie the class to the device */
Greg Kroah-Hartman97ae69f2008-05-28 09:28:39 -0700913 list_add_tail(&dev->node, &dev->class->p->class_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200914
915 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -0700916 list_for_each_entry(class_intf,
917 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200918 if (class_intf->add_dev)
919 class_intf->add_dev(dev, class_intf);
Dave Youngf75b1c62008-05-28 09:28:39 -0700920 mutex_unlock(&dev->class->p->class_mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700921 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 Done:
923 put_device(dev);
924 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 PMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100926 bus_remove_device(dev);
927 BusError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000928 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700929 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000930 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000931 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700932 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700933 device_remove_class_symlinks(dev);
934 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900935 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -0700936 device_remove_sys_dev_entry(dev);
937 devtattrError:
938 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +0900939 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200940 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900941 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700942 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100943 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 kobject_del(&dev->kobj);
945 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100946 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 if (parent)
948 put_device(parent);
949 goto Done;
950}
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800953 * device_register - register a device with the system.
954 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800956 * This happens in two clean steps - initialize the device
957 * and add it to the system. The two steps can be called
958 * separately, but this is the easiest and most common.
959 * I.e. you should only call the two helpers separately if
960 * have a clearly defined need to use and refcount the device
961 * before it is added to the hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963int device_register(struct device *dev)
964{
965 device_initialize(dev);
966 return device_add(dev);
967}
968
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800970 * get_device - increment reference count for device.
971 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800973 * This simply forwards the call to kobject_get(), though
974 * we do take care to provide for the case that we get a NULL
975 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800977struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
979 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
980}
981
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800983 * put_device - decrement reference count.
984 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800986void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200988 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 if (dev)
990 kobject_put(&dev->kobj);
991}
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800994 * device_del - delete device from system.
995 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800997 * This is the first part of the device unregistration
998 * sequence. This removes the device from the lists we control
999 * from here, has it removed from the other driver model
1000 * subsystems it was added to in device_add(), and removes it
1001 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001003 * NOTE: this should be called manually _iff_ device_add() was
1004 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001006void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001008 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001009 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001011 device_pm_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -07001013 klist_del(&dev->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001014 if (MAJOR(dev->devt)) {
1015 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001016 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001017 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001018 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001019 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001020
Dave Youngf75b1c62008-05-28 09:28:39 -07001021 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001022 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001023 list_for_each_entry(class_intf,
1024 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001025 if (class_intf->remove_dev)
1026 class_intf->remove_dev(dev, class_intf);
1027 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001028 list_del_init(&dev->node);
Dave Youngf75b1c62008-05-28 09:28:39 -07001029 mutex_unlock(&dev->class->p->class_mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001030 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001031 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001032 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001033 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001035 /*
1036 * Some platform devices are driven without driver attached
1037 * and managed resources may have been acquired. Make sure
1038 * all resources are released.
1039 */
1040 devres_release_all(dev);
1041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 /* Notify the platform of the removal, in case they
1043 * need to do anything...
1044 */
1045 if (platform_notify_remove)
1046 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001047 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07001048 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001049 BUS_NOTIFY_DEL_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001050 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001051 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001053 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054}
1055
1056/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001057 * device_unregister - unregister device from system.
1058 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001060 * We do this in two parts, like we do device_register(). First,
1061 * we remove it from all the subsystems with device_del(), then
1062 * we decrement the reference count via put_device(). If that
1063 * is the final reference count, the device will be cleaned up
1064 * via device_release() above. Otherwise, the structure will
1065 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001067void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001069 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 device_del(dev);
1071 put_device(dev);
1072}
1073
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001074static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001075{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001076 struct klist_node *n = klist_next(i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001077 return n ? container_of(n, struct device, knode_parent) : NULL;
1078}
1079
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001081 * device_for_each_child - device child iterator.
1082 * @parent: parent struct device.
1083 * @data: data for the callback.
1084 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001086 * Iterate over @parent's child devices, and call @fn for each,
1087 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001089 * We check the return of @fn each time. If it returns anything
1090 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001092int device_for_each_child(struct device *parent, void *data,
1093 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001095 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001096 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 int error = 0;
1098
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001099 klist_iter_init(&parent->klist_children, &i);
1100 while ((child = next_device(&i)) && !error)
1101 error = fn(child, data);
1102 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 return error;
1104}
1105
Cornelia Huck5ab69982006-11-16 15:42:07 +01001106/**
1107 * device_find_child - device iterator for locating a particular device.
1108 * @parent: parent struct device
1109 * @data: Data to pass to match function
1110 * @match: Callback function to check device
1111 *
1112 * This is similar to the device_for_each_child() function above, but it
1113 * returns a reference to a device that is 'found' for later use, as
1114 * determined by the @match callback.
1115 *
1116 * The callback should return 0 if the device doesn't match and non-zero
1117 * if it does. If the callback returns non-zero and a reference to the
1118 * current device can be obtained, this function will return to the caller
1119 * and not iterate over any more devices.
1120 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001121struct device *device_find_child(struct device *parent, void *data,
1122 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001123{
1124 struct klist_iter i;
1125 struct device *child;
1126
1127 if (!parent)
1128 return NULL;
1129
1130 klist_iter_init(&parent->klist_children, &i);
1131 while ((child = next_device(&i)))
1132 if (match(child, data) && get_device(child))
1133 break;
1134 klist_iter_exit(&i);
1135 return child;
1136}
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138int __init devices_init(void)
1139{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001140 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1141 if (!devices_kset)
1142 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001143 dev_kobj = kobject_create_and_add("dev", NULL);
1144 if (!dev_kobj)
1145 goto dev_kobj_err;
1146 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1147 if (!sysfs_dev_block_kobj)
1148 goto block_kobj_err;
1149 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1150 if (!sysfs_dev_char_kobj)
1151 goto char_kobj_err;
1152
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001153 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001154
1155 char_kobj_err:
1156 kobject_put(sysfs_dev_block_kobj);
1157 block_kobj_err:
1158 kobject_put(dev_kobj);
1159 dev_kobj_err:
1160 kset_unregister(devices_kset);
1161 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162}
1163
1164EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001165EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167EXPORT_SYMBOL_GPL(device_initialize);
1168EXPORT_SYMBOL_GPL(device_add);
1169EXPORT_SYMBOL_GPL(device_register);
1170
1171EXPORT_SYMBOL_GPL(device_del);
1172EXPORT_SYMBOL_GPL(device_unregister);
1173EXPORT_SYMBOL_GPL(get_device);
1174EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
1176EXPORT_SYMBOL_GPL(device_create_file);
1177EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001178
1179
1180static void device_create_release(struct device *dev)
1181{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001182 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001183 kfree(dev);
1184}
1185
1186/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001187 * device_create_vargs - creates a device and registers it with sysfs
1188 * @class: pointer to the struct class that this device should be registered to
1189 * @parent: pointer to the parent struct device of this new device, if any
1190 * @devt: the dev_t for the char device to be added
1191 * @drvdata: the data to be added to the device for callbacks
1192 * @fmt: string for the device's name
1193 * @args: va_list for the device's name
1194 *
1195 * This function can be used by char device classes. A struct device
1196 * will be created in sysfs, registered to the specified class.
1197 *
1198 * A "dev" file will be created, showing the dev_t for the device, if
1199 * the dev_t is not 0,0.
1200 * If a pointer to a parent struct device is passed in, the newly created
1201 * struct device will be a child of that device in sysfs.
1202 * The pointer to the struct device will be returned from the call.
1203 * Any further sysfs files that might be required can be created using this
1204 * pointer.
1205 *
1206 * Note: the struct class passed to this function must have previously
1207 * been created with a call to class_create().
1208 */
1209struct device *device_create_vargs(struct class *class, struct device *parent,
1210 dev_t devt, void *drvdata, const char *fmt,
1211 va_list args)
1212{
1213 struct device *dev = NULL;
1214 int retval = -ENODEV;
1215
1216 if (class == NULL || IS_ERR(class))
1217 goto error;
1218
1219 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1220 if (!dev) {
1221 retval = -ENOMEM;
1222 goto error;
1223 }
1224
1225 dev->devt = devt;
1226 dev->class = class;
1227 dev->parent = parent;
1228 dev->release = device_create_release;
1229 dev_set_drvdata(dev, drvdata);
1230
1231 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1232 retval = device_register(dev);
1233 if (retval)
1234 goto error;
1235
1236 return dev;
1237
1238error:
1239 kfree(dev);
1240 return ERR_PTR(retval);
1241}
1242EXPORT_SYMBOL_GPL(device_create_vargs);
1243
1244/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001245 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001246 * @class: pointer to the struct class that this device should be registered to
1247 * @parent: pointer to the parent struct device of this new device, if any
1248 * @devt: the dev_t for the char device to be added
1249 * @drvdata: the data to be added to the device for callbacks
1250 * @fmt: string for the device's name
1251 *
1252 * This function can be used by char device classes. A struct device
1253 * will be created in sysfs, registered to the specified class.
1254 *
1255 * A "dev" file will be created, showing the dev_t for the device, if
1256 * the dev_t is not 0,0.
1257 * If a pointer to a parent struct device is passed in, the newly created
1258 * struct device will be a child of that device in sysfs.
1259 * The pointer to the struct device will be returned from the call.
1260 * Any further sysfs files that might be required can be created using this
1261 * pointer.
1262 *
1263 * Note: the struct class passed to this function must have previously
1264 * been created with a call to class_create().
1265 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001266struct device *device_create(struct class *class, struct device *parent,
1267 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001268{
1269 va_list vargs;
1270 struct device *dev;
1271
1272 va_start(vargs, fmt);
1273 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1274 va_end(vargs);
1275 return dev;
1276}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001277EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001278
Dave Youngcd354492008-01-28 16:56:11 +08001279static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001280{
Dave Youngcd354492008-01-28 16:56:11 +08001281 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001282
Dave Youngcd354492008-01-28 16:56:11 +08001283 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001284}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001285
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001286/**
1287 * device_destroy - removes a device that was created with device_create()
1288 * @class: pointer to the struct class that this device was registered with
1289 * @devt: the dev_t of the device that was previously registered
1290 *
1291 * This call unregisters and cleans up a device that was created with a
1292 * call to device_create().
1293 */
1294void device_destroy(struct class *class, dev_t devt)
1295{
1296 struct device *dev;
1297
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001298 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001299 if (dev) {
1300 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001301 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001302 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001303}
1304EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001305
1306/**
1307 * device_rename - renames a device
1308 * @dev: the pointer to the struct device to be renamed
1309 * @new_name: the new name of the device
1310 */
1311int device_rename(struct device *dev, char *new_name)
1312{
1313 char *old_class_name = NULL;
1314 char *new_class_name = NULL;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001315 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001316 int error;
1317
1318 dev = get_device(dev);
1319 if (!dev)
1320 return -EINVAL;
1321
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001322 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001323 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001324
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001325#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001326 if ((dev->class) && (dev->parent))
1327 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001328#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001329
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001330 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1331 if (!old_device_name) {
1332 error = -ENOMEM;
1333 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001334 }
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001335 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001336 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1337
1338 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001339 if (error) {
1340 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1341 goto out;
1342 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001343
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001344#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001345 if (old_class_name) {
1346 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1347 if (new_class_name) {
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001348 error = sysfs_create_link(&dev->parent->kobj,
1349 &dev->kobj, new_class_name);
1350 if (error)
1351 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001352 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1353 }
1354 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001355#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001356 if (dev->class) {
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001357 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -05001358 &dev->kobj, dev->bus_id);
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001359 if (error)
1360 goto out;
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001361 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -05001362 old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001363 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001364#endif
1365
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001366out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001367 put_device(dev);
1368
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001369 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001370 kfree(old_class_name);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001371 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001372
1373 return error;
1374}
Johannes Berga2807db2007-02-28 12:38:31 +01001375EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001376
1377static int device_move_class_links(struct device *dev,
1378 struct device *old_parent,
1379 struct device *new_parent)
1380{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001381 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001382#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001383 char *class_name;
1384
1385 class_name = make_class_name(dev->class->name, &dev->kobj);
1386 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001387 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001388 goto out;
1389 }
1390 if (old_parent) {
1391 sysfs_remove_link(&dev->kobj, "device");
1392 sysfs_remove_link(&old_parent->kobj, class_name);
1393 }
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001394 if (new_parent) {
1395 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1396 "device");
1397 if (error)
1398 goto out;
1399 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1400 class_name);
1401 if (error)
1402 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001403 } else
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001404 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001405out:
1406 kfree(class_name);
1407 return error;
1408#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001409 if (old_parent)
1410 sysfs_remove_link(&dev->kobj, "device");
1411 if (new_parent)
1412 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1413 "device");
1414 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001415#endif
1416}
1417
1418/**
1419 * device_move - moves a device to a new parent
1420 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001421 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001422 */
1423int device_move(struct device *dev, struct device *new_parent)
1424{
1425 int error;
1426 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001427 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001428
1429 dev = get_device(dev);
1430 if (!dev)
1431 return -EINVAL;
1432
Cornelia Huck8a824722006-11-20 17:07:51 +01001433 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001434 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001435
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001436 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001437 __func__, new_parent ? new_parent->bus_id : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001438 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001439 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001440 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001441 put_device(new_parent);
1442 goto out;
1443 }
1444 old_parent = dev->parent;
1445 dev->parent = new_parent;
1446 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001447 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001448 if (new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001449 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001450 set_dev_node(dev, dev_to_node(new_parent));
1451 }
1452
Cornelia Huck8a824722006-11-20 17:07:51 +01001453 if (!dev->class)
1454 goto out_put;
1455 error = device_move_class_links(dev, old_parent, new_parent);
1456 if (error) {
1457 /* We ignore errors on cleanup since we're hosed anyway... */
1458 device_move_class_links(dev, new_parent, old_parent);
1459 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001460 if (new_parent)
1461 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001462 dev->parent = old_parent;
1463 if (old_parent) {
Cornelia Huck8a824722006-11-20 17:07:51 +01001464 klist_add_tail(&dev->knode_parent,
1465 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001466 set_dev_node(dev, dev_to_node(old_parent));
1467 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001468 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001469 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001470 put_device(new_parent);
1471 goto out;
1472 }
1473out_put:
1474 put_device(old_parent);
1475out:
1476 put_device(dev);
1477 return error;
1478}
Cornelia Huck8a824722006-11-20 17:07:51 +01001479EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001480
1481/**
1482 * device_shutdown - call ->shutdown() on each device to shutdown.
1483 */
1484void device_shutdown(void)
1485{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001486 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001487
1488 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1489 kobj.entry) {
1490 if (dev->bus && dev->bus->shutdown) {
1491 dev_dbg(dev, "shutdown\n");
1492 dev->bus->shutdown(dev);
1493 } else if (dev->driver && dev->driver->shutdown) {
1494 dev_dbg(dev, "shutdown\n");
1495 dev->driver->shutdown(dev);
1496 }
1497 }
Dan Williamse105b8b2008-04-21 10:51:07 -07001498 kobject_put(sysfs_dev_char_kobj);
1499 kobject_put(sysfs_dev_block_kobj);
1500 kobject_put(dev_kobj);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001501}