blob: 2b567177ef782973b7e1ad14c065154ca76a986e [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)
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100494 goto err_remove_dev_groups;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200495 }
496
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500497 return 0;
498
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100499 err_remove_dev_groups:
500 device_remove_groups(dev, dev->groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500501 err_remove_type_groups:
502 if (type)
503 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700504 err_remove_class_groups:
505 if (class)
506 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500507
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700508 return error;
509}
510
511static void device_remove_attrs(struct device *dev)
512{
513 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700514 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700515
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700516 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500517 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200518
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500519 if (type)
520 device_remove_groups(dev, type->groups);
521
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700522 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700523 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700524}
525
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700526static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700527 char *buf)
528{
529 return print_dev_t(buf, dev->devt);
530}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700531static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900532
Kay Sieversca22e562011-12-14 14:29:38 -0800533/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600534struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800537 * device_create_file - create sysfs attribute file for device.
538 * @dev: device.
539 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200541int device_create_file(struct device *dev,
542 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200545
546 if (dev) {
547 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800548 "Attribute %s: write permission without 'store'\n",
549 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200550 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800551 "Attribute %s: read permission without 'show'\n",
552 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200554 }
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return error;
557}
David Graham White86df2682013-07-21 20:41:14 -0400558EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800561 * device_remove_file - remove sysfs attribute file.
562 * @dev: device.
563 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200565void device_remove_file(struct device *dev,
566 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100568 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
David Graham White86df2682013-07-21 20:41:14 -0400571EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700573/**
574 * device_create_bin_file - create sysfs binary attribute file for device.
575 * @dev: device.
576 * @attr: device binary attribute descriptor.
577 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200578int device_create_bin_file(struct device *dev,
579 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700580{
581 int error = -EINVAL;
582 if (dev)
583 error = sysfs_create_bin_file(&dev->kobj, attr);
584 return error;
585}
586EXPORT_SYMBOL_GPL(device_create_bin_file);
587
588/**
589 * device_remove_bin_file - remove sysfs binary attribute file
590 * @dev: device.
591 * @attr: device binary attribute descriptor.
592 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200593void device_remove_bin_file(struct device *dev,
594 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700595{
596 if (dev)
597 sysfs_remove_bin_file(&dev->kobj, attr);
598}
599EXPORT_SYMBOL_GPL(device_remove_bin_file);
600
Greg Kroah-Hartmana30f82b2014-01-13 13:51:36 -0800601/**
602 * device_schedule_callback_owner - helper to schedule a callback for a device
603 * @dev: device.
604 * @func: callback function to invoke later.
605 * @owner: module owning the callback routine
606 *
607 * Attribute methods must not unregister themselves or their parent device
608 * (which would amount to the same thing). Attempts to do so will deadlock,
609 * since unregistration is mutually exclusive with driver callbacks.
610 *
611 * Instead methods can call this routine, which will attempt to allocate
612 * and schedule a workqueue request to call back @func with @dev as its
613 * argument in the workqueue's process context. @dev will be pinned until
614 * @func returns.
615 *
616 * This routine is usually called via the inline device_schedule_callback(),
617 * which automatically sets @owner to THIS_MODULE.
618 *
619 * Returns 0 if the request was submitted, -ENOMEM if storage could not
620 * be allocated, -ENODEV if a reference to @owner isn't available.
621 *
622 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
623 * underlying sysfs routine (since it is intended for use by attribute
624 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
625 */
626int device_schedule_callback_owner(struct device *dev,
627 void (*func)(struct device *), struct module *owner)
628{
629 return sysfs_schedule_callback(&dev->kobj,
630 (void (*)(void *)) func, dev, owner);
631}
632EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
633
James Bottomley34bb61f2005-09-06 16:56:51 -0700634static void klist_children_get(struct klist_node *n)
635{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800636 struct device_private *p = to_device_private_parent(n);
637 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700638
639 get_device(dev);
640}
641
642static void klist_children_put(struct klist_node *n)
643{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800644 struct device_private *p = to_device_private_parent(n);
645 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700646
647 put_device(dev);
648}
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800651 * device_initialize - init device structure.
652 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 *
Cornelia Huck57394112008-09-03 18:26:40 +0200654 * This prepares the device for use by other layers by initializing
655 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800656 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200657 * that function, though it can also be called separately, so one
658 * may use @dev's fields. In particular, get_device()/put_device()
659 * may be used for reference counting of @dev after calling this
660 * function.
661 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500662 * All fields in @dev must be initialized by the caller to 0, except
663 * for those explicitly set to some other value. The simplest
664 * approach is to use kzalloc() to allocate the structure containing
665 * @dev.
666 *
Cornelia Huck57394112008-09-03 18:26:40 +0200667 * NOTE: Use put_device() to give up your reference instead of freeing
668 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670void device_initialize(struct device *dev)
671{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600672 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700673 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000675 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100676 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900677 spin_lock_init(&dev->devres_lock);
678 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400679 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800680 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
David Graham White86df2682013-07-21 20:41:14 -0400682EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Tejun Heod73ce002013-03-12 11:30:05 -0700684struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700685{
Kay Sievers86406242007-03-14 03:25:56 +0100686 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700687
Kay Sievers86406242007-03-14 03:25:56 +0100688 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800689 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600690 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700691
Kay Sievers86406242007-03-14 03:25:56 +0100692 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700693}
694
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700695struct class_dir {
696 struct kobject kobj;
697 struct class *class;
698};
699
700#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
701
702static void class_dir_release(struct kobject *kobj)
703{
704 struct class_dir *dir = to_class_dir(kobj);
705 kfree(dir);
706}
707
708static const
709struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
710{
711 struct class_dir *dir = to_class_dir(kobj);
712 return dir->class->ns_type;
713}
714
715static struct kobj_type class_dir_ktype = {
716 .release = class_dir_release,
717 .sysfs_ops = &kobj_sysfs_ops,
718 .child_ns_type = class_dir_child_ns_type
719};
720
721static struct kobject *
722class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
723{
724 struct class_dir *dir;
725 int retval;
726
727 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
728 if (!dir)
729 return NULL;
730
731 dir->class = class;
732 kobject_init(&dir->kobj, &class_dir_ktype);
733
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100734 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700735
736 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
737 if (retval < 0) {
738 kobject_put(&dir->kobj);
739 return NULL;
740 }
741 return &dir->kobj;
742}
743
744
Kay Sieversda231fd2007-11-21 17:29:15 +0100745static struct kobject *get_device_parent(struct device *dev,
746 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100747{
Kay Sievers86406242007-03-14 03:25:56 +0100748 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900749 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100750 struct kobject *kobj = NULL;
751 struct kobject *parent_kobj;
752 struct kobject *k;
753
Randy Dunlapead454f2010-09-24 14:36:49 -0700754#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700755 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200756 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700757 if (parent && parent->class == &block_class)
758 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100759 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700760 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700761#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200762
Kay Sievers86406242007-03-14 03:25:56 +0100763 /*
764 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100765 * Class-devices with a non class-device as parent, live
766 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100767 */
768 if (parent == NULL)
769 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700770 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100771 return &parent->kobj;
772 else
773 parent_kobj = &parent->kobj;
774
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900775 mutex_lock(&gdp_mutex);
776
Kay Sievers86406242007-03-14 03:25:56 +0100777 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100778 spin_lock(&dev->class->p->glue_dirs.list_lock);
779 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100780 if (k->parent == parent_kobj) {
781 kobj = kobject_get(k);
782 break;
783 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100784 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900785 if (kobj) {
786 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100787 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900788 }
Kay Sievers86406242007-03-14 03:25:56 +0100789
790 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700791 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100792 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900793 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800794 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100795 }
796
Kay Sieversca22e562011-12-14 14:29:38 -0800797 /* subsystems can specify a default root directory for their devices */
798 if (!parent && dev->bus && dev->bus->dev_root)
799 return &dev->bus->dev_root->kobj;
800
Kay Sievers86406242007-03-14 03:25:56 +0100801 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100802 return &parent->kobj;
803 return NULL;
804}
Kay Sieversda231fd2007-11-21 17:29:15 +0100805
Cornelia Huck63b69712008-01-21 16:09:44 +0100806static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100807{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100808 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100809 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100810 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100811 return;
812
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100813 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100814}
Cornelia Huck63b69712008-01-21 16:09:44 +0100815
816static void cleanup_device_parent(struct device *dev)
817{
818 cleanup_glue_dir(dev, dev->kobj.parent);
819}
Kay Sievers86406242007-03-14 03:25:56 +0100820
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700821static int device_add_class_symlinks(struct device *dev)
822{
823 int error;
824
825 if (!dev->class)
826 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100827
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700828 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100829 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700830 "subsystem");
831 if (error)
832 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100833
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800834 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700835 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
836 "device");
837 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700838 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700839 }
Kay Sievers39aba962010-09-04 22:33:14 -0700840
Randy Dunlapead454f2010-09-24 14:36:49 -0700841#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700842 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200843 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700844 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700845#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700846
847 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100848 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700849 &dev->kobj, dev_name(dev));
850 if (error)
851 goto out_device;
852
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700853 return 0;
854
Kay Sievers39aba962010-09-04 22:33:14 -0700855out_device:
856 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100857
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700858out_subsys:
859 sysfs_remove_link(&dev->kobj, "subsystem");
860out:
861 return error;
862}
863
864static void device_remove_class_symlinks(struct device *dev)
865{
866 if (!dev->class)
867 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100868
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800869 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100870 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700871 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700872#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200873 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700874 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700875#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100876 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700877}
878
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000880 * dev_set_name - set a device name
881 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700882 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000883 */
884int dev_set_name(struct device *dev, const char *fmt, ...)
885{
886 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100887 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000888
889 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100890 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000891 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100892 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000893}
894EXPORT_SYMBOL_GPL(dev_set_name);
895
896/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700897 * device_to_dev_kobj - select a /sys/dev/ directory for the device
898 * @dev: device
899 *
900 * By default we select char/ for new entries. Setting class->dev_obj
901 * to NULL prevents an entry from being created. class->dev_kobj must
902 * be set (or cleared) before any devices are registered to the class
903 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200904 * device_remove_sys_dev_entry() will disagree about the presence of
905 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700906 */
907static struct kobject *device_to_dev_kobj(struct device *dev)
908{
909 struct kobject *kobj;
910
911 if (dev->class)
912 kobj = dev->class->dev_kobj;
913 else
914 kobj = sysfs_dev_char_kobj;
915
916 return kobj;
917}
918
919static int device_create_sys_dev_entry(struct device *dev)
920{
921 struct kobject *kobj = device_to_dev_kobj(dev);
922 int error = 0;
923 char devt_str[15];
924
925 if (kobj) {
926 format_dev_t(devt_str, dev->devt);
927 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
928 }
929
930 return error;
931}
932
933static void device_remove_sys_dev_entry(struct device *dev)
934{
935 struct kobject *kobj = device_to_dev_kobj(dev);
936 char devt_str[15];
937
938 if (kobj) {
939 format_dev_t(devt_str, dev->devt);
940 sysfs_remove_link(kobj, devt_str);
941 }
942}
943
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700944int device_private_init(struct device *dev)
945{
946 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
947 if (!dev->p)
948 return -ENOMEM;
949 dev->p->device = dev;
950 klist_init(&dev->p->klist_children, klist_children_get,
951 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800952 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700953 return 0;
954}
955
Dan Williamse105b8b2008-04-21 10:51:07 -0700956/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800957 * device_add - add device to device hierarchy.
958 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800960 * This is part 2 of device_register(), though may be called
961 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 *
Cornelia Huck57394112008-09-03 18:26:40 +0200963 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800964 * to the global and sibling lists for the device, then
965 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200966 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500967 * Do not call this routine or device_register() more than once for
968 * any device structure. The driver model core is not designed to work
969 * with devices that get unregistered and then spring back to life.
970 * (Among other things, it's very hard to guarantee that all references
971 * to the previous incarnation of @dev have been dropped.) Allocate
972 * and register a fresh new struct device instead.
973 *
Cornelia Huck57394112008-09-03 18:26:40 +0200974 * NOTE: _Never_ directly free @dev after calling this function, even
975 * if it returned an error! Always use put_device() to give up your
976 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 */
978int device_add(struct device *dev)
979{
980 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800981 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200982 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700983 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700986 if (!dev)
987 goto done;
988
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800989 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700990 error = device_private_init(dev);
991 if (error)
992 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800993 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800994
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100995 /*
996 * for statically allocated devices, which should all be converted
997 * some day, we need to initialize the name. We prevent reading back
998 * the name, and force the use of dev_name()
999 */
1000 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001001 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001002 dev->init_name = NULL;
1003 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001004
Kay Sieversca22e562011-12-14 14:29:38 -08001005 /* subsystems can specify simple device enumeration */
1006 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1007 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1008
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001009 if (!dev_name(dev)) {
1010 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001011 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001012 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001014 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001017 kobj = get_device_parent(dev, parent);
1018 if (kobj)
1019 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Yinghai Lu0d358f22008-02-19 03:20:41 -08001021 /* use parent numa_node */
1022 if (parent)
1023 set_dev_node(dev, dev_to_node(parent));
1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001026 /* we require the name to be set before, and pass NULL */
1027 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001028 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001030
Brian Walsh37022642006-08-14 22:43:19 -07001031 /* notify platform of device entry */
1032 if (platform_notify)
1033 platform_notify(dev);
1034
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001035 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001036 if (error)
1037 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001038
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001039 if (MAJOR(dev->devt)) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001040 error = device_create_file(dev, &dev_attr_dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001041 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001042 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001043
1044 error = device_create_sys_dev_entry(dev);
1045 if (error)
1046 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001047
1048 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001049 }
1050
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001051 error = device_add_class_symlinks(dev);
1052 if (error)
1053 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001054 error = device_add_attrs(dev);
1055 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001056 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001057 error = bus_add_device(dev);
1058 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001060 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001061 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001062 goto DPMError;
1063 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001064
1065 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001066 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001067 */
1068 if (dev->bus)
1069 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1070 BUS_NOTIFY_ADD_DEVICE, dev);
1071
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001072 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001073 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001075 klist_add_tail(&dev->p->knode_parent,
1076 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001078 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001079 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001080 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001081 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001082 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001083
1084 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001085 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001086 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001087 if (class_intf->add_dev)
1088 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001089 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001090 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001091done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 put_device(dev);
1093 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001094 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001095 bus_remove_device(dev);
1096 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001097 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001098 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001099 device_remove_class_symlinks(dev);
1100 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001101 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001102 devtmpfs_delete_node(dev);
1103 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001104 device_remove_sys_dev_entry(dev);
1105 devtattrError:
1106 if (MAJOR(dev->devt))
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001107 device_remove_file(dev, &dev_attr_dev);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001108 ueventattrError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001109 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001110 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001111 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 kobject_del(&dev->kobj);
1113 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001114 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 if (parent)
1116 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001117name_error:
1118 kfree(dev->p);
1119 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001120 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
David Graham White86df2682013-07-21 20:41:14 -04001122EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001125 * device_register - register a device with the system.
1126 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001128 * This happens in two clean steps - initialize the device
1129 * and add it to the system. The two steps can be called
1130 * separately, but this is the easiest and most common.
1131 * I.e. you should only call the two helpers separately if
1132 * have a clearly defined need to use and refcount the device
1133 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001134 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001135 * For more information, see the kerneldoc for device_initialize()
1136 * and device_add().
1137 *
Cornelia Huck57394112008-09-03 18:26:40 +02001138 * NOTE: _Never_ directly free @dev after calling this function, even
1139 * if it returned an error! Always use put_device() to give up the
1140 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142int device_register(struct device *dev)
1143{
1144 device_initialize(dev);
1145 return device_add(dev);
1146}
David Graham White86df2682013-07-21 20:41:14 -04001147EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001150 * get_device - increment reference count for device.
1151 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001153 * This simply forwards the call to kobject_get(), though
1154 * we do take care to provide for the case that we get a NULL
1155 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001157struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001159 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
David Graham White86df2682013-07-21 20:41:14 -04001161EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001164 * put_device - decrement reference count.
1165 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001167void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001169 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 if (dev)
1171 kobject_put(&dev->kobj);
1172}
David Graham White86df2682013-07-21 20:41:14 -04001173EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001176 * device_del - delete device from system.
1177 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001179 * This is the first part of the device unregistration
1180 * sequence. This removes the device from the lists we control
1181 * from here, has it removed from the other driver model
1182 * subsystems it was added to in device_add(), and removes it
1183 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001185 * NOTE: this should be called manually _iff_ device_add() was
1186 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001188void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001190 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001191 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Alan Sternec0676ee2008-12-05 14:10:31 -05001193 /* Notify clients of device removal. This call must come
1194 * before dpm_sysfs_remove().
1195 */
1196 if (dev->bus)
1197 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1198 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001199 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001201 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001202 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001203 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001204 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001205 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001206 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001207 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001208 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001209
Kay Sieversca22e562011-12-14 14:29:38 -08001210 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001211 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001212 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001213 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001214 if (class_intf->remove_dev)
1215 class_intf->remove_dev(dev, class_intf);
1216 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001217 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001218 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001219 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001220 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001221 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001222 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001223 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001224 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
1226 /* Notify the platform of the removal, in case they
1227 * need to do anything...
1228 */
1229 if (platform_notify_remove)
1230 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001231 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001232 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001234 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235}
David Graham White86df2682013-07-21 20:41:14 -04001236EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001239 * device_unregister - unregister device from system.
1240 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001242 * We do this in two parts, like we do device_register(). First,
1243 * we remove it from all the subsystems with device_del(), then
1244 * we decrement the reference count via put_device(). If that
1245 * is the final reference count, the device will be cleaned up
1246 * via device_release() above. Otherwise, the structure will
1247 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001249void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001251 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 device_del(dev);
1253 put_device(dev);
1254}
David Graham White86df2682013-07-21 20:41:14 -04001255EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001257static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001258{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001259 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001260 struct device *dev = NULL;
1261 struct device_private *p;
1262
1263 if (n) {
1264 p = to_device_private_parent(n);
1265 dev = p->device;
1266 }
1267 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001268}
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001271 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001272 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001273 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001274 * @uid: returned file owner
1275 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001276 * @tmp: possibly allocated string
1277 *
1278 * Return the relative path of a possible device node.
1279 * Non-default names may need to allocate a memory to compose
1280 * a name. This memory is returned in tmp and needs to be
1281 * freed by the caller.
1282 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001283const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001284 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001285 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001286{
1287 char *s;
1288
1289 *tmp = NULL;
1290
1291 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001292 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001293 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001294 if (*tmp)
1295 return *tmp;
1296
1297 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001298 if (dev->class && dev->class->devnode)
1299 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001300 if (*tmp)
1301 return *tmp;
1302
1303 /* return name without allocation, tmp == NULL */
1304 if (strchr(dev_name(dev), '!') == NULL)
1305 return dev_name(dev);
1306
1307 /* replace '!' in the name with '/' */
1308 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1309 if (!*tmp)
1310 return NULL;
1311 while ((s = strchr(*tmp, '!')))
1312 s[0] = '/';
1313 return *tmp;
1314}
1315
1316/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001317 * device_for_each_child - device child iterator.
1318 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001319 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001320 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001322 * Iterate over @parent's child devices, and call @fn for each,
1323 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001325 * We check the return of @fn each time. If it returns anything
1326 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001328int device_for_each_child(struct device *parent, void *data,
1329 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001331 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001332 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 int error = 0;
1334
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001335 if (!parent->p)
1336 return 0;
1337
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001338 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001339 while ((child = next_device(&i)) && !error)
1340 error = fn(child, data);
1341 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 return error;
1343}
David Graham White86df2682013-07-21 20:41:14 -04001344EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
Cornelia Huck5ab69982006-11-16 15:42:07 +01001346/**
1347 * device_find_child - device iterator for locating a particular device.
1348 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01001349 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001350 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01001351 *
1352 * This is similar to the device_for_each_child() function above, but it
1353 * returns a reference to a device that is 'found' for later use, as
1354 * determined by the @match callback.
1355 *
1356 * The callback should return 0 if the device doesn't match and non-zero
1357 * if it does. If the callback returns non-zero and a reference to the
1358 * current device can be obtained, this function will return to the caller
1359 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02001360 *
1361 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01001362 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001363struct device *device_find_child(struct device *parent, void *data,
1364 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001365{
1366 struct klist_iter i;
1367 struct device *child;
1368
1369 if (!parent)
1370 return NULL;
1371
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001372 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001373 while ((child = next_device(&i)))
1374 if (match(child, data) && get_device(child))
1375 break;
1376 klist_iter_exit(&i);
1377 return child;
1378}
David Graham White86df2682013-07-21 20:41:14 -04001379EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001380
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381int __init devices_init(void)
1382{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001383 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1384 if (!devices_kset)
1385 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001386 dev_kobj = kobject_create_and_add("dev", NULL);
1387 if (!dev_kobj)
1388 goto dev_kobj_err;
1389 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1390 if (!sysfs_dev_block_kobj)
1391 goto block_kobj_err;
1392 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1393 if (!sysfs_dev_char_kobj)
1394 goto char_kobj_err;
1395
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001396 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001397
1398 char_kobj_err:
1399 kobject_put(sysfs_dev_block_kobj);
1400 block_kobj_err:
1401 kobject_put(dev_kobj);
1402 dev_kobj_err:
1403 kset_unregister(devices_kset);
1404 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405}
1406
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001407static int device_check_offline(struct device *dev, void *not_used)
1408{
1409 int ret;
1410
1411 ret = device_for_each_child(dev, NULL, device_check_offline);
1412 if (ret)
1413 return ret;
1414
1415 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1416}
1417
1418/**
1419 * device_offline - Prepare the device for hot-removal.
1420 * @dev: Device to be put offline.
1421 *
1422 * Execute the device bus type's .offline() callback, if present, to prepare
1423 * the device for a subsequent hot-removal. If that succeeds, the device must
1424 * not be used until either it is removed or its bus type's .online() callback
1425 * is executed.
1426 *
1427 * Call under device_hotplug_lock.
1428 */
1429int device_offline(struct device *dev)
1430{
1431 int ret;
1432
1433 if (dev->offline_disabled)
1434 return -EPERM;
1435
1436 ret = device_for_each_child(dev, NULL, device_check_offline);
1437 if (ret)
1438 return ret;
1439
1440 device_lock(dev);
1441 if (device_supports_offline(dev)) {
1442 if (dev->offline) {
1443 ret = 1;
1444 } else {
1445 ret = dev->bus->offline(dev);
1446 if (!ret) {
1447 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1448 dev->offline = true;
1449 }
1450 }
1451 }
1452 device_unlock(dev);
1453
1454 return ret;
1455}
1456
1457/**
1458 * device_online - Put the device back online after successful device_offline().
1459 * @dev: Device to be put back online.
1460 *
1461 * If device_offline() has been successfully executed for @dev, but the device
1462 * has not been removed subsequently, execute its bus type's .online() callback
1463 * to indicate that the device can be used again.
1464 *
1465 * Call under device_hotplug_lock.
1466 */
1467int device_online(struct device *dev)
1468{
1469 int ret = 0;
1470
1471 device_lock(dev);
1472 if (device_supports_offline(dev)) {
1473 if (dev->offline) {
1474 ret = dev->bus->online(dev);
1475 if (!ret) {
1476 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1477 dev->offline = false;
1478 }
1479 } else {
1480 ret = 1;
1481 }
1482 }
1483 device_unlock(dev);
1484
1485 return ret;
1486}
1487
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001488struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001489 struct device dev;
1490 struct module *owner;
1491};
1492
Josh Triplett93058422012-11-18 21:27:55 -08001493static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001494{
1495 return container_of(d, struct root_device, dev);
1496}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001497
1498static void root_device_release(struct device *dev)
1499{
1500 kfree(to_root_device(dev));
1501}
1502
1503/**
1504 * __root_device_register - allocate and register a root device
1505 * @name: root device name
1506 * @owner: owner module of the root device, usually THIS_MODULE
1507 *
1508 * This function allocates a root device and registers it
1509 * using device_register(). In order to free the returned
1510 * device, use root_device_unregister().
1511 *
1512 * Root devices are dummy devices which allow other devices
1513 * to be grouped under /sys/devices. Use this function to
1514 * allocate a root device and then use it as the parent of
1515 * any device which should appear under /sys/devices/{name}
1516 *
1517 * The /sys/devices/{name} directory will also contain a
1518 * 'module' symlink which points to the @owner directory
1519 * in sysfs.
1520 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001521 * Returns &struct device pointer on success, or ERR_PTR() on error.
1522 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001523 * Note: You probably want to use root_device_register().
1524 */
1525struct device *__root_device_register(const char *name, struct module *owner)
1526{
1527 struct root_device *root;
1528 int err = -ENOMEM;
1529
1530 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1531 if (!root)
1532 return ERR_PTR(err);
1533
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001534 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001535 if (err) {
1536 kfree(root);
1537 return ERR_PTR(err);
1538 }
1539
1540 root->dev.release = root_device_release;
1541
1542 err = device_register(&root->dev);
1543 if (err) {
1544 put_device(&root->dev);
1545 return ERR_PTR(err);
1546 }
1547
Christoph Egger1d9e8822010-05-17 16:57:58 +02001548#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001549 if (owner) {
1550 struct module_kobject *mk = &owner->mkobj;
1551
1552 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1553 if (err) {
1554 device_unregister(&root->dev);
1555 return ERR_PTR(err);
1556 }
1557 root->owner = owner;
1558 }
1559#endif
1560
1561 return &root->dev;
1562}
1563EXPORT_SYMBOL_GPL(__root_device_register);
1564
1565/**
1566 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001567 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001568 *
1569 * This function unregisters and cleans up a device that was created by
1570 * root_device_register().
1571 */
1572void root_device_unregister(struct device *dev)
1573{
1574 struct root_device *root = to_root_device(dev);
1575
1576 if (root->owner)
1577 sysfs_remove_link(&root->dev.kobj, "module");
1578
1579 device_unregister(dev);
1580}
1581EXPORT_SYMBOL_GPL(root_device_unregister);
1582
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001583
1584static void device_create_release(struct device *dev)
1585{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001586 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001587 kfree(dev);
1588}
1589
Guenter Roeck39ef3112013-07-14 16:05:57 -07001590static struct device *
1591device_create_groups_vargs(struct class *class, struct device *parent,
1592 dev_t devt, void *drvdata,
1593 const struct attribute_group **groups,
1594 const char *fmt, va_list args)
1595{
1596 struct device *dev = NULL;
1597 int retval = -ENODEV;
1598
1599 if (class == NULL || IS_ERR(class))
1600 goto error;
1601
1602 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1603 if (!dev) {
1604 retval = -ENOMEM;
1605 goto error;
1606 }
1607
David Herrmannbbc780f2013-11-21 20:15:48 +01001608 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001609 dev->devt = devt;
1610 dev->class = class;
1611 dev->parent = parent;
1612 dev->groups = groups;
1613 dev->release = device_create_release;
1614 dev_set_drvdata(dev, drvdata);
1615
1616 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1617 if (retval)
1618 goto error;
1619
David Herrmannbbc780f2013-11-21 20:15:48 +01001620 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001621 if (retval)
1622 goto error;
1623
1624 return dev;
1625
1626error:
1627 put_device(dev);
1628 return ERR_PTR(retval);
1629}
1630
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001631/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001632 * device_create_vargs - creates a device and registers it with sysfs
1633 * @class: pointer to the struct class that this device should be registered to
1634 * @parent: pointer to the parent struct device of this new device, if any
1635 * @devt: the dev_t for the char device to be added
1636 * @drvdata: the data to be added to the device for callbacks
1637 * @fmt: string for the device's name
1638 * @args: va_list for the device's name
1639 *
1640 * This function can be used by char device classes. A struct device
1641 * will be created in sysfs, registered to the specified class.
1642 *
1643 * A "dev" file will be created, showing the dev_t for the device, if
1644 * the dev_t is not 0,0.
1645 * If a pointer to a parent struct device is passed in, the newly created
1646 * struct device will be a child of that device in sysfs.
1647 * The pointer to the struct device will be returned from the call.
1648 * Any further sysfs files that might be required can be created using this
1649 * pointer.
1650 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001651 * Returns &struct device pointer on success, or ERR_PTR() on error.
1652 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001653 * Note: the struct class passed to this function must have previously
1654 * been created with a call to class_create().
1655 */
1656struct device *device_create_vargs(struct class *class, struct device *parent,
1657 dev_t devt, void *drvdata, const char *fmt,
1658 va_list args)
1659{
Guenter Roeck39ef3112013-07-14 16:05:57 -07001660 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1661 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001662}
1663EXPORT_SYMBOL_GPL(device_create_vargs);
1664
1665/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001666 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001667 * @class: pointer to the struct class that this device should be registered to
1668 * @parent: pointer to the parent struct device of this new device, if any
1669 * @devt: the dev_t for the char device to be added
1670 * @drvdata: the data to be added to the device for callbacks
1671 * @fmt: string for the device's name
1672 *
1673 * This function can be used by char device classes. A struct device
1674 * will be created in sysfs, registered to the specified class.
1675 *
1676 * A "dev" file will be created, showing the dev_t for the device, if
1677 * the dev_t is not 0,0.
1678 * If a pointer to a parent struct device is passed in, the newly created
1679 * struct device will be a child of that device in sysfs.
1680 * The pointer to the struct device will be returned from the call.
1681 * Any further sysfs files that might be required can be created using this
1682 * pointer.
1683 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001684 * Returns &struct device pointer on success, or ERR_PTR() on error.
1685 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001686 * Note: the struct class passed to this function must have previously
1687 * been created with a call to class_create().
1688 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001689struct device *device_create(struct class *class, struct device *parent,
1690 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001691{
1692 va_list vargs;
1693 struct device *dev;
1694
1695 va_start(vargs, fmt);
1696 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1697 va_end(vargs);
1698 return dev;
1699}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001700EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001701
Guenter Roeck39ef3112013-07-14 16:05:57 -07001702/**
1703 * device_create_with_groups - creates a device and registers it with sysfs
1704 * @class: pointer to the struct class that this device should be registered to
1705 * @parent: pointer to the parent struct device of this new device, if any
1706 * @devt: the dev_t for the char device to be added
1707 * @drvdata: the data to be added to the device for callbacks
1708 * @groups: NULL-terminated list of attribute groups to be created
1709 * @fmt: string for the device's name
1710 *
1711 * This function can be used by char device classes. A struct device
1712 * will be created in sysfs, registered to the specified class.
1713 * Additional attributes specified in the groups parameter will also
1714 * be created automatically.
1715 *
1716 * A "dev" file will be created, showing the dev_t for the device, if
1717 * the dev_t is not 0,0.
1718 * If a pointer to a parent struct device is passed in, the newly created
1719 * struct device will be a child of that device in sysfs.
1720 * The pointer to the struct device will be returned from the call.
1721 * Any further sysfs files that might be required can be created using this
1722 * pointer.
1723 *
1724 * Returns &struct device pointer on success, or ERR_PTR() on error.
1725 *
1726 * Note: the struct class passed to this function must have previously
1727 * been created with a call to class_create().
1728 */
1729struct device *device_create_with_groups(struct class *class,
1730 struct device *parent, dev_t devt,
1731 void *drvdata,
1732 const struct attribute_group **groups,
1733 const char *fmt, ...)
1734{
1735 va_list vargs;
1736 struct device *dev;
1737
1738 va_start(vargs, fmt);
1739 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1740 fmt, vargs);
1741 va_end(vargs);
1742 return dev;
1743}
1744EXPORT_SYMBOL_GPL(device_create_with_groups);
1745
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001746static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001747{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001748 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001749
Dave Youngcd354492008-01-28 16:56:11 +08001750 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001751}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001752
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001753/**
1754 * device_destroy - removes a device that was created with device_create()
1755 * @class: pointer to the struct class that this device was registered with
1756 * @devt: the dev_t of the device that was previously registered
1757 *
1758 * This call unregisters and cleans up a device that was created with a
1759 * call to device_create().
1760 */
1761void device_destroy(struct class *class, dev_t devt)
1762{
1763 struct device *dev;
1764
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001765 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001766 if (dev) {
1767 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001768 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001769 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001770}
1771EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001772
1773/**
1774 * device_rename - renames a device
1775 * @dev: the pointer to the struct device to be renamed
1776 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001777 *
1778 * It is the responsibility of the caller to provide mutual
1779 * exclusion between two different calls of device_rename
1780 * on the same device to ensure that new_name is valid and
1781 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001782 *
Timur Tabia5462512010-12-13 14:08:52 -06001783 * Note: Don't call this function. Currently, the networking layer calls this
1784 * function, but that will change. The following text from Kay Sievers offers
1785 * some insight:
1786 *
1787 * Renaming devices is racy at many levels, symlinks and other stuff are not
1788 * replaced atomically, and you get a "move" uevent, but it's not easy to
1789 * connect the event to the old and new device. Device nodes are not renamed at
1790 * all, there isn't even support for that in the kernel now.
1791 *
1792 * In the meantime, during renaming, your target name might be taken by another
1793 * driver, creating conflicts. Or the old name is taken directly after you
1794 * renamed it -- then you get events for the same DEVPATH, before you even see
1795 * the "move" event. It's just a mess, and nothing new should ever rely on
1796 * kernel device renaming. Besides that, it's not even implemented now for
1797 * other things than (driver-core wise very simple) network devices.
1798 *
1799 * We are currently about to change network renaming in udev to completely
1800 * disallow renaming of devices in the same namespace as the kernel uses,
1801 * because we can't solve the problems properly, that arise with swapping names
1802 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1803 * be allowed to some other name than eth[0-9]*, for the aforementioned
1804 * reasons.
1805 *
1806 * Make up a "real" name in the driver before you register anything, or add
1807 * some other attributes for userspace to find the device, or use udev to add
1808 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1809 * don't even want to get into that and try to implement the missing pieces in
1810 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001811 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001812int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001813{
Tejun Heo4b30ee52013-09-11 22:29:06 -04001814 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001815 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001816 int error;
1817
1818 dev = get_device(dev);
1819 if (!dev)
1820 return -EINVAL;
1821
ethan.zhao69df7532013-10-13 22:12:35 +08001822 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001823
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001824 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001825 if (!old_device_name) {
1826 error = -ENOMEM;
1827 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001828 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001829
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001830 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04001831 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1832 kobj, old_device_name,
1833 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001834 if (error)
1835 goto out;
1836 }
Kay Sievers39aba962010-09-04 22:33:14 -07001837
Tejun Heo4b30ee52013-09-11 22:29:06 -04001838 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001839 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001840 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001841
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001842out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001843 put_device(dev);
1844
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001845 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001846
1847 return error;
1848}
Johannes Berga2807db2007-02-28 12:38:31 +01001849EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001850
1851static int device_move_class_links(struct device *dev,
1852 struct device *old_parent,
1853 struct device *new_parent)
1854{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001855 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001856
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001857 if (old_parent)
1858 sysfs_remove_link(&dev->kobj, "device");
1859 if (new_parent)
1860 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1861 "device");
1862 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001863}
1864
1865/**
1866 * device_move - moves a device to a new parent
1867 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001868 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001869 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001870 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001871int device_move(struct device *dev, struct device *new_parent,
1872 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001873{
1874 int error;
1875 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001876 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001877
1878 dev = get_device(dev);
1879 if (!dev)
1880 return -EINVAL;
1881
Cornelia Huckffa6a702009-03-04 12:44:00 +01001882 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001883 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001884 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001885
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001886 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1887 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001888 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001889 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001890 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001891 put_device(new_parent);
1892 goto out;
1893 }
1894 old_parent = dev->parent;
1895 dev->parent = new_parent;
1896 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001897 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001898 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001899 klist_add_tail(&dev->p->knode_parent,
1900 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001901 set_dev_node(dev, dev_to_node(new_parent));
1902 }
1903
Rabin Vincentbdd40342012-04-23 09:16:36 +02001904 if (dev->class) {
1905 error = device_move_class_links(dev, old_parent, new_parent);
1906 if (error) {
1907 /* We ignore errors on cleanup since we're hosed anyway... */
1908 device_move_class_links(dev, new_parent, old_parent);
1909 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1910 if (new_parent)
1911 klist_remove(&dev->p->knode_parent);
1912 dev->parent = old_parent;
1913 if (old_parent) {
1914 klist_add_tail(&dev->p->knode_parent,
1915 &old_parent->p->klist_children);
1916 set_dev_node(dev, dev_to_node(old_parent));
1917 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001918 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001919 cleanup_glue_dir(dev, new_parent_kobj);
1920 put_device(new_parent);
1921 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001922 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001923 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001924 switch (dpm_order) {
1925 case DPM_ORDER_NONE:
1926 break;
1927 case DPM_ORDER_DEV_AFTER_PARENT:
1928 device_pm_move_after(dev, new_parent);
1929 break;
1930 case DPM_ORDER_PARENT_BEFORE_DEV:
1931 device_pm_move_before(new_parent, dev);
1932 break;
1933 case DPM_ORDER_DEV_LAST:
1934 device_pm_move_last(dev);
1935 break;
1936 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001937
Cornelia Huck8a824722006-11-20 17:07:51 +01001938 put_device(old_parent);
1939out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001940 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001941 put_device(dev);
1942 return error;
1943}
Cornelia Huck8a824722006-11-20 17:07:51 +01001944EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001945
1946/**
1947 * device_shutdown - call ->shutdown() on each device to shutdown.
1948 */
1949void device_shutdown(void)
1950{
Benson Leungf123db82013-09-24 20:05:11 -07001951 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001952
Hugh Daschbach62458382010-03-22 10:36:37 -07001953 spin_lock(&devices_kset->list_lock);
1954 /*
1955 * Walk the devices list backward, shutting down each in turn.
1956 * Beware that device unplug events may also start pulling
1957 * devices offline, even as the system is shutting down.
1958 */
1959 while (!list_empty(&devices_kset->list)) {
1960 dev = list_entry(devices_kset->list.prev, struct device,
1961 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08001962
1963 /*
1964 * hold reference count of device's parent to
1965 * prevent it from being freed because parent's
1966 * lock is to be held
1967 */
Benson Leungf123db82013-09-24 20:05:11 -07001968 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001969 get_device(dev);
1970 /*
1971 * Make sure the device is off the kset list, in the
1972 * event that dev->*->shutdown() doesn't remove it.
1973 */
1974 list_del_init(&dev->kobj.entry);
1975 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001976
Ming Leid1c6c032012-06-22 18:01:40 +08001977 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07001978 if (parent)
1979 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001980 device_lock(dev);
1981
Alan Sternfe6b91f2011-12-06 23:24:52 +01001982 /* Don't allow any more runtime suspends */
1983 pm_runtime_get_noresume(dev);
1984 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001985
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001986 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001987 if (initcall_debug)
1988 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001989 dev->bus->shutdown(dev);
1990 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001991 if (initcall_debug)
1992 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001993 dev->driver->shutdown(dev);
1994 }
Ming Leid1c6c032012-06-22 18:01:40 +08001995
1996 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07001997 if (parent)
1998 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001999
Hugh Daschbach62458382010-03-22 10:36:37 -07002000 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002001 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002002
2003 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002004 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002005 spin_unlock(&devices_kset->list_lock);
Shaohua Li401097e2009-05-12 13:37:57 -07002006 async_synchronize_full();
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002007}
Joe Perches99bcf212010-06-27 01:02:34 +00002008
2009/*
2010 * Device logging functions
2011 */
2012
2013#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002014static int
2015create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002016{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002017 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002018 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002019
Kay Sieversc4e00da2012-05-03 02:29:59 +02002020 if (dev->class)
2021 subsys = dev->class->name;
2022 else if (dev->bus)
2023 subsys = dev->bus->name;
2024 else
Joe Perches798efc62012-09-12 20:11:29 -07002025 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002026
Joe Perches798efc62012-09-12 20:11:29 -07002027 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002028
2029 /*
2030 * Add device identifier DEVICE=:
2031 * b12:8 block dev_t
2032 * c127:3 char dev_t
2033 * n8 netdev ifindex
2034 * +sound:card0 subsystem:devname
2035 */
2036 if (MAJOR(dev->devt)) {
2037 char c;
2038
2039 if (strcmp(subsys, "block") == 0)
2040 c = 'b';
2041 else
2042 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002043 pos++;
2044 pos += snprintf(hdr + pos, hdrlen - pos,
2045 "DEVICE=%c%u:%u",
2046 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002047 } else if (strcmp(subsys, "net") == 0) {
2048 struct net_device *net = to_net_dev(dev);
2049
Joe Perches798efc62012-09-12 20:11:29 -07002050 pos++;
2051 pos += snprintf(hdr + pos, hdrlen - pos,
2052 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002053 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002054 pos++;
2055 pos += snprintf(hdr + pos, hdrlen - pos,
2056 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002057 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002058
Joe Perches798efc62012-09-12 20:11:29 -07002059 return pos;
Joe Perches99bcf212010-06-27 01:02:34 +00002060}
Joe Perches798efc62012-09-12 20:11:29 -07002061EXPORT_SYMBOL(create_syslog_header);
2062
Joe Perches05e4e5b2012-09-12 20:13:37 -07002063int dev_vprintk_emit(int level, const struct device *dev,
2064 const char *fmt, va_list args)
2065{
2066 char hdr[128];
2067 size_t hdrlen;
2068
2069 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2070
2071 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2072}
2073EXPORT_SYMBOL(dev_vprintk_emit);
2074
2075int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2076{
2077 va_list args;
2078 int r;
2079
2080 va_start(args, fmt);
2081
2082 r = dev_vprintk_emit(level, dev, fmt, args);
2083
2084 va_end(args);
2085
2086 return r;
2087}
2088EXPORT_SYMBOL(dev_printk_emit);
2089
Joe Perches798efc62012-09-12 20:11:29 -07002090static int __dev_printk(const char *level, const struct device *dev,
2091 struct va_format *vaf)
2092{
Joe Perches798efc62012-09-12 20:11:29 -07002093 if (!dev)
2094 return printk("%s(NULL device *): %pV", level, vaf);
2095
Joe Perches666f3552012-09-12 20:14:11 -07002096 return dev_printk_emit(level[1] - '0', dev,
2097 "%s %s: %pV",
2098 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002099}
Joe Perches99bcf212010-06-27 01:02:34 +00002100
2101int dev_printk(const char *level, const struct device *dev,
2102 const char *fmt, ...)
2103{
2104 struct va_format vaf;
2105 va_list args;
2106 int r;
2107
2108 va_start(args, fmt);
2109
2110 vaf.fmt = fmt;
2111 vaf.va = &args;
2112
2113 r = __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002114
Joe Perches99bcf212010-06-27 01:02:34 +00002115 va_end(args);
2116
2117 return r;
2118}
2119EXPORT_SYMBOL(dev_printk);
2120
2121#define define_dev_printk_level(func, kern_level) \
2122int func(const struct device *dev, const char *fmt, ...) \
2123{ \
2124 struct va_format vaf; \
2125 va_list args; \
2126 int r; \
2127 \
2128 va_start(args, fmt); \
2129 \
2130 vaf.fmt = fmt; \
2131 vaf.va = &args; \
2132 \
2133 r = __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002134 \
Joe Perches99bcf212010-06-27 01:02:34 +00002135 va_end(args); \
2136 \
2137 return r; \
2138} \
2139EXPORT_SYMBOL(func);
2140
2141define_dev_printk_level(dev_emerg, KERN_EMERG);
2142define_dev_printk_level(dev_alert, KERN_ALERT);
2143define_dev_printk_level(dev_crit, KERN_CRIT);
2144define_dev_printk_level(dev_err, KERN_ERR);
2145define_dev_printk_level(dev_warn, KERN_WARNING);
2146define_dev_printk_level(dev_notice, KERN_NOTICE);
2147define_dev_printk_level(_dev_info, KERN_INFO);
2148
2149#endif