]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
1da177e4 LT |
14 | #include <linux/ioport.h> |
15 | #include <linux/kobject.h> | |
465c7a3a | 16 | #include <linux/klist.h> |
1da177e4 | 17 | #include <linux/list.h> |
4a7fb636 | 18 | #include <linux/compiler.h> |
1da177e4 LT |
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 | ||
1da177e4 LT |
31 | struct device; |
32 | struct device_driver; | |
33 | struct class; | |
34 | struct class_device; | |
1da177e4 LT |
35 | |
36 | struct bus_type { | |
8d790d74 | 37 | const char * name; |
1da177e4 LT |
38 | |
39 | struct subsystem subsys; | |
40 | struct kset drivers; | |
41 | struct kset devices; | |
465c7a3a | 42 | struct klist klist_devices; |
38fdac3c | 43 | struct klist klist_drivers; |
1da177e4 LT |
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); | |
312c004d KS |
50 | int (*uevent)(struct device *dev, char **envp, |
51 | int num_envp, char *buffer, int buffer_size); | |
594c8281 RK |
52 | int (*probe)(struct device * dev); |
53 | int (*remove)(struct device * dev); | |
54 | void (*shutdown)(struct device * dev); | |
7c8265f5 | 55 | |
7c8265f5 LT |
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); | |
1da177e4 LT |
60 | }; |
61 | ||
4a7fb636 | 62 | extern int __must_check bus_register(struct bus_type * bus); |
1da177e4 LT |
63 | extern void bus_unregister(struct bus_type * bus); |
64 | ||
f86db396 | 65 | extern int __must_check bus_rescan_devices(struct bus_type * bus); |
1da177e4 | 66 | |
1da177e4 LT |
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 *)); | |
0edb5860 CH |
71 | struct device * bus_find_device(struct bus_type *bus, struct device *start, |
72 | void *data, int (*match)(struct device *, void *)); | |
1da177e4 | 73 | |
4a7fb636 AM |
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 *)); | |
1da177e4 LT |
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 | ||
4a7fb636 AM |
89 | extern int __must_check bus_create_file(struct bus_type *, |
90 | struct bus_attribute *); | |
1da177e4 LT |
91 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
92 | ||
93 | struct device_driver { | |
8d790d74 | 94 | const char * name; |
1da177e4 LT |
95 | struct bus_type * bus; |
96 | ||
97 | struct completion unloaded; | |
98 | struct kobject kobj; | |
94e7b1c5 | 99 | struct klist klist_devices; |
38fdac3c | 100 | struct klist_node knode_bus; |
1da177e4 | 101 | |
8d790d74 | 102 | struct module * owner; |
1da177e4 LT |
103 | |
104 | int (*probe) (struct device * dev); | |
8d790d74 | 105 | int (*remove) (struct device * dev); |
1da177e4 | 106 | void (*shutdown) (struct device * dev); |
9480e307 RK |
107 | int (*suspend) (struct device * dev, pm_message_t state); |
108 | int (*resume) (struct device * dev); | |
d779249e GKH |
109 | |
110 | unsigned int multithread_probe:1; | |
1da177e4 LT |
111 | }; |
112 | ||
113 | ||
4a7fb636 | 114 | extern int __must_check driver_register(struct device_driver * drv); |
1da177e4 LT |
115 | extern void driver_unregister(struct device_driver * drv); |
116 | ||
117 | extern struct device_driver * get_driver(struct device_driver * drv); | |
118 | extern void put_driver(struct device_driver * drv); | |
119 | extern struct device_driver *driver_find(const char *name, struct bus_type *bus); | |
d779249e | 120 | extern int driver_probe_done(void); |
1da177e4 | 121 | |
1da177e4 LT |
122 | /* driverfs interface for exporting driver attributes */ |
123 | ||
124 | struct driver_attribute { | |
125 | struct attribute attr; | |
126 | ssize_t (*show)(struct device_driver *, char * buf); | |
127 | ssize_t (*store)(struct device_driver *, const char * buf, size_t count); | |
128 | }; | |
129 | ||
130 | #define DRIVER_ATTR(_name,_mode,_show,_store) \ | |
131 | struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store) | |
132 | ||
4a7fb636 AM |
133 | extern int __must_check driver_create_file(struct device_driver *, |
134 | struct driver_attribute *); | |
1da177e4 LT |
135 | extern void driver_remove_file(struct device_driver *, struct driver_attribute *); |
136 | ||
4a7fb636 AM |
137 | extern int __must_check driver_for_each_device(struct device_driver * drv, |
138 | struct device *start, void *data, | |
139 | int (*fn)(struct device *, void *)); | |
0edb5860 CH |
140 | struct device * driver_find_device(struct device_driver *drv, |
141 | struct device *start, void *data, | |
142 | int (*match)(struct device *, void *)); | |
fae3cd00 | 143 | |
1da177e4 LT |
144 | /* |
145 | * device classes | |
146 | */ | |
147 | struct class { | |
8d790d74 | 148 | const char * name; |
e9ba6365 | 149 | struct module * owner; |
1da177e4 LT |
150 | |
151 | struct subsystem subsys; | |
152 | struct list_head children; | |
23681e47 | 153 | struct list_head devices; |
1da177e4 LT |
154 | struct list_head interfaces; |
155 | struct semaphore sem; /* locks both the children and interfaces lists */ | |
156 | ||
c205ef48 GKH |
157 | struct kobject *virtual_dir; |
158 | ||
1da177e4 LT |
159 | struct class_attribute * class_attrs; |
160 | struct class_device_attribute * class_dev_attrs; | |
2620efef | 161 | struct device_attribute * dev_attrs; |
1da177e4 | 162 | |
312c004d | 163 | int (*uevent)(struct class_device *dev, char **envp, |
1da177e4 | 164 | int num_envp, char *buffer, int buffer_size); |
2620efef GKH |
165 | int (*dev_uevent)(struct device *dev, char **envp, int num_envp, |
166 | char *buffer, int buffer_size); | |
1da177e4 LT |
167 | |
168 | void (*release)(struct class_device *dev); | |
169 | void (*class_release)(struct class *class); | |
2620efef | 170 | void (*dev_release)(struct device *dev); |
7c8265f5 LT |
171 | |
172 | int (*suspend)(struct device *, pm_message_t state); | |
173 | int (*resume)(struct device *); | |
1da177e4 LT |
174 | }; |
175 | ||
4a7fb636 | 176 | extern int __must_check class_register(struct class *); |
1da177e4 LT |
177 | extern void class_unregister(struct class *); |
178 | ||
1da177e4 LT |
179 | |
180 | struct class_attribute { | |
181 | struct attribute attr; | |
182 | ssize_t (*show)(struct class *, char * buf); | |
183 | ssize_t (*store)(struct class *, const char * buf, size_t count); | |
184 | }; | |
185 | ||
186 | #define CLASS_ATTR(_name,_mode,_show,_store) \ | |
187 | struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store) | |
188 | ||
4a7fb636 AM |
189 | extern int __must_check class_create_file(struct class *, |
190 | const struct class_attribute *); | |
1da177e4 LT |
191 | extern void class_remove_file(struct class *, const struct class_attribute *); |
192 | ||
a7fd6706 KS |
193 | struct class_device_attribute { |
194 | struct attribute attr; | |
195 | ssize_t (*show)(struct class_device *, char * buf); | |
196 | ssize_t (*store)(struct class_device *, const char * buf, size_t count); | |
197 | }; | |
198 | ||
199 | #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \ | |
200 | struct class_device_attribute class_device_attr_##_name = \ | |
201 | __ATTR(_name,_mode,_show,_store) | |
202 | ||
4a7fb636 | 203 | extern int __must_check class_device_create_file(struct class_device *, |
a7fd6706 | 204 | const struct class_device_attribute *); |
1da177e4 | 205 | |
74be227f GKH |
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. | |
1498221d | 213 | * @groups: optional additional groups to be created |
74be227f GKH |
214 | * @dev: if set, a symlink to the struct device is created in the sysfs |
215 | * directory for this struct class device. | |
216 | * @class_data: pointer to whatever you want to store here for this struct | |
217 | * class_device. Use class_get_devdata() and class_set_devdata() to get and | |
218 | * set this pointer. | |
219 | * @parent: pointer to a struct class_device that is the parent of this struct | |
220 | * class_device. If NULL, this class_device will show up at the root of the | |
221 | * struct class in sysfs (which is probably what you want to have happen.) | |
222 | * @release: pointer to a release function for this struct class_device. If | |
223 | * set, this will be called instead of the class specific release function. | |
224 | * Only use this if you want to override the default release function, like | |
225 | * when you are nesting class_device structures. | |
312c004d KS |
226 | * @uevent: pointer to a uevent function for this struct class_device. If |
227 | * set, this will be called instead of the class specific uevent function. | |
228 | * Only use this if you want to override the default uevent function, like | |
74be227f GKH |
229 | * when you are nesting class_device structures. |
230 | */ | |
1da177e4 LT |
231 | struct class_device { |
232 | struct list_head node; | |
233 | ||
234 | struct kobject kobj; | |
235 | struct class * class; /* required */ | |
236 | dev_t devt; /* dev_t, creates the sysfs "dev" */ | |
e9ba6365 | 237 | struct class_device_attribute *devt_attr; |
a7fd6706 | 238 | struct class_device_attribute uevent_attr; |
1da177e4 LT |
239 | struct device * dev; /* not necessary, but nice to have */ |
240 | void * class_data; /* class-specific data */ | |
51d172d5 | 241 | struct class_device *parent; /* parent of this child device, if there is one */ |
1498221d | 242 | struct attribute_group ** groups; /* optional groups */ |
1da177e4 | 243 | |
51d172d5 | 244 | void (*release)(struct class_device *dev); |
312c004d | 245 | int (*uevent)(struct class_device *dev, char **envp, |
51d172d5 | 246 | int num_envp, char *buffer, int buffer_size); |
1da177e4 LT |
247 | char class_id[BUS_ID_SIZE]; /* unique to this class */ |
248 | }; | |
249 | ||
250 | static inline void * | |
251 | class_get_devdata (struct class_device *dev) | |
252 | { | |
253 | return dev->class_data; | |
254 | } | |
255 | ||
256 | static inline void | |
257 | class_set_devdata (struct class_device *dev, void *data) | |
258 | { | |
259 | dev->class_data = data; | |
260 | } | |
261 | ||
262 | ||
4a7fb636 | 263 | extern int __must_check class_device_register(struct class_device *); |
1da177e4 LT |
264 | extern void class_device_unregister(struct class_device *); |
265 | extern void class_device_initialize(struct class_device *); | |
4a7fb636 | 266 | extern int __must_check class_device_add(struct class_device *); |
1da177e4 LT |
267 | extern void class_device_del(struct class_device *); |
268 | ||
269 | extern int class_device_rename(struct class_device *, char *); | |
270 | ||
271 | extern struct class_device * class_device_get(struct class_device *); | |
272 | extern void class_device_put(struct class_device *); | |
273 | ||
1da177e4 LT |
274 | extern void class_device_remove_file(struct class_device *, |
275 | const struct class_device_attribute *); | |
4a7fb636 | 276 | extern int __must_check class_device_create_bin_file(struct class_device *, |
1da177e4 LT |
277 | struct bin_attribute *); |
278 | extern void class_device_remove_bin_file(struct class_device *, | |
279 | struct bin_attribute *); | |
280 | ||
281 | struct class_interface { | |
282 | struct list_head node; | |
283 | struct class *class; | |
284 | ||
d8539d81 DT |
285 | int (*add) (struct class_device *, struct class_interface *); |
286 | void (*remove) (struct class_device *, struct class_interface *); | |
c47ed219 GKH |
287 | int (*add_dev) (struct device *, struct class_interface *); |
288 | void (*remove_dev) (struct device *, struct class_interface *); | |
1da177e4 LT |
289 | }; |
290 | ||
4a7fb636 | 291 | extern int __must_check class_interface_register(struct class_interface *); |
1da177e4 LT |
292 | extern void class_interface_unregister(struct class_interface *); |
293 | ||
ab7d7371 | 294 | extern struct class *class_create(struct module *owner, const char *name); |
e9ba6365 | 295 | extern void class_destroy(struct class *cls); |
51d172d5 GKH |
296 | extern struct class_device *class_device_create(struct class *cls, |
297 | struct class_device *parent, | |
298 | dev_t devt, | |
299 | struct device *device, | |
ddd5d35a | 300 | const char *fmt, ...) |
51d172d5 | 301 | __attribute__((format(printf,5,6))); |
e9ba6365 GKH |
302 | extern void class_device_destroy(struct class *cls, dev_t devt); |
303 | ||
a7fd6706 KS |
304 | /* interface for exporting device attributes */ |
305 | struct device_attribute { | |
306 | struct attribute attr; | |
307 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, | |
308 | char *buf); | |
309 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, | |
310 | const char *buf, size_t count); | |
311 | }; | |
312 | ||
313 | #define DEVICE_ATTR(_name,_mode,_show,_store) \ | |
314 | struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store) | |
315 | ||
4a7fb636 AM |
316 | extern int __must_check device_create_file(struct device *device, |
317 | struct device_attribute * entry); | |
a7fd6706 | 318 | extern void device_remove_file(struct device * dev, struct device_attribute * attr); |
2589f188 GKH |
319 | extern int __must_check device_create_bin_file(struct device *dev, |
320 | struct bin_attribute *attr); | |
321 | extern void device_remove_bin_file(struct device *dev, | |
322 | struct bin_attribute *attr); | |
1da177e4 | 323 | struct device { |
36239577 PM |
324 | struct klist klist_children; |
325 | struct klist_node knode_parent; /* node in sibling list */ | |
94e7b1c5 | 326 | struct klist_node knode_driver; |
465c7a3a | 327 | struct klist_node knode_bus; |
1da177e4 LT |
328 | struct device * parent; |
329 | ||
330 | struct kobject kobj; | |
331 | char bus_id[BUS_ID_SIZE]; /* position on parent bus */ | |
f2eaae19 | 332 | unsigned is_registered:1; |
a7fd6706 | 333 | struct device_attribute uevent_attr; |
23681e47 | 334 | struct device_attribute *devt_attr; |
1da177e4 | 335 | |
af70316a PM |
336 | struct semaphore sem; /* semaphore to synchronize calls to |
337 | * its driver. | |
338 | */ | |
339 | ||
1da177e4 LT |
340 | struct bus_type * bus; /* type of bus device is on */ |
341 | struct device_driver *driver; /* which driver has allocated this | |
342 | device */ | |
343 | void *driver_data; /* data private to the driver */ | |
4e10d12a DSL |
344 | void *platform_data; /* Platform specific data, device |
345 | core doesn't touch it */ | |
346 | void *firmware_data; /* Firmware specific data (e.g. ACPI, | |
347 | BIOS data),reserved for device core*/ | |
1da177e4 LT |
348 | struct dev_pm_info power; |
349 | ||
1da177e4 LT |
350 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
351 | u64 coherent_dma_mask;/* Like dma_mask, but for | |
352 | alloc_coherent mappings as | |
353 | not all hardware supports | |
354 | 64 bit addresses for consistent | |
355 | allocations such descriptors. */ | |
356 | ||
357 | struct list_head dma_pools; /* dma pools (if dma'ble) */ | |
358 | ||
359 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem | |
360 | override */ | |
361 | ||
23681e47 GKH |
362 | /* class_device migration path */ |
363 | struct list_head node; | |
364 | struct class *class; /* optional*/ | |
365 | dev_t devt; /* dev_t, creates the sysfs "dev" */ | |
de0ff00d | 366 | struct attribute_group **groups; /* optional groups */ |
23681e47 | 367 | |
1da177e4 LT |
368 | void (*release)(struct device * dev); |
369 | }; | |
370 | ||
1da177e4 LT |
371 | static inline void * |
372 | dev_get_drvdata (struct device *dev) | |
373 | { | |
374 | return dev->driver_data; | |
375 | } | |
376 | ||
377 | static inline void | |
378 | dev_set_drvdata (struct device *dev, void *data) | |
379 | { | |
380 | dev->driver_data = data; | |
381 | } | |
382 | ||
d305ef5d DR |
383 | static inline int device_is_registered(struct device *dev) |
384 | { | |
f2eaae19 | 385 | return dev->is_registered; |
d305ef5d DR |
386 | } |
387 | ||
1da177e4 LT |
388 | /* |
389 | * High level routines for use by the bus drivers | |
390 | */ | |
4a7fb636 | 391 | extern int __must_check device_register(struct device * dev); |
1da177e4 LT |
392 | extern void device_unregister(struct device * dev); |
393 | extern void device_initialize(struct device * dev); | |
4a7fb636 | 394 | extern int __must_check device_add(struct device * dev); |
1da177e4 | 395 | extern void device_del(struct device * dev); |
4a7fb636 | 396 | extern int __must_check device_for_each_child(struct device *, void *, |
1da177e4 | 397 | int (*fn)(struct device *, void *)); |
a2de48ca | 398 | extern int device_rename(struct device *dev, char *new_name); |
1da177e4 LT |
399 | |
400 | /* | |
401 | * Manual binding of a device to driver. See drivers/base/bus.c | |
402 | * for information on use. | |
403 | */ | |
f86db396 | 404 | extern int __must_check device_bind_driver(struct device *dev); |
1da177e4 | 405 | extern void device_release_driver(struct device * dev); |
4a7fb636 | 406 | extern int __must_check device_attach(struct device * dev); |
f86db396 AM |
407 | extern int __must_check driver_attach(struct device_driver *drv); |
408 | extern int __must_check device_reprobe(struct device *dev); | |
1da177e4 | 409 | |
23681e47 GKH |
410 | /* |
411 | * Easy functions for dynamically creating devices on the fly | |
412 | */ | |
413 | extern struct device *device_create(struct class *cls, struct device *parent, | |
5cbe5f8a | 414 | dev_t devt, const char *fmt, ...) |
23681e47 GKH |
415 | __attribute__((format(printf,4,5))); |
416 | extern void device_destroy(struct class *cls, dev_t devt); | |
1da177e4 | 417 | |
c205ef48 GKH |
418 | extern int virtual_device_parent(struct device *dev); |
419 | ||
1da177e4 LT |
420 | /* |
421 | * Platform "fixup" functions - allow the platform to have their say | |
422 | * about devices and actions that the general device layer doesn't | |
423 | * know about. | |
424 | */ | |
425 | /* Notify platform of device discovery */ | |
426 | extern int (*platform_notify)(struct device * dev); | |
427 | ||
428 | extern int (*platform_notify_remove)(struct device * dev); | |
429 | ||
430 | ||
431 | /** | |
432 | * get_device - atomically increment the reference count for the device. | |
433 | * | |
434 | */ | |
435 | extern struct device * get_device(struct device * dev); | |
436 | extern void put_device(struct device * dev); | |
1da177e4 LT |
437 | |
438 | ||
116f232b | 439 | /* drivers/base/power/shutdown.c */ |
1da177e4 LT |
440 | extern void device_shutdown(void); |
441 | ||
442 | ||
443 | /* drivers/base/firmware.c */ | |
4a7fb636 | 444 | extern int __must_check firmware_register(struct subsystem *); |
1da177e4 LT |
445 | extern void firmware_unregister(struct subsystem *); |
446 | ||
447 | /* debugging and troubleshooting/diagnostic helpers. */ | |
3e95637a | 448 | extern const char *dev_driver_string(struct device *dev); |
1da177e4 | 449 | #define dev_printk(level, dev, format, arg...) \ |
3e95637a | 450 | printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg) |
1da177e4 LT |
451 | |
452 | #ifdef DEBUG | |
453 | #define dev_dbg(dev, format, arg...) \ | |
454 | dev_printk(KERN_DEBUG , dev , format , ## arg) | |
455 | #else | |
456 | #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0) | |
457 | #endif | |
458 | ||
459 | #define dev_err(dev, format, arg...) \ | |
460 | dev_printk(KERN_ERR , dev , format , ## arg) | |
461 | #define dev_info(dev, format, arg...) \ | |
462 | dev_printk(KERN_INFO , dev , format , ## arg) | |
463 | #define dev_warn(dev, format, arg...) \ | |
464 | dev_printk(KERN_WARNING , dev , format , ## arg) | |
4f2928d0 TS |
465 | #define dev_notice(dev, format, arg...) \ |
466 | dev_printk(KERN_NOTICE , dev , format , ## arg) | |
1da177e4 LT |
467 | |
468 | /* Create alias, so I can be autoloaded. */ | |
469 | #define MODULE_ALIAS_CHARDEV(major,minor) \ | |
470 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) | |
471 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ | |
472 | MODULE_ALIAS("char-major-" __stringify(major) "-*") | |
473 | #endif /* _DEVICE_H_ */ |