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