blob: e28ce9898af4e1bab331fa3b9411b2bbc6575856 [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>
Grant Likely07d57a32012-02-01 11:22:22 -070021#include <linux/of.h>
22#include <linux/of_device.h>
Kay Sieversda231fd2007-11-21 17:29:15 +010023#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080024#include <linux/kallsyms.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070025#include <linux/mutex.h>
Shaohua Li401097e2009-05-12 13:37:57 -070026#include <linux/async.h>
Peter Chenaf8db152011-11-15 21:52:29 +010027#include <linux/pm_runtime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#include "base.h"
30#include "power/power.h"
31
Andi Kleene52eec12010-09-08 16:54:17 +020032#ifdef CONFIG_SYSFS_DEPRECATED
33#ifdef CONFIG_SYSFS_DEPRECATED_V2
34long sysfs_deprecated = 1;
35#else
36long sysfs_deprecated = 0;
37#endif
38static __init int sysfs_deprecated_setup(char *arg)
39{
40 return strict_strtol(arg, 10, &sysfs_deprecated);
41}
42early_param("sysfs.deprecated", sysfs_deprecated_setup);
43#endif
44
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080045int (*platform_notify)(struct device *dev) = NULL;
46int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070047static struct kobject *dev_kobj;
48struct kobject *sysfs_dev_char_kobj;
49struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080051#ifdef CONFIG_BLOCK
52static inline int device_is_not_partition(struct device *dev)
53{
54 return !(dev->type == &part_type);
55}
56#else
57static inline int device_is_not_partition(struct device *dev)
58{
59 return 1;
60}
61#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Alan Stern3e956372006-06-16 17:10:48 -040063/**
64 * dev_driver_string - Return a device's driver name, if at all possible
65 * @dev: struct device to get the name of
66 *
67 * Will return the device's driver's name if it is bound to a device. If
68 * the device is not bound to a device, it will return the name of the bus
69 * it is attached to. If it is not attached to a bus either, an empty
70 * string will be returned.
71 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070072const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040073{
Alan Stern35899722009-12-04 11:06:57 -050074 struct device_driver *drv;
75
76 /* dev->driver can change to NULL underneath us because of unbinding,
77 * so be careful about accessing it. dev->bus and dev->class should
78 * never change once they are set, so they don't need special care.
79 */
80 drv = ACCESS_ONCE(dev->driver);
81 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +010082 (dev->bus ? dev->bus->name :
83 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040084}
Matthew Wilcox310a9222006-09-23 23:35:04 -060085EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define to_dev(obj) container_of(obj, struct device, kobj)
88#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
89
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080090static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
91 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080093 struct device_attribute *dev_attr = to_dev_attr(attr);
94 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050095 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040098 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080099 if (ret >= (ssize_t)PAGE_SIZE) {
100 print_symbol("dev_attr_show: %s returned bad count\n",
101 (unsigned long)dev_attr->show);
102 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 return ret;
104}
105
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800106static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
107 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800109 struct device_attribute *dev_attr = to_dev_attr(attr);
110 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500111 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400114 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 return ret;
116}
117
Emese Revfy52cf25d2010-01-19 02:58:23 +0100118static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 .show = dev_attr_show,
120 .store = dev_attr_store,
121};
122
Kay Sieversca22e562011-12-14 14:29:38 -0800123#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
124
125ssize_t device_store_ulong(struct device *dev,
126 struct device_attribute *attr,
127 const char *buf, size_t size)
128{
129 struct dev_ext_attribute *ea = to_ext_attr(attr);
130 char *end;
131 unsigned long new = simple_strtoul(buf, &end, 0);
132 if (end == buf)
133 return -EINVAL;
134 *(unsigned long *)(ea->var) = new;
135 /* Always return full write size even if we didn't consume all */
136 return size;
137}
138EXPORT_SYMBOL_GPL(device_store_ulong);
139
140ssize_t device_show_ulong(struct device *dev,
141 struct device_attribute *attr,
142 char *buf)
143{
144 struct dev_ext_attribute *ea = to_ext_attr(attr);
145 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
146}
147EXPORT_SYMBOL_GPL(device_show_ulong);
148
149ssize_t device_store_int(struct device *dev,
150 struct device_attribute *attr,
151 const char *buf, size_t size)
152{
153 struct dev_ext_attribute *ea = to_ext_attr(attr);
154 char *end;
155 long new = simple_strtol(buf, &end, 0);
156 if (end == buf || new > INT_MAX || new < INT_MIN)
157 return -EINVAL;
158 *(int *)(ea->var) = new;
159 /* Always return full write size even if we didn't consume all */
160 return size;
161}
162EXPORT_SYMBOL_GPL(device_store_int);
163
164ssize_t device_show_int(struct device *dev,
165 struct device_attribute *attr,
166 char *buf)
167{
168 struct dev_ext_attribute *ea = to_ext_attr(attr);
169
170 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
171}
172EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174/**
175 * device_release - free device structure.
176 * @kobj: device's kobject.
177 *
178 * This is called once the reference count for the object
179 * reaches 0. We forward the call to the device's release
180 * method, which should handle actually freeing the structure.
181 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800182static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800184 struct device *dev = to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800185 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 if (dev->release)
188 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200189 else if (dev->type && dev->type->release)
190 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700191 else if (dev->class && dev->class->dev_release)
192 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700193 else
194 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800195 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100196 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800197 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198}
199
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700200static const void *device_namespace(struct kobject *kobj)
201{
202 struct device *dev = to_dev(kobj);
203 const void *ns = NULL;
204
205 if (dev->class && dev->class->ns_type)
206 ns = dev->class->namespace(dev);
207
208 return ns;
209}
210
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600211static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 .release = device_release,
213 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700214 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215};
216
217
Kay Sievers312c0042005-11-16 09:00:00 +0100218static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
220 struct kobj_type *ktype = get_ktype(kobj);
221
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600222 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 struct device *dev = to_dev(kobj);
224 if (dev->bus)
225 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700226 if (dev->class)
227 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 }
229 return 0;
230}
231
Kay Sievers312c0042005-11-16 09:00:00 +0100232static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233{
234 struct device *dev = to_dev(kobj);
235
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700236 if (dev->bus)
237 return dev->bus->name;
238 if (dev->class)
239 return dev->class->name;
240 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
Kay Sievers7eff2e72007-08-14 15:15:12 +0200243static int dev_uevent(struct kset *kset, struct kobject *kobj,
244 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 int retval = 0;
248
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200249 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700250 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200251 const char *tmp;
252 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400253 umode_t mode = 0;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200254
Kay Sievers7eff2e72007-08-14 15:15:12 +0200255 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
256 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sieverse454cea2009-09-18 23:01:12 +0200257 name = device_get_devnode(dev, &mode, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200258 if (name) {
259 add_uevent_var(env, "DEVNAME=%s", name);
260 kfree(tmp);
Kay Sieverse454cea2009-09-18 23:01:12 +0200261 if (mode)
262 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200263 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700264 }
265
Kay Sievers414264f2007-03-12 21:08:57 +0100266 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200267 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100268
Kay Sievers239378f2006-10-07 21:54:55 +0200269 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200270 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200271
Grant Likely07d57a32012-02-01 11:22:22 -0700272 /* Add common DT information about the device */
273 of_device_uevent(dev, env);
274
Kay Sievers7eff2e72007-08-14 15:15:12 +0200275 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100276 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200277 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200278 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800279 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100280 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 }
282
Kay Sievers7eff2e72007-08-14 15:15:12 +0200283 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700284 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200285 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200286 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800287 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100288 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800289 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200290 }
291
Stefan Weileef35c22010-08-06 21:11:15 +0200292 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200293 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200294 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200295 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800296 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100297 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800298 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700299 }
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 return retval;
302}
303
Emese Revfy9cd43612009-12-31 14:52:51 +0100304static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100305 .filter = dev_uevent_filter,
306 .name = dev_uevent_name,
307 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308};
309
Kay Sievers16574dc2007-04-06 01:40:38 +0200310static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
311 char *buf)
312{
313 struct kobject *top_kobj;
314 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200315 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200316 int i;
317 size_t count = 0;
318 int retval;
319
320 /* search the kset, the device belongs to */
321 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200322 while (!top_kobj->kset && top_kobj->parent)
323 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200324 if (!top_kobj->kset)
325 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200326
Kay Sievers16574dc2007-04-06 01:40:38 +0200327 kset = top_kobj->kset;
328 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
329 goto out;
330
331 /* respect filter */
332 if (kset->uevent_ops && kset->uevent_ops->filter)
333 if (!kset->uevent_ops->filter(kset, &dev->kobj))
334 goto out;
335
Kay Sievers7eff2e72007-08-14 15:15:12 +0200336 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
337 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200338 return -ENOMEM;
339
Kay Sievers16574dc2007-04-06 01:40:38 +0200340 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200341 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200342 if (retval)
343 goto out;
344
345 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200346 for (i = 0; i < env->envp_idx; i++)
347 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200348out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200349 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200350 return count;
351}
352
Kay Sieversa7fd6702005-10-01 14:49:43 +0200353static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
354 const char *buf, size_t count)
355{
Kay Sievers60a96a52007-07-08 22:29:26 +0200356 enum kobject_action action;
357
Kay Sievers3f5468c2010-01-14 22:54:37 +0100358 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200359 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100360 else
361 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200362 return count;
363}
364
Tejun Heoad6a1e12007-06-14 03:45:17 +0900365static struct device_attribute uevent_attr =
366 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
367
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500368static int device_add_attributes(struct device *dev,
369 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700370{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700371 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500372 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700373
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500374 if (attrs) {
375 for (i = 0; attr_name(attrs[i]); i++) {
376 error = device_create_file(dev, &attrs[i]);
377 if (error)
378 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700379 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500380 if (error)
381 while (--i >= 0)
382 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700383 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700384 return error;
385}
386
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500387static void device_remove_attributes(struct device *dev,
388 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700389{
390 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500391
392 if (attrs)
393 for (i = 0; attr_name(attrs[i]); i++)
394 device_remove_file(dev, &attrs[i]);
395}
396
Stefan Achatzc97415a2010-11-26 19:57:29 +0000397static int device_add_bin_attributes(struct device *dev,
398 struct bin_attribute *attrs)
399{
400 int error = 0;
401 int i;
402
403 if (attrs) {
404 for (i = 0; attr_name(attrs[i]); i++) {
405 error = device_create_bin_file(dev, &attrs[i]);
406 if (error)
407 break;
408 }
409 if (error)
410 while (--i >= 0)
411 device_remove_bin_file(dev, &attrs[i]);
412 }
413 return error;
414}
415
416static void device_remove_bin_attributes(struct device *dev,
417 struct bin_attribute *attrs)
418{
419 int i;
420
421 if (attrs)
422 for (i = 0; attr_name(attrs[i]); i++)
423 device_remove_bin_file(dev, &attrs[i]);
424}
425
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500426static int device_add_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700427 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500428{
429 int error = 0;
430 int i;
431
432 if (groups) {
433 for (i = 0; groups[i]; i++) {
434 error = sysfs_create_group(&dev->kobj, groups[i]);
435 if (error) {
436 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800437 sysfs_remove_group(&dev->kobj,
438 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500439 break;
440 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700441 }
442 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500443 return error;
444}
445
446static void device_remove_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700447 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500448{
449 int i;
450
451 if (groups)
452 for (i = 0; groups[i]; i++)
453 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700454}
455
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700456static int device_add_attrs(struct device *dev)
457{
458 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700459 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500460 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700461
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500462 if (class) {
463 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200464 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500465 return error;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000466 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
467 if (error)
468 goto err_remove_class_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700469 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200470
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500471 if (type) {
472 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200473 if (error)
Stefan Achatzc97415a2010-11-26 19:57:29 +0000474 goto err_remove_class_bin_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200475 }
476
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500477 error = device_add_groups(dev, dev->groups);
478 if (error)
479 goto err_remove_type_groups;
480
481 return 0;
482
483 err_remove_type_groups:
484 if (type)
485 device_remove_groups(dev, type->groups);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000486 err_remove_class_bin_attrs:
487 if (class)
488 device_remove_bin_attributes(dev, class->dev_bin_attrs);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500489 err_remove_class_attrs:
490 if (class)
491 device_remove_attributes(dev, class->dev_attrs);
492
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700493 return error;
494}
495
496static void device_remove_attrs(struct device *dev)
497{
498 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700499 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700500
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500501 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200502
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500503 if (type)
504 device_remove_groups(dev, type->groups);
505
Stefan Achatzc97415a2010-11-26 19:57:29 +0000506 if (class) {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500507 device_remove_attributes(dev, class->dev_attrs);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000508 device_remove_bin_attributes(dev, class->dev_bin_attrs);
509 }
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700510}
511
512
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700513static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
514 char *buf)
515{
516 return print_dev_t(buf, dev->devt);
517}
518
Tejun Heoad6a1e12007-06-14 03:45:17 +0900519static struct device_attribute devt_attr =
520 __ATTR(dev, S_IRUGO, show_dev, NULL);
521
Kay Sieversca22e562011-12-14 14:29:38 -0800522/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600523struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800526 * device_create_file - create sysfs attribute file for device.
527 * @dev: device.
528 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200530int device_create_file(struct device *dev,
531 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
533 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100534 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return error;
537}
538
539/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800540 * device_remove_file - remove sysfs attribute file.
541 * @dev: device.
542 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200544void device_remove_file(struct device *dev,
545 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100547 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700551/**
552 * device_create_bin_file - create sysfs binary attribute file for device.
553 * @dev: device.
554 * @attr: device binary attribute descriptor.
555 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200556int device_create_bin_file(struct device *dev,
557 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700558{
559 int error = -EINVAL;
560 if (dev)
561 error = sysfs_create_bin_file(&dev->kobj, attr);
562 return error;
563}
564EXPORT_SYMBOL_GPL(device_create_bin_file);
565
566/**
567 * device_remove_bin_file - remove sysfs binary attribute file
568 * @dev: device.
569 * @attr: device binary attribute descriptor.
570 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200571void device_remove_bin_file(struct device *dev,
572 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700573{
574 if (dev)
575 sysfs_remove_bin_file(&dev->kobj, attr);
576}
577EXPORT_SYMBOL_GPL(device_remove_bin_file);
578
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400579/**
Alan Stern523ded72007-04-26 00:12:04 -0700580 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400581 * @dev: device.
582 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700583 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400584 *
585 * Attribute methods must not unregister themselves or their parent device
586 * (which would amount to the same thing). Attempts to do so will deadlock,
587 * since unregistration is mutually exclusive with driver callbacks.
588 *
589 * Instead methods can call this routine, which will attempt to allocate
590 * and schedule a workqueue request to call back @func with @dev as its
591 * argument in the workqueue's process context. @dev will be pinned until
592 * @func returns.
593 *
Alan Stern523ded72007-04-26 00:12:04 -0700594 * This routine is usually called via the inline device_schedule_callback(),
595 * which automatically sets @owner to THIS_MODULE.
596 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400597 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700598 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400599 *
600 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
601 * underlying sysfs routine (since it is intended for use by attribute
602 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
603 */
Alan Stern523ded72007-04-26 00:12:04 -0700604int device_schedule_callback_owner(struct device *dev,
605 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400606{
607 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700608 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400609}
Alan Stern523ded72007-04-26 00:12:04 -0700610EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400611
James Bottomley34bb61f2005-09-06 16:56:51 -0700612static void klist_children_get(struct klist_node *n)
613{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800614 struct device_private *p = to_device_private_parent(n);
615 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700616
617 get_device(dev);
618}
619
620static void klist_children_put(struct klist_node *n)
621{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800622 struct device_private *p = to_device_private_parent(n);
623 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700624
625 put_device(dev);
626}
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800629 * device_initialize - init device structure.
630 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 *
Cornelia Huck57394112008-09-03 18:26:40 +0200632 * This prepares the device for use by other layers by initializing
633 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800634 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200635 * that function, though it can also be called separately, so one
636 * may use @dev's fields. In particular, get_device()/put_device()
637 * may be used for reference counting of @dev after calling this
638 * function.
639 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500640 * All fields in @dev must be initialized by the caller to 0, except
641 * for those explicitly set to some other value. The simplest
642 * approach is to use kzalloc() to allocate the structure containing
643 * @dev.
644 *
Cornelia Huck57394112008-09-03 18:26:40 +0200645 * NOTE: Use put_device() to give up your reference instead of freeing
646 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648void device_initialize(struct device *dev)
649{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600650 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700651 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000653 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100654 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900655 spin_lock_init(&dev->devres_lock);
656 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400657 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800658 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659}
660
Kay Sievers86406242007-03-14 03:25:56 +0100661static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700662{
Kay Sievers86406242007-03-14 03:25:56 +0100663 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700664
Kay Sievers86406242007-03-14 03:25:56 +0100665 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800666 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600667 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700668
Kay Sievers86406242007-03-14 03:25:56 +0100669 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700670}
671
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700672struct class_dir {
673 struct kobject kobj;
674 struct class *class;
675};
676
677#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
678
679static void class_dir_release(struct kobject *kobj)
680{
681 struct class_dir *dir = to_class_dir(kobj);
682 kfree(dir);
683}
684
685static const
686struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
687{
688 struct class_dir *dir = to_class_dir(kobj);
689 return dir->class->ns_type;
690}
691
692static struct kobj_type class_dir_ktype = {
693 .release = class_dir_release,
694 .sysfs_ops = &kobj_sysfs_ops,
695 .child_ns_type = class_dir_child_ns_type
696};
697
698static struct kobject *
699class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
700{
701 struct class_dir *dir;
702 int retval;
703
704 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
705 if (!dir)
706 return NULL;
707
708 dir->class = class;
709 kobject_init(&dir->kobj, &class_dir_ktype);
710
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100711 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700712
713 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
714 if (retval < 0) {
715 kobject_put(&dir->kobj);
716 return NULL;
717 }
718 return &dir->kobj;
719}
720
721
Kay Sieversda231fd2007-11-21 17:29:15 +0100722static struct kobject *get_device_parent(struct device *dev,
723 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100724{
Kay Sievers86406242007-03-14 03:25:56 +0100725 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900726 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100727 struct kobject *kobj = NULL;
728 struct kobject *parent_kobj;
729 struct kobject *k;
730
Randy Dunlapead454f2010-09-24 14:36:49 -0700731#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700732 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200733 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700734 if (parent && parent->class == &block_class)
735 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100736 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700737 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700738#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200739
Kay Sievers86406242007-03-14 03:25:56 +0100740 /*
741 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100742 * Class-devices with a non class-device as parent, live
743 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100744 */
745 if (parent == NULL)
746 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700747 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100748 return &parent->kobj;
749 else
750 parent_kobj = &parent->kobj;
751
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900752 mutex_lock(&gdp_mutex);
753
Kay Sievers86406242007-03-14 03:25:56 +0100754 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100755 spin_lock(&dev->class->p->glue_dirs.list_lock);
756 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100757 if (k->parent == parent_kobj) {
758 kobj = kobject_get(k);
759 break;
760 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100761 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900762 if (kobj) {
763 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100764 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900765 }
Kay Sievers86406242007-03-14 03:25:56 +0100766
767 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700768 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100769 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900770 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800771 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100772 }
773
Kay Sieversca22e562011-12-14 14:29:38 -0800774 /* subsystems can specify a default root directory for their devices */
775 if (!parent && dev->bus && dev->bus->dev_root)
776 return &dev->bus->dev_root->kobj;
777
Kay Sievers86406242007-03-14 03:25:56 +0100778 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100779 return &parent->kobj;
780 return NULL;
781}
Kay Sieversda231fd2007-11-21 17:29:15 +0100782
Cornelia Huck63b69712008-01-21 16:09:44 +0100783static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100784{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100785 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100786 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100787 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100788 return;
789
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100790 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100791}
Cornelia Huck63b69712008-01-21 16:09:44 +0100792
793static void cleanup_device_parent(struct device *dev)
794{
795 cleanup_glue_dir(dev, dev->kobj.parent);
796}
Kay Sievers86406242007-03-14 03:25:56 +0100797
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700798static int device_add_class_symlinks(struct device *dev)
799{
800 int error;
801
802 if (!dev->class)
803 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100804
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700805 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100806 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700807 "subsystem");
808 if (error)
809 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100810
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800811 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700812 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
813 "device");
814 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700815 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700816 }
Kay Sievers39aba962010-09-04 22:33:14 -0700817
Randy Dunlapead454f2010-09-24 14:36:49 -0700818#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700819 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200820 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700821 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700822#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700823
824 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100825 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700826 &dev->kobj, dev_name(dev));
827 if (error)
828 goto out_device;
829
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700830 return 0;
831
Kay Sievers39aba962010-09-04 22:33:14 -0700832out_device:
833 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100834
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700835out_subsys:
836 sysfs_remove_link(&dev->kobj, "subsystem");
837out:
838 return error;
839}
840
841static void device_remove_class_symlinks(struct device *dev)
842{
843 if (!dev->class)
844 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100845
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800846 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100847 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700848 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700849#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200850 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700851 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700852#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100853 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700854}
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000857 * dev_set_name - set a device name
858 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700859 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000860 */
861int dev_set_name(struct device *dev, const char *fmt, ...)
862{
863 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100864 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000865
866 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100867 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000868 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100869 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000870}
871EXPORT_SYMBOL_GPL(dev_set_name);
872
873/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700874 * device_to_dev_kobj - select a /sys/dev/ directory for the device
875 * @dev: device
876 *
877 * By default we select char/ for new entries. Setting class->dev_obj
878 * to NULL prevents an entry from being created. class->dev_kobj must
879 * be set (or cleared) before any devices are registered to the class
880 * otherwise device_create_sys_dev_entry() and
881 * device_remove_sys_dev_entry() will disagree about the the presence
882 * of the link.
883 */
884static struct kobject *device_to_dev_kobj(struct device *dev)
885{
886 struct kobject *kobj;
887
888 if (dev->class)
889 kobj = dev->class->dev_kobj;
890 else
891 kobj = sysfs_dev_char_kobj;
892
893 return kobj;
894}
895
896static int device_create_sys_dev_entry(struct device *dev)
897{
898 struct kobject *kobj = device_to_dev_kobj(dev);
899 int error = 0;
900 char devt_str[15];
901
902 if (kobj) {
903 format_dev_t(devt_str, dev->devt);
904 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
905 }
906
907 return error;
908}
909
910static void device_remove_sys_dev_entry(struct device *dev)
911{
912 struct kobject *kobj = device_to_dev_kobj(dev);
913 char devt_str[15];
914
915 if (kobj) {
916 format_dev_t(devt_str, dev->devt);
917 sysfs_remove_link(kobj, devt_str);
918 }
919}
920
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700921int device_private_init(struct device *dev)
922{
923 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
924 if (!dev->p)
925 return -ENOMEM;
926 dev->p->device = dev;
927 klist_init(&dev->p->klist_children, klist_children_get,
928 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800929 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700930 return 0;
931}
932
Dan Williamse105b8b2008-04-21 10:51:07 -0700933/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800934 * device_add - add device to device hierarchy.
935 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800937 * This is part 2 of device_register(), though may be called
938 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 *
Cornelia Huck57394112008-09-03 18:26:40 +0200940 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800941 * to the global and sibling lists for the device, then
942 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200943 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500944 * Do not call this routine or device_register() more than once for
945 * any device structure. The driver model core is not designed to work
946 * with devices that get unregistered and then spring back to life.
947 * (Among other things, it's very hard to guarantee that all references
948 * to the previous incarnation of @dev have been dropped.) Allocate
949 * and register a fresh new struct device instead.
950 *
Cornelia Huck57394112008-09-03 18:26:40 +0200951 * NOTE: _Never_ directly free @dev after calling this function, even
952 * if it returned an error! Always use put_device() to give up your
953 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 */
955int device_add(struct device *dev)
956{
957 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800958 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200959 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700960 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700963 if (!dev)
964 goto done;
965
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800966 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700967 error = device_private_init(dev);
968 if (error)
969 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800970 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800971
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100972 /*
973 * for statically allocated devices, which should all be converted
974 * some day, we need to initialize the name. We prevent reading back
975 * the name, and force the use of dev_name()
976 */
977 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700978 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100979 dev->init_name = NULL;
980 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700981
Kay Sieversca22e562011-12-14 14:29:38 -0800982 /* subsystems can specify simple device enumeration */
983 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
984 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
985
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000986 if (!dev_name(dev)) {
987 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -0700988 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000989 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100991 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -0800994 kobj = get_device_parent(dev, parent);
995 if (kobj)
996 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Yinghai Lu0d358f22008-02-19 03:20:41 -0800998 /* use parent numa_node */
999 if (parent)
1000 set_dev_node(dev, dev_to_node(parent));
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001003 /* we require the name to be set before, and pass NULL */
1004 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001005 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001007
Brian Walsh37022642006-08-14 22:43:19 -07001008 /* notify platform of device entry */
1009 if (platform_notify)
1010 platform_notify(dev);
1011
Tejun Heoad6a1e12007-06-14 03:45:17 +09001012 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001013 if (error)
1014 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001015
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001016 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +09001017 error = device_create_file(dev, &devt_attr);
1018 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001019 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001020
1021 error = device_create_sys_dev_entry(dev);
1022 if (error)
1023 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001024
1025 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001026 }
1027
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001028 error = device_add_class_symlinks(dev);
1029 if (error)
1030 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001031 error = device_add_attrs(dev);
1032 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001033 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001034 error = bus_add_device(dev);
1035 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001037 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001038 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001039 goto DPMError;
1040 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001041
1042 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001043 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001044 */
1045 if (dev->bus)
1046 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1047 BUS_NOTIFY_ADD_DEVICE, dev);
1048
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001049 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001050 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001052 klist_add_tail(&dev->p->knode_parent,
1053 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001055 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001056 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001057 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001058 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001059 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001060
1061 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001062 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001063 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001064 if (class_intf->add_dev)
1065 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001066 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001067 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001068done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 put_device(dev);
1070 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001071 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001072 bus_remove_device(dev);
1073 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001074 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001075 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001076 device_remove_class_symlinks(dev);
1077 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001078 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001079 devtmpfs_delete_node(dev);
1080 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001081 device_remove_sys_dev_entry(dev);
1082 devtattrError:
1083 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +09001084 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001085 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001086 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001087 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001088 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 kobject_del(&dev->kobj);
1090 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001091 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 if (parent)
1093 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001094name_error:
1095 kfree(dev->p);
1096 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001097 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
1099
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001101 * device_register - register a device with the system.
1102 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001104 * This happens in two clean steps - initialize the device
1105 * and add it to the system. The two steps can be called
1106 * separately, but this is the easiest and most common.
1107 * I.e. you should only call the two helpers separately if
1108 * have a clearly defined need to use and refcount the device
1109 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001110 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001111 * For more information, see the kerneldoc for device_initialize()
1112 * and device_add().
1113 *
Cornelia Huck57394112008-09-03 18:26:40 +02001114 * NOTE: _Never_ directly free @dev after calling this function, even
1115 * if it returned an error! Always use put_device() to give up the
1116 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118int device_register(struct device *dev)
1119{
1120 device_initialize(dev);
1121 return device_add(dev);
1122}
1123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001125 * get_device - increment reference count for device.
1126 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001128 * This simply forwards the call to kobject_get(), though
1129 * we do take care to provide for the case that we get a NULL
1130 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001132struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133{
1134 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1135}
1136
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001138 * put_device - decrement reference count.
1139 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001141void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001143 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 if (dev)
1145 kobject_put(&dev->kobj);
1146}
1147
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001149 * device_del - delete device from system.
1150 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001152 * This is the first part of the device unregistration
1153 * sequence. This removes the device from the lists we control
1154 * from here, has it removed from the other driver model
1155 * subsystems it was added to in device_add(), and removes it
1156 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001158 * NOTE: this should be called manually _iff_ device_add() was
1159 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001161void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001163 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001164 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Alan Sternec0676ee2008-12-05 14:10:31 -05001166 /* Notify clients of device removal. This call must come
1167 * before dpm_sysfs_remove().
1168 */
1169 if (dev->bus)
1170 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1171 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001172 device_pm_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001173 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001175 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001176 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001177 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001178 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001179 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001180 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001181 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001182 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001183
Kay Sieversca22e562011-12-14 14:29:38 -08001184 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001185 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001186 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001187 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001188 if (class_intf->remove_dev)
1189 class_intf->remove_dev(dev, class_intf);
1190 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001191 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001192 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001193 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001194 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001195 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001196 bus_remove_device(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001197 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001199 /*
1200 * Some platform devices are driven without driver attached
1201 * and managed resources may have been acquired. Make sure
1202 * all resources are released.
1203 */
1204 devres_release_all(dev);
1205
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 /* Notify the platform of the removal, in case they
1207 * need to do anything...
1208 */
1209 if (platform_notify_remove)
1210 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001211 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001212 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001214 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
1216
1217/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001218 * device_unregister - unregister device from system.
1219 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001221 * We do this in two parts, like we do device_register(). First,
1222 * we remove it from all the subsystems with device_del(), then
1223 * we decrement the reference count via put_device(). If that
1224 * is the final reference count, the device will be cleaned up
1225 * via device_release() above. Otherwise, the structure will
1226 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001228void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001230 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 device_del(dev);
1232 put_device(dev);
1233}
1234
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001235static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001236{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001237 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001238 struct device *dev = NULL;
1239 struct device_private *p;
1240
1241 if (n) {
1242 p = to_device_private_parent(n);
1243 dev = p->device;
1244 }
1245 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001246}
1247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001249 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001250 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001251 * @mode: returned file access mode
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001252 * @tmp: possibly allocated string
1253 *
1254 * Return the relative path of a possible device node.
1255 * Non-default names may need to allocate a memory to compose
1256 * a name. This memory is returned in tmp and needs to be
1257 * freed by the caller.
1258 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001259const char *device_get_devnode(struct device *dev,
Al Viro2c9ede52011-07-23 20:24:48 -04001260 umode_t *mode, const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001261{
1262 char *s;
1263
1264 *tmp = NULL;
1265
1266 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001267 if (dev->type && dev->type->devnode)
1268 *tmp = dev->type->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001269 if (*tmp)
1270 return *tmp;
1271
1272 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001273 if (dev->class && dev->class->devnode)
1274 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001275 if (*tmp)
1276 return *tmp;
1277
1278 /* return name without allocation, tmp == NULL */
1279 if (strchr(dev_name(dev), '!') == NULL)
1280 return dev_name(dev);
1281
1282 /* replace '!' in the name with '/' */
1283 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1284 if (!*tmp)
1285 return NULL;
1286 while ((s = strchr(*tmp, '!')))
1287 s[0] = '/';
1288 return *tmp;
1289}
1290
1291/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001292 * device_for_each_child - device child iterator.
1293 * @parent: parent struct device.
1294 * @data: data for the callback.
1295 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001297 * Iterate over @parent's child devices, and call @fn for each,
1298 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001300 * We check the return of @fn each time. If it returns anything
1301 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001303int device_for_each_child(struct device *parent, void *data,
1304 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001306 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001307 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 int error = 0;
1309
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001310 if (!parent->p)
1311 return 0;
1312
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001313 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001314 while ((child = next_device(&i)) && !error)
1315 error = fn(child, data);
1316 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 return error;
1318}
1319
Cornelia Huck5ab69982006-11-16 15:42:07 +01001320/**
1321 * device_find_child - device iterator for locating a particular device.
1322 * @parent: parent struct device
1323 * @data: Data to pass to match function
1324 * @match: Callback function to check device
1325 *
1326 * This is similar to the device_for_each_child() function above, but it
1327 * returns a reference to a device that is 'found' for later use, as
1328 * determined by the @match callback.
1329 *
1330 * The callback should return 0 if the device doesn't match and non-zero
1331 * if it does. If the callback returns non-zero and a reference to the
1332 * current device can be obtained, this function will return to the caller
1333 * and not iterate over any more devices.
1334 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001335struct device *device_find_child(struct device *parent, void *data,
1336 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001337{
1338 struct klist_iter i;
1339 struct device *child;
1340
1341 if (!parent)
1342 return NULL;
1343
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001344 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001345 while ((child = next_device(&i)))
1346 if (match(child, data) && get_device(child))
1347 break;
1348 klist_iter_exit(&i);
1349 return child;
1350}
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352int __init devices_init(void)
1353{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001354 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1355 if (!devices_kset)
1356 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001357 dev_kobj = kobject_create_and_add("dev", NULL);
1358 if (!dev_kobj)
1359 goto dev_kobj_err;
1360 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1361 if (!sysfs_dev_block_kobj)
1362 goto block_kobj_err;
1363 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1364 if (!sysfs_dev_char_kobj)
1365 goto char_kobj_err;
1366
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001367 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001368
1369 char_kobj_err:
1370 kobject_put(sysfs_dev_block_kobj);
1371 block_kobj_err:
1372 kobject_put(dev_kobj);
1373 dev_kobj_err:
1374 kset_unregister(devices_kset);
1375 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376}
1377
1378EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001379EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
1381EXPORT_SYMBOL_GPL(device_initialize);
1382EXPORT_SYMBOL_GPL(device_add);
1383EXPORT_SYMBOL_GPL(device_register);
1384
1385EXPORT_SYMBOL_GPL(device_del);
1386EXPORT_SYMBOL_GPL(device_unregister);
1387EXPORT_SYMBOL_GPL(get_device);
1388EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
1390EXPORT_SYMBOL_GPL(device_create_file);
1391EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001392
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001393struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001394 struct device dev;
1395 struct module *owner;
1396};
1397
Ferenc Wagner481e2072011-01-07 15:17:47 +01001398inline struct root_device *to_root_device(struct device *d)
1399{
1400 return container_of(d, struct root_device, dev);
1401}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001402
1403static void root_device_release(struct device *dev)
1404{
1405 kfree(to_root_device(dev));
1406}
1407
1408/**
1409 * __root_device_register - allocate and register a root device
1410 * @name: root device name
1411 * @owner: owner module of the root device, usually THIS_MODULE
1412 *
1413 * This function allocates a root device and registers it
1414 * using device_register(). In order to free the returned
1415 * device, use root_device_unregister().
1416 *
1417 * Root devices are dummy devices which allow other devices
1418 * to be grouped under /sys/devices. Use this function to
1419 * allocate a root device and then use it as the parent of
1420 * any device which should appear under /sys/devices/{name}
1421 *
1422 * The /sys/devices/{name} directory will also contain a
1423 * 'module' symlink which points to the @owner directory
1424 * in sysfs.
1425 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001426 * Returns &struct device pointer on success, or ERR_PTR() on error.
1427 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001428 * Note: You probably want to use root_device_register().
1429 */
1430struct device *__root_device_register(const char *name, struct module *owner)
1431{
1432 struct root_device *root;
1433 int err = -ENOMEM;
1434
1435 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1436 if (!root)
1437 return ERR_PTR(err);
1438
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001439 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001440 if (err) {
1441 kfree(root);
1442 return ERR_PTR(err);
1443 }
1444
1445 root->dev.release = root_device_release;
1446
1447 err = device_register(&root->dev);
1448 if (err) {
1449 put_device(&root->dev);
1450 return ERR_PTR(err);
1451 }
1452
Christoph Egger1d9e8822010-05-17 16:57:58 +02001453#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001454 if (owner) {
1455 struct module_kobject *mk = &owner->mkobj;
1456
1457 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1458 if (err) {
1459 device_unregister(&root->dev);
1460 return ERR_PTR(err);
1461 }
1462 root->owner = owner;
1463 }
1464#endif
1465
1466 return &root->dev;
1467}
1468EXPORT_SYMBOL_GPL(__root_device_register);
1469
1470/**
1471 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001472 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001473 *
1474 * This function unregisters and cleans up a device that was created by
1475 * root_device_register().
1476 */
1477void root_device_unregister(struct device *dev)
1478{
1479 struct root_device *root = to_root_device(dev);
1480
1481 if (root->owner)
1482 sysfs_remove_link(&root->dev.kobj, "module");
1483
1484 device_unregister(dev);
1485}
1486EXPORT_SYMBOL_GPL(root_device_unregister);
1487
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001488
1489static void device_create_release(struct device *dev)
1490{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001491 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001492 kfree(dev);
1493}
1494
1495/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001496 * device_create_vargs - creates a device and registers it with sysfs
1497 * @class: pointer to the struct class that this device should be registered to
1498 * @parent: pointer to the parent struct device of this new device, if any
1499 * @devt: the dev_t for the char device to be added
1500 * @drvdata: the data to be added to the device for callbacks
1501 * @fmt: string for the device's name
1502 * @args: va_list for the device's name
1503 *
1504 * This function can be used by char device classes. A struct device
1505 * will be created in sysfs, registered to the specified class.
1506 *
1507 * A "dev" file will be created, showing the dev_t for the device, if
1508 * the dev_t is not 0,0.
1509 * If a pointer to a parent struct device is passed in, the newly created
1510 * struct device will be a child of that device in sysfs.
1511 * The pointer to the struct device will be returned from the call.
1512 * Any further sysfs files that might be required can be created using this
1513 * pointer.
1514 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001515 * Returns &struct device pointer on success, or ERR_PTR() on error.
1516 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001517 * Note: the struct class passed to this function must have previously
1518 * been created with a call to class_create().
1519 */
1520struct device *device_create_vargs(struct class *class, struct device *parent,
1521 dev_t devt, void *drvdata, const char *fmt,
1522 va_list args)
1523{
1524 struct device *dev = NULL;
1525 int retval = -ENODEV;
1526
1527 if (class == NULL || IS_ERR(class))
1528 goto error;
1529
1530 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1531 if (!dev) {
1532 retval = -ENOMEM;
1533 goto error;
1534 }
1535
1536 dev->devt = devt;
1537 dev->class = class;
1538 dev->parent = parent;
1539 dev->release = device_create_release;
1540 dev_set_drvdata(dev, drvdata);
1541
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001542 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1543 if (retval)
1544 goto error;
1545
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001546 retval = device_register(dev);
1547 if (retval)
1548 goto error;
1549
1550 return dev;
1551
1552error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001553 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001554 return ERR_PTR(retval);
1555}
1556EXPORT_SYMBOL_GPL(device_create_vargs);
1557
1558/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001559 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001560 * @class: pointer to the struct class that this device should be registered to
1561 * @parent: pointer to the parent struct device of this new device, if any
1562 * @devt: the dev_t for the char device to be added
1563 * @drvdata: the data to be added to the device for callbacks
1564 * @fmt: string for the device's name
1565 *
1566 * This function can be used by char device classes. A struct device
1567 * will be created in sysfs, registered to the specified class.
1568 *
1569 * A "dev" file will be created, showing the dev_t for the device, if
1570 * the dev_t is not 0,0.
1571 * If a pointer to a parent struct device is passed in, the newly created
1572 * struct device will be a child of that device in sysfs.
1573 * The pointer to the struct device will be returned from the call.
1574 * Any further sysfs files that might be required can be created using this
1575 * pointer.
1576 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001577 * Returns &struct device pointer on success, or ERR_PTR() on error.
1578 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001579 * Note: the struct class passed to this function must have previously
1580 * been created with a call to class_create().
1581 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001582struct device *device_create(struct class *class, struct device *parent,
1583 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001584{
1585 va_list vargs;
1586 struct device *dev;
1587
1588 va_start(vargs, fmt);
1589 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1590 va_end(vargs);
1591 return dev;
1592}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001593EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001594
Dave Youngcd354492008-01-28 16:56:11 +08001595static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001596{
Dave Youngcd354492008-01-28 16:56:11 +08001597 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001598
Dave Youngcd354492008-01-28 16:56:11 +08001599 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001600}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001601
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001602/**
1603 * device_destroy - removes a device that was created with device_create()
1604 * @class: pointer to the struct class that this device was registered with
1605 * @devt: the dev_t of the device that was previously registered
1606 *
1607 * This call unregisters and cleans up a device that was created with a
1608 * call to device_create().
1609 */
1610void device_destroy(struct class *class, dev_t devt)
1611{
1612 struct device *dev;
1613
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001614 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001615 if (dev) {
1616 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001617 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001618 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001619}
1620EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001621
1622/**
1623 * device_rename - renames a device
1624 * @dev: the pointer to the struct device to be renamed
1625 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001626 *
1627 * It is the responsibility of the caller to provide mutual
1628 * exclusion between two different calls of device_rename
1629 * on the same device to ensure that new_name is valid and
1630 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001631 *
Timur Tabia5462512010-12-13 14:08:52 -06001632 * Note: Don't call this function. Currently, the networking layer calls this
1633 * function, but that will change. The following text from Kay Sievers offers
1634 * some insight:
1635 *
1636 * Renaming devices is racy at many levels, symlinks and other stuff are not
1637 * replaced atomically, and you get a "move" uevent, but it's not easy to
1638 * connect the event to the old and new device. Device nodes are not renamed at
1639 * all, there isn't even support for that in the kernel now.
1640 *
1641 * In the meantime, during renaming, your target name might be taken by another
1642 * driver, creating conflicts. Or the old name is taken directly after you
1643 * renamed it -- then you get events for the same DEVPATH, before you even see
1644 * the "move" event. It's just a mess, and nothing new should ever rely on
1645 * kernel device renaming. Besides that, it's not even implemented now for
1646 * other things than (driver-core wise very simple) network devices.
1647 *
1648 * We are currently about to change network renaming in udev to completely
1649 * disallow renaming of devices in the same namespace as the kernel uses,
1650 * because we can't solve the problems properly, that arise with swapping names
1651 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1652 * be allowed to some other name than eth[0-9]*, for the aforementioned
1653 * reasons.
1654 *
1655 * Make up a "real" name in the driver before you register anything, or add
1656 * some other attributes for userspace to find the device, or use udev to add
1657 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1658 * don't even want to get into that and try to implement the missing pieces in
1659 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001660 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001661int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001662{
1663 char *old_class_name = NULL;
1664 char *new_class_name = NULL;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001665 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001666 int error;
1667
1668 dev = get_device(dev);
1669 if (!dev)
1670 return -EINVAL;
1671
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001672 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001673 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001674
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001675 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001676 if (!old_device_name) {
1677 error = -ENOMEM;
1678 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001679 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001680
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001681 if (dev->class) {
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001682 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001683 &dev->kobj, old_device_name, new_name);
1684 if (error)
1685 goto out;
1686 }
Kay Sievers39aba962010-09-04 22:33:14 -07001687
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001688 error = kobject_rename(&dev->kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001689 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001690 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001691
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001692out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001693 put_device(dev);
1694
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001695 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001696 kfree(old_class_name);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001697 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001698
1699 return error;
1700}
Johannes Berga2807db2007-02-28 12:38:31 +01001701EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001702
1703static int device_move_class_links(struct device *dev,
1704 struct device *old_parent,
1705 struct device *new_parent)
1706{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001707 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001708
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001709 if (old_parent)
1710 sysfs_remove_link(&dev->kobj, "device");
1711 if (new_parent)
1712 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1713 "device");
1714 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001715}
1716
1717/**
1718 * device_move - moves a device to a new parent
1719 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001720 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001721 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001722 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001723int device_move(struct device *dev, struct device *new_parent,
1724 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001725{
1726 int error;
1727 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001728 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001729
1730 dev = get_device(dev);
1731 if (!dev)
1732 return -EINVAL;
1733
Cornelia Huckffa6a702009-03-04 12:44:00 +01001734 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001735 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001736 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001737
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001738 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1739 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001740 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001741 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001742 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001743 put_device(new_parent);
1744 goto out;
1745 }
1746 old_parent = dev->parent;
1747 dev->parent = new_parent;
1748 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001749 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001750 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001751 klist_add_tail(&dev->p->knode_parent,
1752 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001753 set_dev_node(dev, dev_to_node(new_parent));
1754 }
1755
Cornelia Huck8a824722006-11-20 17:07:51 +01001756 if (!dev->class)
1757 goto out_put;
1758 error = device_move_class_links(dev, old_parent, new_parent);
1759 if (error) {
1760 /* We ignore errors on cleanup since we're hosed anyway... */
1761 device_move_class_links(dev, new_parent, old_parent);
1762 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001763 if (new_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001764 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001765 dev->parent = old_parent;
1766 if (old_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001767 klist_add_tail(&dev->p->knode_parent,
1768 &old_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001769 set_dev_node(dev, dev_to_node(old_parent));
1770 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001771 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001772 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001773 put_device(new_parent);
1774 goto out;
1775 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001776 switch (dpm_order) {
1777 case DPM_ORDER_NONE:
1778 break;
1779 case DPM_ORDER_DEV_AFTER_PARENT:
1780 device_pm_move_after(dev, new_parent);
1781 break;
1782 case DPM_ORDER_PARENT_BEFORE_DEV:
1783 device_pm_move_before(new_parent, dev);
1784 break;
1785 case DPM_ORDER_DEV_LAST:
1786 device_pm_move_last(dev);
1787 break;
1788 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001789out_put:
1790 put_device(old_parent);
1791out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001792 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001793 put_device(dev);
1794 return error;
1795}
Cornelia Huck8a824722006-11-20 17:07:51 +01001796EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001797
1798/**
1799 * device_shutdown - call ->shutdown() on each device to shutdown.
1800 */
1801void device_shutdown(void)
1802{
Hugh Daschbach62458382010-03-22 10:36:37 -07001803 struct device *dev;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001804
Hugh Daschbach62458382010-03-22 10:36:37 -07001805 spin_lock(&devices_kset->list_lock);
1806 /*
1807 * Walk the devices list backward, shutting down each in turn.
1808 * Beware that device unplug events may also start pulling
1809 * devices offline, even as the system is shutting down.
1810 */
1811 while (!list_empty(&devices_kset->list)) {
1812 dev = list_entry(devices_kset->list.prev, struct device,
1813 kobj.entry);
1814 get_device(dev);
1815 /*
1816 * Make sure the device is off the kset list, in the
1817 * event that dev->*->shutdown() doesn't remove it.
1818 */
1819 list_del_init(&dev->kobj.entry);
1820 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001821
1822 /* Don't allow any more runtime suspends */
1823 pm_runtime_get_noresume(dev);
1824 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001825
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001826 if (dev->bus && dev->bus->shutdown) {
1827 dev_dbg(dev, "shutdown\n");
1828 dev->bus->shutdown(dev);
1829 } else if (dev->driver && dev->driver->shutdown) {
1830 dev_dbg(dev, "shutdown\n");
1831 dev->driver->shutdown(dev);
1832 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001833 put_device(dev);
1834
1835 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001836 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001837 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07001838 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001839}
Joe Perches99bcf212010-06-27 01:02:34 +00001840
1841/*
1842 * Device logging functions
1843 */
1844
1845#ifdef CONFIG_PRINTK
1846
Joe Perchescbc46632011-08-11 14:36:21 -04001847int __dev_printk(const char *level, const struct device *dev,
1848 struct va_format *vaf)
Joe Perches99bcf212010-06-27 01:02:34 +00001849{
1850 if (!dev)
1851 return printk("%s(NULL device *): %pV", level, vaf);
1852
1853 return printk("%s%s %s: %pV",
1854 level, dev_driver_string(dev), dev_name(dev), vaf);
1855}
Joe Perchescbc46632011-08-11 14:36:21 -04001856EXPORT_SYMBOL(__dev_printk);
Joe Perches99bcf212010-06-27 01:02:34 +00001857
1858int dev_printk(const char *level, const struct device *dev,
1859 const char *fmt, ...)
1860{
1861 struct va_format vaf;
1862 va_list args;
1863 int r;
1864
1865 va_start(args, fmt);
1866
1867 vaf.fmt = fmt;
1868 vaf.va = &args;
1869
1870 r = __dev_printk(level, dev, &vaf);
1871 va_end(args);
1872
1873 return r;
1874}
1875EXPORT_SYMBOL(dev_printk);
1876
1877#define define_dev_printk_level(func, kern_level) \
1878int func(const struct device *dev, const char *fmt, ...) \
1879{ \
1880 struct va_format vaf; \
1881 va_list args; \
1882 int r; \
1883 \
1884 va_start(args, fmt); \
1885 \
1886 vaf.fmt = fmt; \
1887 vaf.va = &args; \
1888 \
1889 r = __dev_printk(kern_level, dev, &vaf); \
1890 va_end(args); \
1891 \
1892 return r; \
1893} \
1894EXPORT_SYMBOL(func);
1895
1896define_dev_printk_level(dev_emerg, KERN_EMERG);
1897define_dev_printk_level(dev_alert, KERN_ALERT);
1898define_dev_printk_level(dev_crit, KERN_CRIT);
1899define_dev_printk_level(dev_err, KERN_ERR);
1900define_dev_printk_level(dev_warn, KERN_WARNING);
1901define_dev_printk_level(dev_notice, KERN_NOTICE);
1902define_dev_printk_level(_dev_info, KERN_INFO);
1903
1904#endif