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 | 89790fd | 2007-02-12 22:33:06 -0800 | [diff] [blame] | 5 | * Copyright (c) 2004-2007 Greg Kroah-Hartman <gregkh@suse.de> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | * |
| 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | #include <linux/ioport.h> |
| 16 | #include <linux/kobject.h> |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 17 | #include <linux/klist.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/list.h> |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 19 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | #include <linux/types.h> |
| 21 | #include <linux/module.h> |
| 22 | #include <linux/pm.h> |
Matthew Wilcox | 6188e10 | 2008-04-18 22:21:05 -0400 | [diff] [blame] | 23 | #include <linux/semaphore.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | #include <asm/atomic.h> |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 25 | #include <asm/device.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | |
| 27 | #define DEVICE_NAME_SIZE 50 |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 28 | /* DEVICE_NAME_HALF is really less than half to accommodate slop */ |
| 29 | #define DEVICE_NAME_HALF __stringify(20) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | #define DEVICE_ID_SIZE 32 |
| 31 | #define BUS_ID_SIZE KOBJ_NAME_LEN |
| 32 | |
| 33 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | struct device; |
| 35 | struct device_driver; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 36 | struct driver_private; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | struct class; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 38 | struct bus_type; |
Greg Kroah-Hartman | c6f7e72 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 39 | struct bus_type_private; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 40 | |
| 41 | struct bus_attribute { |
| 42 | struct attribute attr; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 43 | ssize_t (*show)(struct bus_type *bus, char *buf); |
| 44 | 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] | 45 | }; |
| 46 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 47 | #define BUS_ATTR(_name, _mode, _show, _store) \ |
| 48 | struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 49 | |
| 50 | extern int __must_check bus_create_file(struct bus_type *, |
| 51 | struct bus_attribute *); |
| 52 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | |
| 54 | struct bus_type { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 55 | const char *name; |
| 56 | struct bus_attribute *bus_attrs; |
| 57 | struct device_attribute *dev_attrs; |
| 58 | struct driver_attribute *drv_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 60 | int (*match)(struct device *dev, struct device_driver *drv); |
| 61 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
| 62 | int (*probe)(struct device *dev); |
| 63 | int (*remove)(struct device *dev); |
| 64 | void (*shutdown)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 65 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 66 | int (*suspend)(struct device *dev, pm_message_t state); |
| 67 | int (*suspend_late)(struct device *dev, pm_message_t state); |
| 68 | int (*resume_early)(struct device *dev); |
| 69 | int (*resume)(struct device *dev); |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 70 | |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 71 | struct pm_ext_ops *pm; |
| 72 | |
Greg Kroah-Hartman | c6f7e72 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 73 | struct bus_type_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | }; |
| 75 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 76 | extern int __must_check bus_register(struct bus_type *bus); |
| 77 | extern void bus_unregister(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 78 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 79 | extern int __must_check bus_rescan_devices(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | /* iterator helpers for buses */ |
| 82 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 83 | int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, |
| 84 | int (*fn)(struct device *dev, void *data)); |
| 85 | struct device *bus_find_device(struct bus_type *bus, struct device *start, |
| 86 | void *data, |
| 87 | int (*match)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 1f9ffc0 | 2008-01-27 10:29:20 -0800 | [diff] [blame] | 88 | struct device *bus_find_device_by_name(struct bus_type *bus, |
| 89 | struct device *start, |
| 90 | const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 92 | int __must_check bus_for_each_drv(struct bus_type *bus, |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 93 | struct device_driver *start, void *data, |
| 94 | int (*fn)(struct device_driver *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 96 | /* |
| 97 | * Bus notifiers: Get notified of addition/removal of devices |
| 98 | * and binding/unbinding of drivers to devices. |
| 99 | * In the long run, it should be a replacement for the platform |
| 100 | * notify hooks. |
| 101 | */ |
| 102 | struct notifier_block; |
| 103 | |
| 104 | extern int bus_register_notifier(struct bus_type *bus, |
| 105 | struct notifier_block *nb); |
| 106 | extern int bus_unregister_notifier(struct bus_type *bus, |
| 107 | struct notifier_block *nb); |
| 108 | |
| 109 | /* All 4 notifers below get called with the target struct device * |
| 110 | * as an argument. Note that those functions are likely to be called |
| 111 | * with the device semaphore held in the core, so be careful. |
| 112 | */ |
| 113 | #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ |
| 114 | #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */ |
| 115 | #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */ |
| 116 | #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be |
| 117 | unbound */ |
| 118 | |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 119 | extern struct kset *bus_get_kset(struct bus_type *bus); |
Greg Kroah-Hartman | b249072 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 120 | extern struct klist *bus_get_device_klist(struct bus_type *bus); |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 121 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | struct device_driver { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 123 | const char *name; |
| 124 | struct bus_type *bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 126 | struct module *owner; |
| 127 | const char *mod_name; /* used for built-in modules */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 129 | int (*probe) (struct device *dev); |
| 130 | int (*remove) (struct device *dev); |
| 131 | void (*shutdown) (struct device *dev); |
| 132 | int (*suspend) (struct device *dev, pm_message_t state); |
| 133 | int (*resume) (struct device *dev); |
Cornelia Huck | 57c7453 | 2007-12-05 12:50:23 +0100 | [diff] [blame] | 134 | struct attribute_group **groups; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 135 | |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 136 | struct pm_ops *pm; |
| 137 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 138 | struct driver_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | }; |
| 140 | |
| 141 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 142 | extern int __must_check driver_register(struct device_driver *drv); |
| 143 | extern void driver_unregister(struct device_driver *drv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 145 | extern struct device_driver *get_driver(struct device_driver *drv); |
| 146 | extern void put_driver(struct device_driver *drv); |
| 147 | extern struct device_driver *driver_find(const char *name, |
| 148 | struct bus_type *bus); |
Greg Kroah-Hartman | d779249 | 2006-07-18 10:59:59 -0700 | [diff] [blame] | 149 | extern int driver_probe_done(void); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
Robert P. J. Day | 405ae7d | 2007-02-17 19:13:42 +0100 | [diff] [blame] | 151 | /* sysfs interface for exporting driver attributes */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | |
| 153 | struct driver_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 154 | struct attribute attr; |
| 155 | ssize_t (*show)(struct device_driver *driver, char *buf); |
| 156 | ssize_t (*store)(struct device_driver *driver, const char *buf, |
| 157 | size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | }; |
| 159 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 160 | #define DRIVER_ATTR(_name, _mode, _show, _store) \ |
| 161 | struct driver_attribute driver_attr_##_name = \ |
| 162 | __ATTR(_name, _mode, _show, _store) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 164 | extern int __must_check driver_create_file(struct device_driver *driver, |
| 165 | struct driver_attribute *attr); |
| 166 | extern void driver_remove_file(struct device_driver *driver, |
| 167 | struct driver_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | |
Greg Kroah-Hartman | cbe9c59 | 2007-12-19 15:54:39 -0400 | [diff] [blame] | 169 | extern int __must_check driver_add_kobj(struct device_driver *drv, |
| 170 | struct kobject *kobj, |
| 171 | const char *fmt, ...); |
| 172 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 173 | extern int __must_check driver_for_each_device(struct device_driver *drv, |
| 174 | struct device *start, |
| 175 | void *data, |
| 176 | int (*fn)(struct device *dev, |
| 177 | void *)); |
| 178 | struct device *driver_find_device(struct device_driver *drv, |
| 179 | struct device *start, void *data, |
| 180 | int (*match)(struct device *dev, void *data)); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 181 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | /* |
| 183 | * device classes |
| 184 | */ |
| 185 | struct class { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 186 | const char *name; |
| 187 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 189 | struct kset subsys; |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 190 | struct list_head devices; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | struct list_head interfaces; |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 192 | struct kset class_dirs; |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 193 | struct semaphore sem; /* locks children, devices, interfaces */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 194 | struct class_attribute *class_attrs; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 195 | struct device_attribute *dev_attrs; |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 196 | struct kobject *dev_kobj; |
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 | int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 200 | void (*class_release)(struct class *class); |
| 201 | void (*dev_release)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 202 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 203 | int (*suspend)(struct device *dev, pm_message_t state); |
| 204 | int (*resume)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 205 | |
| 206 | struct pm_ops *pm; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | }; |
| 208 | |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 209 | extern struct kobject *sysfs_dev_block_kobj; |
| 210 | extern struct kobject *sysfs_dev_char_kobj; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 211 | extern int __must_check class_register(struct class *class); |
| 212 | extern void class_unregister(struct class *class); |
Greg Kroah-Hartman | 93562b5 | 2008-05-22 17:21:08 -0400 | [diff] [blame] | 213 | extern int class_for_each_device(struct class *class, struct device *start, |
| 214 | void *data, |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 215 | int (*fn)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 695794a | 2008-05-22 17:21:08 -0400 | [diff] [blame^] | 216 | extern struct device *class_find_device(struct class *class, |
| 217 | struct device *start, void *data, |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 218 | int (*match)(struct device *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | |
| 220 | struct class_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 221 | struct attribute attr; |
| 222 | ssize_t (*show)(struct class *class, char *buf); |
| 223 | ssize_t (*store)(struct class *class, const char *buf, size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 224 | }; |
| 225 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 226 | #define CLASS_ATTR(_name, _mode, _show, _store) \ |
| 227 | struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 229 | extern int __must_check class_create_file(struct class *class, |
| 230 | const struct class_attribute *attr); |
| 231 | extern void class_remove_file(struct class *class, |
| 232 | const struct class_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 234 | struct class_interface { |
| 235 | struct list_head node; |
| 236 | struct class *class; |
| 237 | |
Greg Kroah-Hartman | c47ed21 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 238 | int (*add_dev) (struct device *, struct class_interface *); |
| 239 | void (*remove_dev) (struct device *, struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | }; |
| 241 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 242 | extern int __must_check class_interface_register(struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | extern void class_interface_unregister(struct class_interface *); |
| 244 | |
Miguel Ojeda Sandonis | ab7d737 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 245 | extern struct class *class_create(struct module *owner, const char *name); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 246 | extern void class_destroy(struct class *cls); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 247 | |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 248 | /* |
| 249 | * The type of device, "struct device" is embedded in. A class |
| 250 | * or bus can contain devices of different types |
| 251 | * like "partitions" and "disks", "mouse" and "event". |
| 252 | * This identifies the device type and carries type-specific |
| 253 | * information, equivalent to the kobj_type of a kobject. |
| 254 | * If "name" is specified, the uevent will contain it in |
| 255 | * the DEVTYPE variable. |
| 256 | */ |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 257 | struct device_type { |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 258 | const char *name; |
Dmitry Torokhov | 621a167 | 2007-03-10 01:37:34 -0500 | [diff] [blame] | 259 | struct attribute_group **groups; |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 260 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 261 | void (*release)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 262 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 263 | int (*suspend)(struct device *dev, pm_message_t state); |
| 264 | int (*resume)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 265 | |
| 266 | struct pm_ops *pm; |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 267 | }; |
| 268 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 269 | /* interface for exporting device attributes */ |
| 270 | struct device_attribute { |
| 271 | struct attribute attr; |
| 272 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, |
| 273 | char *buf); |
| 274 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, |
| 275 | const char *buf, size_t count); |
| 276 | }; |
| 277 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 278 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
| 279 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 280 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 281 | extern int __must_check device_create_file(struct device *device, |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 282 | struct device_attribute *entry); |
| 283 | extern void device_remove_file(struct device *dev, |
| 284 | struct device_attribute *attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 285 | extern int __must_check device_create_bin_file(struct device *dev, |
| 286 | struct bin_attribute *attr); |
| 287 | extern void device_remove_bin_file(struct device *dev, |
| 288 | struct bin_attribute *attr); |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 289 | extern int device_schedule_callback_owner(struct device *dev, |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 290 | void (*func)(struct device *dev), struct module *owner); |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 291 | |
| 292 | /* This is a macro to avoid include problems with THIS_MODULE */ |
| 293 | #define device_schedule_callback(dev, func) \ |
| 294 | device_schedule_callback_owner(dev, func, THIS_MODULE) |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 295 | |
| 296 | /* device resource management */ |
| 297 | typedef void (*dr_release_t)(struct device *dev, void *res); |
| 298 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); |
| 299 | |
| 300 | #ifdef CONFIG_DEBUG_DEVRES |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 301 | 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] | 302 | const char *name); |
| 303 | #define devres_alloc(release, size, gfp) \ |
| 304 | __devres_alloc(release, size, gfp, #release) |
| 305 | #else |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 306 | 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] | 307 | #endif |
| 308 | extern void devres_free(void *res); |
| 309 | extern void devres_add(struct device *dev, void *res); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 310 | extern void *devres_find(struct device *dev, dr_release_t release, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 311 | dr_match_t match, void *match_data); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 312 | extern void *devres_get(struct device *dev, void *new_res, |
| 313 | dr_match_t match, void *match_data); |
| 314 | extern void *devres_remove(struct device *dev, dr_release_t release, |
| 315 | dr_match_t match, void *match_data); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 316 | extern int devres_destroy(struct device *dev, dr_release_t release, |
| 317 | dr_match_t match, void *match_data); |
| 318 | |
| 319 | /* devres group */ |
| 320 | extern void * __must_check devres_open_group(struct device *dev, void *id, |
| 321 | gfp_t gfp); |
| 322 | extern void devres_close_group(struct device *dev, void *id); |
| 323 | extern void devres_remove_group(struct device *dev, void *id); |
| 324 | extern int devres_release_group(struct device *dev, void *id); |
| 325 | |
| 326 | /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */ |
| 327 | extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp); |
| 328 | extern void devm_kfree(struct device *dev, void *p); |
| 329 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 330 | struct device_dma_parameters { |
| 331 | /* |
| 332 | * a low level driver may set these to teach IOMMU code about |
| 333 | * sg limitations. |
| 334 | */ |
| 335 | unsigned int max_segment_size; |
| 336 | unsigned long segment_boundary_mask; |
| 337 | }; |
| 338 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 339 | struct device { |
mochel@digitalimplant.org | 3623957 | 2005-03-24 19:08:30 -0800 | [diff] [blame] | 340 | struct klist klist_children; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 341 | struct klist_node knode_parent; /* node in sibling list */ |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 342 | struct klist_node knode_driver; |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 343 | struct klist_node knode_bus; |
David Brownell | 49a4ec1 | 2007-05-08 00:29:39 -0700 | [diff] [blame] | 344 | struct device *parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | |
| 346 | struct kobject kobj; |
| 347 | char bus_id[BUS_ID_SIZE]; /* position on parent bus */ |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 348 | struct device_type *type; |
David Brownell | 49a4ec1 | 2007-05-08 00:29:39 -0700 | [diff] [blame] | 349 | unsigned uevent_suppress:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 350 | |
mochel@digitalimplant.org | af70316 | 2005-03-21 10:41:04 -0800 | [diff] [blame] | 351 | struct semaphore sem; /* semaphore to synchronize calls to |
| 352 | * its driver. |
| 353 | */ |
| 354 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 355 | struct bus_type *bus; /* type of bus device is on */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 356 | struct device_driver *driver; /* which driver has allocated this |
| 357 | device */ |
| 358 | void *driver_data; /* data private to the driver */ |
David Shaohua Li | 4e10d12 | 2005-03-18 18:45:35 -0500 | [diff] [blame] | 359 | void *platform_data; /* Platform specific data, device |
| 360 | core doesn't touch it */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 361 | struct dev_pm_info power; |
| 362 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 363 | #ifdef CONFIG_NUMA |
| 364 | int numa_node; /* NUMA node this device is close to */ |
| 365 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 366 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
| 367 | u64 coherent_dma_mask;/* Like dma_mask, but for |
| 368 | alloc_coherent mappings as |
| 369 | not all hardware supports |
| 370 | 64 bit addresses for consistent |
| 371 | allocations such descriptors. */ |
| 372 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 373 | struct device_dma_parameters *dma_parms; |
| 374 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 375 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
| 376 | |
| 377 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
| 378 | override */ |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 379 | /* arch specific additions */ |
| 380 | struct dev_archdata archdata; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 381 | |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 382 | spinlock_t devres_lock; |
| 383 | struct list_head devres_head; |
| 384 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 385 | struct list_head node; |
Kay Sievers | b7a3e81 | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 386 | struct class *class; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 387 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
Greg Kroah-Hartman | de0ff00 | 2006-06-27 00:06:09 -0700 | [diff] [blame] | 388 | struct attribute_group **groups; /* optional groups */ |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 389 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 390 | void (*release)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 391 | }; |
| 392 | |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 393 | /* Get the wakeup routines, which depend on struct device */ |
| 394 | #include <linux/pm_wakeup.h> |
| 395 | |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 396 | static inline const char *dev_name(struct device *dev) |
| 397 | { |
| 398 | /* will be changed into kobject_name(&dev->kobj) in the near future */ |
| 399 | return dev->bus_id; |
| 400 | } |
| 401 | |
Stephen Rothwell | 413c239 | 2008-05-30 10:16:40 +1000 | [diff] [blame] | 402 | extern int dev_set_name(struct device *dev, const char *name, ...) |
| 403 | __attribute__((format(printf, 2, 3))); |
| 404 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 405 | #ifdef CONFIG_NUMA |
| 406 | static inline int dev_to_node(struct device *dev) |
| 407 | { |
| 408 | return dev->numa_node; |
| 409 | } |
| 410 | static inline void set_dev_node(struct device *dev, int node) |
| 411 | { |
| 412 | dev->numa_node = node; |
| 413 | } |
| 414 | #else |
| 415 | static inline int dev_to_node(struct device *dev) |
| 416 | { |
| 417 | return -1; |
| 418 | } |
| 419 | static inline void set_dev_node(struct device *dev, int node) |
| 420 | { |
| 421 | } |
| 422 | #endif |
| 423 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 424 | static inline void *dev_get_drvdata(struct device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 425 | { |
| 426 | return dev->driver_data; |
| 427 | } |
| 428 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 429 | static inline void dev_set_drvdata(struct device *dev, void *data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 430 | { |
| 431 | dev->driver_data = data; |
| 432 | } |
| 433 | |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 434 | static inline int device_is_registered(struct device *dev) |
| 435 | { |
Greg Kroah-Hartman | 3f62e57 | 2008-03-13 17:07:03 -0400 | [diff] [blame] | 436 | return dev->kobj.state_in_sysfs; |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 437 | } |
| 438 | |
Adrian Bunk | 1f21782 | 2006-12-19 13:01:28 -0800 | [diff] [blame] | 439 | void driver_init(void); |
| 440 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 441 | /* |
| 442 | * High level routines for use by the bus drivers |
| 443 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 444 | extern int __must_check device_register(struct device *dev); |
| 445 | extern void device_unregister(struct device *dev); |
| 446 | extern void device_initialize(struct device *dev); |
| 447 | extern int __must_check device_add(struct device *dev); |
| 448 | extern void device_del(struct device *dev); |
| 449 | extern int device_for_each_child(struct device *dev, void *data, |
| 450 | int (*fn)(struct device *dev, void *data)); |
| 451 | extern struct device *device_find_child(struct device *dev, void *data, |
| 452 | int (*match)(struct device *dev, void *data)); |
Greg Kroah-Hartman | a2de48c | 2006-07-03 14:31:12 -0700 | [diff] [blame] | 453 | extern int device_rename(struct device *dev, char *new_name); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 454 | extern int device_move(struct device *dev, struct device *new_parent); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 455 | |
| 456 | /* |
| 457 | * Manual binding of a device to driver. See drivers/base/bus.c |
| 458 | * for information on use. |
| 459 | */ |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 460 | extern int __must_check device_bind_driver(struct device *dev); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 461 | extern void device_release_driver(struct device *dev); |
| 462 | extern int __must_check device_attach(struct device *dev); |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 463 | extern int __must_check driver_attach(struct device_driver *drv); |
| 464 | extern int __must_check device_reprobe(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 465 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 466 | /* |
| 467 | * Easy functions for dynamically creating devices on the fly |
| 468 | */ |
Greg Kroah-Hartman | 8882b39 | 2008-05-15 13:44:08 -0700 | [diff] [blame] | 469 | extern struct device *device_create_vargs(struct class *cls, |
| 470 | struct device *parent, |
| 471 | dev_t devt, |
| 472 | void *drvdata, |
| 473 | const char *fmt, |
| 474 | va_list vargs); |
Greg Kroah-Hartman | 4e10673 | 2008-07-21 20:03:34 -0700 | [diff] [blame] | 475 | extern struct device *device_create(struct class *cls, struct device *parent, |
| 476 | dev_t devt, void *drvdata, |
| 477 | const char *fmt, ...) |
Greg Kroah-Hartman | 8882b39 | 2008-05-15 13:44:08 -0700 | [diff] [blame] | 478 | __attribute__((format(printf, 5, 6))); |
Greg Kroah-Hartman | 4e10673 | 2008-07-21 20:03:34 -0700 | [diff] [blame] | 479 | #define device_create_drvdata device_create |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 480 | extern void device_destroy(struct class *cls, dev_t devt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 481 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 482 | /* |
| 483 | * Platform "fixup" functions - allow the platform to have their say |
| 484 | * about devices and actions that the general device layer doesn't |
| 485 | * know about. |
| 486 | */ |
| 487 | /* Notify platform of device discovery */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 488 | extern int (*platform_notify)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 489 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 490 | extern int (*platform_notify_remove)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 491 | |
| 492 | |
| 493 | /** |
| 494 | * get_device - atomically increment the reference count for the device. |
| 495 | * |
| 496 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 497 | extern struct device *get_device(struct device *dev); |
| 498 | extern void put_device(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 499 | |
| 500 | |
Rytchkov Alexey | 116f232b | 2006-03-22 00:58:53 +0100 | [diff] [blame] | 501 | /* drivers/base/power/shutdown.c */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 502 | extern void device_shutdown(void); |
| 503 | |
Rafael J. Wysocki | 58b3b71 | 2007-07-26 16:29:55 +0200 | [diff] [blame] | 504 | /* drivers/base/sys.c */ |
| 505 | extern void sysdev_shutdown(void); |
| 506 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 507 | /* debugging and troubleshooting/diagnostic helpers. */ |
Alan Stern | 3e95637 | 2006-06-16 17:10:48 -0400 | [diff] [blame] | 508 | extern const char *dev_driver_string(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 509 | #define dev_printk(level, dev, format, arg...) \ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 510 | printk(level "%s %s: " format , dev_driver_string(dev) , \ |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 511 | dev_name(dev) , ## arg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 512 | |
Emil Medve | 7b8712e | 2007-10-30 14:37:14 -0500 | [diff] [blame] | 513 | #define dev_emerg(dev, format, arg...) \ |
| 514 | dev_printk(KERN_EMERG , dev , format , ## arg) |
| 515 | #define dev_alert(dev, format, arg...) \ |
| 516 | dev_printk(KERN_ALERT , dev , format , ## arg) |
| 517 | #define dev_crit(dev, format, arg...) \ |
| 518 | dev_printk(KERN_CRIT , dev , format , ## arg) |
| 519 | #define dev_err(dev, format, arg...) \ |
| 520 | dev_printk(KERN_ERR , dev , format , ## arg) |
| 521 | #define dev_warn(dev, format, arg...) \ |
| 522 | dev_printk(KERN_WARNING , dev , format , ## arg) |
| 523 | #define dev_notice(dev, format, arg...) \ |
| 524 | dev_printk(KERN_NOTICE , dev , format , ## arg) |
| 525 | #define dev_info(dev, format, arg...) \ |
| 526 | dev_printk(KERN_INFO , dev , format , ## arg) |
| 527 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 528 | #ifdef DEBUG |
| 529 | #define dev_dbg(dev, format, arg...) \ |
| 530 | dev_printk(KERN_DEBUG , dev , format , ## arg) |
| 531 | #else |
Joe Perches | 1429db8 | 2008-02-26 19:08:42 -0800 | [diff] [blame] | 532 | #define dev_dbg(dev, format, arg...) \ |
| 533 | ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; }) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 534 | #endif |
| 535 | |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 536 | #ifdef VERBOSE_DEBUG |
| 537 | #define dev_vdbg dev_dbg |
| 538 | #else |
Joe Perches | 1429db8 | 2008-02-26 19:08:42 -0800 | [diff] [blame] | 539 | |
| 540 | #define dev_vdbg(dev, format, arg...) \ |
| 541 | ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; }) |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 542 | #endif |
| 543 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 544 | /* Create alias, so I can be autoloaded. */ |
| 545 | #define MODULE_ALIAS_CHARDEV(major,minor) \ |
| 546 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) |
| 547 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ |
| 548 | MODULE_ALIAS("char-major-" __stringify(major) "-*") |
| 549 | #endif /* _DEVICE_H_ */ |