blob: ab8dfc095709674c9afca67152af5c651f1e2d03 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07005 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This file is released under the GPLv2
9 *
10 * See Documentation/driver-model/ for more information.
11 */
12
13#ifndef _DEVICE_H_
14#define _DEVICE_H_
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/ioport.h>
17#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080018#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/list.h>
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -070020#include <linux/lockdep.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070021#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/types.h>
23#include <linux/module.h>
24#include <linux/pm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <asm/atomic.h>
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +110026#include <asm/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028struct device;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080029struct device_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030struct device_driver;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080031struct driver_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct class;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010033struct subsys_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010034struct bus_type;
Grant Likelyd706c1b2010-04-13 16:12:28 -070035struct device_node;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010036
37struct bus_attribute {
38 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080039 ssize_t (*show)(struct bus_type *bus, char *buf);
40 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010041};
42
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080043#define BUS_ATTR(_name, _mode, _show, _store) \
44struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010045
46extern int __must_check bus_create_file(struct bus_type *,
47 struct bus_attribute *);
48extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080051 const char *name;
52 struct bus_attribute *bus_attrs;
53 struct device_attribute *dev_attrs;
54 struct driver_attribute *drv_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080056 int (*match)(struct device *dev, struct device_driver *drv);
57 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
58 int (*probe)(struct device *dev);
59 int (*remove)(struct device *dev);
60 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -070061
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080062 int (*suspend)(struct device *dev, pm_message_t state);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080063 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010064
Dmitry Torokhov8150f322009-07-24 22:11:32 -070065 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020066
Kay Sievers6b6e39a2010-11-15 23:13:18 +010067 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080070extern int __must_check bus_register(struct bus_type *bus);
71extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080073extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Linus Torvalds1da177e2005-04-16 15:20:36 -070075/* iterator helpers for buses */
76
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080077int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
78 int (*fn)(struct device *dev, void *data));
79struct device *bus_find_device(struct bus_type *bus, struct device *start,
80 void *data,
81 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -080082struct device *bus_find_device_by_name(struct bus_type *bus,
83 struct device *start,
84 const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Jean Delvarecc7447a2010-06-16 11:44:18 +020086int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
87 void *data, int (*fn)(struct device_driver *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -050089void bus_sort_breadthfirst(struct bus_type *bus,
90 int (*compare)(const struct device *a,
91 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100092/*
93 * Bus notifiers: Get notified of addition/removal of devices
94 * and binding/unbinding of drivers to devices.
95 * In the long run, it should be a replacement for the platform
96 * notify hooks.
97 */
98struct notifier_block;
99
100extern int bus_register_notifier(struct bus_type *bus,
101 struct notifier_block *nb);
102extern int bus_unregister_notifier(struct bus_type *bus,
103 struct notifier_block *nb);
104
105/* All 4 notifers below get called with the target struct device *
106 * as an argument. Note that those functions are likely to be called
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800107 * with the device lock held in the core, so be careful.
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000108 */
109#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
110#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
Magnus Damm45daef02010-07-23 19:56:18 +0900111#define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
112 bound */
113#define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
114#define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000115 unbound */
Magnus Damm45daef02010-07-23 19:56:18 +0900116#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
Joerg Roedel309b7d62009-04-24 14:57:00 +0200117 from the device */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000118
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700119extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700120extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800123 const char *name;
124 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800126 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700127 const char *mod_name; /* used for built-in modules */
128
129 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Grant Likely597b9d12010-04-13 16:13:01 -0700131 const struct of_device_id *of_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700132
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800133 int (*probe) (struct device *dev);
134 int (*remove) (struct device *dev);
135 void (*shutdown) (struct device *dev);
136 int (*suspend) (struct device *dev, pm_message_t state);
137 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700138 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800139
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700140 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200141
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800142 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143};
144
145
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800146extern int __must_check driver_register(struct device_driver *drv);
147extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800149extern struct device_driver *get_driver(struct device_driver *drv);
150extern void put_driver(struct device_driver *drv);
151extern struct device_driver *driver_find(const char *name,
152 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700153extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800154extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100157/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800160 struct attribute attr;
161 ssize_t (*show)(struct device_driver *driver, char *buf);
162 ssize_t (*store)(struct device_driver *driver, const char *buf,
163 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800166#define DRIVER_ATTR(_name, _mode, _show, _store) \
167struct driver_attribute driver_attr_##_name = \
168 __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800170extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200171 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800172extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200173 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Greg Kroah-Hartmancbe9c592007-12-19 15:54:39 -0400175extern int __must_check driver_add_kobj(struct device_driver *drv,
176 struct kobject *kobj,
177 const char *fmt, ...);
178
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800179extern int __must_check driver_for_each_device(struct device_driver *drv,
180 struct device *start,
181 void *data,
182 int (*fn)(struct device *dev,
183 void *));
184struct device *driver_find_device(struct device_driver *drv,
185 struct device *start, void *data,
186 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/*
189 * device classes
190 */
191struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800192 const char *name;
193 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800195 struct class_attribute *class_attrs;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800196 struct device_attribute *dev_attrs;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000197 struct bin_attribute *dev_bin_attrs;
Dan Williamse105b8b2008-04-21 10:51:07 -0700198 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800200 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sieverse454cea2009-09-18 23:01:12 +0200201 char *(*devnode)(struct device *dev, mode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800203 void (*class_release)(struct class *class);
204 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700205
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800206 int (*suspend)(struct device *dev, pm_message_t state);
207 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200208
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700209 const struct kobj_ns_type_operations *ns_type;
210 const void *(*namespace)(struct device *dev);
211
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700212 const struct dev_pm_ops *pm;
213
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100214 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215};
216
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200217struct class_dev_iter {
218 struct klist_iter ki;
219 const struct device_type *type;
220};
221
Dan Williamse105b8b2008-04-21 10:51:07 -0700222extern struct kobject *sysfs_dev_block_kobj;
223extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700224extern int __must_check __class_register(struct class *class,
225 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800226extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700227
228/* This is a #define to keep the compiler from merging different
229 * instances of the __key variable */
230#define class_register(class) \
231({ \
232 static struct lock_class_key __key; \
233 __class_register(class, &__key); \
234})
235
Jean Delvare46227092009-08-04 12:55:34 +0200236struct class_compat;
237struct class_compat *class_compat_register(const char *name);
238void class_compat_unregister(struct class_compat *cls);
239int class_compat_create_link(struct class_compat *cls, struct device *dev,
240 struct device *device_link);
241void class_compat_remove_link(struct class_compat *cls, struct device *dev,
242 struct device *device_link);
243
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200244extern void class_dev_iter_init(struct class_dev_iter *iter,
245 struct class *class,
246 struct device *start,
247 const struct device_type *type);
248extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
249extern void class_dev_iter_exit(struct class_dev_iter *iter);
250
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400251extern int class_for_each_device(struct class *class, struct device *start,
252 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800253 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400254extern struct device *class_find_device(struct class *class,
255 struct device *start, void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800256 int (*match)(struct device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800259 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100260 ssize_t (*show)(struct class *class, struct class_attribute *attr,
261 char *buf);
262 ssize_t (*store)(struct class *class, struct class_attribute *attr,
263 const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264};
265
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800266#define CLASS_ATTR(_name, _mode, _show, _store) \
267struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800269extern int __must_check class_create_file(struct class *class,
270 const struct class_attribute *attr);
271extern void class_remove_file(struct class *class,
272 const struct class_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Andi Kleen869dfc82010-01-05 12:48:08 +0100274/* Simple class attribute that is just a static string */
275
276struct class_attribute_string {
277 struct class_attribute attr;
278 char *str;
279};
280
281/* Currently read-only only */
282#define _CLASS_ATTR_STRING(_name, _mode, _str) \
283 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
284#define CLASS_ATTR_STRING(_name, _mode, _str) \
285 struct class_attribute_string class_attr_##_name = \
286 _CLASS_ATTR_STRING(_name, _mode, _str)
287
288extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
289 char *buf);
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291struct class_interface {
292 struct list_head node;
293 struct class *class;
294
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200295 int (*add_dev) (struct device *, struct class_interface *);
296 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297};
298
Andrew Morton4a7fb632006-08-14 22:43:17 -0700299extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300extern void class_interface_unregister(struct class_interface *);
301
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700302extern struct class * __must_check __class_create(struct module *owner,
303 const char *name,
304 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800305extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800306
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700307/* This is a #define to keep the compiler from merging different
308 * instances of the __key variable */
309#define class_create(owner, name) \
310({ \
311 static struct lock_class_key __key; \
312 __class_create(owner, name, &__key); \
313})
314
Kay Sievers414264f2007-03-12 21:08:57 +0100315/*
316 * The type of device, "struct device" is embedded in. A class
317 * or bus can contain devices of different types
318 * like "partitions" and "disks", "mouse" and "event".
319 * This identifies the device type and carries type-specific
320 * information, equivalent to the kobj_type of a kobject.
321 * If "name" is specified, the uevent will contain it in
322 * the DEVTYPE variable.
323 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200324struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100325 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700326 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200327 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sieverse454cea2009-09-18 23:01:12 +0200328 char *(*devnode)(struct device *dev, mode_t *mode);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200329 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200330
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700331 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200332};
333
Kay Sieversa7fd6702005-10-01 14:49:43 +0200334/* interface for exporting device attributes */
335struct device_attribute {
336 struct attribute attr;
337 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
338 char *buf);
339 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
340 const char *buf, size_t count);
341};
342
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800343#define DEVICE_ATTR(_name, _mode, _show, _store) \
344struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200345
Andrew Morton4a7fb632006-08-14 22:43:17 -0700346extern int __must_check device_create_file(struct device *device,
Phil Carmody66ecb922009-12-18 15:34:20 +0200347 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800348extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200349 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700350extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200351 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700352extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200353 const struct bin_attribute *attr);
Alan Stern523ded72007-04-26 00:12:04 -0700354extern int device_schedule_callback_owner(struct device *dev,
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800355 void (*func)(struct device *dev), struct module *owner);
Alan Stern523ded72007-04-26 00:12:04 -0700356
357/* This is a macro to avoid include problems with THIS_MODULE */
358#define device_schedule_callback(dev, func) \
359 device_schedule_callback_owner(dev, func, THIS_MODULE)
Tejun Heo9ac78492007-01-20 16:00:26 +0900360
361/* device resource management */
362typedef void (*dr_release_t)(struct device *dev, void *res);
363typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
364
365#ifdef CONFIG_DEBUG_DEVRES
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800366extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
Tejun Heo9ac78492007-01-20 16:00:26 +0900367 const char *name);
368#define devres_alloc(release, size, gfp) \
369 __devres_alloc(release, size, gfp, #release)
370#else
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800371extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900372#endif
373extern void devres_free(void *res);
374extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800375extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900376 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800377extern void *devres_get(struct device *dev, void *new_res,
378 dr_match_t match, void *match_data);
379extern void *devres_remove(struct device *dev, dr_release_t release,
380 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900381extern int devres_destroy(struct device *dev, dr_release_t release,
382 dr_match_t match, void *match_data);
383
384/* devres group */
385extern void * __must_check devres_open_group(struct device *dev, void *id,
386 gfp_t gfp);
387extern void devres_close_group(struct device *dev, void *id);
388extern void devres_remove_group(struct device *dev, void *id);
389extern int devres_release_group(struct device *dev, void *id);
390
391/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
392extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
393extern void devm_kfree(struct device *dev, void *p);
394
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800395struct device_dma_parameters {
396 /*
397 * a low level driver may set these to teach IOMMU code about
398 * sg limitations.
399 */
400 unsigned int max_segment_size;
401 unsigned long segment_boundary_mask;
402};
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700405 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800407 struct device_private *p;
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700410 const char *init_name; /* initial name of the device */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200411 struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Thomas Gleixner31427882010-01-29 20:39:02 +0000413 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800414 * its driver.
415 */
416
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800417 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 struct device_driver *driver; /* which driver has allocated this
419 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800420 void *platform_data; /* Platform specific data, device
421 core doesn't touch it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 struct dev_pm_info power;
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +0100423 struct dev_power_domain *pwr_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Christoph Hellwig87348132006-12-06 20:32:33 -0800425#ifdef CONFIG_NUMA
426 int numa_node; /* NUMA node this device is close to */
427#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 u64 *dma_mask; /* dma mask (if dma'able device) */
429 u64 coherent_dma_mask;/* Like dma_mask, but for
430 alloc_coherent mappings as
431 not all hardware supports
432 64 bit addresses for consistent
433 allocations such descriptors. */
434
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800435 struct device_dma_parameters *dma_parms;
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct list_head dma_pools; /* dma pools (if dma'ble) */
438
439 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
440 override */
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100441 /* arch specific additions */
442 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700443
444 struct device_node *of_node; /* associated device tree node */
Grant Likelyb8262912011-02-17 02:37:15 -0700445 const struct of_device_id *of_match; /* matching of_device_id from driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600447 dev_t devt; /* dev_t, creates the sysfs "dev" */
448
Tejun Heo9ac78492007-01-20 16:00:26 +0900449 spinlock_t devres_lock;
450 struct list_head devres_head;
451
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200452 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200453 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700454 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700455
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800456 void (*release)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457};
458
Alan Stern9a3df1f2008-03-19 22:39:13 +0100459/* Get the wakeup routines, which depend on struct device */
460#include <linux/pm_wakeup.h>
461
Jean Delvarebf9ca692008-07-30 12:29:21 -0700462static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200463{
Paul Mundta636ee72010-03-09 06:57:53 +0000464 /* Use the init name until the kobject becomes available */
465 if (dev->init_name)
466 return dev->init_name;
467
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100468 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200469}
470
Stephen Rothwell413c2392008-05-30 10:16:40 +1000471extern int dev_set_name(struct device *dev, const char *name, ...)
472 __attribute__((format(printf, 2, 3)));
473
Christoph Hellwig87348132006-12-06 20:32:33 -0800474#ifdef CONFIG_NUMA
475static inline int dev_to_node(struct device *dev)
476{
477 return dev->numa_node;
478}
479static inline void set_dev_node(struct device *dev, int node)
480{
481 dev->numa_node = node;
482}
483#else
484static inline int dev_to_node(struct device *dev)
485{
486 return -1;
487}
488static inline void set_dev_node(struct device *dev, int node)
489{
490}
491#endif
492
Ming Leif67f1292009-03-01 21:10:49 +0800493static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
494{
495 return dev->kobj.uevent_suppress;
496}
497
498static inline void dev_set_uevent_suppress(struct device *dev, int val)
499{
500 dev->kobj.uevent_suppress = val;
501}
502
Daniel Ritzd305ef52005-09-22 00:47:24 -0700503static inline int device_is_registered(struct device *dev)
504{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400505 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700506}
507
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100508static inline void device_enable_async_suspend(struct device *dev)
509{
Rafael J. Wysockib8c76f62010-12-16 00:51:21 +0100510 if (!dev->power.in_suspend)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100511 dev->power.async_suspend = true;
512}
513
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100514static inline void device_disable_async_suspend(struct device *dev)
515{
Rafael J. Wysockib8c76f62010-12-16 00:51:21 +0100516 if (!dev->power.in_suspend)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100517 dev->power.async_suspend = false;
518}
519
520static inline bool device_async_suspend_enabled(struct device *dev)
521{
522 return !!dev->power.async_suspend;
523}
524
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800525static inline void device_lock(struct device *dev)
526{
Thomas Gleixner31427882010-01-29 20:39:02 +0000527 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800528}
529
530static inline int device_trylock(struct device *dev)
531{
Thomas Gleixner31427882010-01-29 20:39:02 +0000532 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800533}
534
535static inline void device_unlock(struct device *dev)
536{
Thomas Gleixner31427882010-01-29 20:39:02 +0000537 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800538}
539
Adrian Bunk1f217822006-12-19 13:01:28 -0800540void driver_init(void);
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542/*
543 * High level routines for use by the bus drivers
544 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800545extern int __must_check device_register(struct device *dev);
546extern void device_unregister(struct device *dev);
547extern void device_initialize(struct device *dev);
548extern int __must_check device_add(struct device *dev);
549extern void device_del(struct device *dev);
550extern int device_for_each_child(struct device *dev, void *data,
551 int (*fn)(struct device *dev, void *data));
552extern struct device *device_find_child(struct device *dev, void *data,
553 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +0200554extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +0100555extern int device_move(struct device *dev, struct device *new_parent,
556 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +0200557extern const char *device_get_devnode(struct device *dev,
558 mode_t *mode, const char **tmp);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700559extern void *dev_get_drvdata(const struct device *dev);
560extern void dev_set_drvdata(struct device *dev, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
562/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000563 * Root device objects for grouping under /sys/devices
564 */
565extern struct device *__root_device_register(const char *name,
566 struct module *owner);
567static inline struct device *root_device_register(const char *name)
568{
569 return __root_device_register(name, THIS_MODULE);
570}
571extern void root_device_unregister(struct device *root);
572
Mark Browna5b8b1a2009-07-17 15:06:08 +0100573static inline void *dev_get_platdata(const struct device *dev)
574{
575 return dev->platform_data;
576}
577
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000578/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 * Manual binding of a device to driver. See drivers/base/bus.c
580 * for information on use.
581 */
Andrew Mortonf86db392006-08-14 22:43:20 -0700582extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800583extern void device_release_driver(struct device *dev);
584extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -0700585extern int __must_check driver_attach(struct device_driver *drv);
586extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700588/*
589 * Easy functions for dynamically creating devices on the fly
590 */
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700591extern struct device *device_create_vargs(struct class *cls,
592 struct device *parent,
593 dev_t devt,
594 void *drvdata,
595 const char *fmt,
596 va_list vargs);
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -0700597extern struct device *device_create(struct class *cls, struct device *parent,
598 dev_t devt, void *drvdata,
599 const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700600 __attribute__((format(printf, 5, 6)));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700601extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603/*
604 * Platform "fixup" functions - allow the platform to have their say
605 * about devices and actions that the general device layer doesn't
606 * know about.
607 */
608/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800609extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800611extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613
614/**
615 * get_device - atomically increment the reference count for the device.
616 *
617 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800618extern struct device *get_device(struct device *dev);
619extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Arjan van de Vend4d52912009-04-21 13:32:54 -0700621extern void wait_for_device_probe(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Kay Sievers2b2af542009-04-30 15:23:42 +0200623#ifdef CONFIG_DEVTMPFS
624extern int devtmpfs_create_node(struct device *dev);
625extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +0100626extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +0200627#else
628static inline int devtmpfs_create_node(struct device *dev) { return 0; }
629static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
630static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
631#endif
632
Rytchkov Alexey116f2322006-03-22 00:58:53 +0100633/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634extern void device_shutdown(void);
635
Rafael J. Wysockid47d81c2011-03-23 22:16:41 +0100636#ifndef CONFIG_ARCH_NO_SYSDEV_OPS
Rafael J. Wysocki58b3b712007-07-26 16:29:55 +0200637/* drivers/base/sys.c */
638extern void sysdev_shutdown(void);
Rafael J. Wysockid47d81c2011-03-23 22:16:41 +0100639#else
640static inline void sysdev_shutdown(void) { }
641#endif
Rafael J. Wysocki58b3b712007-07-26 16:29:55 +0200642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -0700644extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Joe Perches99bcf212010-06-27 01:02:34 +0000646
647#ifdef CONFIG_PRINTK
648
649extern int dev_printk(const char *level, const struct device *dev,
650 const char *fmt, ...)
651 __attribute__ ((format (printf, 3, 4)));
652extern int dev_emerg(const struct device *dev, const char *fmt, ...)
653 __attribute__ ((format (printf, 2, 3)));
654extern int dev_alert(const struct device *dev, const char *fmt, ...)
655 __attribute__ ((format (printf, 2, 3)));
656extern int dev_crit(const struct device *dev, const char *fmt, ...)
657 __attribute__ ((format (printf, 2, 3)));
658extern int dev_err(const struct device *dev, const char *fmt, ...)
659 __attribute__ ((format (printf, 2, 3)));
660extern int dev_warn(const struct device *dev, const char *fmt, ...)
661 __attribute__ ((format (printf, 2, 3)));
662extern int dev_notice(const struct device *dev, const char *fmt, ...)
663 __attribute__ ((format (printf, 2, 3)));
664extern int _dev_info(const struct device *dev, const char *fmt, ...)
665 __attribute__ ((format (printf, 2, 3)));
666
667#else
668
669static inline int dev_printk(const char *level, const struct device *dev,
670 const char *fmt, ...)
671 __attribute__ ((format (printf, 3, 4)));
672static inline int dev_printk(const char *level, const struct device *dev,
673 const char *fmt, ...)
674 { return 0; }
675
676static inline int dev_emerg(const struct device *dev, const char *fmt, ...)
677 __attribute__ ((format (printf, 2, 3)));
678static inline int dev_emerg(const struct device *dev, const char *fmt, ...)
679 { return 0; }
680static inline int dev_crit(const struct device *dev, const char *fmt, ...)
681 __attribute__ ((format (printf, 2, 3)));
682static inline int dev_crit(const struct device *dev, const char *fmt, ...)
683 { return 0; }
684static inline int dev_alert(const struct device *dev, const char *fmt, ...)
685 __attribute__ ((format (printf, 2, 3)));
686static inline int dev_alert(const struct device *dev, const char *fmt, ...)
687 { return 0; }
688static inline int dev_err(const struct device *dev, const char *fmt, ...)
689 __attribute__ ((format (printf, 2, 3)));
690static inline int dev_err(const struct device *dev, const char *fmt, ...)
691 { return 0; }
692static inline int dev_warn(const struct device *dev, const char *fmt, ...)
693 __attribute__ ((format (printf, 2, 3)));
694static inline int dev_warn(const struct device *dev, const char *fmt, ...)
695 { return 0; }
696static inline int dev_notice(const struct device *dev, const char *fmt, ...)
697 __attribute__ ((format (printf, 2, 3)));
698static inline int dev_notice(const struct device *dev, const char *fmt, ...)
699 { return 0; }
700static inline int _dev_info(const struct device *dev, const char *fmt, ...)
701 __attribute__ ((format (printf, 2, 3)));
702static inline int _dev_info(const struct device *dev, const char *fmt, ...)
703 { return 0; }
704
705#endif
706
707/*
708 * Stupid hackaround for existing uses of non-printk uses dev_info
709 *
710 * Note that the definition of dev_info below is actually _dev_info
711 * and a macro is used to avoid redefining dev_info
712 */
713
714#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -0500715
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100716#if defined(DEBUG)
717#define dev_dbg(dev, format, arg...) \
Joe Perches99bcf212010-06-27 01:02:34 +0000718 dev_printk(KERN_DEBUG, dev, format, ##arg)
Jason Barone9d376f2009-02-05 11:51:38 -0500719#elif defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +0000720#define dev_dbg(dev, format, ...) \
721do { \
Jason Baron346e15b2008-08-12 16:46:19 -0400722 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +0000723} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724#else
Joe Perches99bcf212010-06-27 01:02:34 +0000725#define dev_dbg(dev, format, arg...) \
726({ \
727 if (0) \
728 dev_printk(KERN_DEBUG, dev, format, ##arg); \
729 0; \
730})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731#endif
732
David Brownellaebdc3b2007-07-12 22:08:22 -0700733#ifdef VERBOSE_DEBUG
734#define dev_vdbg dev_dbg
735#else
Joe Perches99bcf212010-06-27 01:02:34 +0000736#define dev_vdbg(dev, format, arg...) \
737({ \
738 if (0) \
739 dev_printk(KERN_DEBUG, dev, format, ##arg); \
740 0; \
741})
David Brownellaebdc3b2007-07-12 22:08:22 -0700742#endif
743
Arjan van de Vene6139662008-09-20 19:08:39 -0700744/*
745 * dev_WARN() acts like dev_printk(), but with the key difference
746 * of using a WARN/WARN_ON to get the message out, including the
747 * file/line information and a backtrace.
748 */
749#define dev_WARN(dev, format, arg...) \
750 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
751
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752/* Create alias, so I can be autoloaded. */
753#define MODULE_ALIAS_CHARDEV(major,minor) \
754 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
755#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
756 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +0200757
758#ifdef CONFIG_SYSFS_DEPRECATED
759extern long sysfs_deprecated;
760#else
761#define sysfs_deprecated 0
762#endif
763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764#endif /* _DEVICE_H_ */