]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * device.h - generic, centralized driver model | |
3 | * | |
4 | * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> | |
b4028437 GKH |
5 | * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> |
6 | * Copyright (c) 2008-2009 Novell Inc. | |
1da177e4 LT |
7 | * |
8 | * This file is released under the GPLv2 | |
9 | * | |
10 | * See Documentation/driver-model/ for more information. | |
11 | */ | |
12 | ||
13 | #ifndef _DEVICE_H_ | |
14 | #define _DEVICE_H_ | |
15 | ||
1da177e4 LT |
16 | #include <linux/ioport.h> |
17 | #include <linux/kobject.h> | |
465c7a3a | 18 | #include <linux/klist.h> |
1da177e4 | 19 | #include <linux/list.h> |
d2a3b914 | 20 | #include <linux/lockdep.h> |
4a7fb636 | 21 | #include <linux/compiler.h> |
1da177e4 | 22 | #include <linux/types.h> |
de477254 | 23 | #include <linux/mutex.h> |
1da177e4 | 24 | #include <linux/pm.h> |
60063497 | 25 | #include <linux/atomic.h> |
c6dbaef2 | 26 | #include <asm/device.h> |
1da177e4 | 27 | |
1da177e4 | 28 | struct device; |
fb069a5d | 29 | struct device_private; |
1da177e4 | 30 | struct device_driver; |
e5dd1278 | 31 | struct driver_private; |
de477254 | 32 | struct module; |
1da177e4 | 33 | struct class; |
6b6e39a6 | 34 | struct subsys_private; |
b8c5cec2 | 35 | struct bus_type; |
d706c1b0 | 36 | struct device_node; |
ff21776d | 37 | struct iommu_ops; |
b8c5cec2 KS |
38 | |
39 | struct bus_attribute { | |
40 | struct attribute attr; | |
d462943a GKH |
41 | ssize_t (*show)(struct bus_type *bus, char *buf); |
42 | ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count); | |
b8c5cec2 KS |
43 | }; |
44 | ||
d462943a GKH |
45 | #define BUS_ATTR(_name, _mode, _show, _store) \ |
46 | struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store) | |
b8c5cec2 KS |
47 | |
48 | extern int __must_check bus_create_file(struct bus_type *, | |
49 | struct bus_attribute *); | |
50 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); | |
1da177e4 | 51 | |
880ffb5c WG |
52 | /** |
53 | * struct bus_type - The bus type of the device | |
54 | * | |
55 | * @name: The name of the bus. | |
56 | * @bus_attrs: Default attributes of the bus. | |
57 | * @dev_attrs: Default attributes of the devices on the bus. | |
58 | * @drv_attrs: Default attributes of the device drivers on the bus. | |
59 | * @match: Called, perhaps multiple times, whenever a new device or driver | |
60 | * is added for this bus. It should return a nonzero value if the | |
61 | * given device can be handled by the given driver. | |
62 | * @uevent: Called when a device is added, removed, or a few other things | |
63 | * that generate uevents to add the environment variables. | |
64 | * @probe: Called when a new device or driver add to this bus, and callback | |
65 | * the specific driver's probe to initial the matched device. | |
66 | * @remove: Called when a device removed from this bus. | |
67 | * @shutdown: Called at shut-down time to quiesce the device. | |
68 | * @suspend: Called when a device on this bus wants to go to sleep mode. | |
69 | * @resume: Called to bring a device on this bus out of sleep mode. | |
70 | * @pm: Power management operations of this bus, callback the specific | |
71 | * device driver's pm-ops. | |
ff21776d JR |
72 | * @iommu_ops IOMMU specific operations for this bus, used to attach IOMMU |
73 | * driver implementations to a bus and allow the driver to do | |
74 | * bus-specific setup | |
880ffb5c WG |
75 | * @p: The private data of the driver core, only the driver core can |
76 | * touch this. | |
77 | * | |
78 | * A bus is a channel between the processor and one or more devices. For the | |
79 | * purposes of the device model, all devices are connected via a bus, even if | |
80 | * it is an internal, virtual, "platform" bus. Buses can plug into each other. | |
81 | * A USB controller is usually a PCI device, for example. The device model | |
82 | * represents the actual connections between buses and the devices they control. | |
83 | * A bus is represented by the bus_type structure. It contains the name, the | |
84 | * default attributes, the bus' methods, PM operations, and the driver core's | |
85 | * private data. | |
86 | */ | |
1da177e4 | 87 | struct bus_type { |
d462943a GKH |
88 | const char *name; |
89 | struct bus_attribute *bus_attrs; | |
90 | struct device_attribute *dev_attrs; | |
91 | struct driver_attribute *drv_attrs; | |
92 | ||
93 | int (*match)(struct device *dev, struct device_driver *drv); | |
94 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); | |
95 | int (*probe)(struct device *dev); | |
96 | int (*remove)(struct device *dev); | |
97 | void (*shutdown)(struct device *dev); | |
98 | ||
99 | int (*suspend)(struct device *dev, pm_message_t state); | |
d462943a | 100 | int (*resume)(struct device *dev); |
b8c5cec2 | 101 | |
8150f32b | 102 | const struct dev_pm_ops *pm; |
1eede070 | 103 | |
ff21776d JR |
104 | struct iommu_ops *iommu_ops; |
105 | ||
6b6e39a6 | 106 | struct subsys_private *p; |
1da177e4 LT |
107 | }; |
108 | ||
d462943a GKH |
109 | extern int __must_check bus_register(struct bus_type *bus); |
110 | extern void bus_unregister(struct bus_type *bus); | |
1da177e4 | 111 | |
d462943a | 112 | extern int __must_check bus_rescan_devices(struct bus_type *bus); |
1da177e4 | 113 | |
1da177e4 LT |
114 | /* iterator helpers for buses */ |
115 | ||
d462943a GKH |
116 | int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, |
117 | int (*fn)(struct device *dev, void *data)); | |
118 | struct device *bus_find_device(struct bus_type *bus, struct device *start, | |
119 | void *data, | |
120 | int (*match)(struct device *dev, void *data)); | |
1f9ffc04 GKH |
121 | struct device *bus_find_device_by_name(struct bus_type *bus, |
122 | struct device *start, | |
123 | const char *name); | |
1da177e4 | 124 | |
cc7447a5 JD |
125 | int bus_for_each_drv(struct bus_type *bus, struct device_driver *start, |
126 | void *data, int (*fn)(struct device_driver *, void *)); | |
1da177e4 | 127 | |
99178b03 GKH |
128 | void bus_sort_breadthfirst(struct bus_type *bus, |
129 | int (*compare)(const struct device *a, | |
130 | const struct device *b)); | |
116af378 BH |
131 | /* |
132 | * Bus notifiers: Get notified of addition/removal of devices | |
133 | * and binding/unbinding of drivers to devices. | |
134 | * In the long run, it should be a replacement for the platform | |
135 | * notify hooks. | |
136 | */ | |
137 | struct notifier_block; | |
138 | ||
139 | extern int bus_register_notifier(struct bus_type *bus, | |
140 | struct notifier_block *nb); | |
141 | extern int bus_unregister_notifier(struct bus_type *bus, | |
142 | struct notifier_block *nb); | |
143 | ||
144 | /* All 4 notifers below get called with the target struct device * | |
145 | * as an argument. Note that those functions are likely to be called | |
8e9394ce | 146 | * with the device lock held in the core, so be careful. |
116af378 BH |
147 | */ |
148 | #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ | |
149 | #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */ | |
45daef0f MD |
150 | #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be |
151 | bound */ | |
152 | #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */ | |
153 | #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be | |
116af378 | 154 | unbound */ |
45daef0f | 155 | #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound |
309b7d60 | 156 | from the device */ |
116af378 | 157 | |
0fed80f7 | 158 | extern struct kset *bus_get_kset(struct bus_type *bus); |
b249072e | 159 | extern struct klist *bus_get_device_klist(struct bus_type *bus); |
0fed80f7 | 160 | |
880ffb5c WG |
161 | /** |
162 | * struct device_driver - The basic device driver structure | |
163 | * @name: Name of the device driver. | |
164 | * @bus: The bus which the device of this driver belongs to. | |
165 | * @owner: The module owner. | |
166 | * @mod_name: Used for built-in modules. | |
167 | * @suppress_bind_attrs: Disables bind/unbind via sysfs. | |
168 | * @of_match_table: The open firmware table. | |
169 | * @probe: Called to query the existence of a specific device, | |
170 | * whether this driver can work with it, and bind the driver | |
171 | * to a specific device. | |
172 | * @remove: Called when the device is removed from the system to | |
173 | * unbind a device from this driver. | |
174 | * @shutdown: Called at shut-down time to quiesce the device. | |
175 | * @suspend: Called to put the device to sleep mode. Usually to a | |
176 | * low power state. | |
177 | * @resume: Called to bring a device from sleep mode. | |
178 | * @groups: Default attributes that get created by the driver core | |
179 | * automatically. | |
180 | * @pm: Power management operations of the device which matched | |
181 | * this driver. | |
182 | * @p: Driver core's private data, no one other than the driver | |
183 | * core can touch this. | |
184 | * | |
185 | * The device driver-model tracks all of the drivers known to the system. | |
186 | * The main reason for this tracking is to enable the driver core to match | |
187 | * up drivers with new devices. Once drivers are known objects within the | |
188 | * system, however, a number of other things become possible. Device drivers | |
189 | * can export information and configuration variables that are independent | |
190 | * of any specific device. | |
191 | */ | |
1da177e4 | 192 | struct device_driver { |
e5dd1278 GKH |
193 | const char *name; |
194 | struct bus_type *bus; | |
1da177e4 | 195 | |
e5dd1278 | 196 | struct module *owner; |
1a6f2a75 DT |
197 | const char *mod_name; /* used for built-in modules */ |
198 | ||
199 | bool suppress_bind_attrs; /* disables bind/unbind via sysfs */ | |
1da177e4 | 200 | |
597b9d1e | 201 | const struct of_device_id *of_match_table; |
597b9d1e | 202 | |
d462943a GKH |
203 | int (*probe) (struct device *dev); |
204 | int (*remove) (struct device *dev); | |
205 | void (*shutdown) (struct device *dev); | |
206 | int (*suspend) (struct device *dev, pm_message_t state); | |
207 | int (*resume) (struct device *dev); | |
a4dbd674 | 208 | const struct attribute_group **groups; |
e5dd1278 | 209 | |
8150f32b | 210 | const struct dev_pm_ops *pm; |
1eede070 | 211 | |
e5dd1278 | 212 | struct driver_private *p; |
1da177e4 LT |
213 | }; |
214 | ||
215 | ||
d462943a GKH |
216 | extern int __must_check driver_register(struct device_driver *drv); |
217 | extern void driver_unregister(struct device_driver *drv); | |
1da177e4 | 218 | |
d462943a GKH |
219 | extern struct device_driver *get_driver(struct device_driver *drv); |
220 | extern void put_driver(struct device_driver *drv); | |
221 | extern struct device_driver *driver_find(const char *name, | |
222 | struct bus_type *bus); | |
d779249e | 223 | extern int driver_probe_done(void); |
b23530eb | 224 | extern void wait_for_device_probe(void); |
216773a7 | 225 | |
1da177e4 | 226 | |
405ae7d3 | 227 | /* sysfs interface for exporting driver attributes */ |
1da177e4 LT |
228 | |
229 | struct driver_attribute { | |
d462943a GKH |
230 | struct attribute attr; |
231 | ssize_t (*show)(struct device_driver *driver, char *buf); | |
232 | ssize_t (*store)(struct device_driver *driver, const char *buf, | |
233 | size_t count); | |
1da177e4 LT |
234 | }; |
235 | ||
d462943a GKH |
236 | #define DRIVER_ATTR(_name, _mode, _show, _store) \ |
237 | struct driver_attribute driver_attr_##_name = \ | |
238 | __ATTR(_name, _mode, _show, _store) | |
1da177e4 | 239 | |
d462943a | 240 | extern int __must_check driver_create_file(struct device_driver *driver, |
099c2f21 | 241 | const struct driver_attribute *attr); |
d462943a | 242 | extern void driver_remove_file(struct device_driver *driver, |
099c2f21 | 243 | const struct driver_attribute *attr); |
1da177e4 | 244 | |
cbe9c595 GKH |
245 | extern int __must_check driver_add_kobj(struct device_driver *drv, |
246 | struct kobject *kobj, | |
247 | const char *fmt, ...); | |
248 | ||
d462943a GKH |
249 | extern int __must_check driver_for_each_device(struct device_driver *drv, |
250 | struct device *start, | |
251 | void *data, | |
252 | int (*fn)(struct device *dev, | |
253 | void *)); | |
254 | struct device *driver_find_device(struct device_driver *drv, | |
255 | struct device *start, void *data, | |
256 | int (*match)(struct device *dev, void *data)); | |
fae3cd00 | 257 | |
880ffb5c WG |
258 | /** |
259 | * struct class - device classes | |
260 | * @name: Name of the class. | |
261 | * @owner: The module owner. | |
262 | * @class_attrs: Default attributes of this class. | |
263 | * @dev_attrs: Default attributes of the devices belong to the class. | |
264 | * @dev_bin_attrs: Default binary attributes of the devices belong to the class. | |
265 | * @dev_kobj: The kobject that represents this class and links it into the hierarchy. | |
266 | * @dev_uevent: Called when a device is added, removed from this class, or a | |
267 | * few other things that generate uevents to add the environment | |
268 | * variables. | |
269 | * @devnode: Callback to provide the devtmpfs. | |
270 | * @class_release: Called to release this class. | |
271 | * @dev_release: Called to release the device. | |
272 | * @suspend: Used to put the device to sleep mode, usually to a low power | |
273 | * state. | |
274 | * @resume: Used to bring the device from the sleep mode. | |
275 | * @ns_type: Callbacks so sysfs can detemine namespaces. | |
276 | * @namespace: Namespace of the device belongs to this class. | |
277 | * @pm: The default device power management operations of this class. | |
278 | * @p: The private data of the driver core, no one other than the | |
279 | * driver core can touch this. | |
280 | * | |
281 | * A class is a higher-level view of a device that abstracts out low-level | |
282 | * implementation details. Drivers may see a SCSI disk or an ATA disk, but, | |
283 | * at the class level, they are all simply disks. Classes allow user space | |
284 | * to work with devices based on what they do, rather than how they are | |
285 | * connected or how they work. | |
1da177e4 LT |
286 | */ |
287 | struct class { | |
d462943a GKH |
288 | const char *name; |
289 | struct module *owner; | |
1da177e4 | 290 | |
d462943a | 291 | struct class_attribute *class_attrs; |
d462943a | 292 | struct device_attribute *dev_attrs; |
c97415a7 | 293 | struct bin_attribute *dev_bin_attrs; |
e105b8bf | 294 | struct kobject *dev_kobj; |
1da177e4 | 295 | |
d462943a | 296 | int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); |
e454cea2 | 297 | char *(*devnode)(struct device *dev, mode_t *mode); |
1da177e4 | 298 | |
d462943a GKH |
299 | void (*class_release)(struct class *class); |
300 | void (*dev_release)(struct device *dev); | |
7c8265f5 | 301 | |
d462943a GKH |
302 | int (*suspend)(struct device *dev, pm_message_t state); |
303 | int (*resume)(struct device *dev); | |
1eede070 | 304 | |
bc451f20 EB |
305 | const struct kobj_ns_type_operations *ns_type; |
306 | const void *(*namespace)(struct device *dev); | |
307 | ||
8150f32b DT |
308 | const struct dev_pm_ops *pm; |
309 | ||
6b6e39a6 | 310 | struct subsys_private *p; |
1da177e4 LT |
311 | }; |
312 | ||
5a3ceb86 TH |
313 | struct class_dev_iter { |
314 | struct klist_iter ki; | |
315 | const struct device_type *type; | |
316 | }; | |
317 | ||
e105b8bf DW |
318 | extern struct kobject *sysfs_dev_block_kobj; |
319 | extern struct kobject *sysfs_dev_char_kobj; | |
d2a3b914 MW |
320 | extern int __must_check __class_register(struct class *class, |
321 | struct lock_class_key *key); | |
d462943a | 322 | extern void class_unregister(struct class *class); |
d2a3b914 MW |
323 | |
324 | /* This is a #define to keep the compiler from merging different | |
325 | * instances of the __key variable */ | |
326 | #define class_register(class) \ | |
327 | ({ \ | |
328 | static struct lock_class_key __key; \ | |
329 | __class_register(class, &__key); \ | |
330 | }) | |
331 | ||
46227094 JD |
332 | struct class_compat; |
333 | struct class_compat *class_compat_register(const char *name); | |
334 | void class_compat_unregister(struct class_compat *cls); | |
335 | int class_compat_create_link(struct class_compat *cls, struct device *dev, | |
336 | struct device *device_link); | |
337 | void class_compat_remove_link(struct class_compat *cls, struct device *dev, | |
338 | struct device *device_link); | |
339 | ||
5a3ceb86 TH |
340 | extern void class_dev_iter_init(struct class_dev_iter *iter, |
341 | struct class *class, | |
342 | struct device *start, | |
343 | const struct device_type *type); | |
344 | extern struct device *class_dev_iter_next(struct class_dev_iter *iter); | |
345 | extern void class_dev_iter_exit(struct class_dev_iter *iter); | |
346 | ||
93562b53 GKH |
347 | extern int class_for_each_device(struct class *class, struct device *start, |
348 | void *data, | |
fd04897b | 349 | int (*fn)(struct device *dev, void *data)); |
695794ae GKH |
350 | extern struct device *class_find_device(struct class *class, |
351 | struct device *start, void *data, | |
fd04897b | 352 | int (*match)(struct device *, void *)); |
1da177e4 LT |
353 | |
354 | struct class_attribute { | |
d462943a | 355 | struct attribute attr; |
28812fe1 AK |
356 | ssize_t (*show)(struct class *class, struct class_attribute *attr, |
357 | char *buf); | |
358 | ssize_t (*store)(struct class *class, struct class_attribute *attr, | |
359 | const char *buf, size_t count); | |
672d82c1 EB |
360 | const void *(*namespace)(struct class *class, |
361 | const struct class_attribute *attr); | |
1da177e4 LT |
362 | }; |
363 | ||
d462943a GKH |
364 | #define CLASS_ATTR(_name, _mode, _show, _store) \ |
365 | struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store) | |
1da177e4 | 366 | |
d462943a GKH |
367 | extern int __must_check class_create_file(struct class *class, |
368 | const struct class_attribute *attr); | |
369 | extern void class_remove_file(struct class *class, | |
370 | const struct class_attribute *attr); | |
1da177e4 | 371 | |
869dfc87 AK |
372 | /* Simple class attribute that is just a static string */ |
373 | ||
374 | struct class_attribute_string { | |
375 | struct class_attribute attr; | |
376 | char *str; | |
377 | }; | |
378 | ||
379 | /* Currently read-only only */ | |
380 | #define _CLASS_ATTR_STRING(_name, _mode, _str) \ | |
381 | { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } | |
382 | #define CLASS_ATTR_STRING(_name, _mode, _str) \ | |
383 | struct class_attribute_string class_attr_##_name = \ | |
384 | _CLASS_ATTR_STRING(_name, _mode, _str) | |
385 | ||
386 | extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr, | |
387 | char *buf); | |
388 | ||
1da177e4 LT |
389 | struct class_interface { |
390 | struct list_head node; | |
391 | struct class *class; | |
392 | ||
c47ed219 GKH |
393 | int (*add_dev) (struct device *, struct class_interface *); |
394 | void (*remove_dev) (struct device *, struct class_interface *); | |
1da177e4 LT |
395 | }; |
396 | ||
4a7fb636 | 397 | extern int __must_check class_interface_register(struct class_interface *); |
1da177e4 LT |
398 | extern void class_interface_unregister(struct class_interface *); |
399 | ||
d2a3b914 MW |
400 | extern struct class * __must_check __class_create(struct module *owner, |
401 | const char *name, | |
402 | struct lock_class_key *key); | |
e9ba6365 | 403 | extern void class_destroy(struct class *cls); |
e9ba6365 | 404 | |
d2a3b914 MW |
405 | /* This is a #define to keep the compiler from merging different |
406 | * instances of the __key variable */ | |
407 | #define class_create(owner, name) \ | |
408 | ({ \ | |
409 | static struct lock_class_key __key; \ | |
410 | __class_create(owner, name, &__key); \ | |
411 | }) | |
412 | ||
414264f9 KS |
413 | /* |
414 | * The type of device, "struct device" is embedded in. A class | |
415 | * or bus can contain devices of different types | |
416 | * like "partitions" and "disks", "mouse" and "event". | |
417 | * This identifies the device type and carries type-specific | |
418 | * information, equivalent to the kobj_type of a kobject. | |
419 | * If "name" is specified, the uevent will contain it in | |
420 | * the DEVTYPE variable. | |
421 | */ | |
f9f852df | 422 | struct device_type { |
414264f9 | 423 | const char *name; |
a4dbd674 | 424 | const struct attribute_group **groups; |
7eff2e7a | 425 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
e454cea2 | 426 | char *(*devnode)(struct device *dev, mode_t *mode); |
f9f852df | 427 | void (*release)(struct device *dev); |
1eede070 | 428 | |
8150f32b | 429 | const struct dev_pm_ops *pm; |
f9f852df KS |
430 | }; |
431 | ||
a7fd6706 KS |
432 | /* interface for exporting device attributes */ |
433 | struct device_attribute { | |
434 | struct attribute attr; | |
435 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, | |
436 | char *buf); | |
437 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, | |
438 | const char *buf, size_t count); | |
439 | }; | |
440 | ||
d462943a GKH |
441 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
442 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) | |
a7fd6706 | 443 | |
4a7fb636 | 444 | extern int __must_check device_create_file(struct device *device, |
66ecb92b | 445 | const struct device_attribute *entry); |
d462943a | 446 | extern void device_remove_file(struct device *dev, |
26579ab7 | 447 | const struct device_attribute *attr); |
2589f188 | 448 | extern int __must_check device_create_bin_file(struct device *dev, |
66ecb92b | 449 | const struct bin_attribute *attr); |
2589f188 | 450 | extern void device_remove_bin_file(struct device *dev, |
66ecb92b | 451 | const struct bin_attribute *attr); |
523ded71 | 452 | extern int device_schedule_callback_owner(struct device *dev, |
d462943a | 453 | void (*func)(struct device *dev), struct module *owner); |
523ded71 AS |
454 | |
455 | /* This is a macro to avoid include problems with THIS_MODULE */ | |
456 | #define device_schedule_callback(dev, func) \ | |
457 | device_schedule_callback_owner(dev, func, THIS_MODULE) | |
9ac7849e TH |
458 | |
459 | /* device resource management */ | |
460 | typedef void (*dr_release_t)(struct device *dev, void *res); | |
461 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); | |
462 | ||
463 | #ifdef CONFIG_DEBUG_DEVRES | |
d462943a | 464 | extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp, |
9ac7849e TH |
465 | const char *name); |
466 | #define devres_alloc(release, size, gfp) \ | |
467 | __devres_alloc(release, size, gfp, #release) | |
468 | #else | |
d462943a | 469 | extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp); |
9ac7849e TH |
470 | #endif |
471 | extern void devres_free(void *res); | |
472 | extern void devres_add(struct device *dev, void *res); | |
d462943a | 473 | extern void *devres_find(struct device *dev, dr_release_t release, |
9ac7849e | 474 | dr_match_t match, void *match_data); |
d462943a GKH |
475 | extern void *devres_get(struct device *dev, void *new_res, |
476 | dr_match_t match, void *match_data); | |
477 | extern void *devres_remove(struct device *dev, dr_release_t release, | |
478 | dr_match_t match, void *match_data); | |
9ac7849e TH |
479 | extern int devres_destroy(struct device *dev, dr_release_t release, |
480 | dr_match_t match, void *match_data); | |
481 | ||
482 | /* devres group */ | |
483 | extern void * __must_check devres_open_group(struct device *dev, void *id, | |
484 | gfp_t gfp); | |
485 | extern void devres_close_group(struct device *dev, void *id); | |
486 | extern void devres_remove_group(struct device *dev, void *id); | |
487 | extern int devres_release_group(struct device *dev, void *id); | |
488 | ||
489 | /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */ | |
490 | extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp); | |
491 | extern void devm_kfree(struct device *dev, void *p); | |
492 | ||
6b7b6510 FT |
493 | struct device_dma_parameters { |
494 | /* | |
495 | * a low level driver may set these to teach IOMMU code about | |
496 | * sg limitations. | |
497 | */ | |
498 | unsigned int max_segment_size; | |
499 | unsigned long segment_boundary_mask; | |
500 | }; | |
501 | ||
880ffb5c WG |
502 | /** |
503 | * struct device - The basic device structure | |
504 | * @parent: The device's "parent" device, the device to which it is attached. | |
505 | * In most cases, a parent device is some sort of bus or host | |
506 | * controller. If parent is NULL, the device, is a top-level device, | |
507 | * which is not usually what you want. | |
508 | * @p: Holds the private data of the driver core portions of the device. | |
509 | * See the comment of the struct device_private for detail. | |
510 | * @kobj: A top-level, abstract class from which other classes are derived. | |
511 | * @init_name: Initial name of the device. | |
512 | * @type: The type of device. | |
513 | * This identifies the device type and carries type-specific | |
514 | * information. | |
515 | * @mutex: Mutex to synchronize calls to its driver. | |
516 | * @bus: Type of bus device is on. | |
517 | * @driver: Which driver has allocated this | |
518 | * @platform_data: Platform data specific to the device. | |
519 | * Example: For devices on custom boards, as typical of embedded | |
520 | * and SOC based hardware, Linux often uses platform_data to point | |
521 | * to board-specific structures describing devices and how they | |
522 | * are wired. That can include what ports are available, chip | |
523 | * variants, which GPIO pins act in what additional roles, and so | |
524 | * on. This shrinks the "Board Support Packages" (BSPs) and | |
525 | * minimizes board-specific #ifdefs in drivers. | |
526 | * @power: For device power management. | |
527 | * See Documentation/power/devices.txt for details. | |
564b905a | 528 | * @pm_domain: Provide callbacks that are executed during system suspend, |
880ffb5c WG |
529 | * hibernation, system resume and during runtime PM transitions |
530 | * along with subsystem-level and driver-level callbacks. | |
531 | * @numa_node: NUMA node this device is close to. | |
532 | * @dma_mask: Dma mask (if dma'ble device). | |
533 | * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all | |
534 | * hardware supports 64-bit addresses for consistent allocations | |
535 | * such descriptors. | |
536 | * @dma_parms: A low level driver may set these to teach IOMMU code about | |
537 | * segment limitations. | |
538 | * @dma_pools: Dma pools (if dma'ble device). | |
539 | * @dma_mem: Internal for coherent mem override. | |
540 | * @archdata: For arch-specific additions. | |
541 | * @of_node: Associated device tree node. | |
880ffb5c WG |
542 | * @devt: For creating the sysfs "dev". |
543 | * @devres_lock: Spinlock to protect the resource of the device. | |
544 | * @devres_head: The resources list of the device. | |
545 | * @knode_class: The node used to add the device to the class list. | |
546 | * @class: The class of the device. | |
547 | * @groups: Optional attribute groups. | |
548 | * @release: Callback to free the device after all references have | |
549 | * gone away. This should be set by the allocator of the | |
550 | * device (i.e. the bus driver that discovered the device). | |
551 | * | |
552 | * At the lowest level, every device in a Linux system is represented by an | |
553 | * instance of struct device. The device structure contains the information | |
554 | * that the device model core needs to model the system. Most subsystems, | |
555 | * however, track additional information about the devices they host. As a | |
556 | * result, it is rare for devices to be represented by bare device structures; | |
557 | * instead, that structure, like kobject structures, is usually embedded within | |
558 | * a higher-level representation of the device. | |
559 | */ | |
1da177e4 | 560 | struct device { |
49a4ec18 | 561 | struct device *parent; |
1da177e4 | 562 | |
fb069a5d GKH |
563 | struct device_private *p; |
564 | ||
1da177e4 | 565 | struct kobject kobj; |
c906a48a | 566 | const char *init_name; /* initial name of the device */ |
aed65af1 | 567 | const struct device_type *type; |
1da177e4 | 568 | |
3142788b | 569 | struct mutex mutex; /* mutex to synchronize calls to |
af70316a PM |
570 | * its driver. |
571 | */ | |
572 | ||
d462943a | 573 | struct bus_type *bus; /* type of bus device is on */ |
1da177e4 LT |
574 | struct device_driver *driver; /* which driver has allocated this |
575 | device */ | |
e67c8562 GKH |
576 | void *platform_data; /* Platform specific data, device |
577 | core doesn't touch it */ | |
1da177e4 | 578 | struct dev_pm_info power; |
564b905a | 579 | struct dev_pm_domain *pm_domain; |
1da177e4 | 580 | |
87348136 CH |
581 | #ifdef CONFIG_NUMA |
582 | int numa_node; /* NUMA node this device is close to */ | |
583 | #endif | |
1da177e4 LT |
584 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
585 | u64 coherent_dma_mask;/* Like dma_mask, but for | |
586 | alloc_coherent mappings as | |
587 | not all hardware supports | |
588 | 64 bit addresses for consistent | |
589 | allocations such descriptors. */ | |
590 | ||
6b7b6510 FT |
591 | struct device_dma_parameters *dma_parms; |
592 | ||
1da177e4 LT |
593 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
594 | ||
595 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem | |
596 | override */ | |
c6dbaef2 BH |
597 | /* arch specific additions */ |
598 | struct dev_archdata archdata; | |
c9e358df GL |
599 | |
600 | struct device_node *of_node; /* associated device tree node */ | |
1da177e4 | 601 | |
929d2fa5 MW |
602 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
603 | ||
9ac7849e TH |
604 | spinlock_t devres_lock; |
605 | struct list_head devres_head; | |
606 | ||
5a3ceb86 | 607 | struct klist_node knode_class; |
b7a3e813 | 608 | struct class *class; |
a4dbd674 | 609 | const struct attribute_group **groups; /* optional groups */ |
23681e47 | 610 | |
d462943a | 611 | void (*release)(struct device *dev); |
1da177e4 LT |
612 | }; |
613 | ||
9a3df1f7 AS |
614 | /* Get the wakeup routines, which depend on struct device */ |
615 | #include <linux/pm_wakeup.h> | |
616 | ||
bf9ca69f | 617 | static inline const char *dev_name(const struct device *dev) |
06916639 | 618 | { |
a636ee7f PM |
619 | /* Use the init name until the kobject becomes available */ |
620 | if (dev->init_name) | |
621 | return dev->init_name; | |
622 | ||
1fa5ae85 | 623 | return kobject_name(&dev->kobj); |
06916639 KS |
624 | } |
625 | ||
b9075fa9 JP |
626 | extern __printf(2, 3) |
627 | int dev_set_name(struct device *dev, const char *name, ...); | |
413c239f | 628 | |
87348136 CH |
629 | #ifdef CONFIG_NUMA |
630 | static inline int dev_to_node(struct device *dev) | |
631 | { | |
632 | return dev->numa_node; | |
633 | } | |
634 | static inline void set_dev_node(struct device *dev, int node) | |
635 | { | |
636 | dev->numa_node = node; | |
637 | } | |
638 | #else | |
639 | static inline int dev_to_node(struct device *dev) | |
640 | { | |
641 | return -1; | |
642 | } | |
643 | static inline void set_dev_node(struct device *dev, int node) | |
644 | { | |
645 | } | |
646 | #endif | |
647 | ||
5c095a0e RW |
648 | static inline struct pm_subsys_data *dev_to_psd(struct device *dev) |
649 | { | |
650 | return dev ? dev->power.subsys_data : NULL; | |
651 | } | |
652 | ||
f67f129e ML |
653 | static inline unsigned int dev_get_uevent_suppress(const struct device *dev) |
654 | { | |
655 | return dev->kobj.uevent_suppress; | |
656 | } | |
657 | ||
658 | static inline void dev_set_uevent_suppress(struct device *dev, int val) | |
659 | { | |
660 | dev->kobj.uevent_suppress = val; | |
661 | } | |
662 | ||
d305ef5d DR |
663 | static inline int device_is_registered(struct device *dev) |
664 | { | |
3f62e570 | 665 | return dev->kobj.state_in_sysfs; |
d305ef5d DR |
666 | } |
667 | ||
5af84b82 RW |
668 | static inline void device_enable_async_suspend(struct device *dev) |
669 | { | |
f76b168b | 670 | if (!dev->power.is_prepared) |
5af84b82 RW |
671 | dev->power.async_suspend = true; |
672 | } | |
673 | ||
5a2eb858 RW |
674 | static inline void device_disable_async_suspend(struct device *dev) |
675 | { | |
f76b168b | 676 | if (!dev->power.is_prepared) |
5a2eb858 RW |
677 | dev->power.async_suspend = false; |
678 | } | |
679 | ||
680 | static inline bool device_async_suspend_enabled(struct device *dev) | |
681 | { | |
682 | return !!dev->power.async_suspend; | |
683 | } | |
684 | ||
8b258cc8 RW |
685 | static inline void pm_suspend_ignore_children(struct device *dev, bool enable) |
686 | { | |
687 | dev->power.ignore_children = enable; | |
688 | } | |
689 | ||
8e9394ce GKH |
690 | static inline void device_lock(struct device *dev) |
691 | { | |
3142788b | 692 | mutex_lock(&dev->mutex); |
8e9394ce GKH |
693 | } |
694 | ||
695 | static inline int device_trylock(struct device *dev) | |
696 | { | |
3142788b | 697 | return mutex_trylock(&dev->mutex); |
8e9394ce GKH |
698 | } |
699 | ||
700 | static inline void device_unlock(struct device *dev) | |
701 | { | |
3142788b | 702 | mutex_unlock(&dev->mutex); |
8e9394ce GKH |
703 | } |
704 | ||
1f21782e AB |
705 | void driver_init(void); |
706 | ||
1da177e4 LT |
707 | /* |
708 | * High level routines for use by the bus drivers | |
709 | */ | |
d462943a GKH |
710 | extern int __must_check device_register(struct device *dev); |
711 | extern void device_unregister(struct device *dev); | |
712 | extern void device_initialize(struct device *dev); | |
713 | extern int __must_check device_add(struct device *dev); | |
714 | extern void device_del(struct device *dev); | |
715 | extern int device_for_each_child(struct device *dev, void *data, | |
716 | int (*fn)(struct device *dev, void *data)); | |
717 | extern struct device *device_find_child(struct device *dev, void *data, | |
718 | int (*match)(struct device *dev, void *data)); | |
6937e8f8 | 719 | extern int device_rename(struct device *dev, const char *new_name); |
ffa6a705 CH |
720 | extern int device_move(struct device *dev, struct device *new_parent, |
721 | enum dpm_order dpm_order); | |
e454cea2 KS |
722 | extern const char *device_get_devnode(struct device *dev, |
723 | mode_t *mode, const char **tmp); | |
b4028437 | 724 | extern void *dev_get_drvdata(const struct device *dev); |
c8705082 | 725 | extern int dev_set_drvdata(struct device *dev, void *data); |
1da177e4 | 726 | |
0aa0dc41 MM |
727 | /* |
728 | * Root device objects for grouping under /sys/devices | |
729 | */ | |
730 | extern struct device *__root_device_register(const char *name, | |
731 | struct module *owner); | |
eb5589a8 PG |
732 | |
733 | /* | |
734 | * This is a macro to avoid include problems with THIS_MODULE, | |
735 | * just as per what is done for device_schedule_callback() above. | |
736 | */ | |
737 | #define root_device_register(name) \ | |
738 | __root_device_register(name, THIS_MODULE) | |
739 | ||
0aa0dc41 MM |
740 | extern void root_device_unregister(struct device *root); |
741 | ||
a5b8b1ad MB |
742 | static inline void *dev_get_platdata(const struct device *dev) |
743 | { | |
744 | return dev->platform_data; | |
745 | } | |
746 | ||
1da177e4 LT |
747 | /* |
748 | * Manual binding of a device to driver. See drivers/base/bus.c | |
749 | * for information on use. | |
750 | */ | |
f86db396 | 751 | extern int __must_check device_bind_driver(struct device *dev); |
d462943a GKH |
752 | extern void device_release_driver(struct device *dev); |
753 | extern int __must_check device_attach(struct device *dev); | |
f86db396 AM |
754 | extern int __must_check driver_attach(struct device_driver *drv); |
755 | extern int __must_check device_reprobe(struct device *dev); | |
1da177e4 | 756 | |
23681e47 GKH |
757 | /* |
758 | * Easy functions for dynamically creating devices on the fly | |
759 | */ | |
8882b394 GKH |
760 | extern struct device *device_create_vargs(struct class *cls, |
761 | struct device *parent, | |
762 | dev_t devt, | |
763 | void *drvdata, | |
764 | const char *fmt, | |
765 | va_list vargs); | |
b9075fa9 JP |
766 | extern __printf(5, 6) |
767 | struct device *device_create(struct class *cls, struct device *parent, | |
768 | dev_t devt, void *drvdata, | |
769 | const char *fmt, ...); | |
23681e47 | 770 | extern void device_destroy(struct class *cls, dev_t devt); |
1da177e4 | 771 | |
1da177e4 LT |
772 | /* |
773 | * Platform "fixup" functions - allow the platform to have their say | |
774 | * about devices and actions that the general device layer doesn't | |
775 | * know about. | |
776 | */ | |
777 | /* Notify platform of device discovery */ | |
d462943a | 778 | extern int (*platform_notify)(struct device *dev); |
1da177e4 | 779 | |
d462943a | 780 | extern int (*platform_notify_remove)(struct device *dev); |
1da177e4 LT |
781 | |
782 | ||
880ffb5c | 783 | /* |
1da177e4 LT |
784 | * get_device - atomically increment the reference count for the device. |
785 | * | |
786 | */ | |
d462943a GKH |
787 | extern struct device *get_device(struct device *dev); |
788 | extern void put_device(struct device *dev); | |
1da177e4 | 789 | |
d4d5291c | 790 | extern void wait_for_device_probe(void); |
1da177e4 | 791 | |
2b2af54a KS |
792 | #ifdef CONFIG_DEVTMPFS |
793 | extern int devtmpfs_create_node(struct device *dev); | |
794 | extern int devtmpfs_delete_node(struct device *dev); | |
073120cc | 795 | extern int devtmpfs_mount(const char *mntdir); |
2b2af54a KS |
796 | #else |
797 | static inline int devtmpfs_create_node(struct device *dev) { return 0; } | |
798 | static inline int devtmpfs_delete_node(struct device *dev) { return 0; } | |
799 | static inline int devtmpfs_mount(const char *mountpoint) { return 0; } | |
800 | #endif | |
801 | ||
116f232b | 802 | /* drivers/base/power/shutdown.c */ |
1da177e4 LT |
803 | extern void device_shutdown(void); |
804 | ||
1da177e4 | 805 | /* debugging and troubleshooting/diagnostic helpers. */ |
bf9ca69f | 806 | extern const char *dev_driver_string(const struct device *dev); |
99bcf217 JP |
807 | |
808 | ||
809 | #ifdef CONFIG_PRINTK | |
810 | ||
cbc46635 JP |
811 | extern int __dev_printk(const char *level, const struct device *dev, |
812 | struct va_format *vaf); | |
b9075fa9 JP |
813 | extern __printf(3, 4) |
814 | int dev_printk(const char *level, const struct device *dev, | |
815 | const char *fmt, ...) | |
816 | ; | |
817 | extern __printf(2, 3) | |
818 | int dev_emerg(const struct device *dev, const char *fmt, ...); | |
819 | extern __printf(2, 3) | |
820 | int dev_alert(const struct device *dev, const char *fmt, ...); | |
821 | extern __printf(2, 3) | |
822 | int dev_crit(const struct device *dev, const char *fmt, ...); | |
823 | extern __printf(2, 3) | |
824 | int dev_err(const struct device *dev, const char *fmt, ...); | |
825 | extern __printf(2, 3) | |
826 | int dev_warn(const struct device *dev, const char *fmt, ...); | |
827 | extern __printf(2, 3) | |
828 | int dev_notice(const struct device *dev, const char *fmt, ...); | |
829 | extern __printf(2, 3) | |
830 | int _dev_info(const struct device *dev, const char *fmt, ...); | |
99bcf217 JP |
831 | |
832 | #else | |
833 | ||
cbc46635 JP |
834 | static inline int __dev_printk(const char *level, const struct device *dev, |
835 | struct va_format *vaf) | |
b9075fa9 JP |
836 | { return 0; } |
837 | static inline __printf(3, 4) | |
838 | int dev_printk(const char *level, const struct device *dev, | |
839 | const char *fmt, ...) | |
840 | { return 0; } | |
841 | ||
842 | static inline __printf(2, 3) | |
843 | int dev_emerg(const struct device *dev, const char *fmt, ...) | |
844 | { return 0; } | |
845 | static inline __printf(2, 3) | |
846 | int dev_crit(const struct device *dev, const char *fmt, ...) | |
847 | { return 0; } | |
848 | static inline __printf(2, 3) | |
849 | int dev_alert(const struct device *dev, const char *fmt, ...) | |
850 | { return 0; } | |
851 | static inline __printf(2, 3) | |
852 | int dev_err(const struct device *dev, const char *fmt, ...) | |
853 | { return 0; } | |
854 | static inline __printf(2, 3) | |
855 | int dev_warn(const struct device *dev, const char *fmt, ...) | |
856 | { return 0; } | |
857 | static inline __printf(2, 3) | |
858 | int dev_notice(const struct device *dev, const char *fmt, ...) | |
859 | { return 0; } | |
860 | static inline __printf(2, 3) | |
861 | int _dev_info(const struct device *dev, const char *fmt, ...) | |
862 | { return 0; } | |
99bcf217 JP |
863 | |
864 | #endif | |
865 | ||
866 | /* | |
867 | * Stupid hackaround for existing uses of non-printk uses dev_info | |
868 | * | |
869 | * Note that the definition of dev_info below is actually _dev_info | |
870 | * and a macro is used to avoid redefining dev_info | |
871 | */ | |
872 | ||
873 | #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg) | |
7b8712e5 | 874 | |
d0d85ff9 CH |
875 | #if defined(DEBUG) |
876 | #define dev_dbg(dev, format, arg...) \ | |
99bcf217 | 877 | dev_printk(KERN_DEBUG, dev, format, ##arg) |
e9d376f0 | 878 | #elif defined(CONFIG_DYNAMIC_DEBUG) |
99bcf217 JP |
879 | #define dev_dbg(dev, format, ...) \ |
880 | do { \ | |
346e15be | 881 | dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \ |
99bcf217 | 882 | } while (0) |
1da177e4 | 883 | #else |
99bcf217 JP |
884 | #define dev_dbg(dev, format, arg...) \ |
885 | ({ \ | |
886 | if (0) \ | |
887 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ | |
888 | 0; \ | |
889 | }) | |
1da177e4 LT |
890 | #endif |
891 | ||
aebdc3b4 DB |
892 | #ifdef VERBOSE_DEBUG |
893 | #define dev_vdbg dev_dbg | |
894 | #else | |
99bcf217 JP |
895 | #define dev_vdbg(dev, format, arg...) \ |
896 | ({ \ | |
897 | if (0) \ | |
898 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ | |
899 | 0; \ | |
900 | }) | |
aebdc3b4 DB |
901 | #endif |
902 | ||
e6139662 | 903 | /* |
bcdd323b | 904 | * dev_WARN*() acts like dev_printk(), but with the key difference |
e6139662 AV |
905 | * of using a WARN/WARN_ON to get the message out, including the |
906 | * file/line information and a backtrace. | |
907 | */ | |
908 | #define dev_WARN(dev, format, arg...) \ | |
909 | WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg); | |
910 | ||
bcdd323b FB |
911 | #define dev_WARN_ONCE(dev, condition, format, arg...) \ |
912 | WARN_ONCE(condition, "Device %s\n" format, \ | |
913 | dev_driver_string(dev), ## arg) | |
914 | ||
1da177e4 LT |
915 | /* Create alias, so I can be autoloaded. */ |
916 | #define MODULE_ALIAS_CHARDEV(major,minor) \ | |
917 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) | |
918 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ | |
919 | MODULE_ALIAS("char-major-" __stringify(major) "-*") | |
e52eec13 AK |
920 | |
921 | #ifdef CONFIG_SYSFS_DEPRECATED | |
922 | extern long sysfs_deprecated; | |
923 | #else | |
924 | #define sysfs_deprecated 0 | |
925 | #endif | |
926 | ||
1da177e4 | 927 | #endif /* _DEVICE_H_ */ |