blob: 40041319657de223ae32786af9ab0067a2775694 [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",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 dev->bus_id);
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",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800212 dev->bus_id, __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() "
220 "returned %d\n", dev->bus_id,
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() "
229 "returned %d\n", dev->bus_id,
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{
510 struct device *dev = container_of(n, struct device, knode_parent);
511
512 get_device(dev);
513}
514
515static void klist_children_put(struct klist_node *n)
516{
517 struct device *dev = container_of(n, struct device, knode_parent);
518
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 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800526 * This prepares the device for use by other layers,
527 * including adding it to the device hierarchy.
528 * It is the first half of device_register(), if called by
529 * that, though it can also be called separately, so one
530 * may use @dev's fields (e.g. the refcount).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532void device_initialize(struct device *dev)
533{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600534 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700535 kobject_init(&dev->kobj, &device_ktype);
James Bottomley34bb61f2005-09-06 16:56:51 -0700536 klist_init(&dev->klist_children, klist_children_get,
537 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700539 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800540 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900541 spin_lock_init(&dev->devres_lock);
542 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700543 device_init_wakeup(dev, 0);
Alan Stern3b98aea2008-08-07 13:06:12 -0400544 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -0800545 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
547
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100548#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sieversda231fd2007-11-21 17:29:15 +0100549static struct kobject *get_device_parent(struct device *dev,
550 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100551{
Kay Sieversda231fd2007-11-21 17:29:15 +0100552 /* class devices without a parent live in /sys/class/<classname>/ */
Dmitry Torokhov3eb215d2007-10-07 12:22:21 -0400553 if (dev->class && (!parent || parent->class != dev->class))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700554 return &dev->class->p->class_subsys.kobj;
Kay Sieversda231fd2007-11-21 17:29:15 +0100555 /* all other devices keep their parent */
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100556 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100557 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100558
Cornelia Huckc744aea2007-01-08 20:16:44 +0100559 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100560}
Kay Sieversda231fd2007-11-21 17:29:15 +0100561
562static inline void cleanup_device_parent(struct device *dev) {}
Cornelia Huck63b69712008-01-21 16:09:44 +0100563static inline void cleanup_glue_dir(struct device *dev,
564 struct kobject *glue_dir) {}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100565#else
Kay Sievers86406242007-03-14 03:25:56 +0100566static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700567{
Kay Sievers86406242007-03-14 03:25:56 +0100568 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700569
Kay Sievers86406242007-03-14 03:25:56 +0100570 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800571 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600572 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700573
Kay Sievers86406242007-03-14 03:25:56 +0100574 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700575}
576
Kay Sieversda231fd2007-11-21 17:29:15 +0100577static struct kobject *get_device_parent(struct device *dev,
578 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100579{
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800580 int retval;
581
Kay Sievers86406242007-03-14 03:25:56 +0100582 if (dev->class) {
583 struct kobject *kobj = NULL;
584 struct kobject *parent_kobj;
585 struct kobject *k;
586
587 /*
588 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100589 * Class-devices with a non class-device as parent, live
590 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100591 */
592 if (parent == NULL)
593 parent_kobj = virtual_device_parent(dev);
594 else if (parent->class)
595 return &parent->kobj;
596 else
597 parent_kobj = &parent->kobj;
598
599 /* find our class-directory at the parent and reference it */
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500600 spin_lock(&dev->class->p->class_dirs.list_lock);
601 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +0100602 if (k->parent == parent_kobj) {
603 kobj = kobject_get(k);
604 break;
605 }
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500606 spin_unlock(&dev->class->p->class_dirs.list_lock);
Kay Sievers86406242007-03-14 03:25:56 +0100607 if (kobj)
608 return kobj;
609
610 /* or create a new class-directory at the parent device */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800611 k = kobject_create();
612 if (!k)
613 return NULL;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500614 k->kset = &dev->class->p->class_dirs;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700615 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800616 if (retval < 0) {
617 kobject_put(k);
618 return NULL;
619 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100620 /* do not emit an uevent for this simple "glue" directory */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800621 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100622 }
623
624 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100625 return &parent->kobj;
626 return NULL;
627}
Kay Sieversda231fd2007-11-21 17:29:15 +0100628
Cornelia Huck63b69712008-01-21 16:09:44 +0100629static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100630{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100631 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100632 if (!glue_dir || !dev->class ||
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500633 glue_dir->kset != &dev->class->p->class_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100634 return;
635
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100636 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100637}
Cornelia Huck63b69712008-01-21 16:09:44 +0100638
639static void cleanup_device_parent(struct device *dev)
640{
641 cleanup_glue_dir(dev, dev->kobj.parent);
642}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100643#endif
Kay Sievers86406242007-03-14 03:25:56 +0100644
Cornelia Huck63b69712008-01-21 16:09:44 +0100645static void setup_parent(struct device *dev, struct device *parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100646{
647 struct kobject *kobj;
648 kobj = get_device_parent(dev, parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +0100649 if (kobj)
650 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100651}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100652
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700653static int device_add_class_symlinks(struct device *dev)
654{
655 int error;
656
657 if (!dev->class)
658 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100659
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700660 error = sysfs_create_link(&dev->kobj,
661 &dev->class->p->class_subsys.kobj,
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700662 "subsystem");
663 if (error)
664 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100665
666#ifdef CONFIG_SYSFS_DEPRECATED
667 /* stacked class devices need a symlink in the class directory */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700668 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800669 device_is_not_partition(dev)) {
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700670 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500671 &dev->kobj, dev->bus_id);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700672 if (error)
673 goto out_subsys;
674 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100675
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800676 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100677 struct device *parent = dev->parent;
678 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700679
Kay Sieversda231fd2007-11-21 17:29:15 +0100680 /*
681 * stacked class devices have the 'device' link
682 * pointing to the bus device instead of the parent
683 */
684 while (parent->class && !parent->bus && parent->parent)
685 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700686
Kay Sieversda231fd2007-11-21 17:29:15 +0100687 error = sysfs_create_link(&dev->kobj,
688 &parent->kobj,
689 "device");
690 if (error)
691 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700692
Kay Sieversda231fd2007-11-21 17:29:15 +0100693 class_name = make_class_name(dev->class->name,
694 &dev->kobj);
695 if (class_name)
696 error = sysfs_create_link(&dev->parent->kobj,
697 &dev->kobj, class_name);
698 kfree(class_name);
699 if (error)
700 goto out_device;
701 }
702 return 0;
703
704out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800705 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100706 sysfs_remove_link(&dev->kobj, "device");
707out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700708 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800709 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700710 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
711 dev->bus_id);
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700712#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100713 /* link in the class directory pointing to the device */
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700714 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
715 &dev->kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100716 if (error)
717 goto out_subsys;
718
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800719 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700720 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
721 "device");
722 if (error)
723 goto out_busid;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700724 }
725 return 0;
726
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700727out_busid:
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700728 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100729#endif
730
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700731out_subsys:
732 sysfs_remove_link(&dev->kobj, "subsystem");
733out:
734 return error;
735}
736
737static void device_remove_class_symlinks(struct device *dev)
738{
739 if (!dev->class)
740 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100741
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700742#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800743 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700744 char *class_name;
745
746 class_name = make_class_name(dev->class->name, &dev->kobj);
747 if (class_name) {
748 sysfs_remove_link(&dev->parent->kobj, class_name);
749 kfree(class_name);
750 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700751 sysfs_remove_link(&dev->kobj, "device");
752 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100753
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700754 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800755 device_is_not_partition(dev))
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700756 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
757 dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100758#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800759 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100760 sysfs_remove_link(&dev->kobj, "device");
761
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -0700762 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100763#endif
764
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700765 sysfs_remove_link(&dev->kobj, "subsystem");
766}
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000769 * dev_set_name - set a device name
770 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700771 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000772 */
773int dev_set_name(struct device *dev, const char *fmt, ...)
774{
775 va_list vargs;
776
777 va_start(vargs, fmt);
778 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
779 va_end(vargs);
780 return 0;
781}
782EXPORT_SYMBOL_GPL(dev_set_name);
783
784/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700785 * device_to_dev_kobj - select a /sys/dev/ directory for the device
786 * @dev: device
787 *
788 * By default we select char/ for new entries. Setting class->dev_obj
789 * to NULL prevents an entry from being created. class->dev_kobj must
790 * be set (or cleared) before any devices are registered to the class
791 * otherwise device_create_sys_dev_entry() and
792 * device_remove_sys_dev_entry() will disagree about the the presence
793 * of the link.
794 */
795static struct kobject *device_to_dev_kobj(struct device *dev)
796{
797 struct kobject *kobj;
798
799 if (dev->class)
800 kobj = dev->class->dev_kobj;
801 else
802 kobj = sysfs_dev_char_kobj;
803
804 return kobj;
805}
806
807static int device_create_sys_dev_entry(struct device *dev)
808{
809 struct kobject *kobj = device_to_dev_kobj(dev);
810 int error = 0;
811 char devt_str[15];
812
813 if (kobj) {
814 format_dev_t(devt_str, dev->devt);
815 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
816 }
817
818 return error;
819}
820
821static void device_remove_sys_dev_entry(struct device *dev)
822{
823 struct kobject *kobj = device_to_dev_kobj(dev);
824 char devt_str[15];
825
826 if (kobj) {
827 format_dev_t(devt_str, dev->devt);
828 sysfs_remove_link(kobj, devt_str);
829 }
830}
831
832/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800833 * device_add - add device to device hierarchy.
834 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800836 * This is part 2 of device_register(), though may be called
837 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800839 * This adds it to the kobject hierarchy via kobject_add(), adds it
840 * to the global and sibling lists for the device, then
841 * adds it to the other relevant subsystems of the driver model.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 */
843int device_add(struct device *dev)
844{
845 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200846 struct class_interface *class_intf;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100847 int error;
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 dev = get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100850 if (!dev || !strlen(dev->bus_id)) {
851 error = -EINVAL;
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100852 goto Done;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100853 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800855 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700856
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100858 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Yinghai Lu0d358f22008-02-19 03:20:41 -0800860 /* use parent numa_node */
861 if (parent)
862 set_dev_node(dev, dev_to_node(parent));
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 /* first, register with generic layer. */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700865 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100866 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200868
Brian Walsh37022642006-08-14 22:43:19 -0700869 /* notify platform of device entry */
870 if (platform_notify)
871 platform_notify(dev);
872
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000873 /* notify clients of device entry (new way) */
874 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700875 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000876 BUS_NOTIFY_ADD_DEVICE, dev);
877
Tejun Heoad6a1e12007-06-14 03:45:17 +0900878 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200879 if (error)
880 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200881
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700882 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900883 error = device_create_file(dev, &devt_attr);
884 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200885 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -0700886
887 error = device_create_sys_dev_entry(dev);
888 if (error)
889 goto devtattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700890 }
891
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700892 error = device_add_class_symlinks(dev);
893 if (error)
894 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700895 error = device_add_attrs(dev);
896 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700897 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700898 error = bus_add_device(dev);
899 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -0400901 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100902 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -0400903 goto DPMError;
904 device_pm_add(dev);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200905 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800906 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400908 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700910 if (dev->class) {
Dave Youngf75b1c62008-05-28 09:28:39 -0700911 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200912 /* tie the class to the device */
Greg Kroah-Hartman97ae69f2008-05-28 09:28:39 -0700913 list_add_tail(&dev->node, &dev->class->p->class_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200914
915 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -0700916 list_for_each_entry(class_intf,
917 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200918 if (class_intf->add_dev)
919 class_intf->add_dev(dev, class_intf);
Dave Youngf75b1c62008-05-28 09:28:39 -0700920 mutex_unlock(&dev->class->p->class_mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700921 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 Done:
923 put_device(dev);
924 return error;
Alan Stern3b98aea2008-08-07 13:06:12 -0400925 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100926 bus_remove_device(dev);
927 BusError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000928 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700929 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000930 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000931 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700932 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700933 device_remove_class_symlinks(dev);
934 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900935 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -0700936 device_remove_sys_dev_entry(dev);
937 devtattrError:
938 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +0900939 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200940 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900941 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700942 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100943 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 kobject_del(&dev->kobj);
945 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100946 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 if (parent)
948 put_device(parent);
949 goto Done;
950}
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800953 * device_register - register a device with the system.
954 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800956 * This happens in two clean steps - initialize the device
957 * and add it to the system. The two steps can be called
958 * separately, but this is the easiest and most common.
959 * I.e. you should only call the two helpers separately if
960 * have a clearly defined need to use and refcount the device
961 * before it is added to the hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963int device_register(struct device *dev)
964{
965 device_initialize(dev);
966 return device_add(dev);
967}
968
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800970 * get_device - increment reference count for device.
971 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800973 * This simply forwards the call to kobject_get(), though
974 * we do take care to provide for the case that we get a NULL
975 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800977struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
979 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
980}
981
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800983 * put_device - decrement reference count.
984 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800986void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200988 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 if (dev)
990 kobject_put(&dev->kobj);
991}
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800994 * device_del - delete device from system.
995 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800997 * This is the first part of the device unregistration
998 * sequence. This removes the device from the lists we control
999 * from here, has it removed from the other driver model
1000 * subsystems it was added to in device_add(), and removes it
1001 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001003 * NOTE: this should be called manually _iff_ device_add() was
1004 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001006void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001008 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001009 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001011 device_pm_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001012 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -07001014 klist_del(&dev->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001015 if (MAJOR(dev->devt)) {
1016 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001017 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001018 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001019 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001020 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001021
Dave Youngf75b1c62008-05-28 09:28:39 -07001022 mutex_lock(&dev->class->p->class_mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001023 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001024 list_for_each_entry(class_intf,
1025 &dev->class->p->class_interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001026 if (class_intf->remove_dev)
1027 class_intf->remove_dev(dev, class_intf);
1028 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001029 list_del_init(&dev->node);
Dave Youngf75b1c62008-05-28 09:28:39 -07001030 mutex_unlock(&dev->class->p->class_mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001031 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001032 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001033 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001034 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001036 /*
1037 * Some platform devices are driven without driver attached
1038 * and managed resources may have been acquired. Make sure
1039 * all resources are released.
1040 */
1041 devres_release_all(dev);
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 /* Notify the platform of the removal, in case they
1044 * need to do anything...
1045 */
1046 if (platform_notify_remove)
1047 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001048 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07001049 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001050 BUS_NOTIFY_DEL_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001051 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001052 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001054 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055}
1056
1057/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001058 * device_unregister - unregister device from system.
1059 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001061 * We do this in two parts, like we do device_register(). First,
1062 * we remove it from all the subsystems with device_del(), then
1063 * we decrement the reference count via put_device(). If that
1064 * is the final reference count, the device will be cleaned up
1065 * via device_release() above. Otherwise, the structure will
1066 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001068void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001070 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 device_del(dev);
1072 put_device(dev);
1073}
1074
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001075static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001076{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001077 struct klist_node *n = klist_next(i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001078 return n ? container_of(n, struct device, knode_parent) : NULL;
1079}
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001082 * device_for_each_child - device child iterator.
1083 * @parent: parent struct device.
1084 * @data: data for the callback.
1085 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001087 * Iterate over @parent's child devices, and call @fn for each,
1088 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001090 * We check the return of @fn each time. If it returns anything
1091 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001093int device_for_each_child(struct device *parent, void *data,
1094 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001096 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001097 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 int error = 0;
1099
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001100 klist_iter_init(&parent->klist_children, &i);
1101 while ((child = next_device(&i)) && !error)
1102 error = fn(child, data);
1103 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 return error;
1105}
1106
Cornelia Huck5ab69982006-11-16 15:42:07 +01001107/**
1108 * device_find_child - device iterator for locating a particular device.
1109 * @parent: parent struct device
1110 * @data: Data to pass to match function
1111 * @match: Callback function to check device
1112 *
1113 * This is similar to the device_for_each_child() function above, but it
1114 * returns a reference to a device that is 'found' for later use, as
1115 * determined by the @match callback.
1116 *
1117 * The callback should return 0 if the device doesn't match and non-zero
1118 * if it does. If the callback returns non-zero and a reference to the
1119 * current device can be obtained, this function will return to the caller
1120 * and not iterate over any more devices.
1121 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001122struct device *device_find_child(struct device *parent, void *data,
1123 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001124{
1125 struct klist_iter i;
1126 struct device *child;
1127
1128 if (!parent)
1129 return NULL;
1130
1131 klist_iter_init(&parent->klist_children, &i);
1132 while ((child = next_device(&i)))
1133 if (match(child, data) && get_device(child))
1134 break;
1135 klist_iter_exit(&i);
1136 return child;
1137}
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139int __init devices_init(void)
1140{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001141 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1142 if (!devices_kset)
1143 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001144 dev_kobj = kobject_create_and_add("dev", NULL);
1145 if (!dev_kobj)
1146 goto dev_kobj_err;
1147 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1148 if (!sysfs_dev_block_kobj)
1149 goto block_kobj_err;
1150 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1151 if (!sysfs_dev_char_kobj)
1152 goto char_kobj_err;
1153
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001154 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001155
1156 char_kobj_err:
1157 kobject_put(sysfs_dev_block_kobj);
1158 block_kobj_err:
1159 kobject_put(dev_kobj);
1160 dev_kobj_err:
1161 kset_unregister(devices_kset);
1162 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163}
1164
1165EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001166EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
1168EXPORT_SYMBOL_GPL(device_initialize);
1169EXPORT_SYMBOL_GPL(device_add);
1170EXPORT_SYMBOL_GPL(device_register);
1171
1172EXPORT_SYMBOL_GPL(device_del);
1173EXPORT_SYMBOL_GPL(device_unregister);
1174EXPORT_SYMBOL_GPL(get_device);
1175EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
1177EXPORT_SYMBOL_GPL(device_create_file);
1178EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001179
1180
1181static void device_create_release(struct device *dev)
1182{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001183 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001184 kfree(dev);
1185}
1186
1187/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001188 * device_create_vargs - creates a device and registers it with sysfs
1189 * @class: pointer to the struct class that this device should be registered to
1190 * @parent: pointer to the parent struct device of this new device, if any
1191 * @devt: the dev_t for the char device to be added
1192 * @drvdata: the data to be added to the device for callbacks
1193 * @fmt: string for the device's name
1194 * @args: va_list for the device's name
1195 *
1196 * This function can be used by char device classes. A struct device
1197 * will be created in sysfs, registered to the specified class.
1198 *
1199 * A "dev" file will be created, showing the dev_t for the device, if
1200 * the dev_t is not 0,0.
1201 * If a pointer to a parent struct device is passed in, the newly created
1202 * struct device will be a child of that device in sysfs.
1203 * The pointer to the struct device will be returned from the call.
1204 * Any further sysfs files that might be required can be created using this
1205 * pointer.
1206 *
1207 * Note: the struct class passed to this function must have previously
1208 * been created with a call to class_create().
1209 */
1210struct device *device_create_vargs(struct class *class, struct device *parent,
1211 dev_t devt, void *drvdata, const char *fmt,
1212 va_list args)
1213{
1214 struct device *dev = NULL;
1215 int retval = -ENODEV;
1216
1217 if (class == NULL || IS_ERR(class))
1218 goto error;
1219
1220 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1221 if (!dev) {
1222 retval = -ENOMEM;
1223 goto error;
1224 }
1225
1226 dev->devt = devt;
1227 dev->class = class;
1228 dev->parent = parent;
1229 dev->release = device_create_release;
1230 dev_set_drvdata(dev, drvdata);
1231
1232 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1233 retval = device_register(dev);
1234 if (retval)
1235 goto error;
1236
1237 return dev;
1238
1239error:
1240 kfree(dev);
1241 return ERR_PTR(retval);
1242}
1243EXPORT_SYMBOL_GPL(device_create_vargs);
1244
1245/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001246 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001247 * @class: pointer to the struct class that this device should be registered to
1248 * @parent: pointer to the parent struct device of this new device, if any
1249 * @devt: the dev_t for the char device to be added
1250 * @drvdata: the data to be added to the device for callbacks
1251 * @fmt: string for the device's name
1252 *
1253 * This function can be used by char device classes. A struct device
1254 * will be created in sysfs, registered to the specified class.
1255 *
1256 * A "dev" file will be created, showing the dev_t for the device, if
1257 * the dev_t is not 0,0.
1258 * If a pointer to a parent struct device is passed in, the newly created
1259 * struct device will be a child of that device in sysfs.
1260 * The pointer to the struct device will be returned from the call.
1261 * Any further sysfs files that might be required can be created using this
1262 * pointer.
1263 *
1264 * Note: the struct class passed to this function must have previously
1265 * been created with a call to class_create().
1266 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001267struct device *device_create(struct class *class, struct device *parent,
1268 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001269{
1270 va_list vargs;
1271 struct device *dev;
1272
1273 va_start(vargs, fmt);
1274 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1275 va_end(vargs);
1276 return dev;
1277}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001278EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001279
Dave Youngcd354492008-01-28 16:56:11 +08001280static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001281{
Dave Youngcd354492008-01-28 16:56:11 +08001282 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001283
Dave Youngcd354492008-01-28 16:56:11 +08001284 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001285}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001286
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001287/**
1288 * device_destroy - removes a device that was created with device_create()
1289 * @class: pointer to the struct class that this device was registered with
1290 * @devt: the dev_t of the device that was previously registered
1291 *
1292 * This call unregisters and cleans up a device that was created with a
1293 * call to device_create().
1294 */
1295void device_destroy(struct class *class, dev_t devt)
1296{
1297 struct device *dev;
1298
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001299 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08001300 if (dev) {
1301 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001302 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001303 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001304}
1305EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001306
1307/**
1308 * device_rename - renames a device
1309 * @dev: the pointer to the struct device to be renamed
1310 * @new_name: the new name of the device
1311 */
1312int device_rename(struct device *dev, char *new_name)
1313{
1314 char *old_class_name = NULL;
1315 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001316 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001317 int error;
1318
1319 dev = get_device(dev);
1320 if (!dev)
1321 return -EINVAL;
1322
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001323 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001324 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001325
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001326#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001327 if ((dev->class) && (dev->parent))
1328 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001329#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001330
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001331 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1332 if (!old_device_name) {
1333 error = -ENOMEM;
1334 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001335 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001336 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001337 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1338
1339 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001340 if (error) {
1341 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1342 goto out;
1343 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001344
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001345#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001346 if (old_class_name) {
1347 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1348 if (new_class_name) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001349 error = sysfs_create_link_nowarn(&dev->parent->kobj,
1350 &dev->kobj,
1351 new_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001352 if (error)
1353 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001354 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1355 }
1356 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001357#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001358 if (dev->class) {
Cornelia Huck36ce6da2008-06-10 11:09:08 +02001359 error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
1360 &dev->kobj, dev->bus_id);
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001361 if (error)
1362 goto out;
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001363 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -05001364 old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001365 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001366#endif
1367
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001368out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001369 put_device(dev);
1370
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001371 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001372 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001373 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001374
1375 return error;
1376}
Johannes Berga2807db2007-02-28 12:38:31 +01001377EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001378
1379static int device_move_class_links(struct device *dev,
1380 struct device *old_parent,
1381 struct device *new_parent)
1382{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001383 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001384#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001385 char *class_name;
1386
1387 class_name = make_class_name(dev->class->name, &dev->kobj);
1388 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001389 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001390 goto out;
1391 }
1392 if (old_parent) {
1393 sysfs_remove_link(&dev->kobj, "device");
1394 sysfs_remove_link(&old_parent->kobj, class_name);
1395 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001396 if (new_parent) {
1397 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1398 "device");
1399 if (error)
1400 goto out;
1401 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1402 class_name);
1403 if (error)
1404 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001405 } else
Cornelia Huckc744aea2007-01-08 20:16:44 +01001406 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001407out:
1408 kfree(class_name);
1409 return error;
1410#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001411 if (old_parent)
1412 sysfs_remove_link(&dev->kobj, "device");
1413 if (new_parent)
1414 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1415 "device");
1416 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001417#endif
1418}
1419
1420/**
1421 * device_move - moves a device to a new parent
1422 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001423 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001424 */
1425int device_move(struct device *dev, struct device *new_parent)
1426{
1427 int error;
1428 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001429 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001430
1431 dev = get_device(dev);
1432 if (!dev)
1433 return -EINVAL;
1434
Cornelia Huck8a824722006-11-20 17:07:51 +01001435 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001436 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001437
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001438 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001439 __func__, new_parent ? new_parent->bus_id : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001440 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001441 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001442 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001443 put_device(new_parent);
1444 goto out;
1445 }
1446 old_parent = dev->parent;
1447 dev->parent = new_parent;
1448 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001449 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001450 if (new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001451 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001452 set_dev_node(dev, dev_to_node(new_parent));
1453 }
1454
Cornelia Huck8a824722006-11-20 17:07:51 +01001455 if (!dev->class)
1456 goto out_put;
1457 error = device_move_class_links(dev, old_parent, new_parent);
1458 if (error) {
1459 /* We ignore errors on cleanup since we're hosed anyway... */
1460 device_move_class_links(dev, new_parent, old_parent);
1461 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001462 if (new_parent)
1463 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001464 dev->parent = old_parent;
1465 if (old_parent) {
Cornelia Huck8a824722006-11-20 17:07:51 +01001466 klist_add_tail(&dev->knode_parent,
1467 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001468 set_dev_node(dev, dev_to_node(old_parent));
1469 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001470 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001471 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001472 put_device(new_parent);
1473 goto out;
1474 }
1475out_put:
1476 put_device(old_parent);
1477out:
1478 put_device(dev);
1479 return error;
1480}
Cornelia Huck8a824722006-11-20 17:07:51 +01001481EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001482
1483/**
1484 * device_shutdown - call ->shutdown() on each device to shutdown.
1485 */
1486void device_shutdown(void)
1487{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001488 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001489
1490 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1491 kobj.entry) {
1492 if (dev->bus && dev->bus->shutdown) {
1493 dev_dbg(dev, "shutdown\n");
1494 dev->bus->shutdown(dev);
1495 } else if (dev->driver && dev->driver->shutdown) {
1496 dev_dbg(dev, "shutdown\n");
1497 dev->driver->shutdown(dev);
1498 }
1499 }
Dan Williamse105b8b2008-04-21 10:51:07 -07001500 kobject_put(sysfs_dev_char_kobj);
1501 kobject_put(sysfs_dev_block_kobj);
1502 kobject_put(dev_kobj);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001503}