blob: 068aa1c9538c99d54a47603e25f69544f084f537 [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);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700119 else
120 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800121 "function, it is broken and must be fixed.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 dev->bus_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123}
124
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600125static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 .release = device_release,
127 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128};
129
130
Kay Sievers312c0042005-11-16 09:00:00 +0100131static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
133 struct kobj_type *ktype = get_ktype(kobj);
134
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600135 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200137 if (dev->uevent_suppress)
138 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 if (dev->bus)
140 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700141 if (dev->class)
142 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 }
144 return 0;
145}
146
Kay Sievers312c0042005-11-16 09:00:00 +0100147static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
149 struct device *dev = to_dev(kobj);
150
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700151 if (dev->bus)
152 return dev->bus->name;
153 if (dev->class)
154 return dev->class->name;
155 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
Kay Sievers7eff2e72007-08-14 15:15:12 +0200158static int dev_uevent(struct kset *kset, struct kobject *kobj,
159 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
161 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 int retval = 0;
163
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700164 /* add the major/minor if present */
165 if (MAJOR(dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200166 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
167 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700168 }
169
Kay Sievers414264f2007-03-12 21:08:57 +0100170 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200171 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100172
Kay Sievers239378f2006-10-07 21:54:55 +0200173 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200174 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200175
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200176#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200177 if (dev->class) {
178 struct device *parent = dev->parent;
179
180 /* find first bus device in parent chain */
181 while (parent && !parent->bus)
182 parent = parent->parent;
183 if (parent && parent->bus) {
184 const char *path;
185
186 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200187 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200188 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200189 kfree(path);
190 }
Kay Sievers239378f2006-10-07 21:54:55 +0200191
Kay Sievers7eff2e72007-08-14 15:15:12 +0200192 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200193
194 if (parent->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200195 add_uevent_var(env, "PHYSDEVDRIVER=%s",
196 parent->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200197 }
198 } else if (dev->bus) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200199 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200200
201 if (dev->driver)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800202 add_uevent_var(env, "PHYSDEVDRIVER=%s",
203 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
Kay Sievers7eff2e72007-08-14 15:15:12 +0200207 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100208 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200209 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200210 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800211 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800212 dev->bus_id, __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
214
Kay Sievers7eff2e72007-08-14 15:15:12 +0200215 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700216 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200217 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200218 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800219 pr_debug("device: '%s': %s: class uevent() "
220 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800221 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200222 }
223
Kay Sievers7eff2e72007-08-14 15:15:12 +0200224 /* have the device type specific fuction add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200225 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200226 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200227 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800228 pr_debug("device: '%s': %s: dev_type uevent() "
229 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800230 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700231 }
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 return retval;
234}
235
Kay Sievers312c0042005-11-16 09:00:00 +0100236static struct kset_uevent_ops device_uevent_ops = {
237 .filter = dev_uevent_filter,
238 .name = dev_uevent_name,
239 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240};
241
Kay Sievers16574dc2007-04-06 01:40:38 +0200242static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
243 char *buf)
244{
245 struct kobject *top_kobj;
246 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200247 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200248 int i;
249 size_t count = 0;
250 int retval;
251
252 /* search the kset, the device belongs to */
253 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200254 while (!top_kobj->kset && top_kobj->parent)
255 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200256 if (!top_kobj->kset)
257 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200258
Kay Sievers16574dc2007-04-06 01:40:38 +0200259 kset = top_kobj->kset;
260 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
261 goto out;
262
263 /* respect filter */
264 if (kset->uevent_ops && kset->uevent_ops->filter)
265 if (!kset->uevent_ops->filter(kset, &dev->kobj))
266 goto out;
267
Kay Sievers7eff2e72007-08-14 15:15:12 +0200268 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
269 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200270 return -ENOMEM;
271
Kay Sievers16574dc2007-04-06 01:40:38 +0200272 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200273 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200274 if (retval)
275 goto out;
276
277 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200278 for (i = 0; i < env->envp_idx; i++)
279 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200280out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200281 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200282 return count;
283}
284
Kay Sieversa7fd6702005-10-01 14:49:43 +0200285static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
286 const char *buf, size_t count)
287{
Kay Sievers60a96a52007-07-08 22:29:26 +0200288 enum kobject_action action;
289
Kay Sievers5c5daf62007-08-12 20:43:55 +0200290 if (kobject_action_type(buf, count, &action) == 0) {
Kay Sievers60a96a52007-07-08 22:29:26 +0200291 kobject_uevent(&dev->kobj, action);
292 goto out;
293 }
294
295 dev_err(dev, "uevent: unsupported action-string; this will "
296 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100297 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200298out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200299 return count;
300}
301
Tejun Heoad6a1e12007-06-14 03:45:17 +0900302static struct device_attribute uevent_attr =
303 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
304
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500305static int device_add_attributes(struct device *dev,
306 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700307{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700308 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500309 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700310
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500311 if (attrs) {
312 for (i = 0; attr_name(attrs[i]); i++) {
313 error = device_create_file(dev, &attrs[i]);
314 if (error)
315 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700316 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500317 if (error)
318 while (--i >= 0)
319 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700320 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700321 return error;
322}
323
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500324static void device_remove_attributes(struct device *dev,
325 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700326{
327 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500328
329 if (attrs)
330 for (i = 0; attr_name(attrs[i]); i++)
331 device_remove_file(dev, &attrs[i]);
332}
333
334static int device_add_groups(struct device *dev,
335 struct attribute_group **groups)
336{
337 int error = 0;
338 int i;
339
340 if (groups) {
341 for (i = 0; groups[i]; i++) {
342 error = sysfs_create_group(&dev->kobj, groups[i]);
343 if (error) {
344 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800345 sysfs_remove_group(&dev->kobj,
346 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500347 break;
348 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700349 }
350 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500351 return error;
352}
353
354static void device_remove_groups(struct device *dev,
355 struct attribute_group **groups)
356{
357 int i;
358
359 if (groups)
360 for (i = 0; groups[i]; i++)
361 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700362}
363
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700364static int device_add_attrs(struct device *dev)
365{
366 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200367 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500368 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700369
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500370 if (class) {
371 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200372 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500373 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700374 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200375
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500376 if (type) {
377 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200378 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500379 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200380 }
381
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500382 error = device_add_groups(dev, dev->groups);
383 if (error)
384 goto err_remove_type_groups;
385
386 return 0;
387
388 err_remove_type_groups:
389 if (type)
390 device_remove_groups(dev, type->groups);
391 err_remove_class_attrs:
392 if (class)
393 device_remove_attributes(dev, class->dev_attrs);
394
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700395 return error;
396}
397
398static void device_remove_attrs(struct device *dev)
399{
400 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200401 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700402
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500403 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200404
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500405 if (type)
406 device_remove_groups(dev, type->groups);
407
408 if (class)
409 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700410}
411
412
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700413static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
414 char *buf)
415{
416 return print_dev_t(buf, dev->devt);
417}
418
Tejun Heoad6a1e12007-06-14 03:45:17 +0900419static struct device_attribute devt_attr =
420 __ATTR(dev, S_IRUGO, show_dev, NULL);
421
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600422/* kset to create /sys/devices/ */
423struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800426 * device_create_file - create sysfs attribute file for device.
427 * @dev: device.
428 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800430int device_create_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
432 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100433 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return error;
436}
437
438/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800439 * device_remove_file - remove sysfs attribute file.
440 * @dev: device.
441 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800443void device_remove_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100445 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700449/**
450 * device_create_bin_file - create sysfs binary attribute file for device.
451 * @dev: device.
452 * @attr: device binary attribute descriptor.
453 */
454int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
455{
456 int error = -EINVAL;
457 if (dev)
458 error = sysfs_create_bin_file(&dev->kobj, attr);
459 return error;
460}
461EXPORT_SYMBOL_GPL(device_create_bin_file);
462
463/**
464 * device_remove_bin_file - remove sysfs binary attribute file
465 * @dev: device.
466 * @attr: device binary attribute descriptor.
467 */
468void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
469{
470 if (dev)
471 sysfs_remove_bin_file(&dev->kobj, attr);
472}
473EXPORT_SYMBOL_GPL(device_remove_bin_file);
474
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400475/**
Alan Stern523ded72007-04-26 00:12:04 -0700476 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400477 * @dev: device.
478 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700479 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400480 *
481 * Attribute methods must not unregister themselves or their parent device
482 * (which would amount to the same thing). Attempts to do so will deadlock,
483 * since unregistration is mutually exclusive with driver callbacks.
484 *
485 * Instead methods can call this routine, which will attempt to allocate
486 * and schedule a workqueue request to call back @func with @dev as its
487 * argument in the workqueue's process context. @dev will be pinned until
488 * @func returns.
489 *
Alan Stern523ded72007-04-26 00:12:04 -0700490 * This routine is usually called via the inline device_schedule_callback(),
491 * which automatically sets @owner to THIS_MODULE.
492 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400493 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700494 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400495 *
496 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
497 * underlying sysfs routine (since it is intended for use by attribute
498 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
499 */
Alan Stern523ded72007-04-26 00:12:04 -0700500int device_schedule_callback_owner(struct device *dev,
501 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400502{
503 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700504 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400505}
Alan Stern523ded72007-04-26 00:12:04 -0700506EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400507
James Bottomley34bb61f2005-09-06 16:56:51 -0700508static void klist_children_get(struct klist_node *n)
509{
510 struct device *dev = container_of(n, struct device, knode_parent);
511
512 get_device(dev);
513}
514
515static void klist_children_put(struct klist_node *n)
516{
517 struct device *dev = container_of(n, struct device, knode_parent);
518
519 put_device(dev);
520}
521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800523 * device_initialize - init device structure.
524 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800526 * This prepares the device for use by other layers,
527 * including adding it to the device hierarchy.
528 * It is the first half of device_register(), if called by
529 * that, though it can also be called separately, so one
530 * may use @dev's fields (e.g. the refcount).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532void device_initialize(struct device *dev)
533{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600534 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700535 kobject_init(&dev->kobj, &device_ktype);
James Bottomley34bb61f2005-09-06 16:56:51 -0700536 klist_init(&dev->klist_children, klist_children_get,
537 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700539 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800540 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900541 spin_lock_init(&dev->devres_lock);
542 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700543 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800544 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
546
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100547#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sieversda231fd2007-11-21 17:29:15 +0100548static struct kobject *get_device_parent(struct device *dev,
549 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100550{
Kay Sieversda231fd2007-11-21 17:29:15 +0100551 /* class devices without a parent live in /sys/class/<classname>/ */
Dmitry Torokhov3eb215d2007-10-07 12:22:21 -0400552 if (dev->class && (!parent || parent->class != dev->class))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700553 return &dev->class->p->class_subsys.kobj;
Kay Sieversda231fd2007-11-21 17:29:15 +0100554 /* all other devices keep their parent */
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100555 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100556 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100557
Cornelia Huckc744aea2007-01-08 20:16:44 +0100558 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100559}
Kay Sieversda231fd2007-11-21 17:29:15 +0100560
561static inline void cleanup_device_parent(struct device *dev) {}
Cornelia Huck63b69712008-01-21 16:09:44 +0100562static inline void cleanup_glue_dir(struct device *dev,
563 struct kobject *glue_dir) {}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100564#else
Kay Sievers86406242007-03-14 03:25:56 +0100565static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700566{
Kay Sievers86406242007-03-14 03:25:56 +0100567 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700568
Kay Sievers86406242007-03-14 03:25:56 +0100569 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800570 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600571 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700572
Kay Sievers86406242007-03-14 03:25:56 +0100573 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700574}
575
Kay Sieversda231fd2007-11-21 17:29:15 +0100576static struct kobject *get_device_parent(struct device *dev,
577 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100578{
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800579 int retval;
580
Kay Sievers86406242007-03-14 03:25:56 +0100581 if (dev->class) {
582 struct kobject *kobj = NULL;
583 struct kobject *parent_kobj;
584 struct kobject *k;
585
586 /*
587 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100588 * Class-devices with a non class-device as parent, live
589 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100590 */
591 if (parent == NULL)
592 parent_kobj = virtual_device_parent(dev);
593 else if (parent->class)
594 return &parent->kobj;
595 else
596 parent_kobj = &parent->kobj;
597
598 /* find our class-directory at the parent and reference it */
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500599 spin_lock(&dev->class->p->class_dirs.list_lock);
600 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100601 if (k->parent == parent_kobj) {
602 kobj = kobject_get(k);
603 break;
604 }
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500605 spin_unlock(&dev->class->p->class_dirs.list_lock);
Kay Sievers86406242007-03-14 03:25:56 +0100606 if (kobj)
607 return kobj;
608
609 /* or create a new class-directory at the parent device */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800610 k = kobject_create();
611 if (!k)
612 return NULL;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500613 k->kset = &dev->class->p->class_dirs;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700614 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800615 if (retval < 0) {
616 kobject_put(k);
617 return NULL;
618 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100619 /* do not emit an uevent for this simple "glue" directory */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800620 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100621 }
622
623 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100624 return &parent->kobj;
625 return NULL;
626}
Kay Sieversda231fd2007-11-21 17:29:15 +0100627
Cornelia Huck63b69712008-01-21 16:09:44 +0100628static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100629{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100630 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100631 if (!glue_dir || !dev->class ||
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500632 glue_dir->kset != &dev->class->p->class_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100633 return;
634
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100635 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100636}
Cornelia Huck63b69712008-01-21 16:09:44 +0100637
638static void cleanup_device_parent(struct device *dev)
639{
640 cleanup_glue_dir(dev, dev->kobj.parent);
641}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100642#endif
Kay Sievers86406242007-03-14 03:25:56 +0100643
Cornelia Huck63b69712008-01-21 16:09:44 +0100644static void setup_parent(struct device *dev, struct device *parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100645{
646 struct kobject *kobj;
647 kobj = get_device_parent(dev, parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +0100648 if (kobj)
649 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100650}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100651
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700652static int device_add_class_symlinks(struct device *dev)
653{
654 int error;
655
656 if (!dev->class)
657 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100658
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700659 error = sysfs_create_link(&dev->kobj,
660 &dev->class->p->class_subsys.kobj,
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700661 "subsystem");
662 if (error)
663 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100664
665#ifdef CONFIG_SYSFS_DEPRECATED
666 /* stacked class devices need a symlink in the class directory */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700667 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800668 device_is_not_partition(dev)) {
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700669 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500670 &dev->kobj, dev->bus_id);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700671 if (error)
672 goto out_subsys;
673 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100674
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800675 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100676 struct device *parent = dev->parent;
677 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700678
Kay Sieversda231fd2007-11-21 17:29:15 +0100679 /*
680 * stacked class devices have the 'device' link
681 * pointing to the bus device instead of the parent
682 */
683 while (parent->class && !parent->bus && parent->parent)
684 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700685
Kay Sieversda231fd2007-11-21 17:29:15 +0100686 error = sysfs_create_link(&dev->kobj,
687 &parent->kobj,
688 "device");
689 if (error)
690 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700691
Kay Sieversda231fd2007-11-21 17:29:15 +0100692 class_name = make_class_name(dev->class->name,
693 &dev->kobj);
694 if (class_name)
695 error = sysfs_create_link(&dev->parent->kobj,
696 &dev->kobj, class_name);
697 kfree(class_name);
698 if (error)
699 goto out_device;
700 }
701 return 0;
702
703out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800704 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100705 sysfs_remove_link(&dev->kobj, "device");
706out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700707 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800708 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700709 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
710 dev->bus_id);
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700711#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100712 /* link in the class directory pointing to the device */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700713 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
714 &dev->kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100715 if (error)
716 goto out_subsys;
717
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800718 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700719 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
720 "device");
721 if (error)
722 goto out_busid;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700723 }
724 return 0;
725
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700726out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700727 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100728#endif
729
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700730out_subsys:
731 sysfs_remove_link(&dev->kobj, "subsystem");
732out:
733 return error;
734}
735
736static void device_remove_class_symlinks(struct device *dev)
737{
738 if (!dev->class)
739 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100740
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700741#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800742 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700743 char *class_name;
744
745 class_name = make_class_name(dev->class->name, &dev->kobj);
746 if (class_name) {
747 sysfs_remove_link(&dev->parent->kobj, class_name);
748 kfree(class_name);
749 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700750 sysfs_remove_link(&dev->kobj, "device");
751 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100752
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700753 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800754 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700755 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
756 dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100757#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800758 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100759 sysfs_remove_link(&dev->kobj, "device");
760
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700761 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100762#endif
763
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700764 sysfs_remove_link(&dev->kobj, "subsystem");
765}
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000768 * dev_set_name - set a device name
769 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700770 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000771 */
772int dev_set_name(struct device *dev, const char *fmt, ...)
773{
774 va_list vargs;
775
776 va_start(vargs, fmt);
777 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
778 va_end(vargs);
779 return 0;
780}
781EXPORT_SYMBOL_GPL(dev_set_name);
782
783/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700784 * device_to_dev_kobj - select a /sys/dev/ directory for the device
785 * @dev: device
786 *
787 * By default we select char/ for new entries. Setting class->dev_obj
788 * to NULL prevents an entry from being created. class->dev_kobj must
789 * be set (or cleared) before any devices are registered to the class
790 * otherwise device_create_sys_dev_entry() and
791 * device_remove_sys_dev_entry() will disagree about the the presence
792 * of the link.
793 */
794static struct kobject *device_to_dev_kobj(struct device *dev)
795{
796 struct kobject *kobj;
797
798 if (dev->class)
799 kobj = dev->class->dev_kobj;
800 else
801 kobj = sysfs_dev_char_kobj;
802
803 return kobj;
804}
805
806static int device_create_sys_dev_entry(struct device *dev)
807{
808 struct kobject *kobj = device_to_dev_kobj(dev);
809 int error = 0;
810 char devt_str[15];
811
812 if (kobj) {
813 format_dev_t(devt_str, dev->devt);
814 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
815 }
816
817 return error;
818}
819
820static void device_remove_sys_dev_entry(struct device *dev)
821{
822 struct kobject *kobj = device_to_dev_kobj(dev);
823 char devt_str[15];
824
825 if (kobj) {
826 format_dev_t(devt_str, dev->devt);
827 sysfs_remove_link(kobj, devt_str);
828 }
829}
830
831/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800832 * device_add - add device to device hierarchy.
833 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800835 * This is part 2 of device_register(), though may be called
836 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800838 * This adds it to the kobject hierarchy via kobject_add(), adds it
839 * to the global and sibling lists for the device, then
840 * adds it to the other relevant subsystems of the driver model.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 */
842int device_add(struct device *dev)
843{
844 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200845 struct class_interface *class_intf;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100846 int error;
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 dev = get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100849 if (!dev || !strlen(dev->bus_id)) {
850 error = -EINVAL;
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100851 goto Done;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800854 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100857 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Yinghai Lu0d358f22008-02-19 03:20:41 -0800859 /* use parent numa_node */
860 if (parent)
861 set_dev_node(dev, dev_to_node(parent));
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 /* first, register with generic layer. */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700864 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100865 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200867
Brian Walsh37022642006-08-14 22:43:19 -0700868 /* notify platform of device entry */
869 if (platform_notify)
870 platform_notify(dev);
871
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000872 /* notify clients of device entry (new way) */
873 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700874 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000875 BUS_NOTIFY_ADD_DEVICE, dev);
876
Tejun Heoad6a1e12007-06-14 03:45:17 +0900877 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200878 if (error)
879 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200880
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700881 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900882 error = device_create_file(dev, &devt_attr);
883 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200884 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -0700885
886 error = device_create_sys_dev_entry(dev);
887 if (error)
888 goto devtattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700889 }
890
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700891 error = device_add_class_symlinks(dev);
892 if (error)
893 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700894 error = device_add_attrs(dev);
895 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700896 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700897 error = bus_add_device(dev);
898 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 goto BusError;
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100900 error = device_pm_add(dev);
901 if (error)
902 goto PMError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200903 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800904 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400906 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700908 if (dev->class) {
Dave Youngf75b1c62008-05-28 09:28:39 -0700909 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200910 /* tie the class to the device */
Greg Kroah-Hartman97ae69f2008-05-28 09:28:39 -0700911 list_add_tail(&dev->node, &dev->class->p->class_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200912
913 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -0700914 list_for_each_entry(class_intf,
915 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200916 if (class_intf->add_dev)
917 class_intf->add_dev(dev, class_intf);
Dave Youngf75b1c62008-05-28 09:28:39 -0700918 mutex_unlock(&dev->class->p->class_mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700919 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 Done:
921 put_device(dev);
922 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 PMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100924 bus_remove_device(dev);
925 BusError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000926 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700927 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000928 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000929 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700930 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700931 device_remove_class_symlinks(dev);
932 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900933 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -0700934 device_remove_sys_dev_entry(dev);
935 devtattrError:
936 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +0900937 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200938 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900939 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700940 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100941 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 kobject_del(&dev->kobj);
943 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100944 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 if (parent)
946 put_device(parent);
947 goto Done;
948}
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800951 * device_register - register a device with the system.
952 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800954 * This happens in two clean steps - initialize the device
955 * and add it to the system. The two steps can be called
956 * separately, but this is the easiest and most common.
957 * I.e. you should only call the two helpers separately if
958 * have a clearly defined need to use and refcount the device
959 * before it is added to the hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961int device_register(struct device *dev)
962{
963 device_initialize(dev);
964 return device_add(dev);
965}
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800968 * get_device - increment reference count for device.
969 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800971 * This simply forwards the call to kobject_get(), though
972 * we do take care to provide for the case that we get a NULL
973 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800975struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
977 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
978}
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800981 * put_device - decrement reference count.
982 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800984void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200986 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 if (dev)
988 kobject_put(&dev->kobj);
989}
990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800992 * device_del - delete device from system.
993 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800995 * This is the first part of the device unregistration
996 * sequence. This removes the device from the lists we control
997 * from here, has it removed from the other driver model
998 * subsystems it was added to in device_add(), and removes it
999 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001001 * NOTE: this should be called manually _iff_ device_add() was
1002 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001004void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001006 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001007 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001009 device_pm_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -07001011 klist_del(&dev->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001012 if (MAJOR(dev->devt)) {
1013 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001014 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001015 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001016 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001017 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001018
Dave Youngf75b1c62008-05-28 09:28:39 -07001019 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001020 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001021 list_for_each_entry(class_intf,
1022 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001023 if (class_intf->remove_dev)
1024 class_intf->remove_dev(dev, class_intf);
1025 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001026 list_del_init(&dev->node);
Dave Youngf75b1c62008-05-28 09:28:39 -07001027 mutex_unlock(&dev->class->p->class_mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001028 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001029 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001030 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001031 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001033 /*
1034 * Some platform devices are driven without driver attached
1035 * and managed resources may have been acquired. Make sure
1036 * all resources are released.
1037 */
1038 devres_release_all(dev);
1039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 /* Notify the platform of the removal, in case they
1041 * need to do anything...
1042 */
1043 if (platform_notify_remove)
1044 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001045 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07001046 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001047 BUS_NOTIFY_DEL_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001048 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001049 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001051 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052}
1053
1054/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001055 * device_unregister - unregister device from system.
1056 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001058 * We do this in two parts, like we do device_register(). First,
1059 * we remove it from all the subsystems with device_del(), then
1060 * we decrement the reference count via put_device(). If that
1061 * is the final reference count, the device will be cleaned up
1062 * via device_release() above. Otherwise, the structure will
1063 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001065void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001067 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 device_del(dev);
1069 put_device(dev);
1070}
1071
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001072static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001073{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001074 struct klist_node *n = klist_next(i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001075 return n ? container_of(n, struct device, knode_parent) : NULL;
1076}
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001079 * device_for_each_child - device child iterator.
1080 * @parent: parent struct device.
1081 * @data: data for the callback.
1082 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001084 * Iterate over @parent's child devices, and call @fn for each,
1085 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001087 * We check the return of @fn each time. If it returns anything
1088 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001090int device_for_each_child(struct device *parent, void *data,
1091 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001093 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001094 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 int error = 0;
1096
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001097 klist_iter_init(&parent->klist_children, &i);
1098 while ((child = next_device(&i)) && !error)
1099 error = fn(child, data);
1100 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 return error;
1102}
1103
Cornelia Huck5ab69982006-11-16 15:42:07 +01001104/**
1105 * device_find_child - device iterator for locating a particular device.
1106 * @parent: parent struct device
1107 * @data: Data to pass to match function
1108 * @match: Callback function to check device
1109 *
1110 * This is similar to the device_for_each_child() function above, but it
1111 * returns a reference to a device that is 'found' for later use, as
1112 * determined by the @match callback.
1113 *
1114 * The callback should return 0 if the device doesn't match and non-zero
1115 * if it does. If the callback returns non-zero and a reference to the
1116 * current device can be obtained, this function will return to the caller
1117 * and not iterate over any more devices.
1118 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001119struct device *device_find_child(struct device *parent, void *data,
1120 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001121{
1122 struct klist_iter i;
1123 struct device *child;
1124
1125 if (!parent)
1126 return NULL;
1127
1128 klist_iter_init(&parent->klist_children, &i);
1129 while ((child = next_device(&i)))
1130 if (match(child, data) && get_device(child))
1131 break;
1132 klist_iter_exit(&i);
1133 return child;
1134}
1135
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136int __init devices_init(void)
1137{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001138 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1139 if (!devices_kset)
1140 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001141 dev_kobj = kobject_create_and_add("dev", NULL);
1142 if (!dev_kobj)
1143 goto dev_kobj_err;
1144 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1145 if (!sysfs_dev_block_kobj)
1146 goto block_kobj_err;
1147 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1148 if (!sysfs_dev_char_kobj)
1149 goto char_kobj_err;
1150
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001151 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001152
1153 char_kobj_err:
1154 kobject_put(sysfs_dev_block_kobj);
1155 block_kobj_err:
1156 kobject_put(dev_kobj);
1157 dev_kobj_err:
1158 kset_unregister(devices_kset);
1159 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
1161
1162EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001163EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
1165EXPORT_SYMBOL_GPL(device_initialize);
1166EXPORT_SYMBOL_GPL(device_add);
1167EXPORT_SYMBOL_GPL(device_register);
1168
1169EXPORT_SYMBOL_GPL(device_del);
1170EXPORT_SYMBOL_GPL(device_unregister);
1171EXPORT_SYMBOL_GPL(get_device);
1172EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
1174EXPORT_SYMBOL_GPL(device_create_file);
1175EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001176
1177
1178static void device_create_release(struct device *dev)
1179{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001180 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001181 kfree(dev);
1182}
1183
1184/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001185 * device_create_vargs - creates a device and registers it with sysfs
1186 * @class: pointer to the struct class that this device should be registered to
1187 * @parent: pointer to the parent struct device of this new device, if any
1188 * @devt: the dev_t for the char device to be added
1189 * @drvdata: the data to be added to the device for callbacks
1190 * @fmt: string for the device's name
1191 * @args: va_list for the device's name
1192 *
1193 * This function can be used by char device classes. A struct device
1194 * will be created in sysfs, registered to the specified class.
1195 *
1196 * A "dev" file will be created, showing the dev_t for the device, if
1197 * the dev_t is not 0,0.
1198 * If a pointer to a parent struct device is passed in, the newly created
1199 * struct device will be a child of that device in sysfs.
1200 * The pointer to the struct device will be returned from the call.
1201 * Any further sysfs files that might be required can be created using this
1202 * pointer.
1203 *
1204 * Note: the struct class passed to this function must have previously
1205 * been created with a call to class_create().
1206 */
1207struct device *device_create_vargs(struct class *class, struct device *parent,
1208 dev_t devt, void *drvdata, const char *fmt,
1209 va_list args)
1210{
1211 struct device *dev = NULL;
1212 int retval = -ENODEV;
1213
1214 if (class == NULL || IS_ERR(class))
1215 goto error;
1216
1217 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1218 if (!dev) {
1219 retval = -ENOMEM;
1220 goto error;
1221 }
1222
1223 dev->devt = devt;
1224 dev->class = class;
1225 dev->parent = parent;
1226 dev->release = device_create_release;
1227 dev_set_drvdata(dev, drvdata);
1228
1229 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1230 retval = device_register(dev);
1231 if (retval)
1232 goto error;
1233
1234 return dev;
1235
1236error:
1237 kfree(dev);
1238 return ERR_PTR(retval);
1239}
1240EXPORT_SYMBOL_GPL(device_create_vargs);
1241
1242/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001243 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001244 * @class: pointer to the struct class that this device should be registered to
1245 * @parent: pointer to the parent struct device of this new device, if any
1246 * @devt: the dev_t for the char device to be added
1247 * @drvdata: the data to be added to the device for callbacks
1248 * @fmt: string for the device's name
1249 *
1250 * This function can be used by char device classes. A struct device
1251 * will be created in sysfs, registered to the specified class.
1252 *
1253 * A "dev" file will be created, showing the dev_t for the device, if
1254 * the dev_t is not 0,0.
1255 * If a pointer to a parent struct device is passed in, the newly created
1256 * struct device will be a child of that device in sysfs.
1257 * The pointer to the struct device will be returned from the call.
1258 * Any further sysfs files that might be required can be created using this
1259 * pointer.
1260 *
1261 * Note: the struct class passed to this function must have previously
1262 * been created with a call to class_create().
1263 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001264struct device *device_create(struct class *class, struct device *parent,
1265 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001266{
1267 va_list vargs;
1268 struct device *dev;
1269
1270 va_start(vargs, fmt);
1271 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1272 va_end(vargs);
1273 return dev;
1274}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001275EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001276
Dave Youngcd354492008-01-28 16:56:11 +08001277static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001278{
Dave Youngcd354492008-01-28 16:56:11 +08001279 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001280
Dave Youngcd354492008-01-28 16:56:11 +08001281 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001282}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001283
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001284/**
1285 * device_destroy - removes a device that was created with device_create()
1286 * @class: pointer to the struct class that this device was registered with
1287 * @devt: the dev_t of the device that was previously registered
1288 *
1289 * This call unregisters and cleans up a device that was created with a
1290 * call to device_create().
1291 */
1292void device_destroy(struct class *class, dev_t devt)
1293{
1294 struct device *dev;
1295
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001296 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001297 if (dev) {
1298 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001299 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001300 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001301}
1302EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001303
1304/**
1305 * device_rename - renames a device
1306 * @dev: the pointer to the struct device to be renamed
1307 * @new_name: the new name of the device
1308 */
1309int device_rename(struct device *dev, char *new_name)
1310{
1311 char *old_class_name = NULL;
1312 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001313 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001314 int error;
1315
1316 dev = get_device(dev);
1317 if (!dev)
1318 return -EINVAL;
1319
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001320 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001321 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001322
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001323#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001324 if ((dev->class) && (dev->parent))
1325 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001326#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001327
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001328 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1329 if (!old_device_name) {
1330 error = -ENOMEM;
1331 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001332 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001333 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001334 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1335
1336 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001337 if (error) {
1338 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1339 goto out;
1340 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001341
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001342#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001343 if (old_class_name) {
1344 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1345 if (new_class_name) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001346 error = sysfs_create_link_nowarn(&dev->parent->kobj,
1347 &dev->kobj,
1348 new_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001349 if (error)
1350 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001351 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1352 }
1353 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001354#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001355 if (dev->class) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001356 error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
1357 &dev->kobj, dev->bus_id);
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001358 if (error)
1359 goto out;
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001360 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -05001361 old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001362 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001363#endif
1364
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001365out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001366 put_device(dev);
1367
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001368 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001369 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001370 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001371
1372 return error;
1373}
Johannes Berga2807db2007-02-28 12:38:31 +01001374EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001375
1376static int device_move_class_links(struct device *dev,
1377 struct device *old_parent,
1378 struct device *new_parent)
1379{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001380 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001381#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001382 char *class_name;
1383
1384 class_name = make_class_name(dev->class->name, &dev->kobj);
1385 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001386 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001387 goto out;
1388 }
1389 if (old_parent) {
1390 sysfs_remove_link(&dev->kobj, "device");
1391 sysfs_remove_link(&old_parent->kobj, class_name);
1392 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001393 if (new_parent) {
1394 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1395 "device");
1396 if (error)
1397 goto out;
1398 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1399 class_name);
1400 if (error)
1401 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001402 } else
Cornelia Huckc744aea2007-01-08 20:16:44 +01001403 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001404out:
1405 kfree(class_name);
1406 return error;
1407#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001408 if (old_parent)
1409 sysfs_remove_link(&dev->kobj, "device");
1410 if (new_parent)
1411 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1412 "device");
1413 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001414#endif
1415}
1416
1417/**
1418 * device_move - moves a device to a new parent
1419 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001420 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001421 */
1422int device_move(struct device *dev, struct device *new_parent)
1423{
1424 int error;
1425 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001426 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001427
1428 dev = get_device(dev);
1429 if (!dev)
1430 return -EINVAL;
1431
Cornelia Huck8a824722006-11-20 17:07:51 +01001432 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001433 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001434
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001435 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001436 __func__, new_parent ? new_parent->bus_id : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001437 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001438 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001439 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001440 put_device(new_parent);
1441 goto out;
1442 }
1443 old_parent = dev->parent;
1444 dev->parent = new_parent;
1445 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001446 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001447 if (new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001448 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001449 set_dev_node(dev, dev_to_node(new_parent));
1450 }
1451
Cornelia Huck8a824722006-11-20 17:07:51 +01001452 if (!dev->class)
1453 goto out_put;
1454 error = device_move_class_links(dev, old_parent, new_parent);
1455 if (error) {
1456 /* We ignore errors on cleanup since we're hosed anyway... */
1457 device_move_class_links(dev, new_parent, old_parent);
1458 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001459 if (new_parent)
1460 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001461 dev->parent = old_parent;
1462 if (old_parent) {
Cornelia Huck8a824722006-11-20 17:07:51 +01001463 klist_add_tail(&dev->knode_parent,
1464 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001465 set_dev_node(dev, dev_to_node(old_parent));
1466 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001467 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001468 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001469 put_device(new_parent);
1470 goto out;
1471 }
1472out_put:
1473 put_device(old_parent);
1474out:
1475 put_device(dev);
1476 return error;
1477}
Cornelia Huck8a824722006-11-20 17:07:51 +01001478EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001479
1480/**
1481 * device_shutdown - call ->shutdown() on each device to shutdown.
1482 */
1483void device_shutdown(void)
1484{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001485 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001486
1487 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1488 kobj.entry) {
1489 if (dev->bus && dev->bus->shutdown) {
1490 dev_dbg(dev, "shutdown\n");
1491 dev->bus->shutdown(dev);
1492 } else if (dev->driver && dev->driver->shutdown) {
1493 dev_dbg(dev, "shutdown\n");
1494 dev->driver->shutdown(dev);
1495 }
1496 }
Dan Williamse105b8b2008-04-21 10:51:07 -07001497 kobject_put(sysfs_dev_char_kobj);
1498 kobject_put(sysfs_dev_block_kobj);
1499 kobject_put(dev_kobj);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001500}