Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /** |
| 2 | * System devices follow a slightly different driver model. |
| 3 | * They don't need to do dynammic driver binding, can't be probed, |
| 4 | * and don't reside on any type of peripheral bus. |
| 5 | * So, we represent and treat them a little differently. |
| 6 | * |
| 7 | * We still have a notion of a driver for a system device, because we still |
| 8 | * want to perform basic operations on these devices. |
| 9 | * |
| 10 | * We also support auxillary drivers binding to devices of a certain class. |
| 11 | * |
| 12 | * This allows configurable drivers to register themselves for devices of |
| 13 | * a certain type. And, it allows class definitions to reside in generic |
| 14 | * code while arch-specific code can register specific drivers. |
| 15 | * |
| 16 | * Auxillary drivers registered with a NULL cls are registered as drivers |
| 17 | * for all system devices, and get notification calls for each device. |
| 18 | */ |
| 19 | |
| 20 | |
| 21 | #ifndef _SYSDEV_H_ |
| 22 | #define _SYSDEV_H_ |
| 23 | |
| 24 | #include <linux/kobject.h> |
Ralf Baechle | 3367b99 | 2007-05-08 00:27:52 -0700 | [diff] [blame] | 25 | #include <linux/module.h> |
Pavel Machek | 438510f | 2005-04-16 15:25:24 -0700 | [diff] [blame] | 26 | #include <linux/pm.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | |
| 28 | |
| 29 | struct sys_device; |
| 30 | |
| 31 | struct sysdev_class { |
Kay Sievers | af5ca3f | 2007-12-20 02:09:39 +0100 | [diff] [blame] | 32 | const char *name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | struct list_head drivers; |
| 34 | |
| 35 | /* Default operations for these types of devices */ |
| 36 | int (*shutdown)(struct sys_device *); |
Pavel Machek | 438510f | 2005-04-16 15:25:24 -0700 | [diff] [blame] | 37 | int (*suspend)(struct sys_device *, pm_message_t state); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | int (*resume)(struct sys_device *); |
| 39 | struct kset kset; |
| 40 | }; |
| 41 | |
Shaohua Li | 670dd90 | 2006-05-08 13:45:57 +0800 | [diff] [blame] | 42 | struct sysdev_class_attribute { |
| 43 | struct attribute attr; |
| 44 | ssize_t (*show)(struct sysdev_class *, char *); |
| 45 | ssize_t (*store)(struct sysdev_class *, const char *, size_t); |
| 46 | }; |
| 47 | |
Mike Travis | 9d1fe32 | 2008-04-08 11:43:04 -0700 | [diff] [blame] | 48 | #define _SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \ |
| 49 | { \ |
Shaohua Li | 670dd90 | 2006-05-08 13:45:57 +0800 | [diff] [blame] | 50 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
| 51 | .show = _show, \ |
| 52 | .store = _store, \ |
Mike Travis | 9d1fe32 | 2008-04-08 11:43:04 -0700 | [diff] [blame] | 53 | } |
| 54 | |
| 55 | #define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \ |
| 56 | struct sysdev_class_attribute attr_##_name = \ |
| 57 | _SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) |
Shaohua Li | 670dd90 | 2006-05-08 13:45:57 +0800 | [diff] [blame] | 58 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | |
| 60 | extern int sysdev_class_register(struct sysdev_class *); |
| 61 | extern void sysdev_class_unregister(struct sysdev_class *); |
| 62 | |
Shaohua Li | 670dd90 | 2006-05-08 13:45:57 +0800 | [diff] [blame] | 63 | extern int sysdev_class_create_file(struct sysdev_class *, |
| 64 | struct sysdev_class_attribute *); |
| 65 | extern void sysdev_class_remove_file(struct sysdev_class *, |
| 66 | struct sysdev_class_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | /** |
| 68 | * Auxillary system device drivers. |
| 69 | */ |
| 70 | |
| 71 | struct sysdev_driver { |
| 72 | struct list_head entry; |
| 73 | int (*add)(struct sys_device *); |
| 74 | int (*remove)(struct sys_device *); |
| 75 | int (*shutdown)(struct sys_device *); |
Pavel Machek | 438510f | 2005-04-16 15:25:24 -0700 | [diff] [blame] | 76 | int (*suspend)(struct sys_device *, pm_message_t state); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | int (*resume)(struct sys_device *); |
| 78 | }; |
| 79 | |
| 80 | |
| 81 | extern int sysdev_driver_register(struct sysdev_class *, struct sysdev_driver *); |
| 82 | extern void sysdev_driver_unregister(struct sysdev_class *, struct sysdev_driver *); |
| 83 | |
| 84 | |
| 85 | /** |
| 86 | * sys_devices can be simplified a lot from regular devices, because they're |
| 87 | * simply not as versatile. |
| 88 | */ |
| 89 | |
| 90 | struct sys_device { |
| 91 | u32 id; |
| 92 | struct sysdev_class * cls; |
| 93 | struct kobject kobj; |
| 94 | }; |
| 95 | |
| 96 | extern int sysdev_register(struct sys_device *); |
| 97 | extern void sysdev_unregister(struct sys_device *); |
| 98 | |
| 99 | |
| 100 | struct sysdev_attribute { |
| 101 | struct attribute attr; |
| 102 | ssize_t (*show)(struct sys_device *, char *); |
| 103 | ssize_t (*store)(struct sys_device *, const char *, size_t); |
| 104 | }; |
| 105 | |
| 106 | |
Mike Travis | 9d1fe32 | 2008-04-08 11:43:04 -0700 | [diff] [blame] | 107 | #define _SYSDEV_ATTR(_name, _mode, _show, _store) \ |
Olof Johansson | 7583b6e | 2007-01-28 21:24:57 -0600 | [diff] [blame] | 108 | { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 109 | .attr = { .name = __stringify(_name), .mode = _mode }, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | .show = _show, \ |
| 111 | .store = _store, \ |
Olof Johansson | 7583b6e | 2007-01-28 21:24:57 -0600 | [diff] [blame] | 112 | } |
| 113 | |
Mike Travis | 9d1fe32 | 2008-04-08 11:43:04 -0700 | [diff] [blame] | 114 | #define SYSDEV_ATTR(_name, _mode, _show, _store) \ |
| 115 | struct sysdev_attribute attr_##_name = \ |
| 116 | _SYSDEV_ATTR(_name, _mode, _show, _store); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | |
| 118 | extern int sysdev_create_file(struct sys_device *, struct sysdev_attribute *); |
| 119 | extern void sysdev_remove_file(struct sys_device *, struct sysdev_attribute *); |
| 120 | |
| 121 | #endif /* _SYSDEV_H_ */ |