blob: 20da3ad1696b58ef6aa6a91830070063e1dc21d7 [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>
Peter Chenaf8db152011-11-15 21:52:29 +010026#include <linux/pm_runtime.h>
Kay Sieversc4e00da2012-05-03 02:29:59 +020027#include <linux/netdevice.h>
Greg Kroah-Hartman63967682013-08-27 10:24:15 -070028#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#include "base.h"
31#include "power/power.h"
32
Andi Kleene52eec12010-09-08 16:54:17 +020033#ifdef CONFIG_SYSFS_DEPRECATED
34#ifdef CONFIG_SYSFS_DEPRECATED_V2
35long sysfs_deprecated = 1;
36#else
37long sysfs_deprecated = 0;
38#endif
Hanjun Guo3454bf92013-08-17 20:42:24 +080039static int __init sysfs_deprecated_setup(char *arg)
Andi Kleene52eec12010-09-08 16:54:17 +020040{
Jingoo Han34da5e62013-07-26 13:10:22 +090041 return kstrtol(arg, 10, &sysfs_deprecated);
Andi Kleene52eec12010-09-08 16:54:17 +020042}
43early_param("sysfs.deprecated", sysfs_deprecated_setup);
44#endif
45
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080046int (*platform_notify)(struct device *dev) = NULL;
47int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070048static struct kobject *dev_kobj;
49struct kobject *sysfs_dev_char_kobj;
50struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +020052static DEFINE_MUTEX(device_hotplug_lock);
53
54void lock_device_hotplug(void)
55{
56 mutex_lock(&device_hotplug_lock);
57}
58
59void unlock_device_hotplug(void)
60{
61 mutex_unlock(&device_hotplug_lock);
62}
63
64int lock_device_hotplug_sysfs(void)
65{
66 if (mutex_trylock(&device_hotplug_lock))
67 return 0;
68
69 /* Avoid busy looping (5 ms of sleep should do). */
70 msleep(5);
71 return restart_syscall();
72}
73
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080074#ifdef CONFIG_BLOCK
75static inline int device_is_not_partition(struct device *dev)
76{
77 return !(dev->type == &part_type);
78}
79#else
80static inline int device_is_not_partition(struct device *dev)
81{
82 return 1;
83}
84#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Alan Stern3e956372006-06-16 17:10:48 -040086/**
87 * dev_driver_string - Return a device's driver name, if at all possible
88 * @dev: struct device to get the name of
89 *
90 * Will return the device's driver's name if it is bound to a device. If
yan9169c012012-04-20 21:08:45 +080091 * the device is not bound to a driver, it will return the name of the bus
Alan Stern3e956372006-06-16 17:10:48 -040092 * it is attached to. If it is not attached to a bus either, an empty
93 * string will be returned.
94 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070095const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040096{
Alan Stern35899722009-12-04 11:06:57 -050097 struct device_driver *drv;
98
99 /* dev->driver can change to NULL underneath us because of unbinding,
100 * so be careful about accessing it. dev->bus and dev->class should
101 * never change once they are set, so they don't need special care.
102 */
103 drv = ACCESS_ONCE(dev->driver);
104 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +0100105 (dev->bus ? dev->bus->name :
106 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -0400107}
Matthew Wilcox310a9222006-09-23 23:35:04 -0600108EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -0400109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
111
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800112static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
113 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800115 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200116 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500117 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400120 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -0800121 if (ret >= (ssize_t)PAGE_SIZE) {
Greg Kroah-Hartman53a9c872013-01-17 13:10:23 -0800122 print_symbol("dev_attr_show: %s returned bad count\n",
123 (unsigned long)dev_attr->show);
Andrew Morton815d2d52008-03-04 15:09:07 -0800124 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 return ret;
126}
127
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800128static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
129 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800131 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200132 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500133 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400136 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 return ret;
138}
139
Emese Revfy52cf25d2010-01-19 02:58:23 +0100140static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 .show = dev_attr_show,
142 .store = dev_attr_store,
143};
144
Kay Sieversca22e562011-12-14 14:29:38 -0800145#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
146
147ssize_t device_store_ulong(struct device *dev,
148 struct device_attribute *attr,
149 const char *buf, size_t size)
150{
151 struct dev_ext_attribute *ea = to_ext_attr(attr);
152 char *end;
153 unsigned long new = simple_strtoul(buf, &end, 0);
154 if (end == buf)
155 return -EINVAL;
156 *(unsigned long *)(ea->var) = new;
157 /* Always return full write size even if we didn't consume all */
158 return size;
159}
160EXPORT_SYMBOL_GPL(device_store_ulong);
161
162ssize_t device_show_ulong(struct device *dev,
163 struct device_attribute *attr,
164 char *buf)
165{
166 struct dev_ext_attribute *ea = to_ext_attr(attr);
167 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
168}
169EXPORT_SYMBOL_GPL(device_show_ulong);
170
171ssize_t device_store_int(struct device *dev,
172 struct device_attribute *attr,
173 const char *buf, size_t size)
174{
175 struct dev_ext_attribute *ea = to_ext_attr(attr);
176 char *end;
177 long new = simple_strtol(buf, &end, 0);
178 if (end == buf || new > INT_MAX || new < INT_MIN)
179 return -EINVAL;
180 *(int *)(ea->var) = new;
181 /* Always return full write size even if we didn't consume all */
182 return size;
183}
184EXPORT_SYMBOL_GPL(device_store_int);
185
186ssize_t device_show_int(struct device *dev,
187 struct device_attribute *attr,
188 char *buf)
189{
190 struct dev_ext_attribute *ea = to_ext_attr(attr);
191
192 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
193}
194EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Borislav Petkov91872392012-10-09 19:52:05 +0200196ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
197 const char *buf, size_t size)
198{
199 struct dev_ext_attribute *ea = to_ext_attr(attr);
200
201 if (strtobool(buf, ea->var) < 0)
202 return -EINVAL;
203
204 return size;
205}
206EXPORT_SYMBOL_GPL(device_store_bool);
207
208ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
209 char *buf)
210{
211 struct dev_ext_attribute *ea = to_ext_attr(attr);
212
213 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
214}
215EXPORT_SYMBOL_GPL(device_show_bool);
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/**
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400218 * device_release - free device structure.
219 * @kobj: device's kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 *
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400221 * This is called once the reference count for the object
222 * reaches 0. We forward the call to the device's release
223 * method, which should handle actually freeing the structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800225static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200227 struct device *dev = kobj_to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800228 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Ming Leia525a3d2012-07-25 01:42:29 +0800230 /*
231 * Some platform devices are driven without driver attached
232 * and managed resources may have been acquired. Make sure
233 * all resources are released.
234 *
235 * Drivers still can add resources into device after device
236 * is deleted but alive, so release devres here to avoid
237 * possible memory leak.
238 */
239 devres_release_all(dev);
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 if (dev->release)
242 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200243 else if (dev->type && dev->type->release)
244 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700245 else if (dev->class && dev->class->dev_release)
246 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700247 else
248 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800249 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100250 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800251 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
253
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700254static const void *device_namespace(struct kobject *kobj)
255{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200256 struct device *dev = kobj_to_dev(kobj);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700257 const void *ns = NULL;
258
259 if (dev->class && dev->class->ns_type)
260 ns = dev->class->namespace(dev);
261
262 return ns;
263}
264
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600265static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 .release = device_release,
267 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700268 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269};
270
271
Kay Sievers312c0042005-11-16 09:00:00 +0100272static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 struct kobj_type *ktype = get_ktype(kobj);
275
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600276 if (ktype == &device_ktype) {
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200277 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 if (dev->bus)
279 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700280 if (dev->class)
281 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 }
283 return 0;
284}
285
Kay Sievers312c0042005-11-16 09:00:00 +0100286static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200288 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700290 if (dev->bus)
291 return dev->bus->name;
292 if (dev->class)
293 return dev->class->name;
294 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
296
Kay Sievers7eff2e72007-08-14 15:15:12 +0200297static int dev_uevent(struct kset *kset, struct kobject *kobj,
298 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200300 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 int retval = 0;
302
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200303 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700304 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200305 const char *tmp;
306 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400307 umode_t mode = 0;
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700308 kuid_t uid = GLOBAL_ROOT_UID;
309 kgid_t gid = GLOBAL_ROOT_GID;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200310
Kay Sievers7eff2e72007-08-14 15:15:12 +0200311 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
312 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700313 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200314 if (name) {
315 add_uevent_var(env, "DEVNAME=%s", name);
Kay Sieverse454cea2009-09-18 23:01:12 +0200316 if (mode)
317 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700318 if (!uid_eq(uid, GLOBAL_ROOT_UID))
319 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
320 if (!gid_eq(gid, GLOBAL_ROOT_GID))
321 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700322 kfree(tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200323 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700324 }
325
Kay Sievers414264f2007-03-12 21:08:57 +0100326 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200327 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100328
Kay Sievers239378f2006-10-07 21:54:55 +0200329 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200330 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200331
Grant Likely07d57a32012-02-01 11:22:22 -0700332 /* Add common DT information about the device */
333 of_device_uevent(dev, env);
334
Kay Sievers7eff2e72007-08-14 15:15:12 +0200335 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100336 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200337 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200338 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800339 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100340 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 }
342
Kay Sievers7eff2e72007-08-14 15:15:12 +0200343 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700344 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200345 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200346 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800347 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100348 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800349 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200350 }
351
Stefan Weileef35c22010-08-06 21:11:15 +0200352 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200353 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200354 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200355 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800356 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100357 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800358 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700359 }
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 return retval;
362}
363
Emese Revfy9cd43612009-12-31 14:52:51 +0100364static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100365 .filter = dev_uevent_filter,
366 .name = dev_uevent_name,
367 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368};
369
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700370static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
Kay Sievers16574dc2007-04-06 01:40:38 +0200371 char *buf)
372{
373 struct kobject *top_kobj;
374 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200375 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200376 int i;
377 size_t count = 0;
378 int retval;
379
380 /* search the kset, the device belongs to */
381 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200382 while (!top_kobj->kset && top_kobj->parent)
383 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200384 if (!top_kobj->kset)
385 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200386
Kay Sievers16574dc2007-04-06 01:40:38 +0200387 kset = top_kobj->kset;
388 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
389 goto out;
390
391 /* respect filter */
392 if (kset->uevent_ops && kset->uevent_ops->filter)
393 if (!kset->uevent_ops->filter(kset, &dev->kobj))
394 goto out;
395
Kay Sievers7eff2e72007-08-14 15:15:12 +0200396 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
397 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200398 return -ENOMEM;
399
Kay Sievers16574dc2007-04-06 01:40:38 +0200400 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200401 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200402 if (retval)
403 goto out;
404
405 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200406 for (i = 0; i < env->envp_idx; i++)
407 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200408out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200409 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200410 return count;
411}
412
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700413static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
Kay Sieversa7fd6702005-10-01 14:49:43 +0200414 const char *buf, size_t count)
415{
Kay Sievers60a96a52007-07-08 22:29:26 +0200416 enum kobject_action action;
417
Kay Sievers3f5468c2010-01-14 22:54:37 +0100418 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200419 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100420 else
421 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200422 return count;
423}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700424static DEVICE_ATTR_RW(uevent);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200425
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700426static ssize_t online_show(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200427 char *buf)
428{
429 bool val;
430
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200431 device_lock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200432 val = !dev->offline;
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200433 device_unlock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200434 return sprintf(buf, "%u\n", val);
435}
436
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700437static ssize_t online_store(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200438 const char *buf, size_t count)
439{
440 bool val;
441 int ret;
442
443 ret = strtobool(buf, &val);
444 if (ret < 0)
445 return ret;
446
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200447 ret = lock_device_hotplug_sysfs();
448 if (ret)
449 return ret;
450
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200451 ret = val ? device_online(dev) : device_offline(dev);
452 unlock_device_hotplug();
453 return ret < 0 ? ret : count;
454}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700455static DEVICE_ATTR_RW(online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200456
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700457int device_add_groups(struct device *dev, const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500458{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -0700459 return sysfs_create_groups(&dev->kobj, groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500460}
461
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700462void device_remove_groups(struct device *dev,
463 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500464{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -0700465 sysfs_remove_groups(&dev->kobj, groups);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700466}
467
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700468static int device_add_attrs(struct device *dev)
469{
470 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700471 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500472 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700473
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500474 if (class) {
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700475 error = device_add_groups(dev, class->dev_groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200476 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500477 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700478 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200479
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500480 if (type) {
481 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200482 if (error)
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700483 goto err_remove_class_groups;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200484 }
485
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500486 error = device_add_groups(dev, dev->groups);
487 if (error)
488 goto err_remove_type_groups;
489
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200490 if (device_supports_offline(dev) && !dev->offline_disabled) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700491 error = device_create_file(dev, &dev_attr_online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200492 if (error)
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100493 goto err_remove_dev_groups;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200494 }
495
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500496 return 0;
497
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +0100498 err_remove_dev_groups:
499 device_remove_groups(dev, dev->groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500500 err_remove_type_groups:
501 if (type)
502 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700503 err_remove_class_groups:
504 if (class)
505 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500506
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700507 return error;
508}
509
510static void device_remove_attrs(struct device *dev)
511{
512 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700513 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700514
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700515 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500516 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200517
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500518 if (type)
519 device_remove_groups(dev, type->groups);
520
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -0700521 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700522 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700523}
524
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700525static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700526 char *buf)
527{
528 return print_dev_t(buf, dev->devt);
529}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700530static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900531
Kay Sieversca22e562011-12-14 14:29:38 -0800532/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600533struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800536 * device_create_file - create sysfs attribute file for device.
537 * @dev: device.
538 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200540int device_create_file(struct device *dev,
541 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200544
545 if (dev) {
546 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800547 "Attribute %s: write permission without 'store'\n",
548 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200549 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +0800550 "Attribute %s: read permission without 'show'\n",
551 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +0200553 }
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 return error;
556}
David Graham White86df2682013-07-21 20:41:14 -0400557EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800560 * device_remove_file - remove sysfs attribute file.
561 * @dev: device.
562 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 */
Phil Carmody26579ab2009-12-18 15:34:19 +0200564void device_remove_file(struct device *dev,
565 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100567 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
David Graham White86df2682013-07-21 20:41:14 -0400570EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700572/**
Tejun Heo6b0afc22014-02-03 14:03:01 -0500573 * device_remove_file_self - remove sysfs attribute file from its own method.
574 * @dev: device.
575 * @attr: device attribute descriptor.
576 *
577 * See kernfs_remove_self() for details.
578 */
579bool device_remove_file_self(struct device *dev,
580 const struct device_attribute *attr)
581{
582 if (dev)
583 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
584 else
585 return false;
586}
587EXPORT_SYMBOL_GPL(device_remove_file_self);
588
589/**
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700590 * device_create_bin_file - create sysfs binary attribute file for device.
591 * @dev: device.
592 * @attr: device binary attribute descriptor.
593 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200594int device_create_bin_file(struct device *dev,
595 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700596{
597 int error = -EINVAL;
598 if (dev)
599 error = sysfs_create_bin_file(&dev->kobj, attr);
600 return error;
601}
602EXPORT_SYMBOL_GPL(device_create_bin_file);
603
604/**
605 * device_remove_bin_file - remove sysfs binary attribute file
606 * @dev: device.
607 * @attr: device binary attribute descriptor.
608 */
Phil Carmody66ecb922009-12-18 15:34:20 +0200609void device_remove_bin_file(struct device *dev,
610 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700611{
612 if (dev)
613 sysfs_remove_bin_file(&dev->kobj, attr);
614}
615EXPORT_SYMBOL_GPL(device_remove_bin_file);
616
James Bottomley34bb61f2005-09-06 16:56:51 -0700617static void klist_children_get(struct klist_node *n)
618{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800619 struct device_private *p = to_device_private_parent(n);
620 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700621
622 get_device(dev);
623}
624
625static void klist_children_put(struct klist_node *n)
626{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -0800627 struct device_private *p = to_device_private_parent(n);
628 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -0700629
630 put_device(dev);
631}
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800634 * device_initialize - init device structure.
635 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 *
Cornelia Huck57394112008-09-03 18:26:40 +0200637 * This prepares the device for use by other layers by initializing
638 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800639 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200640 * that function, though it can also be called separately, so one
641 * may use @dev's fields. In particular, get_device()/put_device()
642 * may be used for reference counting of @dev after calling this
643 * function.
644 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500645 * All fields in @dev must be initialized by the caller to 0, except
646 * for those explicitly set to some other value. The simplest
647 * approach is to use kzalloc() to allocate the structure containing
648 * @dev.
649 *
Cornelia Huck57394112008-09-03 18:26:40 +0200650 * NOTE: Use put_device() to give up your reference instead of freeing
651 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653void device_initialize(struct device *dev)
654{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600655 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700656 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +0000658 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +0100659 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +0900660 spin_lock_init(&dev->devres_lock);
661 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -0400662 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800663 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664}
David Graham White86df2682013-07-21 20:41:14 -0400665EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Tejun Heod73ce002013-03-12 11:30:05 -0700667struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700668{
Kay Sievers86406242007-03-14 03:25:56 +0100669 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700670
Kay Sievers86406242007-03-14 03:25:56 +0100671 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800672 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600673 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700674
Kay Sievers86406242007-03-14 03:25:56 +0100675 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700676}
677
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700678struct class_dir {
679 struct kobject kobj;
680 struct class *class;
681};
682
683#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
684
685static void class_dir_release(struct kobject *kobj)
686{
687 struct class_dir *dir = to_class_dir(kobj);
688 kfree(dir);
689}
690
691static const
692struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
693{
694 struct class_dir *dir = to_class_dir(kobj);
695 return dir->class->ns_type;
696}
697
698static struct kobj_type class_dir_ktype = {
699 .release = class_dir_release,
700 .sysfs_ops = &kobj_sysfs_ops,
701 .child_ns_type = class_dir_child_ns_type
702};
703
704static struct kobject *
705class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
706{
707 struct class_dir *dir;
708 int retval;
709
710 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
711 if (!dir)
712 return NULL;
713
714 dir->class = class;
715 kobject_init(&dir->kobj, &class_dir_ktype);
716
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100717 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700718
719 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
720 if (retval < 0) {
721 kobject_put(&dir->kobj);
722 return NULL;
723 }
724 return &dir->kobj;
725}
726
727
Kay Sieversda231fd2007-11-21 17:29:15 +0100728static struct kobject *get_device_parent(struct device *dev,
729 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100730{
Kay Sievers86406242007-03-14 03:25:56 +0100731 if (dev->class) {
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900732 static DEFINE_MUTEX(gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100733 struct kobject *kobj = NULL;
734 struct kobject *parent_kobj;
735 struct kobject *k;
736
Randy Dunlapead454f2010-09-24 14:36:49 -0700737#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700738 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +0200739 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -0700740 if (parent && parent->class == &block_class)
741 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100742 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -0700743 }
Randy Dunlapead454f2010-09-24 14:36:49 -0700744#endif
Andi Kleene52eec12010-09-08 16:54:17 +0200745
Kay Sievers86406242007-03-14 03:25:56 +0100746 /*
747 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100748 * Class-devices with a non class-device as parent, live
749 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100750 */
751 if (parent == NULL)
752 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -0700753 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +0100754 return &parent->kobj;
755 else
756 parent_kobj = &parent->kobj;
757
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900758 mutex_lock(&gdp_mutex);
759
Kay Sievers86406242007-03-14 03:25:56 +0100760 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100761 spin_lock(&dev->class->p->glue_dirs.list_lock);
762 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100763 if (k->parent == parent_kobj) {
764 kobj = kobject_get(k);
765 break;
766 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100767 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900768 if (kobj) {
769 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +0100770 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900771 }
Kay Sievers86406242007-03-14 03:25:56 +0100772
773 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700774 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100775 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +0900776 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800777 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100778 }
779
Kay Sieversca22e562011-12-14 14:29:38 -0800780 /* subsystems can specify a default root directory for their devices */
781 if (!parent && dev->bus && dev->bus->dev_root)
782 return &dev->bus->dev_root->kobj;
783
Kay Sievers86406242007-03-14 03:25:56 +0100784 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100785 return &parent->kobj;
786 return NULL;
787}
Kay Sieversda231fd2007-11-21 17:29:15 +0100788
Cornelia Huck63b69712008-01-21 16:09:44 +0100789static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100790{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100791 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100792 if (!glue_dir || !dev->class ||
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100793 glue_dir->kset != &dev->class->p->glue_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100794 return;
795
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100796 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100797}
Cornelia Huck63b69712008-01-21 16:09:44 +0100798
799static void cleanup_device_parent(struct device *dev)
800{
801 cleanup_glue_dir(dev, dev->kobj.parent);
802}
Kay Sievers86406242007-03-14 03:25:56 +0100803
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700804static int device_add_class_symlinks(struct device *dev)
805{
806 int error;
807
808 if (!dev->class)
809 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100810
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700811 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100812 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700813 "subsystem");
814 if (error)
815 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100816
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800817 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700818 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
819 "device");
820 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -0700821 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700822 }
Kay Sievers39aba962010-09-04 22:33:14 -0700823
Randy Dunlapead454f2010-09-24 14:36:49 -0700824#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -0700825 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +0200826 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700827 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -0700828#endif
Kay Sievers39aba962010-09-04 22:33:14 -0700829
830 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100831 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -0700832 &dev->kobj, dev_name(dev));
833 if (error)
834 goto out_device;
835
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700836 return 0;
837
Kay Sievers39aba962010-09-04 22:33:14 -0700838out_device:
839 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +0100840
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700841out_subsys:
842 sysfs_remove_link(&dev->kobj, "subsystem");
843out:
844 return error;
845}
846
847static void device_remove_class_symlinks(struct device *dev)
848{
849 if (!dev->class)
850 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100851
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800852 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100853 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700854 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -0700855#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +0200856 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -0700857 return;
Randy Dunlapead454f2010-09-24 14:36:49 -0700858#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100859 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -0700860}
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000863 * dev_set_name - set a device name
864 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700865 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000866 */
867int dev_set_name(struct device *dev, const char *fmt, ...)
868{
869 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100870 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000871
872 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100873 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000874 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100875 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000876}
877EXPORT_SYMBOL_GPL(dev_set_name);
878
879/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700880 * device_to_dev_kobj - select a /sys/dev/ directory for the device
881 * @dev: device
882 *
883 * By default we select char/ for new entries. Setting class->dev_obj
884 * to NULL prevents an entry from being created. class->dev_kobj must
885 * be set (or cleared) before any devices are registered to the class
886 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +0200887 * device_remove_sys_dev_entry() will disagree about the presence of
888 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -0700889 */
890static struct kobject *device_to_dev_kobj(struct device *dev)
891{
892 struct kobject *kobj;
893
894 if (dev->class)
895 kobj = dev->class->dev_kobj;
896 else
897 kobj = sysfs_dev_char_kobj;
898
899 return kobj;
900}
901
902static int device_create_sys_dev_entry(struct device *dev)
903{
904 struct kobject *kobj = device_to_dev_kobj(dev);
905 int error = 0;
906 char devt_str[15];
907
908 if (kobj) {
909 format_dev_t(devt_str, dev->devt);
910 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
911 }
912
913 return error;
914}
915
916static void device_remove_sys_dev_entry(struct device *dev)
917{
918 struct kobject *kobj = device_to_dev_kobj(dev);
919 char devt_str[15];
920
921 if (kobj) {
922 format_dev_t(devt_str, dev->devt);
923 sysfs_remove_link(kobj, devt_str);
924 }
925}
926
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700927int device_private_init(struct device *dev)
928{
929 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
930 if (!dev->p)
931 return -ENOMEM;
932 dev->p->device = dev;
933 klist_init(&dev->p->klist_children, klist_children_get,
934 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -0800935 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700936 return 0;
937}
938
Dan Williamse105b8b2008-04-21 10:51:07 -0700939/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800940 * device_add - add device to device hierarchy.
941 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800943 * This is part 2 of device_register(), though may be called
944 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 *
Cornelia Huck57394112008-09-03 18:26:40 +0200946 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800947 * to the global and sibling lists for the device, then
948 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200949 *
Alan Sternb10d5ef2012-01-17 11:39:00 -0500950 * Do not call this routine or device_register() more than once for
951 * any device structure. The driver model core is not designed to work
952 * with devices that get unregistered and then spring back to life.
953 * (Among other things, it's very hard to guarantee that all references
954 * to the previous incarnation of @dev have been dropped.) Allocate
955 * and register a fresh new struct device instead.
956 *
Cornelia Huck57394112008-09-03 18:26:40 +0200957 * NOTE: _Never_ directly free @dev after calling this function, even
958 * if it returned an error! Always use put_device() to give up your
959 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 */
961int device_add(struct device *dev)
962{
963 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -0800964 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200965 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700966 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700969 if (!dev)
970 goto done;
971
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800972 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700973 error = device_private_init(dev);
974 if (error)
975 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800976 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800977
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100978 /*
979 * for statically allocated devices, which should all be converted
980 * some day, we need to initialize the name. We prevent reading back
981 * the name, and force the use of dev_name()
982 */
983 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700984 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100985 dev->init_name = NULL;
986 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700987
Kay Sieversca22e562011-12-14 14:29:38 -0800988 /* subsystems can specify simple device enumeration */
989 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
990 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
991
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000992 if (!dev_name(dev)) {
993 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -0700994 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +0000995 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100997 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001000 kobj = get_device_parent(dev, parent);
1001 if (kobj)
1002 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Yinghai Lu0d358f22008-02-19 03:20:41 -08001004 /* use parent numa_node */
1005 if (parent)
1006 set_dev_node(dev, dev_to_node(parent));
1007
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001009 /* we require the name to be set before, and pass NULL */
1010 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001011 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001013
Brian Walsh37022642006-08-14 22:43:19 -07001014 /* notify platform of device entry */
1015 if (platform_notify)
1016 platform_notify(dev);
1017
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001018 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001019 if (error)
1020 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001021
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001022 if (MAJOR(dev->devt)) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001023 error = device_create_file(dev, &dev_attr_dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001024 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +02001025 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -07001026
1027 error = device_create_sys_dev_entry(dev);
1028 if (error)
1029 goto devtattrError;
Kay Sievers2b2af542009-04-30 15:23:42 +02001030
1031 devtmpfs_create_node(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001032 }
1033
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001034 error = device_add_class_symlinks(dev);
1035 if (error)
1036 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001037 error = device_add_attrs(dev);
1038 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001039 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001040 error = bus_add_device(dev);
1041 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001043 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001044 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001045 goto DPMError;
1046 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001047
1048 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001049 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001050 */
1051 if (dev->bus)
1052 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1053 BUS_NOTIFY_ADD_DEVICE, dev);
1054
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001055 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001056 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001058 klist_add_tail(&dev->p->knode_parent,
1059 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001061 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001062 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001063 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001064 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001065 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001066
1067 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001068 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001069 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001070 if (class_intf->add_dev)
1071 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001072 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001073 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001074done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 put_device(dev);
1076 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -04001077 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001078 bus_remove_device(dev);
1079 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001080 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001081 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001082 device_remove_class_symlinks(dev);
1083 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +09001084 if (MAJOR(dev->devt))
Kay Sieversad729562009-10-28 19:51:37 +01001085 devtmpfs_delete_node(dev);
1086 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -07001087 device_remove_sys_dev_entry(dev);
1088 devtattrError:
1089 if (MAJOR(dev->devt))
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001090 device_remove_file(dev, &dev_attr_dev);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001091 ueventattrError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001092 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001093 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001094 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 kobject_del(&dev->kobj);
1096 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +01001097 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 if (parent)
1099 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001100name_error:
1101 kfree(dev->p);
1102 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001103 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104}
David Graham White86df2682013-07-21 20:41:14 -04001105EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001108 * device_register - register a device with the system.
1109 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001111 * This happens in two clean steps - initialize the device
1112 * and add it to the system. The two steps can be called
1113 * separately, but this is the easiest and most common.
1114 * I.e. you should only call the two helpers separately if
1115 * have a clearly defined need to use and refcount the device
1116 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001117 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001118 * For more information, see the kerneldoc for device_initialize()
1119 * and device_add().
1120 *
Cornelia Huck57394112008-09-03 18:26:40 +02001121 * NOTE: _Never_ directly free @dev after calling this function, even
1122 * if it returned an error! Always use put_device() to give up the
1123 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125int device_register(struct device *dev)
1126{
1127 device_initialize(dev);
1128 return device_add(dev);
1129}
David Graham White86df2682013-07-21 20:41:14 -04001130EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001133 * get_device - increment reference count for device.
1134 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001136 * This simply forwards the call to kobject_get(), though
1137 * we do take care to provide for the case that we get a NULL
1138 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001140struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001142 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143}
David Graham White86df2682013-07-21 20:41:14 -04001144EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001147 * put_device - decrement reference count.
1148 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001150void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001152 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 if (dev)
1154 kobject_put(&dev->kobj);
1155}
David Graham White86df2682013-07-21 20:41:14 -04001156EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001159 * device_del - delete device from system.
1160 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001162 * This is the first part of the device unregistration
1163 * sequence. This removes the device from the lists we control
1164 * from here, has it removed from the other driver model
1165 * subsystems it was added to in device_add(), and removes it
1166 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001168 * NOTE: this should be called manually _iff_ device_add() was
1169 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001171void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001173 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001174 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Alan Sternec0676ee2008-12-05 14:10:31 -05001176 /* Notify clients of device removal. This call must come
1177 * before dpm_sysfs_remove().
1178 */
1179 if (dev->bus)
1180 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1181 BUS_NOTIFY_DEL_DEVICE, dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001182 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001184 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001185 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001186 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001187 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001188 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001189 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001190 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001191 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001192
Kay Sieversca22e562011-12-14 14:29:38 -08001193 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001194 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001195 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001196 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001197 if (class_intf->remove_dev)
1198 class_intf->remove_dev(dev, class_intf);
1199 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001200 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001201 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001202 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001203 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001204 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001205 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001206 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001207 driver_deferred_probe_del(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 /* Notify the platform of the removal, in case they
1210 * need to do anything...
1211 */
1212 if (platform_notify_remove)
1213 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001214 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001215 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001217 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218}
David Graham White86df2682013-07-21 20:41:14 -04001219EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001222 * device_unregister - unregister device from system.
1223 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001225 * We do this in two parts, like we do device_register(). First,
1226 * we remove it from all the subsystems with device_del(), then
1227 * we decrement the reference count via put_device(). If that
1228 * is the final reference count, the device will be cleaned up
1229 * via device_release() above. Otherwise, the structure will
1230 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001232void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001234 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 device_del(dev);
1236 put_device(dev);
1237}
David Graham White86df2682013-07-21 20:41:14 -04001238EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001240static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001241{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001242 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001243 struct device *dev = NULL;
1244 struct device_private *p;
1245
1246 if (n) {
1247 p = to_device_private_parent(n);
1248 dev = p->device;
1249 }
1250 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001251}
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001254 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001255 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001256 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001257 * @uid: returned file owner
1258 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001259 * @tmp: possibly allocated string
1260 *
1261 * Return the relative path of a possible device node.
1262 * Non-default names may need to allocate a memory to compose
1263 * a name. This memory is returned in tmp and needs to be
1264 * freed by the caller.
1265 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001266const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001267 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001268 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001269{
1270 char *s;
1271
1272 *tmp = NULL;
1273
1274 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001275 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001276 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001277 if (*tmp)
1278 return *tmp;
1279
1280 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001281 if (dev->class && dev->class->devnode)
1282 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001283 if (*tmp)
1284 return *tmp;
1285
1286 /* return name without allocation, tmp == NULL */
1287 if (strchr(dev_name(dev), '!') == NULL)
1288 return dev_name(dev);
1289
1290 /* replace '!' in the name with '/' */
1291 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1292 if (!*tmp)
1293 return NULL;
1294 while ((s = strchr(*tmp, '!')))
1295 s[0] = '/';
1296 return *tmp;
1297}
1298
1299/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001300 * device_for_each_child - device child iterator.
1301 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001302 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001303 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001305 * Iterate over @parent's child devices, and call @fn for each,
1306 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001308 * We check the return of @fn each time. If it returns anything
1309 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001311int device_for_each_child(struct device *parent, void *data,
1312 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001314 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001315 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 int error = 0;
1317
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001318 if (!parent->p)
1319 return 0;
1320
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001321 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001322 while ((child = next_device(&i)) && !error)
1323 error = fn(child, data);
1324 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 return error;
1326}
David Graham White86df2682013-07-21 20:41:14 -04001327EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Cornelia Huck5ab69982006-11-16 15:42:07 +01001329/**
1330 * device_find_child - device iterator for locating a particular device.
1331 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01001332 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001333 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01001334 *
1335 * This is similar to the device_for_each_child() function above, but it
1336 * returns a reference to a device that is 'found' for later use, as
1337 * determined by the @match callback.
1338 *
1339 * The callback should return 0 if the device doesn't match and non-zero
1340 * if it does. If the callback returns non-zero and a reference to the
1341 * current device can be obtained, this function will return to the caller
1342 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02001343 *
1344 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01001345 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001346struct device *device_find_child(struct device *parent, void *data,
1347 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001348{
1349 struct klist_iter i;
1350 struct device *child;
1351
1352 if (!parent)
1353 return NULL;
1354
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001355 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001356 while ((child = next_device(&i)))
1357 if (match(child, data) && get_device(child))
1358 break;
1359 klist_iter_exit(&i);
1360 return child;
1361}
David Graham White86df2682013-07-21 20:41:14 -04001362EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364int __init devices_init(void)
1365{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001366 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1367 if (!devices_kset)
1368 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001369 dev_kobj = kobject_create_and_add("dev", NULL);
1370 if (!dev_kobj)
1371 goto dev_kobj_err;
1372 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1373 if (!sysfs_dev_block_kobj)
1374 goto block_kobj_err;
1375 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1376 if (!sysfs_dev_char_kobj)
1377 goto char_kobj_err;
1378
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001379 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001380
1381 char_kobj_err:
1382 kobject_put(sysfs_dev_block_kobj);
1383 block_kobj_err:
1384 kobject_put(dev_kobj);
1385 dev_kobj_err:
1386 kset_unregister(devices_kset);
1387 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388}
1389
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001390static int device_check_offline(struct device *dev, void *not_used)
1391{
1392 int ret;
1393
1394 ret = device_for_each_child(dev, NULL, device_check_offline);
1395 if (ret)
1396 return ret;
1397
1398 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1399}
1400
1401/**
1402 * device_offline - Prepare the device for hot-removal.
1403 * @dev: Device to be put offline.
1404 *
1405 * Execute the device bus type's .offline() callback, if present, to prepare
1406 * the device for a subsequent hot-removal. If that succeeds, the device must
1407 * not be used until either it is removed or its bus type's .online() callback
1408 * is executed.
1409 *
1410 * Call under device_hotplug_lock.
1411 */
1412int device_offline(struct device *dev)
1413{
1414 int ret;
1415
1416 if (dev->offline_disabled)
1417 return -EPERM;
1418
1419 ret = device_for_each_child(dev, NULL, device_check_offline);
1420 if (ret)
1421 return ret;
1422
1423 device_lock(dev);
1424 if (device_supports_offline(dev)) {
1425 if (dev->offline) {
1426 ret = 1;
1427 } else {
1428 ret = dev->bus->offline(dev);
1429 if (!ret) {
1430 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1431 dev->offline = true;
1432 }
1433 }
1434 }
1435 device_unlock(dev);
1436
1437 return ret;
1438}
1439
1440/**
1441 * device_online - Put the device back online after successful device_offline().
1442 * @dev: Device to be put back online.
1443 *
1444 * If device_offline() has been successfully executed for @dev, but the device
1445 * has not been removed subsequently, execute its bus type's .online() callback
1446 * to indicate that the device can be used again.
1447 *
1448 * Call under device_hotplug_lock.
1449 */
1450int device_online(struct device *dev)
1451{
1452 int ret = 0;
1453
1454 device_lock(dev);
1455 if (device_supports_offline(dev)) {
1456 if (dev->offline) {
1457 ret = dev->bus->online(dev);
1458 if (!ret) {
1459 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1460 dev->offline = false;
1461 }
1462 } else {
1463 ret = 1;
1464 }
1465 }
1466 device_unlock(dev);
1467
1468 return ret;
1469}
1470
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05001471struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001472 struct device dev;
1473 struct module *owner;
1474};
1475
Josh Triplett93058422012-11-18 21:27:55 -08001476static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01001477{
1478 return container_of(d, struct root_device, dev);
1479}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001480
1481static void root_device_release(struct device *dev)
1482{
1483 kfree(to_root_device(dev));
1484}
1485
1486/**
1487 * __root_device_register - allocate and register a root device
1488 * @name: root device name
1489 * @owner: owner module of the root device, usually THIS_MODULE
1490 *
1491 * This function allocates a root device and registers it
1492 * using device_register(). In order to free the returned
1493 * device, use root_device_unregister().
1494 *
1495 * Root devices are dummy devices which allow other devices
1496 * to be grouped under /sys/devices. Use this function to
1497 * allocate a root device and then use it as the parent of
1498 * any device which should appear under /sys/devices/{name}
1499 *
1500 * The /sys/devices/{name} directory will also contain a
1501 * 'module' symlink which points to the @owner directory
1502 * in sysfs.
1503 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001504 * Returns &struct device pointer on success, or ERR_PTR() on error.
1505 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001506 * Note: You probably want to use root_device_register().
1507 */
1508struct device *__root_device_register(const char *name, struct module *owner)
1509{
1510 struct root_device *root;
1511 int err = -ENOMEM;
1512
1513 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1514 if (!root)
1515 return ERR_PTR(err);
1516
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001517 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001518 if (err) {
1519 kfree(root);
1520 return ERR_PTR(err);
1521 }
1522
1523 root->dev.release = root_device_release;
1524
1525 err = device_register(&root->dev);
1526 if (err) {
1527 put_device(&root->dev);
1528 return ERR_PTR(err);
1529 }
1530
Christoph Egger1d9e8822010-05-17 16:57:58 +02001531#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001532 if (owner) {
1533 struct module_kobject *mk = &owner->mkobj;
1534
1535 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1536 if (err) {
1537 device_unregister(&root->dev);
1538 return ERR_PTR(err);
1539 }
1540 root->owner = owner;
1541 }
1542#endif
1543
1544 return &root->dev;
1545}
1546EXPORT_SYMBOL_GPL(__root_device_register);
1547
1548/**
1549 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08001550 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001551 *
1552 * This function unregisters and cleans up a device that was created by
1553 * root_device_register().
1554 */
1555void root_device_unregister(struct device *dev)
1556{
1557 struct root_device *root = to_root_device(dev);
1558
1559 if (root->owner)
1560 sysfs_remove_link(&root->dev.kobj, "module");
1561
1562 device_unregister(dev);
1563}
1564EXPORT_SYMBOL_GPL(root_device_unregister);
1565
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001566
1567static void device_create_release(struct device *dev)
1568{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001569 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001570 kfree(dev);
1571}
1572
Guenter Roeck39ef3112013-07-14 16:05:57 -07001573static struct device *
1574device_create_groups_vargs(struct class *class, struct device *parent,
1575 dev_t devt, void *drvdata,
1576 const struct attribute_group **groups,
1577 const char *fmt, va_list args)
1578{
1579 struct device *dev = NULL;
1580 int retval = -ENODEV;
1581
1582 if (class == NULL || IS_ERR(class))
1583 goto error;
1584
1585 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1586 if (!dev) {
1587 retval = -ENOMEM;
1588 goto error;
1589 }
1590
David Herrmannbbc780f2013-11-21 20:15:48 +01001591 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001592 dev->devt = devt;
1593 dev->class = class;
1594 dev->parent = parent;
1595 dev->groups = groups;
1596 dev->release = device_create_release;
1597 dev_set_drvdata(dev, drvdata);
1598
1599 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1600 if (retval)
1601 goto error;
1602
David Herrmannbbc780f2013-11-21 20:15:48 +01001603 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001604 if (retval)
1605 goto error;
1606
1607 return dev;
1608
1609error:
1610 put_device(dev);
1611 return ERR_PTR(retval);
1612}
1613
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001614/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001615 * device_create_vargs - creates a device and registers it with sysfs
1616 * @class: pointer to the struct class that this device should be registered to
1617 * @parent: pointer to the parent struct device of this new device, if any
1618 * @devt: the dev_t for the char device to be added
1619 * @drvdata: the data to be added to the device for callbacks
1620 * @fmt: string for the device's name
1621 * @args: va_list for the device's name
1622 *
1623 * This function can be used by char device classes. A struct device
1624 * will be created in sysfs, registered to the specified class.
1625 *
1626 * A "dev" file will be created, showing the dev_t for the device, if
1627 * the dev_t is not 0,0.
1628 * If a pointer to a parent struct device is passed in, the newly created
1629 * struct device will be a child of that device in sysfs.
1630 * The pointer to the struct device will be returned from the call.
1631 * Any further sysfs files that might be required can be created using this
1632 * pointer.
1633 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001634 * Returns &struct device pointer on success, or ERR_PTR() on error.
1635 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001636 * Note: the struct class passed to this function must have previously
1637 * been created with a call to class_create().
1638 */
1639struct device *device_create_vargs(struct class *class, struct device *parent,
1640 dev_t devt, void *drvdata, const char *fmt,
1641 va_list args)
1642{
Guenter Roeck39ef3112013-07-14 16:05:57 -07001643 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1644 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001645}
1646EXPORT_SYMBOL_GPL(device_create_vargs);
1647
1648/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001649 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001650 * @class: pointer to the struct class that this device should be registered to
1651 * @parent: pointer to the parent struct device of this new device, if any
1652 * @devt: the dev_t for the char device to be added
1653 * @drvdata: the data to be added to the device for callbacks
1654 * @fmt: string for the device's name
1655 *
1656 * This function can be used by char device classes. A struct device
1657 * will be created in sysfs, registered to the specified class.
1658 *
1659 * A "dev" file will be created, showing the dev_t for the device, if
1660 * the dev_t is not 0,0.
1661 * If a pointer to a parent struct device is passed in, the newly created
1662 * struct device will be a child of that device in sysfs.
1663 * The pointer to the struct device will be returned from the call.
1664 * Any further sysfs files that might be required can be created using this
1665 * pointer.
1666 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02001667 * Returns &struct device pointer on success, or ERR_PTR() on error.
1668 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001669 * Note: the struct class passed to this function must have previously
1670 * been created with a call to class_create().
1671 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001672struct device *device_create(struct class *class, struct device *parent,
1673 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001674{
1675 va_list vargs;
1676 struct device *dev;
1677
1678 va_start(vargs, fmt);
1679 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1680 va_end(vargs);
1681 return dev;
1682}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001683EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001684
Guenter Roeck39ef3112013-07-14 16:05:57 -07001685/**
1686 * device_create_with_groups - creates a device and registers it with sysfs
1687 * @class: pointer to the struct class that this device should be registered to
1688 * @parent: pointer to the parent struct device of this new device, if any
1689 * @devt: the dev_t for the char device to be added
1690 * @drvdata: the data to be added to the device for callbacks
1691 * @groups: NULL-terminated list of attribute groups to be created
1692 * @fmt: string for the device's name
1693 *
1694 * This function can be used by char device classes. A struct device
1695 * will be created in sysfs, registered to the specified class.
1696 * Additional attributes specified in the groups parameter will also
1697 * be created automatically.
1698 *
1699 * A "dev" file will be created, showing the dev_t for the device, if
1700 * the dev_t is not 0,0.
1701 * If a pointer to a parent struct device is passed in, the newly created
1702 * struct device will be a child of that device in sysfs.
1703 * The pointer to the struct device will be returned from the call.
1704 * Any further sysfs files that might be required can be created using this
1705 * pointer.
1706 *
1707 * Returns &struct device pointer on success, or ERR_PTR() on error.
1708 *
1709 * Note: the struct class passed to this function must have previously
1710 * been created with a call to class_create().
1711 */
1712struct device *device_create_with_groups(struct class *class,
1713 struct device *parent, dev_t devt,
1714 void *drvdata,
1715 const struct attribute_group **groups,
1716 const char *fmt, ...)
1717{
1718 va_list vargs;
1719 struct device *dev;
1720
1721 va_start(vargs, fmt);
1722 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1723 fmt, vargs);
1724 va_end(vargs);
1725 return dev;
1726}
1727EXPORT_SYMBOL_GPL(device_create_with_groups);
1728
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001729static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001730{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001731 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001732
Dave Youngcd354492008-01-28 16:56:11 +08001733 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001734}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001735
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001736/**
1737 * device_destroy - removes a device that was created with device_create()
1738 * @class: pointer to the struct class that this device was registered with
1739 * @devt: the dev_t of the device that was previously registered
1740 *
1741 * This call unregisters and cleans up a device that was created with a
1742 * call to device_create().
1743 */
1744void device_destroy(struct class *class, dev_t devt)
1745{
1746 struct device *dev;
1747
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001748 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001749 if (dev) {
1750 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001751 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001752 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001753}
1754EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001755
1756/**
1757 * device_rename - renames a device
1758 * @dev: the pointer to the struct device to be renamed
1759 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001760 *
1761 * It is the responsibility of the caller to provide mutual
1762 * exclusion between two different calls of device_rename
1763 * on the same device to ensure that new_name is valid and
1764 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11001765 *
Timur Tabia5462512010-12-13 14:08:52 -06001766 * Note: Don't call this function. Currently, the networking layer calls this
1767 * function, but that will change. The following text from Kay Sievers offers
1768 * some insight:
1769 *
1770 * Renaming devices is racy at many levels, symlinks and other stuff are not
1771 * replaced atomically, and you get a "move" uevent, but it's not easy to
1772 * connect the event to the old and new device. Device nodes are not renamed at
1773 * all, there isn't even support for that in the kernel now.
1774 *
1775 * In the meantime, during renaming, your target name might be taken by another
1776 * driver, creating conflicts. Or the old name is taken directly after you
1777 * renamed it -- then you get events for the same DEVPATH, before you even see
1778 * the "move" event. It's just a mess, and nothing new should ever rely on
1779 * kernel device renaming. Besides that, it's not even implemented now for
1780 * other things than (driver-core wise very simple) network devices.
1781 *
1782 * We are currently about to change network renaming in udev to completely
1783 * disallow renaming of devices in the same namespace as the kernel uses,
1784 * because we can't solve the problems properly, that arise with swapping names
1785 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1786 * be allowed to some other name than eth[0-9]*, for the aforementioned
1787 * reasons.
1788 *
1789 * Make up a "real" name in the driver before you register anything, or add
1790 * some other attributes for userspace to find the device, or use udev to add
1791 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1792 * don't even want to get into that and try to implement the missing pieces in
1793 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001794 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02001795int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001796{
Tejun Heo4b30ee52013-09-11 22:29:06 -04001797 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001798 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001799 int error;
1800
1801 dev = get_device(dev);
1802 if (!dev)
1803 return -EINVAL;
1804
ethan.zhao69df7532013-10-13 22:12:35 +08001805 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001806
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001807 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001808 if (!old_device_name) {
1809 error = -ENOMEM;
1810 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001811 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001812
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001813 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04001814 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1815 kobj, old_device_name,
1816 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07001817 if (error)
1818 goto out;
1819 }
Kay Sievers39aba962010-09-04 22:33:14 -07001820
Tejun Heo4b30ee52013-09-11 22:29:06 -04001821 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001822 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001823 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001824
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001825out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001826 put_device(dev);
1827
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001828 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001829
1830 return error;
1831}
Johannes Berga2807db2007-02-28 12:38:31 +01001832EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001833
1834static int device_move_class_links(struct device *dev,
1835 struct device *old_parent,
1836 struct device *new_parent)
1837{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001838 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001839
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001840 if (old_parent)
1841 sysfs_remove_link(&dev->kobj, "device");
1842 if (new_parent)
1843 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1844 "device");
1845 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001846}
1847
1848/**
1849 * device_move - moves a device to a new parent
1850 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001851 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01001852 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01001853 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01001854int device_move(struct device *dev, struct device *new_parent,
1855 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01001856{
1857 int error;
1858 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001859 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001860
1861 dev = get_device(dev);
1862 if (!dev)
1863 return -EINVAL;
1864
Cornelia Huckffa6a702009-03-04 12:44:00 +01001865 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001866 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001867 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001868
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001869 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1870 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001871 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001872 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001873 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001874 put_device(new_parent);
1875 goto out;
1876 }
1877 old_parent = dev->parent;
1878 dev->parent = new_parent;
1879 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001880 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001881 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001882 klist_add_tail(&dev->p->knode_parent,
1883 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001884 set_dev_node(dev, dev_to_node(new_parent));
1885 }
1886
Rabin Vincentbdd40342012-04-23 09:16:36 +02001887 if (dev->class) {
1888 error = device_move_class_links(dev, old_parent, new_parent);
1889 if (error) {
1890 /* We ignore errors on cleanup since we're hosed anyway... */
1891 device_move_class_links(dev, new_parent, old_parent);
1892 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1893 if (new_parent)
1894 klist_remove(&dev->p->knode_parent);
1895 dev->parent = old_parent;
1896 if (old_parent) {
1897 klist_add_tail(&dev->p->knode_parent,
1898 &old_parent->p->klist_children);
1899 set_dev_node(dev, dev_to_node(old_parent));
1900 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08001901 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001902 cleanup_glue_dir(dev, new_parent_kobj);
1903 put_device(new_parent);
1904 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01001905 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001906 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01001907 switch (dpm_order) {
1908 case DPM_ORDER_NONE:
1909 break;
1910 case DPM_ORDER_DEV_AFTER_PARENT:
1911 device_pm_move_after(dev, new_parent);
1912 break;
1913 case DPM_ORDER_PARENT_BEFORE_DEV:
1914 device_pm_move_before(new_parent, dev);
1915 break;
1916 case DPM_ORDER_DEV_LAST:
1917 device_pm_move_last(dev);
1918 break;
1919 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02001920
Cornelia Huck8a824722006-11-20 17:07:51 +01001921 put_device(old_parent);
1922out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01001923 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01001924 put_device(dev);
1925 return error;
1926}
Cornelia Huck8a824722006-11-20 17:07:51 +01001927EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001928
1929/**
1930 * device_shutdown - call ->shutdown() on each device to shutdown.
1931 */
1932void device_shutdown(void)
1933{
Benson Leungf123db82013-09-24 20:05:11 -07001934 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001935
Hugh Daschbach62458382010-03-22 10:36:37 -07001936 spin_lock(&devices_kset->list_lock);
1937 /*
1938 * Walk the devices list backward, shutting down each in turn.
1939 * Beware that device unplug events may also start pulling
1940 * devices offline, even as the system is shutting down.
1941 */
1942 while (!list_empty(&devices_kset->list)) {
1943 dev = list_entry(devices_kset->list.prev, struct device,
1944 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08001945
1946 /*
1947 * hold reference count of device's parent to
1948 * prevent it from being freed because parent's
1949 * lock is to be held
1950 */
Benson Leungf123db82013-09-24 20:05:11 -07001951 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001952 get_device(dev);
1953 /*
1954 * Make sure the device is off the kset list, in the
1955 * event that dev->*->shutdown() doesn't remove it.
1956 */
1957 list_del_init(&dev->kobj.entry);
1958 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01001959
Ming Leid1c6c032012-06-22 18:01:40 +08001960 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07001961 if (parent)
1962 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001963 device_lock(dev);
1964
Alan Sternfe6b91f2011-12-06 23:24:52 +01001965 /* Don't allow any more runtime suspends */
1966 pm_runtime_get_noresume(dev);
1967 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07001968
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001969 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001970 if (initcall_debug)
1971 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001972 dev->bus->shutdown(dev);
1973 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08001974 if (initcall_debug)
1975 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001976 dev->driver->shutdown(dev);
1977 }
Ming Leid1c6c032012-06-22 18:01:40 +08001978
1979 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07001980 if (parent)
1981 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08001982
Hugh Daschbach62458382010-03-22 10:36:37 -07001983 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07001984 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07001985
1986 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001987 }
Hugh Daschbach62458382010-03-22 10:36:37 -07001988 spin_unlock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001989}
Joe Perches99bcf212010-06-27 01:02:34 +00001990
1991/*
1992 * Device logging functions
1993 */
1994
1995#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07001996static int
1997create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00001998{
Kay Sieversc4e00da2012-05-03 02:29:59 +02001999 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002000 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002001
Kay Sieversc4e00da2012-05-03 02:29:59 +02002002 if (dev->class)
2003 subsys = dev->class->name;
2004 else if (dev->bus)
2005 subsys = dev->bus->name;
2006 else
Joe Perches798efc62012-09-12 20:11:29 -07002007 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002008
Joe Perches798efc62012-09-12 20:11:29 -07002009 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002010
2011 /*
2012 * Add device identifier DEVICE=:
2013 * b12:8 block dev_t
2014 * c127:3 char dev_t
2015 * n8 netdev ifindex
2016 * +sound:card0 subsystem:devname
2017 */
2018 if (MAJOR(dev->devt)) {
2019 char c;
2020
2021 if (strcmp(subsys, "block") == 0)
2022 c = 'b';
2023 else
2024 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002025 pos++;
2026 pos += snprintf(hdr + pos, hdrlen - pos,
2027 "DEVICE=%c%u:%u",
2028 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002029 } else if (strcmp(subsys, "net") == 0) {
2030 struct net_device *net = to_net_dev(dev);
2031
Joe Perches798efc62012-09-12 20:11:29 -07002032 pos++;
2033 pos += snprintf(hdr + pos, hdrlen - pos,
2034 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002035 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002036 pos++;
2037 pos += snprintf(hdr + pos, hdrlen - pos,
2038 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002039 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002040
Joe Perches798efc62012-09-12 20:11:29 -07002041 return pos;
Joe Perches99bcf212010-06-27 01:02:34 +00002042}
Joe Perches798efc62012-09-12 20:11:29 -07002043
Joe Perches05e4e5b2012-09-12 20:13:37 -07002044int dev_vprintk_emit(int level, const struct device *dev,
2045 const char *fmt, va_list args)
2046{
2047 char hdr[128];
2048 size_t hdrlen;
2049
2050 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2051
2052 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2053}
2054EXPORT_SYMBOL(dev_vprintk_emit);
2055
2056int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2057{
2058 va_list args;
2059 int r;
2060
2061 va_start(args, fmt);
2062
2063 r = dev_vprintk_emit(level, dev, fmt, args);
2064
2065 va_end(args);
2066
2067 return r;
2068}
2069EXPORT_SYMBOL(dev_printk_emit);
2070
Joe Perches798efc62012-09-12 20:11:29 -07002071static int __dev_printk(const char *level, const struct device *dev,
2072 struct va_format *vaf)
2073{
Joe Perches798efc62012-09-12 20:11:29 -07002074 if (!dev)
2075 return printk("%s(NULL device *): %pV", level, vaf);
2076
Joe Perches666f3552012-09-12 20:14:11 -07002077 return dev_printk_emit(level[1] - '0', dev,
2078 "%s %s: %pV",
2079 dev_driver_string(dev), dev_name(dev), vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002080}
Joe Perches99bcf212010-06-27 01:02:34 +00002081
2082int dev_printk(const char *level, const struct device *dev,
2083 const char *fmt, ...)
2084{
2085 struct va_format vaf;
2086 va_list args;
2087 int r;
2088
2089 va_start(args, fmt);
2090
2091 vaf.fmt = fmt;
2092 vaf.va = &args;
2093
2094 r = __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002095
Joe Perches99bcf212010-06-27 01:02:34 +00002096 va_end(args);
2097
2098 return r;
2099}
2100EXPORT_SYMBOL(dev_printk);
2101
2102#define define_dev_printk_level(func, kern_level) \
2103int func(const struct device *dev, const char *fmt, ...) \
2104{ \
2105 struct va_format vaf; \
2106 va_list args; \
2107 int r; \
2108 \
2109 va_start(args, fmt); \
2110 \
2111 vaf.fmt = fmt; \
2112 vaf.va = &args; \
2113 \
2114 r = __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002115 \
Joe Perches99bcf212010-06-27 01:02:34 +00002116 va_end(args); \
2117 \
2118 return r; \
2119} \
2120EXPORT_SYMBOL(func);
2121
2122define_dev_printk_level(dev_emerg, KERN_EMERG);
2123define_dev_printk_level(dev_alert, KERN_ALERT);
2124define_dev_printk_level(dev_crit, KERN_CRIT);
2125define_dev_printk_level(dev_err, KERN_ERR);
2126define_dev_printk_level(dev_warn, KERN_WARNING);
2127define_dev_printk_level(dev_notice, KERN_NOTICE);
2128define_dev_printk_level(_dev_info, KERN_INFO);
2129
2130#endif