blob: 2499cefdcdf2429d9503506d5514a4943f9ec4e1 [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;
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700286 kuid_t uid = GLOBAL_ROOT_UID;
287 kgid_t gid = GLOBAL_ROOT_GID;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200288
Kay Sievers7eff2e72007-08-14 15:15:12 +0200289 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
290 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700291 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200292 if (name) {
293 add_uevent_var(env, "DEVNAME=%s", name);
Kay Sieverse454cea2009-09-18 23:01:12 +0200294 if (mode)
295 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700296 if (!uid_eq(uid, GLOBAL_ROOT_UID))
297 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
298 if (!gid_eq(gid, GLOBAL_ROOT_GID))
299 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700300 kfree(tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200301 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700302 }
303
Kay Sievers414264f2007-03-12 21:08:57 +0100304 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200305 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100306
Kay Sievers239378f2006-10-07 21:54:55 +0200307 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200308 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200309
Grant Likely07d57a32012-02-01 11:22:22 -0700310 /* Add common DT information about the device */
311 of_device_uevent(dev, env);
312
Kay Sievers7eff2e72007-08-14 15:15:12 +0200313 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100314 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200315 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200316 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800317 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100318 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 }
320
Kay Sievers7eff2e72007-08-14 15:15:12 +0200321 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700322 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200323 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200324 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800325 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100326 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800327 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200328 }
329
Stefan Weileef35c22010-08-06 21:11:15 +0200330 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200331 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200332 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200333 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800334 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100335 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800336 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700337 }
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 return retval;
340}
341
Emese Revfy9cd43612009-12-31 14:52:51 +0100342static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100343 .filter = dev_uevent_filter,
344 .name = dev_uevent_name,
345 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346};
347
Kay Sievers16574dc2007-04-06 01:40:38 +0200348static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
349 char *buf)
350{
351 struct kobject *top_kobj;
352 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200353 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200354 int i;
355 size_t count = 0;
356 int retval;
357
358 /* search the kset, the device belongs to */
359 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200360 while (!top_kobj->kset && top_kobj->parent)
361 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200362 if (!top_kobj->kset)
363 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200364
Kay Sievers16574dc2007-04-06 01:40:38 +0200365 kset = top_kobj->kset;
366 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
367 goto out;
368
369 /* respect filter */
370 if (kset->uevent_ops && kset->uevent_ops->filter)
371 if (!kset->uevent_ops->filter(kset, &dev->kobj))
372 goto out;
373
Kay Sievers7eff2e72007-08-14 15:15:12 +0200374 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
375 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200376 return -ENOMEM;
377
Kay Sievers16574dc2007-04-06 01:40:38 +0200378 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200379 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200380 if (retval)
381 goto out;
382
383 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200384 for (i = 0; i < env->envp_idx; i++)
385 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200386out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200387 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200388 return count;
389}
390
Kay Sieversa7fd6702005-10-01 14:49:43 +0200391static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
392 const char *buf, size_t count)
393{
Kay Sievers60a96a52007-07-08 22:29:26 +0200394 enum kobject_action action;
395
Kay Sievers3f5468c2010-01-14 22:54:37 +0100396 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200397 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100398 else
399 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200400 return count;
401}
402
Tejun Heoad6a1e12007-06-14 03:45:17 +0900403static struct device_attribute uevent_attr =
404 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
405
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500406static int device_add_attributes(struct device *dev,
407 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700408{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700409 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500410 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700411
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500412 if (attrs) {
413 for (i = 0; attr_name(attrs[i]); i++) {
414 error = device_create_file(dev, &attrs[i]);
415 if (error)
416 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700417 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500418 if (error)
419 while (--i >= 0)
420 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700421 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700422 return error;
423}
424
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500425static void device_remove_attributes(struct device *dev,
426 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700427{
428 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500429
430 if (attrs)
431 for (i = 0; attr_name(attrs[i]); i++)
432 device_remove_file(dev, &attrs[i]);
433}
434
Stefan Achatzc97415a2010-11-26 19:57:29 +0000435static int device_add_bin_attributes(struct device *dev,
436 struct bin_attribute *attrs)
437{
438 int error = 0;
439 int i;
440
441 if (attrs) {
442 for (i = 0; attr_name(attrs[i]); i++) {
443 error = device_create_bin_file(dev, &attrs[i]);
444 if (error)
445 break;
446 }
447 if (error)
448 while (--i >= 0)
449 device_remove_bin_file(dev, &attrs[i]);
450 }
451 return error;
452}
453
454static void device_remove_bin_attributes(struct device *dev,
455 struct bin_attribute *attrs)
456{
457 int i;
458
459 if (attrs)
460 for (i = 0; attr_name(attrs[i]); i++)
461 device_remove_bin_file(dev, &attrs[i]);
462}
463
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500464static int device_add_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700465 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500466{
467 int error = 0;
468 int i;
469
470 if (groups) {
471 for (i = 0; groups[i]; i++) {
472 error = sysfs_create_group(&dev->kobj, groups[i]);
473 if (error) {
474 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800475 sysfs_remove_group(&dev->kobj,
476 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500477 break;
478 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700479 }
480 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500481 return error;
482}
483
484static void device_remove_groups(struct device *dev,
David Brownella4dbd672009-06-24 10:06:31 -0700485 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500486{
487 int i;
488
489 if (groups)
490 for (i = 0; groups[i]; i++)
491 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700492}
493
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700494static int device_add_attrs(struct device *dev)
495{
496 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700497 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500498 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700499
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500500 if (class) {
501 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200502 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500503 return error;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000504 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
505 if (error)
506 goto err_remove_class_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700507 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200508
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500509 if (type) {
510 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200511 if (error)
Stefan Achatzc97415a2010-11-26 19:57:29 +0000512 goto err_remove_class_bin_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200513 }
514
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500515 error = device_add_groups(dev, dev->groups);
516 if (error)
517 goto err_remove_type_groups;
518
519 return 0;
520
521 err_remove_type_groups:
522 if (type)
523 device_remove_groups(dev, type->groups);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000524 err_remove_class_bin_attrs:
525 if (class)
526 device_remove_bin_attributes(dev, class->dev_bin_attrs);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500527 err_remove_class_attrs:
528 if (class)
529 device_remove_attributes(dev, class->dev_attrs);
530
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700531 return error;
532}
533
534static void device_remove_attrs(struct device *dev)
535{
536 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700537 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700538
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500539 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200540
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500541 if (type)
542 device_remove_groups(dev, type->groups);
543
Stefan Achatzc97415a2010-11-26 19:57:29 +0000544 if (class) {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500545 device_remove_attributes(dev, class->dev_attrs);
Stefan Achatzc97415a2010-11-26 19:57:29 +0000546 device_remove_bin_attributes(dev, class->dev_bin_attrs);
547 }
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700548}
549
550
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700551static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
552 char *buf)
553{
554 return print_dev_t(buf, dev->devt);
555}
556
Tejun Heoad6a1e12007-06-14 03:45:17 +0900557static struct device_attribute devt_attr =
558 __ATTR(dev, S_IRUGO, show_dev, NULL);
559
Kay Sieversca22e562011-12-14 14:29:38 -0800560/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600561struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800564 * device_create_file - create sysfs attribute file for device.
565 * @dev: device.
566 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200568int device_create_file(struct device *dev,
569 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
571 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200572
573 if (dev) {
574 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800575 "Attribute %s: write permission without 'store'\n",
576 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200577 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800578 "Attribute %s: read permission without 'show'\n",
579 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200581 }
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 return error;
584}
585
586/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800587 * device_remove_file - remove sysfs attribute file.
588 * @dev: device.
589 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200591void device_remove_file(struct device *dev,
592 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100594 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596}
597
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700598/**
599 * device_create_bin_file - create sysfs binary attribute file for device.
600 * @dev: device.
601 * @attr: device binary attribute descriptor.
602 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200603int device_create_bin_file(struct device *dev,
604 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700605{
606 int error = -EINVAL;
607 if (dev)
608 error = sysfs_create_bin_file(&dev->kobj, attr);
609 return error;
610}
611EXPORT_SYMBOL_GPL(device_create_bin_file);
612
613/**
614 * device_remove_bin_file - remove sysfs binary attribute file
615 * @dev: device.
616 * @attr: device binary attribute descriptor.
617 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200618void device_remove_bin_file(struct device *dev,
619 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700620{
621 if (dev)
622 sysfs_remove_bin_file(&dev->kobj, attr);
623}
624EXPORT_SYMBOL_GPL(device_remove_bin_file);
625
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400626/**
Alan Stern523ded72007-04-26 00:12:04 -0700627 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400628 * @dev: device.
629 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700630 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400631 *
632 * Attribute methods must not unregister themselves or their parent device
633 * (which would amount to the same thing). Attempts to do so will deadlock,
634 * since unregistration is mutually exclusive with driver callbacks.
635 *
636 * Instead methods can call this routine, which will attempt to allocate
637 * and schedule a workqueue request to call back @func with @dev as its
638 * argument in the workqueue's process context. @dev will be pinned until
639 * @func returns.
640 *
Alan Stern523ded72007-04-26 00:12:04 -0700641 * This routine is usually called via the inline device_schedule_callback(),
642 * which automatically sets @owner to THIS_MODULE.
643 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400644 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700645 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400646 *
647 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
648 * underlying sysfs routine (since it is intended for use by attribute
649 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
650 */
Alan Stern523ded72007-04-26 00:12:04 -0700651int device_schedule_callback_owner(struct device *dev,
652 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400653{
654 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700655 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400656}
Alan Stern523ded72007-04-26 00:12:04 -0700657EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400658
James Bottomley34bb61f2005-09-06 16:56:51 -0700659static void klist_children_get(struct klist_node *n)
660{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800661 struct device_private *p = to_device_private_parent(n);
662 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700663
664 get_device(dev);
665}
666
667static void klist_children_put(struct klist_node *n)
668{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800669 struct device_private *p = to_device_private_parent(n);
670 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700671
672 put_device(dev);
673}
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800676 * device_initialize - init device structure.
677 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 *
Cornelia Huck57394112008-09-03 18:26:40 +0200679 * This prepares the device for use by other layers by initializing
680 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800681 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200682 * that function, though it can also be called separately, so one
683 * may use @dev's fields. In particular, get_device()/put_device()
684 * may be used for reference counting of @dev after calling this
685 * function.
686 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500687 * All fields in @dev must be initialized by the caller to 0, except
688 * for those explicitly set to some other value. The simplest
689 * approach is to use kzalloc() to allocate the structure containing
690 * @dev.
691 *
Cornelia Huck57394112008-09-03 18:26:40 +0200692 * NOTE: Use put_device() to give up your reference instead of freeing
693 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695void device_initialize(struct device *dev)
696{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600697 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700698 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000700 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100701 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900702 spin_lock_init(&dev->devres_lock);
703 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400704 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800705 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706}
707
Tejun Heod73ce002013-03-12 11:30:05 -0700708struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700709{
Kay Sievers86406242007-03-14 03:25:56 +0100710 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700711
Kay Sievers86406242007-03-14 03:25:56 +0100712 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800713 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600714 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700715
Kay Sievers86406242007-03-14 03:25:56 +0100716 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700717}
718
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700719struct class_dir {
720 struct kobject kobj;
721 struct class *class;
722};
723
724#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
725
726static void class_dir_release(struct kobject *kobj)
727{
728 struct class_dir *dir = to_class_dir(kobj);
729 kfree(dir);
730}
731
732static const
733struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
734{
735 struct class_dir *dir = to_class_dir(kobj);
736 return dir->class->ns_type;
737}
738
739static struct kobj_type class_dir_ktype = {
740 .release = class_dir_release,
741 .sysfs_ops = &kobj_sysfs_ops,
742 .child_ns_type = class_dir_child_ns_type
743};
744
745static struct kobject *
746class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
747{
748 struct class_dir *dir;
749 int retval;
750
751 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
752 if (!dir)
753 return NULL;
754
755 dir->class = class;
756 kobject_init(&dir->kobj, &class_dir_ktype);
757
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100758 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700759
760 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
761 if (retval < 0) {
762 kobject_put(&dir->kobj);
763 return NULL;
764 }
765 return &dir->kobj;
766}
767
768
Kay Sieversda231fd2007-11-21 17:29:15 +0100769static struct kobject *get_device_parent(struct device *dev,
770 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100771{
Kay Sievers86406242007-03-14 03:25:56 +0100772 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900773 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100774 struct kobject *kobj = NULL;
775 struct kobject *parent_kobj;
776 struct kobject *k;
777
Randy Dunlapead454f2010-09-24 14:36:49 -0700778#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700779 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200780 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700781 if (parent && parent->class == &block_class)
782 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100783 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700784 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700785#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200786
Kay Sievers86406242007-03-14 03:25:56 +0100787 /*
788 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100789 * Class-devices with a non class-device as parent, live
790 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100791 */
792 if (parent == NULL)
793 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700794 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100795 return &parent->kobj;
796 else
797 parent_kobj = &parent->kobj;
798
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900799 mutex_lock(&gdp_mutex);
800
Kay Sievers86406242007-03-14 03:25:56 +0100801 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100802 spin_lock(&dev->class->p->glue_dirs.list_lock);
803 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100804 if (k->parent == parent_kobj) {
805 kobj = kobject_get(k);
806 break;
807 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100808 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900809 if (kobj) {
810 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100811 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900812 }
Kay Sievers86406242007-03-14 03:25:56 +0100813
814 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700815 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100816 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900817 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800818 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100819 }
820
Kay Sieversca22e562011-12-14 14:29:38 -0800821 /* subsystems can specify a default root directory for their devices */
822 if (!parent && dev->bus && dev->bus->dev_root)
823 return &dev->bus->dev_root->kobj;
824
Kay Sievers86406242007-03-14 03:25:56 +0100825 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100826 return &parent->kobj;
827 return NULL;
828}
Kay Sieversda231fd2007-11-21 17:29:15 +0100829
Cornelia Huck63b69712008-01-21 16:09:44 +0100830static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100831{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100832 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100833 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100834 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100835 return;
836
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100837 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100838}
Cornelia Huck63b69712008-01-21 16:09:44 +0100839
840static void cleanup_device_parent(struct device *dev)
841{
842 cleanup_glue_dir(dev, dev->kobj.parent);
843}
Kay Sievers86406242007-03-14 03:25:56 +0100844
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700845static int device_add_class_symlinks(struct device *dev)
846{
847 int error;
848
849 if (!dev->class)
850 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100851
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700852 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100853 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700854 "subsystem");
855 if (error)
856 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100857
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800858 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700859 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
860 "device");
861 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700862 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700863 }
Kay Sievers39aba962010-09-04 22:33:14 -0700864
Randy Dunlapead454f2010-09-24 14:36:49 -0700865#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700866 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200867 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700868 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700869#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700870
871 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100872 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700873 &dev->kobj, dev_name(dev));
874 if (error)
875 goto out_device;
876
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700877 return 0;
878
Kay Sievers39aba962010-09-04 22:33:14 -0700879out_device:
880 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100881
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700882out_subsys:
883 sysfs_remove_link(&dev->kobj, "subsystem");
884out:
885 return error;
886}
887
888static void device_remove_class_symlinks(struct device *dev)
889{
890 if (!dev->class)
891 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100892
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800893 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100894 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700895 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700896#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200897 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700898 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700899#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100900 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700901}
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000904 * dev_set_name - set a device name
905 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700906 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000907 */
908int dev_set_name(struct device *dev, const char *fmt, ...)
909{
910 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100911 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000912
913 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100914 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000915 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100916 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000917}
918EXPORT_SYMBOL_GPL(dev_set_name);
919
920/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700921 * device_to_dev_kobj - select a /sys/dev/ directory for the device
922 * @dev: device
923 *
924 * By default we select char/ for new entries. Setting class->dev_obj
925 * to NULL prevents an entry from being created. class->dev_kobj must
926 * be set (or cleared) before any devices are registered to the class
927 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200928 * device_remove_sys_dev_entry() will disagree about the presence of
929 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700930 */
931static struct kobject *device_to_dev_kobj(struct device *dev)
932{
933 struct kobject *kobj;
934
935 if (dev->class)
936 kobj = dev->class->dev_kobj;
937 else
938 kobj = sysfs_dev_char_kobj;
939
940 return kobj;
941}
942
943static int device_create_sys_dev_entry(struct device *dev)
944{
945 struct kobject *kobj = device_to_dev_kobj(dev);
946 int error = 0;
947 char devt_str[15];
948
949 if (kobj) {
950 format_dev_t(devt_str, dev->devt);
951 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
952 }
953
954 return error;
955}
956
957static void device_remove_sys_dev_entry(struct device *dev)
958{
959 struct kobject *kobj = device_to_dev_kobj(dev);
960 char devt_str[15];
961
962 if (kobj) {
963 format_dev_t(devt_str, dev->devt);
964 sysfs_remove_link(kobj, devt_str);
965 }
966}
967
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700968int device_private_init(struct device *dev)
969{
970 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
971 if (!dev->p)
972 return -ENOMEM;
973 dev->p->device = dev;
974 klist_init(&dev->p->klist_children, klist_children_get,
975 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800976 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700977 return 0;
978}
979
Dan Williamse105b8b2008-04-21 10:51:07 -0700980/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800981 * device_add - add device to device hierarchy.
982 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800984 * This is part 2 of device_register(), though may be called
985 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 *
Cornelia Huck57394112008-09-03 18:26:40 +0200987 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800988 * to the global and sibling lists for the device, then
989 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200990 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500991 * Do not call this routine or device_register() more than once for
992 * any device structure. The driver model core is not designed to work
993 * with devices that get unregistered and then spring back to life.
994 * (Among other things, it's very hard to guarantee that all references
995 * to the previous incarnation of @dev have been dropped.) Allocate
996 * and register a fresh new struct device instead.
997 *
Cornelia Huck57394112008-09-03 18:26:40 +0200998 * NOTE: _Never_ directly free @dev after calling this function, even
999 * if it returned an error! Always use put_device() to give up your
1000 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 */
1002int device_add(struct device *dev)
1003{
1004 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -08001005 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001006 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001007 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001010 if (!dev)
1011 goto done;
1012
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001013 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001014 error = device_private_init(dev);
1015 if (error)
1016 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001017 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001018
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001019 /*
1020 * for statically allocated devices, which should all be converted
1021 * some day, we need to initialize the name. We prevent reading back
1022 * the name, and force the use of dev_name()
1023 */
1024 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001025 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001026 dev->init_name = NULL;
1027 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001028
Kay Sieversca22e562011-12-14 14:29:38 -08001029 /* subsystems can specify simple device enumeration */
1030 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1031 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1032
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001033 if (!dev_name(dev)) {
1034 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001035 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001036 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001038 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001041 kobj = get_device_parent(dev, parent);
1042 if (kobj)
1043 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
Yinghai Lu0d358f22008-02-19 03:20:41 -08001045 /* use parent numa_node */
1046 if (parent)
1047 set_dev_node(dev, dev_to_node(parent));
1048
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001050 /* we require the name to be set before, and pass NULL */
1051 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001052 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001054
Brian Walsh37022642006-08-14 22:43:19 -07001055 /* notify platform of device entry */
1056 if (platform_notify)
1057 platform_notify(dev);
1058
Tejun Heoad6a1e12007-06-14 03:45:17 +09001059 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001060 if (error)
1061 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001062
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001063 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +09001064 error = device_create_file(dev, &devt_attr);
1065 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001066 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001067
1068 error = device_create_sys_dev_entry(dev);
1069 if (error)
1070 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001071
1072 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001073 }
1074
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001075 error = device_add_class_symlinks(dev);
1076 if (error)
1077 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001078 error = device_add_attrs(dev);
1079 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001080 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001081 error = bus_add_device(dev);
1082 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001084 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001085 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001086 goto DPMError;
1087 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001088
1089 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001090 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001091 */
1092 if (dev->bus)
1093 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1094 BUS_NOTIFY_ADD_DEVICE, dev);
1095
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001096 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001097 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001099 klist_add_tail(&dev->p->knode_parent,
1100 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001102 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001103 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001104 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001105 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001106 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001107
1108 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001109 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001110 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001111 if (class_intf->add_dev)
1112 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001113 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001114 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001115done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 put_device(dev);
1117 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001118 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001119 bus_remove_device(dev);
1120 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001121 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001122 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001123 device_remove_class_symlinks(dev);
1124 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001125 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001126 devtmpfs_delete_node(dev);
1127 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001128 device_remove_sys_dev_entry(dev);
1129 devtattrError:
1130 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +09001131 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001132 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001133 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001134 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001135 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 kobject_del(&dev->kobj);
1137 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001138 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 if (parent)
1140 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001141name_error:
1142 kfree(dev->p);
1143 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001144 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145}
1146
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001148 * device_register - register a device with the system.
1149 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001151 * This happens in two clean steps - initialize the device
1152 * and add it to the system. The two steps can be called
1153 * separately, but this is the easiest and most common.
1154 * I.e. you should only call the two helpers separately if
1155 * have a clearly defined need to use and refcount the device
1156 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001157 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001158 * For more information, see the kerneldoc for device_initialize()
1159 * and device_add().
1160 *
Cornelia Huck57394112008-09-03 18:26:40 +02001161 * NOTE: _Never_ directly free @dev after calling this function, even
1162 * if it returned an error! Always use put_device() to give up the
1163 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165int device_register(struct device *dev)
1166{
1167 device_initialize(dev);
1168 return device_add(dev);
1169}
1170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001172 * get_device - increment reference count for device.
1173 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001175 * This simply forwards the call to kobject_get(), though
1176 * we do take care to provide for the case that we get a NULL
1177 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001179struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001181 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
1183
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001185 * put_device - decrement reference count.
1186 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001188void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001190 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 if (dev)
1192 kobject_put(&dev->kobj);
1193}
1194
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001196 * device_del - delete device from system.
1197 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001199 * This is the first part of the device unregistration
1200 * sequence. This removes the device from the lists we control
1201 * from here, has it removed from the other driver model
1202 * subsystems it was added to in device_add(), and removes it
1203 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001205 * NOTE: this should be called manually _iff_ device_add() was
1206 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001208void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001210 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001211 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Alan Sternec0676ee2008-12-05 14:10:31 -05001213 /* Notify clients of device removal. This call must come
1214 * before dpm_sysfs_remove().
1215 */
1216 if (dev->bus)
1217 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1218 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001219 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001221 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001222 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001223 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001224 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001225 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001226 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001227 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001228 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001229
Kay Sieversca22e562011-12-14 14:29:38 -08001230 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001231 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001232 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001233 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001234 if (class_intf->remove_dev)
1235 class_intf->remove_dev(dev, class_intf);
1236 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001237 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001238 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001239 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001240 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001241 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001242 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001243 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001244 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246 /* Notify the platform of the removal, in case they
1247 * need to do anything...
1248 */
1249 if (platform_notify_remove)
1250 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001251 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001252 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001254 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255}
1256
1257/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001258 * device_unregister - unregister device from system.
1259 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001261 * We do this in two parts, like we do device_register(). First,
1262 * we remove it from all the subsystems with device_del(), then
1263 * we decrement the reference count via put_device(). If that
1264 * is the final reference count, the device will be cleaned up
1265 * via device_release() above. Otherwise, the structure will
1266 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001268void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001270 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 device_del(dev);
1272 put_device(dev);
1273}
1274
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001275static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001276{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001277 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001278 struct device *dev = NULL;
1279 struct device_private *p;
1280
1281 if (n) {
1282 p = to_device_private_parent(n);
1283 dev = p->device;
1284 }
1285 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001286}
1287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001289 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001290 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001291 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001292 * @uid: returned file owner
1293 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001294 * @tmp: possibly allocated string
1295 *
1296 * Return the relative path of a possible device node.
1297 * Non-default names may need to allocate a memory to compose
1298 * a name. This memory is returned in tmp and needs to be
1299 * freed by the caller.
1300 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001301const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001302 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001303 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001304{
1305 char *s;
1306
1307 *tmp = NULL;
1308
1309 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001310 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001311 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001312 if (*tmp)
1313 return *tmp;
1314
1315 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001316 if (dev->class && dev->class->devnode)
1317 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001318 if (*tmp)
1319 return *tmp;
1320
1321 /* return name without allocation, tmp == NULL */
1322 if (strchr(dev_name(dev), '!') == NULL)
1323 return dev_name(dev);
1324
1325 /* replace '!' in the name with '/' */
1326 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1327 if (!*tmp)
1328 return NULL;
1329 while ((s = strchr(*tmp, '!')))
1330 s[0] = '/';
1331 return *tmp;
1332}
1333
1334/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001335 * device_for_each_child - device child iterator.
1336 * @parent: parent struct device.
1337 * @data: data for the callback.
1338 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001340 * Iterate over @parent's child devices, and call @fn for each,
1341 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001343 * We check the return of @fn each time. If it returns anything
1344 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001346int device_for_each_child(struct device *parent, void *data,
1347 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001349 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001350 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 int error = 0;
1352
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001353 if (!parent->p)
1354 return 0;
1355
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001356 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001357 while ((child = next_device(&i)) && !error)
1358 error = fn(child, data);
1359 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 return error;
1361}
1362
Cornelia Huck5ab69982006-11-16 15:42:07 +01001363/**
1364 * device_find_child - device iterator for locating a particular device.
1365 * @parent: parent struct device
1366 * @data: Data to pass to match function
1367 * @match: Callback function to check device
1368 *
1369 * This is similar to the device_for_each_child() function above, but it
1370 * returns a reference to a device that is 'found' for later use, as
1371 * determined by the @match callback.
1372 *
1373 * The callback should return 0 if the device doesn't match and non-zero
1374 * if it does. If the callback returns non-zero and a reference to the
1375 * current device can be obtained, this function will return to the caller
1376 * and not iterate over any more devices.
1377 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001378struct device *device_find_child(struct device *parent, void *data,
1379 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001380{
1381 struct klist_iter i;
1382 struct device *child;
1383
1384 if (!parent)
1385 return NULL;
1386
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001387 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001388 while ((child = next_device(&i)))
1389 if (match(child, data) && get_device(child))
1390 break;
1391 klist_iter_exit(&i);
1392 return child;
1393}
1394
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395int __init devices_init(void)
1396{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001397 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1398 if (!devices_kset)
1399 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001400 dev_kobj = kobject_create_and_add("dev", NULL);
1401 if (!dev_kobj)
1402 goto dev_kobj_err;
1403 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1404 if (!sysfs_dev_block_kobj)
1405 goto block_kobj_err;
1406 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1407 if (!sysfs_dev_char_kobj)
1408 goto char_kobj_err;
1409
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001410 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001411
1412 char_kobj_err:
1413 kobject_put(sysfs_dev_block_kobj);
1414 block_kobj_err:
1415 kobject_put(dev_kobj);
1416 dev_kobj_err:
1417 kset_unregister(devices_kset);
1418 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419}
1420
1421EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001422EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
1424EXPORT_SYMBOL_GPL(device_initialize);
1425EXPORT_SYMBOL_GPL(device_add);
1426EXPORT_SYMBOL_GPL(device_register);
1427
1428EXPORT_SYMBOL_GPL(device_del);
1429EXPORT_SYMBOL_GPL(device_unregister);
1430EXPORT_SYMBOL_GPL(get_device);
1431EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433EXPORT_SYMBOL_GPL(device_create_file);
1434EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001435
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001436struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001437 struct device dev;
1438 struct module *owner;
1439};
1440
Josh Triplett93058422012-11-18 21:27:55 -08001441static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001442{
1443 return container_of(d, struct root_device, dev);
1444}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001445
1446static void root_device_release(struct device *dev)
1447{
1448 kfree(to_root_device(dev));
1449}
1450
1451/**
1452 * __root_device_register - allocate and register a root device
1453 * @name: root device name
1454 * @owner: owner module of the root device, usually THIS_MODULE
1455 *
1456 * This function allocates a root device and registers it
1457 * using device_register(). In order to free the returned
1458 * device, use root_device_unregister().
1459 *
1460 * Root devices are dummy devices which allow other devices
1461 * to be grouped under /sys/devices. Use this function to
1462 * allocate a root device and then use it as the parent of
1463 * any device which should appear under /sys/devices/{name}
1464 *
1465 * The /sys/devices/{name} directory will also contain a
1466 * 'module' symlink which points to the @owner directory
1467 * in sysfs.
1468 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001469 * Returns &struct device pointer on success, or ERR_PTR() on error.
1470 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001471 * Note: You probably want to use root_device_register().
1472 */
1473struct device *__root_device_register(const char *name, struct module *owner)
1474{
1475 struct root_device *root;
1476 int err = -ENOMEM;
1477
1478 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1479 if (!root)
1480 return ERR_PTR(err);
1481
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001482 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001483 if (err) {
1484 kfree(root);
1485 return ERR_PTR(err);
1486 }
1487
1488 root->dev.release = root_device_release;
1489
1490 err = device_register(&root->dev);
1491 if (err) {
1492 put_device(&root->dev);
1493 return ERR_PTR(err);
1494 }
1495
Christoph Egger1d9e8822010-05-17 16:57:58 +02001496#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001497 if (owner) {
1498 struct module_kobject *mk = &owner->mkobj;
1499
1500 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1501 if (err) {
1502 device_unregister(&root->dev);
1503 return ERR_PTR(err);
1504 }
1505 root->owner = owner;
1506 }
1507#endif
1508
1509 return &root->dev;
1510}
1511EXPORT_SYMBOL_GPL(__root_device_register);
1512
1513/**
1514 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001515 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001516 *
1517 * This function unregisters and cleans up a device that was created by
1518 * root_device_register().
1519 */
1520void root_device_unregister(struct device *dev)
1521{
1522 struct root_device *root = to_root_device(dev);
1523
1524 if (root->owner)
1525 sysfs_remove_link(&root->dev.kobj, "module");
1526
1527 device_unregister(dev);
1528}
1529EXPORT_SYMBOL_GPL(root_device_unregister);
1530
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001531
1532static void device_create_release(struct device *dev)
1533{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001534 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001535 kfree(dev);
1536}
1537
1538/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001539 * device_create_vargs - creates a device and registers it with sysfs
1540 * @class: pointer to the struct class that this device should be registered to
1541 * @parent: pointer to the parent struct device of this new device, if any
1542 * @devt: the dev_t for the char device to be added
1543 * @drvdata: the data to be added to the device for callbacks
1544 * @fmt: string for the device's name
1545 * @args: va_list for the device's name
1546 *
1547 * This function can be used by char device classes. A struct device
1548 * will be created in sysfs, registered to the specified class.
1549 *
1550 * A "dev" file will be created, showing the dev_t for the device, if
1551 * the dev_t is not 0,0.
1552 * If a pointer to a parent struct device is passed in, the newly created
1553 * struct device will be a child of that device in sysfs.
1554 * The pointer to the struct device will be returned from the call.
1555 * Any further sysfs files that might be required can be created using this
1556 * pointer.
1557 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001558 * Returns &struct device pointer on success, or ERR_PTR() on error.
1559 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001560 * Note: the struct class passed to this function must have previously
1561 * been created with a call to class_create().
1562 */
1563struct device *device_create_vargs(struct class *class, struct device *parent,
1564 dev_t devt, void *drvdata, const char *fmt,
1565 va_list args)
1566{
1567 struct device *dev = NULL;
1568 int retval = -ENODEV;
1569
1570 if (class == NULL || IS_ERR(class))
1571 goto error;
1572
1573 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1574 if (!dev) {
1575 retval = -ENOMEM;
1576 goto error;
1577 }
1578
1579 dev->devt = devt;
1580 dev->class = class;
1581 dev->parent = parent;
1582 dev->release = device_create_release;
1583 dev_set_drvdata(dev, drvdata);
1584
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001585 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1586 if (retval)
1587 goto error;
1588
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001589 retval = device_register(dev);
1590 if (retval)
1591 goto error;
1592
1593 return dev;
1594
1595error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001596 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001597 return ERR_PTR(retval);
1598}
1599EXPORT_SYMBOL_GPL(device_create_vargs);
1600
1601/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001602 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001603 * @class: pointer to the struct class that this device should be registered to
1604 * @parent: pointer to the parent struct device of this new device, if any
1605 * @devt: the dev_t for the char device to be added
1606 * @drvdata: the data to be added to the device for callbacks
1607 * @fmt: string for the device's name
1608 *
1609 * This function can be used by char device classes. A struct device
1610 * will be created in sysfs, registered to the specified class.
1611 *
1612 * A "dev" file will be created, showing the dev_t for the device, if
1613 * the dev_t is not 0,0.
1614 * If a pointer to a parent struct device is passed in, the newly created
1615 * struct device will be a child of that device in sysfs.
1616 * The pointer to the struct device will be returned from the call.
1617 * Any further sysfs files that might be required can be created using this
1618 * pointer.
1619 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001620 * Returns &struct device pointer on success, or ERR_PTR() on error.
1621 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001622 * Note: the struct class passed to this function must have previously
1623 * been created with a call to class_create().
1624 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001625struct device *device_create(struct class *class, struct device *parent,
1626 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001627{
1628 va_list vargs;
1629 struct device *dev;
1630
1631 va_start(vargs, fmt);
1632 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1633 va_end(vargs);
1634 return dev;
1635}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001636EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001637
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001638static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001639{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001640 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001641
Dave Youngcd354492008-01-28 16:56:11 +08001642 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001643}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001644
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001645/**
1646 * device_destroy - removes a device that was created with device_create()
1647 * @class: pointer to the struct class that this device was registered with
1648 * @devt: the dev_t of the device that was previously registered
1649 *
1650 * This call unregisters and cleans up a device that was created with a
1651 * call to device_create().
1652 */
1653void device_destroy(struct class *class, dev_t devt)
1654{
1655 struct device *dev;
1656
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001657 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001658 if (dev) {
1659 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001660 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001661 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001662}
1663EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001664
1665/**
1666 * device_rename - renames a device
1667 * @dev: the pointer to the struct device to be renamed
1668 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001669 *
1670 * It is the responsibility of the caller to provide mutual
1671 * exclusion between two different calls of device_rename
1672 * on the same device to ensure that new_name is valid and
1673 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001674 *
Timur Tabia5462512010-12-13 14:08:52 -06001675 * Note: Don't call this function. Currently, the networking layer calls this
1676 * function, but that will change. The following text from Kay Sievers offers
1677 * some insight:
1678 *
1679 * Renaming devices is racy at many levels, symlinks and other stuff are not
1680 * replaced atomically, and you get a "move" uevent, but it's not easy to
1681 * connect the event to the old and new device. Device nodes are not renamed at
1682 * all, there isn't even support for that in the kernel now.
1683 *
1684 * In the meantime, during renaming, your target name might be taken by another
1685 * driver, creating conflicts. Or the old name is taken directly after you
1686 * renamed it -- then you get events for the same DEVPATH, before you even see
1687 * the "move" event. It's just a mess, and nothing new should ever rely on
1688 * kernel device renaming. Besides that, it's not even implemented now for
1689 * other things than (driver-core wise very simple) network devices.
1690 *
1691 * We are currently about to change network renaming in udev to completely
1692 * disallow renaming of devices in the same namespace as the kernel uses,
1693 * because we can't solve the problems properly, that arise with swapping names
1694 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1695 * be allowed to some other name than eth[0-9]*, for the aforementioned
1696 * reasons.
1697 *
1698 * Make up a "real" name in the driver before you register anything, or add
1699 * some other attributes for userspace to find the device, or use udev to add
1700 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1701 * don't even want to get into that and try to implement the missing pieces in
1702 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001703 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001704int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001705{
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001706 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001707 int error;
1708
1709 dev = get_device(dev);
1710 if (!dev)
1711 return -EINVAL;
1712
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001713 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001714 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001715
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001716 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001717 if (!old_device_name) {
1718 error = -ENOMEM;
1719 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001720 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001721
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001722 if (dev->class) {
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001723 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001724 &dev->kobj, old_device_name, new_name);
1725 if (error)
1726 goto out;
1727 }
Kay Sievers39aba962010-09-04 22:33:14 -07001728
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001729 error = kobject_rename(&dev->kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001730 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001731 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001732
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001733out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001734 put_device(dev);
1735
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001736 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001737
1738 return error;
1739}
Johannes Berga2807db2007-02-28 12:38:31 +01001740EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001741
1742static int device_move_class_links(struct device *dev,
1743 struct device *old_parent,
1744 struct device *new_parent)
1745{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001746 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001747
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001748 if (old_parent)
1749 sysfs_remove_link(&dev->kobj, "device");
1750 if (new_parent)
1751 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1752 "device");
1753 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001754}
1755
1756/**
1757 * device_move - moves a device to a new parent
1758 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001759 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001760 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001761 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001762int device_move(struct device *dev, struct device *new_parent,
1763 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001764{
1765 int error;
1766 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001767 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001768
1769 dev = get_device(dev);
1770 if (!dev)
1771 return -EINVAL;
1772
Cornelia Huckffa6a702009-03-04 12:44:00 +01001773 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001774 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001775 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001776
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001777 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1778 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001779 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001780 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001781 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001782 put_device(new_parent);
1783 goto out;
1784 }
1785 old_parent = dev->parent;
1786 dev->parent = new_parent;
1787 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001788 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001789 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001790 klist_add_tail(&dev->p->knode_parent,
1791 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001792 set_dev_node(dev, dev_to_node(new_parent));
1793 }
1794
Rabin Vincentbdd40342012-04-23 09:16:36 +02001795 if (dev->class) {
1796 error = device_move_class_links(dev, old_parent, new_parent);
1797 if (error) {
1798 /* We ignore errors on cleanup since we're hosed anyway... */
1799 device_move_class_links(dev, new_parent, old_parent);
1800 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1801 if (new_parent)
1802 klist_remove(&dev->p->knode_parent);
1803 dev->parent = old_parent;
1804 if (old_parent) {
1805 klist_add_tail(&dev->p->knode_parent,
1806 &old_parent->p->klist_children);
1807 set_dev_node(dev, dev_to_node(old_parent));
1808 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001809 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001810 cleanup_glue_dir(dev, new_parent_kobj);
1811 put_device(new_parent);
1812 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001813 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001814 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001815 switch (dpm_order) {
1816 case DPM_ORDER_NONE:
1817 break;
1818 case DPM_ORDER_DEV_AFTER_PARENT:
1819 device_pm_move_after(dev, new_parent);
1820 break;
1821 case DPM_ORDER_PARENT_BEFORE_DEV:
1822 device_pm_move_before(new_parent, dev);
1823 break;
1824 case DPM_ORDER_DEV_LAST:
1825 device_pm_move_last(dev);
1826 break;
1827 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001828
Cornelia Huck8a824722006-11-20 17:07:51 +01001829 put_device(old_parent);
1830out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001831 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001832 put_device(dev);
1833 return error;
1834}
Cornelia Huck8a824722006-11-20 17:07:51 +01001835EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001836
1837/**
1838 * device_shutdown - call ->shutdown() on each device to shutdown.
1839 */
1840void device_shutdown(void)
1841{
Hugh Daschbach62458382010-03-22 10:36:37 -07001842 struct device *dev;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001843
Hugh Daschbach62458382010-03-22 10:36:37 -07001844 spin_lock(&devices_kset->list_lock);
1845 /*
1846 * Walk the devices list backward, shutting down each in turn.
1847 * Beware that device unplug events may also start pulling
1848 * devices offline, even as the system is shutting down.
1849 */
1850 while (!list_empty(&devices_kset->list)) {
1851 dev = list_entry(devices_kset->list.prev, struct device,
1852 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08001853
1854 /*
1855 * hold reference count of device's parent to
1856 * prevent it from being freed because parent's
1857 * lock is to be held
1858 */
1859 get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001860 get_device(dev);
1861 /*
1862 * Make sure the device is off the kset list, in the
1863 * event that dev->*->shutdown() doesn't remove it.
1864 */
1865 list_del_init(&dev->kobj.entry);
1866 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001867
Ming Leid1c6c032012-06-22 18:01:40 +08001868 /* hold lock to avoid race with probe/release */
1869 if (dev->parent)
1870 device_lock(dev->parent);
1871 device_lock(dev);
1872
Alan Sternfe6b91f2011-12-06 23:24:52 +01001873 /* Don't allow any more runtime suspends */
1874 pm_runtime_get_noresume(dev);
1875 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001876
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001877 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001878 if (initcall_debug)
1879 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001880 dev->bus->shutdown(dev);
1881 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001882 if (initcall_debug)
1883 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001884 dev->driver->shutdown(dev);
1885 }
Ming Leid1c6c032012-06-22 18:01:40 +08001886
1887 device_unlock(dev);
1888 if (dev->parent)
1889 device_unlock(dev->parent);
1890
Hugh Daschbach62458382010-03-22 10:36:37 -07001891 put_device(dev);
Ming Leid1c6c032012-06-22 18:01:40 +08001892 put_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001893
1894 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001895 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001896 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07001897 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001898}
Joe Perches99bcf212010-06-27 01:02:34 +00001899
1900/*
1901 * Device logging functions
1902 */
1903
1904#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07001905static int
1906create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00001907{
Kay Sieversc4e00da2012-05-03 02:29:59 +02001908 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07001909 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00001910
Kay Sieversc4e00da2012-05-03 02:29:59 +02001911 if (dev->class)
1912 subsys = dev->class->name;
1913 else if (dev->bus)
1914 subsys = dev->bus->name;
1915 else
Joe Perches798efc62012-09-12 20:11:29 -07001916 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02001917
Joe Perches798efc62012-09-12 20:11:29 -07001918 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Kay Sieversc4e00da2012-05-03 02:29:59 +02001919
1920 /*
1921 * Add device identifier DEVICE=:
1922 * b12:8 block dev_t
1923 * c127:3 char dev_t
1924 * n8 netdev ifindex
1925 * +sound:card0 subsystem:devname
1926 */
1927 if (MAJOR(dev->devt)) {
1928 char c;
1929
1930 if (strcmp(subsys, "block") == 0)
1931 c = 'b';
1932 else
1933 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07001934 pos++;
1935 pos += snprintf(hdr + pos, hdrlen - pos,
1936 "DEVICE=%c%u:%u",
1937 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02001938 } else if (strcmp(subsys, "net") == 0) {
1939 struct net_device *net = to_net_dev(dev);
1940
Joe Perches798efc62012-09-12 20:11:29 -07001941 pos++;
1942 pos += snprintf(hdr + pos, hdrlen - pos,
1943 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02001944 } else {
Joe Perches798efc62012-09-12 20:11:29 -07001945 pos++;
1946 pos += snprintf(hdr + pos, hdrlen - pos,
1947 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02001948 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06001949
Joe Perches798efc62012-09-12 20:11:29 -07001950 return pos;
Joe Perches99bcf212010-06-27 01:02:34 +00001951}
Joe Perches798efc62012-09-12 20:11:29 -07001952EXPORT_SYMBOL(create_syslog_header);
1953
Joe Perches05e4e5b2012-09-12 20:13:37 -07001954int dev_vprintk_emit(int level, const struct device *dev,
1955 const char *fmt, va_list args)
1956{
1957 char hdr[128];
1958 size_t hdrlen;
1959
1960 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
1961
1962 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
1963}
1964EXPORT_SYMBOL(dev_vprintk_emit);
1965
1966int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1967{
1968 va_list args;
1969 int r;
1970
1971 va_start(args, fmt);
1972
1973 r = dev_vprintk_emit(level, dev, fmt, args);
1974
1975 va_end(args);
1976
1977 return r;
1978}
1979EXPORT_SYMBOL(dev_printk_emit);
1980
Joe Perches798efc62012-09-12 20:11:29 -07001981static int __dev_printk(const char *level, const struct device *dev,
1982 struct va_format *vaf)
1983{
Joe Perches798efc62012-09-12 20:11:29 -07001984 if (!dev)
1985 return printk("%s(NULL device *): %pV", level, vaf);
1986
Joe Perches666f3552012-09-12 20:14:11 -07001987 return dev_printk_emit(level[1] - '0', dev,
1988 "%s %s: %pV",
1989 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches798efc62012-09-12 20:11:29 -07001990}
Joe Perches99bcf212010-06-27 01:02:34 +00001991
1992int dev_printk(const char *level, const struct device *dev,
1993 const char *fmt, ...)
1994{
1995 struct va_format vaf;
1996 va_list args;
1997 int r;
1998
1999 va_start(args, fmt);
2000
2001 vaf.fmt = fmt;
2002 vaf.va = &args;
2003
2004 r = __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002005
Joe Perches99bcf212010-06-27 01:02:34 +00002006 va_end(args);
2007
2008 return r;
2009}
2010EXPORT_SYMBOL(dev_printk);
2011
2012#define define_dev_printk_level(func, kern_level) \
2013int func(const struct device *dev, const char *fmt, ...) \
2014{ \
2015 struct va_format vaf; \
2016 va_list args; \
2017 int r; \
2018 \
2019 va_start(args, fmt); \
2020 \
2021 vaf.fmt = fmt; \
2022 vaf.va = &args; \
2023 \
2024 r = __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002025 \
Joe Perches99bcf212010-06-27 01:02:34 +00002026 va_end(args); \
2027 \
2028 return r; \
2029} \
2030EXPORT_SYMBOL(func);
2031
2032define_dev_printk_level(dev_emerg, KERN_EMERG);
2033define_dev_printk_level(dev_alert, KERN_ALERT);
2034define_dev_printk_level(dev_crit, KERN_CRIT);
2035define_dev_printk_level(dev_err, KERN_ERR);
2036define_dev_printk_level(dev_warn, KERN_WARNING);
2037define_dev_printk_level(dev_notice, KERN_NOTICE);
2038define_dev_printk_level(_dev_info, KERN_INFO);
2039
2040#endif