blob: ce057a568673362277301638cc1bd1a72dbab933 [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
Ming Leicebf8fd2016-07-10 19:27:36 +0800839static inline bool live_in_glue_dir(struct kobject *kobj,
840 struct device *dev)
841{
842 if (!kobj || !dev->class ||
843 kobj->kset != &dev->class->p->glue_dirs)
844 return false;
845 return true;
846}
847
848static inline struct kobject *get_glue_dir(struct device *dev)
849{
850 return dev->kobj.parent;
851}
852
853/*
854 * make sure cleaning up dir as the last step, we need to make
855 * sure .release handler of kobject is run with holding the
856 * global lock
857 */
Cornelia Huck63b69712008-01-21 16:09:44 +0100858static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100859{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100860 /* see if we live in a "glue" directory */
Ming Leicebf8fd2016-07-10 19:27:36 +0800861 if (!live_in_glue_dir(glue_dir, dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100862 return;
863
Yijing Wange4a60d12014-11-07 12:05:49 +0800864 mutex_lock(&gdp_mutex);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100865 kobject_put(glue_dir);
Yijing Wange4a60d12014-11-07 12:05:49 +0800866 mutex_unlock(&gdp_mutex);
Kay Sieversda231fd2007-11-21 17:29:15 +0100867}
Cornelia Huck63b69712008-01-21 16:09:44 +0100868
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700869static int device_add_class_symlinks(struct device *dev)
870{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100871 struct device_node *of_node = dev_of_node(dev);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700872 int error;
873
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100874 if (of_node) {
875 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
876 if (error)
877 dev_warn(dev, "Error %d creating of_node link\n",error);
878 /* An error here doesn't warrant bringing down the device */
879 }
880
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700881 if (!dev->class)
882 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100883
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700884 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100885 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700886 "subsystem");
887 if (error)
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100888 goto out_devnode;
Kay Sieversda231fd2007-11-21 17:29:15 +0100889
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800890 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700891 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
892 "device");
893 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700894 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700895 }
Kay Sievers39aba962010-09-04 22:33:14 -0700896
Randy Dunlapead454f2010-09-24 14:36:49 -0700897#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700898 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200899 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700900 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700901#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700902
903 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100904 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700905 &dev->kobj, dev_name(dev));
906 if (error)
907 goto out_device;
908
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700909 return 0;
910
Kay Sievers39aba962010-09-04 22:33:14 -0700911out_device:
912 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100913
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700914out_subsys:
915 sysfs_remove_link(&dev->kobj, "subsystem");
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100916out_devnode:
917 sysfs_remove_link(&dev->kobj, "of_node");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700918 return error;
919}
920
921static void device_remove_class_symlinks(struct device *dev)
922{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +1100923 if (dev_of_node(dev))
924 sysfs_remove_link(&dev->kobj, "of_node");
925
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700926 if (!dev->class)
927 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100928
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800929 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100930 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700931 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700932#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200933 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700934 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700935#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100936 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700937}
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000940 * dev_set_name - set a device name
941 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700942 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000943 */
944int dev_set_name(struct device *dev, const char *fmt, ...)
945{
946 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100947 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000948
949 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100950 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000951 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100952 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000953}
954EXPORT_SYMBOL_GPL(dev_set_name);
955
956/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700957 * device_to_dev_kobj - select a /sys/dev/ directory for the device
958 * @dev: device
959 *
960 * By default we select char/ for new entries. Setting class->dev_obj
961 * to NULL prevents an entry from being created. class->dev_kobj must
962 * be set (or cleared) before any devices are registered to the class
963 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200964 * device_remove_sys_dev_entry() will disagree about the presence of
965 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700966 */
967static struct kobject *device_to_dev_kobj(struct device *dev)
968{
969 struct kobject *kobj;
970
971 if (dev->class)
972 kobj = dev->class->dev_kobj;
973 else
974 kobj = sysfs_dev_char_kobj;
975
976 return kobj;
977}
978
979static int device_create_sys_dev_entry(struct device *dev)
980{
981 struct kobject *kobj = device_to_dev_kobj(dev);
982 int error = 0;
983 char devt_str[15];
984
985 if (kobj) {
986 format_dev_t(devt_str, dev->devt);
987 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
988 }
989
990 return error;
991}
992
993static void device_remove_sys_dev_entry(struct device *dev)
994{
995 struct kobject *kobj = device_to_dev_kobj(dev);
996 char devt_str[15];
997
998 if (kobj) {
999 format_dev_t(devt_str, dev->devt);
1000 sysfs_remove_link(kobj, devt_str);
1001 }
1002}
1003
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001004int device_private_init(struct device *dev)
1005{
1006 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
1007 if (!dev->p)
1008 return -ENOMEM;
1009 dev->p->device = dev;
1010 klist_init(&dev->p->klist_children, klist_children_get,
1011 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -08001012 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001013 return 0;
1014}
1015
Dan Williamse105b8b2008-04-21 10:51:07 -07001016/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001017 * device_add - add device to device hierarchy.
1018 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001020 * This is part 2 of device_register(), though may be called
1021 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 *
Cornelia Huck57394112008-09-03 18:26:40 +02001023 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001024 * to the global and sibling lists for the device, then
1025 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +02001026 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001027 * Do not call this routine or device_register() more than once for
1028 * any device structure. The driver model core is not designed to work
1029 * with devices that get unregistered and then spring back to life.
1030 * (Among other things, it's very hard to guarantee that all references
1031 * to the previous incarnation of @dev have been dropped.) Allocate
1032 * and register a fresh new struct device instead.
1033 *
Cornelia Huck57394112008-09-03 18:26:40 +02001034 * NOTE: _Never_ directly free @dev after calling this function, even
1035 * if it returned an error! Always use put_device() to give up your
1036 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 */
1038int device_add(struct device *dev)
1039{
1040 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -08001041 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001042 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001043 int error = -EINVAL;
Ming Leicebf8fd2016-07-10 19:27:36 +08001044 struct kobject *glue_dir = NULL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001045
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001047 if (!dev)
1048 goto done;
1049
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001050 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001051 error = device_private_init(dev);
1052 if (error)
1053 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001054 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001055
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001056 /*
1057 * for statically allocated devices, which should all be converted
1058 * some day, we need to initialize the name. We prevent reading back
1059 * the name, and force the use of dev_name()
1060 */
1061 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001062 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001063 dev->init_name = NULL;
1064 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001065
Kay Sieversca22e562011-12-14 14:29:38 -08001066 /* subsystems can specify simple device enumeration */
1067 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1068 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1069
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001070 if (!dev_name(dev)) {
1071 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001072 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001073 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001075 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001078 kobj = get_device_parent(dev, parent);
1079 if (kobj)
1080 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Yinghai Lu0d358f22008-02-19 03:20:41 -08001082 /* use parent numa_node */
Zhen Lei56f2de82015-08-25 12:08:22 +08001083 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
Yinghai Lu0d358f22008-02-19 03:20:41 -08001084 set_dev_node(dev, dev_to_node(parent));
1085
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001087 /* we require the name to be set before, and pass NULL */
1088 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Ming Leicebf8fd2016-07-10 19:27:36 +08001089 if (error) {
1090 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 goto Error;
Ming Leicebf8fd2016-07-10 19:27:36 +08001092 }
Kay Sieversa7fd6702005-10-01 14:49:43 +02001093
Brian Walsh37022642006-08-14 22:43:19 -07001094 /* notify platform of device entry */
1095 if (platform_notify)
1096 platform_notify(dev);
1097
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001098 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001099 if (error)
1100 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001101
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001102 error = device_add_class_symlinks(dev);
1103 if (error)
1104 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001105 error = device_add_attrs(dev);
1106 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001107 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001108 error = bus_add_device(dev);
1109 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001111 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001112 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001113 goto DPMError;
1114 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001115
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001116 if (MAJOR(dev->devt)) {
1117 error = device_create_file(dev, &dev_attr_dev);
1118 if (error)
1119 goto DevAttrError;
1120
1121 error = device_create_sys_dev_entry(dev);
1122 if (error)
1123 goto SysEntryError;
1124
1125 devtmpfs_create_node(dev);
1126 }
1127
Alan Sternec0676ee2008-12-05 14:10:31 -05001128 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001129 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001130 */
1131 if (dev->bus)
1132 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1133 BUS_NOTIFY_ADD_DEVICE, dev);
1134
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001135 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001136 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001138 klist_add_tail(&dev->p->knode_parent,
1139 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001141 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001142 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001143 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001144 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001145 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001146
1147 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001148 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001149 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001150 if (class_intf->add_dev)
1151 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001152 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001153 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001154done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 put_device(dev);
1156 return error;
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001157 SysEntryError:
1158 if (MAJOR(dev->devt))
1159 device_remove_file(dev, &dev_attr_dev);
1160 DevAttrError:
1161 device_pm_remove(dev);
1162 dpm_sysfs_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001163 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001164 bus_remove_device(dev);
1165 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001166 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001167 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001168 device_remove_class_symlinks(dev);
1169 SymlinkError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001170 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001171 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001172 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001173 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 kobject_del(&dev->kobj);
1175 Error:
Ming Leicebf8fd2016-07-10 19:27:36 +08001176 cleanup_glue_dir(dev, glue_dir);
Markus Elfring5f0163a2015-02-05 11:48:26 +01001177 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001178name_error:
1179 kfree(dev->p);
1180 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001181 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
David Graham White86df2682013-07-21 20:41:14 -04001183EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001186 * device_register - register a device with the system.
1187 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001189 * This happens in two clean steps - initialize the device
1190 * and add it to the system. The two steps can be called
1191 * separately, but this is the easiest and most common.
1192 * I.e. you should only call the two helpers separately if
1193 * have a clearly defined need to use and refcount the device
1194 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001195 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001196 * For more information, see the kerneldoc for device_initialize()
1197 * and device_add().
1198 *
Cornelia Huck57394112008-09-03 18:26:40 +02001199 * NOTE: _Never_ directly free @dev after calling this function, even
1200 * if it returned an error! Always use put_device() to give up the
1201 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203int device_register(struct device *dev)
1204{
1205 device_initialize(dev);
1206 return device_add(dev);
1207}
David Graham White86df2682013-07-21 20:41:14 -04001208EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001211 * get_device - increment reference count for device.
1212 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001214 * This simply forwards the call to kobject_get(), though
1215 * we do take care to provide for the case that we get a NULL
1216 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001218struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001220 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221}
David Graham White86df2682013-07-21 20:41:14 -04001222EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001225 * put_device - decrement reference count.
1226 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001228void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001230 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 if (dev)
1232 kobject_put(&dev->kobj);
1233}
David Graham White86df2682013-07-21 20:41:14 -04001234EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001237 * device_del - delete device from system.
1238 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001240 * This is the first part of the device unregistration
1241 * sequence. This removes the device from the lists we control
1242 * from here, has it removed from the other driver model
1243 * subsystems it was added to in device_add(), and removes it
1244 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001246 * NOTE: this should be called manually _iff_ device_add() was
1247 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001249void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001251 struct device *parent = dev->parent;
Ming Leicebf8fd2016-07-10 19:27:36 +08001252 struct kobject *glue_dir = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001253 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
Alan Sternec0676ee2008-12-05 14:10:31 -05001255 /* Notify clients of device removal. This call must come
1256 * before dpm_sysfs_remove().
1257 */
1258 if (dev->bus)
1259 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1260 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001261 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001263 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001264 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001265 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001266 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001267 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001268 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001269 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001270 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001271
Kay Sieversca22e562011-12-14 14:29:38 -08001272 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001273 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001274 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001275 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001276 if (class_intf->remove_dev)
1277 class_intf->remove_dev(dev, class_intf);
1278 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001279 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001280 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001281 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001282 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001283 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001284 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001285 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001286 driver_deferred_probe_del(dev);
Lukas Wunner478573c2016-07-28 02:25:41 +02001287 device_remove_properties(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
1289 /* Notify the platform of the removal, in case they
1290 * need to do anything...
1291 */
1292 if (platform_notify_remove)
1293 platform_notify_remove(dev);
Joerg Roedel599bad32014-09-30 13:02:02 +02001294 if (dev->bus)
1295 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1296 BUS_NOTIFY_REMOVED_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001297 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001298 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 kobject_del(&dev->kobj);
Ming Leicebf8fd2016-07-10 19:27:36 +08001300 cleanup_glue_dir(dev, glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +01001301 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302}
David Graham White86df2682013-07-21 20:41:14 -04001303EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
1305/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001306 * device_unregister - unregister device from system.
1307 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001309 * We do this in two parts, like we do device_register(). First,
1310 * we remove it from all the subsystems with device_del(), then
1311 * we decrement the reference count via put_device(). If that
1312 * is the final reference count, the device will be cleaned up
1313 * via device_release() above. Otherwise, the structure will
1314 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001316void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001318 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 device_del(dev);
1320 put_device(dev);
1321}
David Graham White86df2682013-07-21 20:41:14 -04001322EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001324static struct device *prev_device(struct klist_iter *i)
1325{
1326 struct klist_node *n = klist_prev(i);
1327 struct device *dev = NULL;
1328 struct device_private *p;
1329
1330 if (n) {
1331 p = to_device_private_parent(n);
1332 dev = p->device;
1333 }
1334 return dev;
1335}
1336
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001337static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001338{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001339 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001340 struct device *dev = NULL;
1341 struct device_private *p;
1342
1343 if (n) {
1344 p = to_device_private_parent(n);
1345 dev = p->device;
1346 }
1347 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001348}
1349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001351 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001352 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001353 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001354 * @uid: returned file owner
1355 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001356 * @tmp: possibly allocated string
1357 *
1358 * Return the relative path of a possible device node.
1359 * Non-default names may need to allocate a memory to compose
1360 * a name. This memory is returned in tmp and needs to be
1361 * freed by the caller.
1362 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001363const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001364 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001365 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001366{
1367 char *s;
1368
1369 *tmp = NULL;
1370
1371 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001372 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001373 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001374 if (*tmp)
1375 return *tmp;
1376
1377 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001378 if (dev->class && dev->class->devnode)
1379 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001380 if (*tmp)
1381 return *tmp;
1382
1383 /* return name without allocation, tmp == NULL */
1384 if (strchr(dev_name(dev), '!') == NULL)
1385 return dev_name(dev);
1386
1387 /* replace '!' in the name with '/' */
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001388 s = kstrdup(dev_name(dev), GFP_KERNEL);
1389 if (!s)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001390 return NULL;
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001391 strreplace(s, '!', '/');
1392 return *tmp = s;
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001393}
1394
1395/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001396 * device_for_each_child - device child iterator.
1397 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001398 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001399 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001401 * Iterate over @parent's child devices, and call @fn for each,
1402 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001404 * We check the return of @fn each time. If it returns anything
1405 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001407int device_for_each_child(struct device *parent, void *data,
1408 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001410 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001411 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 int error = 0;
1413
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001414 if (!parent->p)
1415 return 0;
1416
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001417 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001418 while ((child = next_device(&i)) && !error)
1419 error = fn(child, data);
1420 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return error;
1422}
David Graham White86df2682013-07-21 20:41:14 -04001423EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Cornelia Huck5ab69982006-11-16 15:42:07 +01001425/**
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001426 * device_for_each_child_reverse - device child iterator in reversed order.
1427 * @parent: parent struct device.
1428 * @fn: function to be called for each device.
1429 * @data: data for the callback.
1430 *
1431 * Iterate over @parent's child devices, and call @fn for each,
1432 * passing it @data.
1433 *
1434 * We check the return of @fn each time. If it returns anything
1435 * other than 0, we break out and return that value.
1436 */
1437int device_for_each_child_reverse(struct device *parent, void *data,
1438 int (*fn)(struct device *dev, void *data))
1439{
1440 struct klist_iter i;
1441 struct device *child;
1442 int error = 0;
1443
1444 if (!parent->p)
1445 return 0;
1446
1447 klist_iter_init(&parent->p->klist_children, &i);
1448 while ((child = prev_device(&i)) && !error)
1449 error = fn(child, data);
1450 klist_iter_exit(&i);
1451 return error;
1452}
1453EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
1454
1455/**
Cornelia Huck5ab69982006-11-16 15:42:07 +01001456 * device_find_child - device iterator for locating a particular device.
1457 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01001458 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001459 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01001460 *
1461 * This is similar to the device_for_each_child() function above, but it
1462 * returns a reference to a device that is 'found' for later use, as
1463 * determined by the @match callback.
1464 *
1465 * The callback should return 0 if the device doesn't match and non-zero
1466 * if it does. If the callback returns non-zero and a reference to the
1467 * current device can be obtained, this function will return to the caller
1468 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02001469 *
1470 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01001471 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001472struct device *device_find_child(struct device *parent, void *data,
1473 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001474{
1475 struct klist_iter i;
1476 struct device *child;
1477
1478 if (!parent)
1479 return NULL;
1480
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001481 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001482 while ((child = next_device(&i)))
1483 if (match(child, data) && get_device(child))
1484 break;
1485 klist_iter_exit(&i);
1486 return child;
1487}
David Graham White86df2682013-07-21 20:41:14 -04001488EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001489
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490int __init devices_init(void)
1491{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001492 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1493 if (!devices_kset)
1494 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001495 dev_kobj = kobject_create_and_add("dev", NULL);
1496 if (!dev_kobj)
1497 goto dev_kobj_err;
1498 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1499 if (!sysfs_dev_block_kobj)
1500 goto block_kobj_err;
1501 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1502 if (!sysfs_dev_char_kobj)
1503 goto char_kobj_err;
1504
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001505 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001506
1507 char_kobj_err:
1508 kobject_put(sysfs_dev_block_kobj);
1509 block_kobj_err:
1510 kobject_put(dev_kobj);
1511 dev_kobj_err:
1512 kset_unregister(devices_kset);
1513 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514}
1515
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001516static int device_check_offline(struct device *dev, void *not_used)
1517{
1518 int ret;
1519
1520 ret = device_for_each_child(dev, NULL, device_check_offline);
1521 if (ret)
1522 return ret;
1523
1524 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1525}
1526
1527/**
1528 * device_offline - Prepare the device for hot-removal.
1529 * @dev: Device to be put offline.
1530 *
1531 * Execute the device bus type's .offline() callback, if present, to prepare
1532 * the device for a subsequent hot-removal. If that succeeds, the device must
1533 * not be used until either it is removed or its bus type's .online() callback
1534 * is executed.
1535 *
1536 * Call under device_hotplug_lock.
1537 */
1538int device_offline(struct device *dev)
1539{
1540 int ret;
1541
1542 if (dev->offline_disabled)
1543 return -EPERM;
1544
1545 ret = device_for_each_child(dev, NULL, device_check_offline);
1546 if (ret)
1547 return ret;
1548
1549 device_lock(dev);
1550 if (device_supports_offline(dev)) {
1551 if (dev->offline) {
1552 ret = 1;
1553 } else {
1554 ret = dev->bus->offline(dev);
1555 if (!ret) {
1556 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1557 dev->offline = true;
1558 }
1559 }
1560 }
1561 device_unlock(dev);
1562
1563 return ret;
1564}
1565
1566/**
1567 * device_online - Put the device back online after successful device_offline().
1568 * @dev: Device to be put back online.
1569 *
1570 * If device_offline() has been successfully executed for @dev, but the device
1571 * has not been removed subsequently, execute its bus type's .online() callback
1572 * to indicate that the device can be used again.
1573 *
1574 * Call under device_hotplug_lock.
1575 */
1576int device_online(struct device *dev)
1577{
1578 int ret = 0;
1579
1580 device_lock(dev);
1581 if (device_supports_offline(dev)) {
1582 if (dev->offline) {
1583 ret = dev->bus->online(dev);
1584 if (!ret) {
1585 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1586 dev->offline = false;
1587 }
1588 } else {
1589 ret = 1;
1590 }
1591 }
1592 device_unlock(dev);
1593
1594 return ret;
1595}
1596
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001597struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001598 struct device dev;
1599 struct module *owner;
1600};
1601
Josh Triplett93058422012-11-18 21:27:55 -08001602static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001603{
1604 return container_of(d, struct root_device, dev);
1605}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001606
1607static void root_device_release(struct device *dev)
1608{
1609 kfree(to_root_device(dev));
1610}
1611
1612/**
1613 * __root_device_register - allocate and register a root device
1614 * @name: root device name
1615 * @owner: owner module of the root device, usually THIS_MODULE
1616 *
1617 * This function allocates a root device and registers it
1618 * using device_register(). In order to free the returned
1619 * device, use root_device_unregister().
1620 *
1621 * Root devices are dummy devices which allow other devices
1622 * to be grouped under /sys/devices. Use this function to
1623 * allocate a root device and then use it as the parent of
1624 * any device which should appear under /sys/devices/{name}
1625 *
1626 * The /sys/devices/{name} directory will also contain a
1627 * 'module' symlink which points to the @owner directory
1628 * in sysfs.
1629 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001630 * Returns &struct device pointer on success, or ERR_PTR() on error.
1631 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001632 * Note: You probably want to use root_device_register().
1633 */
1634struct device *__root_device_register(const char *name, struct module *owner)
1635{
1636 struct root_device *root;
1637 int err = -ENOMEM;
1638
1639 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1640 if (!root)
1641 return ERR_PTR(err);
1642
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001643 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001644 if (err) {
1645 kfree(root);
1646 return ERR_PTR(err);
1647 }
1648
1649 root->dev.release = root_device_release;
1650
1651 err = device_register(&root->dev);
1652 if (err) {
1653 put_device(&root->dev);
1654 return ERR_PTR(err);
1655 }
1656
Christoph Egger1d9e8822010-05-17 16:57:58 +02001657#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001658 if (owner) {
1659 struct module_kobject *mk = &owner->mkobj;
1660
1661 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1662 if (err) {
1663 device_unregister(&root->dev);
1664 return ERR_PTR(err);
1665 }
1666 root->owner = owner;
1667 }
1668#endif
1669
1670 return &root->dev;
1671}
1672EXPORT_SYMBOL_GPL(__root_device_register);
1673
1674/**
1675 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001676 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001677 *
1678 * This function unregisters and cleans up a device that was created by
1679 * root_device_register().
1680 */
1681void root_device_unregister(struct device *dev)
1682{
1683 struct root_device *root = to_root_device(dev);
1684
1685 if (root->owner)
1686 sysfs_remove_link(&root->dev.kobj, "module");
1687
1688 device_unregister(dev);
1689}
1690EXPORT_SYMBOL_GPL(root_device_unregister);
1691
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001692
1693static void device_create_release(struct device *dev)
1694{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001695 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001696 kfree(dev);
1697}
1698
Guenter Roeck39ef3112013-07-14 16:05:57 -07001699static struct device *
1700device_create_groups_vargs(struct class *class, struct device *parent,
1701 dev_t devt, void *drvdata,
1702 const struct attribute_group **groups,
1703 const char *fmt, va_list args)
1704{
1705 struct device *dev = NULL;
1706 int retval = -ENODEV;
1707
1708 if (class == NULL || IS_ERR(class))
1709 goto error;
1710
1711 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1712 if (!dev) {
1713 retval = -ENOMEM;
1714 goto error;
1715 }
1716
David Herrmannbbc780f2013-11-21 20:15:48 +01001717 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001718 dev->devt = devt;
1719 dev->class = class;
1720 dev->parent = parent;
1721 dev->groups = groups;
1722 dev->release = device_create_release;
1723 dev_set_drvdata(dev, drvdata);
1724
1725 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1726 if (retval)
1727 goto error;
1728
David Herrmannbbc780f2013-11-21 20:15:48 +01001729 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001730 if (retval)
1731 goto error;
1732
1733 return dev;
1734
1735error:
1736 put_device(dev);
1737 return ERR_PTR(retval);
1738}
1739
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001740/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001741 * device_create_vargs - creates a device and registers it with sysfs
1742 * @class: pointer to the struct class that this device should be registered to
1743 * @parent: pointer to the parent struct device of this new device, if any
1744 * @devt: the dev_t for the char device to be added
1745 * @drvdata: the data to be added to the device for callbacks
1746 * @fmt: string for the device's name
1747 * @args: va_list for the device's name
1748 *
1749 * This function can be used by char device classes. A struct device
1750 * will be created in sysfs, registered to the specified class.
1751 *
1752 * A "dev" file will be created, showing the dev_t for the device, if
1753 * the dev_t is not 0,0.
1754 * If a pointer to a parent struct device is passed in, the newly created
1755 * struct device will be a child of that device in sysfs.
1756 * The pointer to the struct device will be returned from the call.
1757 * Any further sysfs files that might be required can be created using this
1758 * pointer.
1759 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001760 * Returns &struct device pointer on success, or ERR_PTR() on error.
1761 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001762 * Note: the struct class passed to this function must have previously
1763 * been created with a call to class_create().
1764 */
1765struct device *device_create_vargs(struct class *class, struct device *parent,
1766 dev_t devt, void *drvdata, const char *fmt,
1767 va_list args)
1768{
Guenter Roeck39ef3112013-07-14 16:05:57 -07001769 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1770 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001771}
1772EXPORT_SYMBOL_GPL(device_create_vargs);
1773
1774/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001775 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001776 * @class: pointer to the struct class that this device should be registered to
1777 * @parent: pointer to the parent struct device of this new device, if any
1778 * @devt: the dev_t for the char device to be added
1779 * @drvdata: the data to be added to the device for callbacks
1780 * @fmt: string for the device's name
1781 *
1782 * This function can be used by char device classes. A struct device
1783 * will be created in sysfs, registered to the specified class.
1784 *
1785 * A "dev" file will be created, showing the dev_t for the device, if
1786 * the dev_t is not 0,0.
1787 * If a pointer to a parent struct device is passed in, the newly created
1788 * struct device will be a child of that device in sysfs.
1789 * The pointer to the struct device will be returned from the call.
1790 * Any further sysfs files that might be required can be created using this
1791 * pointer.
1792 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001793 * Returns &struct device pointer on success, or ERR_PTR() on error.
1794 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001795 * Note: the struct class passed to this function must have previously
1796 * been created with a call to class_create().
1797 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001798struct device *device_create(struct class *class, struct device *parent,
1799 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001800{
1801 va_list vargs;
1802 struct device *dev;
1803
1804 va_start(vargs, fmt);
1805 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1806 va_end(vargs);
1807 return dev;
1808}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001809EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001810
Guenter Roeck39ef3112013-07-14 16:05:57 -07001811/**
1812 * device_create_with_groups - creates a device and registers it with sysfs
1813 * @class: pointer to the struct class that this device should be registered to
1814 * @parent: pointer to the parent struct device of this new device, if any
1815 * @devt: the dev_t for the char device to be added
1816 * @drvdata: the data to be added to the device for callbacks
1817 * @groups: NULL-terminated list of attribute groups to be created
1818 * @fmt: string for the device's name
1819 *
1820 * This function can be used by char device classes. A struct device
1821 * will be created in sysfs, registered to the specified class.
1822 * Additional attributes specified in the groups parameter will also
1823 * be created automatically.
1824 *
1825 * A "dev" file will be created, showing the dev_t for the device, if
1826 * the dev_t is not 0,0.
1827 * If a pointer to a parent struct device is passed in, the newly created
1828 * struct device will be a child of that device in sysfs.
1829 * The pointer to the struct device will be returned from the call.
1830 * Any further sysfs files that might be required can be created using this
1831 * pointer.
1832 *
1833 * Returns &struct device pointer on success, or ERR_PTR() on error.
1834 *
1835 * Note: the struct class passed to this function must have previously
1836 * been created with a call to class_create().
1837 */
1838struct device *device_create_with_groups(struct class *class,
1839 struct device *parent, dev_t devt,
1840 void *drvdata,
1841 const struct attribute_group **groups,
1842 const char *fmt, ...)
1843{
1844 va_list vargs;
1845 struct device *dev;
1846
1847 va_start(vargs, fmt);
1848 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1849 fmt, vargs);
1850 va_end(vargs);
1851 return dev;
1852}
1853EXPORT_SYMBOL_GPL(device_create_with_groups);
1854
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001855static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001856{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001857 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001858
Dave Youngcd354492008-01-28 16:56:11 +08001859 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001860}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001861
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001862/**
1863 * device_destroy - removes a device that was created with device_create()
1864 * @class: pointer to the struct class that this device was registered with
1865 * @devt: the dev_t of the device that was previously registered
1866 *
1867 * This call unregisters and cleans up a device that was created with a
1868 * call to device_create().
1869 */
1870void device_destroy(struct class *class, dev_t devt)
1871{
1872 struct device *dev;
1873
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001874 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001875 if (dev) {
1876 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001877 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001878 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001879}
1880EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001881
1882/**
1883 * device_rename - renames a device
1884 * @dev: the pointer to the struct device to be renamed
1885 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001886 *
1887 * It is the responsibility of the caller to provide mutual
1888 * exclusion between two different calls of device_rename
1889 * on the same device to ensure that new_name is valid and
1890 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001891 *
Timur Tabia5462512010-12-13 14:08:52 -06001892 * Note: Don't call this function. Currently, the networking layer calls this
1893 * function, but that will change. The following text from Kay Sievers offers
1894 * some insight:
1895 *
1896 * Renaming devices is racy at many levels, symlinks and other stuff are not
1897 * replaced atomically, and you get a "move" uevent, but it's not easy to
1898 * connect the event to the old and new device. Device nodes are not renamed at
1899 * all, there isn't even support for that in the kernel now.
1900 *
1901 * In the meantime, during renaming, your target name might be taken by another
1902 * driver, creating conflicts. Or the old name is taken directly after you
1903 * renamed it -- then you get events for the same DEVPATH, before you even see
1904 * the "move" event. It's just a mess, and nothing new should ever rely on
1905 * kernel device renaming. Besides that, it's not even implemented now for
1906 * other things than (driver-core wise very simple) network devices.
1907 *
1908 * We are currently about to change network renaming in udev to completely
1909 * disallow renaming of devices in the same namespace as the kernel uses,
1910 * because we can't solve the problems properly, that arise with swapping names
1911 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1912 * be allowed to some other name than eth[0-9]*, for the aforementioned
1913 * reasons.
1914 *
1915 * Make up a "real" name in the driver before you register anything, or add
1916 * some other attributes for userspace to find the device, or use udev to add
1917 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1918 * don't even want to get into that and try to implement the missing pieces in
1919 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001920 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001921int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001922{
Tejun Heo4b30ee52013-09-11 22:29:06 -04001923 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001924 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001925 int error;
1926
1927 dev = get_device(dev);
1928 if (!dev)
1929 return -EINVAL;
1930
ethan.zhao69df7532013-10-13 22:12:35 +08001931 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001932
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001933 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001934 if (!old_device_name) {
1935 error = -ENOMEM;
1936 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001937 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001938
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001939 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04001940 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1941 kobj, old_device_name,
1942 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001943 if (error)
1944 goto out;
1945 }
Kay Sievers39aba962010-09-04 22:33:14 -07001946
Tejun Heo4b30ee52013-09-11 22:29:06 -04001947 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001948 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001949 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001950
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001951out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001952 put_device(dev);
1953
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001954 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001955
1956 return error;
1957}
Johannes Berga2807db2007-02-28 12:38:31 +01001958EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001959
1960static int device_move_class_links(struct device *dev,
1961 struct device *old_parent,
1962 struct device *new_parent)
1963{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001964 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001965
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001966 if (old_parent)
1967 sysfs_remove_link(&dev->kobj, "device");
1968 if (new_parent)
1969 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1970 "device");
1971 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001972}
1973
1974/**
1975 * device_move - moves a device to a new parent
1976 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001977 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001978 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001979 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001980int device_move(struct device *dev, struct device *new_parent,
1981 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001982{
1983 int error;
1984 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001985 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001986
1987 dev = get_device(dev);
1988 if (!dev)
1989 return -EINVAL;
1990
Cornelia Huckffa6a702009-03-04 12:44:00 +01001991 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001992 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001993 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001994
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001995 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1996 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001997 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001998 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001999 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01002000 put_device(new_parent);
2001 goto out;
2002 }
2003 old_parent = dev->parent;
2004 dev->parent = new_parent;
2005 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002006 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002007 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002008 klist_add_tail(&dev->p->knode_parent,
2009 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002010 set_dev_node(dev, dev_to_node(new_parent));
2011 }
2012
Rabin Vincentbdd40342012-04-23 09:16:36 +02002013 if (dev->class) {
2014 error = device_move_class_links(dev, old_parent, new_parent);
2015 if (error) {
2016 /* We ignore errors on cleanup since we're hosed anyway... */
2017 device_move_class_links(dev, new_parent, old_parent);
2018 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
2019 if (new_parent)
2020 klist_remove(&dev->p->knode_parent);
2021 dev->parent = old_parent;
2022 if (old_parent) {
2023 klist_add_tail(&dev->p->knode_parent,
2024 &old_parent->p->klist_children);
2025 set_dev_node(dev, dev_to_node(old_parent));
2026 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08002027 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002028 cleanup_glue_dir(dev, new_parent_kobj);
2029 put_device(new_parent);
2030 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01002031 }
Cornelia Huck8a824722006-11-20 17:07:51 +01002032 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01002033 switch (dpm_order) {
2034 case DPM_ORDER_NONE:
2035 break;
2036 case DPM_ORDER_DEV_AFTER_PARENT:
2037 device_pm_move_after(dev, new_parent);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002038 devices_kset_move_after(dev, new_parent);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002039 break;
2040 case DPM_ORDER_PARENT_BEFORE_DEV:
2041 device_pm_move_before(new_parent, dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002042 devices_kset_move_before(new_parent, dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002043 break;
2044 case DPM_ORDER_DEV_LAST:
2045 device_pm_move_last(dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002046 devices_kset_move_last(dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002047 break;
2048 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002049
Cornelia Huck8a824722006-11-20 17:07:51 +01002050 put_device(old_parent);
2051out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01002052 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002053 put_device(dev);
2054 return error;
2055}
Cornelia Huck8a824722006-11-20 17:07:51 +01002056EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002057
2058/**
2059 * device_shutdown - call ->shutdown() on each device to shutdown.
2060 */
2061void device_shutdown(void)
2062{
Benson Leungf123db82013-09-24 20:05:11 -07002063 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002064
Hugh Daschbach62458382010-03-22 10:36:37 -07002065 spin_lock(&devices_kset->list_lock);
2066 /*
2067 * Walk the devices list backward, shutting down each in turn.
2068 * Beware that device unplug events may also start pulling
2069 * devices offline, even as the system is shutting down.
2070 */
2071 while (!list_empty(&devices_kset->list)) {
2072 dev = list_entry(devices_kset->list.prev, struct device,
2073 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08002074
2075 /*
2076 * hold reference count of device's parent to
2077 * prevent it from being freed because parent's
2078 * lock is to be held
2079 */
Benson Leungf123db82013-09-24 20:05:11 -07002080 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002081 get_device(dev);
2082 /*
2083 * Make sure the device is off the kset list, in the
2084 * event that dev->*->shutdown() doesn't remove it.
2085 */
2086 list_del_init(&dev->kobj.entry);
2087 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01002088
Ming Leid1c6c032012-06-22 18:01:40 +08002089 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07002090 if (parent)
2091 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002092 device_lock(dev);
2093
Alan Sternfe6b91f2011-12-06 23:24:52 +01002094 /* Don't allow any more runtime suspends */
2095 pm_runtime_get_noresume(dev);
2096 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07002097
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002098 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002099 if (initcall_debug)
2100 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002101 dev->bus->shutdown(dev);
2102 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002103 if (initcall_debug)
2104 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002105 dev->driver->shutdown(dev);
2106 }
Ming Leid1c6c032012-06-22 18:01:40 +08002107
2108 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002109 if (parent)
2110 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002111
Hugh Daschbach62458382010-03-22 10:36:37 -07002112 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002113 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002114
2115 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002116 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002117 spin_unlock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002118}
Joe Perches99bcf212010-06-27 01:02:34 +00002119
2120/*
2121 * Device logging functions
2122 */
2123
2124#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002125static int
2126create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002127{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002128 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002129 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002130
Kay Sieversc4e00da2012-05-03 02:29:59 +02002131 if (dev->class)
2132 subsys = dev->class->name;
2133 else if (dev->bus)
2134 subsys = dev->bus->name;
2135 else
Joe Perches798efc62012-09-12 20:11:29 -07002136 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002137
Joe Perches798efc62012-09-12 20:11:29 -07002138 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Ben Hutchings655e5b72014-08-26 00:34:44 -07002139 if (pos >= hdrlen)
2140 goto overflow;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002141
2142 /*
2143 * Add device identifier DEVICE=:
2144 * b12:8 block dev_t
2145 * c127:3 char dev_t
2146 * n8 netdev ifindex
2147 * +sound:card0 subsystem:devname
2148 */
2149 if (MAJOR(dev->devt)) {
2150 char c;
2151
2152 if (strcmp(subsys, "block") == 0)
2153 c = 'b';
2154 else
2155 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002156 pos++;
2157 pos += snprintf(hdr + pos, hdrlen - pos,
2158 "DEVICE=%c%u:%u",
2159 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002160 } else if (strcmp(subsys, "net") == 0) {
2161 struct net_device *net = to_net_dev(dev);
2162
Joe Perches798efc62012-09-12 20:11:29 -07002163 pos++;
2164 pos += snprintf(hdr + pos, hdrlen - pos,
2165 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002166 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002167 pos++;
2168 pos += snprintf(hdr + pos, hdrlen - pos,
2169 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002170 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002171
Ben Hutchings655e5b72014-08-26 00:34:44 -07002172 if (pos >= hdrlen)
2173 goto overflow;
2174
Joe Perches798efc62012-09-12 20:11:29 -07002175 return pos;
Ben Hutchings655e5b72014-08-26 00:34:44 -07002176
2177overflow:
2178 dev_WARN(dev, "device/subsystem name too long");
2179 return 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002180}
Joe Perches798efc62012-09-12 20:11:29 -07002181
Joe Perches05e4e5b2012-09-12 20:13:37 -07002182int dev_vprintk_emit(int level, const struct device *dev,
2183 const char *fmt, va_list args)
2184{
2185 char hdr[128];
2186 size_t hdrlen;
2187
2188 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2189
2190 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2191}
2192EXPORT_SYMBOL(dev_vprintk_emit);
2193
2194int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2195{
2196 va_list args;
2197 int r;
2198
2199 va_start(args, fmt);
2200
2201 r = dev_vprintk_emit(level, dev, fmt, args);
2202
2203 va_end(args);
2204
2205 return r;
2206}
2207EXPORT_SYMBOL(dev_printk_emit);
2208
Joe Perchesd1f10522014-12-25 15:07:04 -08002209static void __dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -07002210 struct va_format *vaf)
2211{
Joe Perchesd1f10522014-12-25 15:07:04 -08002212 if (dev)
2213 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2214 dev_driver_string(dev), dev_name(dev), vaf);
2215 else
2216 printk("%s(NULL device *): %pV", level, vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002217}
Joe Perches99bcf212010-06-27 01:02:34 +00002218
Joe Perchesd1f10522014-12-25 15:07:04 -08002219void dev_printk(const char *level, const struct device *dev,
2220 const char *fmt, ...)
Joe Perches99bcf212010-06-27 01:02:34 +00002221{
2222 struct va_format vaf;
2223 va_list args;
Joe Perches99bcf212010-06-27 01:02:34 +00002224
2225 va_start(args, fmt);
2226
2227 vaf.fmt = fmt;
2228 vaf.va = &args;
2229
Joe Perchesd1f10522014-12-25 15:07:04 -08002230 __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002231
Joe Perches99bcf212010-06-27 01:02:34 +00002232 va_end(args);
Joe Perches99bcf212010-06-27 01:02:34 +00002233}
2234EXPORT_SYMBOL(dev_printk);
2235
2236#define define_dev_printk_level(func, kern_level) \
Joe Perchesd1f10522014-12-25 15:07:04 -08002237void func(const struct device *dev, const char *fmt, ...) \
Joe Perches99bcf212010-06-27 01:02:34 +00002238{ \
2239 struct va_format vaf; \
2240 va_list args; \
Joe Perches99bcf212010-06-27 01:02:34 +00002241 \
2242 va_start(args, fmt); \
2243 \
2244 vaf.fmt = fmt; \
2245 vaf.va = &args; \
2246 \
Joe Perchesd1f10522014-12-25 15:07:04 -08002247 __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002248 \
Joe Perches99bcf212010-06-27 01:02:34 +00002249 va_end(args); \
Joe Perches99bcf212010-06-27 01:02:34 +00002250} \
2251EXPORT_SYMBOL(func);
2252
2253define_dev_printk_level(dev_emerg, KERN_EMERG);
2254define_dev_printk_level(dev_alert, KERN_ALERT);
2255define_dev_printk_level(dev_crit, KERN_CRIT);
2256define_dev_printk_level(dev_err, KERN_ERR);
2257define_dev_printk_level(dev_warn, KERN_WARNING);
2258define_dev_printk_level(dev_notice, KERN_NOTICE);
2259define_dev_printk_level(_dev_info, KERN_INFO);
2260
2261#endif
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002262
2263static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2264{
2265 return fwnode && !IS_ERR(fwnode->secondary);
2266}
2267
2268/**
2269 * set_primary_fwnode - Change the primary firmware node of a given device.
2270 * @dev: Device to handle.
2271 * @fwnode: New primary firmware node of the device.
2272 *
2273 * Set the device's firmware node pointer to @fwnode, but if a secondary
2274 * firmware node of the device is present, preserve it.
2275 */
2276void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2277{
2278 if (fwnode) {
2279 struct fwnode_handle *fn = dev->fwnode;
2280
2281 if (fwnode_is_primary(fn))
2282 fn = fn->secondary;
2283
Mika Westerberg55f89a82015-11-30 17:11:39 +02002284 if (fn) {
2285 WARN_ON(fwnode->secondary);
2286 fwnode->secondary = fn;
2287 }
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002288 dev->fwnode = fwnode;
2289 } else {
2290 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2291 dev->fwnode->secondary : NULL;
2292 }
2293}
2294EXPORT_SYMBOL_GPL(set_primary_fwnode);
2295
2296/**
2297 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2298 * @dev: Device to handle.
2299 * @fwnode: New secondary firmware node of the device.
2300 *
2301 * If a primary firmware node of the device is present, set its secondary
2302 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2303 * @fwnode.
2304 */
2305void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2306{
2307 if (fwnode)
2308 fwnode->secondary = ERR_PTR(-ENODEV);
2309
2310 if (fwnode_is_primary(dev->fwnode))
2311 dev->fwnode->secondary = fwnode;
2312 else
2313 dev->fwnode = fwnode;
2314}