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> |
| 5 | * |
| 6 | * This file is released under the GPLv2 |
| 7 | * |
| 8 | * See Documentation/driver-model/ for more information. |
| 9 | */ |
| 10 | |
| 11 | #ifndef _DEVICE_H_ |
| 12 | #define _DEVICE_H_ |
| 13 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | #include <linux/ioport.h> |
| 15 | #include <linux/kobject.h> |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 16 | #include <linux/klist.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | #include <linux/list.h> |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 18 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 19 | #include <linux/types.h> |
| 20 | #include <linux/module.h> |
| 21 | #include <linux/pm.h> |
| 22 | #include <asm/semaphore.h> |
| 23 | #include <asm/atomic.h> |
| 24 | |
| 25 | #define DEVICE_NAME_SIZE 50 |
| 26 | #define DEVICE_NAME_HALF __stringify(20) /* Less than half to accommodate slop */ |
| 27 | #define DEVICE_ID_SIZE 32 |
| 28 | #define BUS_ID_SIZE KOBJ_NAME_LEN |
| 29 | |
| 30 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | struct device; |
| 32 | struct device_driver; |
| 33 | struct class; |
| 34 | struct class_device; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | |
| 36 | struct bus_type { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 37 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
| 39 | struct subsystem subsys; |
| 40 | struct kset drivers; |
| 41 | struct kset devices; |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 42 | struct klist klist_devices; |
mochel@digitalimplant.org | 38fdac3 | 2005-03-21 12:00:18 -0800 | [diff] [blame] | 43 | struct klist klist_drivers; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | |
| 45 | struct bus_attribute * bus_attrs; |
| 46 | struct device_attribute * dev_attrs; |
| 47 | struct driver_attribute * drv_attrs; |
| 48 | |
| 49 | int (*match)(struct device * dev, struct device_driver * drv); |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 50 | int (*uevent)(struct device *dev, char **envp, |
| 51 | int num_envp, char *buffer, int buffer_size); |
Russell King | 594c828 | 2006-01-05 14:29:51 +0000 | [diff] [blame] | 52 | int (*probe)(struct device * dev); |
| 53 | int (*remove)(struct device * dev); |
| 54 | void (*shutdown)(struct device * dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 55 | |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 56 | int (*suspend)(struct device * dev, pm_message_t state); |
| 57 | int (*suspend_late)(struct device * dev, pm_message_t state); |
| 58 | int (*resume_early)(struct device * dev); |
| 59 | int (*resume)(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 62 | extern int __must_check bus_register(struct bus_type * bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | extern void bus_unregister(struct bus_type * bus); |
| 64 | |
Greg Kroah-Hartman | 23d3d60 | 2005-06-22 16:09:05 -0700 | [diff] [blame] | 65 | extern void bus_rescan_devices(struct bus_type * bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | /* iterator helpers for buses */ |
| 68 | |
| 69 | int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data, |
| 70 | int (*fn)(struct device *, void *)); |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 71 | struct device * bus_find_device(struct bus_type *bus, struct device *start, |
| 72 | void *data, int (*match)(struct device *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 74 | int __must_check bus_for_each_drv(struct bus_type *bus, |
| 75 | struct device_driver *start, void *data, |
| 76 | int (*fn)(struct device_driver *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | |
| 78 | /* driverfs interface for exporting bus attributes */ |
| 79 | |
| 80 | struct bus_attribute { |
| 81 | struct attribute attr; |
| 82 | ssize_t (*show)(struct bus_type *, char * buf); |
| 83 | ssize_t (*store)(struct bus_type *, const char * buf, size_t count); |
| 84 | }; |
| 85 | |
| 86 | #define BUS_ATTR(_name,_mode,_show,_store) \ |
| 87 | struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 88 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 89 | extern int __must_check bus_create_file(struct bus_type *, |
| 90 | struct bus_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
| 92 | |
| 93 | struct device_driver { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 94 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | struct bus_type * bus; |
| 96 | |
| 97 | struct completion unloaded; |
| 98 | struct kobject kobj; |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 99 | struct klist klist_devices; |
mochel@digitalimplant.org | 38fdac3 | 2005-03-21 12:00:18 -0800 | [diff] [blame] | 100 | struct klist_node knode_bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 102 | struct module * owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | |
| 104 | int (*probe) (struct device * dev); |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 105 | int (*remove) (struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | void (*shutdown) (struct device * dev); |
Russell King | 9480e30 | 2005-10-28 09:52:56 -0700 | [diff] [blame] | 107 | int (*suspend) (struct device * dev, pm_message_t state); |
| 108 | int (*resume) (struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | }; |
| 110 | |
| 111 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 112 | extern int __must_check driver_register(struct device_driver * drv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | extern void driver_unregister(struct device_driver * drv); |
| 114 | |
| 115 | extern struct device_driver * get_driver(struct device_driver * drv); |
| 116 | extern void put_driver(struct device_driver * drv); |
| 117 | extern struct device_driver *driver_find(const char *name, struct bus_type *bus); |
| 118 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | /* driverfs interface for exporting driver attributes */ |
| 120 | |
| 121 | struct driver_attribute { |
| 122 | struct attribute attr; |
| 123 | ssize_t (*show)(struct device_driver *, char * buf); |
| 124 | ssize_t (*store)(struct device_driver *, const char * buf, size_t count); |
| 125 | }; |
| 126 | |
| 127 | #define DRIVER_ATTR(_name,_mode,_show,_store) \ |
| 128 | struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 129 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 130 | extern int __must_check driver_create_file(struct device_driver *, |
| 131 | struct driver_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | extern void driver_remove_file(struct device_driver *, struct driver_attribute *); |
| 133 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 134 | extern int __must_check driver_for_each_device(struct device_driver * drv, |
| 135 | struct device *start, void *data, |
| 136 | int (*fn)(struct device *, void *)); |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 137 | struct device * driver_find_device(struct device_driver *drv, |
| 138 | struct device *start, void *data, |
| 139 | int (*match)(struct device *, void *)); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 140 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | /* |
| 142 | * device classes |
| 143 | */ |
| 144 | struct class { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 145 | const char * name; |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 146 | struct module * owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | |
| 148 | struct subsystem subsys; |
| 149 | struct list_head children; |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 150 | struct list_head devices; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | struct list_head interfaces; |
| 152 | struct semaphore sem; /* locks both the children and interfaces lists */ |
| 153 | |
Greg Kroah-Hartman | c205ef4 | 2006-08-07 22:19:37 -0700 | [diff] [blame] | 154 | struct kobject *virtual_dir; |
| 155 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | struct class_attribute * class_attrs; |
| 157 | struct class_device_attribute * class_dev_attrs; |
Greg Kroah-Hartman | 2620efe | 2006-06-28 16:19:58 -0700 | [diff] [blame] | 158 | struct device_attribute * dev_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 160 | int (*uevent)(struct class_device *dev, char **envp, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | int num_envp, char *buffer, int buffer_size); |
Greg Kroah-Hartman | 2620efe | 2006-06-28 16:19:58 -0700 | [diff] [blame] | 162 | int (*dev_uevent)(struct device *dev, char **envp, int num_envp, |
| 163 | char *buffer, int buffer_size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | |
| 165 | void (*release)(struct class_device *dev); |
| 166 | void (*class_release)(struct class *class); |
Greg Kroah-Hartman | 2620efe | 2006-06-28 16:19:58 -0700 | [diff] [blame] | 167 | void (*dev_release)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 168 | |
| 169 | int (*suspend)(struct device *, pm_message_t state); |
| 170 | int (*resume)(struct device *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | }; |
| 172 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 173 | extern int __must_check class_register(struct class *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | extern void class_unregister(struct class *); |
| 175 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | |
| 177 | struct class_attribute { |
| 178 | struct attribute attr; |
| 179 | ssize_t (*show)(struct class *, char * buf); |
| 180 | ssize_t (*store)(struct class *, const char * buf, size_t count); |
| 181 | }; |
| 182 | |
| 183 | #define CLASS_ATTR(_name,_mode,_show,_store) \ |
| 184 | struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 185 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 186 | extern int __must_check class_create_file(struct class *, |
| 187 | const struct class_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | extern void class_remove_file(struct class *, const struct class_attribute *); |
| 189 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 190 | struct class_device_attribute { |
| 191 | struct attribute attr; |
| 192 | ssize_t (*show)(struct class_device *, char * buf); |
| 193 | ssize_t (*store)(struct class_device *, const char * buf, size_t count); |
| 194 | }; |
| 195 | |
| 196 | #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \ |
| 197 | struct class_device_attribute class_device_attr_##_name = \ |
| 198 | __ATTR(_name,_mode,_show,_store) |
| 199 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 200 | extern int __must_check class_device_create_file(struct class_device *, |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 201 | const struct class_device_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | |
Greg Kroah-Hartman | 74be227 | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 203 | /** |
| 204 | * struct class_device - class devices |
| 205 | * @class: pointer to the parent class for this class device. This is required. |
| 206 | * @devt: for internal use by the driver core only. |
| 207 | * @node: for internal use by the driver core only. |
| 208 | * @kobj: for internal use by the driver core only. |
| 209 | * @devt_attr: for internal use by the driver core only. |
Stephen Hemminger | 1498221 | 2006-05-06 17:55:11 -0700 | [diff] [blame] | 210 | * @groups: optional additional groups to be created |
Greg Kroah-Hartman | 74be227 | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 211 | * @dev: if set, a symlink to the struct device is created in the sysfs |
| 212 | * directory for this struct class device. |
| 213 | * @class_data: pointer to whatever you want to store here for this struct |
| 214 | * class_device. Use class_get_devdata() and class_set_devdata() to get and |
| 215 | * set this pointer. |
| 216 | * @parent: pointer to a struct class_device that is the parent of this struct |
| 217 | * class_device. If NULL, this class_device will show up at the root of the |
| 218 | * struct class in sysfs (which is probably what you want to have happen.) |
| 219 | * @release: pointer to a release function for this struct class_device. If |
| 220 | * set, this will be called instead of the class specific release function. |
| 221 | * Only use this if you want to override the default release function, like |
| 222 | * when you are nesting class_device structures. |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 223 | * @uevent: pointer to a uevent function for this struct class_device. If |
| 224 | * set, this will be called instead of the class specific uevent function. |
| 225 | * Only use this if you want to override the default uevent function, like |
Greg Kroah-Hartman | 74be227 | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 226 | * when you are nesting class_device structures. |
| 227 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | struct class_device { |
| 229 | struct list_head node; |
| 230 | |
| 231 | struct kobject kobj; |
| 232 | struct class * class; /* required */ |
| 233 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 234 | struct class_device_attribute *devt_attr; |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 235 | struct class_device_attribute uevent_attr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | struct device * dev; /* not necessary, but nice to have */ |
| 237 | void * class_data; /* class-specific data */ |
Greg Kroah-Hartman | 51d172d | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 238 | struct class_device *parent; /* parent of this child device, if there is one */ |
Stephen Hemminger | 1498221 | 2006-05-06 17:55:11 -0700 | [diff] [blame] | 239 | struct attribute_group ** groups; /* optional groups */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | |
Greg Kroah-Hartman | 51d172d | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 241 | void (*release)(struct class_device *dev); |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 242 | int (*uevent)(struct class_device *dev, char **envp, |
Greg Kroah-Hartman | 51d172d | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 243 | int num_envp, char *buffer, int buffer_size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | char class_id[BUS_ID_SIZE]; /* unique to this class */ |
| 245 | }; |
| 246 | |
| 247 | static inline void * |
| 248 | class_get_devdata (struct class_device *dev) |
| 249 | { |
| 250 | return dev->class_data; |
| 251 | } |
| 252 | |
| 253 | static inline void |
| 254 | class_set_devdata (struct class_device *dev, void *data) |
| 255 | { |
| 256 | dev->class_data = data; |
| 257 | } |
| 258 | |
| 259 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 260 | extern int __must_check class_device_register(struct class_device *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 261 | extern void class_device_unregister(struct class_device *); |
| 262 | extern void class_device_initialize(struct class_device *); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 263 | extern int __must_check class_device_add(struct class_device *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 264 | extern void class_device_del(struct class_device *); |
| 265 | |
| 266 | extern int class_device_rename(struct class_device *, char *); |
| 267 | |
| 268 | extern struct class_device * class_device_get(struct class_device *); |
| 269 | extern void class_device_put(struct class_device *); |
| 270 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 271 | extern void class_device_remove_file(struct class_device *, |
| 272 | const struct class_device_attribute *); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 273 | extern int __must_check class_device_create_bin_file(struct class_device *, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | struct bin_attribute *); |
| 275 | extern void class_device_remove_bin_file(struct class_device *, |
| 276 | struct bin_attribute *); |
| 277 | |
| 278 | struct class_interface { |
| 279 | struct list_head node; |
| 280 | struct class *class; |
| 281 | |
Dmitry Torokhov | d8539d8 | 2005-09-15 02:01:36 -0500 | [diff] [blame] | 282 | int (*add) (struct class_device *, struct class_interface *); |
| 283 | void (*remove) (struct class_device *, struct class_interface *); |
Greg Kroah-Hartman | c47ed21 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 284 | int (*add_dev) (struct device *, struct class_interface *); |
| 285 | void (*remove_dev) (struct device *, struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 286 | }; |
| 287 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 288 | extern int __must_check class_interface_register(struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 289 | extern void class_interface_unregister(struct class_interface *); |
| 290 | |
Miguel Ojeda Sandonis | ab7d737 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 291 | extern struct class *class_create(struct module *owner, const char *name); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 292 | extern void class_destroy(struct class *cls); |
Greg Kroah-Hartman | 51d172d | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 293 | extern struct class_device *class_device_create(struct class *cls, |
| 294 | struct class_device *parent, |
| 295 | dev_t devt, |
| 296 | struct device *device, |
Dmitry Torokhov | ddd5d35 | 2006-08-10 01:18:18 -0400 | [diff] [blame] | 297 | const char *fmt, ...) |
Greg Kroah-Hartman | 51d172d | 2005-10-27 22:25:43 -0700 | [diff] [blame] | 298 | __attribute__((format(printf,5,6))); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 299 | extern void class_device_destroy(struct class *cls, dev_t devt); |
| 300 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 301 | /* interface for exporting device attributes */ |
| 302 | struct device_attribute { |
| 303 | struct attribute attr; |
| 304 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, |
| 305 | char *buf); |
| 306 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, |
| 307 | const char *buf, size_t count); |
| 308 | }; |
| 309 | |
| 310 | #define DEVICE_ATTR(_name,_mode,_show,_store) \ |
| 311 | struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 312 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 313 | extern int __must_check device_create_file(struct device *device, |
| 314 | struct device_attribute * entry); |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 315 | extern void device_remove_file(struct device * dev, struct device_attribute * attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 316 | extern int __must_check device_create_bin_file(struct device *dev, |
| 317 | struct bin_attribute *attr); |
| 318 | extern void device_remove_bin_file(struct device *dev, |
| 319 | struct bin_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 320 | struct device { |
mochel@digitalimplant.org | 3623957 | 2005-03-24 19:08:30 -0800 | [diff] [blame] | 321 | struct klist klist_children; |
| 322 | struct klist_node knode_parent; /* node in sibling list */ |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 323 | struct klist_node knode_driver; |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 324 | struct klist_node knode_bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 325 | struct device * parent; |
| 326 | |
| 327 | struct kobject kobj; |
| 328 | char bus_id[BUS_ID_SIZE]; /* position on parent bus */ |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 329 | struct device_attribute uevent_attr; |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 330 | struct device_attribute *devt_attr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 331 | |
mochel@digitalimplant.org | af70316 | 2005-03-21 10:41:04 -0800 | [diff] [blame] | 332 | struct semaphore sem; /* semaphore to synchronize calls to |
| 333 | * its driver. |
| 334 | */ |
| 335 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 336 | struct bus_type * bus; /* type of bus device is on */ |
| 337 | struct device_driver *driver; /* which driver has allocated this |
| 338 | device */ |
| 339 | void *driver_data; /* data private to the driver */ |
David Shaohua Li | 4e10d12 | 2005-03-18 18:45:35 -0500 | [diff] [blame] | 340 | void *platform_data; /* Platform specific data, device |
| 341 | core doesn't touch it */ |
| 342 | void *firmware_data; /* Firmware specific data (e.g. ACPI, |
| 343 | BIOS data),reserved for device core*/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 344 | struct dev_pm_info power; |
| 345 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 346 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
| 347 | u64 coherent_dma_mask;/* Like dma_mask, but for |
| 348 | alloc_coherent mappings as |
| 349 | not all hardware supports |
| 350 | 64 bit addresses for consistent |
| 351 | allocations such descriptors. */ |
| 352 | |
| 353 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
| 354 | |
| 355 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
| 356 | override */ |
| 357 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 358 | /* class_device migration path */ |
| 359 | struct list_head node; |
| 360 | struct class *class; /* optional*/ |
| 361 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
Greg Kroah-Hartman | de0ff00 | 2006-06-27 00:06:09 -0700 | [diff] [blame] | 362 | struct attribute_group **groups; /* optional groups */ |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 363 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 364 | void (*release)(struct device * dev); |
| 365 | }; |
| 366 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 367 | static inline void * |
| 368 | dev_get_drvdata (struct device *dev) |
| 369 | { |
| 370 | return dev->driver_data; |
| 371 | } |
| 372 | |
| 373 | static inline void |
| 374 | dev_set_drvdata (struct device *dev, void *data) |
| 375 | { |
| 376 | dev->driver_data = data; |
| 377 | } |
| 378 | |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 379 | static inline int device_is_registered(struct device *dev) |
| 380 | { |
| 381 | return klist_node_attached(&dev->knode_bus); |
| 382 | } |
| 383 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 384 | /* |
| 385 | * High level routines for use by the bus drivers |
| 386 | */ |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 387 | extern int __must_check device_register(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 388 | extern void device_unregister(struct device * dev); |
| 389 | extern void device_initialize(struct device * dev); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 390 | extern int __must_check device_add(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 391 | extern void device_del(struct device * dev); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 392 | extern int __must_check device_for_each_child(struct device *, void *, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 393 | int (*fn)(struct device *, void *)); |
Greg Kroah-Hartman | a2de48c | 2006-07-03 14:31:12 -0700 | [diff] [blame] | 394 | extern int device_rename(struct device *dev, char *new_name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 395 | |
| 396 | /* |
| 397 | * Manual binding of a device to driver. See drivers/base/bus.c |
| 398 | * for information on use. |
| 399 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 400 | extern void device_bind_driver(struct device * dev); |
| 401 | extern void device_release_driver(struct device * dev); |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 402 | extern int __must_check device_attach(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 403 | extern void driver_attach(struct device_driver * drv); |
Moore, Eric | e935d5d | 2006-03-14 09:18:18 -0700 | [diff] [blame] | 404 | extern void device_reprobe(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 406 | /* |
| 407 | * Easy functions for dynamically creating devices on the fly |
| 408 | */ |
| 409 | extern struct device *device_create(struct class *cls, struct device *parent, |
Greg Kroah-Hartman | 5cbe5f8 | 2006-08-10 01:19:19 -0400 | [diff] [blame] | 410 | dev_t devt, const char *fmt, ...) |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 411 | __attribute__((format(printf,4,5))); |
| 412 | extern void device_destroy(struct class *cls, dev_t devt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 413 | |
Greg Kroah-Hartman | c205ef4 | 2006-08-07 22:19:37 -0700 | [diff] [blame] | 414 | extern int virtual_device_parent(struct device *dev); |
| 415 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 416 | /* |
| 417 | * Platform "fixup" functions - allow the platform to have their say |
| 418 | * about devices and actions that the general device layer doesn't |
| 419 | * know about. |
| 420 | */ |
| 421 | /* Notify platform of device discovery */ |
| 422 | extern int (*platform_notify)(struct device * dev); |
| 423 | |
| 424 | extern int (*platform_notify_remove)(struct device * dev); |
| 425 | |
| 426 | |
| 427 | /** |
| 428 | * get_device - atomically increment the reference count for the device. |
| 429 | * |
| 430 | */ |
| 431 | extern struct device * get_device(struct device * dev); |
| 432 | extern void put_device(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 433 | |
| 434 | |
Rytchkov Alexey | 116f232b | 2006-03-22 00:58:53 +0100 | [diff] [blame] | 435 | /* drivers/base/power/shutdown.c */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 436 | extern void device_shutdown(void); |
| 437 | |
| 438 | |
| 439 | /* drivers/base/firmware.c */ |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame^] | 440 | extern int __must_check firmware_register(struct subsystem *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 441 | extern void firmware_unregister(struct subsystem *); |
| 442 | |
| 443 | /* debugging and troubleshooting/diagnostic helpers. */ |
Alan Stern | 3e95637 | 2006-06-16 17:10:48 -0400 | [diff] [blame] | 444 | extern const char *dev_driver_string(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 445 | #define dev_printk(level, dev, format, arg...) \ |
Alan Stern | 3e95637 | 2006-06-16 17:10:48 -0400 | [diff] [blame] | 446 | printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 447 | |
| 448 | #ifdef DEBUG |
| 449 | #define dev_dbg(dev, format, arg...) \ |
| 450 | dev_printk(KERN_DEBUG , dev , format , ## arg) |
| 451 | #else |
| 452 | #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0) |
| 453 | #endif |
| 454 | |
| 455 | #define dev_err(dev, format, arg...) \ |
| 456 | dev_printk(KERN_ERR , dev , format , ## arg) |
| 457 | #define dev_info(dev, format, arg...) \ |
| 458 | dev_printk(KERN_INFO , dev , format , ## arg) |
| 459 | #define dev_warn(dev, format, arg...) \ |
| 460 | dev_printk(KERN_WARNING , dev , format , ## arg) |
Tilman Schmidt | 4f2928d | 2006-02-24 11:05:45 +0100 | [diff] [blame] | 461 | #define dev_notice(dev, format, arg...) \ |
| 462 | dev_printk(KERN_NOTICE , dev , format , ## arg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 463 | |
| 464 | /* Create alias, so I can be autoloaded. */ |
| 465 | #define MODULE_ALIAS_CHARDEV(major,minor) \ |
| 466 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) |
| 467 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ |
| 468 | MODULE_ALIAS("char-major-" __stringify(major) "-*") |
| 469 | #endif /* _DEVICE_H_ */ |