blob: b7d56c5ea3c688fe03c7b5edda4f62c0906a9fc7 [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>
Rafael J. Wysocki97badf82015-04-03 23:23:37 +020015#include <linux/fwnode.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/slab.h>
19#include <linux/string.h>
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -070020#include <linux/kdev_t.h>
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100021#include <linux/notifier.h>
Grant Likely07d57a32012-02-01 11:22:22 -070022#include <linux/of.h>
23#include <linux/of_device.h>
Kay Sieversda231fd2007-11-21 17:29:15 +010024#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080025#include <linux/kallsyms.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070026#include <linux/mutex.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>
Greg Kroah-Hartman63967682013-08-27 10:24:15 -070029#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#include "base.h"
32#include "power/power.h"
33
Andi Kleene52eec12010-09-08 16:54:17 +020034#ifdef CONFIG_SYSFS_DEPRECATED
35#ifdef CONFIG_SYSFS_DEPRECATED_V2
36long sysfs_deprecated = 1;
37#else
38long sysfs_deprecated = 0;
39#endif
Hanjun Guo3454bf92013-08-17 20:42:24 +080040static int __init sysfs_deprecated_setup(char *arg)
Andi Kleene52eec12010-09-08 16:54:17 +020041{
Jingoo Han34da5e62013-07-26 13:10:22 +090042 return kstrtol(arg, 10, &sysfs_deprecated);
Andi Kleene52eec12010-09-08 16:54:17 +020043}
44early_param("sysfs.deprecated", sysfs_deprecated_setup);
45#endif
46
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080047int (*platform_notify)(struct device *dev) = NULL;
48int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070049static struct kobject *dev_kobj;
50struct kobject *sysfs_dev_char_kobj;
51struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +020053static DEFINE_MUTEX(device_hotplug_lock);
54
55void lock_device_hotplug(void)
56{
57 mutex_lock(&device_hotplug_lock);
58}
59
60void unlock_device_hotplug(void)
61{
62 mutex_unlock(&device_hotplug_lock);
63}
64
65int lock_device_hotplug_sysfs(void)
66{
67 if (mutex_trylock(&device_hotplug_lock))
68 return 0;
69
70 /* Avoid busy looping (5 ms of sleep should do). */
71 msleep(5);
72 return restart_syscall();
73}
74
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080075#ifdef CONFIG_BLOCK
76static inline int device_is_not_partition(struct device *dev)
77{
78 return !(dev->type == &part_type);
79}
80#else
81static inline int device_is_not_partition(struct device *dev)
82{
83 return 1;
84}
85#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Alan Stern3e956372006-06-16 17:10:48 -040087/**
88 * dev_driver_string - Return a device's driver name, if at all possible
89 * @dev: struct device to get the name of
90 *
91 * Will return the device's driver's name if it is bound to a device. If
yan9169c012012-04-20 21:08:45 +080092 * the device is not bound to a driver, it will return the name of the bus
Alan Stern3e956372006-06-16 17:10:48 -040093 * it is attached to. If it is not attached to a bus either, an empty
94 * string will be returned.
95 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070096const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040097{
Alan Stern35899722009-12-04 11:06:57 -050098 struct device_driver *drv;
99
100 /* dev->driver can change to NULL underneath us because of unbinding,
101 * so be careful about accessing it. dev->bus and dev->class should
102 * never change once they are set, so they don't need special care.
103 */
104 drv = ACCESS_ONCE(dev->driver);
105 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +0100106 (dev->bus ? dev->bus->name :
107 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -0400108}
Matthew Wilcox310a9222006-09-23 23:35:04 -0600109EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -0400110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
112
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800113static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
114 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800116 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200117 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500118 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400121 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -0800122 if (ret >= (ssize_t)PAGE_SIZE) {
Greg Kroah-Hartman53a9c872013-01-17 13:10:23 -0800123 print_symbol("dev_attr_show: %s returned bad count\n",
124 (unsigned long)dev_attr->show);
Andrew Morton815d2d52008-03-04 15:09:07 -0800125 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 return ret;
127}
128
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800129static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
130 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800132 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200133 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500134 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400137 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 return ret;
139}
140
Emese Revfy52cf25d2010-01-19 02:58:23 +0100141static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 .show = dev_attr_show,
143 .store = dev_attr_store,
144};
145
Kay Sieversca22e562011-12-14 14:29:38 -0800146#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
147
148ssize_t device_store_ulong(struct device *dev,
149 struct device_attribute *attr,
150 const char *buf, size_t size)
151{
152 struct dev_ext_attribute *ea = to_ext_attr(attr);
153 char *end;
154 unsigned long new = simple_strtoul(buf, &end, 0);
155 if (end == buf)
156 return -EINVAL;
157 *(unsigned long *)(ea->var) = new;
158 /* Always return full write size even if we didn't consume all */
159 return size;
160}
161EXPORT_SYMBOL_GPL(device_store_ulong);
162
163ssize_t device_show_ulong(struct device *dev,
164 struct device_attribute *attr,
165 char *buf)
166{
167 struct dev_ext_attribute *ea = to_ext_attr(attr);
168 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
169}
170EXPORT_SYMBOL_GPL(device_show_ulong);
171
172ssize_t device_store_int(struct device *dev,
173 struct device_attribute *attr,
174 const char *buf, size_t size)
175{
176 struct dev_ext_attribute *ea = to_ext_attr(attr);
177 char *end;
178 long new = simple_strtol(buf, &end, 0);
179 if (end == buf || new > INT_MAX || new < INT_MIN)
180 return -EINVAL;
181 *(int *)(ea->var) = new;
182 /* Always return full write size even if we didn't consume all */
183 return size;
184}
185EXPORT_SYMBOL_GPL(device_store_int);
186
187ssize_t device_show_int(struct device *dev,
188 struct device_attribute *attr,
189 char *buf)
190{
191 struct dev_ext_attribute *ea = to_ext_attr(attr);
192
193 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
194}
195EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Borislav Petkov91872392012-10-09 19:52:05 +0200197ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t size)
199{
200 struct dev_ext_attribute *ea = to_ext_attr(attr);
201
202 if (strtobool(buf, ea->var) < 0)
203 return -EINVAL;
204
205 return size;
206}
207EXPORT_SYMBOL_GPL(device_store_bool);
208
209ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
210 char *buf)
211{
212 struct dev_ext_attribute *ea = to_ext_attr(attr);
213
214 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
215}
216EXPORT_SYMBOL_GPL(device_show_bool);
217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218/**
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400219 * device_release - free device structure.
220 * @kobj: device's kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 *
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400222 * This is called once the reference count for the object
223 * reaches 0. We forward the call to the device's release
224 * method, which should handle actually freeing the structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800226static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200228 struct device *dev = kobj_to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800229 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Ming Leia525a3d2012-07-25 01:42:29 +0800231 /*
232 * Some platform devices are driven without driver attached
233 * and managed resources may have been acquired. Make sure
234 * all resources are released.
235 *
236 * Drivers still can add resources into device after device
237 * is deleted but alive, so release devres here to avoid
238 * possible memory leak.
239 */
240 devres_release_all(dev);
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 if (dev->release)
243 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200244 else if (dev->type && dev->type->release)
245 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700246 else if (dev->class && dev->class->dev_release)
247 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700248 else
249 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800250 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100251 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800252 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700255static const void *device_namespace(struct kobject *kobj)
256{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200257 struct device *dev = kobj_to_dev(kobj);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700258 const void *ns = NULL;
259
260 if (dev->class && dev->class->ns_type)
261 ns = dev->class->namespace(dev);
262
263 return ns;
264}
265
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600266static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 .release = device_release,
268 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700269 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270};
271
272
Kay Sievers312c0042005-11-16 09:00:00 +0100273static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
275 struct kobj_type *ktype = get_ktype(kobj);
276
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600277 if (ktype == &device_ktype) {
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200278 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (dev->bus)
280 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700281 if (dev->class)
282 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 }
284 return 0;
285}
286
Kay Sievers312c0042005-11-16 09:00:00 +0100287static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200289 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700291 if (dev->bus)
292 return dev->bus->name;
293 if (dev->class)
294 return dev->class->name;
295 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Kay Sievers7eff2e72007-08-14 15:15:12 +0200298static int dev_uevent(struct kset *kset, struct kobject *kobj,
299 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200301 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 int retval = 0;
303
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200304 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700305 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200306 const char *tmp;
307 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400308 umode_t mode = 0;
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700309 kuid_t uid = GLOBAL_ROOT_UID;
310 kgid_t gid = GLOBAL_ROOT_GID;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200311
Kay Sievers7eff2e72007-08-14 15:15:12 +0200312 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
313 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700314 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200315 if (name) {
316 add_uevent_var(env, "DEVNAME=%s", name);
Kay Sieverse454cea2009-09-18 23:01:12 +0200317 if (mode)
318 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700319 if (!uid_eq(uid, GLOBAL_ROOT_UID))
320 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
321 if (!gid_eq(gid, GLOBAL_ROOT_GID))
322 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700323 kfree(tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200324 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700325 }
326
Kay Sievers414264f2007-03-12 21:08:57 +0100327 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200328 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100329
Kay Sievers239378f2006-10-07 21:54:55 +0200330 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200331 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200332
Grant Likely07d57a32012-02-01 11:22:22 -0700333 /* Add common DT information about the device */
334 of_device_uevent(dev, env);
335
Kay Sievers7eff2e72007-08-14 15:15:12 +0200336 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100337 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200338 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200339 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800340 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100341 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 }
343
Kay Sievers7eff2e72007-08-14 15:15:12 +0200344 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700345 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200346 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200347 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800348 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100349 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800350 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200351 }
352
Stefan Weileef35c22010-08-06 21:11:15 +0200353 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200354 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200355 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200356 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800357 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100358 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800359 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700360 }
361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 return retval;
363}
364
Emese Revfy9cd43612009-12-31 14:52:51 +0100365static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100366 .filter = dev_uevent_filter,
367 .name = dev_uevent_name,
368 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369};
370
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700371static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
Kay Sievers16574dc2007-04-06 01:40:38 +0200372 char *buf)
373{
374 struct kobject *top_kobj;
375 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200376 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200377 int i;
378 size_t count = 0;
379 int retval;
380
381 /* search the kset, the device belongs to */
382 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200383 while (!top_kobj->kset && top_kobj->parent)
384 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200385 if (!top_kobj->kset)
386 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200387
Kay Sievers16574dc2007-04-06 01:40:38 +0200388 kset = top_kobj->kset;
389 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
390 goto out;
391
392 /* respect filter */
393 if (kset->uevent_ops && kset->uevent_ops->filter)
394 if (!kset->uevent_ops->filter(kset, &dev->kobj))
395 goto out;
396
Kay Sievers7eff2e72007-08-14 15:15:12 +0200397 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
398 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200399 return -ENOMEM;
400
Kay Sievers16574dc2007-04-06 01:40:38 +0200401 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200402 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200403 if (retval)
404 goto out;
405
406 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200407 for (i = 0; i < env->envp_idx; i++)
408 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200409out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200410 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200411 return count;
412}
413
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700414static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
Kay Sieversa7fd6702005-10-01 14:49:43 +0200415 const char *buf, size_t count)
416{
Kay Sievers60a96a52007-07-08 22:29:26 +0200417 enum kobject_action action;
418
Kay Sievers3f5468c2010-01-14 22:54:37 +0100419 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200420 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100421 else
422 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200423 return count;
424}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700425static DEVICE_ATTR_RW(uevent);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200426
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700427static ssize_t online_show(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200428 char *buf)
429{
430 bool val;
431
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200432 device_lock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200433 val = !dev->offline;
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200434 device_unlock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200435 return sprintf(buf, "%u\n", val);
436}
437
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700438static ssize_t online_store(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200439 const char *buf, size_t count)
440{
441 bool val;
442 int ret;
443
444 ret = strtobool(buf, &val);
445 if (ret < 0)
446 return ret;
447
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200448 ret = lock_device_hotplug_sysfs();
449 if (ret)
450 return ret;
451
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200452 ret = val ? device_online(dev) : device_offline(dev);
453 unlock_device_hotplug();
454 return ret < 0 ? ret : count;
455}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700456static DEVICE_ATTR_RW(online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200457
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700458int device_add_groups(struct device *dev, const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500459{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -0700460 return sysfs_create_groups(&dev->kobj, groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500461}
462
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700463void device_remove_groups(struct device *dev,
464 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500465{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -0700466 sysfs_remove_groups(&dev->kobj, groups);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700467}
468
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700469static int device_add_attrs(struct device *dev)
470{
471 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700472 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500473 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700474
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500475 if (class) {
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700476 error = device_add_groups(dev, class->dev_groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200477 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500478 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700479 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200480
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500481 if (type) {
482 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200483 if (error)
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700484 goto err_remove_class_groups;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200485 }
486
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500487 error = device_add_groups(dev, dev->groups);
488 if (error)
489 goto err_remove_type_groups;
490
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200491 if (device_supports_offline(dev) && !dev->offline_disabled) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700492 error = device_create_file(dev, &dev_attr_online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200493 if (error)
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100494 goto err_remove_dev_groups;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200495 }
496
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500497 return 0;
498
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100499 err_remove_dev_groups:
500 device_remove_groups(dev, dev->groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500501 err_remove_type_groups:
502 if (type)
503 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700504 err_remove_class_groups:
505 if (class)
506 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500507
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700508 return error;
509}
510
511static void device_remove_attrs(struct device *dev)
512{
513 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700514 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700515
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700516 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500517 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200518
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500519 if (type)
520 device_remove_groups(dev, type->groups);
521
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700522 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700523 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700524}
525
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700526static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700527 char *buf)
528{
529 return print_dev_t(buf, dev->devt);
530}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700531static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900532
Kay Sieversca22e562011-12-14 14:29:38 -0800533/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600534struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536/**
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +0300537 * devices_kset_move_before - Move device in the devices_kset's list.
538 * @deva: Device to move.
539 * @devb: Device @deva should come before.
540 */
541static void devices_kset_move_before(struct device *deva, struct device *devb)
542{
543 if (!devices_kset)
544 return;
545 pr_debug("devices_kset: Moving %s before %s\n",
546 dev_name(deva), dev_name(devb));
547 spin_lock(&devices_kset->list_lock);
548 list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
549 spin_unlock(&devices_kset->list_lock);
550}
551
552/**
553 * devices_kset_move_after - Move device in the devices_kset's list.
554 * @deva: Device to move
555 * @devb: Device @deva should come after.
556 */
557static void devices_kset_move_after(struct device *deva, struct device *devb)
558{
559 if (!devices_kset)
560 return;
561 pr_debug("devices_kset: Moving %s after %s\n",
562 dev_name(deva), dev_name(devb));
563 spin_lock(&devices_kset->list_lock);
564 list_move(&deva->kobj.entry, &devb->kobj.entry);
565 spin_unlock(&devices_kset->list_lock);
566}
567
568/**
569 * devices_kset_move_last - move the device to the end of devices_kset's list.
570 * @dev: device to move
571 */
572void devices_kset_move_last(struct device *dev)
573{
574 if (!devices_kset)
575 return;
576 pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
577 spin_lock(&devices_kset->list_lock);
578 list_move_tail(&dev->kobj.entry, &devices_kset->list);
579 spin_unlock(&devices_kset->list_lock);
580}
581
582/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800583 * device_create_file - create sysfs attribute file for device.
584 * @dev: device.
585 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200587int device_create_file(struct device *dev,
588 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200591
592 if (dev) {
593 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800594 "Attribute %s: write permission without 'store'\n",
595 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200596 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800597 "Attribute %s: read permission without 'show'\n",
598 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200600 }
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 return error;
603}
David Graham White86df2682013-07-21 20:41:14 -0400604EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
606/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800607 * device_remove_file - remove sysfs attribute file.
608 * @dev: device.
609 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200611void device_remove_file(struct device *dev,
612 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100614 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
David Graham White86df2682013-07-21 20:41:14 -0400617EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700619/**
Tejun Heo6b0afc22014-02-03 14:03:01 -0500620 * device_remove_file_self - remove sysfs attribute file from its own method.
621 * @dev: device.
622 * @attr: device attribute descriptor.
623 *
624 * See kernfs_remove_self() for details.
625 */
626bool device_remove_file_self(struct device *dev,
627 const struct device_attribute *attr)
628{
629 if (dev)
630 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
631 else
632 return false;
633}
634EXPORT_SYMBOL_GPL(device_remove_file_self);
635
636/**
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700637 * device_create_bin_file - create sysfs binary attribute file for device.
638 * @dev: device.
639 * @attr: device binary attribute descriptor.
640 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200641int device_create_bin_file(struct device *dev,
642 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700643{
644 int error = -EINVAL;
645 if (dev)
646 error = sysfs_create_bin_file(&dev->kobj, attr);
647 return error;
648}
649EXPORT_SYMBOL_GPL(device_create_bin_file);
650
651/**
652 * device_remove_bin_file - remove sysfs binary attribute file
653 * @dev: device.
654 * @attr: device binary attribute descriptor.
655 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200656void device_remove_bin_file(struct device *dev,
657 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700658{
659 if (dev)
660 sysfs_remove_bin_file(&dev->kobj, attr);
661}
662EXPORT_SYMBOL_GPL(device_remove_bin_file);
663
James Bottomley34bb61f2005-09-06 16:56:51 -0700664static void klist_children_get(struct klist_node *n)
665{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800666 struct device_private *p = to_device_private_parent(n);
667 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700668
669 get_device(dev);
670}
671
672static void klist_children_put(struct klist_node *n)
673{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800674 struct device_private *p = to_device_private_parent(n);
675 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700676
677 put_device(dev);
678}
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800681 * device_initialize - init device structure.
682 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 *
Cornelia Huck57394112008-09-03 18:26:40 +0200684 * This prepares the device for use by other layers by initializing
685 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800686 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200687 * that function, though it can also be called separately, so one
688 * may use @dev's fields. In particular, get_device()/put_device()
689 * may be used for reference counting of @dev after calling this
690 * function.
691 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500692 * All fields in @dev must be initialized by the caller to 0, except
693 * for those explicitly set to some other value. The simplest
694 * approach is to use kzalloc() to allocate the structure containing
695 * @dev.
696 *
Cornelia Huck57394112008-09-03 18:26:40 +0200697 * NOTE: Use put_device() to give up your reference instead of freeing
698 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700void device_initialize(struct device *dev)
701{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600702 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700703 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000705 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100706 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900707 spin_lock_init(&dev->devres_lock);
708 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400709 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800710 set_dev_node(dev, -1);
Jiang Liu4a7cc832015-07-09 16:00:44 +0800711#ifdef CONFIG_GENERIC_MSI_IRQ
712 INIT_LIST_HEAD(&dev->msi_list);
713#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
David Graham White86df2682013-07-21 20:41:14 -0400715EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Tejun Heod73ce002013-03-12 11:30:05 -0700717struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700718{
Kay Sievers86406242007-03-14 03:25:56 +0100719 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700720
Kay Sievers86406242007-03-14 03:25:56 +0100721 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800722 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600723 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700724
Kay Sievers86406242007-03-14 03:25:56 +0100725 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700726}
727
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700728struct class_dir {
729 struct kobject kobj;
730 struct class *class;
731};
732
733#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
734
735static void class_dir_release(struct kobject *kobj)
736{
737 struct class_dir *dir = to_class_dir(kobj);
738 kfree(dir);
739}
740
741static const
742struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
743{
744 struct class_dir *dir = to_class_dir(kobj);
745 return dir->class->ns_type;
746}
747
748static struct kobj_type class_dir_ktype = {
749 .release = class_dir_release,
750 .sysfs_ops = &kobj_sysfs_ops,
751 .child_ns_type = class_dir_child_ns_type
752};
753
754static struct kobject *
755class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
756{
757 struct class_dir *dir;
758 int retval;
759
760 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
761 if (!dir)
762 return NULL;
763
764 dir->class = class;
765 kobject_init(&dir->kobj, &class_dir_ktype);
766
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100767 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700768
769 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
770 if (retval < 0) {
771 kobject_put(&dir->kobj);
772 return NULL;
773 }
774 return &dir->kobj;
775}
776
Yijing Wange4a60d12014-11-07 12:05:49 +0800777static DEFINE_MUTEX(gdp_mutex);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700778
Kay Sieversda231fd2007-11-21 17:29:15 +0100779static struct kobject *get_device_parent(struct device *dev,
780 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100781{
Kay Sievers86406242007-03-14 03:25:56 +0100782 if (dev->class) {
783 struct kobject *kobj = NULL;
784 struct kobject *parent_kobj;
785 struct kobject *k;
786
Randy Dunlapead454f2010-09-24 14:36:49 -0700787#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700788 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200789 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700790 if (parent && parent->class == &block_class)
791 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100792 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700793 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700794#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200795
Kay Sievers86406242007-03-14 03:25:56 +0100796 /*
797 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100798 * Class-devices with a non class-device as parent, live
799 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100800 */
801 if (parent == NULL)
802 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700803 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100804 return &parent->kobj;
805 else
806 parent_kobj = &parent->kobj;
807
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900808 mutex_lock(&gdp_mutex);
809
Kay Sievers86406242007-03-14 03:25:56 +0100810 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100811 spin_lock(&dev->class->p->glue_dirs.list_lock);
812 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100813 if (k->parent == parent_kobj) {
814 kobj = kobject_get(k);
815 break;
816 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100817 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900818 if (kobj) {
819 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100820 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900821 }
Kay Sievers86406242007-03-14 03:25:56 +0100822
823 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700824 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100825 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900826 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800827 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100828 }
829
Kay Sieversca22e562011-12-14 14:29:38 -0800830 /* subsystems can specify a default root directory for their devices */
831 if (!parent && dev->bus && dev->bus->dev_root)
832 return &dev->bus->dev_root->kobj;
833
Kay Sievers86406242007-03-14 03:25:56 +0100834 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100835 return &parent->kobj;
836 return NULL;
837}
Kay Sieversda231fd2007-11-21 17:29:15 +0100838
Cornelia Huck63b69712008-01-21 16:09:44 +0100839static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100840{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100841 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100842 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100843 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100844 return;
845
Yijing Wange4a60d12014-11-07 12:05:49 +0800846 mutex_lock(&gdp_mutex);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100847 kobject_put(glue_dir);
Yijing Wange4a60d12014-11-07 12:05:49 +0800848 mutex_unlock(&gdp_mutex);
Kay Sieversda231fd2007-11-21 17:29:15 +0100849}
Cornelia Huck63b69712008-01-21 16:09:44 +0100850
851static void cleanup_device_parent(struct device *dev)
852{
853 cleanup_glue_dir(dev, dev->kobj.parent);
854}
Kay Sievers86406242007-03-14 03:25:56 +0100855
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700856static int device_add_class_symlinks(struct device *dev)
857{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100858 struct device_node *of_node = dev_of_node(dev);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700859 int error;
860
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100861 if (of_node) {
862 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
863 if (error)
864 dev_warn(dev, "Error %d creating of_node link\n",error);
865 /* An error here doesn't warrant bringing down the device */
866 }
867
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700868 if (!dev->class)
869 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100870
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700871 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100872 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700873 "subsystem");
874 if (error)
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100875 goto out_devnode;
Kay Sieversda231fd2007-11-21 17:29:15 +0100876
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800877 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700878 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
879 "device");
880 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700881 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700882 }
Kay Sievers39aba962010-09-04 22:33:14 -0700883
Randy Dunlapead454f2010-09-24 14:36:49 -0700884#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700885 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200886 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700887 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700888#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700889
890 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100891 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700892 &dev->kobj, dev_name(dev));
893 if (error)
894 goto out_device;
895
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700896 return 0;
897
Kay Sievers39aba962010-09-04 22:33:14 -0700898out_device:
899 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100900
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700901out_subsys:
902 sysfs_remove_link(&dev->kobj, "subsystem");
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100903out_devnode:
904 sysfs_remove_link(&dev->kobj, "of_node");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700905 return error;
906}
907
908static void device_remove_class_symlinks(struct device *dev)
909{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100910 if (dev_of_node(dev))
911 sysfs_remove_link(&dev->kobj, "of_node");
912
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700913 if (!dev->class)
914 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100915
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800916 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100917 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700918 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700919#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200920 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700921 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700922#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100923 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700924}
925
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000927 * dev_set_name - set a device name
928 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700929 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000930 */
931int dev_set_name(struct device *dev, const char *fmt, ...)
932{
933 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100934 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000935
936 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100937 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000938 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100939 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000940}
941EXPORT_SYMBOL_GPL(dev_set_name);
942
943/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700944 * device_to_dev_kobj - select a /sys/dev/ directory for the device
945 * @dev: device
946 *
947 * By default we select char/ for new entries. Setting class->dev_obj
948 * to NULL prevents an entry from being created. class->dev_kobj must
949 * be set (or cleared) before any devices are registered to the class
950 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200951 * device_remove_sys_dev_entry() will disagree about the presence of
952 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700953 */
954static struct kobject *device_to_dev_kobj(struct device *dev)
955{
956 struct kobject *kobj;
957
958 if (dev->class)
959 kobj = dev->class->dev_kobj;
960 else
961 kobj = sysfs_dev_char_kobj;
962
963 return kobj;
964}
965
966static int device_create_sys_dev_entry(struct device *dev)
967{
968 struct kobject *kobj = device_to_dev_kobj(dev);
969 int error = 0;
970 char devt_str[15];
971
972 if (kobj) {
973 format_dev_t(devt_str, dev->devt);
974 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
975 }
976
977 return error;
978}
979
980static void device_remove_sys_dev_entry(struct device *dev)
981{
982 struct kobject *kobj = device_to_dev_kobj(dev);
983 char devt_str[15];
984
985 if (kobj) {
986 format_dev_t(devt_str, dev->devt);
987 sysfs_remove_link(kobj, devt_str);
988 }
989}
990
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700991int device_private_init(struct device *dev)
992{
993 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
994 if (!dev->p)
995 return -ENOMEM;
996 dev->p->device = dev;
997 klist_init(&dev->p->klist_children, klist_children_get,
998 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800999 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001000 return 0;
1001}
1002
Dan Williamse105b8b2008-04-21 10:51:07 -07001003/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001004 * device_add - add device to device hierarchy.
1005 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001007 * This is part 2 of device_register(), though may be called
1008 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 *
Cornelia Huck57394112008-09-03 18:26:40 +02001010 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001011 * to the global and sibling lists for the device, then
1012 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +02001013 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001014 * Do not call this routine or device_register() more than once for
1015 * any device structure. The driver model core is not designed to work
1016 * with devices that get unregistered and then spring back to life.
1017 * (Among other things, it's very hard to guarantee that all references
1018 * to the previous incarnation of @dev have been dropped.) Allocate
1019 * and register a fresh new struct device instead.
1020 *
Cornelia Huck57394112008-09-03 18:26:40 +02001021 * NOTE: _Never_ directly free @dev after calling this function, even
1022 * if it returned an error! Always use put_device() to give up your
1023 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 */
1025int device_add(struct device *dev)
1026{
1027 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -08001028 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001029 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001030 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001033 if (!dev)
1034 goto done;
1035
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001036 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001037 error = device_private_init(dev);
1038 if (error)
1039 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001040 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001041
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001042 /*
1043 * for statically allocated devices, which should all be converted
1044 * some day, we need to initialize the name. We prevent reading back
1045 * the name, and force the use of dev_name()
1046 */
1047 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001048 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001049 dev->init_name = NULL;
1050 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001051
Kay Sieversca22e562011-12-14 14:29:38 -08001052 /* subsystems can specify simple device enumeration */
1053 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1054 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1055
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001056 if (!dev_name(dev)) {
1057 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001058 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001059 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001061 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001064 kobj = get_device_parent(dev, parent);
1065 if (kobj)
1066 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Yinghai Lu0d358f22008-02-19 03:20:41 -08001068 /* use parent numa_node */
Zhen Lei56f2de82015-08-25 12:08:22 +08001069 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
Yinghai Lu0d358f22008-02-19 03:20:41 -08001070 set_dev_node(dev, dev_to_node(parent));
1071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001073 /* we require the name to be set before, and pass NULL */
1074 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001075 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001077
Brian Walsh37022642006-08-14 22:43:19 -07001078 /* notify platform of device entry */
1079 if (platform_notify)
1080 platform_notify(dev);
1081
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001082 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001083 if (error)
1084 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001085
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001086 error = device_add_class_symlinks(dev);
1087 if (error)
1088 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001089 error = device_add_attrs(dev);
1090 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001091 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001092 error = bus_add_device(dev);
1093 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001095 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001096 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001097 goto DPMError;
1098 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001099
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001100 if (MAJOR(dev->devt)) {
1101 error = device_create_file(dev, &dev_attr_dev);
1102 if (error)
1103 goto DevAttrError;
1104
1105 error = device_create_sys_dev_entry(dev);
1106 if (error)
1107 goto SysEntryError;
1108
1109 devtmpfs_create_node(dev);
1110 }
1111
Alan Sternec0676ee2008-12-05 14:10:31 -05001112 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001113 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001114 */
1115 if (dev->bus)
1116 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1117 BUS_NOTIFY_ADD_DEVICE, dev);
1118
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001119 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001120 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001122 klist_add_tail(&dev->p->knode_parent,
1123 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001125 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001126 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001127 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001128 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001129 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001130
1131 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001132 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001133 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001134 if (class_intf->add_dev)
1135 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001136 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001137 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001138done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 put_device(dev);
1140 return error;
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001141 SysEntryError:
1142 if (MAJOR(dev->devt))
1143 device_remove_file(dev, &dev_attr_dev);
1144 DevAttrError:
1145 device_pm_remove(dev);
1146 dpm_sysfs_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001147 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001148 bus_remove_device(dev);
1149 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001150 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001151 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001152 device_remove_class_symlinks(dev);
1153 SymlinkError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001154 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001155 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001156 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 kobject_del(&dev->kobj);
1158 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001159 cleanup_device_parent(dev);
Markus Elfring5f0163a2015-02-05 11:48:26 +01001160 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001161name_error:
1162 kfree(dev->p);
1163 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001164 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
David Graham White86df2682013-07-21 20:41:14 -04001166EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001169 * device_register - register a device with the system.
1170 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001172 * This happens in two clean steps - initialize the device
1173 * and add it to the system. The two steps can be called
1174 * separately, but this is the easiest and most common.
1175 * I.e. you should only call the two helpers separately if
1176 * have a clearly defined need to use and refcount the device
1177 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001178 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001179 * For more information, see the kerneldoc for device_initialize()
1180 * and device_add().
1181 *
Cornelia Huck57394112008-09-03 18:26:40 +02001182 * NOTE: _Never_ directly free @dev after calling this function, even
1183 * if it returned an error! Always use put_device() to give up the
1184 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186int device_register(struct device *dev)
1187{
1188 device_initialize(dev);
1189 return device_add(dev);
1190}
David Graham White86df2682013-07-21 20:41:14 -04001191EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001194 * get_device - increment reference count for device.
1195 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001197 * This simply forwards the call to kobject_get(), though
1198 * we do take care to provide for the case that we get a NULL
1199 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001201struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001203 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204}
David Graham White86df2682013-07-21 20:41:14 -04001205EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001208 * put_device - decrement reference count.
1209 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001211void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001213 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 if (dev)
1215 kobject_put(&dev->kobj);
1216}
David Graham White86df2682013-07-21 20:41:14 -04001217EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001220 * device_del - delete device from system.
1221 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001223 * This is the first part of the device unregistration
1224 * sequence. This removes the device from the lists we control
1225 * from here, has it removed from the other driver model
1226 * subsystems it was added to in device_add(), and removes it
1227 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001229 * NOTE: this should be called manually _iff_ device_add() was
1230 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001232void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001234 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001235 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
Alan Sternec0676ee2008-12-05 14:10:31 -05001237 /* Notify clients of device removal. This call must come
1238 * before dpm_sysfs_remove().
1239 */
1240 if (dev->bus)
1241 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1242 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001243 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001245 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001246 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001247 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001248 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001249 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001250 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001251 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001252 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001253
Kay Sieversca22e562011-12-14 14:29:38 -08001254 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001255 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001256 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001257 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001258 if (class_intf->remove_dev)
1259 class_intf->remove_dev(dev, class_intf);
1260 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001261 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001262 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001263 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001264 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001265 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001266 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001267 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001268 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
1270 /* Notify the platform of the removal, in case they
1271 * need to do anything...
1272 */
1273 if (platform_notify_remove)
1274 platform_notify_remove(dev);
Joerg Roedel599bad32014-09-30 13:02:02 +02001275 if (dev->bus)
1276 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1277 BUS_NOTIFY_REMOVED_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001278 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001279 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001281 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282}
David Graham White86df2682013-07-21 20:41:14 -04001283EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001286 * device_unregister - unregister device from system.
1287 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001289 * We do this in two parts, like we do device_register(). First,
1290 * we remove it from all the subsystems with device_del(), then
1291 * we decrement the reference count via put_device(). If that
1292 * is the final reference count, the device will be cleaned up
1293 * via device_release() above. Otherwise, the structure will
1294 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001296void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001298 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 device_del(dev);
1300 put_device(dev);
1301}
David Graham White86df2682013-07-21 20:41:14 -04001302EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001304static struct device *prev_device(struct klist_iter *i)
1305{
1306 struct klist_node *n = klist_prev(i);
1307 struct device *dev = NULL;
1308 struct device_private *p;
1309
1310 if (n) {
1311 p = to_device_private_parent(n);
1312 dev = p->device;
1313 }
1314 return dev;
1315}
1316
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001317static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001318{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001319 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001320 struct device *dev = NULL;
1321 struct device_private *p;
1322
1323 if (n) {
1324 p = to_device_private_parent(n);
1325 dev = p->device;
1326 }
1327 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001328}
1329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001331 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001332 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001333 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001334 * @uid: returned file owner
1335 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001336 * @tmp: possibly allocated string
1337 *
1338 * Return the relative path of a possible device node.
1339 * Non-default names may need to allocate a memory to compose
1340 * a name. This memory is returned in tmp and needs to be
1341 * freed by the caller.
1342 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001343const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001344 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001345 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001346{
1347 char *s;
1348
1349 *tmp = NULL;
1350
1351 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001352 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001353 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001354 if (*tmp)
1355 return *tmp;
1356
1357 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001358 if (dev->class && dev->class->devnode)
1359 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001360 if (*tmp)
1361 return *tmp;
1362
1363 /* return name without allocation, tmp == NULL */
1364 if (strchr(dev_name(dev), '!') == NULL)
1365 return dev_name(dev);
1366
1367 /* replace '!' in the name with '/' */
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001368 s = kstrdup(dev_name(dev), GFP_KERNEL);
1369 if (!s)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001370 return NULL;
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001371 strreplace(s, '!', '/');
1372 return *tmp = s;
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001373}
1374
1375/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001376 * device_for_each_child - device child iterator.
1377 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001378 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001379 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001381 * Iterate over @parent's child devices, and call @fn for each,
1382 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001384 * We check the return of @fn each time. If it returns anything
1385 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001387int device_for_each_child(struct device *parent, void *data,
1388 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001390 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001391 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 int error = 0;
1393
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001394 if (!parent->p)
1395 return 0;
1396
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001397 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001398 while ((child = next_device(&i)) && !error)
1399 error = fn(child, data);
1400 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 return error;
1402}
David Graham White86df2682013-07-21 20:41:14 -04001403EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Cornelia Huck5ab69982006-11-16 15:42:07 +01001405/**
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001406 * device_for_each_child_reverse - device child iterator in reversed order.
1407 * @parent: parent struct device.
1408 * @fn: function to be called for each device.
1409 * @data: data for the callback.
1410 *
1411 * Iterate over @parent's child devices, and call @fn for each,
1412 * passing it @data.
1413 *
1414 * We check the return of @fn each time. If it returns anything
1415 * other than 0, we break out and return that value.
1416 */
1417int device_for_each_child_reverse(struct device *parent, void *data,
1418 int (*fn)(struct device *dev, void *data))
1419{
1420 struct klist_iter i;
1421 struct device *child;
1422 int error = 0;
1423
1424 if (!parent->p)
1425 return 0;
1426
1427 klist_iter_init(&parent->p->klist_children, &i);
1428 while ((child = prev_device(&i)) && !error)
1429 error = fn(child, data);
1430 klist_iter_exit(&i);
1431 return error;
1432}
1433EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
1434
1435/**
Cornelia Huck5ab69982006-11-16 15:42:07 +01001436 * device_find_child - device iterator for locating a particular device.
1437 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01001438 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001439 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01001440 *
1441 * This is similar to the device_for_each_child() function above, but it
1442 * returns a reference to a device that is 'found' for later use, as
1443 * determined by the @match callback.
1444 *
1445 * The callback should return 0 if the device doesn't match and non-zero
1446 * if it does. If the callback returns non-zero and a reference to the
1447 * current device can be obtained, this function will return to the caller
1448 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02001449 *
1450 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01001451 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001452struct device *device_find_child(struct device *parent, void *data,
1453 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001454{
1455 struct klist_iter i;
1456 struct device *child;
1457
1458 if (!parent)
1459 return NULL;
1460
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001461 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001462 while ((child = next_device(&i)))
1463 if (match(child, data) && get_device(child))
1464 break;
1465 klist_iter_exit(&i);
1466 return child;
1467}
David Graham White86df2682013-07-21 20:41:14 -04001468EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470int __init devices_init(void)
1471{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001472 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1473 if (!devices_kset)
1474 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001475 dev_kobj = kobject_create_and_add("dev", NULL);
1476 if (!dev_kobj)
1477 goto dev_kobj_err;
1478 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1479 if (!sysfs_dev_block_kobj)
1480 goto block_kobj_err;
1481 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1482 if (!sysfs_dev_char_kobj)
1483 goto char_kobj_err;
1484
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001485 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001486
1487 char_kobj_err:
1488 kobject_put(sysfs_dev_block_kobj);
1489 block_kobj_err:
1490 kobject_put(dev_kobj);
1491 dev_kobj_err:
1492 kset_unregister(devices_kset);
1493 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494}
1495
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001496static int device_check_offline(struct device *dev, void *not_used)
1497{
1498 int ret;
1499
1500 ret = device_for_each_child(dev, NULL, device_check_offline);
1501 if (ret)
1502 return ret;
1503
1504 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1505}
1506
1507/**
1508 * device_offline - Prepare the device for hot-removal.
1509 * @dev: Device to be put offline.
1510 *
1511 * Execute the device bus type's .offline() callback, if present, to prepare
1512 * the device for a subsequent hot-removal. If that succeeds, the device must
1513 * not be used until either it is removed or its bus type's .online() callback
1514 * is executed.
1515 *
1516 * Call under device_hotplug_lock.
1517 */
1518int device_offline(struct device *dev)
1519{
1520 int ret;
1521
1522 if (dev->offline_disabled)
1523 return -EPERM;
1524
1525 ret = device_for_each_child(dev, NULL, device_check_offline);
1526 if (ret)
1527 return ret;
1528
1529 device_lock(dev);
1530 if (device_supports_offline(dev)) {
1531 if (dev->offline) {
1532 ret = 1;
1533 } else {
1534 ret = dev->bus->offline(dev);
1535 if (!ret) {
1536 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1537 dev->offline = true;
1538 }
1539 }
1540 }
1541 device_unlock(dev);
1542
1543 return ret;
1544}
1545
1546/**
1547 * device_online - Put the device back online after successful device_offline().
1548 * @dev: Device to be put back online.
1549 *
1550 * If device_offline() has been successfully executed for @dev, but the device
1551 * has not been removed subsequently, execute its bus type's .online() callback
1552 * to indicate that the device can be used again.
1553 *
1554 * Call under device_hotplug_lock.
1555 */
1556int device_online(struct device *dev)
1557{
1558 int ret = 0;
1559
1560 device_lock(dev);
1561 if (device_supports_offline(dev)) {
1562 if (dev->offline) {
1563 ret = dev->bus->online(dev);
1564 if (!ret) {
1565 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1566 dev->offline = false;
1567 }
1568 } else {
1569 ret = 1;
1570 }
1571 }
1572 device_unlock(dev);
1573
1574 return ret;
1575}
1576
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001577struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001578 struct device dev;
1579 struct module *owner;
1580};
1581
Josh Triplett93058422012-11-18 21:27:55 -08001582static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001583{
1584 return container_of(d, struct root_device, dev);
1585}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001586
1587static void root_device_release(struct device *dev)
1588{
1589 kfree(to_root_device(dev));
1590}
1591
1592/**
1593 * __root_device_register - allocate and register a root device
1594 * @name: root device name
1595 * @owner: owner module of the root device, usually THIS_MODULE
1596 *
1597 * This function allocates a root device and registers it
1598 * using device_register(). In order to free the returned
1599 * device, use root_device_unregister().
1600 *
1601 * Root devices are dummy devices which allow other devices
1602 * to be grouped under /sys/devices. Use this function to
1603 * allocate a root device and then use it as the parent of
1604 * any device which should appear under /sys/devices/{name}
1605 *
1606 * The /sys/devices/{name} directory will also contain a
1607 * 'module' symlink which points to the @owner directory
1608 * in sysfs.
1609 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001610 * Returns &struct device pointer on success, or ERR_PTR() on error.
1611 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001612 * Note: You probably want to use root_device_register().
1613 */
1614struct device *__root_device_register(const char *name, struct module *owner)
1615{
1616 struct root_device *root;
1617 int err = -ENOMEM;
1618
1619 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1620 if (!root)
1621 return ERR_PTR(err);
1622
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001623 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001624 if (err) {
1625 kfree(root);
1626 return ERR_PTR(err);
1627 }
1628
1629 root->dev.release = root_device_release;
1630
1631 err = device_register(&root->dev);
1632 if (err) {
1633 put_device(&root->dev);
1634 return ERR_PTR(err);
1635 }
1636
Christoph Egger1d9e8822010-05-17 16:57:58 +02001637#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001638 if (owner) {
1639 struct module_kobject *mk = &owner->mkobj;
1640
1641 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1642 if (err) {
1643 device_unregister(&root->dev);
1644 return ERR_PTR(err);
1645 }
1646 root->owner = owner;
1647 }
1648#endif
1649
1650 return &root->dev;
1651}
1652EXPORT_SYMBOL_GPL(__root_device_register);
1653
1654/**
1655 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001656 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001657 *
1658 * This function unregisters and cleans up a device that was created by
1659 * root_device_register().
1660 */
1661void root_device_unregister(struct device *dev)
1662{
1663 struct root_device *root = to_root_device(dev);
1664
1665 if (root->owner)
1666 sysfs_remove_link(&root->dev.kobj, "module");
1667
1668 device_unregister(dev);
1669}
1670EXPORT_SYMBOL_GPL(root_device_unregister);
1671
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001672
1673static void device_create_release(struct device *dev)
1674{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001675 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001676 kfree(dev);
1677}
1678
Guenter Roeck39ef3112013-07-14 16:05:57 -07001679static struct device *
1680device_create_groups_vargs(struct class *class, struct device *parent,
1681 dev_t devt, void *drvdata,
1682 const struct attribute_group **groups,
1683 const char *fmt, va_list args)
1684{
1685 struct device *dev = NULL;
1686 int retval = -ENODEV;
1687
1688 if (class == NULL || IS_ERR(class))
1689 goto error;
1690
1691 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1692 if (!dev) {
1693 retval = -ENOMEM;
1694 goto error;
1695 }
1696
David Herrmannbbc780f2013-11-21 20:15:48 +01001697 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001698 dev->devt = devt;
1699 dev->class = class;
1700 dev->parent = parent;
1701 dev->groups = groups;
1702 dev->release = device_create_release;
1703 dev_set_drvdata(dev, drvdata);
1704
1705 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1706 if (retval)
1707 goto error;
1708
David Herrmannbbc780f2013-11-21 20:15:48 +01001709 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001710 if (retval)
1711 goto error;
1712
1713 return dev;
1714
1715error:
1716 put_device(dev);
1717 return ERR_PTR(retval);
1718}
1719
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001720/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001721 * device_create_vargs - creates a device and registers it with sysfs
1722 * @class: pointer to the struct class that this device should be registered to
1723 * @parent: pointer to the parent struct device of this new device, if any
1724 * @devt: the dev_t for the char device to be added
1725 * @drvdata: the data to be added to the device for callbacks
1726 * @fmt: string for the device's name
1727 * @args: va_list for the device's name
1728 *
1729 * This function can be used by char device classes. A struct device
1730 * will be created in sysfs, registered to the specified class.
1731 *
1732 * A "dev" file will be created, showing the dev_t for the device, if
1733 * the dev_t is not 0,0.
1734 * If a pointer to a parent struct device is passed in, the newly created
1735 * struct device will be a child of that device in sysfs.
1736 * The pointer to the struct device will be returned from the call.
1737 * Any further sysfs files that might be required can be created using this
1738 * pointer.
1739 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001740 * Returns &struct device pointer on success, or ERR_PTR() on error.
1741 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001742 * Note: the struct class passed to this function must have previously
1743 * been created with a call to class_create().
1744 */
1745struct device *device_create_vargs(struct class *class, struct device *parent,
1746 dev_t devt, void *drvdata, const char *fmt,
1747 va_list args)
1748{
Guenter Roeck39ef3112013-07-14 16:05:57 -07001749 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1750 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001751}
1752EXPORT_SYMBOL_GPL(device_create_vargs);
1753
1754/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001755 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001756 * @class: pointer to the struct class that this device should be registered to
1757 * @parent: pointer to the parent struct device of this new device, if any
1758 * @devt: the dev_t for the char device to be added
1759 * @drvdata: the data to be added to the device for callbacks
1760 * @fmt: string for the device's name
1761 *
1762 * This function can be used by char device classes. A struct device
1763 * will be created in sysfs, registered to the specified class.
1764 *
1765 * A "dev" file will be created, showing the dev_t for the device, if
1766 * the dev_t is not 0,0.
1767 * If a pointer to a parent struct device is passed in, the newly created
1768 * struct device will be a child of that device in sysfs.
1769 * The pointer to the struct device will be returned from the call.
1770 * Any further sysfs files that might be required can be created using this
1771 * pointer.
1772 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001773 * Returns &struct device pointer on success, or ERR_PTR() on error.
1774 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001775 * Note: the struct class passed to this function must have previously
1776 * been created with a call to class_create().
1777 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001778struct device *device_create(struct class *class, struct device *parent,
1779 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001780{
1781 va_list vargs;
1782 struct device *dev;
1783
1784 va_start(vargs, fmt);
1785 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1786 va_end(vargs);
1787 return dev;
1788}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001789EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001790
Guenter Roeck39ef3112013-07-14 16:05:57 -07001791/**
1792 * device_create_with_groups - creates a device and registers it with sysfs
1793 * @class: pointer to the struct class that this device should be registered to
1794 * @parent: pointer to the parent struct device of this new device, if any
1795 * @devt: the dev_t for the char device to be added
1796 * @drvdata: the data to be added to the device for callbacks
1797 * @groups: NULL-terminated list of attribute groups to be created
1798 * @fmt: string for the device's name
1799 *
1800 * This function can be used by char device classes. A struct device
1801 * will be created in sysfs, registered to the specified class.
1802 * Additional attributes specified in the groups parameter will also
1803 * be created automatically.
1804 *
1805 * A "dev" file will be created, showing the dev_t for the device, if
1806 * the dev_t is not 0,0.
1807 * If a pointer to a parent struct device is passed in, the newly created
1808 * struct device will be a child of that device in sysfs.
1809 * The pointer to the struct device will be returned from the call.
1810 * Any further sysfs files that might be required can be created using this
1811 * pointer.
1812 *
1813 * Returns &struct device pointer on success, or ERR_PTR() on error.
1814 *
1815 * Note: the struct class passed to this function must have previously
1816 * been created with a call to class_create().
1817 */
1818struct device *device_create_with_groups(struct class *class,
1819 struct device *parent, dev_t devt,
1820 void *drvdata,
1821 const struct attribute_group **groups,
1822 const char *fmt, ...)
1823{
1824 va_list vargs;
1825 struct device *dev;
1826
1827 va_start(vargs, fmt);
1828 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1829 fmt, vargs);
1830 va_end(vargs);
1831 return dev;
1832}
1833EXPORT_SYMBOL_GPL(device_create_with_groups);
1834
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001835static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001836{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001837 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001838
Dave Youngcd354492008-01-28 16:56:11 +08001839 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001840}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001841
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001842/**
1843 * device_destroy - removes a device that was created with device_create()
1844 * @class: pointer to the struct class that this device was registered with
1845 * @devt: the dev_t of the device that was previously registered
1846 *
1847 * This call unregisters and cleans up a device that was created with a
1848 * call to device_create().
1849 */
1850void device_destroy(struct class *class, dev_t devt)
1851{
1852 struct device *dev;
1853
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001854 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001855 if (dev) {
1856 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001857 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001858 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001859}
1860EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001861
1862/**
1863 * device_rename - renames a device
1864 * @dev: the pointer to the struct device to be renamed
1865 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001866 *
1867 * It is the responsibility of the caller to provide mutual
1868 * exclusion between two different calls of device_rename
1869 * on the same device to ensure that new_name is valid and
1870 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001871 *
Timur Tabia5462512010-12-13 14:08:52 -06001872 * Note: Don't call this function. Currently, the networking layer calls this
1873 * function, but that will change. The following text from Kay Sievers offers
1874 * some insight:
1875 *
1876 * Renaming devices is racy at many levels, symlinks and other stuff are not
1877 * replaced atomically, and you get a "move" uevent, but it's not easy to
1878 * connect the event to the old and new device. Device nodes are not renamed at
1879 * all, there isn't even support for that in the kernel now.
1880 *
1881 * In the meantime, during renaming, your target name might be taken by another
1882 * driver, creating conflicts. Or the old name is taken directly after you
1883 * renamed it -- then you get events for the same DEVPATH, before you even see
1884 * the "move" event. It's just a mess, and nothing new should ever rely on
1885 * kernel device renaming. Besides that, it's not even implemented now for
1886 * other things than (driver-core wise very simple) network devices.
1887 *
1888 * We are currently about to change network renaming in udev to completely
1889 * disallow renaming of devices in the same namespace as the kernel uses,
1890 * because we can't solve the problems properly, that arise with swapping names
1891 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1892 * be allowed to some other name than eth[0-9]*, for the aforementioned
1893 * reasons.
1894 *
1895 * Make up a "real" name in the driver before you register anything, or add
1896 * some other attributes for userspace to find the device, or use udev to add
1897 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1898 * don't even want to get into that and try to implement the missing pieces in
1899 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001900 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001901int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001902{
Tejun Heo4b30ee52013-09-11 22:29:06 -04001903 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001904 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001905 int error;
1906
1907 dev = get_device(dev);
1908 if (!dev)
1909 return -EINVAL;
1910
ethan.zhao69df7532013-10-13 22:12:35 +08001911 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001912
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001913 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001914 if (!old_device_name) {
1915 error = -ENOMEM;
1916 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001917 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001918
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001919 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04001920 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1921 kobj, old_device_name,
1922 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001923 if (error)
1924 goto out;
1925 }
Kay Sievers39aba962010-09-04 22:33:14 -07001926
Tejun Heo4b30ee52013-09-11 22:29:06 -04001927 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001928 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001929 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001930
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001931out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001932 put_device(dev);
1933
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001934 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001935
1936 return error;
1937}
Johannes Berga2807db2007-02-28 12:38:31 +01001938EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001939
1940static int device_move_class_links(struct device *dev,
1941 struct device *old_parent,
1942 struct device *new_parent)
1943{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001944 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001945
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001946 if (old_parent)
1947 sysfs_remove_link(&dev->kobj, "device");
1948 if (new_parent)
1949 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1950 "device");
1951 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001952}
1953
1954/**
1955 * device_move - moves a device to a new parent
1956 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001957 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001958 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001959 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001960int device_move(struct device *dev, struct device *new_parent,
1961 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001962{
1963 int error;
1964 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001965 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001966
1967 dev = get_device(dev);
1968 if (!dev)
1969 return -EINVAL;
1970
Cornelia Huckffa6a702009-03-04 12:44:00 +01001971 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001972 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001973 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001974
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001975 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1976 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001977 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001978 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001979 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001980 put_device(new_parent);
1981 goto out;
1982 }
1983 old_parent = dev->parent;
1984 dev->parent = new_parent;
1985 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001986 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001987 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001988 klist_add_tail(&dev->p->knode_parent,
1989 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001990 set_dev_node(dev, dev_to_node(new_parent));
1991 }
1992
Rabin Vincentbdd40342012-04-23 09:16:36 +02001993 if (dev->class) {
1994 error = device_move_class_links(dev, old_parent, new_parent);
1995 if (error) {
1996 /* We ignore errors on cleanup since we're hosed anyway... */
1997 device_move_class_links(dev, new_parent, old_parent);
1998 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1999 if (new_parent)
2000 klist_remove(&dev->p->knode_parent);
2001 dev->parent = old_parent;
2002 if (old_parent) {
2003 klist_add_tail(&dev->p->knode_parent,
2004 &old_parent->p->klist_children);
2005 set_dev_node(dev, dev_to_node(old_parent));
2006 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08002007 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002008 cleanup_glue_dir(dev, new_parent_kobj);
2009 put_device(new_parent);
2010 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01002011 }
Cornelia Huck8a824722006-11-20 17:07:51 +01002012 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01002013 switch (dpm_order) {
2014 case DPM_ORDER_NONE:
2015 break;
2016 case DPM_ORDER_DEV_AFTER_PARENT:
2017 device_pm_move_after(dev, new_parent);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002018 devices_kset_move_after(dev, new_parent);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002019 break;
2020 case DPM_ORDER_PARENT_BEFORE_DEV:
2021 device_pm_move_before(new_parent, dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002022 devices_kset_move_before(new_parent, dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002023 break;
2024 case DPM_ORDER_DEV_LAST:
2025 device_pm_move_last(dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002026 devices_kset_move_last(dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002027 break;
2028 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002029
Cornelia Huck8a824722006-11-20 17:07:51 +01002030 put_device(old_parent);
2031out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01002032 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002033 put_device(dev);
2034 return error;
2035}
Cornelia Huck8a824722006-11-20 17:07:51 +01002036EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002037
2038/**
2039 * device_shutdown - call ->shutdown() on each device to shutdown.
2040 */
2041void device_shutdown(void)
2042{
Benson Leungf123db82013-09-24 20:05:11 -07002043 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002044
Hugh Daschbach62458382010-03-22 10:36:37 -07002045 spin_lock(&devices_kset->list_lock);
2046 /*
2047 * Walk the devices list backward, shutting down each in turn.
2048 * Beware that device unplug events may also start pulling
2049 * devices offline, even as the system is shutting down.
2050 */
2051 while (!list_empty(&devices_kset->list)) {
2052 dev = list_entry(devices_kset->list.prev, struct device,
2053 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08002054
2055 /*
2056 * hold reference count of device's parent to
2057 * prevent it from being freed because parent's
2058 * lock is to be held
2059 */
Benson Leungf123db82013-09-24 20:05:11 -07002060 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002061 get_device(dev);
2062 /*
2063 * Make sure the device is off the kset list, in the
2064 * event that dev->*->shutdown() doesn't remove it.
2065 */
2066 list_del_init(&dev->kobj.entry);
2067 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01002068
Ming Leid1c6c032012-06-22 18:01:40 +08002069 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07002070 if (parent)
2071 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002072 device_lock(dev);
2073
Alan Sternfe6b91f2011-12-06 23:24:52 +01002074 /* Don't allow any more runtime suspends */
2075 pm_runtime_get_noresume(dev);
2076 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07002077
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002078 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002079 if (initcall_debug)
2080 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002081 dev->bus->shutdown(dev);
2082 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002083 if (initcall_debug)
2084 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002085 dev->driver->shutdown(dev);
2086 }
Ming Leid1c6c032012-06-22 18:01:40 +08002087
2088 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002089 if (parent)
2090 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002091
Hugh Daschbach62458382010-03-22 10:36:37 -07002092 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002093 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002094
2095 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002096 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002097 spin_unlock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002098}
Joe Perches99bcf212010-06-27 01:02:34 +00002099
2100/*
2101 * Device logging functions
2102 */
2103
2104#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002105static int
2106create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002107{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002108 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002109 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002110
Kay Sieversc4e00da2012-05-03 02:29:59 +02002111 if (dev->class)
2112 subsys = dev->class->name;
2113 else if (dev->bus)
2114 subsys = dev->bus->name;
2115 else
Joe Perches798efc62012-09-12 20:11:29 -07002116 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002117
Joe Perches798efc62012-09-12 20:11:29 -07002118 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Ben Hutchings655e5b72014-08-26 00:34:44 -07002119 if (pos >= hdrlen)
2120 goto overflow;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002121
2122 /*
2123 * Add device identifier DEVICE=:
2124 * b12:8 block dev_t
2125 * c127:3 char dev_t
2126 * n8 netdev ifindex
2127 * +sound:card0 subsystem:devname
2128 */
2129 if (MAJOR(dev->devt)) {
2130 char c;
2131
2132 if (strcmp(subsys, "block") == 0)
2133 c = 'b';
2134 else
2135 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002136 pos++;
2137 pos += snprintf(hdr + pos, hdrlen - pos,
2138 "DEVICE=%c%u:%u",
2139 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002140 } else if (strcmp(subsys, "net") == 0) {
2141 struct net_device *net = to_net_dev(dev);
2142
Joe Perches798efc62012-09-12 20:11:29 -07002143 pos++;
2144 pos += snprintf(hdr + pos, hdrlen - pos,
2145 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002146 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002147 pos++;
2148 pos += snprintf(hdr + pos, hdrlen - pos,
2149 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002150 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002151
Ben Hutchings655e5b72014-08-26 00:34:44 -07002152 if (pos >= hdrlen)
2153 goto overflow;
2154
Joe Perches798efc62012-09-12 20:11:29 -07002155 return pos;
Ben Hutchings655e5b72014-08-26 00:34:44 -07002156
2157overflow:
2158 dev_WARN(dev, "device/subsystem name too long");
2159 return 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002160}
Joe Perches798efc62012-09-12 20:11:29 -07002161
Joe Perches05e4e5b2012-09-12 20:13:37 -07002162int dev_vprintk_emit(int level, const struct device *dev,
2163 const char *fmt, va_list args)
2164{
2165 char hdr[128];
2166 size_t hdrlen;
2167
2168 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2169
2170 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2171}
2172EXPORT_SYMBOL(dev_vprintk_emit);
2173
2174int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2175{
2176 va_list args;
2177 int r;
2178
2179 va_start(args, fmt);
2180
2181 r = dev_vprintk_emit(level, dev, fmt, args);
2182
2183 va_end(args);
2184
2185 return r;
2186}
2187EXPORT_SYMBOL(dev_printk_emit);
2188
Joe Perchesd1f10522014-12-25 15:07:04 -08002189static void __dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -07002190 struct va_format *vaf)
2191{
Joe Perchesd1f10522014-12-25 15:07:04 -08002192 if (dev)
2193 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2194 dev_driver_string(dev), dev_name(dev), vaf);
2195 else
2196 printk("%s(NULL device *): %pV", level, vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002197}
Joe Perches99bcf212010-06-27 01:02:34 +00002198
Joe Perchesd1f10522014-12-25 15:07:04 -08002199void dev_printk(const char *level, const struct device *dev,
2200 const char *fmt, ...)
Joe Perches99bcf212010-06-27 01:02:34 +00002201{
2202 struct va_format vaf;
2203 va_list args;
Joe Perches99bcf212010-06-27 01:02:34 +00002204
2205 va_start(args, fmt);
2206
2207 vaf.fmt = fmt;
2208 vaf.va = &args;
2209
Joe Perchesd1f10522014-12-25 15:07:04 -08002210 __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002211
Joe Perches99bcf212010-06-27 01:02:34 +00002212 va_end(args);
Joe Perches99bcf212010-06-27 01:02:34 +00002213}
2214EXPORT_SYMBOL(dev_printk);
2215
2216#define define_dev_printk_level(func, kern_level) \
Joe Perchesd1f10522014-12-25 15:07:04 -08002217void func(const struct device *dev, const char *fmt, ...) \
Joe Perches99bcf212010-06-27 01:02:34 +00002218{ \
2219 struct va_format vaf; \
2220 va_list args; \
Joe Perches99bcf212010-06-27 01:02:34 +00002221 \
2222 va_start(args, fmt); \
2223 \
2224 vaf.fmt = fmt; \
2225 vaf.va = &args; \
2226 \
Joe Perchesd1f10522014-12-25 15:07:04 -08002227 __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002228 \
Joe Perches99bcf212010-06-27 01:02:34 +00002229 va_end(args); \
Joe Perches99bcf212010-06-27 01:02:34 +00002230} \
2231EXPORT_SYMBOL(func);
2232
2233define_dev_printk_level(dev_emerg, KERN_EMERG);
2234define_dev_printk_level(dev_alert, KERN_ALERT);
2235define_dev_printk_level(dev_crit, KERN_CRIT);
2236define_dev_printk_level(dev_err, KERN_ERR);
2237define_dev_printk_level(dev_warn, KERN_WARNING);
2238define_dev_printk_level(dev_notice, KERN_NOTICE);
2239define_dev_printk_level(_dev_info, KERN_INFO);
2240
2241#endif
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002242
2243static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2244{
2245 return fwnode && !IS_ERR(fwnode->secondary);
2246}
2247
2248/**
2249 * set_primary_fwnode - Change the primary firmware node of a given device.
2250 * @dev: Device to handle.
2251 * @fwnode: New primary firmware node of the device.
2252 *
2253 * Set the device's firmware node pointer to @fwnode, but if a secondary
2254 * firmware node of the device is present, preserve it.
2255 */
2256void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2257{
2258 if (fwnode) {
2259 struct fwnode_handle *fn = dev->fwnode;
2260
2261 if (fwnode_is_primary(fn))
2262 fn = fn->secondary;
2263
2264 fwnode->secondary = fn;
2265 dev->fwnode = fwnode;
2266 } else {
2267 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2268 dev->fwnode->secondary : NULL;
2269 }
2270}
2271EXPORT_SYMBOL_GPL(set_primary_fwnode);
2272
2273/**
2274 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2275 * @dev: Device to handle.
2276 * @fwnode: New secondary firmware node of the device.
2277 *
2278 * If a primary firmware node of the device is present, set its secondary
2279 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2280 * @fwnode.
2281 */
2282void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2283{
2284 if (fwnode)
2285 fwnode->secondary = ERR_PTR(-ENODEV);
2286
2287 if (fwnode_is_primary(dev->fwnode))
2288 dev->fwnode->secondary = fwnode;
2289 else
2290 dev->fwnode = fwnode;
2291}