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 | |
| 14 | #include <linux/config.h> |
| 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> |
| 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 | |
| 31 | enum { |
| 32 | SUSPEND_NOTIFY, |
| 33 | SUSPEND_SAVE_STATE, |
| 34 | SUSPEND_DISABLE, |
| 35 | SUSPEND_POWER_DOWN, |
| 36 | }; |
| 37 | |
| 38 | enum { |
| 39 | RESUME_POWER_ON, |
| 40 | RESUME_RESTORE_STATE, |
| 41 | RESUME_ENABLE, |
| 42 | }; |
| 43 | |
| 44 | struct device; |
| 45 | struct device_driver; |
| 46 | struct class; |
| 47 | struct class_device; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | |
| 49 | struct bus_type { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 50 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | |
| 52 | struct subsystem subsys; |
| 53 | struct kset drivers; |
| 54 | struct kset devices; |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 55 | struct klist klist_devices; |
mochel@digitalimplant.org | 38fdac3 | 2005-03-21 12:00:18 -0800 | [diff] [blame] | 56 | struct klist klist_drivers; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | |
| 58 | struct bus_attribute * bus_attrs; |
| 59 | struct device_attribute * dev_attrs; |
| 60 | struct driver_attribute * drv_attrs; |
| 61 | |
| 62 | int (*match)(struct device * dev, struct device_driver * drv); |
| 63 | int (*hotplug) (struct device *dev, char **envp, |
| 64 | int num_envp, char *buffer, int buffer_size); |
| 65 | int (*suspend)(struct device * dev, pm_message_t state); |
| 66 | int (*resume)(struct device * dev); |
| 67 | }; |
| 68 | |
| 69 | extern int bus_register(struct bus_type * bus); |
| 70 | extern void bus_unregister(struct bus_type * bus); |
| 71 | |
Greg Kroah-Hartman | 23d3d60 | 2005-06-22 16:09:05 -0700 | [diff] [blame^] | 72 | extern void bus_rescan_devices(struct bus_type * bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
| 74 | extern struct bus_type * get_bus(struct bus_type * bus); |
| 75 | extern void put_bus(struct bus_type * bus); |
| 76 | |
| 77 | extern struct bus_type * find_bus(char * name); |
| 78 | |
| 79 | /* iterator helpers for buses */ |
| 80 | |
| 81 | int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data, |
| 82 | int (*fn)(struct device *, void *)); |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 83 | struct device * bus_find_device(struct bus_type *bus, struct device *start, |
| 84 | void *data, int (*match)(struct device *, void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | |
| 86 | int bus_for_each_drv(struct bus_type * bus, struct device_driver * start, |
| 87 | void * data, int (*fn)(struct device_driver *, void *)); |
| 88 | |
| 89 | |
| 90 | /* driverfs interface for exporting bus attributes */ |
| 91 | |
| 92 | struct bus_attribute { |
| 93 | struct attribute attr; |
| 94 | ssize_t (*show)(struct bus_type *, char * buf); |
| 95 | ssize_t (*store)(struct bus_type *, const char * buf, size_t count); |
| 96 | }; |
| 97 | |
| 98 | #define BUS_ATTR(_name,_mode,_show,_store) \ |
| 99 | struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 100 | |
| 101 | extern int bus_create_file(struct bus_type *, struct bus_attribute *); |
| 102 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
| 103 | |
| 104 | struct device_driver { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 105 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | struct bus_type * bus; |
| 107 | |
| 108 | struct completion unloaded; |
| 109 | struct kobject kobj; |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 110 | struct klist klist_devices; |
mochel@digitalimplant.org | 38fdac3 | 2005-03-21 12:00:18 -0800 | [diff] [blame] | 111 | struct klist_node knode_bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 113 | struct module * owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | |
| 115 | int (*probe) (struct device * dev); |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 116 | int (*remove) (struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | void (*shutdown) (struct device * dev); |
| 118 | int (*suspend) (struct device * dev, pm_message_t state, u32 level); |
| 119 | int (*resume) (struct device * dev, u32 level); |
| 120 | }; |
| 121 | |
| 122 | |
| 123 | extern int driver_register(struct device_driver * drv); |
| 124 | extern void driver_unregister(struct device_driver * drv); |
| 125 | |
| 126 | extern struct device_driver * get_driver(struct device_driver * drv); |
| 127 | extern void put_driver(struct device_driver * drv); |
| 128 | extern struct device_driver *driver_find(const char *name, struct bus_type *bus); |
| 129 | |
| 130 | |
| 131 | /* driverfs interface for exporting driver attributes */ |
| 132 | |
| 133 | struct driver_attribute { |
| 134 | struct attribute attr; |
| 135 | ssize_t (*show)(struct device_driver *, char * buf); |
| 136 | ssize_t (*store)(struct device_driver *, const char * buf, size_t count); |
| 137 | }; |
| 138 | |
| 139 | #define DRIVER_ATTR(_name,_mode,_show,_store) \ |
| 140 | struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 141 | |
| 142 | extern int driver_create_file(struct device_driver *, struct driver_attribute *); |
| 143 | extern void driver_remove_file(struct device_driver *, struct driver_attribute *); |
| 144 | |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 145 | extern int driver_for_each_device(struct device_driver * drv, struct device * start, |
| 146 | void * data, int (*fn)(struct device *, void *)); |
Cornelia Huck | 0edb586 | 2005-06-22 16:59:51 +0200 | [diff] [blame] | 147 | struct device * driver_find_device(struct device_driver *drv, |
| 148 | struct device *start, void *data, |
| 149 | int (*match)(struct device *, void *)); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 150 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
| 152 | /* |
| 153 | * device classes |
| 154 | */ |
| 155 | struct class { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 156 | const char * name; |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 157 | struct module * owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | |
| 159 | struct subsystem subsys; |
| 160 | struct list_head children; |
| 161 | struct list_head interfaces; |
| 162 | struct semaphore sem; /* locks both the children and interfaces lists */ |
| 163 | |
| 164 | struct class_attribute * class_attrs; |
| 165 | struct class_device_attribute * class_dev_attrs; |
| 166 | |
| 167 | int (*hotplug)(struct class_device *dev, char **envp, |
| 168 | int num_envp, char *buffer, int buffer_size); |
| 169 | |
| 170 | void (*release)(struct class_device *dev); |
| 171 | void (*class_release)(struct class *class); |
| 172 | }; |
| 173 | |
| 174 | extern int class_register(struct class *); |
| 175 | extern void class_unregister(struct class *); |
| 176 | |
| 177 | extern struct class * class_get(struct class *); |
| 178 | extern void class_put(struct class *); |
| 179 | |
| 180 | |
| 181 | struct class_attribute { |
| 182 | struct attribute attr; |
| 183 | ssize_t (*show)(struct class *, char * buf); |
| 184 | ssize_t (*store)(struct class *, const char * buf, size_t count); |
| 185 | }; |
| 186 | |
| 187 | #define CLASS_ATTR(_name,_mode,_show,_store) \ |
| 188 | struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 189 | |
| 190 | extern int class_create_file(struct class *, const struct class_attribute *); |
| 191 | extern void class_remove_file(struct class *, const struct class_attribute *); |
| 192 | |
| 193 | |
| 194 | struct class_device { |
| 195 | struct list_head node; |
| 196 | |
| 197 | struct kobject kobj; |
| 198 | struct class * class; /* required */ |
| 199 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 200 | struct class_device_attribute *devt_attr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | struct device * dev; /* not necessary, but nice to have */ |
| 202 | void * class_data; /* class-specific data */ |
| 203 | |
| 204 | char class_id[BUS_ID_SIZE]; /* unique to this class */ |
| 205 | }; |
| 206 | |
| 207 | static inline void * |
| 208 | class_get_devdata (struct class_device *dev) |
| 209 | { |
| 210 | return dev->class_data; |
| 211 | } |
| 212 | |
| 213 | static inline void |
| 214 | class_set_devdata (struct class_device *dev, void *data) |
| 215 | { |
| 216 | dev->class_data = data; |
| 217 | } |
| 218 | |
| 219 | |
| 220 | extern int class_device_register(struct class_device *); |
| 221 | extern void class_device_unregister(struct class_device *); |
| 222 | extern void class_device_initialize(struct class_device *); |
| 223 | extern int class_device_add(struct class_device *); |
| 224 | extern void class_device_del(struct class_device *); |
| 225 | |
| 226 | extern int class_device_rename(struct class_device *, char *); |
| 227 | |
| 228 | extern struct class_device * class_device_get(struct class_device *); |
| 229 | extern void class_device_put(struct class_device *); |
| 230 | |
| 231 | struct class_device_attribute { |
| 232 | struct attribute attr; |
| 233 | ssize_t (*show)(struct class_device *, char * buf); |
| 234 | ssize_t (*store)(struct class_device *, const char * buf, size_t count); |
| 235 | }; |
| 236 | |
| 237 | #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \ |
| 238 | struct class_device_attribute class_device_attr_##_name = \ |
| 239 | __ATTR(_name,_mode,_show,_store) |
| 240 | |
| 241 | extern int class_device_create_file(struct class_device *, |
| 242 | const struct class_device_attribute *); |
| 243 | extern void class_device_remove_file(struct class_device *, |
| 244 | const struct class_device_attribute *); |
| 245 | extern int class_device_create_bin_file(struct class_device *, |
| 246 | struct bin_attribute *); |
| 247 | extern void class_device_remove_bin_file(struct class_device *, |
| 248 | struct bin_attribute *); |
| 249 | |
| 250 | struct class_interface { |
| 251 | struct list_head node; |
| 252 | struct class *class; |
| 253 | |
| 254 | int (*add) (struct class_device *); |
| 255 | void (*remove) (struct class_device *); |
| 256 | }; |
| 257 | |
| 258 | extern int class_interface_register(struct class_interface *); |
| 259 | extern void class_interface_unregister(struct class_interface *); |
| 260 | |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 261 | extern struct class *class_create(struct module *owner, char *name); |
| 262 | extern void class_destroy(struct class *cls); |
| 263 | extern struct class_device *class_device_create(struct class *cls, dev_t devt, |
| 264 | struct device *device, char *fmt, ...) |
| 265 | __attribute__((format(printf,4,5))); |
| 266 | extern void class_device_destroy(struct class *cls, dev_t devt); |
| 267 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 268 | |
| 269 | struct device { |
mochel@digitalimplant.org | 3623957 | 2005-03-24 19:08:30 -0800 | [diff] [blame] | 270 | struct klist klist_children; |
| 271 | struct klist_node knode_parent; /* node in sibling list */ |
mochel@digitalimplant.org | 94e7b1c5 | 2005-03-21 12:25:36 -0800 | [diff] [blame] | 272 | struct klist_node knode_driver; |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 273 | struct klist_node knode_bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | struct device * parent; |
| 275 | |
| 276 | struct kobject kobj; |
| 277 | char bus_id[BUS_ID_SIZE]; /* position on parent bus */ |
| 278 | |
mochel@digitalimplant.org | af70316 | 2005-03-21 10:41:04 -0800 | [diff] [blame] | 279 | struct semaphore sem; /* semaphore to synchronize calls to |
| 280 | * its driver. |
| 281 | */ |
| 282 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | struct bus_type * bus; /* type of bus device is on */ |
| 284 | struct device_driver *driver; /* which driver has allocated this |
| 285 | device */ |
| 286 | void *driver_data; /* data private to the driver */ |
| 287 | void *platform_data; /* Platform specific data (e.g. ACPI, |
| 288 | BIOS data relevant to device) */ |
| 289 | struct dev_pm_info power; |
| 290 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
| 292 | u64 coherent_dma_mask;/* Like dma_mask, but for |
| 293 | alloc_coherent mappings as |
| 294 | not all hardware supports |
| 295 | 64 bit addresses for consistent |
| 296 | allocations such descriptors. */ |
| 297 | |
| 298 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
| 299 | |
| 300 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
| 301 | override */ |
| 302 | |
| 303 | void (*release)(struct device * dev); |
| 304 | }; |
| 305 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 306 | static inline void * |
| 307 | dev_get_drvdata (struct device *dev) |
| 308 | { |
| 309 | return dev->driver_data; |
| 310 | } |
| 311 | |
| 312 | static inline void |
| 313 | dev_set_drvdata (struct device *dev, void *data) |
| 314 | { |
| 315 | dev->driver_data = data; |
| 316 | } |
| 317 | |
| 318 | /* |
| 319 | * High level routines for use by the bus drivers |
| 320 | */ |
| 321 | extern int device_register(struct device * dev); |
| 322 | extern void device_unregister(struct device * dev); |
| 323 | extern void device_initialize(struct device * dev); |
| 324 | extern int device_add(struct device * dev); |
| 325 | extern void device_del(struct device * dev); |
| 326 | extern int device_for_each_child(struct device *, void *, |
| 327 | int (*fn)(struct device *, void *)); |
| 328 | |
| 329 | /* |
| 330 | * Manual binding of a device to driver. See drivers/base/bus.c |
| 331 | * for information on use. |
| 332 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 333 | extern void device_bind_driver(struct device * dev); |
| 334 | extern void device_release_driver(struct device * dev); |
| 335 | extern int device_attach(struct device * dev); |
| 336 | extern void driver_attach(struct device_driver * drv); |
| 337 | |
| 338 | |
| 339 | /* driverfs interface for exporting device attributes */ |
| 340 | |
| 341 | struct device_attribute { |
| 342 | struct attribute attr; |
Yani Ioannou | 54b6f35 | 2005-05-17 06:39:34 -0400 | [diff] [blame] | 343 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, |
| 344 | char *buf); |
| 345 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, |
| 346 | const char *buf, size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 347 | }; |
| 348 | |
| 349 | #define DEVICE_ATTR(_name,_mode,_show,_store) \ |
| 350 | struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store) |
| 351 | |
| 352 | |
| 353 | extern int device_create_file(struct device *device, struct device_attribute * entry); |
| 354 | extern void device_remove_file(struct device * dev, struct device_attribute * attr); |
| 355 | |
| 356 | /* |
| 357 | * Platform "fixup" functions - allow the platform to have their say |
| 358 | * about devices and actions that the general device layer doesn't |
| 359 | * know about. |
| 360 | */ |
| 361 | /* Notify platform of device discovery */ |
| 362 | extern int (*platform_notify)(struct device * dev); |
| 363 | |
| 364 | extern int (*platform_notify_remove)(struct device * dev); |
| 365 | |
| 366 | |
| 367 | /** |
| 368 | * get_device - atomically increment the reference count for the device. |
| 369 | * |
| 370 | */ |
| 371 | extern struct device * get_device(struct device * dev); |
| 372 | extern void put_device(struct device * dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 373 | |
| 374 | |
| 375 | /* drivers/base/platform.c */ |
| 376 | |
| 377 | struct platform_device { |
Dmitry Torokhov | 8d790d7 | 2005-04-26 02:34:05 -0500 | [diff] [blame] | 378 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 379 | u32 id; |
| 380 | struct device dev; |
| 381 | u32 num_resources; |
| 382 | struct resource * resource; |
| 383 | }; |
| 384 | |
| 385 | #define to_platform_device(x) container_of((x), struct platform_device, dev) |
| 386 | |
| 387 | extern int platform_device_register(struct platform_device *); |
| 388 | extern void platform_device_unregister(struct platform_device *); |
| 389 | |
| 390 | extern struct bus_type platform_bus_type; |
| 391 | extern struct device platform_bus; |
| 392 | |
| 393 | extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int); |
| 394 | extern int platform_get_irq(struct platform_device *, unsigned int); |
| 395 | extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, char *); |
| 396 | extern int platform_get_irq_byname(struct platform_device *, char *); |
| 397 | extern int platform_add_devices(struct platform_device **, int); |
| 398 | |
| 399 | extern struct platform_device *platform_device_register_simple(char *, unsigned int, struct resource *, unsigned int); |
| 400 | |
| 401 | /* drivers/base/power.c */ |
| 402 | extern void device_shutdown(void); |
| 403 | |
| 404 | |
| 405 | /* drivers/base/firmware.c */ |
| 406 | extern int firmware_register(struct subsystem *); |
| 407 | extern void firmware_unregister(struct subsystem *); |
| 408 | |
| 409 | /* debugging and troubleshooting/diagnostic helpers. */ |
| 410 | #define dev_printk(level, dev, format, arg...) \ |
| 411 | printk(level "%s %s: " format , (dev)->driver ? (dev)->driver->name : "" , (dev)->bus_id , ## arg) |
| 412 | |
| 413 | #ifdef DEBUG |
| 414 | #define dev_dbg(dev, format, arg...) \ |
| 415 | dev_printk(KERN_DEBUG , dev , format , ## arg) |
| 416 | #else |
| 417 | #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0) |
| 418 | #endif |
| 419 | |
| 420 | #define dev_err(dev, format, arg...) \ |
| 421 | dev_printk(KERN_ERR , dev , format , ## arg) |
| 422 | #define dev_info(dev, format, arg...) \ |
| 423 | dev_printk(KERN_INFO , dev , format , ## arg) |
| 424 | #define dev_warn(dev, format, arg...) \ |
| 425 | dev_printk(KERN_WARNING , dev , format , ## arg) |
| 426 | |
| 427 | /* Create alias, so I can be autoloaded. */ |
| 428 | #define MODULE_ALIAS_CHARDEV(major,minor) \ |
| 429 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) |
| 430 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ |
| 431 | MODULE_ALIAS("char-major-" __stringify(major) "-*") |
| 432 | #endif /* _DEVICE_H_ */ |