blob: 4a67cc0c8b37aaeeec97e27eef04752a52504d1a [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>
Dave Youngf75b1c62008-05-28 09:28:39 -070023#include <linux/mutex.h>
Shaohua Li401097e2009-05-12 13:37:57 -070024#include <linux/async.h>
Peter Chenaf8db152011-11-15 21:52:29 +010025#include <linux/pm_runtime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include "base.h"
28#include "power/power.h"
29
Andi Kleene52eec12010-09-08 16:54:17 +020030#ifdef CONFIG_SYSFS_DEPRECATED
31#ifdef CONFIG_SYSFS_DEPRECATED_V2
32long sysfs_deprecated = 1;
33#else
34long sysfs_deprecated = 0;
35#endif
36static __init int sysfs_deprecated_setup(char *arg)
37{
38 return strict_strtol(arg, 10, &sysfs_deprecated);
39}
40early_param("sysfs.deprecated", sysfs_deprecated_setup);
41#endif
42
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080043int (*platform_notify)(struct device *dev) = NULL;
44int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070045static struct kobject *dev_kobj;
46struct kobject *sysfs_dev_char_kobj;
47struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080049#ifdef CONFIG_BLOCK
50static inline int device_is_not_partition(struct device *dev)
51{
52 return !(dev->type == &part_type);
53}
54#else
55static inline int device_is_not_partition(struct device *dev)
56{
57 return 1;
58}
59#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Alan Stern3e956372006-06-16 17:10:48 -040061/**
62 * dev_driver_string - Return a device's driver name, if at all possible
63 * @dev: struct device to get the name of
64 *
65 * Will return the device's driver's name if it is bound to a device. If
66 * the device is not bound to a device, it will return the name of the bus
67 * it is attached to. If it is not attached to a bus either, an empty
68 * string will be returned.
69 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070070const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040071{
Alan Stern35899722009-12-04 11:06:57 -050072 struct device_driver *drv;
73
74 /* dev->driver can change to NULL underneath us because of unbinding,
75 * so be careful about accessing it. dev->bus and dev->class should
76 * never change once they are set, so they don't need special care.
77 */
78 drv = ACCESS_ONCE(dev->driver);
79 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +010080 (dev->bus ? dev->bus->name :
81 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040082}
Matthew Wilcox310a9222006-09-23 23:35:04 -060083EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085#define to_dev(obj) container_of(obj, struct device, kobj)
86#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
87
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080088static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
89 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080091 struct device_attribute *dev_attr = to_dev_attr(attr);
92 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050093 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040096 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080097 if (ret >= (ssize_t)PAGE_SIZE) {
98 print_symbol("dev_attr_show: %s returned bad count\n",
99 (unsigned long)dev_attr->show);
100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 return ret;
102}
103
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800104static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
105 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800107 struct device_attribute *dev_attr = to_dev_attr(attr);
108 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500109 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400112 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 return ret;
114}
115
Emese Revfy52cf25d2010-01-19 02:58:23 +0100116static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 .show = dev_attr_show,
118 .store = dev_attr_store,
119};
120
Kay Sieversca22e562011-12-14 14:29:38 -0800121#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
122
123ssize_t device_store_ulong(struct device *dev,
124 struct device_attribute *attr,
125 const char *buf, size_t size)
126{
127 struct dev_ext_attribute *ea = to_ext_attr(attr);
128 char *end;
129 unsigned long new = simple_strtoul(buf, &end, 0);
130 if (end == buf)
131 return -EINVAL;
132 *(unsigned long *)(ea->var) = new;
133 /* Always return full write size even if we didn't consume all */
134 return size;
135}
136EXPORT_SYMBOL_GPL(device_store_ulong);
137
138ssize_t device_show_ulong(struct device *dev,
139 struct device_attribute *attr,
140 char *buf)
141{
142 struct dev_ext_attribute *ea = to_ext_attr(attr);
143 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
144}
145EXPORT_SYMBOL_GPL(device_show_ulong);
146
147ssize_t device_store_int(struct device *dev,
148 struct device_attribute *attr,
149 const char *buf, size_t size)
150{
151 struct dev_ext_attribute *ea = to_ext_attr(attr);
152 char *end;
153 long new = simple_strtol(buf, &end, 0);
154 if (end == buf || new > INT_MAX || new < INT_MIN)
155 return -EINVAL;
156 *(int *)(ea->var) = new;
157 /* Always return full write size even if we didn't consume all */
158 return size;
159}
160EXPORT_SYMBOL_GPL(device_store_int);
161
162ssize_t device_show_int(struct device *dev,
163 struct device_attribute *attr,
164 char *buf)
165{
166 struct dev_ext_attribute *ea = to_ext_attr(attr);
167
168 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
169}
170EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/**
173 * device_release - free device structure.
174 * @kobj: device's kobject.
175 *
176 * This is called once the reference count for the object
177 * reaches 0. We forward the call to the device's release
178 * method, which should handle actually freeing the structure.
179 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800180static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800182 struct device *dev = to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800183 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 if (dev->release)
186 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200187 else if (dev->type && dev->type->release)
188 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700189 else if (dev->class && dev->class->dev_release)
190 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700191 else
192 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800193 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100194 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800195 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196}
197
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700198static const void *device_namespace(struct kobject *kobj)
199{
200 struct device *dev = to_dev(kobj);
201 const void *ns = NULL;
202
203 if (dev->class && dev->class->ns_type)
204 ns = dev->class->namespace(dev);
205
206 return ns;
207}
208
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600209static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 .release = device_release,
211 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700212 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
215
Kay Sievers312c0042005-11-16 09:00:00 +0100216static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218 struct kobj_type *ktype = get_ktype(kobj);
219
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600220 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 struct device *dev = to_dev(kobj);
222 if (dev->bus)
223 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700224 if (dev->class)
225 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 }
227 return 0;
228}
229
Kay Sievers312c0042005-11-16 09:00:00 +0100230static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
232 struct device *dev = to_dev(kobj);
233
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700234 if (dev->bus)
235 return dev->bus->name;
236 if (dev->class)
237 return dev->class->name;
238 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
Kay Sievers7eff2e72007-08-14 15:15:12 +0200241static int dev_uevent(struct kset *kset, struct kobject *kobj,
242 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 int retval = 0;
246
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200247 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700248 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200249 const char *tmp;
250 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400251 umode_t mode = 0;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200252
Kay Sievers7eff2e72007-08-14 15:15:12 +0200253 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
254 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sieverse454cea2009-09-18 23:01:12 +0200255 name = device_get_devnode(dev, &mode, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200256 if (name) {
257 add_uevent_var(env, "DEVNAME=%s", name);
258 kfree(tmp);
Kay Sieverse454cea2009-09-18 23:01:12 +0200259 if (mode)
260 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200261 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700262 }
263
Kay Sievers414264f2007-03-12 21:08:57 +0100264 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200265 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100266
Kay Sievers239378f2006-10-07 21:54:55 +0200267 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200268 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200269
Kay Sievers7eff2e72007-08-14 15:15:12 +0200270 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100271 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200272 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200273 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800274 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100275 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 }
277
Kay Sievers7eff2e72007-08-14 15:15:12 +0200278 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700279 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200280 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200281 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800282 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100283 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800284 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200285 }
286
Stefan Weileef35c22010-08-06 21:11:15 +0200287 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200288 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200289 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200290 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800291 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100292 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800293 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700294 }
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 return retval;
297}
298
Emese Revfy9cd43612009-12-31 14:52:51 +0100299static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100300 .filter = dev_uevent_filter,
301 .name = dev_uevent_name,
302 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303};
304
Kay Sievers16574dc2007-04-06 01:40:38 +0200305static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
306 char *buf)
307{
308 struct kobject *top_kobj;
309 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200310 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200311 int i;
312 size_t count = 0;
313 int retval;
314
315 /* search the kset, the device belongs to */
316 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200317 while (!top_kobj->kset && top_kobj->parent)
318 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200319 if (!top_kobj->kset)
320 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200321
Kay Sievers16574dc2007-04-06 01:40:38 +0200322 kset = top_kobj->kset;
323 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
324 goto out;
325
326 /* respect filter */
327 if (kset->uevent_ops && kset->uevent_ops->filter)
328 if (!kset->uevent_ops->filter(kset, &dev->kobj))
329 goto out;
330
Kay Sievers7eff2e72007-08-14 15:15:12 +0200331 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
332 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200333 return -ENOMEM;
334
Kay Sievers16574dc2007-04-06 01:40:38 +0200335 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200336 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200337 if (retval)
338 goto out;
339
340 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200341 for (i = 0; i < env->envp_idx; i++)
342 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200343out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200344 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200345 return count;
346}
347
Kay Sieversa7fd6702005-10-01 14:49:43 +0200348static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
349 const char *buf, size_t count)
350{
Kay Sievers60a96a52007-07-08 22:29:26 +0200351 enum kobject_action action;
352
Kay Sievers3f5468c2010-01-14 22:54:37 +0100353 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200354 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100355 else
356 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200357 return count;
358}
359
Tejun Heoad6a1e12007-06-14 03:45:17 +0900360static struct device_attribute uevent_attr =
361 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
362
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500363static int device_add_attributes(struct device *dev,
364 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700365{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700366 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500367 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700368
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500369 if (attrs) {
370 for (i = 0; attr_name(attrs[i]); i++) {
371 error = device_create_file(dev, &attrs[i]);
372 if (error)
373 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700374 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500375 if (error)
376 while (--i >= 0)
377 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700378 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700379 return error;
380}
381
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500382static void device_remove_attributes(struct device *dev,
383 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700384{
385 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500386
387 if (attrs)
388 for (i = 0; attr_name(attrs[i]); i++)
389 device_remove_file(dev, &attrs[i]);
390}
391
Stefan Achatzc97415a2010-11-26 19:57:29 +0000392static int device_add_bin_attributes(struct device *dev,
393 struct bin_attribute *attrs)
394{
395 int error = 0;
396 int i;
397
398 if (attrs) {
399 for (i = 0; attr_name(attrs[i]); i++) {
400 error = device_create_bin_file(dev, &attrs[i]);
401 if (error)
402 break;
403 }
404 if (error)
405 while (--i >= 0)
406 device_remove_bin_file(dev, &attrs[i]);
407 }
408 return error;
409}
410
411static void device_remove_bin_attributes(struct device *dev,
412 struct bin_attribute *attrs)
413{
414 int i;
415
416 if (attrs)
417 for (i = 0; attr_name(attrs[i]); i++)
418 device_remove_bin_file(dev, &attrs[i]);
419}
420
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500421static int device_add_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700422 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500423{
424 int error = 0;
425 int i;
426
427 if (groups) {
428 for (i = 0; groups[i]; i++) {
429 error = sysfs_create_group(&dev->kobj, groups[i]);
430 if (error) {
431 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800432 sysfs_remove_group(&dev->kobj,
433 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500434 break;
435 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700436 }
437 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500438 return error;
439}
440
441static void device_remove_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700442 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500443{
444 int i;
445
446 if (groups)
447 for (i = 0; groups[i]; i++)
448 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700449}
450
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700451static int device_add_attrs(struct device *dev)
452{
453 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700454 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500455 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700456
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500457 if (class) {
458 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200459 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500460 return error;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000461 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
462 if (error)
463 goto err_remove_class_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700464 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200465
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500466 if (type) {
467 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200468 if (error)
Stefan Achatzc97415a2010-11-26 19:57:29 +0000469 goto err_remove_class_bin_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200470 }
471
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500472 error = device_add_groups(dev, dev->groups);
473 if (error)
474 goto err_remove_type_groups;
475
476 return 0;
477
478 err_remove_type_groups:
479 if (type)
480 device_remove_groups(dev, type->groups);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000481 err_remove_class_bin_attrs:
482 if (class)
483 device_remove_bin_attributes(dev, class->dev_bin_attrs);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500484 err_remove_class_attrs:
485 if (class)
486 device_remove_attributes(dev, class->dev_attrs);
487
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700488 return error;
489}
490
491static void device_remove_attrs(struct device *dev)
492{
493 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700494 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700495
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500496 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200497
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500498 if (type)
499 device_remove_groups(dev, type->groups);
500
Stefan Achatzc97415a2010-11-26 19:57:29 +0000501 if (class) {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500502 device_remove_attributes(dev, class->dev_attrs);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000503 device_remove_bin_attributes(dev, class->dev_bin_attrs);
504 }
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700505}
506
507
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700508static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
509 char *buf)
510{
511 return print_dev_t(buf, dev->devt);
512}
513
Tejun Heoad6a1e12007-06-14 03:45:17 +0900514static struct device_attribute devt_attr =
515 __ATTR(dev, S_IRUGO, show_dev, NULL);
516
Kay Sieversca22e562011-12-14 14:29:38 -0800517/* /sys/devices/ */
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600518struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800521 * device_create_file - create sysfs attribute file for device.
522 * @dev: device.
523 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200525int device_create_file(struct device *dev,
526 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100529 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 return error;
532}
533
534/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800535 * device_remove_file - remove sysfs attribute file.
536 * @dev: device.
537 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200539void device_remove_file(struct device *dev,
540 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100542 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544}
545
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700546/**
547 * device_create_bin_file - create sysfs binary attribute file for device.
548 * @dev: device.
549 * @attr: device binary attribute descriptor.
550 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200551int device_create_bin_file(struct device *dev,
552 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700553{
554 int error = -EINVAL;
555 if (dev)
556 error = sysfs_create_bin_file(&dev->kobj, attr);
557 return error;
558}
559EXPORT_SYMBOL_GPL(device_create_bin_file);
560
561/**
562 * device_remove_bin_file - remove sysfs binary attribute file
563 * @dev: device.
564 * @attr: device binary attribute descriptor.
565 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200566void device_remove_bin_file(struct device *dev,
567 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700568{
569 if (dev)
570 sysfs_remove_bin_file(&dev->kobj, attr);
571}
572EXPORT_SYMBOL_GPL(device_remove_bin_file);
573
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400574/**
Alan Stern523ded72007-04-26 00:12:04 -0700575 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400576 * @dev: device.
577 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700578 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400579 *
580 * Attribute methods must not unregister themselves or their parent device
581 * (which would amount to the same thing). Attempts to do so will deadlock,
582 * since unregistration is mutually exclusive with driver callbacks.
583 *
584 * Instead methods can call this routine, which will attempt to allocate
585 * and schedule a workqueue request to call back @func with @dev as its
586 * argument in the workqueue's process context. @dev will be pinned until
587 * @func returns.
588 *
Alan Stern523ded72007-04-26 00:12:04 -0700589 * This routine is usually called via the inline device_schedule_callback(),
590 * which automatically sets @owner to THIS_MODULE.
591 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400592 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700593 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400594 *
595 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
596 * underlying sysfs routine (since it is intended for use by attribute
597 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
598 */
Alan Stern523ded72007-04-26 00:12:04 -0700599int device_schedule_callback_owner(struct device *dev,
600 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400601{
602 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700603 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400604}
Alan Stern523ded72007-04-26 00:12:04 -0700605EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400606
James Bottomley34bb61f2005-09-06 16:56:51 -0700607static void klist_children_get(struct klist_node *n)
608{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800609 struct device_private *p = to_device_private_parent(n);
610 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700611
612 get_device(dev);
613}
614
615static void klist_children_put(struct klist_node *n)
616{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800617 struct device_private *p = to_device_private_parent(n);
618 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700619
620 put_device(dev);
621}
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800624 * device_initialize - init device structure.
625 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 *
Cornelia Huck57394112008-09-03 18:26:40 +0200627 * This prepares the device for use by other layers by initializing
628 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800629 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200630 * that function, though it can also be called separately, so one
631 * may use @dev's fields. In particular, get_device()/put_device()
632 * may be used for reference counting of @dev after calling this
633 * function.
634 *
635 * NOTE: Use put_device() to give up your reference instead of freeing
636 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638void device_initialize(struct device *dev)
639{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600640 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700641 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000643 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100644 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900645 spin_lock_init(&dev->devres_lock);
646 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400647 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800648 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
Kay Sievers86406242007-03-14 03:25:56 +0100651static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700652{
Kay Sievers86406242007-03-14 03:25:56 +0100653 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700654
Kay Sievers86406242007-03-14 03:25:56 +0100655 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800656 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600657 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700658
Kay Sievers86406242007-03-14 03:25:56 +0100659 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700660}
661
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700662struct class_dir {
663 struct kobject kobj;
664 struct class *class;
665};
666
667#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
668
669static void class_dir_release(struct kobject *kobj)
670{
671 struct class_dir *dir = to_class_dir(kobj);
672 kfree(dir);
673}
674
675static const
676struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
677{
678 struct class_dir *dir = to_class_dir(kobj);
679 return dir->class->ns_type;
680}
681
682static struct kobj_type class_dir_ktype = {
683 .release = class_dir_release,
684 .sysfs_ops = &kobj_sysfs_ops,
685 .child_ns_type = class_dir_child_ns_type
686};
687
688static struct kobject *
689class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
690{
691 struct class_dir *dir;
692 int retval;
693
694 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
695 if (!dir)
696 return NULL;
697
698 dir->class = class;
699 kobject_init(&dir->kobj, &class_dir_ktype);
700
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100701 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700702
703 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
704 if (retval < 0) {
705 kobject_put(&dir->kobj);
706 return NULL;
707 }
708 return &dir->kobj;
709}
710
711
Kay Sieversda231fd2007-11-21 17:29:15 +0100712static struct kobject *get_device_parent(struct device *dev,
713 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100714{
Kay Sievers86406242007-03-14 03:25:56 +0100715 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900716 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100717 struct kobject *kobj = NULL;
718 struct kobject *parent_kobj;
719 struct kobject *k;
720
Randy Dunlapead454f2010-09-24 14:36:49 -0700721#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700722 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200723 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700724 if (parent && parent->class == &block_class)
725 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100726 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700727 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700728#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200729
Kay Sievers86406242007-03-14 03:25:56 +0100730 /*
731 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100732 * Class-devices with a non class-device as parent, live
733 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100734 */
735 if (parent == NULL)
736 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700737 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100738 return &parent->kobj;
739 else
740 parent_kobj = &parent->kobj;
741
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900742 mutex_lock(&gdp_mutex);
743
Kay Sievers86406242007-03-14 03:25:56 +0100744 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100745 spin_lock(&dev->class->p->glue_dirs.list_lock);
746 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100747 if (k->parent == parent_kobj) {
748 kobj = kobject_get(k);
749 break;
750 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100751 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900752 if (kobj) {
753 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100754 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900755 }
Kay Sievers86406242007-03-14 03:25:56 +0100756
757 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700758 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100759 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900760 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800761 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100762 }
763
Kay Sieversca22e562011-12-14 14:29:38 -0800764 /* subsystems can specify a default root directory for their devices */
765 if (!parent && dev->bus && dev->bus->dev_root)
766 return &dev->bus->dev_root->kobj;
767
Kay Sievers86406242007-03-14 03:25:56 +0100768 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100769 return &parent->kobj;
770 return NULL;
771}
Kay Sieversda231fd2007-11-21 17:29:15 +0100772
Cornelia Huck63b69712008-01-21 16:09:44 +0100773static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100774{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100775 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100776 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100777 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100778 return;
779
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100780 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100781}
Cornelia Huck63b69712008-01-21 16:09:44 +0100782
783static void cleanup_device_parent(struct device *dev)
784{
785 cleanup_glue_dir(dev, dev->kobj.parent);
786}
Kay Sievers86406242007-03-14 03:25:56 +0100787
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700788static int device_add_class_symlinks(struct device *dev)
789{
790 int error;
791
792 if (!dev->class)
793 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100794
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700795 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100796 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700797 "subsystem");
798 if (error)
799 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100800
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800801 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700802 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
803 "device");
804 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700805 goto out_subsys;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700806 }
Kay Sievers39aba962010-09-04 22:33:14 -0700807
Randy Dunlapead454f2010-09-24 14:36:49 -0700808#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700809 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200810 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700811 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700812#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700813
814 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100815 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700816 &dev->kobj, dev_name(dev));
817 if (error)
818 goto out_device;
819
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700820 return 0;
821
Kay Sievers39aba962010-09-04 22:33:14 -0700822out_device:
823 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100824
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700825out_subsys:
826 sysfs_remove_link(&dev->kobj, "subsystem");
827out:
828 return error;
829}
830
831static void device_remove_class_symlinks(struct device *dev)
832{
833 if (!dev->class)
834 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100835
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800836 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100837 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700838 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700839#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200840 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700841 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700842#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100843 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700844}
845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000847 * dev_set_name - set a device name
848 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700849 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000850 */
851int dev_set_name(struct device *dev, const char *fmt, ...)
852{
853 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100854 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000855
856 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100857 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000858 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100859 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000860}
861EXPORT_SYMBOL_GPL(dev_set_name);
862
863/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700864 * device_to_dev_kobj - select a /sys/dev/ directory for the device
865 * @dev: device
866 *
867 * By default we select char/ for new entries. Setting class->dev_obj
868 * to NULL prevents an entry from being created. class->dev_kobj must
869 * be set (or cleared) before any devices are registered to the class
870 * otherwise device_create_sys_dev_entry() and
871 * device_remove_sys_dev_entry() will disagree about the the presence
872 * of the link.
873 */
874static struct kobject *device_to_dev_kobj(struct device *dev)
875{
876 struct kobject *kobj;
877
878 if (dev->class)
879 kobj = dev->class->dev_kobj;
880 else
881 kobj = sysfs_dev_char_kobj;
882
883 return kobj;
884}
885
886static int device_create_sys_dev_entry(struct device *dev)
887{
888 struct kobject *kobj = device_to_dev_kobj(dev);
889 int error = 0;
890 char devt_str[15];
891
892 if (kobj) {
893 format_dev_t(devt_str, dev->devt);
894 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
895 }
896
897 return error;
898}
899
900static void device_remove_sys_dev_entry(struct device *dev)
901{
902 struct kobject *kobj = device_to_dev_kobj(dev);
903 char devt_str[15];
904
905 if (kobj) {
906 format_dev_t(devt_str, dev->devt);
907 sysfs_remove_link(kobj, devt_str);
908 }
909}
910
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700911int device_private_init(struct device *dev)
912{
913 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
914 if (!dev->p)
915 return -ENOMEM;
916 dev->p->device = dev;
917 klist_init(&dev->p->klist_children, klist_children_get,
918 klist_children_put);
919 return 0;
920}
921
Dan Williamse105b8b2008-04-21 10:51:07 -0700922/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800923 * device_add - add device to device hierarchy.
924 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800926 * This is part 2 of device_register(), though may be called
927 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 *
Cornelia Huck57394112008-09-03 18:26:40 +0200929 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800930 * to the global and sibling lists for the device, then
931 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200932 *
933 * NOTE: _Never_ directly free @dev after calling this function, even
934 * if it returned an error! Always use put_device() to give up your
935 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 */
937int device_add(struct device *dev)
938{
939 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800940 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200941 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700942 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700945 if (!dev)
946 goto done;
947
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800948 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700949 error = device_private_init(dev);
950 if (error)
951 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800952 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800953
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100954 /*
955 * for statically allocated devices, which should all be converted
956 * some day, we need to initialize the name. We prevent reading back
957 * the name, and force the use of dev_name()
958 */
959 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700960 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100961 dev->init_name = NULL;
962 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700963
Kay Sieversca22e562011-12-14 14:29:38 -0800964 /* subsystems can specify simple device enumeration */
965 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
966 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
967
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000968 if (!dev_name(dev)) {
969 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -0700970 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000971 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100973 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700974
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -0800976 kobj = get_device_parent(dev, parent);
977 if (kobj)
978 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
Yinghai Lu0d358f22008-02-19 03:20:41 -0800980 /* use parent numa_node */
981 if (parent)
982 set_dev_node(dev, dev_to_node(parent));
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -0700985 /* we require the name to be set before, and pass NULL */
986 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100987 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200989
Brian Walsh37022642006-08-14 22:43:19 -0700990 /* notify platform of device entry */
991 if (platform_notify)
992 platform_notify(dev);
993
Tejun Heoad6a1e12007-06-14 03:45:17 +0900994 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200995 if (error)
996 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200997
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700998 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900999 error = device_create_file(dev, &devt_attr);
1000 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001001 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001002
1003 error = device_create_sys_dev_entry(dev);
1004 if (error)
1005 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001006
1007 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001008 }
1009
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001010 error = device_add_class_symlinks(dev);
1011 if (error)
1012 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001013 error = device_add_attrs(dev);
1014 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001015 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001016 error = bus_add_device(dev);
1017 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001019 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001020 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001021 goto DPMError;
1022 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001023
1024 /* Notify clients of device addition. This call must come
1025 * after dpm_sysf_add() and before kobject_uevent().
1026 */
1027 if (dev->bus)
1028 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1029 BUS_NOTIFY_ADD_DEVICE, dev);
1030
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001031 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001032 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001034 klist_add_tail(&dev->p->knode_parent,
1035 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001037 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001038 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001039 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001040 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001041 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001042
1043 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001044 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001045 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001046 if (class_intf->add_dev)
1047 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001048 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001049 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001050done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 put_device(dev);
1052 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001053 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001054 bus_remove_device(dev);
1055 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001056 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001057 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001058 device_remove_class_symlinks(dev);
1059 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001060 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001061 devtmpfs_delete_node(dev);
1062 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001063 device_remove_sys_dev_entry(dev);
1064 devtattrError:
1065 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +09001066 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001067 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001068 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001069 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001070 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 kobject_del(&dev->kobj);
1072 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001073 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 if (parent)
1075 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001076name_error:
1077 kfree(dev->p);
1078 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001079 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080}
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001083 * device_register - register a device with the system.
1084 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001086 * This happens in two clean steps - initialize the device
1087 * and add it to the system. The two steps can be called
1088 * separately, but this is the easiest and most common.
1089 * I.e. you should only call the two helpers separately if
1090 * have a clearly defined need to use and refcount the device
1091 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001092 *
1093 * NOTE: _Never_ directly free @dev after calling this function, even
1094 * if it returned an error! Always use put_device() to give up the
1095 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097int device_register(struct device *dev)
1098{
1099 device_initialize(dev);
1100 return device_add(dev);
1101}
1102
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001104 * get_device - increment reference count for device.
1105 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001107 * This simply forwards the call to kobject_get(), though
1108 * we do take care to provide for the case that we get a NULL
1109 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001111struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112{
1113 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1114}
1115
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001117 * put_device - decrement reference count.
1118 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001120void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001122 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 if (dev)
1124 kobject_put(&dev->kobj);
1125}
1126
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001128 * device_del - delete device from system.
1129 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001131 * This is the first part of the device unregistration
1132 * sequence. This removes the device from the lists we control
1133 * from here, has it removed from the other driver model
1134 * subsystems it was added to in device_add(), and removes it
1135 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001137 * NOTE: this should be called manually _iff_ device_add() was
1138 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001140void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001142 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001143 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Alan Sternec0676ee2008-12-05 14:10:31 -05001145 /* Notify clients of device removal. This call must come
1146 * before dpm_sysfs_remove().
1147 */
1148 if (dev->bus)
1149 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1150 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001151 device_pm_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001152 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001154 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001155 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001156 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001157 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001158 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001159 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001160 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001161 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001162
Kay Sieversca22e562011-12-14 14:29:38 -08001163 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001164 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001165 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001166 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001167 if (class_intf->remove_dev)
1168 class_intf->remove_dev(dev, class_intf);
1169 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001170 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001171 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001172 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001173 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001174 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001175 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001177 /*
1178 * Some platform devices are driven without driver attached
1179 * and managed resources may have been acquired. Make sure
1180 * all resources are released.
1181 */
1182 devres_release_all(dev);
1183
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 /* Notify the platform of the removal, in case they
1185 * need to do anything...
1186 */
1187 if (platform_notify_remove)
1188 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001189 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001190 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001192 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193}
1194
1195/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001196 * device_unregister - unregister device from system.
1197 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001199 * We do this in two parts, like we do device_register(). First,
1200 * we remove it from all the subsystems with device_del(), then
1201 * we decrement the reference count via put_device(). If that
1202 * is the final reference count, the device will be cleaned up
1203 * via device_release() above. Otherwise, the structure will
1204 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001206void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001208 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 device_del(dev);
1210 put_device(dev);
1211}
1212
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001213static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001214{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001215 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001216 struct device *dev = NULL;
1217 struct device_private *p;
1218
1219 if (n) {
1220 p = to_device_private_parent(n);
1221 dev = p->device;
1222 }
1223 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001224}
1225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001227 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001228 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001229 * @mode: returned file access mode
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001230 * @tmp: possibly allocated string
1231 *
1232 * Return the relative path of a possible device node.
1233 * Non-default names may need to allocate a memory to compose
1234 * a name. This memory is returned in tmp and needs to be
1235 * freed by the caller.
1236 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001237const char *device_get_devnode(struct device *dev,
Al Viro2c9ede52011-07-23 20:24:48 -04001238 umode_t *mode, const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001239{
1240 char *s;
1241
1242 *tmp = NULL;
1243
1244 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001245 if (dev->type && dev->type->devnode)
1246 *tmp = dev->type->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001247 if (*tmp)
1248 return *tmp;
1249
1250 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001251 if (dev->class && dev->class->devnode)
1252 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001253 if (*tmp)
1254 return *tmp;
1255
1256 /* return name without allocation, tmp == NULL */
1257 if (strchr(dev_name(dev), '!') == NULL)
1258 return dev_name(dev);
1259
1260 /* replace '!' in the name with '/' */
1261 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1262 if (!*tmp)
1263 return NULL;
1264 while ((s = strchr(*tmp, '!')))
1265 s[0] = '/';
1266 return *tmp;
1267}
1268
1269/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001270 * device_for_each_child - device child iterator.
1271 * @parent: parent struct device.
1272 * @data: data for the callback.
1273 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001275 * Iterate over @parent's child devices, and call @fn for each,
1276 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001278 * We check the return of @fn each time. If it returns anything
1279 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001281int device_for_each_child(struct device *parent, void *data,
1282 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001284 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001285 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 int error = 0;
1287
Greg Kroah-Hartman014c90d2009-04-15 16:00:12 -07001288 if (!parent->p)
1289 return 0;
1290
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001291 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001292 while ((child = next_device(&i)) && !error)
1293 error = fn(child, data);
1294 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 return error;
1296}
1297
Cornelia Huck5ab69982006-11-16 15:42:07 +01001298/**
1299 * device_find_child - device iterator for locating a particular device.
1300 * @parent: parent struct device
1301 * @data: Data to pass to match function
1302 * @match: Callback function to check device
1303 *
1304 * This is similar to the device_for_each_child() function above, but it
1305 * returns a reference to a device that is 'found' for later use, as
1306 * determined by the @match callback.
1307 *
1308 * The callback should return 0 if the device doesn't match and non-zero
1309 * if it does. If the callback returns non-zero and a reference to the
1310 * current device can be obtained, this function will return to the caller
1311 * and not iterate over any more devices.
1312 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001313struct device *device_find_child(struct device *parent, void *data,
1314 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001315{
1316 struct klist_iter i;
1317 struct device *child;
1318
1319 if (!parent)
1320 return NULL;
1321
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001322 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001323 while ((child = next_device(&i)))
1324 if (match(child, data) && get_device(child))
1325 break;
1326 klist_iter_exit(&i);
1327 return child;
1328}
1329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330int __init devices_init(void)
1331{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001332 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1333 if (!devices_kset)
1334 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001335 dev_kobj = kobject_create_and_add("dev", NULL);
1336 if (!dev_kobj)
1337 goto dev_kobj_err;
1338 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1339 if (!sysfs_dev_block_kobj)
1340 goto block_kobj_err;
1341 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1342 if (!sysfs_dev_char_kobj)
1343 goto char_kobj_err;
1344
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001345 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001346
1347 char_kobj_err:
1348 kobject_put(sysfs_dev_block_kobj);
1349 block_kobj_err:
1350 kobject_put(dev_kobj);
1351 dev_kobj_err:
1352 kset_unregister(devices_kset);
1353 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
1355
1356EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001357EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
1359EXPORT_SYMBOL_GPL(device_initialize);
1360EXPORT_SYMBOL_GPL(device_add);
1361EXPORT_SYMBOL_GPL(device_register);
1362
1363EXPORT_SYMBOL_GPL(device_del);
1364EXPORT_SYMBOL_GPL(device_unregister);
1365EXPORT_SYMBOL_GPL(get_device);
1366EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
1368EXPORT_SYMBOL_GPL(device_create_file);
1369EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001370
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001371struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001372 struct device dev;
1373 struct module *owner;
1374};
1375
Ferenc Wagner481e2072011-01-07 15:17:47 +01001376inline struct root_device *to_root_device(struct device *d)
1377{
1378 return container_of(d, struct root_device, dev);
1379}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001380
1381static void root_device_release(struct device *dev)
1382{
1383 kfree(to_root_device(dev));
1384}
1385
1386/**
1387 * __root_device_register - allocate and register a root device
1388 * @name: root device name
1389 * @owner: owner module of the root device, usually THIS_MODULE
1390 *
1391 * This function allocates a root device and registers it
1392 * using device_register(). In order to free the returned
1393 * device, use root_device_unregister().
1394 *
1395 * Root devices are dummy devices which allow other devices
1396 * to be grouped under /sys/devices. Use this function to
1397 * allocate a root device and then use it as the parent of
1398 * any device which should appear under /sys/devices/{name}
1399 *
1400 * The /sys/devices/{name} directory will also contain a
1401 * 'module' symlink which points to the @owner directory
1402 * in sysfs.
1403 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001404 * Returns &struct device pointer on success, or ERR_PTR() on error.
1405 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001406 * Note: You probably want to use root_device_register().
1407 */
1408struct device *__root_device_register(const char *name, struct module *owner)
1409{
1410 struct root_device *root;
1411 int err = -ENOMEM;
1412
1413 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1414 if (!root)
1415 return ERR_PTR(err);
1416
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001417 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001418 if (err) {
1419 kfree(root);
1420 return ERR_PTR(err);
1421 }
1422
1423 root->dev.release = root_device_release;
1424
1425 err = device_register(&root->dev);
1426 if (err) {
1427 put_device(&root->dev);
1428 return ERR_PTR(err);
1429 }
1430
Christoph Egger1d9e8822010-05-17 16:57:58 +02001431#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001432 if (owner) {
1433 struct module_kobject *mk = &owner->mkobj;
1434
1435 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1436 if (err) {
1437 device_unregister(&root->dev);
1438 return ERR_PTR(err);
1439 }
1440 root->owner = owner;
1441 }
1442#endif
1443
1444 return &root->dev;
1445}
1446EXPORT_SYMBOL_GPL(__root_device_register);
1447
1448/**
1449 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001450 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001451 *
1452 * This function unregisters and cleans up a device that was created by
1453 * root_device_register().
1454 */
1455void root_device_unregister(struct device *dev)
1456{
1457 struct root_device *root = to_root_device(dev);
1458
1459 if (root->owner)
1460 sysfs_remove_link(&root->dev.kobj, "module");
1461
1462 device_unregister(dev);
1463}
1464EXPORT_SYMBOL_GPL(root_device_unregister);
1465
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001466
1467static void device_create_release(struct device *dev)
1468{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001469 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001470 kfree(dev);
1471}
1472
1473/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001474 * device_create_vargs - creates a device and registers it with sysfs
1475 * @class: pointer to the struct class that this device should be registered to
1476 * @parent: pointer to the parent struct device of this new device, if any
1477 * @devt: the dev_t for the char device to be added
1478 * @drvdata: the data to be added to the device for callbacks
1479 * @fmt: string for the device's name
1480 * @args: va_list for the device's name
1481 *
1482 * This function can be used by char device classes. A struct device
1483 * will be created in sysfs, registered to the specified class.
1484 *
1485 * A "dev" file will be created, showing the dev_t for the device, if
1486 * the dev_t is not 0,0.
1487 * If a pointer to a parent struct device is passed in, the newly created
1488 * struct device will be a child of that device in sysfs.
1489 * The pointer to the struct device will be returned from the call.
1490 * Any further sysfs files that might be required can be created using this
1491 * pointer.
1492 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001493 * Returns &struct device pointer on success, or ERR_PTR() on error.
1494 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001495 * Note: the struct class passed to this function must have previously
1496 * been created with a call to class_create().
1497 */
1498struct device *device_create_vargs(struct class *class, struct device *parent,
1499 dev_t devt, void *drvdata, const char *fmt,
1500 va_list args)
1501{
1502 struct device *dev = NULL;
1503 int retval = -ENODEV;
1504
1505 if (class == NULL || IS_ERR(class))
1506 goto error;
1507
1508 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1509 if (!dev) {
1510 retval = -ENOMEM;
1511 goto error;
1512 }
1513
1514 dev->devt = devt;
1515 dev->class = class;
1516 dev->parent = parent;
1517 dev->release = device_create_release;
1518 dev_set_drvdata(dev, drvdata);
1519
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001520 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1521 if (retval)
1522 goto error;
1523
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001524 retval = device_register(dev);
1525 if (retval)
1526 goto error;
1527
1528 return dev;
1529
1530error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001531 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001532 return ERR_PTR(retval);
1533}
1534EXPORT_SYMBOL_GPL(device_create_vargs);
1535
1536/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001537 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001538 * @class: pointer to the struct class that this device should be registered to
1539 * @parent: pointer to the parent struct device of this new device, if any
1540 * @devt: the dev_t for the char device to be added
1541 * @drvdata: the data to be added to the device for callbacks
1542 * @fmt: string for the device's name
1543 *
1544 * This function can be used by char device classes. A struct device
1545 * will be created in sysfs, registered to the specified class.
1546 *
1547 * A "dev" file will be created, showing the dev_t for the device, if
1548 * the dev_t is not 0,0.
1549 * If a pointer to a parent struct device is passed in, the newly created
1550 * struct device will be a child of that device in sysfs.
1551 * The pointer to the struct device will be returned from the call.
1552 * Any further sysfs files that might be required can be created using this
1553 * pointer.
1554 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001555 * Returns &struct device pointer on success, or ERR_PTR() on error.
1556 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001557 * Note: the struct class passed to this function must have previously
1558 * been created with a call to class_create().
1559 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001560struct device *device_create(struct class *class, struct device *parent,
1561 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001562{
1563 va_list vargs;
1564 struct device *dev;
1565
1566 va_start(vargs, fmt);
1567 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1568 va_end(vargs);
1569 return dev;
1570}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001571EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001572
Dave Youngcd354492008-01-28 16:56:11 +08001573static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001574{
Dave Youngcd354492008-01-28 16:56:11 +08001575 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001576
Dave Youngcd354492008-01-28 16:56:11 +08001577 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001578}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001579
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001580/**
1581 * device_destroy - removes a device that was created with device_create()
1582 * @class: pointer to the struct class that this device was registered with
1583 * @devt: the dev_t of the device that was previously registered
1584 *
1585 * This call unregisters and cleans up a device that was created with a
1586 * call to device_create().
1587 */
1588void device_destroy(struct class *class, dev_t devt)
1589{
1590 struct device *dev;
1591
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001592 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001593 if (dev) {
1594 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001595 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001596 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001597}
1598EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001599
1600/**
1601 * device_rename - renames a device
1602 * @dev: the pointer to the struct device to be renamed
1603 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001604 *
1605 * It is the responsibility of the caller to provide mutual
1606 * exclusion between two different calls of device_rename
1607 * on the same device to ensure that new_name is valid and
1608 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001609 *
Timur Tabia5462512010-12-13 14:08:52 -06001610 * Note: Don't call this function. Currently, the networking layer calls this
1611 * function, but that will change. The following text from Kay Sievers offers
1612 * some insight:
1613 *
1614 * Renaming devices is racy at many levels, symlinks and other stuff are not
1615 * replaced atomically, and you get a "move" uevent, but it's not easy to
1616 * connect the event to the old and new device. Device nodes are not renamed at
1617 * all, there isn't even support for that in the kernel now.
1618 *
1619 * In the meantime, during renaming, your target name might be taken by another
1620 * driver, creating conflicts. Or the old name is taken directly after you
1621 * renamed it -- then you get events for the same DEVPATH, before you even see
1622 * the "move" event. It's just a mess, and nothing new should ever rely on
1623 * kernel device renaming. Besides that, it's not even implemented now for
1624 * other things than (driver-core wise very simple) network devices.
1625 *
1626 * We are currently about to change network renaming in udev to completely
1627 * disallow renaming of devices in the same namespace as the kernel uses,
1628 * because we can't solve the problems properly, that arise with swapping names
1629 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1630 * be allowed to some other name than eth[0-9]*, for the aforementioned
1631 * reasons.
1632 *
1633 * Make up a "real" name in the driver before you register anything, or add
1634 * some other attributes for userspace to find the device, or use udev to add
1635 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1636 * don't even want to get into that and try to implement the missing pieces in
1637 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001638 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001639int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001640{
1641 char *old_class_name = NULL;
1642 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001643 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001644 int error;
1645
1646 dev = get_device(dev);
1647 if (!dev)
1648 return -EINVAL;
1649
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001650 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001651 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001652
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001653 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001654 if (!old_device_name) {
1655 error = -ENOMEM;
1656 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001657 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001658
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001659 if (dev->class) {
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001660 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001661 &dev->kobj, old_device_name, new_name);
1662 if (error)
1663 goto out;
1664 }
Kay Sievers39aba962010-09-04 22:33:14 -07001665
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001666 error = kobject_rename(&dev->kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001667 if (error)
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001668 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001669
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001670out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001671 put_device(dev);
1672
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001673 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001674 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001675 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001676
1677 return error;
1678}
Johannes Berga2807db2007-02-28 12:38:31 +01001679EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001680
1681static int device_move_class_links(struct device *dev,
1682 struct device *old_parent,
1683 struct device *new_parent)
1684{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001685 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001686
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001687 if (old_parent)
1688 sysfs_remove_link(&dev->kobj, "device");
1689 if (new_parent)
1690 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1691 "device");
1692 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001693}
1694
1695/**
1696 * device_move - moves a device to a new parent
1697 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001698 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001699 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001700 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001701int device_move(struct device *dev, struct device *new_parent,
1702 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001703{
1704 int error;
1705 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001706 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001707
1708 dev = get_device(dev);
1709 if (!dev)
1710 return -EINVAL;
1711
Cornelia Huckffa6a702009-03-04 12:44:00 +01001712 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001713 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001714 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001715
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001716 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1717 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001718 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001719 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001720 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001721 put_device(new_parent);
1722 goto out;
1723 }
1724 old_parent = dev->parent;
1725 dev->parent = new_parent;
1726 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001727 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001728 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001729 klist_add_tail(&dev->p->knode_parent,
1730 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001731 set_dev_node(dev, dev_to_node(new_parent));
1732 }
1733
Cornelia Huck8a824722006-11-20 17:07:51 +01001734 if (!dev->class)
1735 goto out_put;
1736 error = device_move_class_links(dev, old_parent, new_parent);
1737 if (error) {
1738 /* We ignore errors on cleanup since we're hosed anyway... */
1739 device_move_class_links(dev, new_parent, old_parent);
1740 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001741 if (new_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001742 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001743 dev->parent = old_parent;
1744 if (old_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001745 klist_add_tail(&dev->p->knode_parent,
1746 &old_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001747 set_dev_node(dev, dev_to_node(old_parent));
1748 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001749 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001750 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001751 put_device(new_parent);
1752 goto out;
1753 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001754 switch (dpm_order) {
1755 case DPM_ORDER_NONE:
1756 break;
1757 case DPM_ORDER_DEV_AFTER_PARENT:
1758 device_pm_move_after(dev, new_parent);
1759 break;
1760 case DPM_ORDER_PARENT_BEFORE_DEV:
1761 device_pm_move_before(new_parent, dev);
1762 break;
1763 case DPM_ORDER_DEV_LAST:
1764 device_pm_move_last(dev);
1765 break;
1766 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001767out_put:
1768 put_device(old_parent);
1769out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001770 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001771 put_device(dev);
1772 return error;
1773}
Cornelia Huck8a824722006-11-20 17:07:51 +01001774EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001775
1776/**
1777 * device_shutdown - call ->shutdown() on each device to shutdown.
1778 */
1779void device_shutdown(void)
1780{
Hugh Daschbach62458382010-03-22 10:36:37 -07001781 struct device *dev;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001782
Hugh Daschbach62458382010-03-22 10:36:37 -07001783 spin_lock(&devices_kset->list_lock);
1784 /*
1785 * Walk the devices list backward, shutting down each in turn.
1786 * Beware that device unplug events may also start pulling
1787 * devices offline, even as the system is shutting down.
1788 */
1789 while (!list_empty(&devices_kset->list)) {
1790 dev = list_entry(devices_kset->list.prev, struct device,
1791 kobj.entry);
1792 get_device(dev);
1793 /*
1794 * Make sure the device is off the kset list, in the
1795 * event that dev->*->shutdown() doesn't remove it.
1796 */
1797 list_del_init(&dev->kobj.entry);
1798 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001799
1800 /* Don't allow any more runtime suspends */
1801 pm_runtime_get_noresume(dev);
1802 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001803
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001804 if (dev->bus && dev->bus->shutdown) {
1805 dev_dbg(dev, "shutdown\n");
1806 dev->bus->shutdown(dev);
1807 } else if (dev->driver && dev->driver->shutdown) {
1808 dev_dbg(dev, "shutdown\n");
1809 dev->driver->shutdown(dev);
1810 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001811 put_device(dev);
1812
1813 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001814 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001815 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07001816 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001817}
Joe Perches99bcf212010-06-27 01:02:34 +00001818
1819/*
1820 * Device logging functions
1821 */
1822
1823#ifdef CONFIG_PRINTK
1824
Joe Perchescbc46632011-08-11 14:36:21 -04001825int __dev_printk(const char *level, const struct device *dev,
1826 struct va_format *vaf)
Joe Perches99bcf212010-06-27 01:02:34 +00001827{
1828 if (!dev)
1829 return printk("%s(NULL device *): %pV", level, vaf);
1830
1831 return printk("%s%s %s: %pV",
1832 level, dev_driver_string(dev), dev_name(dev), vaf);
1833}
Joe Perchescbc46632011-08-11 14:36:21 -04001834EXPORT_SYMBOL(__dev_printk);
Joe Perches99bcf212010-06-27 01:02:34 +00001835
1836int dev_printk(const char *level, const struct device *dev,
1837 const char *fmt, ...)
1838{
1839 struct va_format vaf;
1840 va_list args;
1841 int r;
1842
1843 va_start(args, fmt);
1844
1845 vaf.fmt = fmt;
1846 vaf.va = &args;
1847
1848 r = __dev_printk(level, dev, &vaf);
1849 va_end(args);
1850
1851 return r;
1852}
1853EXPORT_SYMBOL(dev_printk);
1854
1855#define define_dev_printk_level(func, kern_level) \
1856int func(const struct device *dev, const char *fmt, ...) \
1857{ \
1858 struct va_format vaf; \
1859 va_list args; \
1860 int r; \
1861 \
1862 va_start(args, fmt); \
1863 \
1864 vaf.fmt = fmt; \
1865 vaf.va = &args; \
1866 \
1867 r = __dev_printk(kern_level, dev, &vaf); \
1868 va_end(args); \
1869 \
1870 return r; \
1871} \
1872EXPORT_SYMBOL(func);
1873
1874define_dev_printk_level(dev_emerg, KERN_EMERG);
1875define_dev_printk_level(dev_alert, KERN_ALERT);
1876define_dev_printk_level(dev_crit, KERN_CRIT);
1877define_dev_printk_level(dev_err, KERN_ERR);
1878define_dev_printk_level(dev_warn, KERN_WARNING);
1879define_dev_printk_level(dev_notice, KERN_NOTICE);
1880define_dev_printk_level(_dev_info, KERN_INFO);
1881
1882#endif