blob: 6a69caaac18a8f18fcbdc60c2f5e686ff95922c8 [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-Hartman89790fd2007-02-12 22:33:06 -08005 * Copyright (c) 2004-2007 Greg Kroah-Hartman <gregkh@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
7 * This file is released under the GPLv2
8 *
9 * See Documentation/driver-model/ for more information.
10 */
11
12#ifndef _DEVICE_H_
13#define _DEVICE_H_
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/ioport.h>
16#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080017#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/list.h>
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -070019#include <linux/lockdep.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070020#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/types.h>
22#include <linux/module.h>
23#include <linux/pm.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040024#include <linux/semaphore.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
Kay Sieversaab0de22008-05-02 06:02:41 +020028#define BUS_ID_SIZE 20
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030struct device;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080031struct device_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct device_driver;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080033struct driver_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034struct class;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -050035struct class_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010036struct bus_type;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070037struct bus_type_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010038
39struct bus_attribute {
40 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080041 ssize_t (*show)(struct bus_type *bus, char *buf);
42 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010043};
44
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080045#define BUS_ATTR(_name, _mode, _show, _store) \
46struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010047
48extern int __must_check bus_create_file(struct bus_type *,
49 struct bus_attribute *);
50extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080053 const char *name;
54 struct bus_attribute *bus_attrs;
55 struct device_attribute *dev_attrs;
56 struct driver_attribute *drv_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080058 int (*match)(struct device *dev, struct device_driver *drv);
59 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
60 int (*probe)(struct device *dev);
61 int (*remove)(struct device *dev);
62 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -070063
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080064 int (*suspend)(struct device *dev, pm_message_t state);
65 int (*suspend_late)(struct device *dev, pm_message_t state);
66 int (*resume_early)(struct device *dev);
67 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010068
Rafael J. Wysockiadf09492008-10-06 22:46:05 +020069 struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020070
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070071 struct bus_type_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080074extern int __must_check bus_register(struct bus_type *bus);
75extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080077extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Linus Torvalds1da177e2005-04-16 15:20:36 -070079/* iterator helpers for buses */
80
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080081int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
82 int (*fn)(struct device *dev, void *data));
83struct device *bus_find_device(struct bus_type *bus, struct device *start,
84 void *data,
85 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -080086struct device *bus_find_device_by_name(struct bus_type *bus,
87 struct device *start,
88 const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Andrew Morton4a7fb632006-08-14 22:43:17 -070090int __must_check bus_for_each_drv(struct bus_type *bus,
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080091 struct device_driver *start, void *data,
92 int (*fn)(struct device_driver *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -050094void bus_sort_breadthfirst(struct bus_type *bus,
95 int (*compare)(const struct device *a,
96 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100097/*
98 * Bus notifiers: Get notified of addition/removal of devices
99 * and binding/unbinding of drivers to devices.
100 * In the long run, it should be a replacement for the platform
101 * notify hooks.
102 */
103struct notifier_block;
104
105extern int bus_register_notifier(struct bus_type *bus,
106 struct notifier_block *nb);
107extern int bus_unregister_notifier(struct bus_type *bus,
108 struct notifier_block *nb);
109
110/* All 4 notifers below get called with the target struct device *
111 * as an argument. Note that those functions are likely to be called
112 * with the device semaphore held in the core, so be careful.
113 */
114#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
115#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
116#define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
117#define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
118 unbound */
119
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700120extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700121extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800124 const char *name;
125 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800127 struct module *owner;
128 const char *mod_name; /* used for built-in modules */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800130 int (*probe) (struct device *dev);
131 int (*remove) (struct device *dev);
132 void (*shutdown) (struct device *dev);
133 int (*suspend) (struct device *dev, pm_message_t state);
134 int (*resume) (struct device *dev);
Cornelia Huck57c74532007-12-05 12:50:23 +0100135 struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800136
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200137 struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200138
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800139 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
142
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800143extern int __must_check driver_register(struct device_driver *drv);
144extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800146extern struct device_driver *get_driver(struct device_driver *drv);
147extern void put_driver(struct device_driver *drv);
148extern struct device_driver *driver_find(const char *name,
149 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700150extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800151extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100154/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800157 struct attribute attr;
158 ssize_t (*show)(struct device_driver *driver, char *buf);
159 ssize_t (*store)(struct device_driver *driver, const char *buf,
160 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161};
162
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800163#define DRIVER_ATTR(_name, _mode, _show, _store) \
164struct driver_attribute driver_attr_##_name = \
165 __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800167extern int __must_check driver_create_file(struct device_driver *driver,
168 struct driver_attribute *attr);
169extern void driver_remove_file(struct device_driver *driver,
170 struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Greg Kroah-Hartmancbe9c592007-12-19 15:54:39 -0400172extern int __must_check driver_add_kobj(struct device_driver *drv,
173 struct kobject *kobj,
174 const char *fmt, ...);
175
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800176extern int __must_check driver_for_each_device(struct device_driver *drv,
177 struct device *start,
178 void *data,
179 int (*fn)(struct device *dev,
180 void *));
181struct device *driver_find_device(struct device_driver *drv,
182 struct device *start, void *data,
183 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/*
186 * device classes
187 */
188struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800189 const char *name;
190 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800192 struct class_attribute *class_attrs;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800193 struct device_attribute *dev_attrs;
Dan Williamse105b8b2008-04-21 10:51:07 -0700194 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800196 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800198 void (*class_release)(struct class *class);
199 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700200
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800201 int (*suspend)(struct device *dev, pm_message_t state);
202 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200203
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200204 struct dev_pm_ops *pm;
Greg Kroah-Hartman7c714482008-01-22 18:17:41 -0500205 struct class_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206};
207
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200208struct class_dev_iter {
209 struct klist_iter ki;
210 const struct device_type *type;
211};
212
Dan Williamse105b8b2008-04-21 10:51:07 -0700213extern struct kobject *sysfs_dev_block_kobj;
214extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700215extern int __must_check __class_register(struct class *class,
216 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800217extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700218
219/* This is a #define to keep the compiler from merging different
220 * instances of the __key variable */
221#define class_register(class) \
222({ \
223 static struct lock_class_key __key; \
224 __class_register(class, &__key); \
225})
226
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200227extern void class_dev_iter_init(struct class_dev_iter *iter,
228 struct class *class,
229 struct device *start,
230 const struct device_type *type);
231extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
232extern void class_dev_iter_exit(struct class_dev_iter *iter);
233
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400234extern int class_for_each_device(struct class *class, struct device *start,
235 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800236 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400237extern struct device *class_find_device(struct class *class,
238 struct device *start, void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800239 int (*match)(struct device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800242 struct attribute attr;
243 ssize_t (*show)(struct class *class, char *buf);
244 ssize_t (*store)(struct class *class, const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245};
246
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800247#define CLASS_ATTR(_name, _mode, _show, _store) \
248struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800250extern int __must_check class_create_file(struct class *class,
251 const struct class_attribute *attr);
252extern void class_remove_file(struct class *class,
253 const struct class_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255struct class_interface {
256 struct list_head node;
257 struct class *class;
258
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200259 int (*add_dev) (struct device *, struct class_interface *);
260 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261};
262
Andrew Morton4a7fb632006-08-14 22:43:17 -0700263extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264extern void class_interface_unregister(struct class_interface *);
265
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700266extern struct class * __must_check __class_create(struct module *owner,
267 const char *name,
268 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800269extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800270
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700271/* This is a #define to keep the compiler from merging different
272 * instances of the __key variable */
273#define class_create(owner, name) \
274({ \
275 static struct lock_class_key __key; \
276 __class_create(owner, name, &__key); \
277})
278
Kay Sievers414264f2007-03-12 21:08:57 +0100279/*
280 * The type of device, "struct device" is embedded in. A class
281 * or bus can contain devices of different types
282 * like "partitions" and "disks", "mouse" and "event".
283 * This identifies the device type and carries type-specific
284 * information, equivalent to the kobj_type of a kobject.
285 * If "name" is specified, the uevent will contain it in
286 * the DEVTYPE variable.
287 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200288struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100289 const char *name;
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500290 struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200291 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200292 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200293
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800294 int (*suspend)(struct device *dev, pm_message_t state);
295 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200296
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200297 struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200298};
299
Kay Sieversa7fd6702005-10-01 14:49:43 +0200300/* interface for exporting device attributes */
301struct device_attribute {
302 struct attribute attr;
303 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
304 char *buf);
305 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
306 const char *buf, size_t count);
307};
308
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800309#define DEVICE_ATTR(_name, _mode, _show, _store) \
310struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200311
Andrew Morton4a7fb632006-08-14 22:43:17 -0700312extern int __must_check device_create_file(struct device *device,
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800313 struct device_attribute *entry);
314extern void device_remove_file(struct device *dev,
315 struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700316extern int __must_check device_create_bin_file(struct device *dev,
317 struct bin_attribute *attr);
318extern void device_remove_bin_file(struct device *dev,
319 struct bin_attribute *attr);
Alan Stern523ded72007-04-26 00:12:04 -0700320extern int device_schedule_callback_owner(struct device *dev,
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800321 void (*func)(struct device *dev), struct module *owner);
Alan Stern523ded72007-04-26 00:12:04 -0700322
323/* This is a macro to avoid include problems with THIS_MODULE */
324#define device_schedule_callback(dev, func) \
325 device_schedule_callback_owner(dev, func, THIS_MODULE)
Tejun Heo9ac78492007-01-20 16:00:26 +0900326
327/* device resource management */
328typedef void (*dr_release_t)(struct device *dev, void *res);
329typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
330
331#ifdef CONFIG_DEBUG_DEVRES
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800332extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
Tejun Heo9ac78492007-01-20 16:00:26 +0900333 const char *name);
334#define devres_alloc(release, size, gfp) \
335 __devres_alloc(release, size, gfp, #release)
336#else
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800337extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900338#endif
339extern void devres_free(void *res);
340extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800341extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900342 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800343extern void *devres_get(struct device *dev, void *new_res,
344 dr_match_t match, void *match_data);
345extern void *devres_remove(struct device *dev, dr_release_t release,
346 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900347extern int devres_destroy(struct device *dev, dr_release_t release,
348 dr_match_t match, void *match_data);
349
350/* devres group */
351extern void * __must_check devres_open_group(struct device *dev, void *id,
352 gfp_t gfp);
353extern void devres_close_group(struct device *dev, void *id);
354extern void devres_remove_group(struct device *dev, void *id);
355extern int devres_release_group(struct device *dev, void *id);
356
357/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
358extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
359extern void devm_kfree(struct device *dev, void *p);
360
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800361struct device_dma_parameters {
362 /*
363 * a low level driver may set these to teach IOMMU code about
364 * sg limitations.
365 */
366 unsigned int max_segment_size;
367 unsigned long segment_boundary_mask;
368};
369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700371 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800373 struct device_private *p;
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700376 const char *init_name; /* initial name of the device */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200377 struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800379 struct semaphore sem; /* semaphore to synchronize calls to
380 * its driver.
381 */
382
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800383 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 struct device_driver *driver; /* which driver has allocated this
385 device */
386 void *driver_data; /* data private to the driver */
Ming Lei006f4572009-03-08 23:13:32 +0800387
388 void *platform_data; /* We will remove platform_data
389 field if all platform devices
390 pass its platform specific data
391 from platform_device->platform_data,
392 other kind of devices should not
393 use platform_data. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 struct dev_pm_info power;
395
Christoph Hellwig87348132006-12-06 20:32:33 -0800396#ifdef CONFIG_NUMA
397 int numa_node; /* NUMA node this device is close to */
398#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 u64 *dma_mask; /* dma mask (if dma'able device) */
400 u64 coherent_dma_mask;/* Like dma_mask, but for
401 alloc_coherent mappings as
402 not all hardware supports
403 64 bit addresses for consistent
404 allocations such descriptors. */
405
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800406 struct device_dma_parameters *dma_parms;
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 struct list_head dma_pools; /* dma pools (if dma'ble) */
409
410 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
411 override */
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100412 /* arch specific additions */
413 struct dev_archdata archdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600415 dev_t devt; /* dev_t, creates the sysfs "dev" */
416
Tejun Heo9ac78492007-01-20 16:00:26 +0900417 spinlock_t devres_lock;
418 struct list_head devres_head;
419
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200420 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200421 struct class *class;
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700422 struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700423
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800424 void (*release)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426
Alan Stern9a3df1f2008-03-19 22:39:13 +0100427/* Get the wakeup routines, which depend on struct device */
428#include <linux/pm_wakeup.h>
429
Jean Delvarebf9ca692008-07-30 12:29:21 -0700430static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200431{
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100432 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200433}
434
Stephen Rothwell413c2392008-05-30 10:16:40 +1000435extern int dev_set_name(struct device *dev, const char *name, ...)
436 __attribute__((format(printf, 2, 3)));
437
Christoph Hellwig87348132006-12-06 20:32:33 -0800438#ifdef CONFIG_NUMA
439static inline int dev_to_node(struct device *dev)
440{
441 return dev->numa_node;
442}
443static inline void set_dev_node(struct device *dev, int node)
444{
445 dev->numa_node = node;
446}
447#else
448static inline int dev_to_node(struct device *dev)
449{
450 return -1;
451}
452static inline void set_dev_node(struct device *dev, int node)
453{
454}
455#endif
456
Jean Delvare7d1d8992008-10-22 20:21:31 +0200457static inline void *dev_get_drvdata(const struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458{
459 return dev->driver_data;
460}
461
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800462static inline void dev_set_drvdata(struct device *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
464 dev->driver_data = data;
465}
466
Ming Leif67f1292009-03-01 21:10:49 +0800467static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
468{
469 return dev->kobj.uevent_suppress;
470}
471
472static inline void dev_set_uevent_suppress(struct device *dev, int val)
473{
474 dev->kobj.uevent_suppress = val;
475}
476
Daniel Ritzd305ef52005-09-22 00:47:24 -0700477static inline int device_is_registered(struct device *dev)
478{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400479 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700480}
481
Adrian Bunk1f217822006-12-19 13:01:28 -0800482void driver_init(void);
483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484/*
485 * High level routines for use by the bus drivers
486 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800487extern int __must_check device_register(struct device *dev);
488extern void device_unregister(struct device *dev);
489extern void device_initialize(struct device *dev);
490extern int __must_check device_add(struct device *dev);
491extern void device_del(struct device *dev);
492extern int device_for_each_child(struct device *dev, void *data,
493 int (*fn)(struct device *dev, void *data));
494extern struct device *device_find_child(struct device *dev, void *data,
495 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -0700496extern int device_rename(struct device *dev, char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +0100497extern int device_move(struct device *dev, struct device *new_parent,
498 enum dpm_order dpm_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000501 * Root device objects for grouping under /sys/devices
502 */
503extern struct device *__root_device_register(const char *name,
504 struct module *owner);
505static inline struct device *root_device_register(const char *name)
506{
507 return __root_device_register(name, THIS_MODULE);
508}
509extern void root_device_unregister(struct device *root);
510
511/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 * Manual binding of a device to driver. See drivers/base/bus.c
513 * for information on use.
514 */
Andrew Mortonf86db392006-08-14 22:43:20 -0700515extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800516extern void device_release_driver(struct device *dev);
517extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -0700518extern int __must_check driver_attach(struct device_driver *drv);
519extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700521/*
522 * Easy functions for dynamically creating devices on the fly
523 */
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700524extern struct device *device_create_vargs(struct class *cls,
525 struct device *parent,
526 dev_t devt,
527 void *drvdata,
528 const char *fmt,
529 va_list vargs);
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -0700530extern struct device *device_create(struct class *cls, struct device *parent,
531 dev_t devt, void *drvdata,
532 const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700533 __attribute__((format(printf, 5, 6)));
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700534extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536/*
537 * Platform "fixup" functions - allow the platform to have their say
538 * about devices and actions that the general device layer doesn't
539 * know about.
540 */
541/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800542extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800544extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546
547/**
548 * get_device - atomically increment the reference count for the device.
549 *
550 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800551extern struct device *get_device(struct device *dev);
552extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Arjan van de Vend4d52912009-04-21 13:32:54 -0700554extern void wait_for_device_probe(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Rytchkov Alexey116f232b2006-03-22 00:58:53 +0100556/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557extern void device_shutdown(void);
558
Rafael J. Wysocki58b3b712007-07-26 16:29:55 +0200559/* drivers/base/sys.c */
560extern void sysdev_shutdown(void);
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -0700563extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564#define dev_printk(level, dev, format, arg...) \
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800565 printk(level "%s %s: " format , dev_driver_string(dev) , \
Kay Sievers06916632008-05-02 06:02:41 +0200566 dev_name(dev) , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Emil Medve7b8712e2007-10-30 14:37:14 -0500568#define dev_emerg(dev, format, arg...) \
569 dev_printk(KERN_EMERG , dev , format , ## arg)
570#define dev_alert(dev, format, arg...) \
571 dev_printk(KERN_ALERT , dev , format , ## arg)
572#define dev_crit(dev, format, arg...) \
573 dev_printk(KERN_CRIT , dev , format , ## arg)
574#define dev_err(dev, format, arg...) \
575 dev_printk(KERN_ERR , dev , format , ## arg)
576#define dev_warn(dev, format, arg...) \
577 dev_printk(KERN_WARNING , dev , format , ## arg)
578#define dev_notice(dev, format, arg...) \
579 dev_printk(KERN_NOTICE , dev , format , ## arg)
580#define dev_info(dev, format, arg...) \
581 dev_printk(KERN_INFO , dev , format , ## arg)
582
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100583#if defined(DEBUG)
584#define dev_dbg(dev, format, arg...) \
585 dev_printk(KERN_DEBUG , dev , format , ## arg)
Jason Barone9d376f2009-02-05 11:51:38 -0500586#elif defined(CONFIG_DYNAMIC_DEBUG)
Jason Baron346e15b2008-08-12 16:46:19 -0400587#define dev_dbg(dev, format, ...) do { \
588 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
589 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590#else
Joe Perches1429db82008-02-26 19:08:42 -0800591#define dev_dbg(dev, format, arg...) \
592 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#endif
594
David Brownellaebdc3b2007-07-12 22:08:22 -0700595#ifdef VERBOSE_DEBUG
596#define dev_vdbg dev_dbg
597#else
Joe Perches1429db82008-02-26 19:08:42 -0800598
599#define dev_vdbg(dev, format, arg...) \
600 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
David Brownellaebdc3b2007-07-12 22:08:22 -0700601#endif
602
Arjan van de Vene6139662008-09-20 19:08:39 -0700603/*
604 * dev_WARN() acts like dev_printk(), but with the key difference
605 * of using a WARN/WARN_ON to get the message out, including the
606 * file/line information and a backtrace.
607 */
608#define dev_WARN(dev, format, arg...) \
609 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611/* Create alias, so I can be autoloaded. */
612#define MODULE_ALIAS_CHARDEV(major,minor) \
613 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
614#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
615 MODULE_ALIAS("char-major-" __stringify(major) "-*")
616#endif /* _DEVICE_H_ */