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