Commit | Line | Data |
---|---|---|
989d42e8 | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 LT |
2 | /* |
3 | * device.h - generic, centralized driver model | |
4 | * | |
5 | * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> | |
b4028437 GKH |
6 | * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> |
7 | * Copyright (c) 2008-2009 Novell Inc. | |
1da177e4 | 8 | * |
fe34c89d | 9 | * See Documentation/driver-api/driver-model/ for more information. |
1da177e4 LT |
10 | */ |
11 | ||
12 | #ifndef _DEVICE_H_ | |
13 | #define _DEVICE_H_ | |
14 | ||
af628aae | 15 | #include <linux/dev_printk.h> |
1bc138c6 | 16 | #include <linux/energy_model.h> |
1da177e4 LT |
17 | #include <linux/ioport.h> |
18 | #include <linux/kobject.h> | |
465c7a3a | 19 | #include <linux/klist.h> |
1da177e4 | 20 | #include <linux/list.h> |
d2a3b914 | 21 | #include <linux/lockdep.h> |
4a7fb636 | 22 | #include <linux/compiler.h> |
1da177e4 | 23 | #include <linux/types.h> |
de477254 | 24 | #include <linux/mutex.h> |
1da177e4 | 25 | #include <linux/pm.h> |
60063497 | 26 | #include <linux/atomic.h> |
3c2670e6 | 27 | #include <linux/uidgid.h> |
64c862a8 | 28 | #include <linux/gfp.h> |
2509b561 | 29 | #include <linux/overflow.h> |
5aee2bf2 | 30 | #include <linux/device/bus.h> |
a8ae6085 | 31 | #include <linux/device/class.h> |
4c002c97 | 32 | #include <linux/device/driver.h> |
c6dbaef2 | 33 | #include <asm/device.h> |
1da177e4 | 34 | |
1da177e4 | 35 | struct device; |
fb069a5d | 36 | struct device_private; |
1da177e4 | 37 | struct device_driver; |
e5dd1278 | 38 | struct driver_private; |
de477254 | 39 | struct module; |
1da177e4 | 40 | struct class; |
6b6e39a6 | 41 | struct subsys_private; |
d706c1b0 | 42 | struct device_node; |
ce793486 | 43 | struct fwnode_handle; |
ff21776d | 44 | struct iommu_ops; |
74416e1e | 45 | struct iommu_group; |
23c35f48 | 46 | struct dev_pin_info; |
045a7042 | 47 | struct dev_iommu; |
013bd8e5 | 48 | struct msi_device_data; |
b8c5cec2 | 49 | |
ca22e56d KS |
50 | /** |
51 | * struct subsys_interface - interfaces to device functions | |
2eda013f | 52 | * @name: name of the device function |
5dd5f934 | 53 | * @subsys: subsystem of the devices to attach to |
2eda013f RD |
54 | * @node: the list of functions registered at the subsystem |
55 | * @add_dev: device hookup to device function handler | |
56 | * @remove_dev: device hookup to device function handler | |
ca22e56d KS |
57 | * |
58 | * Simple interfaces attached to a subsystem. Multiple interfaces can | |
59 | * attach to a subsystem and its devices. Unlike drivers, they do not | |
60 | * exclusively claim or control devices. Interfaces usually represent | |
61 | * a specific functionality of a subsystem/class of devices. | |
62 | */ | |
63 | struct subsys_interface { | |
64 | const char *name; | |
65 | struct bus_type *subsys; | |
66 | struct list_head node; | |
67 | int (*add_dev)(struct device *dev, struct subsys_interface *sif); | |
71db87ba | 68 | void (*remove_dev)(struct device *dev, struct subsys_interface *sif); |
ca22e56d KS |
69 | }; |
70 | ||
71 | int subsys_interface_register(struct subsys_interface *sif); | |
72 | void subsys_interface_unregister(struct subsys_interface *sif); | |
73 | ||
74 | int subsys_system_register(struct bus_type *subsys, | |
75 | const struct attribute_group **groups); | |
d73ce004 TH |
76 | int subsys_virtual_register(struct bus_type *subsys, |
77 | const struct attribute_group **groups); | |
ca22e56d | 78 | |
414264f9 KS |
79 | /* |
80 | * The type of device, "struct device" is embedded in. A class | |
81 | * or bus can contain devices of different types | |
82 | * like "partitions" and "disks", "mouse" and "event". | |
83 | * This identifies the device type and carries type-specific | |
84 | * information, equivalent to the kobj_type of a kobject. | |
85 | * If "name" is specified, the uevent will contain it in | |
86 | * the DEVTYPE variable. | |
87 | */ | |
f9f852df | 88 | struct device_type { |
414264f9 | 89 | const char *name; |
a4dbd674 | 90 | const struct attribute_group **groups; |
7eff2e7a | 91 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
3c2670e6 | 92 | char *(*devnode)(struct device *dev, umode_t *mode, |
4e4098a3 | 93 | kuid_t *uid, kgid_t *gid); |
f9f852df | 94 | void (*release)(struct device *dev); |
1eede070 | 95 | |
8150f32b | 96 | const struct dev_pm_ops *pm; |
f9f852df KS |
97 | }; |
98 | ||
a7fd6706 KS |
99 | /* interface for exporting device attributes */ |
100 | struct device_attribute { | |
101 | struct attribute attr; | |
102 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, | |
103 | char *buf); | |
104 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, | |
105 | const char *buf, size_t count); | |
106 | }; | |
107 | ||
ca22e56d KS |
108 | struct dev_ext_attribute { |
109 | struct device_attribute attr; | |
110 | void *var; | |
111 | }; | |
112 | ||
113 | ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr, | |
114 | char *buf); | |
115 | ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr, | |
116 | const char *buf, size_t count); | |
117 | ssize_t device_show_int(struct device *dev, struct device_attribute *attr, | |
118 | char *buf); | |
119 | ssize_t device_store_int(struct device *dev, struct device_attribute *attr, | |
120 | const char *buf, size_t count); | |
91872392 BP |
121 | ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, |
122 | char *buf); | |
123 | ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, | |
124 | const char *buf, size_t count); | |
a7fd6706 | 125 | |
d462943a | 126 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
ca22e56d | 127 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) |
7fda9100 CL |
128 | #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \ |
129 | struct device_attribute dev_attr_##_name = \ | |
130 | __ATTR_PREALLOC(_name, _mode, _show, _store) | |
ced321bf GKH |
131 | #define DEVICE_ATTR_RW(_name) \ |
132 | struct device_attribute dev_attr_##_name = __ATTR_RW(_name) | |
3022c6a1 DW |
133 | #define DEVICE_ATTR_ADMIN_RW(_name) \ |
134 | struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600) | |
ced321bf GKH |
135 | #define DEVICE_ATTR_RO(_name) \ |
136 | struct device_attribute dev_attr_##_name = __ATTR_RO(_name) | |
3022c6a1 DW |
137 | #define DEVICE_ATTR_ADMIN_RO(_name) \ |
138 | struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400) | |
1130c55c GKH |
139 | #define DEVICE_ATTR_WO(_name) \ |
140 | struct device_attribute dev_attr_##_name = __ATTR_WO(_name) | |
ca22e56d KS |
141 | #define DEVICE_ULONG_ATTR(_name, _mode, _var) \ |
142 | struct dev_ext_attribute dev_attr_##_name = \ | |
143 | { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) } | |
144 | #define DEVICE_INT_ATTR(_name, _mode, _var) \ | |
145 | struct dev_ext_attribute dev_attr_##_name = \ | |
94758185 | 146 | { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) } |
91872392 BP |
147 | #define DEVICE_BOOL_ATTR(_name, _mode, _var) \ |
148 | struct dev_ext_attribute dev_attr_##_name = \ | |
149 | { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) } | |
356c05d5 AS |
150 | #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ |
151 | struct device_attribute dev_attr_##_name = \ | |
152 | __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) | |
a7fd6706 | 153 | |
67dd0772 BG |
154 | int device_create_file(struct device *device, |
155 | const struct device_attribute *entry); | |
156 | void device_remove_file(struct device *dev, | |
157 | const struct device_attribute *attr); | |
158 | bool device_remove_file_self(struct device *dev, | |
159 | const struct device_attribute *attr); | |
160 | int __must_check device_create_bin_file(struct device *dev, | |
66ecb92b | 161 | const struct bin_attribute *attr); |
67dd0772 BG |
162 | void device_remove_bin_file(struct device *dev, |
163 | const struct bin_attribute *attr); | |
9ac7849e TH |
164 | |
165 | /* device resource management */ | |
166 | typedef void (*dr_release_t)(struct device *dev, void *res); | |
167 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); | |
168 | ||
67dd0772 BG |
169 | void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, |
170 | int nid, const char *name) __malloc; | |
9ac7849e | 171 | #define devres_alloc(release, size, gfp) \ |
7c683941 DW |
172 | __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release) |
173 | #define devres_alloc_node(release, size, gfp, nid) \ | |
174 | __devres_alloc_node(release, size, gfp, nid, #release) | |
7c683941 | 175 | |
67dd0772 BG |
176 | void devres_for_each_res(struct device *dev, dr_release_t release, |
177 | dr_match_t match, void *match_data, | |
178 | void (*fn)(struct device *, void *, void *), | |
179 | void *data); | |
180 | void devres_free(void *res); | |
181 | void devres_add(struct device *dev, void *res); | |
182 | void *devres_find(struct device *dev, dr_release_t release, | |
183 | dr_match_t match, void *match_data); | |
184 | void *devres_get(struct device *dev, void *new_res, | |
185 | dr_match_t match, void *match_data); | |
186 | void *devres_remove(struct device *dev, dr_release_t release, | |
187 | dr_match_t match, void *match_data); | |
188 | int devres_destroy(struct device *dev, dr_release_t release, | |
189 | dr_match_t match, void *match_data); | |
190 | int devres_release(struct device *dev, dr_release_t release, | |
191 | dr_match_t match, void *match_data); | |
9ac7849e TH |
192 | |
193 | /* devres group */ | |
67dd0772 BG |
194 | void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp); |
195 | void devres_close_group(struct device *dev, void *id); | |
196 | void devres_remove_group(struct device *dev, void *id); | |
197 | int devres_release_group(struct device *dev, void *id); | |
9ac7849e | 198 | |
64c862a8 | 199 | /* managed devm_k.alloc/kfree for device drivers */ |
67dd0772 | 200 | void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc; |
f8248572 BG |
201 | void *devm_krealloc(struct device *dev, void *ptr, size_t size, |
202 | gfp_t gfp) __must_check; | |
67dd0772 BG |
203 | __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp, |
204 | const char *fmt, va_list ap) __malloc; | |
205 | __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp, | |
206 | const char *fmt, ...) __malloc; | |
64c862a8 JP |
207 | static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp) |
208 | { | |
209 | return devm_kmalloc(dev, size, gfp | __GFP_ZERO); | |
210 | } | |
211 | static inline void *devm_kmalloc_array(struct device *dev, | |
212 | size_t n, size_t size, gfp_t flags) | |
213 | { | |
2509b561 KC |
214 | size_t bytes; |
215 | ||
216 | if (unlikely(check_mul_overflow(n, size, &bytes))) | |
64c862a8 | 217 | return NULL; |
2509b561 KC |
218 | |
219 | return devm_kmalloc(dev, bytes, flags); | |
64c862a8 JP |
220 | } |
221 | static inline void *devm_kcalloc(struct device *dev, | |
222 | size_t n, size_t size, gfp_t flags) | |
223 | { | |
224 | return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO); | |
225 | } | |
67dd0772 BG |
226 | void devm_kfree(struct device *dev, const void *p); |
227 | char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc; | |
228 | const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp); | |
229 | void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp); | |
9ac7849e | 230 | |
67dd0772 BG |
231 | unsigned long devm_get_free_pages(struct device *dev, |
232 | gfp_t gfp_mask, unsigned int order); | |
233 | void devm_free_pages(struct device *dev, unsigned long addr); | |
9ac7849e | 234 | |
eef778c9 AB |
235 | void __iomem *devm_ioremap_resource(struct device *dev, |
236 | const struct resource *res); | |
b873af62 BG |
237 | void __iomem *devm_ioremap_resource_wc(struct device *dev, |
238 | const struct resource *res); | |
72f8c0bf | 239 | |
d5e83827 BH |
240 | void __iomem *devm_of_iomap(struct device *dev, |
241 | struct device_node *node, int index, | |
242 | resource_size_t *size); | |
243 | ||
d6b0c580 DT |
244 | /* allows to add/remove a custom action to devres stack */ |
245 | int devm_add_action(struct device *dev, void (*action)(void *), void *data); | |
246 | void devm_remove_action(struct device *dev, void (*action)(void *), void *data); | |
2374b682 | 247 | void devm_release_action(struct device *dev, void (*action)(void *), void *data); |
d6b0c580 | 248 | |
a3499e9b SM |
249 | static inline int devm_add_action_or_reset(struct device *dev, |
250 | void (*action)(void *), void *data) | |
251 | { | |
252 | int ret; | |
253 | ||
254 | ret = devm_add_action(dev, action, data); | |
255 | if (ret) | |
256 | action(data); | |
257 | ||
258 | return ret; | |
259 | } | |
260 | ||
ff86aae3 MB |
261 | /** |
262 | * devm_alloc_percpu - Resource-managed alloc_percpu | |
263 | * @dev: Device to allocate per-cpu memory for | |
264 | * @type: Type to allocate per-cpu memory for | |
265 | * | |
266 | * Managed alloc_percpu. Per-cpu memory allocated with this function is | |
267 | * automatically freed on driver detach. | |
268 | * | |
269 | * RETURNS: | |
270 | * Pointer to allocated memory on success, NULL on failure. | |
271 | */ | |
272 | #define devm_alloc_percpu(dev, type) \ | |
273 | ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \ | |
274 | __alignof__(type))) | |
275 | ||
276 | void __percpu *__devm_alloc_percpu(struct device *dev, size_t size, | |
277 | size_t align); | |
278 | void devm_free_percpu(struct device *dev, void __percpu *pdata); | |
279 | ||
6b7b6510 FT |
280 | struct device_dma_parameters { |
281 | /* | |
282 | * a low level driver may set these to teach IOMMU code about | |
283 | * sg limitations. | |
284 | */ | |
285 | unsigned int max_segment_size; | |
36950f2d | 286 | unsigned int min_align_mask; |
6b7b6510 FT |
287 | unsigned long segment_boundary_mask; |
288 | }; | |
289 | ||
9ed98953 RW |
290 | /** |
291 | * enum device_link_state - Device link states. | |
292 | * @DL_STATE_NONE: The presence of the drivers is not being tracked. | |
293 | * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. | |
294 | * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. | |
295 | * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). | |
296 | * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. | |
297 | * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. | |
298 | */ | |
299 | enum device_link_state { | |
300 | DL_STATE_NONE = -1, | |
301 | DL_STATE_DORMANT = 0, | |
302 | DL_STATE_AVAILABLE, | |
303 | DL_STATE_CONSUMER_PROBE, | |
304 | DL_STATE_ACTIVE, | |
305 | DL_STATE_SUPPLIER_UNBIND, | |
306 | }; | |
307 | ||
308 | /* | |
309 | * Device link flags. | |
310 | * | |
515db266 | 311 | * STATELESS: The core will not remove this link automatically. |
e88728f4 | 312 | * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind. |
21d5c57b RW |
313 | * PM_RUNTIME: If set, the runtime PM framework will use this link. |
314 | * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. | |
1689cac5 | 315 | * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind. |
e7dd4010 | 316 | * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds. |
515db266 | 317 | * MANAGED: The core tracks presence of supplier/consumer drivers (internal). |
05ef983e | 318 | * SYNC_STATE_ONLY: Link only affects sync_state() behavior. |
4b9bbb29 | 319 | * INFERRED: Inferred from data (eg: firmware) and not from driver actions. |
9ed98953 | 320 | */ |
e88728f4 VG |
321 | #define DL_FLAG_STATELESS BIT(0) |
322 | #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1) | |
323 | #define DL_FLAG_PM_RUNTIME BIT(2) | |
324 | #define DL_FLAG_RPM_ACTIVE BIT(3) | |
1689cac5 | 325 | #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4) |
e7dd4010 | 326 | #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5) |
515db266 | 327 | #define DL_FLAG_MANAGED BIT(6) |
05ef983e | 328 | #define DL_FLAG_SYNC_STATE_ONLY BIT(7) |
4b9bbb29 | 329 | #define DL_FLAG_INFERRED BIT(8) |
9ed98953 | 330 | |
9ed98953 RW |
331 | /** |
332 | * enum dl_dev_state - Device driver presence tracking information. | |
333 | * @DL_DEV_NO_DRIVER: There is no driver attached to the device. | |
334 | * @DL_DEV_PROBING: A driver is probing. | |
335 | * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. | |
336 | * @DL_DEV_UNBINDING: The driver is unbinding from the device. | |
337 | */ | |
338 | enum dl_dev_state { | |
339 | DL_DEV_NO_DRIVER = 0, | |
340 | DL_DEV_PROBING, | |
341 | DL_DEV_DRIVER_BOUND, | |
342 | DL_DEV_UNBINDING, | |
343 | }; | |
344 | ||
70f400d4 RJ |
345 | /** |
346 | * enum device_removable - Whether the device is removable. The criteria for a | |
347 | * device to be classified as removable is determined by its subsystem or bus. | |
348 | * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this | |
349 | * device (default). | |
350 | * @DEVICE_REMOVABLE_UNKNOWN: Device location is Unknown. | |
351 | * @DEVICE_FIXED: Device is not removable by the user. | |
352 | * @DEVICE_REMOVABLE: Device is removable by the user. | |
353 | */ | |
354 | enum device_removable { | |
355 | DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */ | |
356 | DEVICE_REMOVABLE_UNKNOWN, | |
357 | DEVICE_FIXED, | |
358 | DEVICE_REMOVABLE, | |
359 | }; | |
360 | ||
9ed98953 RW |
361 | /** |
362 | * struct dev_links_info - Device data related to device links. | |
363 | * @suppliers: List of links to supplier devices. | |
364 | * @consumers: List of links to consumer devices. | |
3b052a3e | 365 | * @defer_sync: Hook to global list of devices that have deferred sync_state. |
9ed98953 RW |
366 | * @status: Driver status information. |
367 | */ | |
368 | struct dev_links_info { | |
369 | struct list_head suppliers; | |
370 | struct list_head consumers; | |
3b052a3e | 371 | struct list_head defer_sync; |
9ed98953 RW |
372 | enum dl_dev_state status; |
373 | }; | |
374 | ||
34fff628 TG |
375 | /** |
376 | * struct dev_msi_info - Device data related to MSI | |
377 | * @domain: The MSI interrupt domain associated to the device | |
013bd8e5 | 378 | * @data: Pointer to MSI device data |
34fff628 TG |
379 | */ |
380 | struct dev_msi_info { | |
381 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN | |
382 | struct irq_domain *domain; | |
383 | #endif | |
013bd8e5 TG |
384 | #ifdef CONFIG_GENERIC_MSI_IRQ |
385 | struct msi_device_data *data; | |
386 | #endif | |
34fff628 TG |
387 | }; |
388 | ||
880ffb5c WG |
389 | /** |
390 | * struct device - The basic device structure | |
391 | * @parent: The device's "parent" device, the device to which it is attached. | |
392 | * In most cases, a parent device is some sort of bus or host | |
393 | * controller. If parent is NULL, the device, is a top-level device, | |
394 | * which is not usually what you want. | |
395 | * @p: Holds the private data of the driver core portions of the device. | |
396 | * See the comment of the struct device_private for detail. | |
397 | * @kobj: A top-level, abstract class from which other classes are derived. | |
398 | * @init_name: Initial name of the device. | |
399 | * @type: The type of device. | |
400 | * This identifies the device type and carries type-specific | |
401 | * information. | |
402 | * @mutex: Mutex to synchronize calls to its driver. | |
403 | * @bus: Type of bus device is on. | |
404 | * @driver: Which driver has allocated this | |
405 | * @platform_data: Platform data specific to the device. | |
406 | * Example: For devices on custom boards, as typical of embedded | |
407 | * and SOC based hardware, Linux often uses platform_data to point | |
408 | * to board-specific structures describing devices and how they | |
409 | * are wired. That can include what ports are available, chip | |
410 | * variants, which GPIO pins act in what additional roles, and so | |
411 | * on. This shrinks the "Board Support Packages" (BSPs) and | |
412 | * minimizes board-specific #ifdefs in drivers. | |
1bb6c08a | 413 | * @driver_data: Private pointer for driver specific info. |
64df1148 | 414 | * @links: Links to suppliers and consumers of this device. |
880ffb5c | 415 | * @power: For device power management. |
74378c5c | 416 | * See Documentation/driver-api/pm/devices.rst for details. |
564b905a | 417 | * @pm_domain: Provide callbacks that are executed during system suspend, |
880ffb5c WG |
418 | * hibernation, system resume and during runtime PM transitions |
419 | * along with subsystem-level and driver-level callbacks. | |
95035eac | 420 | * @em_pd: device's energy model performance domain |
ab78029e | 421 | * @pins: For device pin management. |
4b0c9948 | 422 | * See Documentation/driver-api/pin-control.rst for details. |
34fff628 | 423 | * @msi: MSI related data |
880ffb5c | 424 | * @numa_node: NUMA node this device is close to. |
6a7a8176 | 425 | * @dma_ops: DMA mapping operations for this device. |
880ffb5c WG |
426 | * @dma_mask: Dma mask (if dma'ble device). |
427 | * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all | |
428 | * hardware supports 64-bit addresses for consistent allocations | |
429 | * such descriptors. | |
a7ba70f1 NSJ |
430 | * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller |
431 | * DMA limit than the device itself supports. | |
e0d07278 | 432 | * @dma_range_map: map for DMA memory ranges relative to that of RAM |
880ffb5c WG |
433 | * @dma_parms: A low level driver may set these to teach IOMMU code about |
434 | * segment limitations. | |
435 | * @dma_pools: Dma pools (if dma'ble device). | |
436 | * @dma_mem: Internal for coherent mem override. | |
bfd63cd2 | 437 | * @cma_area: Contiguous memory area for dma allocations |
69031f50 | 438 | * @dma_io_tlb_mem: Pointer to the swiotlb pool used. Not for driver use. |
880ffb5c WG |
439 | * @archdata: For arch-specific additions. |
440 | * @of_node: Associated device tree node. | |
ce793486 | 441 | * @fwnode: Associated device node supplied by platform firmware. |
880ffb5c | 442 | * @devt: For creating the sysfs "dev". |
2eda013f | 443 | * @id: device instance |
880ffb5c WG |
444 | * @devres_lock: Spinlock to protect the resource of the device. |
445 | * @devres_head: The resources list of the device. | |
446 | * @knode_class: The node used to add the device to the class list. | |
447 | * @class: The class of the device. | |
448 | * @groups: Optional attribute groups. | |
449 | * @release: Callback to free the device after all references have | |
450 | * gone away. This should be set by the allocator of the | |
451 | * device (i.e. the bus driver that discovered the device). | |
bfd63cd2 | 452 | * @iommu_group: IOMMU group the device belongs to. |
045a7042 | 453 | * @iommu: Per device generic IOMMU runtime data |
70f400d4 RJ |
454 | * @removable: Whether the device can be removed from the system. This |
455 | * should be set by the subsystem / bus driver that discovered | |
456 | * the device. | |
880ffb5c | 457 | * |
4f3549d7 RW |
458 | * @offline_disabled: If set, the device is permanently online. |
459 | * @offline: Set after successful invocation of bus type's .offline(). | |
4e75e1d7 JH |
460 | * @of_node_reused: Set if the device-tree node is shared with an ancestor |
461 | * device. | |
fc5a251d SK |
462 | * @state_synced: The hardware state of this device has been synced to match |
463 | * the software state of this device by calling the driver/bus | |
464 | * sync_state() callback. | |
f2db85b6 SK |
465 | * @can_match: The device has matched with a driver at least once or it is in |
466 | * a bus (like AMBA) which can't check for matching drivers until | |
467 | * other devices probe successfully. | |
f3ecc0ff CH |
468 | * @dma_coherent: this particular device is dma coherent, even if the |
469 | * architecture supports non-coherent devices. | |
d35834c6 CH |
470 | * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the |
471 | * streaming DMA operations (->map_* / ->unmap_* / ->sync_*), | |
472 | * and optionall (if the coherent mask is large enough) also | |
473 | * for dma allocations. This flag is managed by the dma ops | |
474 | * instance from ->dma_supported. | |
880ffb5c WG |
475 | * |
476 | * At the lowest level, every device in a Linux system is represented by an | |
477 | * instance of struct device. The device structure contains the information | |
478 | * that the device model core needs to model the system. Most subsystems, | |
479 | * however, track additional information about the devices they host. As a | |
480 | * result, it is rare for devices to be represented by bare device structures; | |
481 | * instead, that structure, like kobject structures, is usually embedded within | |
482 | * a higher-level representation of the device. | |
483 | */ | |
1da177e4 | 484 | struct device { |
159ef31e | 485 | struct kobject kobj; |
49a4ec18 | 486 | struct device *parent; |
1da177e4 | 487 | |
fb069a5d GKH |
488 | struct device_private *p; |
489 | ||
c906a48a | 490 | const char *init_name; /* initial name of the device */ |
aed65af1 | 491 | const struct device_type *type; |
1da177e4 | 492 | |
d462943a | 493 | struct bus_type *bus; /* type of bus device is on */ |
1da177e4 LT |
494 | struct device_driver *driver; /* which driver has allocated this |
495 | device */ | |
e67c8562 GKH |
496 | void *platform_data; /* Platform specific data, device |
497 | core doesn't touch it */ | |
1bb6c08a | 498 | void *driver_data; /* Driver data, set and get with |
2c6f4fc8 | 499 | dev_set_drvdata/dev_get_drvdata */ |
159ef31e GKH |
500 | struct mutex mutex; /* mutex to synchronize calls to |
501 | * its driver. | |
502 | */ | |
503 | ||
9ed98953 | 504 | struct dev_links_info links; |
1da177e4 | 505 | struct dev_pm_info power; |
564b905a | 506 | struct dev_pm_domain *pm_domain; |
1da177e4 | 507 | |
1bc138c6 LL |
508 | #ifdef CONFIG_ENERGY_MODEL |
509 | struct em_perf_domain *em_pd; | |
510 | #endif | |
511 | ||
ab78029e LW |
512 | #ifdef CONFIG_PINCTRL |
513 | struct dev_pin_info *pins; | |
514 | #endif | |
34fff628 | 515 | struct dev_msi_info msi; |
2f9237d4 | 516 | #ifdef CONFIG_DMA_OPS |
5657933d | 517 | const struct dma_map_ops *dma_ops; |
2f9237d4 | 518 | #endif |
1da177e4 LT |
519 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
520 | u64 coherent_dma_mask;/* Like dma_mask, but for | |
521 | alloc_coherent mappings as | |
522 | not all hardware supports | |
523 | 64 bit addresses for consistent | |
524 | allocations such descriptors. */ | |
a7ba70f1 | 525 | u64 bus_dma_limit; /* upstream dma constraint */ |
e0d07278 | 526 | const struct bus_dma_region *dma_range_map; |
1da177e4 | 527 | |
6b7b6510 FT |
528 | struct device_dma_parameters *dma_parms; |
529 | ||
1da177e4 LT |
530 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
531 | ||
ff4c25f2 | 532 | #ifdef CONFIG_DMA_DECLARE_COHERENT |
1da177e4 LT |
533 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
534 | override */ | |
2b281296 | 535 | #endif |
a2547380 | 536 | #ifdef CONFIG_DMA_CMA |
c64be2bb MS |
537 | struct cma *cma_area; /* contiguous memory area for dma |
538 | allocations */ | |
69031f50 CC |
539 | #endif |
540 | #ifdef CONFIG_SWIOTLB | |
541 | struct io_tlb_mem *dma_io_tlb_mem; | |
c64be2bb | 542 | #endif |
c6dbaef2 BH |
543 | /* arch specific additions */ |
544 | struct dev_archdata archdata; | |
c9e358df GL |
545 | |
546 | struct device_node *of_node; /* associated device tree node */ | |
ce793486 | 547 | struct fwnode_handle *fwnode; /* firmware device node */ |
1da177e4 | 548 | |
159ef31e GKH |
549 | #ifdef CONFIG_NUMA |
550 | int numa_node; /* NUMA node this device is close to */ | |
551 | #endif | |
929d2fa5 | 552 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
ca22e56d | 553 | u32 id; /* device instance */ |
929d2fa5 | 554 | |
9ac7849e TH |
555 | spinlock_t devres_lock; |
556 | struct list_head devres_head; | |
557 | ||
b7a3e813 | 558 | struct class *class; |
a4dbd674 | 559 | const struct attribute_group **groups; /* optional groups */ |
23681e47 | 560 | |
d462943a | 561 | void (*release)(struct device *dev); |
74416e1e | 562 | struct iommu_group *iommu_group; |
045a7042 | 563 | struct dev_iommu *iommu; |
4f3549d7 | 564 | |
70f400d4 RJ |
565 | enum device_removable removable; |
566 | ||
4f3549d7 RW |
567 | bool offline_disabled:1; |
568 | bool offline:1; | |
4e75e1d7 | 569 | bool of_node_reused:1; |
fc5a251d | 570 | bool state_synced:1; |
f2db85b6 | 571 | bool can_match:1; |
f3ecc0ff CH |
572 | #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ |
573 | defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ | |
574 | defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) | |
575 | bool dma_coherent:1; | |
576 | #endif | |
d35834c6 CH |
577 | #ifdef CONFIG_DMA_OPS_BYPASS |
578 | bool dma_ops_bypass : 1; | |
579 | #endif | |
1da177e4 LT |
580 | }; |
581 | ||
287905e6 SK |
582 | /** |
583 | * struct device_link - Device link representation. | |
584 | * @supplier: The device on the supplier end of the link. | |
585 | * @s_node: Hook to the supplier device's list of links to consumers. | |
586 | * @consumer: The device on the consumer end of the link. | |
587 | * @c_node: Hook to the consumer device's list of links to suppliers. | |
588 | * @link_dev: device used to expose link details in sysfs | |
589 | * @status: The state of the link (with respect to the presence of drivers). | |
590 | * @flags: Link flags. | |
591 | * @rpm_active: Whether or not the consumer device is runtime-PM-active. | |
592 | * @kref: Count repeated addition of the same link. | |
80dd33cf | 593 | * @rm_work: Work structure used for removing the link. |
287905e6 SK |
594 | * @supplier_preactivated: Supplier has been made active before consumer probe. |
595 | */ | |
596 | struct device_link { | |
597 | struct device *supplier; | |
598 | struct list_head s_node; | |
599 | struct device *consumer; | |
600 | struct list_head c_node; | |
601 | struct device link_dev; | |
602 | enum device_link_state status; | |
603 | u32 flags; | |
604 | refcount_t rpm_active; | |
605 | struct kref kref; | |
80dd33cf | 606 | struct work_struct rm_work; |
287905e6 SK |
607 | bool supplier_preactivated; /* Owned by consumer probe. */ |
608 | }; | |
609 | ||
a4232963 LPC |
610 | static inline struct device *kobj_to_dev(struct kobject *kobj) |
611 | { | |
612 | return container_of(kobj, struct device, kobj); | |
613 | } | |
614 | ||
dbba197e JR |
615 | /** |
616 | * device_iommu_mapped - Returns true when the device DMA is translated | |
617 | * by an IOMMU | |
618 | * @dev: Device to perform the check on | |
619 | */ | |
620 | static inline bool device_iommu_mapped(struct device *dev) | |
621 | { | |
622 | return (dev->iommu_group != NULL); | |
623 | } | |
624 | ||
9a3df1f7 AS |
625 | /* Get the wakeup routines, which depend on struct device */ |
626 | #include <linux/pm_wakeup.h> | |
627 | ||
bf9ca69f | 628 | static inline const char *dev_name(const struct device *dev) |
06916639 | 629 | { |
a636ee7f PM |
630 | /* Use the init name until the kobject becomes available */ |
631 | if (dev->init_name) | |
632 | return dev->init_name; | |
633 | ||
1fa5ae85 | 634 | return kobject_name(&dev->kobj); |
06916639 KS |
635 | } |
636 | ||
e020ff61 SK |
637 | /** |
638 | * dev_bus_name - Return a device's bus/class name, if at all possible | |
639 | * @dev: struct device to get the bus/class name of | |
640 | * | |
641 | * Will return the name of the bus/class the device is attached to. If it is | |
642 | * not attached to a bus/class, an empty string will be returned. | |
643 | */ | |
644 | static inline const char *dev_bus_name(const struct device *dev) | |
645 | { | |
646 | return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : ""); | |
647 | } | |
648 | ||
67dd0772 | 649 | __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...); |
413c239f | 650 | |
87348136 CH |
651 | #ifdef CONFIG_NUMA |
652 | static inline int dev_to_node(struct device *dev) | |
653 | { | |
654 | return dev->numa_node; | |
655 | } | |
656 | static inline void set_dev_node(struct device *dev, int node) | |
657 | { | |
658 | dev->numa_node = node; | |
659 | } | |
660 | #else | |
661 | static inline int dev_to_node(struct device *dev) | |
662 | { | |
98fa15f3 | 663 | return NUMA_NO_NODE; |
87348136 CH |
664 | } |
665 | static inline void set_dev_node(struct device *dev, int node) | |
666 | { | |
667 | } | |
668 | #endif | |
669 | ||
f1421db8 MZ |
670 | static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) |
671 | { | |
672 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN | |
34fff628 | 673 | return dev->msi.domain; |
f1421db8 MZ |
674 | #else |
675 | return NULL; | |
676 | #endif | |
677 | } | |
678 | ||
679 | static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) | |
680 | { | |
681 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN | |
34fff628 | 682 | dev->msi.domain = d; |
f1421db8 MZ |
683 | #endif |
684 | } | |
685 | ||
a996d010 JD |
686 | static inline void *dev_get_drvdata(const struct device *dev) |
687 | { | |
688 | return dev->driver_data; | |
689 | } | |
690 | ||
691 | static inline void dev_set_drvdata(struct device *dev, void *data) | |
692 | { | |
693 | dev->driver_data = data; | |
694 | } | |
695 | ||
5c095a0e RW |
696 | static inline struct pm_subsys_data *dev_to_psd(struct device *dev) |
697 | { | |
698 | return dev ? dev->power.subsys_data : NULL; | |
699 | } | |
700 | ||
f67f129e ML |
701 | static inline unsigned int dev_get_uevent_suppress(const struct device *dev) |
702 | { | |
703 | return dev->kobj.uevent_suppress; | |
704 | } | |
705 | ||
706 | static inline void dev_set_uevent_suppress(struct device *dev, int val) | |
707 | { | |
708 | dev->kobj.uevent_suppress = val; | |
709 | } | |
710 | ||
d305ef5d DR |
711 | static inline int device_is_registered(struct device *dev) |
712 | { | |
3f62e570 | 713 | return dev->kobj.state_in_sysfs; |
d305ef5d DR |
714 | } |
715 | ||
5af84b82 RW |
716 | static inline void device_enable_async_suspend(struct device *dev) |
717 | { | |
f76b168b | 718 | if (!dev->power.is_prepared) |
5af84b82 RW |
719 | dev->power.async_suspend = true; |
720 | } | |
721 | ||
5a2eb858 RW |
722 | static inline void device_disable_async_suspend(struct device *dev) |
723 | { | |
f76b168b | 724 | if (!dev->power.is_prepared) |
5a2eb858 RW |
725 | dev->power.async_suspend = false; |
726 | } | |
727 | ||
728 | static inline bool device_async_suspend_enabled(struct device *dev) | |
729 | { | |
730 | return !!dev->power.async_suspend; | |
731 | } | |
732 | ||
85945c28 SH |
733 | static inline bool device_pm_not_required(struct device *dev) |
734 | { | |
735 | return dev->power.no_pm; | |
736 | } | |
737 | ||
738 | static inline void device_set_pm_not_required(struct device *dev) | |
739 | { | |
740 | dev->power.no_pm = true; | |
741 | } | |
742 | ||
feb70af0 RW |
743 | static inline void dev_pm_syscore_device(struct device *dev, bool val) |
744 | { | |
745 | #ifdef CONFIG_PM_SLEEP | |
746 | dev->power.syscore = val; | |
747 | #endif | |
748 | } | |
749 | ||
08810a41 RW |
750 | static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) |
751 | { | |
752 | dev->power.driver_flags = flags; | |
753 | } | |
754 | ||
755 | static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) | |
756 | { | |
757 | return !!(dev->power.driver_flags & flags); | |
758 | } | |
759 | ||
8e9394ce GKH |
760 | static inline void device_lock(struct device *dev) |
761 | { | |
3142788b | 762 | mutex_lock(&dev->mutex); |
8e9394ce GKH |
763 | } |
764 | ||
7dd9cba5 ON |
765 | static inline int device_lock_interruptible(struct device *dev) |
766 | { | |
767 | return mutex_lock_interruptible(&dev->mutex); | |
768 | } | |
769 | ||
8e9394ce GKH |
770 | static inline int device_trylock(struct device *dev) |
771 | { | |
3142788b | 772 | return mutex_trylock(&dev->mutex); |
8e9394ce GKH |
773 | } |
774 | ||
775 | static inline void device_unlock(struct device *dev) | |
776 | { | |
3142788b | 777 | mutex_unlock(&dev->mutex); |
8e9394ce GKH |
778 | } |
779 | ||
ac801022 KRW |
780 | static inline void device_lock_assert(struct device *dev) |
781 | { | |
782 | lockdep_assert_held(&dev->mutex); | |
783 | } | |
784 | ||
e8a51e1b BH |
785 | static inline struct device_node *dev_of_node(struct device *dev) |
786 | { | |
1b833924 | 787 | if (!IS_ENABLED(CONFIG_OF) || !dev) |
e8a51e1b BH |
788 | return NULL; |
789 | return dev->of_node; | |
790 | } | |
791 | ||
ac338acf SK |
792 | static inline bool dev_has_sync_state(struct device *dev) |
793 | { | |
794 | if (!dev) | |
795 | return false; | |
796 | if (dev->driver && dev->driver->sync_state) | |
797 | return true; | |
798 | if (dev->bus && dev->bus->sync_state) | |
799 | return true; | |
800 | return false; | |
801 | } | |
802 | ||
70f400d4 RJ |
803 | static inline void dev_set_removable(struct device *dev, |
804 | enum device_removable removable) | |
805 | { | |
806 | dev->removable = removable; | |
807 | } | |
808 | ||
809 | static inline bool dev_is_removable(struct device *dev) | |
810 | { | |
811 | return dev->removable == DEVICE_REMOVABLE; | |
812 | } | |
813 | ||
814 | static inline bool dev_removable_is_valid(struct device *dev) | |
815 | { | |
816 | return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED; | |
817 | } | |
818 | ||
1da177e4 LT |
819 | /* |
820 | * High level routines for use by the bus drivers | |
821 | */ | |
67dd0772 BG |
822 | int __must_check device_register(struct device *dev); |
823 | void device_unregister(struct device *dev); | |
824 | void device_initialize(struct device *dev); | |
825 | int __must_check device_add(struct device *dev); | |
826 | void device_del(struct device *dev); | |
827 | int device_for_each_child(struct device *dev, void *data, | |
828 | int (*fn)(struct device *dev, void *data)); | |
829 | int device_for_each_child_reverse(struct device *dev, void *data, | |
830 | int (*fn)(struct device *dev, void *data)); | |
831 | struct device *device_find_child(struct device *dev, void *data, | |
832 | int (*match)(struct device *dev, void *data)); | |
833 | struct device *device_find_child_by_name(struct device *parent, | |
834 | const char *name); | |
835 | int device_rename(struct device *dev, const char *new_name); | |
836 | int device_move(struct device *dev, struct device *new_parent, | |
837 | enum dpm_order dpm_order); | |
838 | int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid); | |
839 | const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid, | |
840 | kgid_t *gid, const char **tmp); | |
44197797 | 841 | int device_is_dependent(struct device *dev, void *target); |
1da177e4 | 842 | |
4f3549d7 RW |
843 | static inline bool device_supports_offline(struct device *dev) |
844 | { | |
845 | return dev->bus && dev->bus->offline && dev->bus->online; | |
846 | } | |
847 | ||
d864b8ea DW |
848 | #define __device_lock_set_class(dev, name, key) \ |
849 | do { \ | |
850 | struct device *__d2 __maybe_unused = dev; \ | |
851 | lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \ | |
852 | } while (0) | |
853 | ||
854 | /** | |
855 | * device_lock_set_class - Specify a temporary lock class while a device | |
856 | * is attached to a driver | |
857 | * @dev: device to modify | |
858 | * @key: lock class key data | |
859 | * | |
860 | * This must be called with the device_lock() already held, for example | |
861 | * from driver ->probe(). Take care to only override the default | |
862 | * lockdep_no_validate class. | |
863 | */ | |
864 | #ifdef CONFIG_LOCKDEP | |
865 | #define device_lock_set_class(dev, key) \ | |
866 | do { \ | |
867 | struct device *__d = dev; \ | |
868 | dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex, \ | |
869 | &__lockdep_no_validate__), \ | |
870 | "overriding existing custom lock class\n"); \ | |
871 | __device_lock_set_class(__d, #key, key); \ | |
872 | } while (0) | |
873 | #else | |
874 | #define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key) | |
875 | #endif | |
876 | ||
877 | /** | |
878 | * device_lock_reset_class - Return a device to the default lockdep novalidate state | |
879 | * @dev: device to modify | |
880 | * | |
881 | * This must be called with the device_lock() already held, for example | |
882 | * from driver ->remove(). | |
883 | */ | |
884 | #define device_lock_reset_class(dev) \ | |
885 | do { \ | |
886 | struct device *__d __maybe_unused = dev; \ | |
887 | lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex", \ | |
888 | _THIS_IP_); \ | |
889 | } while (0) | |
890 | ||
67dd0772 BG |
891 | void lock_device_hotplug(void); |
892 | void unlock_device_hotplug(void); | |
893 | int lock_device_hotplug_sysfs(void); | |
894 | int device_offline(struct device *dev); | |
895 | int device_online(struct device *dev); | |
896 | void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); | |
897 | void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); | |
4e75e1d7 | 898 | void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); |
43e76d46 | 899 | void device_set_node(struct device *dev, struct fwnode_handle *fwnode); |
97badf87 | 900 | |
9af15c38 PS |
901 | static inline int dev_num_vf(struct device *dev) |
902 | { | |
903 | if (dev->bus && dev->bus->num_vf) | |
904 | return dev->bus->num_vf(dev); | |
905 | return 0; | |
906 | } | |
907 | ||
0aa0dc41 MM |
908 | /* |
909 | * Root device objects for grouping under /sys/devices | |
910 | */ | |
67dd0772 | 911 | struct device *__root_device_register(const char *name, struct module *owner); |
eb5589a8 | 912 | |
33ac1257 | 913 | /* This is a macro to avoid include problems with THIS_MODULE */ |
eb5589a8 PG |
914 | #define root_device_register(name) \ |
915 | __root_device_register(name, THIS_MODULE) | |
916 | ||
67dd0772 | 917 | void root_device_unregister(struct device *root); |
0aa0dc41 | 918 | |
a5b8b1ad MB |
919 | static inline void *dev_get_platdata(const struct device *dev) |
920 | { | |
921 | return dev->platform_data; | |
922 | } | |
923 | ||
1da177e4 LT |
924 | /* |
925 | * Manual binding of a device to driver. See drivers/base/bus.c | |
926 | * for information on use. | |
927 | */ | |
0d9f837c JG |
928 | int __must_check device_driver_attach(struct device_driver *drv, |
929 | struct device *dev); | |
67dd0772 BG |
930 | int __must_check device_bind_driver(struct device *dev); |
931 | void device_release_driver(struct device *dev); | |
932 | int __must_check device_attach(struct device *dev); | |
933 | int __must_check driver_attach(struct device_driver *drv); | |
934 | void device_initial_probe(struct device *dev); | |
935 | int __must_check device_reprobe(struct device *dev); | |
1da177e4 | 936 | |
67dd0772 | 937 | bool device_is_bound(struct device *dev); |
6b9cb427 | 938 | |
23681e47 GKH |
939 | /* |
940 | * Easy functions for dynamically creating devices on the fly | |
941 | */ | |
67dd0772 BG |
942 | __printf(5, 6) struct device * |
943 | device_create(struct class *cls, struct device *parent, dev_t devt, | |
944 | void *drvdata, const char *fmt, ...); | |
945 | __printf(6, 7) struct device * | |
946 | device_create_with_groups(struct class *cls, struct device *parent, dev_t devt, | |
947 | void *drvdata, const struct attribute_group **groups, | |
948 | const char *fmt, ...); | |
949 | void device_destroy(struct class *cls, dev_t devt); | |
950 | ||
951 | int __must_check device_add_groups(struct device *dev, | |
952 | const struct attribute_group **groups); | |
953 | void device_remove_groups(struct device *dev, | |
954 | const struct attribute_group **groups); | |
a7670d42 | 955 | |
e323b2dd DT |
956 | static inline int __must_check device_add_group(struct device *dev, |
957 | const struct attribute_group *grp) | |
958 | { | |
959 | const struct attribute_group *groups[] = { grp, NULL }; | |
960 | ||
961 | return device_add_groups(dev, groups); | |
962 | } | |
963 | ||
964 | static inline void device_remove_group(struct device *dev, | |
965 | const struct attribute_group *grp) | |
966 | { | |
967 | const struct attribute_group *groups[] = { grp, NULL }; | |
968 | ||
969 | return device_remove_groups(dev, groups); | |
970 | } | |
971 | ||
67dd0772 | 972 | int __must_check devm_device_add_groups(struct device *dev, |
57b8ff07 | 973 | const struct attribute_group **groups); |
67dd0772 BG |
974 | void devm_device_remove_groups(struct device *dev, |
975 | const struct attribute_group **groups); | |
976 | int __must_check devm_device_add_group(struct device *dev, | |
977 | const struct attribute_group *grp); | |
978 | void devm_device_remove_group(struct device *dev, | |
979 | const struct attribute_group *grp); | |
57b8ff07 | 980 | |
1da177e4 LT |
981 | /* |
982 | * Platform "fixup" functions - allow the platform to have their say | |
983 | * about devices and actions that the general device layer doesn't | |
984 | * know about. | |
985 | */ | |
986 | /* Notify platform of device discovery */ | |
d462943a | 987 | extern int (*platform_notify)(struct device *dev); |
1da177e4 | 988 | |
d462943a | 989 | extern int (*platform_notify_remove)(struct device *dev); |
1da177e4 LT |
990 | |
991 | ||
880ffb5c | 992 | /* |
1da177e4 LT |
993 | * get_device - atomically increment the reference count for the device. |
994 | * | |
995 | */ | |
67dd0772 BG |
996 | struct device *get_device(struct device *dev); |
997 | void put_device(struct device *dev); | |
998 | bool kill_device(struct device *dev); | |
1da177e4 | 999 | |
2b2af54a | 1000 | #ifdef CONFIG_DEVTMPFS |
67dd0772 | 1001 | int devtmpfs_mount(void); |
2b2af54a | 1002 | #else |
5e787dbf | 1003 | static inline int devtmpfs_mount(void) { return 0; } |
2b2af54a KS |
1004 | #endif |
1005 | ||
116f232b | 1006 | /* drivers/base/power/shutdown.c */ |
67dd0772 | 1007 | void device_shutdown(void); |
1da177e4 | 1008 | |
1da177e4 | 1009 | /* debugging and troubleshooting/diagnostic helpers. */ |
67dd0772 | 1010 | const char *dev_driver_string(const struct device *dev); |
99bcf217 | 1011 | |
9ed98953 RW |
1012 | /* Device links interface. */ |
1013 | struct device_link *device_link_add(struct device *consumer, | |
1014 | struct device *supplier, u32 flags); | |
1015 | void device_link_del(struct device_link *link); | |
d8842211 | 1016 | void device_link_remove(void *consumer, struct device *supplier); |
fc5a251d SK |
1017 | void device_links_supplier_sync_state_pause(void); |
1018 | void device_links_supplier_sync_state_resume(void); | |
99bcf217 | 1019 | |
a787e540 | 1020 | extern __printf(3, 4) |
f601e8f3 | 1021 | int dev_err_probe(const struct device *dev, int err, const char *fmt, ...); |
a787e540 | 1022 | |
1da177e4 LT |
1023 | /* Create alias, so I can be autoloaded. */ |
1024 | #define MODULE_ALIAS_CHARDEV(major,minor) \ | |
1025 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) | |
1026 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ | |
1027 | MODULE_ALIAS("char-major-" __stringify(major) "-*") | |
e52eec13 AK |
1028 | |
1029 | #ifdef CONFIG_SYSFS_DEPRECATED | |
1030 | extern long sysfs_deprecated; | |
1031 | #else | |
1032 | #define sysfs_deprecated 0 | |
1033 | #endif | |
1034 | ||
1da177e4 | 1035 | #endif /* _DEVICE_H_ */ |