blob: 846d12b5d5794942b743a53c1c8fd513358995d9 [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>
Kay Sieversc4e00da2012-05-03 02:29:59 +020028#include <linux/netdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#include "base.h"
31#include "power/power.h"
32
Andi Kleene52eec12010-09-08 16:54:17 +020033#ifdef CONFIG_SYSFS_DEPRECATED
34#ifdef CONFIG_SYSFS_DEPRECATED_V2
35long sysfs_deprecated = 1;
36#else
37long sysfs_deprecated = 0;
38#endif
39static __init int sysfs_deprecated_setup(char *arg)
40{
41 return strict_strtol(arg, 10, &sysfs_deprecated);
42}
43early_param("sysfs.deprecated", sysfs_deprecated_setup);
44#endif
45
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080046int (*platform_notify)(struct device *dev) = NULL;
47int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070048static struct kobject *dev_kobj;
49struct kobject *sysfs_dev_char_kobj;
50struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080052#ifdef CONFIG_BLOCK
53static inline int device_is_not_partition(struct device *dev)
54{
55 return !(dev->type == &part_type);
56}
57#else
58static inline int device_is_not_partition(struct device *dev)
59{
60 return 1;
61}
62#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Alan Stern3e956372006-06-16 17:10:48 -040064/**
65 * dev_driver_string - Return a device's driver name, if at all possible
66 * @dev: struct device to get the name of
67 *
68 * Will return the device's driver's name if it is bound to a device. If
yan9169c012012-04-20 21:08:45 +080069 * the device is not bound to a driver, it will return the name of the bus
Alan Stern3e956372006-06-16 17:10:48 -040070 * it is attached to. If it is not attached to a bus either, an empty
71 * string will be returned.
72 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070073const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040074{
Alan Stern35899722009-12-04 11:06:57 -050075 struct device_driver *drv;
76
77 /* dev->driver can change to NULL underneath us because of unbinding,
78 * so be careful about accessing it. dev->bus and dev->class should
79 * never change once they are set, so they don't need special care.
80 */
81 drv = ACCESS_ONCE(dev->driver);
82 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +010083 (dev->bus ? dev->bus->name :
84 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040085}
Matthew Wilcox310a9222006-09-23 23:35:04 -060086EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040087
Linus Torvalds1da177e2005-04-16 15:20:36 -070088#define to_dev(obj) container_of(obj, struct device, kobj)
89#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
90
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080091static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
92 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080094 struct device_attribute *dev_attr = to_dev_attr(attr);
95 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050096 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040099 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -0800100 if (ret >= (ssize_t)PAGE_SIZE) {
101 print_symbol("dev_attr_show: %s returned bad count\n",
102 (unsigned long)dev_attr->show);
103 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 return ret;
105}
106
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800107static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
108 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800110 struct device_attribute *dev_attr = to_dev_attr(attr);
111 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500112 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400115 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 return ret;
117}
118
Emese Revfy52cf25d2010-01-19 02:58:23 +0100119static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 .show = dev_attr_show,
121 .store = dev_attr_store,
122};
123
Kay Sieversca22e562011-12-14 14:29:38 -0800124#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
125
126ssize_t device_store_ulong(struct device *dev,
127 struct device_attribute *attr,
128 const char *buf, size_t size)
129{
130 struct dev_ext_attribute *ea = to_ext_attr(attr);
131 char *end;
132 unsigned long new = simple_strtoul(buf, &end, 0);
133 if (end == buf)
134 return -EINVAL;
135 *(unsigned long *)(ea->var) = new;
136 /* Always return full write size even if we didn't consume all */
137 return size;
138}
139EXPORT_SYMBOL_GPL(device_store_ulong);
140
141ssize_t device_show_ulong(struct device *dev,
142 struct device_attribute *attr,
143 char *buf)
144{
145 struct dev_ext_attribute *ea = to_ext_attr(attr);
146 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
147}
148EXPORT_SYMBOL_GPL(device_show_ulong);
149
150ssize_t device_store_int(struct device *dev,
151 struct device_attribute *attr,
152 const char *buf, size_t size)
153{
154 struct dev_ext_attribute *ea = to_ext_attr(attr);
155 char *end;
156 long new = simple_strtol(buf, &end, 0);
157 if (end == buf || new > INT_MAX || new < INT_MIN)
158 return -EINVAL;
159 *(int *)(ea->var) = new;
160 /* Always return full write size even if we didn't consume all */
161 return size;
162}
163EXPORT_SYMBOL_GPL(device_store_int);
164
165ssize_t device_show_int(struct device *dev,
166 struct device_attribute *attr,
167 char *buf)
168{
169 struct dev_ext_attribute *ea = to_ext_attr(attr);
170
171 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
172}
173EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175/**
176 * device_release - free device structure.
177 * @kobj: device's kobject.
178 *
179 * This is called once the reference count for the object
180 * reaches 0. We forward the call to the device's release
181 * method, which should handle actually freeing the structure.
182 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800183static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800185 struct device *dev = to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800186 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 if (dev->release)
189 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200190 else if (dev->type && dev->type->release)
191 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700192 else if (dev->class && dev->class->dev_release)
193 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700194 else
195 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800196 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100197 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800198 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199}
200
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700201static const void *device_namespace(struct kobject *kobj)
202{
203 struct device *dev = to_dev(kobj);
204 const void *ns = NULL;
205
206 if (dev->class && dev->class->ns_type)
207 ns = dev->class->namespace(dev);
208
209 return ns;
210}
211
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600212static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 .release = device_release,
214 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700215 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216};
217
218
Kay Sievers312c0042005-11-16 09:00:00 +0100219static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
221 struct kobj_type *ktype = get_ktype(kobj);
222
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600223 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 struct device *dev = to_dev(kobj);
225 if (dev->bus)
226 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700227 if (dev->class)
228 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 }
230 return 0;
231}
232
Kay Sievers312c0042005-11-16 09:00:00 +0100233static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 struct device *dev = to_dev(kobj);
236
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700237 if (dev->bus)
238 return dev->bus->name;
239 if (dev->class)
240 return dev->class->name;
241 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242}
243
Kay Sievers7eff2e72007-08-14 15:15:12 +0200244static int dev_uevent(struct kset *kset, struct kobject *kobj,
245 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
247 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 int retval = 0;
249
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200250 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700251 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200252 const char *tmp;
253 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400254 umode_t mode = 0;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200255
Kay Sievers7eff2e72007-08-14 15:15:12 +0200256 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
257 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sieverse454cea2009-09-18 23:01:12 +0200258 name = device_get_devnode(dev, &mode, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200259 if (name) {
260 add_uevent_var(env, "DEVNAME=%s", name);
261 kfree(tmp);
Kay Sieverse454cea2009-09-18 23:01:12 +0200262 if (mode)
263 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200264 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700265 }
266
Kay Sievers414264f2007-03-12 21:08:57 +0100267 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200268 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100269
Kay Sievers239378f2006-10-07 21:54:55 +0200270 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200271 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200272
Grant Likely07d57a32012-02-01 11:22:22 -0700273 /* Add common DT information about the device */
274 of_device_uevent(dev, env);
275
Kay Sievers7eff2e72007-08-14 15:15:12 +0200276 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100277 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200278 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200279 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800280 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100281 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 }
283
Kay Sievers7eff2e72007-08-14 15:15:12 +0200284 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700285 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200286 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200287 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800288 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100289 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800290 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200291 }
292
Stefan Weileef35c22010-08-06 21:11:15 +0200293 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200294 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200295 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200296 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800297 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100298 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800299 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700300 }
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 return retval;
303}
304
Emese Revfy9cd43612009-12-31 14:52:51 +0100305static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100306 .filter = dev_uevent_filter,
307 .name = dev_uevent_name,
308 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309};
310
Kay Sievers16574dc2007-04-06 01:40:38 +0200311static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
312 char *buf)
313{
314 struct kobject *top_kobj;
315 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200316 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200317 int i;
318 size_t count = 0;
319 int retval;
320
321 /* search the kset, the device belongs to */
322 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200323 while (!top_kobj->kset && top_kobj->parent)
324 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200325 if (!top_kobj->kset)
326 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200327
Kay Sievers16574dc2007-04-06 01:40:38 +0200328 kset = top_kobj->kset;
329 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
330 goto out;
331
332 /* respect filter */
333 if (kset->uevent_ops && kset->uevent_ops->filter)
334 if (!kset->uevent_ops->filter(kset, &dev->kobj))
335 goto out;
336
Kay Sievers7eff2e72007-08-14 15:15:12 +0200337 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
338 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200339 return -ENOMEM;
340
Kay Sievers16574dc2007-04-06 01:40:38 +0200341 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200342 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200343 if (retval)
344 goto out;
345
346 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200347 for (i = 0; i < env->envp_idx; i++)
348 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200349out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200350 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200351 return count;
352}
353
Kay Sieversa7fd6702005-10-01 14:49:43 +0200354static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
355 const char *buf, size_t count)
356{
Kay Sievers60a96a52007-07-08 22:29:26 +0200357 enum kobject_action action;
358
Kay Sievers3f5468c2010-01-14 22:54:37 +0100359 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200360 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100361 else
362 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200363 return count;
364}
365
Tejun Heoad6a1e12007-06-14 03:45:17 +0900366static struct device_attribute uevent_attr =
367 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
368
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500369static int device_add_attributes(struct device *dev,
370 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700371{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700372 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500373 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700374
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500375 if (attrs) {
376 for (i = 0; attr_name(attrs[i]); i++) {
377 error = device_create_file(dev, &attrs[i]);
378 if (error)
379 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700380 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500381 if (error)
382 while (--i >= 0)
383 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700384 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700385 return error;
386}
387
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500388static void device_remove_attributes(struct device *dev,
389 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700390{
391 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500392
393 if (attrs)
394 for (i = 0; attr_name(attrs[i]); i++)
395 device_remove_file(dev, &attrs[i]);
396}
397
Stefan Achatzc97415a2010-11-26 19:57:29 +0000398static int device_add_bin_attributes(struct device *dev,
399 struct bin_attribute *attrs)
400{
401 int error = 0;
402 int i;
403
404 if (attrs) {
405 for (i = 0; attr_name(attrs[i]); i++) {
406 error = device_create_bin_file(dev, &attrs[i]);
407 if (error)
408 break;
409 }
410 if (error)
411 while (--i >= 0)
412 device_remove_bin_file(dev, &attrs[i]);
413 }
414 return error;
415}
416
417static void device_remove_bin_attributes(struct device *dev,
418 struct bin_attribute *attrs)
419{
420 int i;
421
422 if (attrs)
423 for (i = 0; attr_name(attrs[i]); i++)
424 device_remove_bin_file(dev, &attrs[i]);
425}
426
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500427static int device_add_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700428 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500429{
430 int error = 0;
431 int i;
432
433 if (groups) {
434 for (i = 0; groups[i]; i++) {
435 error = sysfs_create_group(&dev->kobj, groups[i]);
436 if (error) {
437 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800438 sysfs_remove_group(&dev->kobj,
439 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500440 break;
441 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700442 }
443 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500444 return error;
445}
446
447static void device_remove_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700448 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500449{
450 int i;
451
452 if (groups)
453 for (i = 0; groups[i]; i++)
454 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700455}
456
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700457static int device_add_attrs(struct device *dev)
458{
459 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700460 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500461 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700462
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500463 if (class) {
464 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200465 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500466 return error;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000467 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
468 if (error)
469 goto err_remove_class_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700470 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200471
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500472 if (type) {
473 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200474 if (error)
Stefan Achatzc97415a2010-11-26 19:57:29 +0000475 goto err_remove_class_bin_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200476 }
477
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500478 error = device_add_groups(dev, dev->groups);
479 if (error)
480 goto err_remove_type_groups;
481
482 return 0;
483
484 err_remove_type_groups:
485 if (type)
486 device_remove_groups(dev, type->groups);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000487 err_remove_class_bin_attrs:
488 if (class)
489 device_remove_bin_attributes(dev, class->dev_bin_attrs);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500490 err_remove_class_attrs:
491 if (class)
492 device_remove_attributes(dev, class->dev_attrs);
493
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700494 return error;
495}
496
497static void device_remove_attrs(struct device *dev)
498{
499 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700500 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700501
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500502 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200503
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500504 if (type)
505 device_remove_groups(dev, type->groups);
506
Stefan Achatzc97415a2010-11-26 19:57:29 +0000507 if (class) {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500508 device_remove_attributes(dev, class->dev_attrs);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000509 device_remove_bin_attributes(dev, class->dev_bin_attrs);
510 }
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700511}
512
513
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700514static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
515 char *buf)
516{
517 return print_dev_t(buf, dev->devt);
518}
519
Tejun Heoad6a1e12007-06-14 03:45:17 +0900520static struct device_attribute devt_attr =
521 __ATTR(dev, S_IRUGO, show_dev, NULL);
522
Kay Sieversca22e562011-12-14 14:29:38 -0800523/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600524struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800527 * device_create_file - create sysfs attribute file for device.
528 * @dev: device.
529 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200531int device_create_file(struct device *dev,
532 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
534 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100535 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 return error;
538}
539
540/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800541 * device_remove_file - remove sysfs attribute file.
542 * @dev: device.
543 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200545void device_remove_file(struct device *dev,
546 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100548 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550}
551
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700552/**
553 * device_create_bin_file - create sysfs binary attribute file for device.
554 * @dev: device.
555 * @attr: device binary attribute descriptor.
556 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200557int device_create_bin_file(struct device *dev,
558 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700559{
560 int error = -EINVAL;
561 if (dev)
562 error = sysfs_create_bin_file(&dev->kobj, attr);
563 return error;
564}
565EXPORT_SYMBOL_GPL(device_create_bin_file);
566
567/**
568 * device_remove_bin_file - remove sysfs binary attribute file
569 * @dev: device.
570 * @attr: device binary attribute descriptor.
571 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200572void device_remove_bin_file(struct device *dev,
573 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700574{
575 if (dev)
576 sysfs_remove_bin_file(&dev->kobj, attr);
577}
578EXPORT_SYMBOL_GPL(device_remove_bin_file);
579
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400580/**
Alan Stern523ded72007-04-26 00:12:04 -0700581 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400582 * @dev: device.
583 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700584 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400585 *
586 * Attribute methods must not unregister themselves or their parent device
587 * (which would amount to the same thing). Attempts to do so will deadlock,
588 * since unregistration is mutually exclusive with driver callbacks.
589 *
590 * Instead methods can call this routine, which will attempt to allocate
591 * and schedule a workqueue request to call back @func with @dev as its
592 * argument in the workqueue's process context. @dev will be pinned until
593 * @func returns.
594 *
Alan Stern523ded72007-04-26 00:12:04 -0700595 * This routine is usually called via the inline device_schedule_callback(),
596 * which automatically sets @owner to THIS_MODULE.
597 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400598 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700599 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400600 *
601 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
602 * underlying sysfs routine (since it is intended for use by attribute
603 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
604 */
Alan Stern523ded72007-04-26 00:12:04 -0700605int device_schedule_callback_owner(struct device *dev,
606 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400607{
608 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700609 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400610}
Alan Stern523ded72007-04-26 00:12:04 -0700611EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400612
James Bottomley34bb61f2005-09-06 16:56:51 -0700613static void klist_children_get(struct klist_node *n)
614{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800615 struct device_private *p = to_device_private_parent(n);
616 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700617
618 get_device(dev);
619}
620
621static void klist_children_put(struct klist_node *n)
622{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800623 struct device_private *p = to_device_private_parent(n);
624 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700625
626 put_device(dev);
627}
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800630 * device_initialize - init device structure.
631 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 *
Cornelia Huck57394112008-09-03 18:26:40 +0200633 * This prepares the device for use by other layers by initializing
634 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800635 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200636 * that function, though it can also be called separately, so one
637 * may use @dev's fields. In particular, get_device()/put_device()
638 * may be used for reference counting of @dev after calling this
639 * function.
640 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500641 * All fields in @dev must be initialized by the caller to 0, except
642 * for those explicitly set to some other value. The simplest
643 * approach is to use kzalloc() to allocate the structure containing
644 * @dev.
645 *
Cornelia Huck57394112008-09-03 18:26:40 +0200646 * NOTE: Use put_device() to give up your reference instead of freeing
647 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649void device_initialize(struct device *dev)
650{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600651 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700652 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000654 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100655 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900656 spin_lock_init(&dev->devres_lock);
657 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400658 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800659 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
661
Kay Sievers86406242007-03-14 03:25:56 +0100662static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700663{
Kay Sievers86406242007-03-14 03:25:56 +0100664 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700665
Kay Sievers86406242007-03-14 03:25:56 +0100666 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800667 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600668 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700669
Kay Sievers86406242007-03-14 03:25:56 +0100670 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700671}
672
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700673struct class_dir {
674 struct kobject kobj;
675 struct class *class;
676};
677
678#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
679
680static void class_dir_release(struct kobject *kobj)
681{
682 struct class_dir *dir = to_class_dir(kobj);
683 kfree(dir);
684}
685
686static const
687struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
688{
689 struct class_dir *dir = to_class_dir(kobj);
690 return dir->class->ns_type;
691}
692
693static struct kobj_type class_dir_ktype = {
694 .release = class_dir_release,
695 .sysfs_ops = &kobj_sysfs_ops,
696 .child_ns_type = class_dir_child_ns_type
697};
698
699static struct kobject *
700class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
701{
702 struct class_dir *dir;
703 int retval;
704
705 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
706 if (!dir)
707 return NULL;
708
709 dir->class = class;
710 kobject_init(&dir->kobj, &class_dir_ktype);
711
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100712 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700713
714 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
715 if (retval < 0) {
716 kobject_put(&dir->kobj);
717 return NULL;
718 }
719 return &dir->kobj;
720}
721
722
Kay Sieversda231fd2007-11-21 17:29:15 +0100723static struct kobject *get_device_parent(struct device *dev,
724 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100725{
Kay Sievers86406242007-03-14 03:25:56 +0100726 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900727 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100728 struct kobject *kobj = NULL;
729 struct kobject *parent_kobj;
730 struct kobject *k;
731
Randy Dunlapead454f2010-09-24 14:36:49 -0700732#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700733 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200734 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700735 if (parent && parent->class == &block_class)
736 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100737 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700738 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700739#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200740
Kay Sievers86406242007-03-14 03:25:56 +0100741 /*
742 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100743 * Class-devices with a non class-device as parent, live
744 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100745 */
746 if (parent == NULL)
747 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700748 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100749 return &parent->kobj;
750 else
751 parent_kobj = &parent->kobj;
752
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900753 mutex_lock(&gdp_mutex);
754
Kay Sievers86406242007-03-14 03:25:56 +0100755 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100756 spin_lock(&dev->class->p->glue_dirs.list_lock);
757 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100758 if (k->parent == parent_kobj) {
759 kobj = kobject_get(k);
760 break;
761 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100762 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900763 if (kobj) {
764 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100765 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900766 }
Kay Sievers86406242007-03-14 03:25:56 +0100767
768 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700769 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100770 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900771 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800772 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100773 }
774
Kay Sieversca22e562011-12-14 14:29:38 -0800775 /* subsystems can specify a default root directory for their devices */
776 if (!parent && dev->bus && dev->bus->dev_root)
777 return &dev->bus->dev_root->kobj;
778
Kay Sievers86406242007-03-14 03:25:56 +0100779 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100780 return &parent->kobj;
781 return NULL;
782}
Kay Sieversda231fd2007-11-21 17:29:15 +0100783
Cornelia Huck63b69712008-01-21 16:09:44 +0100784static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100785{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100786 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100787 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100788 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100789 return;
790
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100791 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100792}
Cornelia Huck63b69712008-01-21 16:09:44 +0100793
794static void cleanup_device_parent(struct device *dev)
795{
796 cleanup_glue_dir(dev, dev->kobj.parent);
797}
Kay Sievers86406242007-03-14 03:25:56 +0100798
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700799static int device_add_class_symlinks(struct device *dev)
800{
801 int error;
802
803 if (!dev->class)
804 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100805
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700806 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100807 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700808 "subsystem");
809 if (error)
810 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100811
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800812 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700813 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
814 "device");
815 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700816 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700817 }
Kay Sievers39aba962010-09-04 22:33:14 -0700818
Randy Dunlapead454f2010-09-24 14:36:49 -0700819#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700820 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200821 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700822 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700823#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700824
825 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100826 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700827 &dev->kobj, dev_name(dev));
828 if (error)
829 goto out_device;
830
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700831 return 0;
832
Kay Sievers39aba962010-09-04 22:33:14 -0700833out_device:
834 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100835
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700836out_subsys:
837 sysfs_remove_link(&dev->kobj, "subsystem");
838out:
839 return error;
840}
841
842static void device_remove_class_symlinks(struct device *dev)
843{
844 if (!dev->class)
845 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100846
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800847 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100848 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700849 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700850#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200851 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700852 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700853#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100854 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700855}
856
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000858 * dev_set_name - set a device name
859 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700860 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000861 */
862int dev_set_name(struct device *dev, const char *fmt, ...)
863{
864 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100865 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000866
867 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100868 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000869 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100870 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000871}
872EXPORT_SYMBOL_GPL(dev_set_name);
873
874/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700875 * device_to_dev_kobj - select a /sys/dev/ directory for the device
876 * @dev: device
877 *
878 * By default we select char/ for new entries. Setting class->dev_obj
879 * to NULL prevents an entry from being created. class->dev_kobj must
880 * be set (or cleared) before any devices are registered to the class
881 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200882 * device_remove_sys_dev_entry() will disagree about the presence of
883 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700884 */
885static struct kobject *device_to_dev_kobj(struct device *dev)
886{
887 struct kobject *kobj;
888
889 if (dev->class)
890 kobj = dev->class->dev_kobj;
891 else
892 kobj = sysfs_dev_char_kobj;
893
894 return kobj;
895}
896
897static int device_create_sys_dev_entry(struct device *dev)
898{
899 struct kobject *kobj = device_to_dev_kobj(dev);
900 int error = 0;
901 char devt_str[15];
902
903 if (kobj) {
904 format_dev_t(devt_str, dev->devt);
905 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
906 }
907
908 return error;
909}
910
911static void device_remove_sys_dev_entry(struct device *dev)
912{
913 struct kobject *kobj = device_to_dev_kobj(dev);
914 char devt_str[15];
915
916 if (kobj) {
917 format_dev_t(devt_str, dev->devt);
918 sysfs_remove_link(kobj, devt_str);
919 }
920}
921
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700922int device_private_init(struct device *dev)
923{
924 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
925 if (!dev->p)
926 return -ENOMEM;
927 dev->p->device = dev;
928 klist_init(&dev->p->klist_children, klist_children_get,
929 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800930 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700931 return 0;
932}
933
Dan Williamse105b8b2008-04-21 10:51:07 -0700934/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800935 * device_add - add device to device hierarchy.
936 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800938 * This is part 2 of device_register(), though may be called
939 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 *
Cornelia Huck57394112008-09-03 18:26:40 +0200941 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800942 * to the global and sibling lists for the device, then
943 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200944 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500945 * Do not call this routine or device_register() more than once for
946 * any device structure. The driver model core is not designed to work
947 * with devices that get unregistered and then spring back to life.
948 * (Among other things, it's very hard to guarantee that all references
949 * to the previous incarnation of @dev have been dropped.) Allocate
950 * and register a fresh new struct device instead.
951 *
Cornelia Huck57394112008-09-03 18:26:40 +0200952 * NOTE: _Never_ directly free @dev after calling this function, even
953 * if it returned an error! Always use put_device() to give up your
954 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 */
956int device_add(struct device *dev)
957{
958 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800959 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200960 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700961 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100962
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700964 if (!dev)
965 goto done;
966
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800967 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700968 error = device_private_init(dev);
969 if (error)
970 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800971 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800972
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100973 /*
974 * for statically allocated devices, which should all be converted
975 * some day, we need to initialize the name. We prevent reading back
976 * the name, and force the use of dev_name()
977 */
978 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700979 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100980 dev->init_name = NULL;
981 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700982
Kay Sieversca22e562011-12-14 14:29:38 -0800983 /* subsystems can specify simple device enumeration */
984 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
985 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
986
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000987 if (!dev_name(dev)) {
988 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -0700989 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100992 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -0800995 kobj = get_device_parent(dev, parent);
996 if (kobj)
997 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Yinghai Lu0d358f22008-02-19 03:20:41 -0800999 /* use parent numa_node */
1000 if (parent)
1001 set_dev_node(dev, dev_to_node(parent));
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001004 /* we require the name to be set before, and pass NULL */
1005 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001006 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001008
Brian Walsh37022642006-08-14 22:43:19 -07001009 /* notify platform of device entry */
1010 if (platform_notify)
1011 platform_notify(dev);
1012
Tejun Heoad6a1e12007-06-14 03:45:17 +09001013 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001014 if (error)
1015 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001016
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001017 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +09001018 error = device_create_file(dev, &devt_attr);
1019 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001020 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001021
1022 error = device_create_sys_dev_entry(dev);
1023 if (error)
1024 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001025
1026 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001027 }
1028
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001029 error = device_add_class_symlinks(dev);
1030 if (error)
1031 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001032 error = device_add_attrs(dev);
1033 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001034 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001035 error = bus_add_device(dev);
1036 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001038 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001039 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001040 goto DPMError;
1041 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001042
1043 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001044 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001045 */
1046 if (dev->bus)
1047 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1048 BUS_NOTIFY_ADD_DEVICE, dev);
1049
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001050 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001051 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001053 klist_add_tail(&dev->p->knode_parent,
1054 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001056 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001057 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001058 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001059 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001060 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001061
1062 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001063 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001064 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001065 if (class_intf->add_dev)
1066 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001067 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001068 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001069done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 put_device(dev);
1071 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001072 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001073 bus_remove_device(dev);
1074 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001075 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001076 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001077 device_remove_class_symlinks(dev);
1078 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001079 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001080 devtmpfs_delete_node(dev);
1081 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001082 device_remove_sys_dev_entry(dev);
1083 devtattrError:
1084 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +09001085 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001086 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001087 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001088 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001089 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 kobject_del(&dev->kobj);
1091 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001092 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 if (parent)
1094 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001095name_error:
1096 kfree(dev->p);
1097 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001098 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099}
1100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001102 * device_register - register a device with the system.
1103 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001105 * This happens in two clean steps - initialize the device
1106 * and add it to the system. The two steps can be called
1107 * separately, but this is the easiest and most common.
1108 * I.e. you should only call the two helpers separately if
1109 * have a clearly defined need to use and refcount the device
1110 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001111 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001112 * For more information, see the kerneldoc for device_initialize()
1113 * and device_add().
1114 *
Cornelia Huck57394112008-09-03 18:26:40 +02001115 * NOTE: _Never_ directly free @dev after calling this function, even
1116 * if it returned an error! Always use put_device() to give up the
1117 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119int device_register(struct device *dev)
1120{
1121 device_initialize(dev);
1122 return device_add(dev);
1123}
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001126 * get_device - increment reference count for device.
1127 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001129 * This simply forwards the call to kobject_get(), though
1130 * we do take care to provide for the case that we get a NULL
1131 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001133struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134{
1135 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1136}
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001139 * put_device - decrement reference count.
1140 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001142void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001144 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 if (dev)
1146 kobject_put(&dev->kobj);
1147}
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001150 * device_del - delete device from system.
1151 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001153 * This is the first part of the device unregistration
1154 * sequence. This removes the device from the lists we control
1155 * from here, has it removed from the other driver model
1156 * subsystems it was added to in device_add(), and removes it
1157 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001159 * NOTE: this should be called manually _iff_ device_add() was
1160 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001162void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001164 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001165 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Alan Sternec0676ee2008-12-05 14:10:31 -05001167 /* Notify clients of device removal. This call must come
1168 * before dpm_sysfs_remove().
1169 */
1170 if (dev->bus)
1171 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1172 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001173 device_pm_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001174 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001176 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001177 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001178 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001179 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001180 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001181 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001182 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001183 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001184
Kay Sieversca22e562011-12-14 14:29:38 -08001185 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001186 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001187 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001188 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001189 if (class_intf->remove_dev)
1190 class_intf->remove_dev(dev, class_intf);
1191 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001192 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001193 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001194 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001195 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001196 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001197 bus_remove_device(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001198 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001200 /*
1201 * Some platform devices are driven without driver attached
1202 * and managed resources may have been acquired. Make sure
1203 * all resources are released.
1204 */
1205 devres_release_all(dev);
1206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 /* Notify the platform of the removal, in case they
1208 * need to do anything...
1209 */
1210 if (platform_notify_remove)
1211 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001212 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001213 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001215 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
1218/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001219 * device_unregister - unregister device from system.
1220 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001222 * We do this in two parts, like we do device_register(). First,
1223 * we remove it from all the subsystems with device_del(), then
1224 * we decrement the reference count via put_device(). If that
1225 * is the final reference count, the device will be cleaned up
1226 * via device_release() above. Otherwise, the structure will
1227 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001229void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001231 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 device_del(dev);
1233 put_device(dev);
1234}
1235
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001236static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001237{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001238 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001239 struct device *dev = NULL;
1240 struct device_private *p;
1241
1242 if (n) {
1243 p = to_device_private_parent(n);
1244 dev = p->device;
1245 }
1246 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001247}
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001250 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001251 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001252 * @mode: returned file access mode
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001253 * @tmp: possibly allocated string
1254 *
1255 * Return the relative path of a possible device node.
1256 * Non-default names may need to allocate a memory to compose
1257 * a name. This memory is returned in tmp and needs to be
1258 * freed by the caller.
1259 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001260const char *device_get_devnode(struct device *dev,
Al Viro2c9ede52011-07-23 20:24:48 -04001261 umode_t *mode, const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001262{
1263 char *s;
1264
1265 *tmp = NULL;
1266
1267 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001268 if (dev->type && dev->type->devnode)
1269 *tmp = dev->type->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001270 if (*tmp)
1271 return *tmp;
1272
1273 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001274 if (dev->class && dev->class->devnode)
1275 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001276 if (*tmp)
1277 return *tmp;
1278
1279 /* return name without allocation, tmp == NULL */
1280 if (strchr(dev_name(dev), '!') == NULL)
1281 return dev_name(dev);
1282
1283 /* replace '!' in the name with '/' */
1284 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1285 if (!*tmp)
1286 return NULL;
1287 while ((s = strchr(*tmp, '!')))
1288 s[0] = '/';
1289 return *tmp;
1290}
1291
1292/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001293 * device_for_each_child - device child iterator.
1294 * @parent: parent struct device.
1295 * @data: data for the callback.
1296 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001298 * Iterate over @parent's child devices, and call @fn for each,
1299 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001301 * We check the return of @fn each time. If it returns anything
1302 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001304int device_for_each_child(struct device *parent, void *data,
1305 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001307 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001308 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 int error = 0;
1310
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001311 if (!parent->p)
1312 return 0;
1313
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001314 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001315 while ((child = next_device(&i)) && !error)
1316 error = fn(child, data);
1317 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 return error;
1319}
1320
Cornelia Huck5ab69982006-11-16 15:42:07 +01001321/**
1322 * device_find_child - device iterator for locating a particular device.
1323 * @parent: parent struct device
1324 * @data: Data to pass to match function
1325 * @match: Callback function to check device
1326 *
1327 * This is similar to the device_for_each_child() function above, but it
1328 * returns a reference to a device that is 'found' for later use, as
1329 * determined by the @match callback.
1330 *
1331 * The callback should return 0 if the device doesn't match and non-zero
1332 * if it does. If the callback returns non-zero and a reference to the
1333 * current device can be obtained, this function will return to the caller
1334 * and not iterate over any more devices.
1335 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001336struct device *device_find_child(struct device *parent, void *data,
1337 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001338{
1339 struct klist_iter i;
1340 struct device *child;
1341
1342 if (!parent)
1343 return NULL;
1344
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001345 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001346 while ((child = next_device(&i)))
1347 if (match(child, data) && get_device(child))
1348 break;
1349 klist_iter_exit(&i);
1350 return child;
1351}
1352
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353int __init devices_init(void)
1354{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001355 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1356 if (!devices_kset)
1357 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001358 dev_kobj = kobject_create_and_add("dev", NULL);
1359 if (!dev_kobj)
1360 goto dev_kobj_err;
1361 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1362 if (!sysfs_dev_block_kobj)
1363 goto block_kobj_err;
1364 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1365 if (!sysfs_dev_char_kobj)
1366 goto char_kobj_err;
1367
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001368 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001369
1370 char_kobj_err:
1371 kobject_put(sysfs_dev_block_kobj);
1372 block_kobj_err:
1373 kobject_put(dev_kobj);
1374 dev_kobj_err:
1375 kset_unregister(devices_kset);
1376 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377}
1378
1379EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001380EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
1382EXPORT_SYMBOL_GPL(device_initialize);
1383EXPORT_SYMBOL_GPL(device_add);
1384EXPORT_SYMBOL_GPL(device_register);
1385
1386EXPORT_SYMBOL_GPL(device_del);
1387EXPORT_SYMBOL_GPL(device_unregister);
1388EXPORT_SYMBOL_GPL(get_device);
1389EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
1391EXPORT_SYMBOL_GPL(device_create_file);
1392EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001393
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001394struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001395 struct device dev;
1396 struct module *owner;
1397};
1398
Ferenc Wagner481e2072011-01-07 15:17:47 +01001399inline struct root_device *to_root_device(struct device *d)
1400{
1401 return container_of(d, struct root_device, dev);
1402}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001403
1404static void root_device_release(struct device *dev)
1405{
1406 kfree(to_root_device(dev));
1407}
1408
1409/**
1410 * __root_device_register - allocate and register a root device
1411 * @name: root device name
1412 * @owner: owner module of the root device, usually THIS_MODULE
1413 *
1414 * This function allocates a root device and registers it
1415 * using device_register(). In order to free the returned
1416 * device, use root_device_unregister().
1417 *
1418 * Root devices are dummy devices which allow other devices
1419 * to be grouped under /sys/devices. Use this function to
1420 * allocate a root device and then use it as the parent of
1421 * any device which should appear under /sys/devices/{name}
1422 *
1423 * The /sys/devices/{name} directory will also contain a
1424 * 'module' symlink which points to the @owner directory
1425 * in sysfs.
1426 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001427 * Returns &struct device pointer on success, or ERR_PTR() on error.
1428 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001429 * Note: You probably want to use root_device_register().
1430 */
1431struct device *__root_device_register(const char *name, struct module *owner)
1432{
1433 struct root_device *root;
1434 int err = -ENOMEM;
1435
1436 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1437 if (!root)
1438 return ERR_PTR(err);
1439
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001440 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001441 if (err) {
1442 kfree(root);
1443 return ERR_PTR(err);
1444 }
1445
1446 root->dev.release = root_device_release;
1447
1448 err = device_register(&root->dev);
1449 if (err) {
1450 put_device(&root->dev);
1451 return ERR_PTR(err);
1452 }
1453
Christoph Egger1d9e8822010-05-17 16:57:58 +02001454#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001455 if (owner) {
1456 struct module_kobject *mk = &owner->mkobj;
1457
1458 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1459 if (err) {
1460 device_unregister(&root->dev);
1461 return ERR_PTR(err);
1462 }
1463 root->owner = owner;
1464 }
1465#endif
1466
1467 return &root->dev;
1468}
1469EXPORT_SYMBOL_GPL(__root_device_register);
1470
1471/**
1472 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001473 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001474 *
1475 * This function unregisters and cleans up a device that was created by
1476 * root_device_register().
1477 */
1478void root_device_unregister(struct device *dev)
1479{
1480 struct root_device *root = to_root_device(dev);
1481
1482 if (root->owner)
1483 sysfs_remove_link(&root->dev.kobj, "module");
1484
1485 device_unregister(dev);
1486}
1487EXPORT_SYMBOL_GPL(root_device_unregister);
1488
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001489
1490static void device_create_release(struct device *dev)
1491{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001492 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001493 kfree(dev);
1494}
1495
1496/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001497 * device_create_vargs - creates a device and registers it with sysfs
1498 * @class: pointer to the struct class that this device should be registered to
1499 * @parent: pointer to the parent struct device of this new device, if any
1500 * @devt: the dev_t for the char device to be added
1501 * @drvdata: the data to be added to the device for callbacks
1502 * @fmt: string for the device's name
1503 * @args: va_list for the device's name
1504 *
1505 * This function can be used by char device classes. A struct device
1506 * will be created in sysfs, registered to the specified class.
1507 *
1508 * A "dev" file will be created, showing the dev_t for the device, if
1509 * the dev_t is not 0,0.
1510 * If a pointer to a parent struct device is passed in, the newly created
1511 * struct device will be a child of that device in sysfs.
1512 * The pointer to the struct device will be returned from the call.
1513 * Any further sysfs files that might be required can be created using this
1514 * pointer.
1515 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001516 * Returns &struct device pointer on success, or ERR_PTR() on error.
1517 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001518 * Note: the struct class passed to this function must have previously
1519 * been created with a call to class_create().
1520 */
1521struct device *device_create_vargs(struct class *class, struct device *parent,
1522 dev_t devt, void *drvdata, const char *fmt,
1523 va_list args)
1524{
1525 struct device *dev = NULL;
1526 int retval = -ENODEV;
1527
1528 if (class == NULL || IS_ERR(class))
1529 goto error;
1530
1531 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1532 if (!dev) {
1533 retval = -ENOMEM;
1534 goto error;
1535 }
1536
1537 dev->devt = devt;
1538 dev->class = class;
1539 dev->parent = parent;
1540 dev->release = device_create_release;
1541 dev_set_drvdata(dev, drvdata);
1542
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001543 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1544 if (retval)
1545 goto error;
1546
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001547 retval = device_register(dev);
1548 if (retval)
1549 goto error;
1550
1551 return dev;
1552
1553error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001554 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001555 return ERR_PTR(retval);
1556}
1557EXPORT_SYMBOL_GPL(device_create_vargs);
1558
1559/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001560 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001561 * @class: pointer to the struct class that this device should be registered to
1562 * @parent: pointer to the parent struct device of this new device, if any
1563 * @devt: the dev_t for the char device to be added
1564 * @drvdata: the data to be added to the device for callbacks
1565 * @fmt: string for the device's name
1566 *
1567 * This function can be used by char device classes. A struct device
1568 * will be created in sysfs, registered to the specified class.
1569 *
1570 * A "dev" file will be created, showing the dev_t for the device, if
1571 * the dev_t is not 0,0.
1572 * If a pointer to a parent struct device is passed in, the newly created
1573 * struct device will be a child of that device in sysfs.
1574 * The pointer to the struct device will be returned from the call.
1575 * Any further sysfs files that might be required can be created using this
1576 * pointer.
1577 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001578 * Returns &struct device pointer on success, or ERR_PTR() on error.
1579 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001580 * Note: the struct class passed to this function must have previously
1581 * been created with a call to class_create().
1582 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001583struct device *device_create(struct class *class, struct device *parent,
1584 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001585{
1586 va_list vargs;
1587 struct device *dev;
1588
1589 va_start(vargs, fmt);
1590 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1591 va_end(vargs);
1592 return dev;
1593}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001594EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001595
Dave Youngcd354492008-01-28 16:56:11 +08001596static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001597{
Dave Youngcd354492008-01-28 16:56:11 +08001598 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001599
Dave Youngcd354492008-01-28 16:56:11 +08001600 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001601}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001602
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001603/**
1604 * device_destroy - removes a device that was created with device_create()
1605 * @class: pointer to the struct class that this device was registered with
1606 * @devt: the dev_t of the device that was previously registered
1607 *
1608 * This call unregisters and cleans up a device that was created with a
1609 * call to device_create().
1610 */
1611void device_destroy(struct class *class, dev_t devt)
1612{
1613 struct device *dev;
1614
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001615 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001616 if (dev) {
1617 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001618 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001619 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001620}
1621EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001622
1623/**
1624 * device_rename - renames a device
1625 * @dev: the pointer to the struct device to be renamed
1626 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001627 *
1628 * It is the responsibility of the caller to provide mutual
1629 * exclusion between two different calls of device_rename
1630 * on the same device to ensure that new_name is valid and
1631 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001632 *
Timur Tabia5462512010-12-13 14:08:52 -06001633 * Note: Don't call this function. Currently, the networking layer calls this
1634 * function, but that will change. The following text from Kay Sievers offers
1635 * some insight:
1636 *
1637 * Renaming devices is racy at many levels, symlinks and other stuff are not
1638 * replaced atomically, and you get a "move" uevent, but it's not easy to
1639 * connect the event to the old and new device. Device nodes are not renamed at
1640 * all, there isn't even support for that in the kernel now.
1641 *
1642 * In the meantime, during renaming, your target name might be taken by another
1643 * driver, creating conflicts. Or the old name is taken directly after you
1644 * renamed it -- then you get events for the same DEVPATH, before you even see
1645 * the "move" event. It's just a mess, and nothing new should ever rely on
1646 * kernel device renaming. Besides that, it's not even implemented now for
1647 * other things than (driver-core wise very simple) network devices.
1648 *
1649 * We are currently about to change network renaming in udev to completely
1650 * disallow renaming of devices in the same namespace as the kernel uses,
1651 * because we can't solve the problems properly, that arise with swapping names
1652 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1653 * be allowed to some other name than eth[0-9]*, for the aforementioned
1654 * reasons.
1655 *
1656 * Make up a "real" name in the driver before you register anything, or add
1657 * some other attributes for userspace to find the device, or use udev to add
1658 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1659 * don't even want to get into that and try to implement the missing pieces in
1660 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001661 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001662int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001663{
1664 char *old_class_name = NULL;
1665 char *new_class_name = NULL;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001666 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001667 int error;
1668
1669 dev = get_device(dev);
1670 if (!dev)
1671 return -EINVAL;
1672
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001673 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001674 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001675
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001676 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001677 if (!old_device_name) {
1678 error = -ENOMEM;
1679 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001680 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001681
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001682 if (dev->class) {
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001683 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001684 &dev->kobj, old_device_name, new_name);
1685 if (error)
1686 goto out;
1687 }
Kay Sievers39aba962010-09-04 22:33:14 -07001688
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001689 error = kobject_rename(&dev->kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001690 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001691 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001692
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001693out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001694 put_device(dev);
1695
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001696 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001697 kfree(old_class_name);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001698 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001699
1700 return error;
1701}
Johannes Berga2807db2007-02-28 12:38:31 +01001702EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001703
1704static int device_move_class_links(struct device *dev,
1705 struct device *old_parent,
1706 struct device *new_parent)
1707{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001708 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001709
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001710 if (old_parent)
1711 sysfs_remove_link(&dev->kobj, "device");
1712 if (new_parent)
1713 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1714 "device");
1715 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001716}
1717
1718/**
1719 * device_move - moves a device to a new parent
1720 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001721 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001722 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001723 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001724int device_move(struct device *dev, struct device *new_parent,
1725 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001726{
1727 int error;
1728 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001729 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001730
1731 dev = get_device(dev);
1732 if (!dev)
1733 return -EINVAL;
1734
Cornelia Huckffa6a702009-03-04 12:44:00 +01001735 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001736 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001737 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001738
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001739 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1740 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001741 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001742 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001743 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001744 put_device(new_parent);
1745 goto out;
1746 }
1747 old_parent = dev->parent;
1748 dev->parent = new_parent;
1749 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001750 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001751 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001752 klist_add_tail(&dev->p->knode_parent,
1753 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001754 set_dev_node(dev, dev_to_node(new_parent));
1755 }
1756
Rabin Vincentbdd40342012-04-23 09:16:36 +02001757 if (dev->class) {
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)) {
1763 if (new_parent)
1764 klist_remove(&dev->p->knode_parent);
1765 dev->parent = old_parent;
1766 if (old_parent) {
1767 klist_add_tail(&dev->p->knode_parent,
1768 &old_parent->p->klist_children);
1769 set_dev_node(dev, dev_to_node(old_parent));
1770 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001771 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001772 cleanup_glue_dir(dev, new_parent_kobj);
1773 put_device(new_parent);
1774 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001775 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001776 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001777 switch (dpm_order) {
1778 case DPM_ORDER_NONE:
1779 break;
1780 case DPM_ORDER_DEV_AFTER_PARENT:
1781 device_pm_move_after(dev, new_parent);
1782 break;
1783 case DPM_ORDER_PARENT_BEFORE_DEV:
1784 device_pm_move_before(new_parent, dev);
1785 break;
1786 case DPM_ORDER_DEV_LAST:
1787 device_pm_move_last(dev);
1788 break;
1789 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001790
Cornelia Huck8a824722006-11-20 17:07:51 +01001791 put_device(old_parent);
1792out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001793 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001794 put_device(dev);
1795 return error;
1796}
Cornelia Huck8a824722006-11-20 17:07:51 +01001797EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001798
1799/**
1800 * device_shutdown - call ->shutdown() on each device to shutdown.
1801 */
1802void device_shutdown(void)
1803{
Hugh Daschbach62458382010-03-22 10:36:37 -07001804 struct device *dev;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001805
Hugh Daschbach62458382010-03-22 10:36:37 -07001806 spin_lock(&devices_kset->list_lock);
1807 /*
1808 * Walk the devices list backward, shutting down each in turn.
1809 * Beware that device unplug events may also start pulling
1810 * devices offline, even as the system is shutting down.
1811 */
1812 while (!list_empty(&devices_kset->list)) {
1813 dev = list_entry(devices_kset->list.prev, struct device,
1814 kobj.entry);
1815 get_device(dev);
1816 /*
1817 * Make sure the device is off the kset list, in the
1818 * event that dev->*->shutdown() doesn't remove it.
1819 */
1820 list_del_init(&dev->kobj.entry);
1821 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001822
1823 /* Don't allow any more runtime suspends */
1824 pm_runtime_get_noresume(dev);
1825 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001826
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001827 if (dev->bus && dev->bus->shutdown) {
1828 dev_dbg(dev, "shutdown\n");
1829 dev->bus->shutdown(dev);
1830 } else if (dev->driver && dev->driver->shutdown) {
1831 dev_dbg(dev, "shutdown\n");
1832 dev->driver->shutdown(dev);
1833 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001834 put_device(dev);
1835
1836 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001837 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001838 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07001839 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001840}
Joe Perches99bcf212010-06-27 01:02:34 +00001841
1842/*
1843 * Device logging functions
1844 */
1845
1846#ifdef CONFIG_PRINTK
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{
Kay Sieversc4e00da2012-05-03 02:29:59 +02001850 char dict[128];
1851 size_t dictlen = 0;
1852 const char *subsys;
1853
Joe Perches99bcf212010-06-27 01:02:34 +00001854 if (!dev)
1855 return printk("%s(NULL device *): %pV", level, vaf);
1856
Kay Sieversc4e00da2012-05-03 02:29:59 +02001857 if (dev->class)
1858 subsys = dev->class->name;
1859 else if (dev->bus)
1860 subsys = dev->bus->name;
1861 else
1862 goto skip;
1863
1864 dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
1865 "SUBSYSTEM=%s", subsys);
1866
1867 /*
1868 * Add device identifier DEVICE=:
1869 * b12:8 block dev_t
1870 * c127:3 char dev_t
1871 * n8 netdev ifindex
1872 * +sound:card0 subsystem:devname
1873 */
1874 if (MAJOR(dev->devt)) {
1875 char c;
1876
1877 if (strcmp(subsys, "block") == 0)
1878 c = 'b';
1879 else
1880 c = 'c';
1881 dictlen++;
1882 dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
1883 "DEVICE=%c%u:%u",
1884 c, MAJOR(dev->devt), MINOR(dev->devt));
1885 } else if (strcmp(subsys, "net") == 0) {
1886 struct net_device *net = to_net_dev(dev);
1887
1888 dictlen++;
1889 dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
1890 "DEVICE=n%u", net->ifindex);
1891 } else {
1892 dictlen++;
1893 dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
1894 "DEVICE=+%s:%s", subsys, dev_name(dev));
1895 }
1896skip:
1897 return printk_emit(0, level[1] - '0',
1898 dictlen ? dict : NULL, dictlen,
1899 "%s %s: %pV",
1900 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches99bcf212010-06-27 01:02:34 +00001901}
Joe Perchescbc46632011-08-11 14:36:21 -04001902EXPORT_SYMBOL(__dev_printk);
Joe Perches99bcf212010-06-27 01:02:34 +00001903
1904int dev_printk(const char *level, const struct device *dev,
1905 const char *fmt, ...)
1906{
1907 struct va_format vaf;
1908 va_list args;
1909 int r;
1910
1911 va_start(args, fmt);
1912
1913 vaf.fmt = fmt;
1914 vaf.va = &args;
1915
1916 r = __dev_printk(level, dev, &vaf);
1917 va_end(args);
1918
1919 return r;
1920}
1921EXPORT_SYMBOL(dev_printk);
1922
1923#define define_dev_printk_level(func, kern_level) \
1924int func(const struct device *dev, const char *fmt, ...) \
1925{ \
1926 struct va_format vaf; \
1927 va_list args; \
1928 int r; \
1929 \
1930 va_start(args, fmt); \
1931 \
1932 vaf.fmt = fmt; \
1933 vaf.va = &args; \
1934 \
1935 r = __dev_printk(kern_level, dev, &vaf); \
1936 va_end(args); \
1937 \
1938 return r; \
1939} \
1940EXPORT_SYMBOL(func);
1941
1942define_dev_printk_level(dev_emerg, KERN_EMERG);
1943define_dev_printk_level(dev_alert, KERN_ALERT);
1944define_dev_printk_level(dev_crit, KERN_CRIT);
1945define_dev_printk_level(dev_err, KERN_ERR);
1946define_dev_printk_level(dev_warn, KERN_WARNING);
1947define_dev_printk_level(dev_notice, KERN_NOTICE);
1948define_dev_printk_level(_dev_info, KERN_INFO);
1949
1950#endif