blob: 55e530942ab0a705c452028c133e8eed15a5fdb6 [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>
Kay Sieversda231fd2007-11-21 17:29:15 +010021#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080022#include <linux/kallsyms.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040023#include <linux/semaphore.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070024#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include "base.h"
27#include "power/power.h"
28
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080029int (*platform_notify)(struct device *dev) = NULL;
30int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -070031static struct kobject *dev_kobj;
32struct kobject *sysfs_dev_char_kobj;
33struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080035#ifdef CONFIG_BLOCK
36static inline int device_is_not_partition(struct device *dev)
37{
38 return !(dev->type == &part_type);
39}
40#else
41static inline int device_is_not_partition(struct device *dev)
42{
43 return 1;
44}
45#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Alan Stern3e956372006-06-16 17:10:48 -040047/**
48 * dev_driver_string - Return a device's driver name, if at all possible
49 * @dev: struct device to get the name of
50 *
51 * Will return the device's driver's name if it is bound to a device. If
52 * the device is not bound to a device, it will return the name of the bus
53 * it is attached to. If it is not attached to a bus either, an empty
54 * string will be returned.
55 */
Jean Delvarebf9ca692008-07-30 12:29:21 -070056const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -040057{
58 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010059 (dev->bus ? dev->bus->name :
60 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040061}
Matthew Wilcox310a9222006-09-23 23:35:04 -060062EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040063
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#define to_dev(obj) container_of(obj, struct device, kobj)
65#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
66
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080067static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
68 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080070 struct device_attribute *dev_attr = to_dev_attr(attr);
71 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050072 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040075 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080076 if (ret >= (ssize_t)PAGE_SIZE) {
77 print_symbol("dev_attr_show: %s returned bad count\n",
78 (unsigned long)dev_attr->show);
79 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 return ret;
81}
82
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080083static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
84 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080086 struct device_attribute *dev_attr = to_dev_attr(attr);
87 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050088 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040091 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return ret;
93}
94
95static struct sysfs_ops dev_sysfs_ops = {
96 .show = dev_attr_show,
97 .store = dev_attr_store,
98};
99
100
101/**
102 * device_release - free device structure.
103 * @kobj: device's kobject.
104 *
105 * This is called once the reference count for the object
106 * reaches 0. We forward the call to the device's release
107 * method, which should handle actually freeing the structure.
108 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800109static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800111 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 if (dev->release)
114 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200115 else if (dev->type && dev->type->release)
116 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700117 else if (dev->class && dev->class->dev_release)
118 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700119 else
120 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800121 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100122 dev_name(dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123}
124
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600125static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 .release = device_release,
127 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128};
129
130
Kay Sievers312c0042005-11-16 09:00:00 +0100131static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
133 struct kobj_type *ktype = get_ktype(kobj);
134
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600135 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200137 if (dev->uevent_suppress)
138 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 if (dev->bus)
140 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700141 if (dev->class)
142 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 }
144 return 0;
145}
146
Kay Sievers312c0042005-11-16 09:00:00 +0100147static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
149 struct device *dev = to_dev(kobj);
150
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700151 if (dev->bus)
152 return dev->bus->name;
153 if (dev->class)
154 return dev->class->name;
155 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
Kay Sievers7eff2e72007-08-14 15:15:12 +0200158static int dev_uevent(struct kset *kset, struct kobject *kobj,
159 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
161 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 int retval = 0;
163
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700164 /* add the major/minor if present */
165 if (MAJOR(dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200166 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
167 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700168 }
169
Kay Sievers414264f2007-03-12 21:08:57 +0100170 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200171 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100172
Kay Sievers239378f2006-10-07 21:54:55 +0200173 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200174 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200175
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200176#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200177 if (dev->class) {
178 struct device *parent = dev->parent;
179
180 /* find first bus device in parent chain */
181 while (parent && !parent->bus)
182 parent = parent->parent;
183 if (parent && parent->bus) {
184 const char *path;
185
186 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200187 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200188 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200189 kfree(path);
190 }
Kay Sievers239378f2006-10-07 21:54:55 +0200191
Kay Sievers7eff2e72007-08-14 15:15:12 +0200192 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200193
194 if (parent->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200195 add_uevent_var(env, "PHYSDEVDRIVER=%s",
196 parent->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200197 }
198 } else if (dev->bus) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200199 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200200
201 if (dev->driver)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800202 add_uevent_var(env, "PHYSDEVDRIVER=%s",
203 dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200204 }
Kay Sievers239378f2006-10-07 21:54:55 +0200205#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Kay Sievers7eff2e72007-08-14 15:15:12 +0200207 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100208 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200209 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200210 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800211 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100212 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
214
Kay Sievers7eff2e72007-08-14 15:15:12 +0200215 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700216 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200217 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200218 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800219 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100220 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800221 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200222 }
223
Kay Sievers7eff2e72007-08-14 15:15:12 +0200224 /* have the device type specific fuction add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200225 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200226 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200227 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800228 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100229 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800230 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700231 }
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 return retval;
234}
235
Kay Sievers312c0042005-11-16 09:00:00 +0100236static struct kset_uevent_ops device_uevent_ops = {
237 .filter = dev_uevent_filter,
238 .name = dev_uevent_name,
239 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240};
241
Kay Sievers16574dc2007-04-06 01:40:38 +0200242static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
243 char *buf)
244{
245 struct kobject *top_kobj;
246 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200247 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200248 int i;
249 size_t count = 0;
250 int retval;
251
252 /* search the kset, the device belongs to */
253 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200254 while (!top_kobj->kset && top_kobj->parent)
255 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200256 if (!top_kobj->kset)
257 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200258
Kay Sievers16574dc2007-04-06 01:40:38 +0200259 kset = top_kobj->kset;
260 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
261 goto out;
262
263 /* respect filter */
264 if (kset->uevent_ops && kset->uevent_ops->filter)
265 if (!kset->uevent_ops->filter(kset, &dev->kobj))
266 goto out;
267
Kay Sievers7eff2e72007-08-14 15:15:12 +0200268 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
269 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200270 return -ENOMEM;
271
Kay Sievers16574dc2007-04-06 01:40:38 +0200272 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200273 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200274 if (retval)
275 goto out;
276
277 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200278 for (i = 0; i < env->envp_idx; i++)
279 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200280out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200281 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200282 return count;
283}
284
Kay Sieversa7fd6702005-10-01 14:49:43 +0200285static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
286 const char *buf, size_t count)
287{
Kay Sievers60a96a52007-07-08 22:29:26 +0200288 enum kobject_action action;
289
Kay Sievers5c5daf62007-08-12 20:43:55 +0200290 if (kobject_action_type(buf, count, &action) == 0) {
Kay Sievers60a96a52007-07-08 22:29:26 +0200291 kobject_uevent(&dev->kobj, action);
292 goto out;
293 }
294
295 dev_err(dev, "uevent: unsupported action-string; this will "
296 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100297 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200298out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200299 return count;
300}
301
Tejun Heoad6a1e12007-06-14 03:45:17 +0900302static struct device_attribute uevent_attr =
303 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
304
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500305static int device_add_attributes(struct device *dev,
306 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700307{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700308 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500309 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700310
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500311 if (attrs) {
312 for (i = 0; attr_name(attrs[i]); i++) {
313 error = device_create_file(dev, &attrs[i]);
314 if (error)
315 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700316 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500317 if (error)
318 while (--i >= 0)
319 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700320 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700321 return error;
322}
323
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500324static void device_remove_attributes(struct device *dev,
325 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700326{
327 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500328
329 if (attrs)
330 for (i = 0; attr_name(attrs[i]); i++)
331 device_remove_file(dev, &attrs[i]);
332}
333
334static int device_add_groups(struct device *dev,
335 struct attribute_group **groups)
336{
337 int error = 0;
338 int i;
339
340 if (groups) {
341 for (i = 0; groups[i]; i++) {
342 error = sysfs_create_group(&dev->kobj, groups[i]);
343 if (error) {
344 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800345 sysfs_remove_group(&dev->kobj,
346 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500347 break;
348 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700349 }
350 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500351 return error;
352}
353
354static void device_remove_groups(struct device *dev,
355 struct attribute_group **groups)
356{
357 int i;
358
359 if (groups)
360 for (i = 0; groups[i]; i++)
361 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700362}
363
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700364static int device_add_attrs(struct device *dev)
365{
366 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200367 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500368 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700369
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500370 if (class) {
371 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200372 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500373 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700374 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200375
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500376 if (type) {
377 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200378 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500379 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200380 }
381
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500382 error = device_add_groups(dev, dev->groups);
383 if (error)
384 goto err_remove_type_groups;
385
386 return 0;
387
388 err_remove_type_groups:
389 if (type)
390 device_remove_groups(dev, type->groups);
391 err_remove_class_attrs:
392 if (class)
393 device_remove_attributes(dev, class->dev_attrs);
394
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700395 return error;
396}
397
398static void device_remove_attrs(struct device *dev)
399{
400 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200401 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700402
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500403 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200404
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500405 if (type)
406 device_remove_groups(dev, type->groups);
407
408 if (class)
409 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700410}
411
412
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700413static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
414 char *buf)
415{
416 return print_dev_t(buf, dev->devt);
417}
418
Tejun Heoad6a1e12007-06-14 03:45:17 +0900419static struct device_attribute devt_attr =
420 __ATTR(dev, S_IRUGO, show_dev, NULL);
421
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600422/* kset to create /sys/devices/ */
423struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800426 * device_create_file - create sysfs attribute file for device.
427 * @dev: device.
428 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800430int device_create_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
432 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100433 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return error;
436}
437
438/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800439 * device_remove_file - remove sysfs attribute file.
440 * @dev: device.
441 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800443void device_remove_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100445 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700449/**
450 * device_create_bin_file - create sysfs binary attribute file for device.
451 * @dev: device.
452 * @attr: device binary attribute descriptor.
453 */
454int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
455{
456 int error = -EINVAL;
457 if (dev)
458 error = sysfs_create_bin_file(&dev->kobj, attr);
459 return error;
460}
461EXPORT_SYMBOL_GPL(device_create_bin_file);
462
463/**
464 * device_remove_bin_file - remove sysfs binary attribute file
465 * @dev: device.
466 * @attr: device binary attribute descriptor.
467 */
468void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
469{
470 if (dev)
471 sysfs_remove_bin_file(&dev->kobj, attr);
472}
473EXPORT_SYMBOL_GPL(device_remove_bin_file);
474
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400475/**
Alan Stern523ded72007-04-26 00:12:04 -0700476 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400477 * @dev: device.
478 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700479 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400480 *
481 * Attribute methods must not unregister themselves or their parent device
482 * (which would amount to the same thing). Attempts to do so will deadlock,
483 * since unregistration is mutually exclusive with driver callbacks.
484 *
485 * Instead methods can call this routine, which will attempt to allocate
486 * and schedule a workqueue request to call back @func with @dev as its
487 * argument in the workqueue's process context. @dev will be pinned until
488 * @func returns.
489 *
Alan Stern523ded72007-04-26 00:12:04 -0700490 * This routine is usually called via the inline device_schedule_callback(),
491 * which automatically sets @owner to THIS_MODULE.
492 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400493 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700494 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400495 *
496 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
497 * underlying sysfs routine (since it is intended for use by attribute
498 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
499 */
Alan Stern523ded72007-04-26 00:12:04 -0700500int device_schedule_callback_owner(struct device *dev,
501 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400502{
503 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700504 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400505}
Alan Stern523ded72007-04-26 00:12:04 -0700506EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400507
James Bottomley34bb61f2005-09-06 16:56:51 -0700508static void klist_children_get(struct klist_node *n)
509{
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -0800510 struct device *dev = container_of(n, struct device, knode_parent);
James Bottomley34bb61f2005-09-06 16:56:51 -0700511
512 get_device(dev);
513}
514
515static void klist_children_put(struct klist_node *n)
516{
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -0800517 struct device *dev = container_of(n, struct device, knode_parent);
James Bottomley34bb61f2005-09-06 16:56:51 -0700518
519 put_device(dev);
520}
521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800523 * device_initialize - init device structure.
524 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 *
Cornelia Huck57394112008-09-03 18:26:40 +0200526 * This prepares the device for use by other layers by initializing
527 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800528 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +0200529 * that function, though it can also be called separately, so one
530 * may use @dev's fields. In particular, get_device()/put_device()
531 * may be used for reference counting of @dev after calling this
532 * function.
533 *
534 * NOTE: Use put_device() to give up your reference instead of freeing
535 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537void device_initialize(struct device *dev)
538{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600539 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700540 kobject_init(&dev->kobj, &device_ktype);
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -0800541 klist_init(&dev->klist_children, klist_children_get,
James Bottomley34bb61f2005-09-06 16:56:51 -0700542 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 INIT_LIST_HEAD(&dev->dma_pools);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800544 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900545 spin_lock_init(&dev->devres_lock);
546 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700547 device_init_wakeup(dev, 0);
Alan Stern3b98aea2008-08-07 13:06:12 -0400548 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800549 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550}
551
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100552#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sieversda231fd2007-11-21 17:29:15 +0100553static struct kobject *get_device_parent(struct device *dev,
554 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100555{
Kay Sieversda231fd2007-11-21 17:29:15 +0100556 /* class devices without a parent live in /sys/class/<classname>/ */
Dmitry Torokhov3eb215d2007-10-07 12:22:21 -0400557 if (dev->class && (!parent || parent->class != dev->class))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700558 return &dev->class->p->class_subsys.kobj;
Kay Sieversda231fd2007-11-21 17:29:15 +0100559 /* all other devices keep their parent */
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100560 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100561 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100562
Cornelia Huckc744aea2007-01-08 20:16:44 +0100563 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100564}
Kay Sieversda231fd2007-11-21 17:29:15 +0100565
566static inline void cleanup_device_parent(struct device *dev) {}
Cornelia Huck63b69712008-01-21 16:09:44 +0100567static inline void cleanup_glue_dir(struct device *dev,
568 struct kobject *glue_dir) {}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100569#else
Kay Sievers86406242007-03-14 03:25:56 +0100570static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700571{
Kay Sievers86406242007-03-14 03:25:56 +0100572 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700573
Kay Sievers86406242007-03-14 03:25:56 +0100574 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800575 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600576 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700577
Kay Sievers86406242007-03-14 03:25:56 +0100578 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700579}
580
Kay Sieversda231fd2007-11-21 17:29:15 +0100581static struct kobject *get_device_parent(struct device *dev,
582 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100583{
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800584 int retval;
585
Kay Sievers86406242007-03-14 03:25:56 +0100586 if (dev->class) {
587 struct kobject *kobj = NULL;
588 struct kobject *parent_kobj;
589 struct kobject *k;
590
591 /*
592 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100593 * Class-devices with a non class-device as parent, live
594 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100595 */
596 if (parent == NULL)
597 parent_kobj = virtual_device_parent(dev);
598 else if (parent->class)
599 return &parent->kobj;
600 else
601 parent_kobj = &parent->kobj;
602
603 /* find our class-directory at the parent and reference it */
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500604 spin_lock(&dev->class->p->class_dirs.list_lock);
605 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100606 if (k->parent == parent_kobj) {
607 kobj = kobject_get(k);
608 break;
609 }
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500610 spin_unlock(&dev->class->p->class_dirs.list_lock);
Kay Sievers86406242007-03-14 03:25:56 +0100611 if (kobj)
612 return kobj;
613
614 /* or create a new class-directory at the parent device */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800615 k = kobject_create();
616 if (!k)
617 return NULL;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500618 k->kset = &dev->class->p->class_dirs;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700619 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800620 if (retval < 0) {
621 kobject_put(k);
622 return NULL;
623 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100624 /* do not emit an uevent for this simple "glue" directory */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800625 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100626 }
627
628 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100629 return &parent->kobj;
630 return NULL;
631}
Kay Sieversda231fd2007-11-21 17:29:15 +0100632
Cornelia Huck63b69712008-01-21 16:09:44 +0100633static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100634{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100635 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100636 if (!glue_dir || !dev->class ||
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500637 glue_dir->kset != &dev->class->p->class_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100638 return;
639
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100640 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100641}
Cornelia Huck63b69712008-01-21 16:09:44 +0100642
643static void cleanup_device_parent(struct device *dev)
644{
645 cleanup_glue_dir(dev, dev->kobj.parent);
646}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100647#endif
Kay Sievers86406242007-03-14 03:25:56 +0100648
Cornelia Huck63b69712008-01-21 16:09:44 +0100649static void setup_parent(struct device *dev, struct device *parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100650{
651 struct kobject *kobj;
652 kobj = get_device_parent(dev, parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +0100653 if (kobj)
654 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100655}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100656
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700657static int device_add_class_symlinks(struct device *dev)
658{
659 int error;
660
661 if (!dev->class)
662 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100663
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700664 error = sysfs_create_link(&dev->kobj,
665 &dev->class->p->class_subsys.kobj,
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700666 "subsystem");
667 if (error)
668 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100669
670#ifdef CONFIG_SYSFS_DEPRECATED
671 /* stacked class devices need a symlink in the class directory */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700672 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800673 device_is_not_partition(dev)) {
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700674 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100675 &dev->kobj, dev_name(dev));
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700676 if (error)
677 goto out_subsys;
678 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100679
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800680 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100681 struct device *parent = dev->parent;
682 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700683
Kay Sieversda231fd2007-11-21 17:29:15 +0100684 /*
685 * stacked class devices have the 'device' link
686 * pointing to the bus device instead of the parent
687 */
688 while (parent->class && !parent->bus && parent->parent)
689 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700690
Kay Sieversda231fd2007-11-21 17:29:15 +0100691 error = sysfs_create_link(&dev->kobj,
692 &parent->kobj,
693 "device");
694 if (error)
695 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700696
Kay Sieversda231fd2007-11-21 17:29:15 +0100697 class_name = make_class_name(dev->class->name,
698 &dev->kobj);
699 if (class_name)
700 error = sysfs_create_link(&dev->parent->kobj,
701 &dev->kobj, class_name);
702 kfree(class_name);
703 if (error)
704 goto out_device;
705 }
706 return 0;
707
708out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800709 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100710 sysfs_remove_link(&dev->kobj, "device");
711out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700712 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800713 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700714 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100715 dev_name(dev));
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700716#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100717 /* link in the class directory pointing to the device */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700718 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100719 &dev->kobj, dev_name(dev));
Kay Sieversda231fd2007-11-21 17:29:15 +0100720 if (error)
721 goto out_subsys;
722
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800723 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700724 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
725 "device");
726 if (error)
727 goto out_busid;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700728 }
729 return 0;
730
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700731out_busid:
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100732 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
Kay Sieversda231fd2007-11-21 17:29:15 +0100733#endif
734
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700735out_subsys:
736 sysfs_remove_link(&dev->kobj, "subsystem");
737out:
738 return error;
739}
740
741static void device_remove_class_symlinks(struct device *dev)
742{
743 if (!dev->class)
744 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100745
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700746#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800747 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700748 char *class_name;
749
750 class_name = make_class_name(dev->class->name, &dev->kobj);
751 if (class_name) {
752 sysfs_remove_link(&dev->parent->kobj, class_name);
753 kfree(class_name);
754 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700755 sysfs_remove_link(&dev->kobj, "device");
756 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100757
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700758 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800759 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700760 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100761 dev_name(dev));
Kay Sieversda231fd2007-11-21 17:29:15 +0100762#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800763 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100764 sysfs_remove_link(&dev->kobj, "device");
765
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100766 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
Kay Sieversda231fd2007-11-21 17:29:15 +0100767#endif
768
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700769 sysfs_remove_link(&dev->kobj, "subsystem");
770}
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000773 * dev_set_name - set a device name
774 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700775 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000776 */
777int dev_set_name(struct device *dev, const char *fmt, ...)
778{
779 va_list vargs;
Roland Dreier7143f7a2009-01-09 22:27:42 -0800780 char *s;
Stephen Rothwell413c2392008-05-30 10:16:40 +1000781
782 va_start(vargs, fmt);
783 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
784 va_end(vargs);
Roland Dreier7143f7a2009-01-09 22:27:42 -0800785
786 /* ewww... some of these buggers have / in the name... */
787 while ((s = strchr(dev->bus_id, '/')))
788 *s = '!';
789
Stephen Rothwell413c2392008-05-30 10:16:40 +1000790 return 0;
791}
792EXPORT_SYMBOL_GPL(dev_set_name);
793
794/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700795 * device_to_dev_kobj - select a /sys/dev/ directory for the device
796 * @dev: device
797 *
798 * By default we select char/ for new entries. Setting class->dev_obj
799 * to NULL prevents an entry from being created. class->dev_kobj must
800 * be set (or cleared) before any devices are registered to the class
801 * otherwise device_create_sys_dev_entry() and
802 * device_remove_sys_dev_entry() will disagree about the the presence
803 * of the link.
804 */
805static struct kobject *device_to_dev_kobj(struct device *dev)
806{
807 struct kobject *kobj;
808
809 if (dev->class)
810 kobj = dev->class->dev_kobj;
811 else
812 kobj = sysfs_dev_char_kobj;
813
814 return kobj;
815}
816
817static int device_create_sys_dev_entry(struct device *dev)
818{
819 struct kobject *kobj = device_to_dev_kobj(dev);
820 int error = 0;
821 char devt_str[15];
822
823 if (kobj) {
824 format_dev_t(devt_str, dev->devt);
825 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
826 }
827
828 return error;
829}
830
831static void device_remove_sys_dev_entry(struct device *dev)
832{
833 struct kobject *kobj = device_to_dev_kobj(dev);
834 char devt_str[15];
835
836 if (kobj) {
837 format_dev_t(devt_str, dev->devt);
838 sysfs_remove_link(kobj, devt_str);
839 }
840}
841
842/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800843 * device_add - add device to device hierarchy.
844 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800846 * This is part 2 of device_register(), though may be called
847 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 *
Cornelia Huck57394112008-09-03 18:26:40 +0200849 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800850 * to the global and sibling lists for the device, then
851 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +0200852 *
853 * NOTE: _Never_ directly free @dev after calling this function, even
854 * if it returned an error! Always use put_device() to give up your
855 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 */
857int device_add(struct device *dev)
858{
859 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200860 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700861 int error = -EINVAL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700864 if (!dev)
865 goto done;
866
867 /* Temporarily support init_name if it is set.
868 * It will override bus_id for now */
869 if (dev->init_name)
870 dev_set_name(dev, "%s", dev->init_name);
871
872 if (!strlen(dev->bus_id))
873 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100875 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700876
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100878 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
Yinghai Lu0d358f22008-02-19 03:20:41 -0800880 /* use parent numa_node */
881 if (parent)
882 set_dev_node(dev, dev_to_node(parent));
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 /* first, register with generic layer. */
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100885 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev_name(dev));
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100886 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200888
Brian Walsh37022642006-08-14 22:43:19 -0700889 /* notify platform of device entry */
890 if (platform_notify)
891 platform_notify(dev);
892
Tejun Heoad6a1e12007-06-14 03:45:17 +0900893 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200894 if (error)
895 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200896
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700897 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900898 error = device_create_file(dev, &devt_attr);
899 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200900 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -0700901
902 error = device_create_sys_dev_entry(dev);
903 if (error)
904 goto devtattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700905 }
906
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700907 error = device_add_class_symlinks(dev);
908 if (error)
909 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700910 error = device_add_attrs(dev);
911 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700912 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700913 error = bus_add_device(dev);
914 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -0400916 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100917 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -0400918 goto DPMError;
919 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -0500920
921 /* Notify clients of device addition. This call must come
922 * after dpm_sysf_add() and before kobject_uevent().
923 */
924 if (dev->bus)
925 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
926 BUS_NOTIFY_ADD_DEVICE, dev);
927
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200928 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800929 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 if (parent)
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -0800931 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700933 if (dev->class) {
Dave Youngf75b1c62008-05-28 09:28:39 -0700934 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200935 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200936 klist_add_tail(&dev->knode_class,
937 &dev->class->p->class_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200938
939 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -0700940 list_for_each_entry(class_intf,
941 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200942 if (class_intf->add_dev)
943 class_intf->add_dev(dev, class_intf);
Dave Youngf75b1c62008-05-28 09:28:39 -0700944 mutex_unlock(&dev->class->p->class_mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700945 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700946done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 put_device(dev);
948 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -0400949 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100950 bus_remove_device(dev);
951 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +0000952 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700953 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700954 device_remove_class_symlinks(dev);
955 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900956 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -0700957 device_remove_sys_dev_entry(dev);
958 devtattrError:
959 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +0900960 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200961 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900962 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700963 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100964 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 kobject_del(&dev->kobj);
966 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100967 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 if (parent)
969 put_device(parent);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700970 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971}
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800974 * device_register - register a device with the system.
975 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800977 * This happens in two clean steps - initialize the device
978 * and add it to the system. The two steps can be called
979 * separately, but this is the easiest and most common.
980 * I.e. you should only call the two helpers separately if
981 * have a clearly defined need to use and refcount the device
982 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +0200983 *
984 * NOTE: _Never_ directly free @dev after calling this function, even
985 * if it returned an error! Always use put_device() to give up the
986 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988int device_register(struct device *dev)
989{
990 device_initialize(dev);
991 return device_add(dev);
992}
993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800995 * get_device - increment reference count for device.
996 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800998 * This simply forwards the call to kobject_get(), though
999 * we do take care to provide for the case that we get a NULL
1000 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001002struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003{
1004 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1005}
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001008 * put_device - decrement reference count.
1009 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001011void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001013 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 if (dev)
1015 kobject_put(&dev->kobj);
1016}
1017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001019 * device_del - delete device from system.
1020 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001022 * This is the first part of the device unregistration
1023 * sequence. This removes the device from the lists we control
1024 * from here, has it removed from the other driver model
1025 * subsystems it was added to in device_add(), and removes it
1026 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001028 * NOTE: this should be called manually _iff_ device_add() was
1029 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001031void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001033 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001034 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Alan Sternec0676ee2008-12-05 14:10:31 -05001036 /* Notify clients of device removal. This call must come
1037 * before dpm_sysfs_remove().
1038 */
1039 if (dev->bus)
1040 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1041 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001042 device_pm_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001043 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 if (parent)
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001045 klist_del(&dev->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001046 if (MAJOR(dev->devt)) {
1047 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001048 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001049 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001050 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001051 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001052
Dave Youngf75b1c62008-05-28 09:28:39 -07001053 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001054 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001055 list_for_each_entry(class_intf,
1056 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001057 if (class_intf->remove_dev)
1058 class_intf->remove_dev(dev, class_intf);
1059 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001060 klist_del(&dev->knode_class);
Dave Youngf75b1c62008-05-28 09:28:39 -07001061 mutex_unlock(&dev->class->p->class_mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001062 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001063 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001064 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001065 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001067 /*
1068 * Some platform devices are driven without driver attached
1069 * and managed resources may have been acquired. Make sure
1070 * all resources are released.
1071 */
1072 devres_release_all(dev);
1073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 /* Notify the platform of the removal, in case they
1075 * need to do anything...
1076 */
1077 if (platform_notify_remove)
1078 platform_notify_remove(dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001079 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001080 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001082 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083}
1084
1085/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001086 * device_unregister - unregister device from system.
1087 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001089 * We do this in two parts, like we do device_register(). First,
1090 * we remove it from all the subsystems with device_del(), then
1091 * we decrement the reference count via put_device(). If that
1092 * is the final reference count, the device will be cleaned up
1093 * via device_release() above. Otherwise, the structure will
1094 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001096void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001098 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 device_del(dev);
1100 put_device(dev);
1101}
1102
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001103static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001104{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001105 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001106 return n ? container_of(n, struct device, knode_parent) : NULL;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001107}
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001110 * device_for_each_child - device child iterator.
1111 * @parent: parent struct device.
1112 * @data: data for the callback.
1113 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001115 * Iterate over @parent's child devices, and call @fn for each,
1116 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001118 * We check the return of @fn each time. If it returns anything
1119 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001121int device_for_each_child(struct device *parent, void *data,
1122 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001124 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001125 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 int error = 0;
1127
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001128 klist_iter_init(&parent->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001129 while ((child = next_device(&i)) && !error)
1130 error = fn(child, data);
1131 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 return error;
1133}
1134
Cornelia Huck5ab69982006-11-16 15:42:07 +01001135/**
1136 * device_find_child - device iterator for locating a particular device.
1137 * @parent: parent struct device
1138 * @data: Data to pass to match function
1139 * @match: Callback function to check device
1140 *
1141 * This is similar to the device_for_each_child() function above, but it
1142 * returns a reference to a device that is 'found' for later use, as
1143 * determined by the @match callback.
1144 *
1145 * The callback should return 0 if the device doesn't match and non-zero
1146 * if it does. If the callback returns non-zero and a reference to the
1147 * current device can be obtained, this function will return to the caller
1148 * and not iterate over any more devices.
1149 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001150struct device *device_find_child(struct device *parent, void *data,
1151 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001152{
1153 struct klist_iter i;
1154 struct device *child;
1155
1156 if (!parent)
1157 return NULL;
1158
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001159 klist_iter_init(&parent->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001160 while ((child = next_device(&i)))
1161 if (match(child, data) && get_device(child))
1162 break;
1163 klist_iter_exit(&i);
1164 return child;
1165}
1166
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167int __init devices_init(void)
1168{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001169 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1170 if (!devices_kset)
1171 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001172 dev_kobj = kobject_create_and_add("dev", NULL);
1173 if (!dev_kobj)
1174 goto dev_kobj_err;
1175 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1176 if (!sysfs_dev_block_kobj)
1177 goto block_kobj_err;
1178 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1179 if (!sysfs_dev_char_kobj)
1180 goto char_kobj_err;
1181
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001182 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001183
1184 char_kobj_err:
1185 kobject_put(sysfs_dev_block_kobj);
1186 block_kobj_err:
1187 kobject_put(dev_kobj);
1188 dev_kobj_err:
1189 kset_unregister(devices_kset);
1190 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191}
1192
1193EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001194EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
1196EXPORT_SYMBOL_GPL(device_initialize);
1197EXPORT_SYMBOL_GPL(device_add);
1198EXPORT_SYMBOL_GPL(device_register);
1199
1200EXPORT_SYMBOL_GPL(device_del);
1201EXPORT_SYMBOL_GPL(device_unregister);
1202EXPORT_SYMBOL_GPL(get_device);
1203EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
1205EXPORT_SYMBOL_GPL(device_create_file);
1206EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001207
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001208struct root_device
1209{
1210 struct device dev;
1211 struct module *owner;
1212};
1213
1214#define to_root_device(dev) container_of(dev, struct root_device, dev)
1215
1216static void root_device_release(struct device *dev)
1217{
1218 kfree(to_root_device(dev));
1219}
1220
1221/**
1222 * __root_device_register - allocate and register a root device
1223 * @name: root device name
1224 * @owner: owner module of the root device, usually THIS_MODULE
1225 *
1226 * This function allocates a root device and registers it
1227 * using device_register(). In order to free the returned
1228 * device, use root_device_unregister().
1229 *
1230 * Root devices are dummy devices which allow other devices
1231 * to be grouped under /sys/devices. Use this function to
1232 * allocate a root device and then use it as the parent of
1233 * any device which should appear under /sys/devices/{name}
1234 *
1235 * The /sys/devices/{name} directory will also contain a
1236 * 'module' symlink which points to the @owner directory
1237 * in sysfs.
1238 *
1239 * Note: You probably want to use root_device_register().
1240 */
1241struct device *__root_device_register(const char *name, struct module *owner)
1242{
1243 struct root_device *root;
1244 int err = -ENOMEM;
1245
1246 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1247 if (!root)
1248 return ERR_PTR(err);
1249
1250 err = dev_set_name(&root->dev, name);
1251 if (err) {
1252 kfree(root);
1253 return ERR_PTR(err);
1254 }
1255
1256 root->dev.release = root_device_release;
1257
1258 err = device_register(&root->dev);
1259 if (err) {
1260 put_device(&root->dev);
1261 return ERR_PTR(err);
1262 }
1263
1264#ifdef CONFIG_MODULE /* gotta find a "cleaner" way to do this */
1265 if (owner) {
1266 struct module_kobject *mk = &owner->mkobj;
1267
1268 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1269 if (err) {
1270 device_unregister(&root->dev);
1271 return ERR_PTR(err);
1272 }
1273 root->owner = owner;
1274 }
1275#endif
1276
1277 return &root->dev;
1278}
1279EXPORT_SYMBOL_GPL(__root_device_register);
1280
1281/**
1282 * root_device_unregister - unregister and free a root device
1283 * @root: device going away.
1284 *
1285 * This function unregisters and cleans up a device that was created by
1286 * root_device_register().
1287 */
1288void root_device_unregister(struct device *dev)
1289{
1290 struct root_device *root = to_root_device(dev);
1291
1292 if (root->owner)
1293 sysfs_remove_link(&root->dev.kobj, "module");
1294
1295 device_unregister(dev);
1296}
1297EXPORT_SYMBOL_GPL(root_device_unregister);
1298
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001299
1300static void device_create_release(struct device *dev)
1301{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001302 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001303 kfree(dev);
1304}
1305
1306/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001307 * device_create_vargs - creates a device and registers it with sysfs
1308 * @class: pointer to the struct class that this device should be registered to
1309 * @parent: pointer to the parent struct device of this new device, if any
1310 * @devt: the dev_t for the char device to be added
1311 * @drvdata: the data to be added to the device for callbacks
1312 * @fmt: string for the device's name
1313 * @args: va_list for the device's name
1314 *
1315 * This function can be used by char device classes. A struct device
1316 * will be created in sysfs, registered to the specified class.
1317 *
1318 * A "dev" file will be created, showing the dev_t for the device, if
1319 * the dev_t is not 0,0.
1320 * If a pointer to a parent struct device is passed in, the newly created
1321 * struct device will be a child of that device in sysfs.
1322 * The pointer to the struct device will be returned from the call.
1323 * Any further sysfs files that might be required can be created using this
1324 * pointer.
1325 *
1326 * Note: the struct class passed to this function must have previously
1327 * been created with a call to class_create().
1328 */
1329struct device *device_create_vargs(struct class *class, struct device *parent,
1330 dev_t devt, void *drvdata, const char *fmt,
1331 va_list args)
1332{
1333 struct device *dev = NULL;
1334 int retval = -ENODEV;
1335
1336 if (class == NULL || IS_ERR(class))
1337 goto error;
1338
1339 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1340 if (!dev) {
1341 retval = -ENOMEM;
1342 goto error;
1343 }
1344
1345 dev->devt = devt;
1346 dev->class = class;
1347 dev->parent = parent;
1348 dev->release = device_create_release;
1349 dev_set_drvdata(dev, drvdata);
1350
1351 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1352 retval = device_register(dev);
1353 if (retval)
1354 goto error;
1355
1356 return dev;
1357
1358error:
Cornelia Huck286661b2008-09-03 18:26:41 +02001359 put_device(dev);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001360 return ERR_PTR(retval);
1361}
1362EXPORT_SYMBOL_GPL(device_create_vargs);
1363
1364/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001365 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001366 * @class: pointer to the struct class that this device should be registered to
1367 * @parent: pointer to the parent struct device of this new device, if any
1368 * @devt: the dev_t for the char device to be added
1369 * @drvdata: the data to be added to the device for callbacks
1370 * @fmt: string for the device's name
1371 *
1372 * This function can be used by char device classes. A struct device
1373 * will be created in sysfs, registered to the specified class.
1374 *
1375 * A "dev" file will be created, showing the dev_t for the device, if
1376 * the dev_t is not 0,0.
1377 * If a pointer to a parent struct device is passed in, the newly created
1378 * struct device will be a child of that device in sysfs.
1379 * The pointer to the struct device will be returned from the call.
1380 * Any further sysfs files that might be required can be created using this
1381 * pointer.
1382 *
1383 * Note: the struct class passed to this function must have previously
1384 * been created with a call to class_create().
1385 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001386struct device *device_create(struct class *class, struct device *parent,
1387 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001388{
1389 va_list vargs;
1390 struct device *dev;
1391
1392 va_start(vargs, fmt);
1393 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1394 va_end(vargs);
1395 return dev;
1396}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001397EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001398
Dave Youngcd354492008-01-28 16:56:11 +08001399static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001400{
Dave Youngcd354492008-01-28 16:56:11 +08001401 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001402
Dave Youngcd354492008-01-28 16:56:11 +08001403 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001404}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001405
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001406/**
1407 * device_destroy - removes a device that was created with device_create()
1408 * @class: pointer to the struct class that this device was registered with
1409 * @devt: the dev_t of the device that was previously registered
1410 *
1411 * This call unregisters and cleans up a device that was created with a
1412 * call to device_create().
1413 */
1414void device_destroy(struct class *class, dev_t devt)
1415{
1416 struct device *dev;
1417
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001418 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001419 if (dev) {
1420 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001421 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001422 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001423}
1424EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001425
1426/**
1427 * device_rename - renames a device
1428 * @dev: the pointer to the struct device to be renamed
1429 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07001430 *
1431 * It is the responsibility of the caller to provide mutual
1432 * exclusion between two different calls of device_rename
1433 * on the same device to ensure that new_name is valid and
1434 * won't conflict with other devices.
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001435 */
1436int device_rename(struct device *dev, char *new_name)
1437{
1438 char *old_class_name = NULL;
1439 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001440 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001441 int error;
1442
1443 dev = get_device(dev);
1444 if (!dev)
1445 return -EINVAL;
1446
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001447 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001448 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001449
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001450#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001451 if ((dev->class) && (dev->parent))
1452 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001453#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001454
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001455 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1456 if (!old_device_name) {
1457 error = -ENOMEM;
1458 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001459 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001460 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001461 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1462
1463 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001464 if (error) {
1465 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1466 goto out;
1467 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001468
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001469#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001470 if (old_class_name) {
1471 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1472 if (new_class_name) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001473 error = sysfs_create_link_nowarn(&dev->parent->kobj,
1474 &dev->kobj,
1475 new_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001476 if (error)
1477 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001478 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1479 }
1480 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001481#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001482 if (dev->class) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001483 error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001484 &dev->kobj, dev_name(dev));
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001485 if (error)
1486 goto out;
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001487 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -05001488 old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001489 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001490#endif
1491
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001492out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001493 put_device(dev);
1494
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001495 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001496 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001497 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001498
1499 return error;
1500}
Johannes Berga2807db2007-02-28 12:38:31 +01001501EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001502
1503static int device_move_class_links(struct device *dev,
1504 struct device *old_parent,
1505 struct device *new_parent)
1506{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001507 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001508#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001509 char *class_name;
1510
1511 class_name = make_class_name(dev->class->name, &dev->kobj);
1512 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001513 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001514 goto out;
1515 }
1516 if (old_parent) {
1517 sysfs_remove_link(&dev->kobj, "device");
1518 sysfs_remove_link(&old_parent->kobj, class_name);
1519 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001520 if (new_parent) {
1521 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1522 "device");
1523 if (error)
1524 goto out;
1525 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1526 class_name);
1527 if (error)
1528 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001529 } else
Cornelia Huckc744aea2007-01-08 20:16:44 +01001530 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001531out:
1532 kfree(class_name);
1533 return error;
1534#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001535 if (old_parent)
1536 sysfs_remove_link(&dev->kobj, "device");
1537 if (new_parent)
1538 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1539 "device");
1540 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001541#endif
1542}
1543
1544/**
1545 * device_move - moves a device to a new parent
1546 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001547 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001548 */
1549int device_move(struct device *dev, struct device *new_parent)
1550{
1551 int error;
1552 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001553 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001554
1555 dev = get_device(dev);
1556 if (!dev)
1557 return -EINVAL;
1558
Cornelia Huck8a824722006-11-20 17:07:51 +01001559 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001560 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001561
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001562 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1563 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001564 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001565 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001566 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001567 put_device(new_parent);
1568 goto out;
1569 }
1570 old_parent = dev->parent;
1571 dev->parent = new_parent;
1572 if (old_parent)
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001573 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001574 if (new_parent) {
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001575 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001576 set_dev_node(dev, dev_to_node(new_parent));
1577 }
1578
Cornelia Huck8a824722006-11-20 17:07:51 +01001579 if (!dev->class)
1580 goto out_put;
1581 error = device_move_class_links(dev, old_parent, new_parent);
1582 if (error) {
1583 /* We ignore errors on cleanup since we're hosed anyway... */
1584 device_move_class_links(dev, new_parent, old_parent);
1585 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001586 if (new_parent)
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001587 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001588 dev->parent = old_parent;
1589 if (old_parent) {
Greg Kroah-Hartmane2d40772009-01-09 14:55:37 -08001590 klist_add_tail(&dev->knode_parent,
1591 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001592 set_dev_node(dev, dev_to_node(old_parent));
1593 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001594 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001595 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001596 put_device(new_parent);
1597 goto out;
1598 }
1599out_put:
1600 put_device(old_parent);
1601out:
1602 put_device(dev);
1603 return error;
1604}
Cornelia Huck8a824722006-11-20 17:07:51 +01001605EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001606
1607/**
1608 * device_shutdown - call ->shutdown() on each device to shutdown.
1609 */
1610void device_shutdown(void)
1611{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001612 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001613
1614 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1615 kobj.entry) {
1616 if (dev->bus && dev->bus->shutdown) {
1617 dev_dbg(dev, "shutdown\n");
1618 dev->bus->shutdown(dev);
1619 } else if (dev->driver && dev->driver->shutdown) {
1620 dev_dbg(dev, "shutdown\n");
1621 dev->driver->shutdown(dev);
1622 }
1623 }
Dan Williamse105b8b2008-04-21 10:51:07 -07001624 kobject_put(sysfs_dev_char_kobj);
1625 kobject_put(sysfs_dev_block_kobj);
1626 kobject_put(dev_kobj);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001627}