blob: 9ae28aa709d5f8044c65d4ef783e682e818ff241 [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;
Dan Williamse105b8b2008-04-21 10:51:07 -070030static struct kobject *dev_kobj;
31struct kobject *sysfs_dev_char_kobj;
32struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -080034#ifdef CONFIG_BLOCK
35static inline int device_is_not_partition(struct device *dev)
36{
37 return !(dev->type == &part_type);
38}
39#else
40static inline int device_is_not_partition(struct device *dev)
41{
42 return 1;
43}
44#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Alan Stern3e956372006-06-16 17:10:48 -040046/**
47 * dev_driver_string - Return a device's driver name, if at all possible
48 * @dev: struct device to get the name of
49 *
50 * Will return the device's driver's name if it is bound to a device. If
51 * the device is not bound to a device, it will return the name of the bus
52 * it is attached to. If it is not attached to a bus either, an empty
53 * string will be returned.
54 */
55const char *dev_driver_string(struct device *dev)
56{
57 return dev->driver ? dev->driver->name :
Jean Delvarea456b702007-03-09 16:33:10 +010058 (dev->bus ? dev->bus->name :
59 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -040060}
Matthew Wilcox310a9222006-09-23 23:35:04 -060061EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -040062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define to_dev(obj) container_of(obj, struct device, kobj)
64#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
65
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080066static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
67 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080069 struct device_attribute *dev_attr = to_dev_attr(attr);
70 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050071 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -040074 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -080075 if (ret >= (ssize_t)PAGE_SIZE) {
76 print_symbol("dev_attr_show: %s returned bad count\n",
77 (unsigned long)dev_attr->show);
78 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 return ret;
80}
81
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080082static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
83 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -080085 struct device_attribute *dev_attr = to_dev_attr(attr);
86 struct device *dev = to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050087 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -040090 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 return ret;
92}
93
94static struct sysfs_ops dev_sysfs_ops = {
95 .show = dev_attr_show,
96 .store = dev_attr_store,
97};
98
99
100/**
101 * device_release - free device structure.
102 * @kobj: device's kobject.
103 *
104 * This is called once the reference count for the object
105 * reaches 0. We forward the call to the device's release
106 * method, which should handle actually freeing the structure.
107 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800108static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800110 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112 if (dev->release)
113 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200114 else if (dev->type && dev->type->release)
115 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700116 else if (dev->class && dev->class->dev_release)
117 dev->class->dev_release(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 else {
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800119 printk(KERN_ERR "Device '%s' does not have a release() "
120 "function, it is broken and must be fixed.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 dev->bus_id);
122 WARN_ON(1);
123 }
124}
125
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600126static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 .release = device_release,
128 .sysfs_ops = &dev_sysfs_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
130
131
Kay Sievers312c0042005-11-16 09:00:00 +0100132static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
134 struct kobj_type *ktype = get_ktype(kobj);
135
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600136 if (ktype == &device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 struct device *dev = to_dev(kobj);
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200138 if (dev->uevent_suppress)
139 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 if (dev->bus)
141 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700142 if (dev->class)
143 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 }
145 return 0;
146}
147
Kay Sievers312c0042005-11-16 09:00:00 +0100148static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149{
150 struct device *dev = to_dev(kobj);
151
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700152 if (dev->bus)
153 return dev->bus->name;
154 if (dev->class)
155 return dev->class->name;
156 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Kay Sievers7eff2e72007-08-14 15:15:12 +0200159static int dev_uevent(struct kset *kset, struct kobject *kobj,
160 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
162 struct device *dev = to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 int retval = 0;
164
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700165 /* add the major/minor if present */
166 if (MAJOR(dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200167 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
168 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700169 }
170
Kay Sievers414264f2007-03-12 21:08:57 +0100171 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200172 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100173
Kay Sievers239378f2006-10-07 21:54:55 +0200174 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200175 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200176
Kay Sieversa87cb2a2006-09-14 11:23:28 +0200177#ifdef CONFIG_SYSFS_DEPRECATED
Kay Sievers239378f2006-10-07 21:54:55 +0200178 if (dev->class) {
179 struct device *parent = dev->parent;
180
181 /* find first bus device in parent chain */
182 while (parent && !parent->bus)
183 parent = parent->parent;
184 if (parent && parent->bus) {
185 const char *path;
186
187 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200188 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200189 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200190 kfree(path);
191 }
Kay Sievers239378f2006-10-07 21:54:55 +0200192
Kay Sievers7eff2e72007-08-14 15:15:12 +0200193 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200194
195 if (parent->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200196 add_uevent_var(env, "PHYSDEVDRIVER=%s",
197 parent->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200198 }
199 } else if (dev->bus) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200200 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200201
202 if (dev->driver)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800203 add_uevent_var(env, "PHYSDEVDRIVER=%s",
204 dev->driver->name);
Kay Sieversd81d9d62006-08-13 06:17:09 +0200205 }
Kay Sievers239378f2006-10-07 21:54:55 +0200206#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Kay Sievers7eff2e72007-08-14 15:15:12 +0200208 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100209 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200210 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200211 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800212 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800213 dev->bus_id, __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 }
215
Kay Sievers7eff2e72007-08-14 15:15:12 +0200216 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700217 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200218 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200219 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800220 pr_debug("device: '%s': %s: class uevent() "
221 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800222 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200223 }
224
Kay Sievers7eff2e72007-08-14 15:15:12 +0200225 /* have the device type specific fuction add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200226 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200227 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200228 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800229 pr_debug("device: '%s': %s: dev_type uevent() "
230 "returned %d\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800231 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700232 }
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 return retval;
235}
236
Kay Sievers312c0042005-11-16 09:00:00 +0100237static struct kset_uevent_ops device_uevent_ops = {
238 .filter = dev_uevent_filter,
239 .name = dev_uevent_name,
240 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241};
242
Kay Sievers16574dc2007-04-06 01:40:38 +0200243static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
244 char *buf)
245{
246 struct kobject *top_kobj;
247 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200248 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200249 int i;
250 size_t count = 0;
251 int retval;
252
253 /* search the kset, the device belongs to */
254 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200255 while (!top_kobj->kset && top_kobj->parent)
256 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200257 if (!top_kobj->kset)
258 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200259
Kay Sievers16574dc2007-04-06 01:40:38 +0200260 kset = top_kobj->kset;
261 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
262 goto out;
263
264 /* respect filter */
265 if (kset->uevent_ops && kset->uevent_ops->filter)
266 if (!kset->uevent_ops->filter(kset, &dev->kobj))
267 goto out;
268
Kay Sievers7eff2e72007-08-14 15:15:12 +0200269 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
270 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200271 return -ENOMEM;
272
Kay Sievers16574dc2007-04-06 01:40:38 +0200273 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200274 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200275 if (retval)
276 goto out;
277
278 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200279 for (i = 0; i < env->envp_idx; i++)
280 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200281out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200282 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200283 return count;
284}
285
Kay Sieversa7fd6702005-10-01 14:49:43 +0200286static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
287 const char *buf, size_t count)
288{
Kay Sievers60a96a52007-07-08 22:29:26 +0200289 enum kobject_action action;
290
Kay Sievers5c5daf62007-08-12 20:43:55 +0200291 if (kobject_action_type(buf, count, &action) == 0) {
Kay Sievers60a96a52007-07-08 22:29:26 +0200292 kobject_uevent(&dev->kobj, action);
293 goto out;
294 }
295
296 dev_err(dev, "uevent: unsupported action-string; this will "
297 "be ignored in a future kernel version\n");
Kay Sievers312c0042005-11-16 09:00:00 +0100298 kobject_uevent(&dev->kobj, KOBJ_ADD);
Kay Sievers60a96a52007-07-08 22:29:26 +0200299out:
Kay Sieversa7fd6702005-10-01 14:49:43 +0200300 return count;
301}
302
Tejun Heoad6a1e12007-06-14 03:45:17 +0900303static struct device_attribute uevent_attr =
304 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
305
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500306static int device_add_attributes(struct device *dev,
307 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700308{
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700309 int error = 0;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500310 int i;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700311
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500312 if (attrs) {
313 for (i = 0; attr_name(attrs[i]); i++) {
314 error = device_create_file(dev, &attrs[i]);
315 if (error)
316 break;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700317 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500318 if (error)
319 while (--i >= 0)
320 device_remove_file(dev, &attrs[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700321 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700322 return error;
323}
324
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500325static void device_remove_attributes(struct device *dev,
326 struct device_attribute *attrs)
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700327{
328 int i;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500329
330 if (attrs)
331 for (i = 0; attr_name(attrs[i]); i++)
332 device_remove_file(dev, &attrs[i]);
333}
334
335static int device_add_groups(struct device *dev,
336 struct attribute_group **groups)
337{
338 int error = 0;
339 int i;
340
341 if (groups) {
342 for (i = 0; groups[i]; i++) {
343 error = sysfs_create_group(&dev->kobj, groups[i]);
344 if (error) {
345 while (--i >= 0)
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800346 sysfs_remove_group(&dev->kobj,
347 groups[i]);
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500348 break;
349 }
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700350 }
351 }
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500352 return error;
353}
354
355static void device_remove_groups(struct device *dev,
356 struct attribute_group **groups)
357{
358 int i;
359
360 if (groups)
361 for (i = 0; groups[i]; i++)
362 sysfs_remove_group(&dev->kobj, groups[i]);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700363}
364
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700365static int device_add_attrs(struct device *dev)
366{
367 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200368 struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500369 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700370
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500371 if (class) {
372 error = device_add_attributes(dev, class->dev_attrs);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200373 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500374 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700375 }
Kay Sieversf9f852d2006-10-07 21:54:55 +0200376
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500377 if (type) {
378 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200379 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500380 goto err_remove_class_attrs;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200381 }
382
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500383 error = device_add_groups(dev, dev->groups);
384 if (error)
385 goto err_remove_type_groups;
386
387 return 0;
388
389 err_remove_type_groups:
390 if (type)
391 device_remove_groups(dev, type->groups);
392 err_remove_class_attrs:
393 if (class)
394 device_remove_attributes(dev, class->dev_attrs);
395
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700396 return error;
397}
398
399static void device_remove_attrs(struct device *dev)
400{
401 struct class *class = dev->class;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200402 struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700403
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500404 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200405
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500406 if (type)
407 device_remove_groups(dev, type->groups);
408
409 if (class)
410 device_remove_attributes(dev, class->dev_attrs);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700411}
412
413
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700414static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
415 char *buf)
416{
417 return print_dev_t(buf, dev->devt);
418}
419
Tejun Heoad6a1e12007-06-14 03:45:17 +0900420static struct device_attribute devt_attr =
421 __ATTR(dev, S_IRUGO, show_dev, NULL);
422
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600423/* kset to create /sys/devices/ */
424struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800427 * device_create_file - create sysfs attribute file for device.
428 * @dev: device.
429 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800431int device_create_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
433 int error = 0;
Cornelia Huck0c98b192008-01-31 10:39:38 +0100434 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 error = sysfs_create_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 return error;
437}
438
439/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800440 * device_remove_file - remove sysfs attribute file.
441 * @dev: device.
442 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800444void device_remove_file(struct device *dev, struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
Cornelia Huck0c98b192008-01-31 10:39:38 +0100446 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448}
449
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700450/**
451 * device_create_bin_file - create sysfs binary attribute file for device.
452 * @dev: device.
453 * @attr: device binary attribute descriptor.
454 */
455int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
456{
457 int error = -EINVAL;
458 if (dev)
459 error = sysfs_create_bin_file(&dev->kobj, attr);
460 return error;
461}
462EXPORT_SYMBOL_GPL(device_create_bin_file);
463
464/**
465 * device_remove_bin_file - remove sysfs binary attribute file
466 * @dev: device.
467 * @attr: device binary attribute descriptor.
468 */
469void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
470{
471 if (dev)
472 sysfs_remove_bin_file(&dev->kobj, attr);
473}
474EXPORT_SYMBOL_GPL(device_remove_bin_file);
475
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400476/**
Alan Stern523ded72007-04-26 00:12:04 -0700477 * device_schedule_callback_owner - helper to schedule a callback for a device
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400478 * @dev: device.
479 * @func: callback function to invoke later.
Alan Stern523ded72007-04-26 00:12:04 -0700480 * @owner: module owning the callback routine
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400481 *
482 * Attribute methods must not unregister themselves or their parent device
483 * (which would amount to the same thing). Attempts to do so will deadlock,
484 * since unregistration is mutually exclusive with driver callbacks.
485 *
486 * Instead methods can call this routine, which will attempt to allocate
487 * and schedule a workqueue request to call back @func with @dev as its
488 * argument in the workqueue's process context. @dev will be pinned until
489 * @func returns.
490 *
Alan Stern523ded72007-04-26 00:12:04 -0700491 * This routine is usually called via the inline device_schedule_callback(),
492 * which automatically sets @owner to THIS_MODULE.
493 *
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400494 * Returns 0 if the request was submitted, -ENOMEM if storage could not
Alan Stern523ded72007-04-26 00:12:04 -0700495 * be allocated, -ENODEV if a reference to @owner isn't available.
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400496 *
497 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
498 * underlying sysfs routine (since it is intended for use by attribute
499 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
500 */
Alan Stern523ded72007-04-26 00:12:04 -0700501int device_schedule_callback_owner(struct device *dev,
502 void (*func)(struct device *), struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400503{
504 return sysfs_schedule_callback(&dev->kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700505 (void (*)(void *)) func, dev, owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400506}
Alan Stern523ded72007-04-26 00:12:04 -0700507EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400508
James Bottomley34bb61f2005-09-06 16:56:51 -0700509static void klist_children_get(struct klist_node *n)
510{
511 struct device *dev = container_of(n, struct device, knode_parent);
512
513 get_device(dev);
514}
515
516static void klist_children_put(struct klist_node *n)
517{
518 struct device *dev = container_of(n, struct device, knode_parent);
519
520 put_device(dev);
521}
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800524 * device_initialize - init device structure.
525 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800527 * This prepares the device for use by other layers,
528 * including adding it to the device hierarchy.
529 * It is the first half of device_register(), if called by
530 * that, though it can also be called separately, so one
531 * may use @dev's fields (e.g. the refcount).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533void device_initialize(struct device *dev)
534{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -0600535 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700536 kobject_init(&dev->kobj, &device_ktype);
James Bottomley34bb61f2005-09-06 16:56:51 -0700537 klist_init(&dev->klist_children, klist_children_get,
538 klist_children_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 INIT_LIST_HEAD(&dev->dma_pools);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700540 INIT_LIST_HEAD(&dev->node);
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800541 init_MUTEX(&dev->sem);
Tejun Heo9ac78492007-01-20 16:00:26 +0900542 spin_lock_init(&dev->devres_lock);
543 INIT_LIST_HEAD(&dev->devres_head);
David Brownell0ac85242005-09-12 19:39:34 -0700544 device_init_wakeup(dev, 0);
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-Hartman823bccf2007-04-13 13:15:19 -0700554 return &dev->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 */
600 spin_lock(&dev->class->class_dirs.list_lock);
601 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
602 if (k->parent == parent_kobj) {
603 kobj = kobject_get(k);
604 break;
605 }
606 spin_unlock(&dev->class->class_dirs.list_lock);
607 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;
614 k->kset = &dev->class->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 ||
633 glue_dir->kset != &dev->class->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
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700660 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
661 "subsystem");
662 if (error)
663 goto out;
Kay Sieversda231fd2007-11-21 17:29:15 +0100664
665#ifdef CONFIG_SYSFS_DEPRECATED
666 /* stacked class devices need a symlink in the class directory */
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200667 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800668 device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700669 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
670 dev->bus_id);
671 if (error)
672 goto out_subsys;
673 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100674
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800675 if (dev->parent && device_is_not_partition(dev)) {
Kay Sieversda231fd2007-11-21 17:29:15 +0100676 struct device *parent = dev->parent;
677 char *class_name;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700678
Kay Sieversda231fd2007-11-21 17:29:15 +0100679 /*
680 * stacked class devices have the 'device' link
681 * pointing to the bus device instead of the parent
682 */
683 while (parent->class && !parent->bus && parent->parent)
684 parent = parent->parent;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700685
Kay Sieversda231fd2007-11-21 17:29:15 +0100686 error = sysfs_create_link(&dev->kobj,
687 &parent->kobj,
688 "device");
689 if (error)
690 goto out_busid;
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700691
Kay Sieversda231fd2007-11-21 17:29:15 +0100692 class_name = make_class_name(dev->class->name,
693 &dev->kobj);
694 if (class_name)
695 error = sysfs_create_link(&dev->parent->kobj,
696 &dev->kobj, class_name);
697 kfree(class_name);
698 if (error)
699 goto out_device;
700 }
701 return 0;
702
703out_device:
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800704 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100705 sysfs_remove_link(&dev->kobj, "device");
706out_busid:
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200707 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800708 device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100709 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700710#else
Kay Sieversda231fd2007-11-21 17:29:15 +0100711 /* link in the class directory pointing to the device */
712 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
713 dev->bus_id);
714 if (error)
715 goto out_subsys;
716
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800717 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -0700718 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
719 "device");
720 if (error)
721 goto out_busid;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700722 }
723 return 0;
724
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700725out_busid:
Kay Sieversda231fd2007-11-21 17:29:15 +0100726 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
727#endif
728
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700729out_subsys:
730 sysfs_remove_link(&dev->kobj, "subsystem");
731out:
732 return error;
733}
734
735static void device_remove_class_symlinks(struct device *dev)
736{
737 if (!dev->class)
738 return;
Kay Sieversda231fd2007-11-21 17:29:15 +0100739
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700740#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800741 if (dev->parent && device_is_not_partition(dev)) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700742 char *class_name;
743
744 class_name = make_class_name(dev->class->name, &dev->kobj);
745 if (class_name) {
746 sysfs_remove_link(&dev->parent->kobj, class_name);
747 kfree(class_name);
748 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700749 sysfs_remove_link(&dev->kobj, "device");
750 }
Kay Sieversda231fd2007-11-21 17:29:15 +0100751
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200752 if (dev->kobj.parent != &dev->class->subsys.kobj &&
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800753 device_is_not_partition(dev))
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700754 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
Kay Sieversda231fd2007-11-21 17:29:15 +0100755#else
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800756 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +0100757 sysfs_remove_link(&dev->kobj, "device");
758
759 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
760#endif
761
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700762 sysfs_remove_link(&dev->kobj, "subsystem");
763}
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/**
Stephen Rothwell413c2392008-05-30 10:16:40 +1000766 * dev_set_name - set a device name
767 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -0700768 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +1000769 */
770int dev_set_name(struct device *dev, const char *fmt, ...)
771{
772 va_list vargs;
773
774 va_start(vargs, fmt);
775 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
776 va_end(vargs);
777 return 0;
778}
779EXPORT_SYMBOL_GPL(dev_set_name);
780
781/**
Dan Williamse105b8b2008-04-21 10:51:07 -0700782 * device_to_dev_kobj - select a /sys/dev/ directory for the device
783 * @dev: device
784 *
785 * By default we select char/ for new entries. Setting class->dev_obj
786 * to NULL prevents an entry from being created. class->dev_kobj must
787 * be set (or cleared) before any devices are registered to the class
788 * otherwise device_create_sys_dev_entry() and
789 * device_remove_sys_dev_entry() will disagree about the the presence
790 * of the link.
791 */
792static struct kobject *device_to_dev_kobj(struct device *dev)
793{
794 struct kobject *kobj;
795
796 if (dev->class)
797 kobj = dev->class->dev_kobj;
798 else
799 kobj = sysfs_dev_char_kobj;
800
801 return kobj;
802}
803
804static int device_create_sys_dev_entry(struct device *dev)
805{
806 struct kobject *kobj = device_to_dev_kobj(dev);
807 int error = 0;
808 char devt_str[15];
809
810 if (kobj) {
811 format_dev_t(devt_str, dev->devt);
812 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
813 }
814
815 return error;
816}
817
818static void device_remove_sys_dev_entry(struct device *dev)
819{
820 struct kobject *kobj = device_to_dev_kobj(dev);
821 char devt_str[15];
822
823 if (kobj) {
824 format_dev_t(devt_str, dev->devt);
825 sysfs_remove_link(kobj, devt_str);
826 }
827}
828
829/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800830 * device_add - add device to device hierarchy.
831 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800833 * This is part 2 of device_register(), though may be called
834 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800836 * This adds it to the kobject hierarchy via kobject_add(), adds it
837 * to the global and sibling lists for the device, then
838 * adds it to the other relevant subsystems of the driver model.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
840int device_add(struct device *dev)
841{
842 struct device *parent = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200843 struct class_interface *class_intf;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100844 int error;
845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 dev = get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100847 if (!dev || !strlen(dev->bus_id)) {
848 error = -EINVAL;
Cornelia Huckc1fe5392008-02-27 15:38:23 +0100849 goto Done;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100850 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800852 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 parent = get_device(dev->parent);
Cornelia Huck63b69712008-01-21 16:09:44 +0100855 setup_parent(dev, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Yinghai Lu0d358f22008-02-19 03:20:41 -0800857 /* use parent numa_node */
858 if (parent)
859 set_dev_node(dev, dev_to_node(parent));
860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 /* first, register with generic layer. */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700862 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +0100863 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 goto Error;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200865
Brian Walsh37022642006-08-14 22:43:19 -0700866 /* notify platform of device entry */
867 if (platform_notify)
868 platform_notify(dev);
869
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000870 /* notify clients of device entry (new way) */
871 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700872 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000873 BUS_NOTIFY_ADD_DEVICE, dev);
874
Tejun Heoad6a1e12007-06-14 03:45:17 +0900875 error = device_create_file(dev, &uevent_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200876 if (error)
877 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200878
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700879 if (MAJOR(dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900880 error = device_create_file(dev, &devt_attr);
881 if (error)
Cornelia Hucka306eea2006-09-22 11:37:13 +0200882 goto ueventattrError;
Dan Williamse105b8b2008-04-21 10:51:07 -0700883
884 error = device_create_sys_dev_entry(dev);
885 if (error)
886 goto devtattrError;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700887 }
888
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700889 error = device_add_class_symlinks(dev);
890 if (error)
891 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700892 error = device_add_attrs(dev);
893 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700894 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -0700895 error = bus_add_device(dev);
896 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 goto BusError;
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100898 error = device_pm_add(dev);
899 if (error)
900 goto PMError;
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +0200901 kobject_uevent(&dev->kobj, KOBJ_ADD);
Cornelia Huckc6a46692007-02-05 16:15:26 -0800902 bus_attach_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 if (parent)
James Bottomleyd856f1e2005-08-19 09:14:01 -0400904 klist_add_tail(&dev->knode_parent, &parent->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700906 if (dev->class) {
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700907 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200908 /* tie the class to the device */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700909 list_add_tail(&dev->node, &dev->class->devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200910
911 /* notify any interfaces that the device is here */
912 list_for_each_entry(class_intf, &dev->class->interfaces, node)
913 if (class_intf->add_dev)
914 class_intf->add_dev(dev, class_intf);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -0700915 up(&dev->class->sem);
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 Done:
918 put_device(dev);
919 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 PMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +0100921 bus_remove_device(dev);
922 BusError:
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000923 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -0700924 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000925 BUS_NOTIFY_DEL_DEVICE, dev);
James Simmons82f0cf92007-02-21 17:44:51 +0000926 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700927 AttrsError:
Cornelia Huck2ee97caf2007-07-18 01:43:47 -0700928 device_remove_class_symlinks(dev);
929 SymlinkError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900930 if (MAJOR(dev->devt))
Dan Williamse105b8b2008-04-21 10:51:07 -0700931 device_remove_sys_dev_entry(dev);
932 devtattrError:
933 if (MAJOR(dev->devt))
Tejun Heoad6a1e12007-06-14 03:45:17 +0900934 device_remove_file(dev, &devt_attr);
Cornelia Hucka306eea2006-09-22 11:37:13 +0200935 ueventattrError:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900936 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700937 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +0100938 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 kobject_del(&dev->kobj);
940 Error:
Cornelia Huck63b69712008-01-21 16:09:44 +0100941 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 if (parent)
943 put_device(parent);
944 goto Done;
945}
946
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800948 * device_register - register a device with the system.
949 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800951 * This happens in two clean steps - initialize the device
952 * and add it to the system. The two steps can be called
953 * separately, but this is the easiest and most common.
954 * I.e. you should only call the two helpers separately if
955 * have a clearly defined need to use and refcount the device
956 * before it is added to the hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958int device_register(struct device *dev)
959{
960 device_initialize(dev);
961 return device_add(dev);
962}
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800965 * get_device - increment reference count for device.
966 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800968 * This simply forwards the call to kobject_get(), though
969 * we do take care to provide for the case that we get a NULL
970 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800972struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973{
974 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
975}
976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800978 * put_device - decrement reference count.
979 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800981void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200983 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 if (dev)
985 kobject_put(&dev->kobj);
986}
987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800989 * device_del - delete device from system.
990 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800992 * This is the first part of the device unregistration
993 * sequence. This removes the device from the lists we control
994 * from here, has it removed from the other driver model
995 * subsystems it was added to in device_add(), and removes it
996 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800998 * NOTE: this should be called manually _iff_ device_add() was
999 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001001void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001003 struct device *parent = dev->parent;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001004 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001006 device_pm_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 if (parent)
Patrick Mocheld62c0f92005-06-24 08:39:33 -07001008 klist_del(&dev->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001009 if (MAJOR(dev->devt)) {
1010 device_remove_sys_dev_entry(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001011 device_remove_file(dev, &devt_attr);
Dan Williamse105b8b2008-04-21 10:51:07 -07001012 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001013 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001014 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001015
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001016 down(&dev->class->sem);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001017 /* notify any interfaces that the device is now gone */
1018 list_for_each_entry(class_intf, &dev->class->interfaces, node)
1019 if (class_intf->remove_dev)
1020 class_intf->remove_dev(dev, class_intf);
1021 /* remove the device from the class list */
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001022 list_del_init(&dev->node);
1023 up(&dev->class->sem);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001024 }
Tejun Heoad6a1e12007-06-14 03:45:17 +09001025 device_remove_file(dev, &uevent_attr);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001026 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001027 bus_remove_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
Tejun Heo2f8d16a2007-03-09 19:34:19 +09001029 /*
1030 * Some platform devices are driven without driver attached
1031 * and managed resources may have been acquired. Make sure
1032 * all resources are released.
1033 */
1034 devres_release_all(dev);
1035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 /* Notify the platform of the removal, in case they
1037 * need to do anything...
1038 */
1039 if (platform_notify_remove)
1040 platform_notify_remove(dev);
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001041 if (dev->bus)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07001042 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +10001043 BUS_NOTIFY_DEL_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001044 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Kay Sieversda231fd2007-11-21 17:29:15 +01001045 cleanup_device_parent(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 kobject_del(&dev->kobj);
Kay Sieversda231fd2007-11-21 17:29:15 +01001047 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048}
1049
1050/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001051 * device_unregister - unregister device from system.
1052 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001054 * We do this in two parts, like we do device_register(). First,
1055 * we remove it from all the subsystems with device_del(), then
1056 * we decrement the reference count via put_device(). If that
1057 * is the final reference count, the device will be cleaned up
1058 * via device_release() above. Otherwise, the structure will
1059 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001061void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001063 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 device_del(dev);
1065 put_device(dev);
1066}
1067
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001068static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001069{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001070 struct klist_node *n = klist_next(i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001071 return n ? container_of(n, struct device, knode_parent) : NULL;
1072}
1073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001075 * device_for_each_child - device child iterator.
1076 * @parent: parent struct device.
1077 * @data: data for the callback.
1078 * @fn: function to be called for each device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001080 * Iterate over @parent's child devices, and call @fn for each,
1081 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001083 * We check the return of @fn each time. If it returns anything
1084 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001086int device_for_each_child(struct device *parent, void *data,
1087 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001089 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001090 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 int error = 0;
1092
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001093 klist_iter_init(&parent->klist_children, &i);
1094 while ((child = next_device(&i)) && !error)
1095 error = fn(child, data);
1096 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 return error;
1098}
1099
Cornelia Huck5ab69982006-11-16 15:42:07 +01001100/**
1101 * device_find_child - device iterator for locating a particular device.
1102 * @parent: parent struct device
1103 * @data: Data to pass to match function
1104 * @match: Callback function to check device
1105 *
1106 * This is similar to the device_for_each_child() function above, but it
1107 * returns a reference to a device that is 'found' for later use, as
1108 * determined by the @match callback.
1109 *
1110 * The callback should return 0 if the device doesn't match and non-zero
1111 * if it does. If the callback returns non-zero and a reference to the
1112 * current device can be obtained, this function will return to the caller
1113 * and not iterate over any more devices.
1114 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001115struct device *device_find_child(struct device *parent, void *data,
1116 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01001117{
1118 struct klist_iter i;
1119 struct device *child;
1120
1121 if (!parent)
1122 return NULL;
1123
1124 klist_iter_init(&parent->klist_children, &i);
1125 while ((child = next_device(&i)))
1126 if (match(child, data) && get_device(child))
1127 break;
1128 klist_iter_exit(&i);
1129 return child;
1130}
1131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132int __init devices_init(void)
1133{
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001134 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1135 if (!devices_kset)
1136 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07001137 dev_kobj = kobject_create_and_add("dev", NULL);
1138 if (!dev_kobj)
1139 goto dev_kobj_err;
1140 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1141 if (!sysfs_dev_block_kobj)
1142 goto block_kobj_err;
1143 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1144 if (!sysfs_dev_char_kobj)
1145 goto char_kobj_err;
1146
Greg Kroah-Hartman881c6cf2007-11-01 09:29:06 -06001147 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07001148
1149 char_kobj_err:
1150 kobject_put(sysfs_dev_block_kobj);
1151 block_kobj_err:
1152 kobject_put(dev_kobj);
1153 dev_kobj_err:
1154 kset_unregister(devices_kset);
1155 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156}
1157
1158EXPORT_SYMBOL_GPL(device_for_each_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01001159EXPORT_SYMBOL_GPL(device_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
1161EXPORT_SYMBOL_GPL(device_initialize);
1162EXPORT_SYMBOL_GPL(device_add);
1163EXPORT_SYMBOL_GPL(device_register);
1164
1165EXPORT_SYMBOL_GPL(device_del);
1166EXPORT_SYMBOL_GPL(device_unregister);
1167EXPORT_SYMBOL_GPL(get_device);
1168EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170EXPORT_SYMBOL_GPL(device_create_file);
1171EXPORT_SYMBOL_GPL(device_remove_file);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001172
1173
1174static void device_create_release(struct device *dev)
1175{
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001176 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001177 kfree(dev);
1178}
1179
1180/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001181 * device_create_vargs - creates a device and registers it with sysfs
1182 * @class: pointer to the struct class that this device should be registered to
1183 * @parent: pointer to the parent struct device of this new device, if any
1184 * @devt: the dev_t for the char device to be added
1185 * @drvdata: the data to be added to the device for callbacks
1186 * @fmt: string for the device's name
1187 * @args: va_list for the device's name
1188 *
1189 * This function can be used by char device classes. A struct device
1190 * will be created in sysfs, registered to the specified class.
1191 *
1192 * A "dev" file will be created, showing the dev_t for the device, if
1193 * the dev_t is not 0,0.
1194 * 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
1198 * 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_vargs(struct class *class, struct device *parent,
1204 dev_t devt, void *drvdata, const char *fmt,
1205 va_list args)
1206{
1207 struct device *dev = NULL;
1208 int retval = -ENODEV;
1209
1210 if (class == NULL || IS_ERR(class))
1211 goto error;
1212
1213 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1214 if (!dev) {
1215 retval = -ENOMEM;
1216 goto error;
1217 }
1218
1219 dev->devt = devt;
1220 dev->class = class;
1221 dev->parent = parent;
1222 dev->release = device_create_release;
1223 dev_set_drvdata(dev, drvdata);
1224
1225 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1226 retval = device_register(dev);
1227 if (retval)
1228 goto error;
1229
1230 return dev;
1231
1232error:
1233 kfree(dev);
1234 return ERR_PTR(retval);
1235}
1236EXPORT_SYMBOL_GPL(device_create_vargs);
1237
1238/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001239 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001240 * @class: pointer to the struct class that this device should be registered to
1241 * @parent: pointer to the parent struct device of this new device, if any
1242 * @devt: the dev_t for the char device to be added
1243 * @drvdata: the data to be added to the device for callbacks
1244 * @fmt: string for the device's name
1245 *
1246 * This function can be used by char device classes. A struct device
1247 * will be created in sysfs, registered to the specified class.
1248 *
1249 * A "dev" file will be created, showing the dev_t for the device, if
1250 * the dev_t is not 0,0.
1251 * If a pointer to a parent struct device is passed in, the newly created
1252 * struct device will be a child of that device in sysfs.
1253 * The pointer to the struct device will be returned from the call.
1254 * Any further sysfs files that might be required can be created using this
1255 * pointer.
1256 *
1257 * Note: the struct class passed to this function must have previously
1258 * been created with a call to class_create().
1259 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001260struct device *device_create(struct class *class, struct device *parent,
1261 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001262{
1263 va_list vargs;
1264 struct device *dev;
1265
1266 va_start(vargs, fmt);
1267 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1268 va_end(vargs);
1269 return dev;
1270}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07001271EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07001272
Dave Youngcd354492008-01-28 16:56:11 +08001273static int __match_devt(struct device *dev, void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001274{
Dave Youngcd354492008-01-28 16:56:11 +08001275 dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001276
Dave Youngcd354492008-01-28 16:56:11 +08001277 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001278}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001279
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001280/**
1281 * device_destroy - removes a device that was created with device_create()
1282 * @class: pointer to the struct class that this device was registered with
1283 * @devt: the dev_t of the device that was previously registered
1284 *
1285 * This call unregisters and cleans up a device that was created with a
1286 * call to device_create().
1287 */
1288void device_destroy(struct class *class, dev_t devt)
1289{
1290 struct device *dev;
1291
Dave Youngcd354492008-01-28 16:56:11 +08001292 dev = class_find_device(class, &devt, __match_devt);
1293 if (dev) {
1294 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001295 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08001296 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001297}
1298EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001299
1300/**
1301 * device_rename - renames a device
1302 * @dev: the pointer to the struct device to be renamed
1303 * @new_name: the new name of the device
1304 */
1305int device_rename(struct device *dev, char *new_name)
1306{
1307 char *old_class_name = NULL;
1308 char *new_class_name = NULL;
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001309 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001310 int error;
1311
1312 dev = get_device(dev);
1313 if (!dev)
1314 return -EINVAL;
1315
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001316 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001317 __func__, new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001318
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001319#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001320 if ((dev->class) && (dev->parent))
1321 old_class_name = make_class_name(dev->class->name, &dev->kobj);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001322#endif
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001323
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001324 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1325 if (!old_device_name) {
1326 error = -ENOMEM;
1327 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001328 }
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001329 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001330 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1331
1332 error = kobject_rename(&dev->kobj, new_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001333 if (error) {
1334 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1335 goto out;
1336 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001337
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001338#ifdef CONFIG_SYSFS_DEPRECATED
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001339 if (old_class_name) {
1340 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1341 if (new_class_name) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001342 error = sysfs_create_link(&dev->parent->kobj,
1343 &dev->kobj, new_class_name);
1344 if (error)
1345 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001346 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1347 }
1348 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001349#else
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001350 if (dev->class) {
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001351 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1352 dev->bus_id);
Stephen Hemminger0599ad52008-05-14 22:34:16 -07001353 if (error)
1354 goto out;
1355 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001356 }
Kay Sievers60b8cab2007-10-26 20:07:44 +02001357#endif
1358
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001359out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001360 put_device(dev);
1361
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001362 kfree(new_class_name);
Jesper Juhl952ab432006-09-28 23:56:01 +02001363 kfree(old_class_name);
Cornelia Huck2ee97caf2007-07-18 01:43:47 -07001364 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07001365
1366 return error;
1367}
Johannes Berga2807db2007-02-28 12:38:31 +01001368EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01001369
1370static int device_move_class_links(struct device *dev,
1371 struct device *old_parent,
1372 struct device *new_parent)
1373{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001374 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001375#ifdef CONFIG_SYSFS_DEPRECATED
Cornelia Huck8a824722006-11-20 17:07:51 +01001376 char *class_name;
1377
1378 class_name = make_class_name(dev->class->name, &dev->kobj);
1379 if (!class_name) {
Cornelia Huckcb360bb2006-11-27 10:35:05 +01001380 error = -ENOMEM;
Cornelia Huck8a824722006-11-20 17:07:51 +01001381 goto out;
1382 }
1383 if (old_parent) {
1384 sysfs_remove_link(&dev->kobj, "device");
1385 sysfs_remove_link(&old_parent->kobj, class_name);
1386 }
Cornelia Huckc744aea2007-01-08 20:16:44 +01001387 if (new_parent) {
1388 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1389 "device");
1390 if (error)
1391 goto out;
1392 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1393 class_name);
1394 if (error)
1395 sysfs_remove_link(&dev->kobj, "device");
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001396 } else
Cornelia Huckc744aea2007-01-08 20:16:44 +01001397 error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01001398out:
1399 kfree(class_name);
1400 return error;
1401#else
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08001402 if (old_parent)
1403 sysfs_remove_link(&dev->kobj, "device");
1404 if (new_parent)
1405 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1406 "device");
1407 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01001408#endif
1409}
1410
1411/**
1412 * device_move - moves a device to a new parent
1413 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aea2007-01-08 20:16:44 +01001414 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +01001415 */
1416int device_move(struct device *dev, struct device *new_parent)
1417{
1418 int error;
1419 struct device *old_parent;
Cornelia Huckc744aea2007-01-08 20:16:44 +01001420 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01001421
1422 dev = get_device(dev);
1423 if (!dev)
1424 return -EINVAL;
1425
Cornelia Huck8a824722006-11-20 17:07:51 +01001426 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001427 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01001428
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -08001429 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
Harvey Harrison2b3a3022008-03-04 16:41:05 -08001430 __func__, new_parent ? new_parent->bus_id : "<NULL>");
Cornelia Huckc744aea2007-01-08 20:16:44 +01001431 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001432 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01001433 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001434 put_device(new_parent);
1435 goto out;
1436 }
1437 old_parent = dev->parent;
1438 dev->parent = new_parent;
1439 if (old_parent)
Cornelia Huckacf02d22006-11-22 17:49:39 +01001440 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001441 if (new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001442 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001443 set_dev_node(dev, dev_to_node(new_parent));
1444 }
1445
Cornelia Huck8a824722006-11-20 17:07:51 +01001446 if (!dev->class)
1447 goto out_put;
1448 error = device_move_class_links(dev, old_parent, new_parent);
1449 if (error) {
1450 /* We ignore errors on cleanup since we're hosed anyway... */
1451 device_move_class_links(dev, new_parent, old_parent);
1452 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
Cornelia Huckc744aea2007-01-08 20:16:44 +01001453 if (new_parent)
1454 klist_remove(&dev->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001455 dev->parent = old_parent;
1456 if (old_parent) {
Cornelia Huck8a824722006-11-20 17:07:51 +01001457 klist_add_tail(&dev->knode_parent,
1458 &old_parent->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08001459 set_dev_node(dev, dev_to_node(old_parent));
1460 }
Cornelia Huck8a824722006-11-20 17:07:51 +01001461 }
Cornelia Huck63b69712008-01-21 16:09:44 +01001462 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01001463 put_device(new_parent);
1464 goto out;
1465 }
1466out_put:
1467 put_device(old_parent);
1468out:
1469 put_device(dev);
1470 return error;
1471}
Cornelia Huck8a824722006-11-20 17:07:51 +01001472EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001473
1474/**
1475 * device_shutdown - call ->shutdown() on each device to shutdown.
1476 */
1477void device_shutdown(void)
1478{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001479 struct device *dev, *devn;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001480
1481 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1482 kobj.entry) {
1483 if (dev->bus && dev->bus->shutdown) {
1484 dev_dbg(dev, "shutdown\n");
1485 dev->bus->shutdown(dev);
1486 } else if (dev->driver && dev->driver->shutdown) {
1487 dev_dbg(dev, "shutdown\n");
1488 dev->driver->shutdown(dev);
1489 }
1490 }
Dan Williamse105b8b2008-04-21 10:51:07 -07001491 kobject_put(sysfs_dev_char_kobj);
1492 kobject_put(sysfs_dev_block_kobj);
1493 kobject_put(dev_kobj);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08001494}