diff options
author | Greg Kroah-Hartman <gregkh@suse.de> | 2005-10-28 01:25:43 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@suse.de> | 2005-10-28 12:52:52 -0400 |
commit | 74be227f728ed68bfc270153665b43fc1f0fa845 (patch) | |
tree | c10fbdaa10a57162885881e080ac1cee71c0d9c1 /include/linux | |
parent | 53f4654272df7c51064825024340554b39c9efba (diff) |
[PATCH] Driver Core: document struct class_device properly
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'include/linux')
-rw-r--r-- | include/linux/device.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/include/linux/device.h b/include/linux/device.h index 226e550ae2ea..10ab7807f8ea 100644 --- a/include/linux/device.h +++ b/include/linux/device.h | |||
@@ -203,6 +203,30 @@ struct class_device_attribute class_device_attr_##_name = \ | |||
203 | extern int class_device_create_file(struct class_device *, | 203 | extern int class_device_create_file(struct class_device *, |
204 | const struct class_device_attribute *); | 204 | const struct class_device_attribute *); |
205 | 205 | ||
206 | /** | ||
207 | * struct class_device - class devices | ||
208 | * @class: pointer to the parent class for this class device. This is required. | ||
209 | * @devt: for internal use by the driver core only. | ||
210 | * @node: for internal use by the driver core only. | ||
211 | * @kobj: for internal use by the driver core only. | ||
212 | * @devt_attr: for internal use by the driver core only. | ||
213 | * @dev: if set, a symlink to the struct device is created in the sysfs | ||
214 | * directory for this struct class device. | ||
215 | * @class_data: pointer to whatever you want to store here for this struct | ||
216 | * class_device. Use class_get_devdata() and class_set_devdata() to get and | ||
217 | * set this pointer. | ||
218 | * @parent: pointer to a struct class_device that is the parent of this struct | ||
219 | * class_device. If NULL, this class_device will show up at the root of the | ||
220 | * struct class in sysfs (which is probably what you want to have happen.) | ||
221 | * @release: pointer to a release function for this struct class_device. If | ||
222 | * set, this will be called instead of the class specific release function. | ||
223 | * Only use this if you want to override the default release function, like | ||
224 | * when you are nesting class_device structures. | ||
225 | * @hotplug: pointer to a hotplug function for this struct class_device. If | ||
226 | * set, this will be called instead of the class specific hotplug function. | ||
227 | * Only use this if you want to override the default hotplug function, like | ||
228 | * when you are nesting class_device structures. | ||
229 | */ | ||
206 | struct class_device { | 230 | struct class_device { |
207 | struct list_head node; | 231 | struct list_head node; |
208 | 232 | ||