blob: 72eccae4904bf8685f887bcd0b9ef6a6fc19f5cb [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#include "base.h"
26#include "power/power.h"
27
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080028int (*platform_notify)(struct device *dev) = NULL;
29int (*platform_notify_remove)(struct device *dev) = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080031#ifdef CONFIG_BLOCK
32static inline int device_is_not_partition(struct device *dev)
33{
34 return !(dev->type == &part_type);
35}
36#else
37static inline int device_is_not_partition(struct device *dev)
38{
39 return 1;
40}
41#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Alan Stern3e956372006-06-16 17:10:48 -040043/**
44 * dev_driver_string - Return a device's driver name, if at all possible
45 * @dev: struct device to get the name of
46 *
47 * Will return the device's driver's name if it is bound to a device. If
48 * the device is not bound to a device, it will return the name of the bus
49 * it is attached to. If it is not attached to a bus either, an empty
50 * string will be returned.
51 */
52const char *dev_driver_string(struct device *dev)
53{
54 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010055 (dev->bus ? dev->bus->name :
56 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040057}
Matthew Wilcox310a9222006-09-23 23:35:04 -060058EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#define to_dev(obj) container_of(obj, struct device, kobj)
61#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
62
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080063static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
64 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080066 struct device_attribute *dev_attr = to_dev_attr(attr);
67 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050068 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040071 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080072 if (ret >= (ssize_t)PAGE_SIZE) {
73 print_symbol("dev_attr_show: %s returned bad count\n",
74 (unsigned long)dev_attr->show);
75 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 return ret;
77}
78
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080079static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
80 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080082 struct device_attribute *dev_attr = to_dev_attr(attr);
83 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050084 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040087 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 return ret;
89}
90
91static struct sysfs_ops dev_sysfs_ops = {
92 .show = dev_attr_show,
93 .store = dev_attr_store,
94};
95
96
97/**
98 * device_release - free device structure.
99 * @kobj: device's kobject.
100 *
101 * This is called once the reference count for the object
102 * reaches 0. We forward the call to the device's release
103 * method, which should handle actually freeing the structure.
104 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800105static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800107 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109 if (dev->release)
110 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200111 else if (dev->type && dev->type->release)
112 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700113 else if (dev->class && dev->class->dev_release)
114 dev->class->dev_release(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 else {
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800116 printk(KERN_ERR "Device '%s' does not have a release() "
117 "function, it is broken and must be fixed.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 dev->bus_id);
119 WARN_ON(1);
120 }
121}
122
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600123static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 .release = device_release,
125 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126};
127
128
Kay Sievers312c0042005-11-16 09:00:00 +0100129static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 struct kobj_type *ktype = get_ktype(kobj);
132
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600133 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200135 if (dev->uevent_suppress)
136 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 if (dev->bus)
138 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700139 if (dev->class)
140 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 }
142 return 0;
143}
144
Kay Sievers312c0042005-11-16 09:00:00 +0100145static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
147 struct device *dev = to_dev(kobj);
148
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700149 if (dev->bus)
150 return dev->bus->name;
151 if (dev->class)
152 return dev->class->name;
153 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154}
155
Kay Sievers7eff2e72007-08-14 15:15:12 +0200156static int dev_uevent(struct kset *kset, struct kobject *kobj,
157 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
159 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 int retval = 0;
161
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700162 /* add the major/minor if present */
163 if (MAJOR(dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200164 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
165 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700166 }
167
Kay Sievers414264f2007-03-12 21:08:57 +0100168 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200169 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100170
Kay Sievers239378f2006-10-07 21:54:55 +0200171 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200172 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200173
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200174#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200175 if (dev->class) {
176 struct device *parent = dev->parent;
177
178 /* find first bus device in parent chain */
179 while (parent && !parent->bus)
180 parent = parent->parent;
181 if (parent && parent->bus) {
182 const char *path;
183
184 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200185 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200186 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200187 kfree(path);
188 }
Kay Sievers239378f2006-10-07 21:54:55 +0200189
Kay Sievers7eff2e72007-08-14 15:15:12 +0200190 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200191
192 if (parent->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200193 add_uevent_var(env, "PHYSDEVDRIVER=%s",
194 parent->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200195 }
196 } else if (dev->bus) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200197 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200198
199 if (dev->driver)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800200 add_uevent_var(env, "PHYSDEVDRIVER=%s",
201 dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200202 }
Kay Sievers239378f2006-10-07 21:54:55 +0200203#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Kay Sievers7eff2e72007-08-14 15:15:12 +0200205 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100206 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200207 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200208 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800209 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800210 dev->bus_id, __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 }
212
Kay Sievers7eff2e72007-08-14 15:15:12 +0200213 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700214 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200215 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200216 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800217 pr_debug("device: '%s': %s: class uevent() "
218 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800219 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200220 }
221
Kay Sievers7eff2e72007-08-14 15:15:12 +0200222 /* have the device type specific fuction add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200223 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200224 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200225 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800226 pr_debug("device: '%s': %s: dev_type uevent() "
227 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800228 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700229 }
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 return retval;
232}
233
Kay Sievers312c0042005-11-16 09:00:00 +0100234static struct kset_uevent_ops device_uevent_ops = {
235 .filter = dev_uevent_filter,
236 .name = dev_uevent_name,
237 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238};
239
Kay Sievers16574dc2007-04-06 01:40:38 +0200240static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
241 char *buf)
242{
243 struct kobject *top_kobj;
244 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200245 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200246 int i;
247 size_t count = 0;
248 int retval;
249
250 /* search the kset, the device belongs to */
251 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200252 while (!top_kobj->kset && top_kobj->parent)
253 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200254 if (!top_kobj->kset)
255 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200256
Kay Sievers16574dc2007-04-06 01:40:38 +0200257 kset = top_kobj->kset;
258 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
259 goto out;
260
261 /* respect filter */
262 if (kset->uevent_ops && kset->uevent_ops->filter)
263 if (!kset->uevent_ops->filter(kset, &dev->kobj))
264 goto out;
265
Kay Sievers7eff2e72007-08-14 15:15:12 +0200266 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
267 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200268 return -ENOMEM;
269
Kay Sievers16574dc2007-04-06 01:40:38 +0200270 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200271 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200272 if (retval)
273 goto out;
274
275 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200276 for (i = 0; i < env->envp_idx; i++)
277 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200278out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200279 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200280 return count;
281}
282
Kay Sieversa7fd6702005-10-01 14:49:43 +0200283static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
284 const char *buf, size_t count)
285{
Kay Sievers60a96a52007-07-08 22:29:26 +0200286 enum kobject_action action;
287
Kay Sievers5c5daf62007-08-12 20:43:55 +0200288 if (kobject_action_type(buf, count, &action) == 0) {
Kay Sievers60a96a52007-07-08 22:29:26 +0200289 kobject_uevent(&dev->kobj, action);
290 goto out;
291 }
292
293 dev_err(dev, "uevent: unsupported action-string; this will "
294 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100295 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200296out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200297 return count;
298}
299
Tejun Heoad6a1e12007-06-14 03:45:17 +0900300static struct device_attribute uevent_attr =
301 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
302
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500303static int device_add_attributes(struct device *dev,
304 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700305{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700306 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500307 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700308
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500309 if (attrs) {
310 for (i = 0; attr_name(attrs[i]); i++) {
311 error = device_create_file(dev, &attrs[i]);
312 if (error)
313 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700314 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500315 if (error)
316 while (--i >= 0)
317 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700318 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700319 return error;
320}
321
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500322static void device_remove_attributes(struct device *dev,
323 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700324{
325 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500326
327 if (attrs)
328 for (i = 0; attr_name(attrs[i]); i++)
329 device_remove_file(dev, &attrs[i]);
330}
331
332static int device_add_groups(struct device *dev,
333 struct attribute_group **groups)
334{
335 int error = 0;
336 int i;
337
338 if (groups) {
339 for (i = 0; groups[i]; i++) {
340 error = sysfs_create_group(&dev->kobj, groups[i]);
341 if (error) {
342 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800343 sysfs_remove_group(&dev->kobj,
344 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500345 break;
346 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700347 }
348 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500349 return error;
350}
351
352static void device_remove_groups(struct device *dev,
353 struct attribute_group **groups)
354{
355 int i;
356
357 if (groups)
358 for (i = 0; groups[i]; i++)
359 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700360}
361
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700362static int device_add_attrs(struct device *dev)
363{
364 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200365 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500366 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700367
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500368 if (class) {
369 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200370 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500371 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700372 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200373
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500374 if (type) {
375 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200376 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500377 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200378 }
379
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500380 error = device_add_groups(dev, dev->groups);
381 if (error)
382 goto err_remove_type_groups;
383
384 return 0;
385
386 err_remove_type_groups:
387 if (type)
388 device_remove_groups(dev, type->groups);
389 err_remove_class_attrs:
390 if (class)
391 device_remove_attributes(dev, class->dev_attrs);
392
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700393 return error;
394}
395
396static void device_remove_attrs(struct device *dev)
397{
398 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200399 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700400
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500401 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200402
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500403 if (type)
404 device_remove_groups(dev, type->groups);
405
406 if (class)
407 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700408}
409
410
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700411static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
412 char *buf)
413{
414 return print_dev_t(buf, dev->devt);
415}
416
Tejun Heoad6a1e12007-06-14 03:45:17 +0900417static struct device_attribute devt_attr =
418 __ATTR(dev, S_IRUGO, show_dev, NULL);
419
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600420/* kset to create /sys/devices/ */
421struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800424 * device_create_file - create sysfs attribute file for device.
425 * @dev: device.
426 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800428int device_create_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429{
430 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100431 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return error;
434}
435
436/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800437 * device_remove_file - remove sysfs attribute file.
438 * @dev: device.
439 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800441void device_remove_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100443 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445}
446
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700447/**
448 * device_create_bin_file - create sysfs binary attribute file for device.
449 * @dev: device.
450 * @attr: device binary attribute descriptor.
451 */
452int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
453{
454 int error = -EINVAL;
455 if (dev)
456 error = sysfs_create_bin_file(&dev->kobj, attr);
457 return error;
458}
459EXPORT_SYMBOL_GPL(device_create_bin_file);
460
461/**
462 * device_remove_bin_file - remove sysfs binary attribute file
463 * @dev: device.
464 * @attr: device binary attribute descriptor.
465 */
466void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
467{
468 if (dev)
469 sysfs_remove_bin_file(&dev->kobj, attr);
470}
471EXPORT_SYMBOL_GPL(device_remove_bin_file);
472
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400473/**
Alan Stern523ded72007-04-26 00:12:04 -0700474 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400475 * @dev: device.
476 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700477 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400478 *
479 * Attribute methods must not unregister themselves or their parent device
480 * (which would amount to the same thing). Attempts to do so will deadlock,
481 * since unregistration is mutually exclusive with driver callbacks.
482 *
483 * Instead methods can call this routine, which will attempt to allocate
484 * and schedule a workqueue request to call back @func with @dev as its
485 * argument in the workqueue's process context. @dev will be pinned until
486 * @func returns.
487 *
Alan Stern523ded72007-04-26 00:12:04 -0700488 * This routine is usually called via the inline device_schedule_callback(),
489 * which automatically sets @owner to THIS_MODULE.
490 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400491 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700492 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400493 *
494 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
495 * underlying sysfs routine (since it is intended for use by attribute
496 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
497 */
Alan Stern523ded72007-04-26 00:12:04 -0700498int device_schedule_callback_owner(struct device *dev,
499 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400500{
501 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700502 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400503}
Alan Stern523ded72007-04-26 00:12:04 -0700504EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400505
James Bottomley34bb61f2005-09-06 16:56:51 -0700506static void klist_children_get(struct klist_node *n)
507{
508 struct device *dev = container_of(n, struct device, knode_parent);
509
510 get_device(dev);
511}
512
513static void klist_children_put(struct klist_node *n)
514{
515 struct device *dev = container_of(n, struct device, knode_parent);
516
517 put_device(dev);
518}
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800521 * device_initialize - init device structure.
522 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800524 * This prepares the device for use by other layers,
525 * including adding it to the device hierarchy.
526 * It is the first half of device_register(), if called by
527 * that, though it can also be called separately, so one
528 * may use @dev's fields (e.g. the refcount).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530void device_initialize(struct device *dev)
531{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600532 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700533 kobject_init(&dev->kobj, &device_ktype);
James Bottomley34bb61f2005-09-06 16:56:51 -0700534 klist_init(&dev->klist_children, klist_children_get,
535 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700537 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800538 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900539 spin_lock_init(&dev->devres_lock);
540 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700541 device_init_wakeup(dev, 0);
Christoph Hellwig87348132006-12-06 20:32:33 -0800542 set_dev_node(dev, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
544
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100545#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sieversda231fd2007-11-21 17:29:15 +0100546static struct kobject *get_device_parent(struct device *dev,
547 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100548{
Kay Sieversda231fd2007-11-21 17:29:15 +0100549 /* class devices without a parent live in /sys/class/<classname>/ */
Dmitry Torokhov3eb215d2007-10-07 12:22:21 -0400550 if (dev->class && (!parent || parent->class != dev->class))
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700551 return &dev->class->subsys.kobj;
Kay Sieversda231fd2007-11-21 17:29:15 +0100552 /* all other devices keep their parent */
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100553 else if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100554 return &parent->kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100555
Cornelia Huckc744aea2007-01-08 20:16:44 +0100556 return NULL;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100557}
Kay Sieversda231fd2007-11-21 17:29:15 +0100558
559static inline void cleanup_device_parent(struct device *dev) {}
Cornelia Huck63b69712008-01-21 16:09:44 +0100560static inline void cleanup_glue_dir(struct device *dev,
561 struct kobject *glue_dir) {}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100562#else
Kay Sievers86406242007-03-14 03:25:56 +0100563static struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700564{
Kay Sievers86406242007-03-14 03:25:56 +0100565 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700566
Kay Sievers86406242007-03-14 03:25:56 +0100567 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -0800568 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600569 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700570
Kay Sievers86406242007-03-14 03:25:56 +0100571 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -0700572}
573
Kay Sieversda231fd2007-11-21 17:29:15 +0100574static struct kobject *get_device_parent(struct device *dev,
575 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100576{
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800577 int retval;
578
Kay Sievers86406242007-03-14 03:25:56 +0100579 if (dev->class) {
580 struct kobject *kobj = NULL;
581 struct kobject *parent_kobj;
582 struct kobject *k;
583
584 /*
585 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100586 * Class-devices with a non class-device as parent, live
587 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +0100588 */
589 if (parent == NULL)
590 parent_kobj = virtual_device_parent(dev);
591 else if (parent->class)
592 return &parent->kobj;
593 else
594 parent_kobj = &parent->kobj;
595
596 /* find our class-directory at the parent and reference it */
597 spin_lock(&dev->class->class_dirs.list_lock);
598 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
599 if (k->parent == parent_kobj) {
600 kobj = kobject_get(k);
601 break;
602 }
603 spin_unlock(&dev->class->class_dirs.list_lock);
604 if (kobj)
605 return kobj;
606
607 /* or create a new class-directory at the parent device */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800608 k = kobject_create();
609 if (!k)
610 return NULL;
611 k->kset = &dev->class->class_dirs;
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700612 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800613 if (retval < 0) {
614 kobject_put(k);
615 return NULL;
616 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100617 /* do not emit an uevent for this simple "glue" directory */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800618 return k;
Kay Sievers86406242007-03-14 03:25:56 +0100619 }
620
621 if (parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100622 return &parent->kobj;
623 return NULL;
624}
Kay Sieversda231fd2007-11-21 17:29:15 +0100625
Cornelia Huck63b69712008-01-21 16:09:44 +0100626static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +0100627{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100628 /* see if we live in a "glue" directory */
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100629 if (!glue_dir || !dev->class ||
630 glue_dir->kset != &dev->class->class_dirs)
Kay Sieversda231fd2007-11-21 17:29:15 +0100631 return;
632
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100633 kobject_put(glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +0100634}
Cornelia Huck63b69712008-01-21 16:09:44 +0100635
636static void cleanup_device_parent(struct device *dev)
637{
638 cleanup_glue_dir(dev, dev->kobj.parent);
639}
Cornelia Huckc744aea2007-01-08 20:16:44 +0100640#endif
Kay Sievers86406242007-03-14 03:25:56 +0100641
Cornelia Huck63b69712008-01-21 16:09:44 +0100642static void setup_parent(struct device *dev, struct device *parent)
Cornelia Huckc744aea2007-01-08 20:16:44 +0100643{
644 struct kobject *kobj;
645 kobj = get_device_parent(dev, parent);
Cornelia Huckc744aea2007-01-08 20:16:44 +0100646 if (kobj)
647 dev->kobj.parent = kobj;
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100648}
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100649
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700650static int device_add_class_symlinks(struct device *dev)
651{
652 int error;
653
654 if (!dev->class)
655 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +0100656
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700657 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
658 "subsystem");
659 if (error)
660 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100661
662#ifdef CONFIG_SYSFS_DEPRECATED
663 /* stacked class devices need a symlink in the class directory */
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200664 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800665 device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700666 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
667 dev->bus_id);
668 if (error)
669 goto out_subsys;
670 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100671
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800672 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100673 struct device *parent = dev->parent;
674 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700675
Kay Sieversda231fd2007-11-21 17:29:15 +0100676 /*
677 * stacked class devices have the 'device' link
678 * pointing to the bus device instead of the parent
679 */
680 while (parent->class && !parent->bus && parent->parent)
681 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700682
Kay Sieversda231fd2007-11-21 17:29:15 +0100683 error = sysfs_create_link(&dev->kobj,
684 &parent->kobj,
685 "device");
686 if (error)
687 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700688
Kay Sieversda231fd2007-11-21 17:29:15 +0100689 class_name = make_class_name(dev->class->name,
690 &dev->kobj);
691 if (class_name)
692 error = sysfs_create_link(&dev->parent->kobj,
693 &dev->kobj, class_name);
694 kfree(class_name);
695 if (error)
696 goto out_device;
697 }
698 return 0;
699
700out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800701 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100702 sysfs_remove_link(&dev->kobj, "device");
703out_busid:
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200704 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800705 device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100706 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700707#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100708 /* link in the class directory pointing to the device */
709 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
710 dev->bus_id);
711 if (error)
712 goto out_subsys;
713
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800714 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700715 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
716 "device");
717 if (error)
718 goto out_busid;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700719 }
720 return 0;
721
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700722out_busid:
Kay Sieversda231fd2007-11-21 17:29:15 +0100723 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
724#endif
725
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700726out_subsys:
727 sysfs_remove_link(&dev->kobj, "subsystem");
728out:
729 return error;
730}
731
732static void device_remove_class_symlinks(struct device *dev)
733{
734 if (!dev->class)
735 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100736
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700737#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800738 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700739 char *class_name;
740
741 class_name = make_class_name(dev->class->name, &dev->kobj);
742 if (class_name) {
743 sysfs_remove_link(&dev->parent->kobj, class_name);
744 kfree(class_name);
745 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700746 sysfs_remove_link(&dev->kobj, "device");
747 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100748
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200749 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800750 device_is_not_partition(dev))
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700751 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100752#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800753 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100754 sysfs_remove_link(&dev->kobj, "device");
755
756 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
757#endif
758
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700759 sysfs_remove_link(&dev->kobj, "subsystem");
760}
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800763 * device_add - add device to device hierarchy.
764 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800766 * This is part 2 of device_register(), though may be called
767 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800769 * This adds it to the kobject hierarchy via kobject_add(), adds it
770 * to the global and sibling lists for the device, then
771 * adds it to the other relevant subsystems of the driver model.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 */
773int device_add(struct device *dev)
774{
775 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200776 struct class_interface *class_intf;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100777 int error;
778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 dev = get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100780 if (!dev || !strlen(dev->bus_id)) {
781 error = -EINVAL;
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100782 goto Done;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100783 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800785 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100788 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Yinghai Lu0d358f22008-02-19 03:20:41 -0800790 /* use parent numa_node */
791 if (parent)
792 set_dev_node(dev, dev_to_node(parent));
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 /* first, register with generic layer. */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700795 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100796 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200798
Brian Walsh37022642006-08-14 22:43:19 -0700799 /* notify platform of device entry */
800 if (platform_notify)
801 platform_notify(dev);
802
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000803 /* notify clients of device entry (new way) */
804 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700805 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000806 BUS_NOTIFY_ADD_DEVICE, dev);
807
Tejun Heoad6a1e12007-06-14 03:45:17 +0900808 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200809 if (error)
810 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200811
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700812 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900813 error = device_create_file(dev, &devt_attr);
814 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200815 goto ueventattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700816 }
817
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700818 error = device_add_class_symlinks(dev);
819 if (error)
820 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700821 error = device_add_attrs(dev);
822 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700823 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700824 error = bus_add_device(dev);
825 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 goto BusError;
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100827 error = device_pm_add(dev);
828 if (error)
829 goto PMError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200830 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800831 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400833 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700835 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700836 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200837 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700838 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200839
840 /* notify any interfaces that the device is here */
841 list_for_each_entry(class_intf, &dev->class->interfaces, node)
842 if (class_intf->add_dev)
843 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700844 up(&dev->class->sem);
845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 Done:
847 put_device(dev);
848 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 PMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100850 bus_remove_device(dev);
851 BusError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000852 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700853 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000854 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000855 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700856 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700857 device_remove_class_symlinks(dev);
858 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900859 if (MAJOR(dev->devt))
860 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200861 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900862 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700863 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100864 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 kobject_del(&dev->kobj);
866 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100867 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 if (parent)
869 put_device(parent);
870 goto Done;
871}
872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800874 * device_register - register a device with the system.
875 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800877 * This happens in two clean steps - initialize the device
878 * and add it to the system. The two steps can be called
879 * separately, but this is the easiest and most common.
880 * I.e. you should only call the two helpers separately if
881 * have a clearly defined need to use and refcount the device
882 * before it is added to the hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884int device_register(struct device *dev)
885{
886 device_initialize(dev);
887 return device_add(dev);
888}
889
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800891 * get_device - increment reference count for device.
892 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800894 * This simply forwards the call to kobject_get(), though
895 * we do take care to provide for the case that we get a NULL
896 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800898struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899{
900 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
901}
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800904 * put_device - decrement reference count.
905 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800907void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200909 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 if (dev)
911 kobject_put(&dev->kobj);
912}
913
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800915 * device_del - delete device from system.
916 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800918 * This is the first part of the device unregistration
919 * sequence. This removes the device from the lists we control
920 * from here, has it removed from the other driver model
921 * subsystems it was added to in device_add(), and removes it
922 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800924 * NOTE: this should be called manually _iff_ device_add() was
925 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800927void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800929 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200930 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100932 device_pm_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -0700934 klist_del(&dev->knode_parent);
Tejun Heoad6a1e12007-06-14 03:45:17 +0900935 if (MAJOR(dev->devt))
936 device_remove_file(dev, &devt_attr);
Kay Sieversb9d9c822006-06-15 15:31:56 +0200937 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100938 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +0200939
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700940 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200941 /* notify any interfaces that the device is now gone */
942 list_for_each_entry(class_intf, &dev->class->interfaces, node)
943 if (class_intf->remove_dev)
944 class_intf->remove_dev(dev, class_intf);
945 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700946 list_del_init(&dev->node);
947 up(&dev->class->sem);
Kay Sieversb9d9c822006-06-15 15:31:56 +0200948 }
Tejun Heoad6a1e12007-06-14 03:45:17 +0900949 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700950 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -0800951 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Tejun Heo2f8d16a2007-03-09 19:34:19 +0900953 /*
954 * Some platform devices are driven without driver attached
955 * and managed resources may have been acquired. Make sure
956 * all resources are released.
957 */
958 devres_release_all(dev);
959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 /* Notify the platform of the removal, in case they
961 * need to do anything...
962 */
963 if (platform_notify_remove)
964 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000965 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700966 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000967 BUS_NOTIFY_DEL_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100968 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +0100969 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +0100971 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972}
973
974/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800975 * device_unregister - unregister device from system.
976 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800978 * We do this in two parts, like we do device_register(). First,
979 * we remove it from all the subsystems with device_del(), then
980 * we decrement the reference count via put_device(). If that
981 * is the final reference count, the device will be cleaned up
982 * via device_release() above. Otherwise, the structure will
983 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800985void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986{
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800987 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 device_del(dev);
989 put_device(dev);
990}
991
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800992static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800993{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800994 struct klist_node *n = klist_next(i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800995 return n ? container_of(n, struct device, knode_parent) : NULL;
996}
997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800999 * device_for_each_child - device child iterator.
1000 * @parent: parent struct device.
1001 * @data: data for the callback.
1002 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001004 * Iterate over @parent's child devices, and call @fn for each,
1005 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001007 * We check the return of @fn each time. If it returns anything
1008 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001010int device_for_each_child(struct device *parent, void *data,
1011 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001013 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001014 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 int error = 0;
1016
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001017 klist_iter_init(&parent->klist_children, &i);
1018 while ((child = next_device(&i)) && !error)
1019 error = fn(child, data);
1020 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 return error;
1022}
1023
Cornelia Huck5ab69982006-11-16 15:42:07 +01001024/**
1025 * device_find_child - device iterator for locating a particular device.
1026 * @parent: parent struct device
1027 * @data: Data to pass to match function
1028 * @match: Callback function to check device
1029 *
1030 * This is similar to the device_for_each_child() function above, but it
1031 * returns a reference to a device that is 'found' for later use, as
1032 * determined by the @match callback.
1033 *
1034 * The callback should return 0 if the device doesn't match and non-zero
1035 * if it does. If the callback returns non-zero and a reference to the
1036 * current device can be obtained, this function will return to the caller
1037 * and not iterate over any more devices.
1038 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001039struct device *device_find_child(struct device *parent, void *data,
1040 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001041{
1042 struct klist_iter i;
1043 struct device *child;
1044
1045 if (!parent)
1046 return NULL;
1047
1048 klist_iter_init(&parent->klist_children, &i);
1049 while ((child = next_device(&i)))
1050 if (match(child, data) && get_device(child))
1051 break;
1052 klist_iter_exit(&i);
1053 return child;
1054}
1055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056int __init devices_init(void)
1057{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001058 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1059 if (!devices_kset)
1060 return -ENOMEM;
1061 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062}
1063
1064EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001065EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
1067EXPORT_SYMBOL_GPL(device_initialize);
1068EXPORT_SYMBOL_GPL(device_add);
1069EXPORT_SYMBOL_GPL(device_register);
1070
1071EXPORT_SYMBOL_GPL(device_del);
1072EXPORT_SYMBOL_GPL(device_unregister);
1073EXPORT_SYMBOL_GPL(get_device);
1074EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
1076EXPORT_SYMBOL_GPL(device_create_file);
1077EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001078
1079
1080static void device_create_release(struct device *dev)
1081{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001082 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001083 kfree(dev);
1084}
1085
1086/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001087 * device_create_vargs - creates a device and registers it with sysfs
1088 * @class: pointer to the struct class that this device should be registered to
1089 * @parent: pointer to the parent struct device of this new device, if any
1090 * @devt: the dev_t for the char device to be added
1091 * @drvdata: the data to be added to the device for callbacks
1092 * @fmt: string for the device's name
1093 * @args: va_list for the device's name
1094 *
1095 * This function can be used by char device classes. A struct device
1096 * will be created in sysfs, registered to the specified class.
1097 *
1098 * A "dev" file will be created, showing the dev_t for the device, if
1099 * the dev_t is not 0,0.
1100 * If a pointer to a parent struct device is passed in, the newly created
1101 * struct device will be a child of that device in sysfs.
1102 * The pointer to the struct device will be returned from the call.
1103 * Any further sysfs files that might be required can be created using this
1104 * pointer.
1105 *
1106 * Note: the struct class passed to this function must have previously
1107 * been created with a call to class_create().
1108 */
1109struct device *device_create_vargs(struct class *class, struct device *parent,
1110 dev_t devt, void *drvdata, const char *fmt,
1111 va_list args)
1112{
1113 struct device *dev = NULL;
1114 int retval = -ENODEV;
1115
1116 if (class == NULL || IS_ERR(class))
1117 goto error;
1118
1119 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1120 if (!dev) {
1121 retval = -ENOMEM;
1122 goto error;
1123 }
1124
1125 dev->devt = devt;
1126 dev->class = class;
1127 dev->parent = parent;
1128 dev->release = device_create_release;
1129 dev_set_drvdata(dev, drvdata);
1130
1131 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1132 retval = device_register(dev);
1133 if (retval)
1134 goto error;
1135
1136 return dev;
1137
1138error:
1139 kfree(dev);
1140 return ERR_PTR(retval);
1141}
1142EXPORT_SYMBOL_GPL(device_create_vargs);
1143
1144/**
1145 * device_create_drvdata - creates a device and registers it with sysfs
1146 * @class: pointer to the struct class that this device should be registered to
1147 * @parent: pointer to the parent struct device of this new device, if any
1148 * @devt: the dev_t for the char device to be added
1149 * @drvdata: the data to be added to the device for callbacks
1150 * @fmt: string for the device's name
1151 *
1152 * This function can be used by char device classes. A struct device
1153 * will be created in sysfs, registered to the specified class.
1154 *
1155 * A "dev" file will be created, showing the dev_t for the device, if
1156 * the dev_t is not 0,0.
1157 * If a pointer to a parent struct device is passed in, the newly created
1158 * struct device will be a child of that device in sysfs.
1159 * The pointer to the struct device will be returned from the call.
1160 * Any further sysfs files that might be required can be created using this
1161 * pointer.
1162 *
1163 * Note: the struct class passed to this function must have previously
1164 * been created with a call to class_create().
1165 */
1166struct device *device_create_drvdata(struct class *class,
1167 struct device *parent,
1168 dev_t devt,
1169 void *drvdata,
1170 const char *fmt, ...)
1171{
1172 va_list vargs;
1173 struct device *dev;
1174
1175 va_start(vargs, fmt);
1176 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1177 va_end(vargs);
1178 return dev;
1179}
1180EXPORT_SYMBOL_GPL(device_create_drvdata);
1181
1182/**
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001183 * device_create - creates a device and registers it with sysfs
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001184 * @class: pointer to the struct class that this device should be registered to
1185 * @parent: pointer to the parent struct device of this new device, if any
1186 * @devt: the dev_t for the char device to be added
1187 * @fmt: string for the device's name
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001188 *
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001189 * This function can be used by char device classes. A struct device
1190 * will be created in sysfs, registered to the specified class.
1191 *
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001192 * A "dev" file will be created, showing the dev_t for the device, if
1193 * the dev_t is not 0,0.
Henrik Kretzschmar42734da2006-07-05 00:53:19 +02001194 * If a pointer to a parent struct device is passed in, the newly created
1195 * struct device will be a child of that device in sysfs.
1196 * The pointer to the struct device will be returned from the call.
1197 * Any further sysfs files that might be required can be created using this
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001198 * pointer.
1199 *
1200 * Note: the struct class passed to this function must have previously
1201 * been created with a call to class_create().
1202 */
1203struct device *device_create(struct class *class, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -04001204 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001205{
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001206 va_list vargs;
1207 struct device *dev;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001208
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001209 va_start(vargs, fmt);
1210 dev = device_create_vargs(class, parent, devt, NULL, fmt, vargs);
1211 va_end(vargs);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001212 return dev;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001213}
1214EXPORT_SYMBOL_GPL(device_create);
1215
Dave Youngcd354492008-01-28 16:56:11 +08001216static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001217{
Dave Youngcd354492008-01-28 16:56:11 +08001218 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001219
Dave Youngcd354492008-01-28 16:56:11 +08001220 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001221}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001222
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001223/**
1224 * device_destroy - removes a device that was created with device_create()
1225 * @class: pointer to the struct class that this device was registered with
1226 * @devt: the dev_t of the device that was previously registered
1227 *
1228 * This call unregisters and cleans up a device that was created with a
1229 * call to device_create().
1230 */
1231void device_destroy(struct class *class, dev_t devt)
1232{
1233 struct device *dev;
1234
Dave Youngcd354492008-01-28 16:56:11 +08001235 dev = class_find_device(class, &devt, __match_devt);
1236 if (dev) {
1237 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001238 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001239 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001240}
1241EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001242
1243/**
1244 * device_rename - renames a device
1245 * @dev: the pointer to the struct device to be renamed
1246 * @new_name: the new name of the device
1247 */
1248int device_rename(struct device *dev, char *new_name)
1249{
1250 char *old_class_name = NULL;
1251 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001252 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001253 int error;
1254
1255 dev = get_device(dev);
1256 if (!dev)
1257 return -EINVAL;
1258
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001259 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001260 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001261
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001262#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001263 if ((dev->class) && (dev->parent))
1264 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001265#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001266
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001267 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1268 if (!old_device_name) {
1269 error = -ENOMEM;
1270 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001271 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001272 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001273 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1274
1275 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001276 if (error) {
1277 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1278 goto out;
1279 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001280
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001281#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001282 if (old_class_name) {
1283 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1284 if (new_class_name) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001285 error = sysfs_create_link(&dev->parent->kobj,
1286 &dev->kobj, new_class_name);
1287 if (error)
1288 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001289 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1290 }
1291 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001292#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001293 if (dev->class) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001294 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1295 dev->bus_id);
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001296 if (error)
1297 goto out;
1298 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001299 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001300#endif
1301
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001302out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001303 put_device(dev);
1304
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001305 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001306 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001307 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001308
1309 return error;
1310}
Johannes Berga2807db2007-02-28 12:38:31 +01001311EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001312
1313static int device_move_class_links(struct device *dev,
1314 struct device *old_parent,
1315 struct device *new_parent)
1316{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001317 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001318#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001319 char *class_name;
1320
1321 class_name = make_class_name(dev->class->name, &dev->kobj);
1322 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001323 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001324 goto out;
1325 }
1326 if (old_parent) {
1327 sysfs_remove_link(&dev->kobj, "device");
1328 sysfs_remove_link(&old_parent->kobj, class_name);
1329 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001330 if (new_parent) {
1331 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1332 "device");
1333 if (error)
1334 goto out;
1335 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1336 class_name);
1337 if (error)
1338 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001339 } else
Cornelia Huckc744aea2007-01-08 20:16:44 +01001340 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001341out:
1342 kfree(class_name);
1343 return error;
1344#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001345 if (old_parent)
1346 sysfs_remove_link(&dev->kobj, "device");
1347 if (new_parent)
1348 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1349 "device");
1350 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001351#endif
1352}
1353
1354/**
1355 * device_move - moves a device to a new parent
1356 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001357 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001358 */
1359int device_move(struct device *dev, struct device *new_parent)
1360{
1361 int error;
1362 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001363 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001364
1365 dev = get_device(dev);
1366 if (!dev)
1367 return -EINVAL;
1368
Cornelia Huck8a824722006-11-20 17:07:51 +01001369 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001370 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001371
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001372 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001373 __func__, new_parent ? new_parent->bus_id : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001374 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001375 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001376 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001377 put_device(new_parent);
1378 goto out;
1379 }
1380 old_parent = dev->parent;
1381 dev->parent = new_parent;
1382 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001383 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001384 if (new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001385 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001386 set_dev_node(dev, dev_to_node(new_parent));
1387 }
1388
Cornelia Huck8a824722006-11-20 17:07:51 +01001389 if (!dev->class)
1390 goto out_put;
1391 error = device_move_class_links(dev, old_parent, new_parent);
1392 if (error) {
1393 /* We ignore errors on cleanup since we're hosed anyway... */
1394 device_move_class_links(dev, new_parent, old_parent);
1395 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001396 if (new_parent)
1397 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001398 dev->parent = old_parent;
1399 if (old_parent) {
Cornelia Huck8a824722006-11-20 17:07:51 +01001400 klist_add_tail(&dev->knode_parent,
1401 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001402 set_dev_node(dev, dev_to_node(old_parent));
1403 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001404 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001405 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001406 put_device(new_parent);
1407 goto out;
1408 }
1409out_put:
1410 put_device(old_parent);
1411out:
1412 put_device(dev);
1413 return error;
1414}
Cornelia Huck8a824722006-11-20 17:07:51 +01001415EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001416
1417/**
1418 * device_shutdown - call ->shutdown() on each device to shutdown.
1419 */
1420void device_shutdown(void)
1421{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001422 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001423
1424 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1425 kobj.entry) {
1426 if (dev->bus && dev->bus->shutdown) {
1427 dev_dbg(dev, "shutdown\n");
1428 dev->bus->shutdown(dev);
1429 } else if (dev->driver && dev->driver->shutdown) {
1430 dev_dbg(dev, "shutdown\n");
1431 dev->driver->shutdown(dev);
1432 }
1433 }
1434}