Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * device.h - generic, centralized driver model |
| 3 | * |
| 4 | * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> |
Greg Kroah-Hartman | b402843 | 2009-05-11 14:16:57 -0700 | [diff] [blame] | 5 | * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> |
| 6 | * Copyright (c) 2008-2009 Novell Inc. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 7 | * |
| 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <linux/ioport.h> |
| 17 | #include <linux/kobject.h> |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 18 | #include <linux/klist.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 19 | #include <linux/list.h> |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 20 | #include <linux/lockdep.h> |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 21 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 22 | #include <linux/types.h> |
| 23 | #include <linux/module.h> |
| 24 | #include <linux/pm.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | #include <asm/atomic.h> |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 26 | #include <asm/device.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | struct device; |
Greg Kroah-Hartman | fb069a5 | 2008-12-16 12:23:36 -0800 | [diff] [blame] | 29 | struct device_private; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | struct device_driver; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 31 | struct driver_private; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | struct class; |
Greg Kroah-Hartman | 7c71448 | 2008-01-22 18:17:41 -0500 | [diff] [blame] | 33 | struct class_private; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 34 | struct bus_type; |
Greg Kroah-Hartman | c6f7e72 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 35 | struct bus_type_private; |
Grant Likely | d706c1b | 2010-04-13 16:12:28 -0700 | [diff] [blame] | 36 | struct device_node; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 37 | |
| 38 | struct bus_attribute { |
| 39 | struct attribute attr; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 40 | ssize_t (*show)(struct bus_type *bus, char *buf); |
| 41 | ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count); |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 42 | }; |
| 43 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 44 | #define BUS_ATTR(_name, _mode, _show, _store) \ |
| 45 | struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 46 | |
| 47 | extern int __must_check bus_create_file(struct bus_type *, |
| 48 | struct bus_attribute *); |
| 49 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
| 51 | struct bus_type { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 52 | const char *name; |
| 53 | struct bus_attribute *bus_attrs; |
| 54 | struct device_attribute *dev_attrs; |
| 55 | struct driver_attribute *drv_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 57 | int (*match)(struct device *dev, struct device_driver *drv); |
| 58 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
| 59 | int (*probe)(struct device *dev); |
| 60 | int (*remove)(struct device *dev); |
| 61 | void (*shutdown)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 62 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 63 | int (*suspend)(struct device *dev, pm_message_t state); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 64 | int (*resume)(struct device *dev); |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 65 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 66 | const struct dev_pm_ops *pm; |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 67 | |
Greg Kroah-Hartman | c6f7e72 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 68 | struct bus_type_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | }; |
| 70 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 71 | extern int __must_check bus_register(struct bus_type *bus); |
| 72 | extern void bus_unregister(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 74 | extern int __must_check bus_rescan_devices(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 76 | /* iterator helpers for buses */ |
| 77 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 78 | int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, |
| 79 | int (*fn)(struct device *dev, void *data)); |
| 80 | struct device *bus_find_device(struct bus_type *bus, struct device *start, |
| 81 | void *data, |
| 82 | int (*match)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 1f9ffc0 | 2008-01-27 10:29:20 -0800 | [diff] [blame] | 83 | struct device *bus_find_device_by_name(struct bus_type *bus, |
| 84 | struct device *start, |
| 85 | const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | |
Jean Delvare | cc7447a | 2010-06-16 11:44:18 +0200 | [diff] [blame] | 87 | int bus_for_each_drv(struct bus_type *bus, struct device_driver *start, |
| 88 | void *data, int (*fn)(struct device_driver *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | |
Greg Kroah-Hartman | 99178b0 | 2008-08-26 11:00:57 -0500 | [diff] [blame] | 90 | void bus_sort_breadthfirst(struct bus_type *bus, |
| 91 | int (*compare)(const struct device *a, |
| 92 | const struct device *b)); |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 93 | /* |
| 94 | * Bus notifiers: Get notified of addition/removal of devices |
| 95 | * and binding/unbinding of drivers to devices. |
| 96 | * In the long run, it should be a replacement for the platform |
| 97 | * notify hooks. |
| 98 | */ |
| 99 | struct notifier_block; |
| 100 | |
| 101 | extern int bus_register_notifier(struct bus_type *bus, |
| 102 | struct notifier_block *nb); |
| 103 | extern int bus_unregister_notifier(struct bus_type *bus, |
| 104 | struct notifier_block *nb); |
| 105 | |
| 106 | /* All 4 notifers below get called with the target struct device * |
| 107 | * as an argument. Note that those functions are likely to be called |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 108 | * with the device lock held in the core, so be careful. |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 109 | */ |
| 110 | #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ |
| 111 | #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */ |
Magnus Damm | 45daef0 | 2010-07-23 19:56:18 +0900 | [diff] [blame] | 112 | #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be |
| 113 | bound */ |
| 114 | #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */ |
| 115 | #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 116 | unbound */ |
Magnus Damm | 45daef0 | 2010-07-23 19:56:18 +0900 | [diff] [blame] | 117 | #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound |
Joerg Roedel | 309b7d6 | 2009-04-24 14:57:00 +0200 | [diff] [blame] | 118 | from the device */ |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 119 | |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 120 | extern struct kset *bus_get_kset(struct bus_type *bus); |
Greg Kroah-Hartman | b249072 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 121 | extern struct klist *bus_get_device_klist(struct bus_type *bus); |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 122 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | struct device_driver { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 124 | const char *name; |
| 125 | struct bus_type *bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 127 | struct module *owner; |
Dmitry Torokhov | 1a6f2a7 | 2009-10-12 20:17:41 -0700 | [diff] [blame] | 128 | const char *mod_name; /* used for built-in modules */ |
| 129 | |
| 130 | bool suppress_bind_attrs; /* disables bind/unbind via sysfs */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | |
Grant Likely | 597b9d1 | 2010-04-13 16:13:01 -0700 | [diff] [blame] | 132 | #if defined(CONFIG_OF) |
| 133 | const struct of_device_id *of_match_table; |
| 134 | #endif |
| 135 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 136 | int (*probe) (struct device *dev); |
| 137 | int (*remove) (struct device *dev); |
| 138 | void (*shutdown) (struct device *dev); |
| 139 | int (*suspend) (struct device *dev, pm_message_t state); |
| 140 | int (*resume) (struct device *dev); |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 141 | const struct attribute_group **groups; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 142 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 143 | const struct dev_pm_ops *pm; |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 144 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 145 | struct driver_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | }; |
| 147 | |
| 148 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 149 | extern int __must_check driver_register(struct device_driver *drv); |
| 150 | extern void driver_unregister(struct device_driver *drv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 152 | extern struct device_driver *get_driver(struct device_driver *drv); |
| 153 | extern void put_driver(struct device_driver *drv); |
| 154 | extern struct device_driver *driver_find(const char *name, |
| 155 | struct bus_type *bus); |
Greg Kroah-Hartman | d779249 | 2006-07-18 10:59:59 -0700 | [diff] [blame] | 156 | extern int driver_probe_done(void); |
Ming Lei | b23530e | 2009-02-21 16:45:07 +0800 | [diff] [blame] | 157 | extern void wait_for_device_probe(void); |
Arjan van de Ven | 216773a | 2009-02-14 01:59:06 +0100 | [diff] [blame] | 158 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | |
Robert P. J. Day | 405ae7d | 2007-02-17 19:13:42 +0100 | [diff] [blame] | 160 | /* sysfs interface for exporting driver attributes */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | |
| 162 | struct driver_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 163 | struct attribute attr; |
| 164 | ssize_t (*show)(struct device_driver *driver, char *buf); |
| 165 | ssize_t (*store)(struct device_driver *driver, const char *buf, |
| 166 | size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | }; |
| 168 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 169 | #define DRIVER_ATTR(_name, _mode, _show, _store) \ |
| 170 | struct driver_attribute driver_attr_##_name = \ |
| 171 | __ATTR(_name, _mode, _show, _store) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 172 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 173 | extern int __must_check driver_create_file(struct device_driver *driver, |
Phil Carmody | 099c2f2 | 2009-12-18 15:34:21 +0200 | [diff] [blame] | 174 | const struct driver_attribute *attr); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 175 | extern void driver_remove_file(struct device_driver *driver, |
Phil Carmody | 099c2f2 | 2009-12-18 15:34:21 +0200 | [diff] [blame] | 176 | const struct driver_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | |
Greg Kroah-Hartman | cbe9c59 | 2007-12-19 15:54:39 -0400 | [diff] [blame] | 178 | extern int __must_check driver_add_kobj(struct device_driver *drv, |
| 179 | struct kobject *kobj, |
| 180 | const char *fmt, ...); |
| 181 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 182 | extern int __must_check driver_for_each_device(struct device_driver *drv, |
| 183 | struct device *start, |
| 184 | void *data, |
| 185 | int (*fn)(struct device *dev, |
| 186 | void *)); |
| 187 | struct device *driver_find_device(struct device_driver *drv, |
| 188 | struct device *start, void *data, |
| 189 | int (*match)(struct device *dev, void *data)); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 190 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | /* |
| 192 | * device classes |
| 193 | */ |
| 194 | struct class { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 195 | const char *name; |
| 196 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 198 | struct class_attribute *class_attrs; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 199 | struct device_attribute *dev_attrs; |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 200 | struct kobject *dev_kobj; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 202 | int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); |
Kay Sievers | e454cea | 2009-09-18 23:01:12 +0200 | [diff] [blame] | 203 | char *(*devnode)(struct device *dev, mode_t *mode); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 204 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 205 | void (*class_release)(struct class *class); |
| 206 | void (*dev_release)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 207 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 208 | int (*suspend)(struct device *dev, pm_message_t state); |
| 209 | int (*resume)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 210 | |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 211 | const struct kobj_ns_type_operations *ns_type; |
| 212 | const void *(*namespace)(struct device *dev); |
| 213 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 214 | const struct dev_pm_ops *pm; |
| 215 | |
Greg Kroah-Hartman | 7c71448 | 2008-01-22 18:17:41 -0500 | [diff] [blame] | 216 | struct class_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | }; |
| 218 | |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 219 | struct class_dev_iter { |
| 220 | struct klist_iter ki; |
| 221 | const struct device_type *type; |
| 222 | }; |
| 223 | |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 224 | extern struct kobject *sysfs_dev_block_kobj; |
| 225 | extern struct kobject *sysfs_dev_char_kobj; |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 226 | extern int __must_check __class_register(struct class *class, |
| 227 | struct lock_class_key *key); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 228 | extern void class_unregister(struct class *class); |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 229 | |
| 230 | /* This is a #define to keep the compiler from merging different |
| 231 | * instances of the __key variable */ |
| 232 | #define class_register(class) \ |
| 233 | ({ \ |
| 234 | static struct lock_class_key __key; \ |
| 235 | __class_register(class, &__key); \ |
| 236 | }) |
| 237 | |
Jean Delvare | 4622709 | 2009-08-04 12:55:34 +0200 | [diff] [blame] | 238 | struct class_compat; |
| 239 | struct class_compat *class_compat_register(const char *name); |
| 240 | void class_compat_unregister(struct class_compat *cls); |
| 241 | int class_compat_create_link(struct class_compat *cls, struct device *dev, |
| 242 | struct device *device_link); |
| 243 | void class_compat_remove_link(struct class_compat *cls, struct device *dev, |
| 244 | struct device *device_link); |
| 245 | |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 246 | extern void class_dev_iter_init(struct class_dev_iter *iter, |
| 247 | struct class *class, |
| 248 | struct device *start, |
| 249 | const struct device_type *type); |
| 250 | extern struct device *class_dev_iter_next(struct class_dev_iter *iter); |
| 251 | extern void class_dev_iter_exit(struct class_dev_iter *iter); |
| 252 | |
Greg Kroah-Hartman | 93562b5 | 2008-05-22 17:21:08 -0400 | [diff] [blame] | 253 | extern int class_for_each_device(struct class *class, struct device *start, |
| 254 | void *data, |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 255 | int (*fn)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 695794a | 2008-05-22 17:21:08 -0400 | [diff] [blame] | 256 | extern struct device *class_find_device(struct class *class, |
| 257 | struct device *start, void *data, |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 258 | int (*match)(struct device *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 259 | |
| 260 | struct class_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 261 | struct attribute attr; |
Andi Kleen | 28812fe | 2010-01-05 12:48:07 +0100 | [diff] [blame] | 262 | ssize_t (*show)(struct class *class, struct class_attribute *attr, |
| 263 | char *buf); |
| 264 | ssize_t (*store)(struct class *class, struct class_attribute *attr, |
| 265 | const char *buf, size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 266 | }; |
| 267 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 268 | #define CLASS_ATTR(_name, _mode, _show, _store) \ |
| 269 | struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 271 | extern int __must_check class_create_file(struct class *class, |
| 272 | const struct class_attribute *attr); |
| 273 | extern void class_remove_file(struct class *class, |
| 274 | const struct class_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 275 | |
Andi Kleen | 869dfc8 | 2010-01-05 12:48:08 +0100 | [diff] [blame] | 276 | /* Simple class attribute that is just a static string */ |
| 277 | |
| 278 | struct class_attribute_string { |
| 279 | struct class_attribute attr; |
| 280 | char *str; |
| 281 | }; |
| 282 | |
| 283 | /* Currently read-only only */ |
| 284 | #define _CLASS_ATTR_STRING(_name, _mode, _str) \ |
| 285 | { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } |
| 286 | #define CLASS_ATTR_STRING(_name, _mode, _str) \ |
| 287 | struct class_attribute_string class_attr_##_name = \ |
| 288 | _CLASS_ATTR_STRING(_name, _mode, _str) |
| 289 | |
| 290 | extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr, |
| 291 | char *buf); |
| 292 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 293 | struct class_interface { |
| 294 | struct list_head node; |
| 295 | struct class *class; |
| 296 | |
Greg Kroah-Hartman | c47ed21 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 297 | int (*add_dev) (struct device *, struct class_interface *); |
| 298 | void (*remove_dev) (struct device *, struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 299 | }; |
| 300 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 301 | extern int __must_check class_interface_register(struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 302 | extern void class_interface_unregister(struct class_interface *); |
| 303 | |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 304 | extern struct class * __must_check __class_create(struct module *owner, |
| 305 | const char *name, |
| 306 | struct lock_class_key *key); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 307 | extern void class_destroy(struct class *cls); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 308 | |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 309 | /* This is a #define to keep the compiler from merging different |
| 310 | * instances of the __key variable */ |
| 311 | #define class_create(owner, name) \ |
| 312 | ({ \ |
| 313 | static struct lock_class_key __key; \ |
| 314 | __class_create(owner, name, &__key); \ |
| 315 | }) |
| 316 | |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 317 | /* |
| 318 | * The type of device, "struct device" is embedded in. A class |
| 319 | * or bus can contain devices of different types |
| 320 | * like "partitions" and "disks", "mouse" and "event". |
| 321 | * This identifies the device type and carries type-specific |
| 322 | * information, equivalent to the kobj_type of a kobject. |
| 323 | * If "name" is specified, the uevent will contain it in |
| 324 | * the DEVTYPE variable. |
| 325 | */ |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 326 | struct device_type { |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 327 | const char *name; |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 328 | const struct attribute_group **groups; |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 329 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
Kay Sievers | e454cea | 2009-09-18 23:01:12 +0200 | [diff] [blame] | 330 | char *(*devnode)(struct device *dev, mode_t *mode); |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 331 | void (*release)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 332 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 333 | const struct dev_pm_ops *pm; |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 334 | }; |
| 335 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 336 | /* interface for exporting device attributes */ |
| 337 | struct device_attribute { |
| 338 | struct attribute attr; |
| 339 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, |
| 340 | char *buf); |
| 341 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, |
| 342 | const char *buf, size_t count); |
| 343 | }; |
| 344 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 345 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
| 346 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 347 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 348 | extern int __must_check device_create_file(struct device *device, |
Phil Carmody | 66ecb92 | 2009-12-18 15:34:20 +0200 | [diff] [blame] | 349 | const struct device_attribute *entry); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 350 | extern void device_remove_file(struct device *dev, |
Phil Carmody | 26579ab | 2009-12-18 15:34:19 +0200 | [diff] [blame] | 351 | const struct device_attribute *attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 352 | extern int __must_check device_create_bin_file(struct device *dev, |
Phil Carmody | 66ecb92 | 2009-12-18 15:34:20 +0200 | [diff] [blame] | 353 | const struct bin_attribute *attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 354 | extern void device_remove_bin_file(struct device *dev, |
Phil Carmody | 66ecb92 | 2009-12-18 15:34:20 +0200 | [diff] [blame] | 355 | const struct bin_attribute *attr); |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 356 | extern int device_schedule_callback_owner(struct device *dev, |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 357 | void (*func)(struct device *dev), struct module *owner); |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 358 | |
| 359 | /* This is a macro to avoid include problems with THIS_MODULE */ |
| 360 | #define device_schedule_callback(dev, func) \ |
| 361 | device_schedule_callback_owner(dev, func, THIS_MODULE) |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 362 | |
| 363 | /* device resource management */ |
| 364 | typedef void (*dr_release_t)(struct device *dev, void *res); |
| 365 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); |
| 366 | |
| 367 | #ifdef CONFIG_DEBUG_DEVRES |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 368 | extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 369 | const char *name); |
| 370 | #define devres_alloc(release, size, gfp) \ |
| 371 | __devres_alloc(release, size, gfp, #release) |
| 372 | #else |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 373 | extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 374 | #endif |
| 375 | extern void devres_free(void *res); |
| 376 | extern void devres_add(struct device *dev, void *res); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 377 | extern void *devres_find(struct device *dev, dr_release_t release, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 378 | dr_match_t match, void *match_data); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 379 | extern void *devres_get(struct device *dev, void *new_res, |
| 380 | dr_match_t match, void *match_data); |
| 381 | extern void *devres_remove(struct device *dev, dr_release_t release, |
| 382 | dr_match_t match, void *match_data); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 383 | extern int devres_destroy(struct device *dev, dr_release_t release, |
| 384 | dr_match_t match, void *match_data); |
| 385 | |
| 386 | /* devres group */ |
| 387 | extern void * __must_check devres_open_group(struct device *dev, void *id, |
| 388 | gfp_t gfp); |
| 389 | extern void devres_close_group(struct device *dev, void *id); |
| 390 | extern void devres_remove_group(struct device *dev, void *id); |
| 391 | extern int devres_release_group(struct device *dev, void *id); |
| 392 | |
| 393 | /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */ |
| 394 | extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp); |
| 395 | extern void devm_kfree(struct device *dev, void *p); |
| 396 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 397 | struct device_dma_parameters { |
| 398 | /* |
| 399 | * a low level driver may set these to teach IOMMU code about |
| 400 | * sg limitations. |
| 401 | */ |
| 402 | unsigned int max_segment_size; |
| 403 | unsigned long segment_boundary_mask; |
| 404 | }; |
| 405 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 406 | struct device { |
David Brownell | 49a4ec1 | 2007-05-08 00:29:39 -0700 | [diff] [blame] | 407 | struct device *parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 408 | |
Greg Kroah-Hartman | fb069a5 | 2008-12-16 12:23:36 -0800 | [diff] [blame] | 409 | struct device_private *p; |
| 410 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 411 | struct kobject kobj; |
Greg Kroah-Hartman | c906a48 | 2008-05-30 10:45:12 -0700 | [diff] [blame] | 412 | const char *init_name; /* initial name of the device */ |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 413 | struct device_type *type; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 414 | |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 415 | struct mutex mutex; /* mutex to synchronize calls to |
mochel@digitalimplant.org | af70316 | 2005-03-21 10:41:04 -0800 | [diff] [blame] | 416 | * its driver. |
| 417 | */ |
| 418 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 419 | struct bus_type *bus; /* type of bus device is on */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 420 | struct device_driver *driver; /* which driver has allocated this |
| 421 | device */ |
Greg Kroah-Hartman | e67c856 | 2009-03-08 23:13:32 +0800 | [diff] [blame] | 422 | void *platform_data; /* Platform specific data, device |
| 423 | core doesn't touch it */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | struct dev_pm_info power; |
| 425 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 426 | #ifdef CONFIG_NUMA |
| 427 | int numa_node; /* NUMA node this device is close to */ |
| 428 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 429 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
| 430 | u64 coherent_dma_mask;/* Like dma_mask, but for |
| 431 | alloc_coherent mappings as |
| 432 | not all hardware supports |
| 433 | 64 bit addresses for consistent |
| 434 | allocations such descriptors. */ |
| 435 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 436 | struct device_dma_parameters *dma_parms; |
| 437 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 438 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
| 439 | |
| 440 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
| 441 | override */ |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 442 | /* arch specific additions */ |
| 443 | struct dev_archdata archdata; |
Grant Likely | d706c1b | 2010-04-13 16:12:28 -0700 | [diff] [blame] | 444 | #ifdef CONFIG_OF |
| 445 | struct device_node *of_node; |
| 446 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 447 | |
Matthew Wilcox | 929d2fa | 2008-10-16 15:51:35 -0600 | [diff] [blame] | 448 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
| 449 | |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 450 | spinlock_t devres_lock; |
| 451 | struct list_head devres_head; |
| 452 | |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 453 | struct klist_node knode_class; |
Kay Sievers | b7a3e81 | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 454 | struct class *class; |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 455 | const struct attribute_group **groups; /* optional groups */ |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 456 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 457 | void (*release)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 458 | }; |
| 459 | |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 460 | /* Get the wakeup routines, which depend on struct device */ |
| 461 | #include <linux/pm_wakeup.h> |
| 462 | |
Jean Delvare | bf9ca69 | 2008-07-30 12:29:21 -0700 | [diff] [blame] | 463 | static inline const char *dev_name(const struct device *dev) |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 464 | { |
Paul Mundt | a636ee7 | 2010-03-09 06:57:53 +0000 | [diff] [blame] | 465 | /* Use the init name until the kobject becomes available */ |
| 466 | if (dev->init_name) |
| 467 | return dev->init_name; |
| 468 | |
Kay Sievers | 1fa5ae8 | 2009-01-25 15:17:37 +0100 | [diff] [blame] | 469 | return kobject_name(&dev->kobj); |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 470 | } |
| 471 | |
Stephen Rothwell | 413c239 | 2008-05-30 10:16:40 +1000 | [diff] [blame] | 472 | extern int dev_set_name(struct device *dev, const char *name, ...) |
| 473 | __attribute__((format(printf, 2, 3))); |
| 474 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 475 | #ifdef CONFIG_NUMA |
| 476 | static inline int dev_to_node(struct device *dev) |
| 477 | { |
| 478 | return dev->numa_node; |
| 479 | } |
| 480 | static inline void set_dev_node(struct device *dev, int node) |
| 481 | { |
| 482 | dev->numa_node = node; |
| 483 | } |
| 484 | #else |
| 485 | static inline int dev_to_node(struct device *dev) |
| 486 | { |
| 487 | return -1; |
| 488 | } |
| 489 | static inline void set_dev_node(struct device *dev, int node) |
| 490 | { |
| 491 | } |
| 492 | #endif |
| 493 | |
Ming Lei | f67f129 | 2009-03-01 21:10:49 +0800 | [diff] [blame] | 494 | static inline unsigned int dev_get_uevent_suppress(const struct device *dev) |
| 495 | { |
| 496 | return dev->kobj.uevent_suppress; |
| 497 | } |
| 498 | |
| 499 | static inline void dev_set_uevent_suppress(struct device *dev, int val) |
| 500 | { |
| 501 | dev->kobj.uevent_suppress = val; |
| 502 | } |
| 503 | |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 504 | static inline int device_is_registered(struct device *dev) |
| 505 | { |
Greg Kroah-Hartman | 3f62e57 | 2008-03-13 17:07:03 -0400 | [diff] [blame] | 506 | return dev->kobj.state_in_sysfs; |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 507 | } |
| 508 | |
Rafael J. Wysocki | 5af84b8 | 2010-01-23 22:23:32 +0100 | [diff] [blame] | 509 | static inline void device_enable_async_suspend(struct device *dev) |
| 510 | { |
| 511 | if (dev->power.status == DPM_ON) |
| 512 | dev->power.async_suspend = true; |
| 513 | } |
| 514 | |
Rafael J. Wysocki | 5a2eb85 | 2010-01-23 22:25:23 +0100 | [diff] [blame] | 515 | static inline void device_disable_async_suspend(struct device *dev) |
| 516 | { |
| 517 | if (dev->power.status == DPM_ON) |
| 518 | dev->power.async_suspend = false; |
| 519 | } |
| 520 | |
| 521 | static inline bool device_async_suspend_enabled(struct device *dev) |
| 522 | { |
| 523 | return !!dev->power.async_suspend; |
| 524 | } |
| 525 | |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 526 | static inline void device_lock(struct device *dev) |
| 527 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 528 | mutex_lock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 529 | } |
| 530 | |
| 531 | static inline int device_trylock(struct device *dev) |
| 532 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 533 | return mutex_trylock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 534 | } |
| 535 | |
| 536 | static inline void device_unlock(struct device *dev) |
| 537 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 538 | mutex_unlock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 539 | } |
| 540 | |
Adrian Bunk | 1f21782 | 2006-12-19 13:01:28 -0800 | [diff] [blame] | 541 | void driver_init(void); |
| 542 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 543 | /* |
| 544 | * High level routines for use by the bus drivers |
| 545 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 546 | extern int __must_check device_register(struct device *dev); |
| 547 | extern void device_unregister(struct device *dev); |
| 548 | extern void device_initialize(struct device *dev); |
| 549 | extern int __must_check device_add(struct device *dev); |
| 550 | extern void device_del(struct device *dev); |
| 551 | extern int device_for_each_child(struct device *dev, void *data, |
| 552 | int (*fn)(struct device *dev, void *data)); |
| 553 | extern struct device *device_find_child(struct device *dev, void *data, |
| 554 | int (*match)(struct device *dev, void *data)); |
Johannes Berg | 6937e8f | 2010-08-05 17:38:18 +0200 | [diff] [blame^] | 555 | extern int device_rename(struct device *dev, const char *new_name); |
Cornelia Huck | ffa6a70 | 2009-03-04 12:44:00 +0100 | [diff] [blame] | 556 | extern int device_move(struct device *dev, struct device *new_parent, |
| 557 | enum dpm_order dpm_order); |
Kay Sievers | e454cea | 2009-09-18 23:01:12 +0200 | [diff] [blame] | 558 | extern const char *device_get_devnode(struct device *dev, |
| 559 | mode_t *mode, const char **tmp); |
Greg Kroah-Hartman | b402843 | 2009-05-11 14:16:57 -0700 | [diff] [blame] | 560 | extern void *dev_get_drvdata(const struct device *dev); |
| 561 | extern void dev_set_drvdata(struct device *dev, void *data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 562 | |
| 563 | /* |
Mark McLoughlin | 0aa0dc4 | 2008-12-15 12:58:26 +0000 | [diff] [blame] | 564 | * Root device objects for grouping under /sys/devices |
| 565 | */ |
| 566 | extern struct device *__root_device_register(const char *name, |
| 567 | struct module *owner); |
| 568 | static inline struct device *root_device_register(const char *name) |
| 569 | { |
| 570 | return __root_device_register(name, THIS_MODULE); |
| 571 | } |
| 572 | extern void root_device_unregister(struct device *root); |
| 573 | |
Mark Brown | a5b8b1a | 2009-07-17 15:06:08 +0100 | [diff] [blame] | 574 | static inline void *dev_get_platdata(const struct device *dev) |
| 575 | { |
| 576 | return dev->platform_data; |
| 577 | } |
| 578 | |
Mark McLoughlin | 0aa0dc4 | 2008-12-15 12:58:26 +0000 | [diff] [blame] | 579 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 580 | * Manual binding of a device to driver. See drivers/base/bus.c |
| 581 | * for information on use. |
| 582 | */ |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 583 | extern int __must_check device_bind_driver(struct device *dev); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 584 | extern void device_release_driver(struct device *dev); |
| 585 | extern int __must_check device_attach(struct device *dev); |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 586 | extern int __must_check driver_attach(struct device_driver *drv); |
| 587 | extern int __must_check device_reprobe(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 588 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 589 | /* |
| 590 | * Easy functions for dynamically creating devices on the fly |
| 591 | */ |
Greg Kroah-Hartman | 8882b39 | 2008-05-15 13:44:08 -0700 | [diff] [blame] | 592 | extern struct device *device_create_vargs(struct class *cls, |
| 593 | struct device *parent, |
| 594 | dev_t devt, |
| 595 | void *drvdata, |
| 596 | const char *fmt, |
| 597 | va_list vargs); |
Greg Kroah-Hartman | 4e10673 | 2008-07-21 20:03:34 -0700 | [diff] [blame] | 598 | extern struct device *device_create(struct class *cls, struct device *parent, |
| 599 | dev_t devt, void *drvdata, |
| 600 | const char *fmt, ...) |
Greg Kroah-Hartman | 8882b39 | 2008-05-15 13:44:08 -0700 | [diff] [blame] | 601 | __attribute__((format(printf, 5, 6))); |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 602 | extern void device_destroy(struct class *cls, dev_t devt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 603 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 604 | /* |
| 605 | * Platform "fixup" functions - allow the platform to have their say |
| 606 | * about devices and actions that the general device layer doesn't |
| 607 | * know about. |
| 608 | */ |
| 609 | /* Notify platform of device discovery */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 610 | extern int (*platform_notify)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 611 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 612 | extern int (*platform_notify_remove)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 613 | |
| 614 | |
| 615 | /** |
| 616 | * get_device - atomically increment the reference count for the device. |
| 617 | * |
| 618 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 619 | extern struct device *get_device(struct device *dev); |
| 620 | extern void put_device(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 621 | |
Arjan van de Ven | d4d5291 | 2009-04-21 13:32:54 -0700 | [diff] [blame] | 622 | extern void wait_for_device_probe(void); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 623 | |
Kay Sievers | 2b2af54 | 2009-04-30 15:23:42 +0200 | [diff] [blame] | 624 | #ifdef CONFIG_DEVTMPFS |
| 625 | extern int devtmpfs_create_node(struct device *dev); |
| 626 | extern int devtmpfs_delete_node(struct device *dev); |
Kay Sievers | 073120c | 2009-10-28 19:51:17 +0100 | [diff] [blame] | 627 | extern int devtmpfs_mount(const char *mntdir); |
Kay Sievers | 2b2af54 | 2009-04-30 15:23:42 +0200 | [diff] [blame] | 628 | #else |
| 629 | static inline int devtmpfs_create_node(struct device *dev) { return 0; } |
| 630 | static inline int devtmpfs_delete_node(struct device *dev) { return 0; } |
| 631 | static inline int devtmpfs_mount(const char *mountpoint) { return 0; } |
| 632 | #endif |
| 633 | |
Rytchkov Alexey | 116f232b | 2006-03-22 00:58:53 +0100 | [diff] [blame] | 634 | /* drivers/base/power/shutdown.c */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 635 | extern void device_shutdown(void); |
| 636 | |
Rafael J. Wysocki | 58b3b71 | 2007-07-26 16:29:55 +0200 | [diff] [blame] | 637 | /* drivers/base/sys.c */ |
| 638 | extern void sysdev_shutdown(void); |
| 639 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 640 | /* debugging and troubleshooting/diagnostic helpers. */ |
Jean Delvare | bf9ca69 | 2008-07-30 12:29:21 -0700 | [diff] [blame] | 641 | extern const char *dev_driver_string(const struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 642 | |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 643 | |
| 644 | #ifdef CONFIG_PRINTK |
| 645 | |
| 646 | extern int dev_printk(const char *level, const struct device *dev, |
| 647 | const char *fmt, ...) |
| 648 | __attribute__ ((format (printf, 3, 4))); |
| 649 | extern int dev_emerg(const struct device *dev, const char *fmt, ...) |
| 650 | __attribute__ ((format (printf, 2, 3))); |
| 651 | extern int dev_alert(const struct device *dev, const char *fmt, ...) |
| 652 | __attribute__ ((format (printf, 2, 3))); |
| 653 | extern int dev_crit(const struct device *dev, const char *fmt, ...) |
| 654 | __attribute__ ((format (printf, 2, 3))); |
| 655 | extern int dev_err(const struct device *dev, const char *fmt, ...) |
| 656 | __attribute__ ((format (printf, 2, 3))); |
| 657 | extern int dev_warn(const struct device *dev, const char *fmt, ...) |
| 658 | __attribute__ ((format (printf, 2, 3))); |
| 659 | extern int dev_notice(const struct device *dev, const char *fmt, ...) |
| 660 | __attribute__ ((format (printf, 2, 3))); |
| 661 | extern int _dev_info(const struct device *dev, const char *fmt, ...) |
| 662 | __attribute__ ((format (printf, 2, 3))); |
| 663 | |
| 664 | #else |
| 665 | |
| 666 | static inline int dev_printk(const char *level, const struct device *dev, |
| 667 | const char *fmt, ...) |
| 668 | __attribute__ ((format (printf, 3, 4))); |
| 669 | static inline int dev_printk(const char *level, const struct device *dev, |
| 670 | const char *fmt, ...) |
| 671 | { return 0; } |
| 672 | |
| 673 | static inline int dev_emerg(const struct device *dev, const char *fmt, ...) |
| 674 | __attribute__ ((format (printf, 2, 3))); |
| 675 | static inline int dev_emerg(const struct device *dev, const char *fmt, ...) |
| 676 | { return 0; } |
| 677 | static inline int dev_crit(const struct device *dev, const char *fmt, ...) |
| 678 | __attribute__ ((format (printf, 2, 3))); |
| 679 | static inline int dev_crit(const struct device *dev, const char *fmt, ...) |
| 680 | { return 0; } |
| 681 | static inline int dev_alert(const struct device *dev, const char *fmt, ...) |
| 682 | __attribute__ ((format (printf, 2, 3))); |
| 683 | static inline int dev_alert(const struct device *dev, const char *fmt, ...) |
| 684 | { return 0; } |
| 685 | static inline int dev_err(const struct device *dev, const char *fmt, ...) |
| 686 | __attribute__ ((format (printf, 2, 3))); |
| 687 | static inline int dev_err(const struct device *dev, const char *fmt, ...) |
| 688 | { return 0; } |
| 689 | static inline int dev_warn(const struct device *dev, const char *fmt, ...) |
| 690 | __attribute__ ((format (printf, 2, 3))); |
| 691 | static inline int dev_warn(const struct device *dev, const char *fmt, ...) |
| 692 | { return 0; } |
| 693 | static inline int dev_notice(const struct device *dev, const char *fmt, ...) |
| 694 | __attribute__ ((format (printf, 2, 3))); |
| 695 | static inline int dev_notice(const struct device *dev, const char *fmt, ...) |
| 696 | { return 0; } |
| 697 | static inline int _dev_info(const struct device *dev, const char *fmt, ...) |
| 698 | __attribute__ ((format (printf, 2, 3))); |
| 699 | static inline int _dev_info(const struct device *dev, const char *fmt, ...) |
| 700 | { return 0; } |
| 701 | |
| 702 | #endif |
| 703 | |
| 704 | /* |
| 705 | * Stupid hackaround for existing uses of non-printk uses dev_info |
| 706 | * |
| 707 | * Note that the definition of dev_info below is actually _dev_info |
| 708 | * and a macro is used to avoid redefining dev_info |
| 709 | */ |
| 710 | |
| 711 | #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg) |
Emil Medve | 7b8712e | 2007-10-30 14:37:14 -0500 | [diff] [blame] | 712 | |
Cornelia Huck | d0d85ff | 2008-12-04 16:55:47 +0100 | [diff] [blame] | 713 | #if defined(DEBUG) |
| 714 | #define dev_dbg(dev, format, arg...) \ |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 715 | dev_printk(KERN_DEBUG, dev, format, ##arg) |
Jason Baron | e9d376f | 2009-02-05 11:51:38 -0500 | [diff] [blame] | 716 | #elif defined(CONFIG_DYNAMIC_DEBUG) |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 717 | #define dev_dbg(dev, format, ...) \ |
| 718 | do { \ |
Jason Baron | 346e15b | 2008-08-12 16:46:19 -0400 | [diff] [blame] | 719 | dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \ |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 720 | } while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 721 | #else |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 722 | #define dev_dbg(dev, format, arg...) \ |
| 723 | ({ \ |
| 724 | if (0) \ |
| 725 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ |
| 726 | 0; \ |
| 727 | }) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 728 | #endif |
| 729 | |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 730 | #ifdef VERBOSE_DEBUG |
| 731 | #define dev_vdbg dev_dbg |
| 732 | #else |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 733 | #define dev_vdbg(dev, format, arg...) \ |
| 734 | ({ \ |
| 735 | if (0) \ |
| 736 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ |
| 737 | 0; \ |
| 738 | }) |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 739 | #endif |
| 740 | |
Arjan van de Ven | e613966 | 2008-09-20 19:08:39 -0700 | [diff] [blame] | 741 | /* |
| 742 | * dev_WARN() acts like dev_printk(), but with the key difference |
| 743 | * of using a WARN/WARN_ON to get the message out, including the |
| 744 | * file/line information and a backtrace. |
| 745 | */ |
| 746 | #define dev_WARN(dev, format, arg...) \ |
| 747 | WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg); |
| 748 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 749 | /* Create alias, so I can be autoloaded. */ |
| 750 | #define MODULE_ALIAS_CHARDEV(major,minor) \ |
| 751 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) |
| 752 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ |
| 753 | MODULE_ALIAS("char-major-" __stringify(major) "-*") |
| 754 | #endif /* _DEVICE_H_ */ |