blob: 56536f4b0f6b9bfd6c3aa4aa603e43e75112de87 [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_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);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +020094 struct device *dev = kobj_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) {
Greg Kroah-Hartman53a9c872013-01-17 13:10:23 -0800100 print_symbol("dev_attr_show: %s returned bad count\n",
101 (unsigned long)dev_attr->show);
Andrew Morton815d2d52008-03-04 15:09:07 -0800102 }
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);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200110 struct device *dev = kobj_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
Borislav Petkov91872392012-10-09 19:52:05 +0200174ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
175 const char *buf, size_t size)
176{
177 struct dev_ext_attribute *ea = to_ext_attr(attr);
178
179 if (strtobool(buf, ea->var) < 0)
180 return -EINVAL;
181
182 return size;
183}
184EXPORT_SYMBOL_GPL(device_store_bool);
185
186ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
187 char *buf)
188{
189 struct dev_ext_attribute *ea = to_ext_attr(attr);
190
191 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
192}
193EXPORT_SYMBOL_GPL(device_show_bool);
194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195/**
196 * device_release - free device structure.
197 * @kobj: device's kobject.
198 *
199 * This is called once the reference count for the object
200 * reaches 0. We forward the call to the device's release
201 * method, which should handle actually freeing the structure.
202 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800203static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200205 struct device *dev = kobj_to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800206 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Ming Leia525a3d2012-07-25 01:42:29 +0800208 /*
209 * Some platform devices are driven without driver attached
210 * and managed resources may have been acquired. Make sure
211 * all resources are released.
212 *
213 * Drivers still can add resources into device after device
214 * is deleted but alive, so release devres here to avoid
215 * possible memory leak.
216 */
217 devres_release_all(dev);
218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 if (dev->release)
220 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200221 else if (dev->type && dev->type->release)
222 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700223 else if (dev->class && dev->class->dev_release)
224 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700225 else
226 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800227 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100228 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800229 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230}
231
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700232static const void *device_namespace(struct kobject *kobj)
233{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200234 struct device *dev = kobj_to_dev(kobj);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700235 const void *ns = NULL;
236
237 if (dev->class && dev->class->ns_type)
238 ns = dev->class->namespace(dev);
239
240 return ns;
241}
242
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600243static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 .release = device_release,
245 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700246 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247};
248
249
Kay Sievers312c0042005-11-16 09:00:00 +0100250static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 struct kobj_type *ktype = get_ktype(kobj);
253
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600254 if (ktype == &device_ktype) {
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200255 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 if (dev->bus)
257 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700258 if (dev->class)
259 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 }
261 return 0;
262}
263
Kay Sievers312c0042005-11-16 09:00:00 +0100264static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200266 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700268 if (dev->bus)
269 return dev->bus->name;
270 if (dev->class)
271 return dev->class->name;
272 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273}
274
Kay Sievers7eff2e72007-08-14 15:15:12 +0200275static int dev_uevent(struct kset *kset, struct kobject *kobj,
276 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200278 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 int retval = 0;
280
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200281 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700282 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200283 const char *tmp;
284 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400285 umode_t mode = 0;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200286
Kay Sievers7eff2e72007-08-14 15:15:12 +0200287 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
288 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sieverse454cea2009-09-18 23:01:12 +0200289 name = device_get_devnode(dev, &mode, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200290 if (name) {
291 add_uevent_var(env, "DEVNAME=%s", name);
292 kfree(tmp);
Kay Sieverse454cea2009-09-18 23:01:12 +0200293 if (mode)
294 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200295 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700296 }
297
Kay Sievers414264f2007-03-12 21:08:57 +0100298 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200299 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100300
Kay Sievers239378f2006-10-07 21:54:55 +0200301 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200302 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200303
Grant Likely07d57a32012-02-01 11:22:22 -0700304 /* Add common DT information about the device */
305 of_device_uevent(dev, env);
306
Kay Sievers7eff2e72007-08-14 15:15:12 +0200307 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100308 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200309 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200310 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800311 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100312 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 }
314
Kay Sievers7eff2e72007-08-14 15:15:12 +0200315 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700316 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200317 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200318 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800319 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100320 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800321 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200322 }
323
Stefan Weileef35c22010-08-06 21:11:15 +0200324 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200325 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200326 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200327 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800328 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100329 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800330 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700331 }
332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 return retval;
334}
335
Emese Revfy9cd43612009-12-31 14:52:51 +0100336static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100337 .filter = dev_uevent_filter,
338 .name = dev_uevent_name,
339 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340};
341
Kay Sievers16574dc2007-04-06 01:40:38 +0200342static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
343 char *buf)
344{
345 struct kobject *top_kobj;
346 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200347 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200348 int i;
349 size_t count = 0;
350 int retval;
351
352 /* search the kset, the device belongs to */
353 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200354 while (!top_kobj->kset && top_kobj->parent)
355 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200356 if (!top_kobj->kset)
357 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200358
Kay Sievers16574dc2007-04-06 01:40:38 +0200359 kset = top_kobj->kset;
360 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
361 goto out;
362
363 /* respect filter */
364 if (kset->uevent_ops && kset->uevent_ops->filter)
365 if (!kset->uevent_ops->filter(kset, &dev->kobj))
366 goto out;
367
Kay Sievers7eff2e72007-08-14 15:15:12 +0200368 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
369 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200370 return -ENOMEM;
371
Kay Sievers16574dc2007-04-06 01:40:38 +0200372 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200373 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200374 if (retval)
375 goto out;
376
377 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200378 for (i = 0; i < env->envp_idx; i++)
379 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200380out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200381 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200382 return count;
383}
384
Kay Sieversa7fd6702005-10-01 14:49:43 +0200385static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
386 const char *buf, size_t count)
387{
Kay Sievers60a96a52007-07-08 22:29:26 +0200388 enum kobject_action action;
389
Kay Sievers3f5468c2010-01-14 22:54:37 +0100390 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200391 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100392 else
393 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200394 return count;
395}
396
Tejun Heoad6a1e12007-06-14 03:45:17 +0900397static struct device_attribute uevent_attr =
398 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
399
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500400static int device_add_attributes(struct device *dev,
401 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700402{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700403 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500404 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700405
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500406 if (attrs) {
407 for (i = 0; attr_name(attrs[i]); i++) {
408 error = device_create_file(dev, &attrs[i]);
409 if (error)
410 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700411 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500412 if (error)
413 while (--i >= 0)
414 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700415 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700416 return error;
417}
418
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500419static void device_remove_attributes(struct device *dev,
420 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700421{
422 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500423
424 if (attrs)
425 for (i = 0; attr_name(attrs[i]); i++)
426 device_remove_file(dev, &attrs[i]);
427}
428
Stefan Achatzc97415a2010-11-26 19:57:29 +0000429static int device_add_bin_attributes(struct device *dev,
430 struct bin_attribute *attrs)
431{
432 int error = 0;
433 int i;
434
435 if (attrs) {
436 for (i = 0; attr_name(attrs[i]); i++) {
437 error = device_create_bin_file(dev, &attrs[i]);
438 if (error)
439 break;
440 }
441 if (error)
442 while (--i >= 0)
443 device_remove_bin_file(dev, &attrs[i]);
444 }
445 return error;
446}
447
448static void device_remove_bin_attributes(struct device *dev,
449 struct bin_attribute *attrs)
450{
451 int i;
452
453 if (attrs)
454 for (i = 0; attr_name(attrs[i]); i++)
455 device_remove_bin_file(dev, &attrs[i]);
456}
457
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500458static int device_add_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700459 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500460{
461 int error = 0;
462 int i;
463
464 if (groups) {
465 for (i = 0; groups[i]; i++) {
466 error = sysfs_create_group(&dev->kobj, groups[i]);
467 if (error) {
468 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800469 sysfs_remove_group(&dev->kobj,
470 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500471 break;
472 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700473 }
474 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500475 return error;
476}
477
478static void device_remove_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700479 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500480{
481 int i;
482
483 if (groups)
484 for (i = 0; groups[i]; i++)
485 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700486}
487
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700488static int device_add_attrs(struct device *dev)
489{
490 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700491 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500492 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700493
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500494 if (class) {
495 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200496 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500497 return error;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000498 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
499 if (error)
500 goto err_remove_class_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700501 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200502
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500503 if (type) {
504 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200505 if (error)
Stefan Achatzc97415a2010-11-26 19:57:29 +0000506 goto err_remove_class_bin_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200507 }
508
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500509 error = device_add_groups(dev, dev->groups);
510 if (error)
511 goto err_remove_type_groups;
512
513 return 0;
514
515 err_remove_type_groups:
516 if (type)
517 device_remove_groups(dev, type->groups);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000518 err_remove_class_bin_attrs:
519 if (class)
520 device_remove_bin_attributes(dev, class->dev_bin_attrs);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500521 err_remove_class_attrs:
522 if (class)
523 device_remove_attributes(dev, class->dev_attrs);
524
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700525 return error;
526}
527
528static void device_remove_attrs(struct device *dev)
529{
530 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700531 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700532
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500533 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200534
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500535 if (type)
536 device_remove_groups(dev, type->groups);
537
Stefan Achatzc97415a2010-11-26 19:57:29 +0000538 if (class) {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500539 device_remove_attributes(dev, class->dev_attrs);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000540 device_remove_bin_attributes(dev, class->dev_bin_attrs);
541 }
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700542}
543
544
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700545static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
546 char *buf)
547{
548 return print_dev_t(buf, dev->devt);
549}
550
Tejun Heoad6a1e12007-06-14 03:45:17 +0900551static struct device_attribute devt_attr =
552 __ATTR(dev, S_IRUGO, show_dev, NULL);
553
Kay Sieversca22e562011-12-14 14:29:38 -0800554/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600555struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800558 * device_create_file - create sysfs attribute file for device.
559 * @dev: device.
560 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200562int device_create_file(struct device *dev,
563 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
565 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100566 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 return error;
569}
570
571/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800572 * device_remove_file - remove sysfs attribute file.
573 * @dev: device.
574 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200576void device_remove_file(struct device *dev,
577 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100579 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
582
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700583/**
584 * device_create_bin_file - create sysfs binary attribute file for device.
585 * @dev: device.
586 * @attr: device binary attribute descriptor.
587 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200588int device_create_bin_file(struct device *dev,
589 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700590{
591 int error = -EINVAL;
592 if (dev)
593 error = sysfs_create_bin_file(&dev->kobj, attr);
594 return error;
595}
596EXPORT_SYMBOL_GPL(device_create_bin_file);
597
598/**
599 * device_remove_bin_file - remove sysfs binary attribute file
600 * @dev: device.
601 * @attr: device binary attribute descriptor.
602 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200603void device_remove_bin_file(struct device *dev,
604 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700605{
606 if (dev)
607 sysfs_remove_bin_file(&dev->kobj, attr);
608}
609EXPORT_SYMBOL_GPL(device_remove_bin_file);
610
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400611/**
Alan Stern523ded72007-04-26 00:12:04 -0700612 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400613 * @dev: device.
614 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700615 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400616 *
617 * Attribute methods must not unregister themselves or their parent device
618 * (which would amount to the same thing). Attempts to do so will deadlock,
619 * since unregistration is mutually exclusive with driver callbacks.
620 *
621 * Instead methods can call this routine, which will attempt to allocate
622 * and schedule a workqueue request to call back @func with @dev as its
623 * argument in the workqueue's process context. @dev will be pinned until
624 * @func returns.
625 *
Alan Stern523ded72007-04-26 00:12:04 -0700626 * This routine is usually called via the inline device_schedule_callback(),
627 * which automatically sets @owner to THIS_MODULE.
628 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400629 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700630 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400631 *
632 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
633 * underlying sysfs routine (since it is intended for use by attribute
634 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
635 */
Alan Stern523ded72007-04-26 00:12:04 -0700636int device_schedule_callback_owner(struct device *dev,
637 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400638{
639 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700640 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400641}
Alan Stern523ded72007-04-26 00:12:04 -0700642EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400643
James Bottomley34bb61f2005-09-06 16:56:51 -0700644static void klist_children_get(struct klist_node *n)
645{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800646 struct device_private *p = to_device_private_parent(n);
647 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700648
649 get_device(dev);
650}
651
652static void klist_children_put(struct klist_node *n)
653{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800654 struct device_private *p = to_device_private_parent(n);
655 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700656
657 put_device(dev);
658}
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800661 * device_initialize - init device structure.
662 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 *
Cornelia Huck57394112008-09-03 18:26:40 +0200664 * This prepares the device for use by other layers by initializing
665 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800666 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200667 * that function, though it can also be called separately, so one
668 * may use @dev's fields. In particular, get_device()/put_device()
669 * may be used for reference counting of @dev after calling this
670 * function.
671 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500672 * All fields in @dev must be initialized by the caller to 0, except
673 * for those explicitly set to some other value. The simplest
674 * approach is to use kzalloc() to allocate the structure containing
675 * @dev.
676 *
Cornelia Huck57394112008-09-03 18:26:40 +0200677 * NOTE: Use put_device() to give up your reference instead of freeing
678 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680void device_initialize(struct device *dev)
681{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600682 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700683 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000685 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100686 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900687 spin_lock_init(&dev->devres_lock);
688 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400689 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800690 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691}
692
Kay Sievers86406242007-03-14 03:25:56 +0100693static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700694{
Kay Sievers86406242007-03-14 03:25:56 +0100695 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700696
Kay Sievers86406242007-03-14 03:25:56 +0100697 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800698 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600699 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700700
Kay Sievers86406242007-03-14 03:25:56 +0100701 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700702}
703
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700704struct class_dir {
705 struct kobject kobj;
706 struct class *class;
707};
708
709#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
710
711static void class_dir_release(struct kobject *kobj)
712{
713 struct class_dir *dir = to_class_dir(kobj);
714 kfree(dir);
715}
716
717static const
718struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
719{
720 struct class_dir *dir = to_class_dir(kobj);
721 return dir->class->ns_type;
722}
723
724static struct kobj_type class_dir_ktype = {
725 .release = class_dir_release,
726 .sysfs_ops = &kobj_sysfs_ops,
727 .child_ns_type = class_dir_child_ns_type
728};
729
730static struct kobject *
731class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
732{
733 struct class_dir *dir;
734 int retval;
735
736 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
737 if (!dir)
738 return NULL;
739
740 dir->class = class;
741 kobject_init(&dir->kobj, &class_dir_ktype);
742
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100743 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700744
745 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
746 if (retval < 0) {
747 kobject_put(&dir->kobj);
748 return NULL;
749 }
750 return &dir->kobj;
751}
752
753
Kay Sieversda231fd2007-11-21 17:29:15 +0100754static struct kobject *get_device_parent(struct device *dev,
755 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100756{
Kay Sievers86406242007-03-14 03:25:56 +0100757 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900758 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100759 struct kobject *kobj = NULL;
760 struct kobject *parent_kobj;
761 struct kobject *k;
762
Randy Dunlapead454f2010-09-24 14:36:49 -0700763#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700764 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200765 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700766 if (parent && parent->class == &block_class)
767 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100768 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700769 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700770#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200771
Kay Sievers86406242007-03-14 03:25:56 +0100772 /*
773 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100774 * Class-devices with a non class-device as parent, live
775 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100776 */
777 if (parent == NULL)
778 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700779 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100780 return &parent->kobj;
781 else
782 parent_kobj = &parent->kobj;
783
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900784 mutex_lock(&gdp_mutex);
785
Kay Sievers86406242007-03-14 03:25:56 +0100786 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100787 spin_lock(&dev->class->p->glue_dirs.list_lock);
788 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100789 if (k->parent == parent_kobj) {
790 kobj = kobject_get(k);
791 break;
792 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100793 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900794 if (kobj) {
795 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100796 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900797 }
Kay Sievers86406242007-03-14 03:25:56 +0100798
799 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700800 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100801 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900802 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800803 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100804 }
805
Kay Sieversca22e562011-12-14 14:29:38 -0800806 /* subsystems can specify a default root directory for their devices */
807 if (!parent && dev->bus && dev->bus->dev_root)
808 return &dev->bus->dev_root->kobj;
809
Kay Sievers86406242007-03-14 03:25:56 +0100810 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100811 return &parent->kobj;
812 return NULL;
813}
Kay Sieversda231fd2007-11-21 17:29:15 +0100814
Cornelia Huck63b69712008-01-21 16:09:44 +0100815static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100816{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100817 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100818 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100819 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100820 return;
821
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100822 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100823}
Cornelia Huck63b69712008-01-21 16:09:44 +0100824
825static void cleanup_device_parent(struct device *dev)
826{
827 cleanup_glue_dir(dev, dev->kobj.parent);
828}
Kay Sievers86406242007-03-14 03:25:56 +0100829
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700830static int device_add_class_symlinks(struct device *dev)
831{
832 int error;
833
834 if (!dev->class)
835 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100836
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700837 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100838 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700839 "subsystem");
840 if (error)
841 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100842
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800843 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700844 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
845 "device");
846 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700847 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700848 }
Kay Sievers39aba962010-09-04 22:33:14 -0700849
Randy Dunlapead454f2010-09-24 14:36:49 -0700850#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700851 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200852 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700853 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700854#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700855
856 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100857 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700858 &dev->kobj, dev_name(dev));
859 if (error)
860 goto out_device;
861
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700862 return 0;
863
Kay Sievers39aba962010-09-04 22:33:14 -0700864out_device:
865 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100866
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700867out_subsys:
868 sysfs_remove_link(&dev->kobj, "subsystem");
869out:
870 return error;
871}
872
873static void device_remove_class_symlinks(struct device *dev)
874{
875 if (!dev->class)
876 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100877
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800878 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100879 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700880 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700881#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200882 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700883 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700884#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100885 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700886}
887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000889 * dev_set_name - set a device name
890 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700891 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000892 */
893int dev_set_name(struct device *dev, const char *fmt, ...)
894{
895 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100896 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000897
898 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100899 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000900 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100901 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000902}
903EXPORT_SYMBOL_GPL(dev_set_name);
904
905/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700906 * device_to_dev_kobj - select a /sys/dev/ directory for the device
907 * @dev: device
908 *
909 * By default we select char/ for new entries. Setting class->dev_obj
910 * to NULL prevents an entry from being created. class->dev_kobj must
911 * be set (or cleared) before any devices are registered to the class
912 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200913 * device_remove_sys_dev_entry() will disagree about the presence of
914 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700915 */
916static struct kobject *device_to_dev_kobj(struct device *dev)
917{
918 struct kobject *kobj;
919
920 if (dev->class)
921 kobj = dev->class->dev_kobj;
922 else
923 kobj = sysfs_dev_char_kobj;
924
925 return kobj;
926}
927
928static int device_create_sys_dev_entry(struct device *dev)
929{
930 struct kobject *kobj = device_to_dev_kobj(dev);
931 int error = 0;
932 char devt_str[15];
933
934 if (kobj) {
935 format_dev_t(devt_str, dev->devt);
936 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
937 }
938
939 return error;
940}
941
942static void device_remove_sys_dev_entry(struct device *dev)
943{
944 struct kobject *kobj = device_to_dev_kobj(dev);
945 char devt_str[15];
946
947 if (kobj) {
948 format_dev_t(devt_str, dev->devt);
949 sysfs_remove_link(kobj, devt_str);
950 }
951}
952
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700953int device_private_init(struct device *dev)
954{
955 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
956 if (!dev->p)
957 return -ENOMEM;
958 dev->p->device = dev;
959 klist_init(&dev->p->klist_children, klist_children_get,
960 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800961 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700962 return 0;
963}
964
Dan Williamse105b8b2008-04-21 10:51:07 -0700965/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800966 * device_add - add device to device hierarchy.
967 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800969 * This is part 2 of device_register(), though may be called
970 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 *
Cornelia Huck57394112008-09-03 18:26:40 +0200972 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800973 * to the global and sibling lists for the device, then
974 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200975 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500976 * Do not call this routine or device_register() more than once for
977 * any device structure. The driver model core is not designed to work
978 * with devices that get unregistered and then spring back to life.
979 * (Among other things, it's very hard to guarantee that all references
980 * to the previous incarnation of @dev have been dropped.) Allocate
981 * and register a fresh new struct device instead.
982 *
Cornelia Huck57394112008-09-03 18:26:40 +0200983 * NOTE: _Never_ directly free @dev after calling this function, even
984 * if it returned an error! Always use put_device() to give up your
985 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
987int device_add(struct device *dev)
988{
989 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800990 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200991 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700992 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700995 if (!dev)
996 goto done;
997
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800998 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700999 error = device_private_init(dev);
1000 if (error)
1001 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001002 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001003
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001004 /*
1005 * for statically allocated devices, which should all be converted
1006 * some day, we need to initialize the name. We prevent reading back
1007 * the name, and force the use of dev_name()
1008 */
1009 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001010 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001011 dev->init_name = NULL;
1012 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001013
Kay Sieversca22e562011-12-14 14:29:38 -08001014 /* subsystems can specify simple device enumeration */
1015 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1016 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1017
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001018 if (!dev_name(dev)) {
1019 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001020 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001021 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001023 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001026 kobj = get_device_parent(dev, parent);
1027 if (kobj)
1028 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
Yinghai Lu0d358f22008-02-19 03:20:41 -08001030 /* use parent numa_node */
1031 if (parent)
1032 set_dev_node(dev, dev_to_node(parent));
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001035 /* we require the name to be set before, and pass NULL */
1036 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001037 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001039
Brian Walsh37022642006-08-14 22:43:19 -07001040 /* notify platform of device entry */
1041 if (platform_notify)
1042 platform_notify(dev);
1043
Tejun Heoad6a1e12007-06-14 03:45:17 +09001044 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001045 if (error)
1046 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001047
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001048 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +09001049 error = device_create_file(dev, &devt_attr);
1050 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001051 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001052
1053 error = device_create_sys_dev_entry(dev);
1054 if (error)
1055 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001056
1057 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001058 }
1059
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001060 error = device_add_class_symlinks(dev);
1061 if (error)
1062 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001063 error = device_add_attrs(dev);
1064 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001065 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001066 error = bus_add_device(dev);
1067 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001069 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001070 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001071 goto DPMError;
1072 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001073
1074 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001075 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001076 */
1077 if (dev->bus)
1078 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1079 BUS_NOTIFY_ADD_DEVICE, dev);
1080
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001081 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001082 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001084 klist_add_tail(&dev->p->knode_parent,
1085 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001087 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001088 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001089 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001090 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001091 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001092
1093 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001094 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001095 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001096 if (class_intf->add_dev)
1097 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001098 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001099 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001100done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 put_device(dev);
1102 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001103 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001104 bus_remove_device(dev);
1105 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001106 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001107 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001108 device_remove_class_symlinks(dev);
1109 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001110 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001111 devtmpfs_delete_node(dev);
1112 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001113 device_remove_sys_dev_entry(dev);
1114 devtattrError:
1115 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +09001116 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001117 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001118 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001119 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001120 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 kobject_del(&dev->kobj);
1122 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001123 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 if (parent)
1125 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001126name_error:
1127 kfree(dev->p);
1128 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001129 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130}
1131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001133 * device_register - register a device with the system.
1134 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001136 * This happens in two clean steps - initialize the device
1137 * and add it to the system. The two steps can be called
1138 * separately, but this is the easiest and most common.
1139 * I.e. you should only call the two helpers separately if
1140 * have a clearly defined need to use and refcount the device
1141 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001142 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001143 * For more information, see the kerneldoc for device_initialize()
1144 * and device_add().
1145 *
Cornelia Huck57394112008-09-03 18:26:40 +02001146 * NOTE: _Never_ directly free @dev after calling this function, even
1147 * if it returned an error! Always use put_device() to give up the
1148 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150int device_register(struct device *dev)
1151{
1152 device_initialize(dev);
1153 return device_add(dev);
1154}
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001157 * get_device - increment reference count for device.
1158 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001160 * This simply forwards the call to kobject_get(), though
1161 * we do take care to provide for the case that we get a NULL
1162 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001164struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001166 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167}
1168
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001170 * put_device - decrement reference count.
1171 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001173void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001175 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 if (dev)
1177 kobject_put(&dev->kobj);
1178}
1179
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001181 * device_del - delete device from system.
1182 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001184 * This is the first part of the device unregistration
1185 * sequence. This removes the device from the lists we control
1186 * from here, has it removed from the other driver model
1187 * subsystems it was added to in device_add(), and removes it
1188 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001190 * NOTE: this should be called manually _iff_ device_add() was
1191 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001193void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001195 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001196 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Alan Sternec0676ee2008-12-05 14:10:31 -05001198 /* Notify clients of device removal. This call must come
1199 * before dpm_sysfs_remove().
1200 */
1201 if (dev->bus)
1202 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1203 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001204 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001206 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001207 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001208 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001209 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001210 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001211 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001212 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001213 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001214
Kay Sieversca22e562011-12-14 14:29:38 -08001215 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001216 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001217 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001218 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001219 if (class_intf->remove_dev)
1220 class_intf->remove_dev(dev, class_intf);
1221 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001222 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001223 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001224 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001225 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001226 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001227 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001228 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001229 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
1231 /* Notify the platform of the removal, in case they
1232 * need to do anything...
1233 */
1234 if (platform_notify_remove)
1235 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001236 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001237 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001239 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240}
1241
1242/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001243 * device_unregister - unregister device from system.
1244 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001246 * We do this in two parts, like we do device_register(). First,
1247 * we remove it from all the subsystems with device_del(), then
1248 * we decrement the reference count via put_device(). If that
1249 * is the final reference count, the device will be cleaned up
1250 * via device_release() above. Otherwise, the structure will
1251 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001253void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001255 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 device_del(dev);
1257 put_device(dev);
1258}
1259
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001260static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001261{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001262 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001263 struct device *dev = NULL;
1264 struct device_private *p;
1265
1266 if (n) {
1267 p = to_device_private_parent(n);
1268 dev = p->device;
1269 }
1270 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001271}
1272
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001274 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001275 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001276 * @mode: returned file access mode
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001277 * @tmp: possibly allocated string
1278 *
1279 * Return the relative path of a possible device node.
1280 * Non-default names may need to allocate a memory to compose
1281 * a name. This memory is returned in tmp and needs to be
1282 * freed by the caller.
1283 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001284const char *device_get_devnode(struct device *dev,
Al Viro2c9ede52011-07-23 20:24:48 -04001285 umode_t *mode, const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001286{
1287 char *s;
1288
1289 *tmp = NULL;
1290
1291 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001292 if (dev->type && dev->type->devnode)
1293 *tmp = dev->type->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001294 if (*tmp)
1295 return *tmp;
1296
1297 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001298 if (dev->class && dev->class->devnode)
1299 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001300 if (*tmp)
1301 return *tmp;
1302
1303 /* return name without allocation, tmp == NULL */
1304 if (strchr(dev_name(dev), '!') == NULL)
1305 return dev_name(dev);
1306
1307 /* replace '!' in the name with '/' */
1308 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1309 if (!*tmp)
1310 return NULL;
1311 while ((s = strchr(*tmp, '!')))
1312 s[0] = '/';
1313 return *tmp;
1314}
1315
1316/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001317 * device_for_each_child - device child iterator.
1318 * @parent: parent struct device.
1319 * @data: data for the callback.
1320 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001322 * Iterate over @parent's child devices, and call @fn for each,
1323 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001325 * We check the return of @fn each time. If it returns anything
1326 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001328int device_for_each_child(struct device *parent, void *data,
1329 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001331 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001332 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 int error = 0;
1334
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001335 if (!parent->p)
1336 return 0;
1337
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001338 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001339 while ((child = next_device(&i)) && !error)
1340 error = fn(child, data);
1341 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 return error;
1343}
1344
Cornelia Huck5ab69982006-11-16 15:42:07 +01001345/**
1346 * device_find_child - device iterator for locating a particular device.
1347 * @parent: parent struct device
1348 * @data: Data to pass to match function
1349 * @match: Callback function to check device
1350 *
1351 * This is similar to the device_for_each_child() function above, but it
1352 * returns a reference to a device that is 'found' for later use, as
1353 * determined by the @match callback.
1354 *
1355 * The callback should return 0 if the device doesn't match and non-zero
1356 * if it does. If the callback returns non-zero and a reference to the
1357 * current device can be obtained, this function will return to the caller
1358 * and not iterate over any more devices.
1359 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001360struct device *device_find_child(struct device *parent, void *data,
1361 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001362{
1363 struct klist_iter i;
1364 struct device *child;
1365
1366 if (!parent)
1367 return NULL;
1368
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001369 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001370 while ((child = next_device(&i)))
1371 if (match(child, data) && get_device(child))
1372 break;
1373 klist_iter_exit(&i);
1374 return child;
1375}
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377int __init devices_init(void)
1378{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001379 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1380 if (!devices_kset)
1381 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001382 dev_kobj = kobject_create_and_add("dev", NULL);
1383 if (!dev_kobj)
1384 goto dev_kobj_err;
1385 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1386 if (!sysfs_dev_block_kobj)
1387 goto block_kobj_err;
1388 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1389 if (!sysfs_dev_char_kobj)
1390 goto char_kobj_err;
1391
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001392 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001393
1394 char_kobj_err:
1395 kobject_put(sysfs_dev_block_kobj);
1396 block_kobj_err:
1397 kobject_put(dev_kobj);
1398 dev_kobj_err:
1399 kset_unregister(devices_kset);
1400 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401}
1402
1403EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001404EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
1406EXPORT_SYMBOL_GPL(device_initialize);
1407EXPORT_SYMBOL_GPL(device_add);
1408EXPORT_SYMBOL_GPL(device_register);
1409
1410EXPORT_SYMBOL_GPL(device_del);
1411EXPORT_SYMBOL_GPL(device_unregister);
1412EXPORT_SYMBOL_GPL(get_device);
1413EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
1415EXPORT_SYMBOL_GPL(device_create_file);
1416EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001417
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001418struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001419 struct device dev;
1420 struct module *owner;
1421};
1422
Josh Triplett93058422012-11-18 21:27:55 -08001423static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001424{
1425 return container_of(d, struct root_device, dev);
1426}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001427
1428static void root_device_release(struct device *dev)
1429{
1430 kfree(to_root_device(dev));
1431}
1432
1433/**
1434 * __root_device_register - allocate and register a root device
1435 * @name: root device name
1436 * @owner: owner module of the root device, usually THIS_MODULE
1437 *
1438 * This function allocates a root device and registers it
1439 * using device_register(). In order to free the returned
1440 * device, use root_device_unregister().
1441 *
1442 * Root devices are dummy devices which allow other devices
1443 * to be grouped under /sys/devices. Use this function to
1444 * allocate a root device and then use it as the parent of
1445 * any device which should appear under /sys/devices/{name}
1446 *
1447 * The /sys/devices/{name} directory will also contain a
1448 * 'module' symlink which points to the @owner directory
1449 * in sysfs.
1450 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001451 * Returns &struct device pointer on success, or ERR_PTR() on error.
1452 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001453 * Note: You probably want to use root_device_register().
1454 */
1455struct device *__root_device_register(const char *name, struct module *owner)
1456{
1457 struct root_device *root;
1458 int err = -ENOMEM;
1459
1460 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1461 if (!root)
1462 return ERR_PTR(err);
1463
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001464 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001465 if (err) {
1466 kfree(root);
1467 return ERR_PTR(err);
1468 }
1469
1470 root->dev.release = root_device_release;
1471
1472 err = device_register(&root->dev);
1473 if (err) {
1474 put_device(&root->dev);
1475 return ERR_PTR(err);
1476 }
1477
Christoph Egger1d9e8822010-05-17 16:57:58 +02001478#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001479 if (owner) {
1480 struct module_kobject *mk = &owner->mkobj;
1481
1482 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1483 if (err) {
1484 device_unregister(&root->dev);
1485 return ERR_PTR(err);
1486 }
1487 root->owner = owner;
1488 }
1489#endif
1490
1491 return &root->dev;
1492}
1493EXPORT_SYMBOL_GPL(__root_device_register);
1494
1495/**
1496 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001497 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001498 *
1499 * This function unregisters and cleans up a device that was created by
1500 * root_device_register().
1501 */
1502void root_device_unregister(struct device *dev)
1503{
1504 struct root_device *root = to_root_device(dev);
1505
1506 if (root->owner)
1507 sysfs_remove_link(&root->dev.kobj, "module");
1508
1509 device_unregister(dev);
1510}
1511EXPORT_SYMBOL_GPL(root_device_unregister);
1512
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001513
1514static void device_create_release(struct device *dev)
1515{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001516 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001517 kfree(dev);
1518}
1519
1520/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001521 * device_create_vargs - creates a device and registers it with sysfs
1522 * @class: pointer to the struct class that this device should be registered to
1523 * @parent: pointer to the parent struct device of this new device, if any
1524 * @devt: the dev_t for the char device to be added
1525 * @drvdata: the data to be added to the device for callbacks
1526 * @fmt: string for the device's name
1527 * @args: va_list for the device's name
1528 *
1529 * This function can be used by char device classes. A struct device
1530 * will be created in sysfs, registered to the specified class.
1531 *
1532 * A "dev" file will be created, showing the dev_t for the device, if
1533 * the dev_t is not 0,0.
1534 * If a pointer to a parent struct device is passed in, the newly created
1535 * struct device will be a child of that device in sysfs.
1536 * The pointer to the struct device will be returned from the call.
1537 * Any further sysfs files that might be required can be created using this
1538 * pointer.
1539 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001540 * Returns &struct device pointer on success, or ERR_PTR() on error.
1541 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001542 * Note: the struct class passed to this function must have previously
1543 * been created with a call to class_create().
1544 */
1545struct device *device_create_vargs(struct class *class, struct device *parent,
1546 dev_t devt, void *drvdata, const char *fmt,
1547 va_list args)
1548{
1549 struct device *dev = NULL;
1550 int retval = -ENODEV;
1551
1552 if (class == NULL || IS_ERR(class))
1553 goto error;
1554
1555 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1556 if (!dev) {
1557 retval = -ENOMEM;
1558 goto error;
1559 }
1560
1561 dev->devt = devt;
1562 dev->class = class;
1563 dev->parent = parent;
1564 dev->release = device_create_release;
1565 dev_set_drvdata(dev, drvdata);
1566
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001567 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1568 if (retval)
1569 goto error;
1570
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001571 retval = device_register(dev);
1572 if (retval)
1573 goto error;
1574
1575 return dev;
1576
1577error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001578 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001579 return ERR_PTR(retval);
1580}
1581EXPORT_SYMBOL_GPL(device_create_vargs);
1582
1583/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001584 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001585 * @class: pointer to the struct class that this device should be registered to
1586 * @parent: pointer to the parent struct device of this new device, if any
1587 * @devt: the dev_t for the char device to be added
1588 * @drvdata: the data to be added to the device for callbacks
1589 * @fmt: string for the device's name
1590 *
1591 * This function can be used by char device classes. A struct device
1592 * will be created in sysfs, registered to the specified class.
1593 *
1594 * A "dev" file will be created, showing the dev_t for the device, if
1595 * the dev_t is not 0,0.
1596 * If a pointer to a parent struct device is passed in, the newly created
1597 * struct device will be a child of that device in sysfs.
1598 * The pointer to the struct device will be returned from the call.
1599 * Any further sysfs files that might be required can be created using this
1600 * pointer.
1601 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001602 * Returns &struct device pointer on success, or ERR_PTR() on error.
1603 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001604 * Note: the struct class passed to this function must have previously
1605 * been created with a call to class_create().
1606 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001607struct device *device_create(struct class *class, struct device *parent,
1608 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001609{
1610 va_list vargs;
1611 struct device *dev;
1612
1613 va_start(vargs, fmt);
1614 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1615 va_end(vargs);
1616 return dev;
1617}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001618EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001619
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001620static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001621{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001622 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001623
Dave Youngcd354492008-01-28 16:56:11 +08001624 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001625}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001626
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001627/**
1628 * device_destroy - removes a device that was created with device_create()
1629 * @class: pointer to the struct class that this device was registered with
1630 * @devt: the dev_t of the device that was previously registered
1631 *
1632 * This call unregisters and cleans up a device that was created with a
1633 * call to device_create().
1634 */
1635void device_destroy(struct class *class, dev_t devt)
1636{
1637 struct device *dev;
1638
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001639 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001640 if (dev) {
1641 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001642 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001643 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001644}
1645EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001646
1647/**
1648 * device_rename - renames a device
1649 * @dev: the pointer to the struct device to be renamed
1650 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001651 *
1652 * It is the responsibility of the caller to provide mutual
1653 * exclusion between two different calls of device_rename
1654 * on the same device to ensure that new_name is valid and
1655 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001656 *
Timur Tabia5462512010-12-13 14:08:52 -06001657 * Note: Don't call this function. Currently, the networking layer calls this
1658 * function, but that will change. The following text from Kay Sievers offers
1659 * some insight:
1660 *
1661 * Renaming devices is racy at many levels, symlinks and other stuff are not
1662 * replaced atomically, and you get a "move" uevent, but it's not easy to
1663 * connect the event to the old and new device. Device nodes are not renamed at
1664 * all, there isn't even support for that in the kernel now.
1665 *
1666 * In the meantime, during renaming, your target name might be taken by another
1667 * driver, creating conflicts. Or the old name is taken directly after you
1668 * renamed it -- then you get events for the same DEVPATH, before you even see
1669 * the "move" event. It's just a mess, and nothing new should ever rely on
1670 * kernel device renaming. Besides that, it's not even implemented now for
1671 * other things than (driver-core wise very simple) network devices.
1672 *
1673 * We are currently about to change network renaming in udev to completely
1674 * disallow renaming of devices in the same namespace as the kernel uses,
1675 * because we can't solve the problems properly, that arise with swapping names
1676 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1677 * be allowed to some other name than eth[0-9]*, for the aforementioned
1678 * reasons.
1679 *
1680 * Make up a "real" name in the driver before you register anything, or add
1681 * some other attributes for userspace to find the device, or use udev to add
1682 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1683 * don't even want to get into that and try to implement the missing pieces in
1684 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001685 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001686int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001687{
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001688 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001689 int error;
1690
1691 dev = get_device(dev);
1692 if (!dev)
1693 return -EINVAL;
1694
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001695 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001696 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001697
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001698 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001699 if (!old_device_name) {
1700 error = -ENOMEM;
1701 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001702 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001703
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001704 if (dev->class) {
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001705 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001706 &dev->kobj, old_device_name, new_name);
1707 if (error)
1708 goto out;
1709 }
Kay Sievers39aba962010-09-04 22:33:14 -07001710
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001711 error = kobject_rename(&dev->kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001712 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001713 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001714
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001715out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001716 put_device(dev);
1717
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001718 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001719
1720 return error;
1721}
Johannes Berga2807db2007-02-28 12:38:31 +01001722EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001723
1724static int device_move_class_links(struct device *dev,
1725 struct device *old_parent,
1726 struct device *new_parent)
1727{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001728 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001729
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001730 if (old_parent)
1731 sysfs_remove_link(&dev->kobj, "device");
1732 if (new_parent)
1733 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1734 "device");
1735 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001736}
1737
1738/**
1739 * device_move - moves a device to a new parent
1740 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001741 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001742 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001743 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001744int device_move(struct device *dev, struct device *new_parent,
1745 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001746{
1747 int error;
1748 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001749 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001750
1751 dev = get_device(dev);
1752 if (!dev)
1753 return -EINVAL;
1754
Cornelia Huckffa6a702009-03-04 12:44:00 +01001755 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001756 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001757 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001758
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001759 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1760 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001761 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001762 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001763 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001764 put_device(new_parent);
1765 goto out;
1766 }
1767 old_parent = dev->parent;
1768 dev->parent = new_parent;
1769 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001770 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001771 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001772 klist_add_tail(&dev->p->knode_parent,
1773 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001774 set_dev_node(dev, dev_to_node(new_parent));
1775 }
1776
Rabin Vincentbdd40342012-04-23 09:16:36 +02001777 if (dev->class) {
1778 error = device_move_class_links(dev, old_parent, new_parent);
1779 if (error) {
1780 /* We ignore errors on cleanup since we're hosed anyway... */
1781 device_move_class_links(dev, new_parent, old_parent);
1782 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1783 if (new_parent)
1784 klist_remove(&dev->p->knode_parent);
1785 dev->parent = old_parent;
1786 if (old_parent) {
1787 klist_add_tail(&dev->p->knode_parent,
1788 &old_parent->p->klist_children);
1789 set_dev_node(dev, dev_to_node(old_parent));
1790 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001791 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001792 cleanup_glue_dir(dev, new_parent_kobj);
1793 put_device(new_parent);
1794 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001795 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001796 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001797 switch (dpm_order) {
1798 case DPM_ORDER_NONE:
1799 break;
1800 case DPM_ORDER_DEV_AFTER_PARENT:
1801 device_pm_move_after(dev, new_parent);
1802 break;
1803 case DPM_ORDER_PARENT_BEFORE_DEV:
1804 device_pm_move_before(new_parent, dev);
1805 break;
1806 case DPM_ORDER_DEV_LAST:
1807 device_pm_move_last(dev);
1808 break;
1809 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001810
Cornelia Huck8a824722006-11-20 17:07:51 +01001811 put_device(old_parent);
1812out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001813 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001814 put_device(dev);
1815 return error;
1816}
Cornelia Huck8a824722006-11-20 17:07:51 +01001817EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001818
1819/**
1820 * device_shutdown - call ->shutdown() on each device to shutdown.
1821 */
1822void device_shutdown(void)
1823{
Hugh Daschbach62458382010-03-22 10:36:37 -07001824 struct device *dev;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001825
Hugh Daschbach62458382010-03-22 10:36:37 -07001826 spin_lock(&devices_kset->list_lock);
1827 /*
1828 * Walk the devices list backward, shutting down each in turn.
1829 * Beware that device unplug events may also start pulling
1830 * devices offline, even as the system is shutting down.
1831 */
1832 while (!list_empty(&devices_kset->list)) {
1833 dev = list_entry(devices_kset->list.prev, struct device,
1834 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08001835
1836 /*
1837 * hold reference count of device's parent to
1838 * prevent it from being freed because parent's
1839 * lock is to be held
1840 */
1841 get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001842 get_device(dev);
1843 /*
1844 * Make sure the device is off the kset list, in the
1845 * event that dev->*->shutdown() doesn't remove it.
1846 */
1847 list_del_init(&dev->kobj.entry);
1848 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001849
Ming Leid1c6c032012-06-22 18:01:40 +08001850 /* hold lock to avoid race with probe/release */
1851 if (dev->parent)
1852 device_lock(dev->parent);
1853 device_lock(dev);
1854
Alan Sternfe6b91f2011-12-06 23:24:52 +01001855 /* Don't allow any more runtime suspends */
1856 pm_runtime_get_noresume(dev);
1857 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001858
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001859 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001860 if (initcall_debug)
1861 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001862 dev->bus->shutdown(dev);
1863 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001864 if (initcall_debug)
1865 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001866 dev->driver->shutdown(dev);
1867 }
Ming Leid1c6c032012-06-22 18:01:40 +08001868
1869 device_unlock(dev);
1870 if (dev->parent)
1871 device_unlock(dev->parent);
1872
Hugh Daschbach62458382010-03-22 10:36:37 -07001873 put_device(dev);
Ming Leid1c6c032012-06-22 18:01:40 +08001874 put_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001875
1876 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001877 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001878 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07001879 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001880}
Joe Perches99bcf212010-06-27 01:02:34 +00001881
1882/*
1883 * Device logging functions
1884 */
1885
1886#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07001887static int
1888create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00001889{
Kay Sieversc4e00da2012-05-03 02:29:59 +02001890 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07001891 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00001892
Kay Sieversc4e00da2012-05-03 02:29:59 +02001893 if (dev->class)
1894 subsys = dev->class->name;
1895 else if (dev->bus)
1896 subsys = dev->bus->name;
1897 else
Joe Perches798efc62012-09-12 20:11:29 -07001898 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02001899
Joe Perches798efc62012-09-12 20:11:29 -07001900 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Kay Sieversc4e00da2012-05-03 02:29:59 +02001901
1902 /*
1903 * Add device identifier DEVICE=:
1904 * b12:8 block dev_t
1905 * c127:3 char dev_t
1906 * n8 netdev ifindex
1907 * +sound:card0 subsystem:devname
1908 */
1909 if (MAJOR(dev->devt)) {
1910 char c;
1911
1912 if (strcmp(subsys, "block") == 0)
1913 c = 'b';
1914 else
1915 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07001916 pos++;
1917 pos += snprintf(hdr + pos, hdrlen - pos,
1918 "DEVICE=%c%u:%u",
1919 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02001920 } else if (strcmp(subsys, "net") == 0) {
1921 struct net_device *net = to_net_dev(dev);
1922
Joe Perches798efc62012-09-12 20:11:29 -07001923 pos++;
1924 pos += snprintf(hdr + pos, hdrlen - pos,
1925 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02001926 } else {
Joe Perches798efc62012-09-12 20:11:29 -07001927 pos++;
1928 pos += snprintf(hdr + pos, hdrlen - pos,
1929 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02001930 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06001931
Joe Perches798efc62012-09-12 20:11:29 -07001932 return pos;
Joe Perches99bcf212010-06-27 01:02:34 +00001933}
Joe Perches798efc62012-09-12 20:11:29 -07001934EXPORT_SYMBOL(create_syslog_header);
1935
Joe Perches05e4e5b2012-09-12 20:13:37 -07001936int dev_vprintk_emit(int level, const struct device *dev,
1937 const char *fmt, va_list args)
1938{
1939 char hdr[128];
1940 size_t hdrlen;
1941
1942 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
1943
1944 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
1945}
1946EXPORT_SYMBOL(dev_vprintk_emit);
1947
1948int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1949{
1950 va_list args;
1951 int r;
1952
1953 va_start(args, fmt);
1954
1955 r = dev_vprintk_emit(level, dev, fmt, args);
1956
1957 va_end(args);
1958
1959 return r;
1960}
1961EXPORT_SYMBOL(dev_printk_emit);
1962
Joe Perches798efc62012-09-12 20:11:29 -07001963static int __dev_printk(const char *level, const struct device *dev,
1964 struct va_format *vaf)
1965{
Joe Perches798efc62012-09-12 20:11:29 -07001966 if (!dev)
1967 return printk("%s(NULL device *): %pV", level, vaf);
1968
Joe Perches666f3552012-09-12 20:14:11 -07001969 return dev_printk_emit(level[1] - '0', dev,
1970 "%s %s: %pV",
1971 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches798efc62012-09-12 20:11:29 -07001972}
Joe Perches99bcf212010-06-27 01:02:34 +00001973
1974int dev_printk(const char *level, const struct device *dev,
1975 const char *fmt, ...)
1976{
1977 struct va_format vaf;
1978 va_list args;
1979 int r;
1980
1981 va_start(args, fmt);
1982
1983 vaf.fmt = fmt;
1984 vaf.va = &args;
1985
1986 r = __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07001987
Joe Perches99bcf212010-06-27 01:02:34 +00001988 va_end(args);
1989
1990 return r;
1991}
1992EXPORT_SYMBOL(dev_printk);
1993
1994#define define_dev_printk_level(func, kern_level) \
1995int func(const struct device *dev, const char *fmt, ...) \
1996{ \
1997 struct va_format vaf; \
1998 va_list args; \
1999 int r; \
2000 \
2001 va_start(args, fmt); \
2002 \
2003 vaf.fmt = fmt; \
2004 vaf.va = &args; \
2005 \
2006 r = __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002007 \
Joe Perches99bcf212010-06-27 01:02:34 +00002008 va_end(args); \
2009 \
2010 return r; \
2011} \
2012EXPORT_SYMBOL(func);
2013
2014define_dev_printk_level(dev_emerg, KERN_EMERG);
2015define_dev_printk_level(dev_alert, KERN_ALERT);
2016define_dev_printk_level(dev_crit, KERN_CRIT);
2017define_dev_printk_level(dev_err, KERN_ERR);
2018define_dev_printk_level(dev_warn, KERN_WARNING);
2019define_dev_printk_level(dev_notice, KERN_NOTICE);
2020define_dev_printk_level(_dev_info, KERN_INFO);
2021
2022#endif