blob: 67b180d855b2c7baf365e5174802581b3c766745 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/base/core.c - core driver model code (device registration, etc)
3 *
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -07006 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2
10 *
11 */
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/device.h>
14#include <linux/err.h>
15#include <linux/init.h>
16#include <linux/module.h>
17#include <linux/slab.h>
18#include <linux/string.h>
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -070019#include <linux/kdev_t.h>
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100020#include <linux/notifier.h>
Grant Likely07d57a32012-02-01 11:22:22 -070021#include <linux/of.h>
22#include <linux/of_device.h>
Kay Sieversda231fd2007-11-21 17:29:15 +010023#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080024#include <linux/kallsyms.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070025#include <linux/mutex.h>
Shaohua Li401097e2009-05-12 13:37:57 -070026#include <linux/async.h>
Peter Chenaf8db152011-11-15 21:52:29 +010027#include <linux/pm_runtime.h>
Kay Sieversc4e00da2012-05-03 02:29:59 +020028#include <linux/netdevice.h>
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)
494 goto err_remove_type_groups;
495 }
496
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500497 return 0;
498
499 err_remove_type_groups:
500 if (type)
501 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700502 err_remove_class_groups:
503 if (class)
504 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500505
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700506 return error;
507}
508
509static void device_remove_attrs(struct device *dev)
510{
511 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700512 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700513
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700514 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500515 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200516
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500517 if (type)
518 device_remove_groups(dev, type->groups);
519
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700520 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700521 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700522}
523
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700524static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700525 char *buf)
526{
527 return print_dev_t(buf, dev->devt);
528}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700529static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900530
Kay Sieversca22e562011-12-14 14:29:38 -0800531/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600532struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800535 * device_create_file - create sysfs attribute file for device.
536 * @dev: device.
537 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200539int device_create_file(struct device *dev,
540 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
542 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200543
544 if (dev) {
545 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800546 "Attribute %s: write permission without 'store'\n",
547 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200548 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800549 "Attribute %s: read permission without 'show'\n",
550 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200552 }
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return error;
555}
David Graham White86df2682013-07-21 20:41:14 -0400556EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
558/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800559 * device_remove_file - remove sysfs attribute file.
560 * @dev: device.
561 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200563void device_remove_file(struct device *dev,
564 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100566 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
David Graham White86df2682013-07-21 20:41:14 -0400569EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700571/**
572 * device_create_bin_file - create sysfs binary attribute file for device.
573 * @dev: device.
574 * @attr: device binary attribute descriptor.
575 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200576int device_create_bin_file(struct device *dev,
577 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700578{
579 int error = -EINVAL;
580 if (dev)
581 error = sysfs_create_bin_file(&dev->kobj, attr);
582 return error;
583}
584EXPORT_SYMBOL_GPL(device_create_bin_file);
585
586/**
587 * device_remove_bin_file - remove sysfs binary attribute file
588 * @dev: device.
589 * @attr: device binary attribute descriptor.
590 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200591void device_remove_bin_file(struct device *dev,
592 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700593{
594 if (dev)
595 sysfs_remove_bin_file(&dev->kobj, attr);
596}
597EXPORT_SYMBOL_GPL(device_remove_bin_file);
598
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400599/**
Alan Stern523ded72007-04-26 00:12:04 -0700600 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400601 * @dev: device.
602 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700603 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400604 *
605 * Attribute methods must not unregister themselves or their parent device
606 * (which would amount to the same thing). Attempts to do so will deadlock,
607 * since unregistration is mutually exclusive with driver callbacks.
608 *
609 * Instead methods can call this routine, which will attempt to allocate
610 * and schedule a workqueue request to call back @func with @dev as its
611 * argument in the workqueue's process context. @dev will be pinned until
612 * @func returns.
613 *
Alan Stern523ded72007-04-26 00:12:04 -0700614 * This routine is usually called via the inline device_schedule_callback(),
615 * which automatically sets @owner to THIS_MODULE.
616 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400617 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700618 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400619 *
620 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
621 * underlying sysfs routine (since it is intended for use by attribute
622 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
623 */
Alan Stern523ded72007-04-26 00:12:04 -0700624int device_schedule_callback_owner(struct device *dev,
625 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400626{
627 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700628 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400629}
Alan Stern523ded72007-04-26 00:12:04 -0700630EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400631
James Bottomley34bb61f2005-09-06 16:56:51 -0700632static void klist_children_get(struct klist_node *n)
633{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800634 struct device_private *p = to_device_private_parent(n);
635 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700636
637 get_device(dev);
638}
639
640static void klist_children_put(struct klist_node *n)
641{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800642 struct device_private *p = to_device_private_parent(n);
643 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700644
645 put_device(dev);
646}
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800649 * device_initialize - init device structure.
650 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 *
Cornelia Huck57394112008-09-03 18:26:40 +0200652 * This prepares the device for use by other layers by initializing
653 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800654 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200655 * that function, though it can also be called separately, so one
656 * may use @dev's fields. In particular, get_device()/put_device()
657 * may be used for reference counting of @dev after calling this
658 * function.
659 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500660 * All fields in @dev must be initialized by the caller to 0, except
661 * for those explicitly set to some other value. The simplest
662 * approach is to use kzalloc() to allocate the structure containing
663 * @dev.
664 *
Cornelia Huck57394112008-09-03 18:26:40 +0200665 * NOTE: Use put_device() to give up your reference instead of freeing
666 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668void device_initialize(struct device *dev)
669{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600670 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700671 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000673 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100674 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900675 spin_lock_init(&dev->devres_lock);
676 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400677 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800678 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679}
David Graham White86df2682013-07-21 20:41:14 -0400680EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Tejun Heod73ce002013-03-12 11:30:05 -0700682struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700683{
Kay Sievers86406242007-03-14 03:25:56 +0100684 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700685
Kay Sievers86406242007-03-14 03:25:56 +0100686 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800687 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600688 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700689
Kay Sievers86406242007-03-14 03:25:56 +0100690 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700691}
692
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700693struct class_dir {
694 struct kobject kobj;
695 struct class *class;
696};
697
698#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
699
700static void class_dir_release(struct kobject *kobj)
701{
702 struct class_dir *dir = to_class_dir(kobj);
703 kfree(dir);
704}
705
706static const
707struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
708{
709 struct class_dir *dir = to_class_dir(kobj);
710 return dir->class->ns_type;
711}
712
713static struct kobj_type class_dir_ktype = {
714 .release = class_dir_release,
715 .sysfs_ops = &kobj_sysfs_ops,
716 .child_ns_type = class_dir_child_ns_type
717};
718
719static struct kobject *
720class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
721{
722 struct class_dir *dir;
723 int retval;
724
725 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
726 if (!dir)
727 return NULL;
728
729 dir->class = class;
730 kobject_init(&dir->kobj, &class_dir_ktype);
731
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100732 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700733
734 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
735 if (retval < 0) {
736 kobject_put(&dir->kobj);
737 return NULL;
738 }
739 return &dir->kobj;
740}
741
742
Kay Sieversda231fd2007-11-21 17:29:15 +0100743static struct kobject *get_device_parent(struct device *dev,
744 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100745{
Kay Sievers86406242007-03-14 03:25:56 +0100746 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900747 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100748 struct kobject *kobj = NULL;
749 struct kobject *parent_kobj;
750 struct kobject *k;
751
Randy Dunlapead454f2010-09-24 14:36:49 -0700752#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700753 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200754 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700755 if (parent && parent->class == &block_class)
756 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100757 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700758 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700759#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200760
Kay Sievers86406242007-03-14 03:25:56 +0100761 /*
762 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100763 * Class-devices with a non class-device as parent, live
764 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100765 */
766 if (parent == NULL)
767 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700768 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100769 return &parent->kobj;
770 else
771 parent_kobj = &parent->kobj;
772
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900773 mutex_lock(&gdp_mutex);
774
Kay Sievers86406242007-03-14 03:25:56 +0100775 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100776 spin_lock(&dev->class->p->glue_dirs.list_lock);
777 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100778 if (k->parent == parent_kobj) {
779 kobj = kobject_get(k);
780 break;
781 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100782 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900783 if (kobj) {
784 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100785 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900786 }
Kay Sievers86406242007-03-14 03:25:56 +0100787
788 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700789 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100790 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900791 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800792 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100793 }
794
Kay Sieversca22e562011-12-14 14:29:38 -0800795 /* subsystems can specify a default root directory for their devices */
796 if (!parent && dev->bus && dev->bus->dev_root)
797 return &dev->bus->dev_root->kobj;
798
Kay Sievers86406242007-03-14 03:25:56 +0100799 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100800 return &parent->kobj;
801 return NULL;
802}
Kay Sieversda231fd2007-11-21 17:29:15 +0100803
Cornelia Huck63b69712008-01-21 16:09:44 +0100804static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100805{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100806 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100807 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100808 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100809 return;
810
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100811 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100812}
Cornelia Huck63b69712008-01-21 16:09:44 +0100813
814static void cleanup_device_parent(struct device *dev)
815{
816 cleanup_glue_dir(dev, dev->kobj.parent);
817}
Kay Sievers86406242007-03-14 03:25:56 +0100818
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700819static int device_add_class_symlinks(struct device *dev)
820{
821 int error;
822
823 if (!dev->class)
824 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100825
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700826 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100827 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700828 "subsystem");
829 if (error)
830 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100831
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800832 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700833 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
834 "device");
835 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700836 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700837 }
Kay Sievers39aba962010-09-04 22:33:14 -0700838
Randy Dunlapead454f2010-09-24 14:36:49 -0700839#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700840 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200841 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700842 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700843#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700844
845 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100846 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700847 &dev->kobj, dev_name(dev));
848 if (error)
849 goto out_device;
850
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700851 return 0;
852
Kay Sievers39aba962010-09-04 22:33:14 -0700853out_device:
854 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100855
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700856out_subsys:
857 sysfs_remove_link(&dev->kobj, "subsystem");
858out:
859 return error;
860}
861
862static void device_remove_class_symlinks(struct device *dev)
863{
864 if (!dev->class)
865 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100866
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800867 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100868 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700869 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700870#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200871 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700872 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700873#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100874 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700875}
876
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000878 * dev_set_name - set a device name
879 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700880 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000881 */
882int dev_set_name(struct device *dev, const char *fmt, ...)
883{
884 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100885 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000886
887 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100888 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000889 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100890 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000891}
892EXPORT_SYMBOL_GPL(dev_set_name);
893
894/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700895 * device_to_dev_kobj - select a /sys/dev/ directory for the device
896 * @dev: device
897 *
898 * By default we select char/ for new entries. Setting class->dev_obj
899 * to NULL prevents an entry from being created. class->dev_kobj must
900 * be set (or cleared) before any devices are registered to the class
901 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200902 * device_remove_sys_dev_entry() will disagree about the presence of
903 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700904 */
905static struct kobject *device_to_dev_kobj(struct device *dev)
906{
907 struct kobject *kobj;
908
909 if (dev->class)
910 kobj = dev->class->dev_kobj;
911 else
912 kobj = sysfs_dev_char_kobj;
913
914 return kobj;
915}
916
917static int device_create_sys_dev_entry(struct device *dev)
918{
919 struct kobject *kobj = device_to_dev_kobj(dev);
920 int error = 0;
921 char devt_str[15];
922
923 if (kobj) {
924 format_dev_t(devt_str, dev->devt);
925 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
926 }
927
928 return error;
929}
930
931static void device_remove_sys_dev_entry(struct device *dev)
932{
933 struct kobject *kobj = device_to_dev_kobj(dev);
934 char devt_str[15];
935
936 if (kobj) {
937 format_dev_t(devt_str, dev->devt);
938 sysfs_remove_link(kobj, devt_str);
939 }
940}
941
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700942int device_private_init(struct device *dev)
943{
944 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
945 if (!dev->p)
946 return -ENOMEM;
947 dev->p->device = dev;
948 klist_init(&dev->p->klist_children, klist_children_get,
949 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800950 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700951 return 0;
952}
953
Dan Williamse105b8b2008-04-21 10:51:07 -0700954/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800955 * device_add - add device to device hierarchy.
956 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800958 * This is part 2 of device_register(), though may be called
959 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 *
Cornelia Huck57394112008-09-03 18:26:40 +0200961 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800962 * to the global and sibling lists for the device, then
963 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200964 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500965 * Do not call this routine or device_register() more than once for
966 * any device structure. The driver model core is not designed to work
967 * with devices that get unregistered and then spring back to life.
968 * (Among other things, it's very hard to guarantee that all references
969 * to the previous incarnation of @dev have been dropped.) Allocate
970 * and register a fresh new struct device instead.
971 *
Cornelia Huck57394112008-09-03 18:26:40 +0200972 * NOTE: _Never_ directly free @dev after calling this function, even
973 * if it returned an error! Always use put_device() to give up your
974 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 */
976int device_add(struct device *dev)
977{
978 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800979 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200980 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700981 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700984 if (!dev)
985 goto done;
986
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800987 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700988 error = device_private_init(dev);
989 if (error)
990 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800991 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800992
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100993 /*
994 * for statically allocated devices, which should all be converted
995 * some day, we need to initialize the name. We prevent reading back
996 * the name, and force the use of dev_name()
997 */
998 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700999 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001000 dev->init_name = NULL;
1001 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001002
Kay Sieversca22e562011-12-14 14:29:38 -08001003 /* subsystems can specify simple device enumeration */
1004 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1005 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1006
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001007 if (!dev_name(dev)) {
1008 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001009 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001010 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001012 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001015 kobj = get_device_parent(dev, parent);
1016 if (kobj)
1017 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
Yinghai Lu0d358f22008-02-19 03:20:41 -08001019 /* use parent numa_node */
1020 if (parent)
1021 set_dev_node(dev, dev_to_node(parent));
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001024 /* we require the name to be set before, and pass NULL */
1025 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001026 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001028
Brian Walsh37022642006-08-14 22:43:19 -07001029 /* notify platform of device entry */
1030 if (platform_notify)
1031 platform_notify(dev);
1032
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001033 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001034 if (error)
1035 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001036
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001037 if (MAJOR(dev->devt)) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001038 error = device_create_file(dev, &dev_attr_dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001039 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001040 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001041
1042 error = device_create_sys_dev_entry(dev);
1043 if (error)
1044 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001045
1046 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001047 }
1048
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001049 error = device_add_class_symlinks(dev);
1050 if (error)
1051 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001052 error = device_add_attrs(dev);
1053 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001054 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001055 error = bus_add_device(dev);
1056 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001058 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001059 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001060 goto DPMError;
1061 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001062
1063 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001064 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001065 */
1066 if (dev->bus)
1067 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1068 BUS_NOTIFY_ADD_DEVICE, dev);
1069
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001070 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001071 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001073 klist_add_tail(&dev->p->knode_parent,
1074 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001076 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001077 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001078 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001079 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001080 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001081
1082 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001083 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001084 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001085 if (class_intf->add_dev)
1086 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001087 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001088 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001089done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 put_device(dev);
1091 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001092 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001093 bus_remove_device(dev);
1094 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001095 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001096 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001097 device_remove_class_symlinks(dev);
1098 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001099 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001100 devtmpfs_delete_node(dev);
1101 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001102 device_remove_sys_dev_entry(dev);
1103 devtattrError:
1104 if (MAJOR(dev->devt))
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001105 device_remove_file(dev, &dev_attr_dev);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001106 ueventattrError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001107 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001108 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001109 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 kobject_del(&dev->kobj);
1111 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001112 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 if (parent)
1114 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001115name_error:
1116 kfree(dev->p);
1117 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001118 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119}
David Graham White86df2682013-07-21 20:41:14 -04001120EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001123 * device_register - register a device with the system.
1124 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001126 * This happens in two clean steps - initialize the device
1127 * and add it to the system. The two steps can be called
1128 * separately, but this is the easiest and most common.
1129 * I.e. you should only call the two helpers separately if
1130 * have a clearly defined need to use and refcount the device
1131 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001132 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001133 * For more information, see the kerneldoc for device_initialize()
1134 * and device_add().
1135 *
Cornelia Huck57394112008-09-03 18:26:40 +02001136 * NOTE: _Never_ directly free @dev after calling this function, even
1137 * if it returned an error! Always use put_device() to give up the
1138 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140int device_register(struct device *dev)
1141{
1142 device_initialize(dev);
1143 return device_add(dev);
1144}
David Graham White86df2682013-07-21 20:41:14 -04001145EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001148 * get_device - increment reference count for device.
1149 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001151 * This simply forwards the call to kobject_get(), though
1152 * we do take care to provide for the case that we get a NULL
1153 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001155struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001157 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
David Graham White86df2682013-07-21 20:41:14 -04001159EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001162 * put_device - decrement reference count.
1163 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001165void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001167 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 if (dev)
1169 kobject_put(&dev->kobj);
1170}
David Graham White86df2682013-07-21 20:41:14 -04001171EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001174 * device_del - delete device from system.
1175 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001177 * This is the first part of the device unregistration
1178 * sequence. This removes the device from the lists we control
1179 * from here, has it removed from the other driver model
1180 * subsystems it was added to in device_add(), and removes it
1181 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001183 * NOTE: this should be called manually _iff_ device_add() was
1184 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001186void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001188 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001189 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Alan Sternec0676ee2008-12-05 14:10:31 -05001191 /* Notify clients of device removal. This call must come
1192 * before dpm_sysfs_remove().
1193 */
1194 if (dev->bus)
1195 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1196 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001197 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001199 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001200 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001201 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001202 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001203 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001204 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001205 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001206 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001207
Kay Sieversca22e562011-12-14 14:29:38 -08001208 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001209 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001210 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001211 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001212 if (class_intf->remove_dev)
1213 class_intf->remove_dev(dev, class_intf);
1214 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001215 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001216 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001217 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001218 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001219 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001220 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001221 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001222 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
1224 /* Notify the platform of the removal, in case they
1225 * need to do anything...
1226 */
1227 if (platform_notify_remove)
1228 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001229 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001230 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001232 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233}
David Graham White86df2682013-07-21 20:41:14 -04001234EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
1236/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001237 * device_unregister - unregister device from system.
1238 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001240 * We do this in two parts, like we do device_register(). First,
1241 * we remove it from all the subsystems with device_del(), then
1242 * we decrement the reference count via put_device(). If that
1243 * is the final reference count, the device will be cleaned up
1244 * via device_release() above. Otherwise, the structure will
1245 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001247void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001249 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 device_del(dev);
1251 put_device(dev);
1252}
David Graham White86df2682013-07-21 20:41:14 -04001253EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001255static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001256{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001257 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001258 struct device *dev = NULL;
1259 struct device_private *p;
1260
1261 if (n) {
1262 p = to_device_private_parent(n);
1263 dev = p->device;
1264 }
1265 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001266}
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001269 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001270 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001271 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001272 * @uid: returned file owner
1273 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001274 * @tmp: possibly allocated string
1275 *
1276 * Return the relative path of a possible device node.
1277 * Non-default names may need to allocate a memory to compose
1278 * a name. This memory is returned in tmp and needs to be
1279 * freed by the caller.
1280 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001281const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001282 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001283 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001284{
1285 char *s;
1286
1287 *tmp = NULL;
1288
1289 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001290 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001291 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001292 if (*tmp)
1293 return *tmp;
1294
1295 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001296 if (dev->class && dev->class->devnode)
1297 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001298 if (*tmp)
1299 return *tmp;
1300
1301 /* return name without allocation, tmp == NULL */
1302 if (strchr(dev_name(dev), '!') == NULL)
1303 return dev_name(dev);
1304
1305 /* replace '!' in the name with '/' */
1306 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1307 if (!*tmp)
1308 return NULL;
1309 while ((s = strchr(*tmp, '!')))
1310 s[0] = '/';
1311 return *tmp;
1312}
1313
1314/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001315 * device_for_each_child - device child iterator.
1316 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001317 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001318 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001320 * Iterate over @parent's child devices, and call @fn for each,
1321 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001323 * We check the return of @fn each time. If it returns anything
1324 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001326int device_for_each_child(struct device *parent, void *data,
1327 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001329 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001330 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 int error = 0;
1332
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001333 if (!parent->p)
1334 return 0;
1335
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001336 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001337 while ((child = next_device(&i)) && !error)
1338 error = fn(child, data);
1339 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 return error;
1341}
David Graham White86df2682013-07-21 20:41:14 -04001342EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
Cornelia Huck5ab69982006-11-16 15:42:07 +01001344/**
1345 * device_find_child - device iterator for locating a particular device.
1346 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01001347 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001348 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01001349 *
1350 * This is similar to the device_for_each_child() function above, but it
1351 * returns a reference to a device that is 'found' for later use, as
1352 * determined by the @match callback.
1353 *
1354 * The callback should return 0 if the device doesn't match and non-zero
1355 * if it does. If the callback returns non-zero and a reference to the
1356 * current device can be obtained, this function will return to the caller
1357 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02001358 *
1359 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01001360 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001361struct device *device_find_child(struct device *parent, void *data,
1362 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001363{
1364 struct klist_iter i;
1365 struct device *child;
1366
1367 if (!parent)
1368 return NULL;
1369
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001370 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001371 while ((child = next_device(&i)))
1372 if (match(child, data) && get_device(child))
1373 break;
1374 klist_iter_exit(&i);
1375 return child;
1376}
David Graham White86df2682013-07-21 20:41:14 -04001377EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001378
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379int __init devices_init(void)
1380{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001381 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1382 if (!devices_kset)
1383 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001384 dev_kobj = kobject_create_and_add("dev", NULL);
1385 if (!dev_kobj)
1386 goto dev_kobj_err;
1387 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1388 if (!sysfs_dev_block_kobj)
1389 goto block_kobj_err;
1390 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1391 if (!sysfs_dev_char_kobj)
1392 goto char_kobj_err;
1393
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001394 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001395
1396 char_kobj_err:
1397 kobject_put(sysfs_dev_block_kobj);
1398 block_kobj_err:
1399 kobject_put(dev_kobj);
1400 dev_kobj_err:
1401 kset_unregister(devices_kset);
1402 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403}
1404
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001405static int device_check_offline(struct device *dev, void *not_used)
1406{
1407 int ret;
1408
1409 ret = device_for_each_child(dev, NULL, device_check_offline);
1410 if (ret)
1411 return ret;
1412
1413 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1414}
1415
1416/**
1417 * device_offline - Prepare the device for hot-removal.
1418 * @dev: Device to be put offline.
1419 *
1420 * Execute the device bus type's .offline() callback, if present, to prepare
1421 * the device for a subsequent hot-removal. If that succeeds, the device must
1422 * not be used until either it is removed or its bus type's .online() callback
1423 * is executed.
1424 *
1425 * Call under device_hotplug_lock.
1426 */
1427int device_offline(struct device *dev)
1428{
1429 int ret;
1430
1431 if (dev->offline_disabled)
1432 return -EPERM;
1433
1434 ret = device_for_each_child(dev, NULL, device_check_offline);
1435 if (ret)
1436 return ret;
1437
1438 device_lock(dev);
1439 if (device_supports_offline(dev)) {
1440 if (dev->offline) {
1441 ret = 1;
1442 } else {
1443 ret = dev->bus->offline(dev);
1444 if (!ret) {
1445 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1446 dev->offline = true;
1447 }
1448 }
1449 }
1450 device_unlock(dev);
1451
1452 return ret;
1453}
1454
1455/**
1456 * device_online - Put the device back online after successful device_offline().
1457 * @dev: Device to be put back online.
1458 *
1459 * If device_offline() has been successfully executed for @dev, but the device
1460 * has not been removed subsequently, execute its bus type's .online() callback
1461 * to indicate that the device can be used again.
1462 *
1463 * Call under device_hotplug_lock.
1464 */
1465int device_online(struct device *dev)
1466{
1467 int ret = 0;
1468
1469 device_lock(dev);
1470 if (device_supports_offline(dev)) {
1471 if (dev->offline) {
1472 ret = dev->bus->online(dev);
1473 if (!ret) {
1474 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1475 dev->offline = false;
1476 }
1477 } else {
1478 ret = 1;
1479 }
1480 }
1481 device_unlock(dev);
1482
1483 return ret;
1484}
1485
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001486struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001487 struct device dev;
1488 struct module *owner;
1489};
1490
Josh Triplett93058422012-11-18 21:27:55 -08001491static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001492{
1493 return container_of(d, struct root_device, dev);
1494}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001495
1496static void root_device_release(struct device *dev)
1497{
1498 kfree(to_root_device(dev));
1499}
1500
1501/**
1502 * __root_device_register - allocate and register a root device
1503 * @name: root device name
1504 * @owner: owner module of the root device, usually THIS_MODULE
1505 *
1506 * This function allocates a root device and registers it
1507 * using device_register(). In order to free the returned
1508 * device, use root_device_unregister().
1509 *
1510 * Root devices are dummy devices which allow other devices
1511 * to be grouped under /sys/devices. Use this function to
1512 * allocate a root device and then use it as the parent of
1513 * any device which should appear under /sys/devices/{name}
1514 *
1515 * The /sys/devices/{name} directory will also contain a
1516 * 'module' symlink which points to the @owner directory
1517 * in sysfs.
1518 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001519 * Returns &struct device pointer on success, or ERR_PTR() on error.
1520 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001521 * Note: You probably want to use root_device_register().
1522 */
1523struct device *__root_device_register(const char *name, struct module *owner)
1524{
1525 struct root_device *root;
1526 int err = -ENOMEM;
1527
1528 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1529 if (!root)
1530 return ERR_PTR(err);
1531
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001532 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001533 if (err) {
1534 kfree(root);
1535 return ERR_PTR(err);
1536 }
1537
1538 root->dev.release = root_device_release;
1539
1540 err = device_register(&root->dev);
1541 if (err) {
1542 put_device(&root->dev);
1543 return ERR_PTR(err);
1544 }
1545
Christoph Egger1d9e8822010-05-17 16:57:58 +02001546#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001547 if (owner) {
1548 struct module_kobject *mk = &owner->mkobj;
1549
1550 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1551 if (err) {
1552 device_unregister(&root->dev);
1553 return ERR_PTR(err);
1554 }
1555 root->owner = owner;
1556 }
1557#endif
1558
1559 return &root->dev;
1560}
1561EXPORT_SYMBOL_GPL(__root_device_register);
1562
1563/**
1564 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001565 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001566 *
1567 * This function unregisters and cleans up a device that was created by
1568 * root_device_register().
1569 */
1570void root_device_unregister(struct device *dev)
1571{
1572 struct root_device *root = to_root_device(dev);
1573
1574 if (root->owner)
1575 sysfs_remove_link(&root->dev.kobj, "module");
1576
1577 device_unregister(dev);
1578}
1579EXPORT_SYMBOL_GPL(root_device_unregister);
1580
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001581
1582static void device_create_release(struct device *dev)
1583{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001584 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001585 kfree(dev);
1586}
1587
Guenter Roeck39ef3112013-07-14 16:05:57 -07001588static struct device *
1589device_create_groups_vargs(struct class *class, struct device *parent,
1590 dev_t devt, void *drvdata,
1591 const struct attribute_group **groups,
1592 const char *fmt, va_list args)
1593{
1594 struct device *dev = NULL;
1595 int retval = -ENODEV;
1596
1597 if (class == NULL || IS_ERR(class))
1598 goto error;
1599
1600 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1601 if (!dev) {
1602 retval = -ENOMEM;
1603 goto error;
1604 }
1605
1606 dev->devt = devt;
1607 dev->class = class;
1608 dev->parent = parent;
1609 dev->groups = groups;
1610 dev->release = device_create_release;
1611 dev_set_drvdata(dev, drvdata);
1612
1613 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1614 if (retval)
1615 goto error;
1616
1617 retval = device_register(dev);
1618 if (retval)
1619 goto error;
1620
1621 return dev;
1622
1623error:
1624 put_device(dev);
1625 return ERR_PTR(retval);
1626}
1627
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001628/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001629 * device_create_vargs - creates a device and registers it with sysfs
1630 * @class: pointer to the struct class that this device should be registered to
1631 * @parent: pointer to the parent struct device of this new device, if any
1632 * @devt: the dev_t for the char device to be added
1633 * @drvdata: the data to be added to the device for callbacks
1634 * @fmt: string for the device's name
1635 * @args: va_list for the device's name
1636 *
1637 * This function can be used by char device classes. A struct device
1638 * will be created in sysfs, registered to the specified class.
1639 *
1640 * A "dev" file will be created, showing the dev_t for the device, if
1641 * the dev_t is not 0,0.
1642 * If a pointer to a parent struct device is passed in, the newly created
1643 * struct device will be a child of that device in sysfs.
1644 * The pointer to the struct device will be returned from the call.
1645 * Any further sysfs files that might be required can be created using this
1646 * pointer.
1647 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001648 * Returns &struct device pointer on success, or ERR_PTR() on error.
1649 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001650 * Note: the struct class passed to this function must have previously
1651 * been created with a call to class_create().
1652 */
1653struct device *device_create_vargs(struct class *class, struct device *parent,
1654 dev_t devt, void *drvdata, const char *fmt,
1655 va_list args)
1656{
Guenter Roeck39ef3112013-07-14 16:05:57 -07001657 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1658 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001659}
1660EXPORT_SYMBOL_GPL(device_create_vargs);
1661
1662/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001663 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001664 * @class: pointer to the struct class that this device should be registered to
1665 * @parent: pointer to the parent struct device of this new device, if any
1666 * @devt: the dev_t for the char device to be added
1667 * @drvdata: the data to be added to the device for callbacks
1668 * @fmt: string for the device's name
1669 *
1670 * This function can be used by char device classes. A struct device
1671 * will be created in sysfs, registered to the specified class.
1672 *
1673 * A "dev" file will be created, showing the dev_t for the device, if
1674 * the dev_t is not 0,0.
1675 * If a pointer to a parent struct device is passed in, the newly created
1676 * struct device will be a child of that device in sysfs.
1677 * The pointer to the struct device will be returned from the call.
1678 * Any further sysfs files that might be required can be created using this
1679 * pointer.
1680 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001681 * Returns &struct device pointer on success, or ERR_PTR() on error.
1682 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001683 * Note: the struct class passed to this function must have previously
1684 * been created with a call to class_create().
1685 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001686struct device *device_create(struct class *class, struct device *parent,
1687 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001688{
1689 va_list vargs;
1690 struct device *dev;
1691
1692 va_start(vargs, fmt);
1693 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1694 va_end(vargs);
1695 return dev;
1696}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001697EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001698
Guenter Roeck39ef3112013-07-14 16:05:57 -07001699/**
1700 * device_create_with_groups - creates a device and registers it with sysfs
1701 * @class: pointer to the struct class that this device should be registered to
1702 * @parent: pointer to the parent struct device of this new device, if any
1703 * @devt: the dev_t for the char device to be added
1704 * @drvdata: the data to be added to the device for callbacks
1705 * @groups: NULL-terminated list of attribute groups to be created
1706 * @fmt: string for the device's name
1707 *
1708 * This function can be used by char device classes. A struct device
1709 * will be created in sysfs, registered to the specified class.
1710 * Additional attributes specified in the groups parameter will also
1711 * be created automatically.
1712 *
1713 * A "dev" file will be created, showing the dev_t for the device, if
1714 * the dev_t is not 0,0.
1715 * If a pointer to a parent struct device is passed in, the newly created
1716 * struct device will be a child of that device in sysfs.
1717 * The pointer to the struct device will be returned from the call.
1718 * Any further sysfs files that might be required can be created using this
1719 * pointer.
1720 *
1721 * Returns &struct device pointer on success, or ERR_PTR() on error.
1722 *
1723 * Note: the struct class passed to this function must have previously
1724 * been created with a call to class_create().
1725 */
1726struct device *device_create_with_groups(struct class *class,
1727 struct device *parent, dev_t devt,
1728 void *drvdata,
1729 const struct attribute_group **groups,
1730 const char *fmt, ...)
1731{
1732 va_list vargs;
1733 struct device *dev;
1734
1735 va_start(vargs, fmt);
1736 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1737 fmt, vargs);
1738 va_end(vargs);
1739 return dev;
1740}
1741EXPORT_SYMBOL_GPL(device_create_with_groups);
1742
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001743static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001744{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001745 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001746
Dave Youngcd354492008-01-28 16:56:11 +08001747 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001748}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001749
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001750/**
1751 * device_destroy - removes a device that was created with device_create()
1752 * @class: pointer to the struct class that this device was registered with
1753 * @devt: the dev_t of the device that was previously registered
1754 *
1755 * This call unregisters and cleans up a device that was created with a
1756 * call to device_create().
1757 */
1758void device_destroy(struct class *class, dev_t devt)
1759{
1760 struct device *dev;
1761
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001762 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001763 if (dev) {
1764 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001765 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001766 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001767}
1768EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001769
1770/**
1771 * device_rename - renames a device
1772 * @dev: the pointer to the struct device to be renamed
1773 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001774 *
1775 * It is the responsibility of the caller to provide mutual
1776 * exclusion between two different calls of device_rename
1777 * on the same device to ensure that new_name is valid and
1778 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001779 *
Timur Tabia5462512010-12-13 14:08:52 -06001780 * Note: Don't call this function. Currently, the networking layer calls this
1781 * function, but that will change. The following text from Kay Sievers offers
1782 * some insight:
1783 *
1784 * Renaming devices is racy at many levels, symlinks and other stuff are not
1785 * replaced atomically, and you get a "move" uevent, but it's not easy to
1786 * connect the event to the old and new device. Device nodes are not renamed at
1787 * all, there isn't even support for that in the kernel now.
1788 *
1789 * In the meantime, during renaming, your target name might be taken by another
1790 * driver, creating conflicts. Or the old name is taken directly after you
1791 * renamed it -- then you get events for the same DEVPATH, before you even see
1792 * the "move" event. It's just a mess, and nothing new should ever rely on
1793 * kernel device renaming. Besides that, it's not even implemented now for
1794 * other things than (driver-core wise very simple) network devices.
1795 *
1796 * We are currently about to change network renaming in udev to completely
1797 * disallow renaming of devices in the same namespace as the kernel uses,
1798 * because we can't solve the problems properly, that arise with swapping names
1799 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1800 * be allowed to some other name than eth[0-9]*, for the aforementioned
1801 * reasons.
1802 *
1803 * Make up a "real" name in the driver before you register anything, or add
1804 * some other attributes for userspace to find the device, or use udev to add
1805 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1806 * don't even want to get into that and try to implement the missing pieces in
1807 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001808 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001809int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001810{
Tejun Heo4b30ee52013-09-11 22:29:06 -04001811 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001812 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001813 int error;
1814
1815 dev = get_device(dev);
1816 if (!dev)
1817 return -EINVAL;
1818
ethan.zhao69df7532013-10-13 22:12:35 +08001819 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001820
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001821 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001822 if (!old_device_name) {
1823 error = -ENOMEM;
1824 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001825 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001826
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001827 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04001828 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1829 kobj, old_device_name,
1830 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001831 if (error)
1832 goto out;
1833 }
Kay Sievers39aba962010-09-04 22:33:14 -07001834
Tejun Heo4b30ee52013-09-11 22:29:06 -04001835 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001836 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001837 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001838
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001839out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001840 put_device(dev);
1841
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001842 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001843
1844 return error;
1845}
Johannes Berga2807db2007-02-28 12:38:31 +01001846EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001847
1848static int device_move_class_links(struct device *dev,
1849 struct device *old_parent,
1850 struct device *new_parent)
1851{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001852 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001853
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001854 if (old_parent)
1855 sysfs_remove_link(&dev->kobj, "device");
1856 if (new_parent)
1857 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1858 "device");
1859 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001860}
1861
1862/**
1863 * device_move - moves a device to a new parent
1864 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001865 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001866 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001867 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001868int device_move(struct device *dev, struct device *new_parent,
1869 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001870{
1871 int error;
1872 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001873 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001874
1875 dev = get_device(dev);
1876 if (!dev)
1877 return -EINVAL;
1878
Cornelia Huckffa6a702009-03-04 12:44:00 +01001879 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001880 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001881 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001882
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001883 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1884 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001885 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001886 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001887 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001888 put_device(new_parent);
1889 goto out;
1890 }
1891 old_parent = dev->parent;
1892 dev->parent = new_parent;
1893 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001894 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001895 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001896 klist_add_tail(&dev->p->knode_parent,
1897 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001898 set_dev_node(dev, dev_to_node(new_parent));
1899 }
1900
Rabin Vincentbdd40342012-04-23 09:16:36 +02001901 if (dev->class) {
1902 error = device_move_class_links(dev, old_parent, new_parent);
1903 if (error) {
1904 /* We ignore errors on cleanup since we're hosed anyway... */
1905 device_move_class_links(dev, new_parent, old_parent);
1906 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1907 if (new_parent)
1908 klist_remove(&dev->p->knode_parent);
1909 dev->parent = old_parent;
1910 if (old_parent) {
1911 klist_add_tail(&dev->p->knode_parent,
1912 &old_parent->p->klist_children);
1913 set_dev_node(dev, dev_to_node(old_parent));
1914 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001915 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001916 cleanup_glue_dir(dev, new_parent_kobj);
1917 put_device(new_parent);
1918 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001919 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001920 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001921 switch (dpm_order) {
1922 case DPM_ORDER_NONE:
1923 break;
1924 case DPM_ORDER_DEV_AFTER_PARENT:
1925 device_pm_move_after(dev, new_parent);
1926 break;
1927 case DPM_ORDER_PARENT_BEFORE_DEV:
1928 device_pm_move_before(new_parent, dev);
1929 break;
1930 case DPM_ORDER_DEV_LAST:
1931 device_pm_move_last(dev);
1932 break;
1933 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001934
Cornelia Huck8a824722006-11-20 17:07:51 +01001935 put_device(old_parent);
1936out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001937 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001938 put_device(dev);
1939 return error;
1940}
Cornelia Huck8a824722006-11-20 17:07:51 +01001941EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001942
1943/**
1944 * device_shutdown - call ->shutdown() on each device to shutdown.
1945 */
1946void device_shutdown(void)
1947{
Benson Leungf123db82013-09-24 20:05:11 -07001948 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001949
Hugh Daschbach62458382010-03-22 10:36:37 -07001950 spin_lock(&devices_kset->list_lock);
1951 /*
1952 * Walk the devices list backward, shutting down each in turn.
1953 * Beware that device unplug events may also start pulling
1954 * devices offline, even as the system is shutting down.
1955 */
1956 while (!list_empty(&devices_kset->list)) {
1957 dev = list_entry(devices_kset->list.prev, struct device,
1958 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08001959
1960 /*
1961 * hold reference count of device's parent to
1962 * prevent it from being freed because parent's
1963 * lock is to be held
1964 */
Benson Leungf123db82013-09-24 20:05:11 -07001965 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001966 get_device(dev);
1967 /*
1968 * Make sure the device is off the kset list, in the
1969 * event that dev->*->shutdown() doesn't remove it.
1970 */
1971 list_del_init(&dev->kobj.entry);
1972 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001973
Ming Leid1c6c032012-06-22 18:01:40 +08001974 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07001975 if (parent)
1976 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001977 device_lock(dev);
1978
Alan Sternfe6b91f2011-12-06 23:24:52 +01001979 /* Don't allow any more runtime suspends */
1980 pm_runtime_get_noresume(dev);
1981 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001982
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001983 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001984 if (initcall_debug)
1985 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001986 dev->bus->shutdown(dev);
1987 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001988 if (initcall_debug)
1989 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001990 dev->driver->shutdown(dev);
1991 }
Ming Leid1c6c032012-06-22 18:01:40 +08001992
1993 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07001994 if (parent)
1995 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001996
Hugh Daschbach62458382010-03-22 10:36:37 -07001997 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07001998 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001999
2000 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002001 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002002 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07002003 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002004}
Joe Perches99bcf212010-06-27 01:02:34 +00002005
2006/*
2007 * Device logging functions
2008 */
2009
2010#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002011static int
2012create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002013{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002014 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002015 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002016
Kay Sieversc4e00da2012-05-03 02:29:59 +02002017 if (dev->class)
2018 subsys = dev->class->name;
2019 else if (dev->bus)
2020 subsys = dev->bus->name;
2021 else
Joe Perches798efc62012-09-12 20:11:29 -07002022 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002023
Joe Perches798efc62012-09-12 20:11:29 -07002024 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002025
2026 /*
2027 * Add device identifier DEVICE=:
2028 * b12:8 block dev_t
2029 * c127:3 char dev_t
2030 * n8 netdev ifindex
2031 * +sound:card0 subsystem:devname
2032 */
2033 if (MAJOR(dev->devt)) {
2034 char c;
2035
2036 if (strcmp(subsys, "block") == 0)
2037 c = 'b';
2038 else
2039 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002040 pos++;
2041 pos += snprintf(hdr + pos, hdrlen - pos,
2042 "DEVICE=%c%u:%u",
2043 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002044 } else if (strcmp(subsys, "net") == 0) {
2045 struct net_device *net = to_net_dev(dev);
2046
Joe Perches798efc62012-09-12 20:11:29 -07002047 pos++;
2048 pos += snprintf(hdr + pos, hdrlen - pos,
2049 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002050 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002051 pos++;
2052 pos += snprintf(hdr + pos, hdrlen - pos,
2053 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002054 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002055
Joe Perches798efc62012-09-12 20:11:29 -07002056 return pos;
Joe Perches99bcf212010-06-27 01:02:34 +00002057}
Joe Perches798efc62012-09-12 20:11:29 -07002058EXPORT_SYMBOL(create_syslog_header);
2059
Joe Perches05e4e5b2012-09-12 20:13:37 -07002060int dev_vprintk_emit(int level, const struct device *dev,
2061 const char *fmt, va_list args)
2062{
2063 char hdr[128];
2064 size_t hdrlen;
2065
2066 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2067
2068 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2069}
2070EXPORT_SYMBOL(dev_vprintk_emit);
2071
2072int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2073{
2074 va_list args;
2075 int r;
2076
2077 va_start(args, fmt);
2078
2079 r = dev_vprintk_emit(level, dev, fmt, args);
2080
2081 va_end(args);
2082
2083 return r;
2084}
2085EXPORT_SYMBOL(dev_printk_emit);
2086
Joe Perches798efc62012-09-12 20:11:29 -07002087static int __dev_printk(const char *level, const struct device *dev,
2088 struct va_format *vaf)
2089{
Joe Perches798efc62012-09-12 20:11:29 -07002090 if (!dev)
2091 return printk("%s(NULL device *): %pV", level, vaf);
2092
Joe Perches666f3552012-09-12 20:14:11 -07002093 return dev_printk_emit(level[1] - '0', dev,
2094 "%s %s: %pV",
2095 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002096}
Joe Perches99bcf212010-06-27 01:02:34 +00002097
2098int dev_printk(const char *level, const struct device *dev,
2099 const char *fmt, ...)
2100{
2101 struct va_format vaf;
2102 va_list args;
2103 int r;
2104
2105 va_start(args, fmt);
2106
2107 vaf.fmt = fmt;
2108 vaf.va = &args;
2109
2110 r = __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002111
Joe Perches99bcf212010-06-27 01:02:34 +00002112 va_end(args);
2113
2114 return r;
2115}
2116EXPORT_SYMBOL(dev_printk);
2117
2118#define define_dev_printk_level(func, kern_level) \
2119int func(const struct device *dev, const char *fmt, ...) \
2120{ \
2121 struct va_format vaf; \
2122 va_list args; \
2123 int r; \
2124 \
2125 va_start(args, fmt); \
2126 \
2127 vaf.fmt = fmt; \
2128 vaf.va = &args; \
2129 \
2130 r = __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002131 \
Joe Perches99bcf212010-06-27 01:02:34 +00002132 va_end(args); \
2133 \
2134 return r; \
2135} \
2136EXPORT_SYMBOL(func);
2137
2138define_dev_printk_level(dev_emerg, KERN_EMERG);
2139define_dev_printk_level(dev_alert, KERN_ALERT);
2140define_dev_printk_level(dev_crit, KERN_CRIT);
2141define_dev_printk_level(dev_err, KERN_ERR);
2142define_dev_printk_level(dev_warn, KERN_WARNING);
2143define_dev_printk_level(dev_notice, KERN_NOTICE);
2144define_dev_printk_level(_dev_info, KERN_INFO);
2145
2146#endif