1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * device.h - generic, centralized driver model
4 *
5 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
6 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2008-2009 Novell Inc.
8 *
9 * See Documentation/driver-api/driver-model/ for more information.
10 */
11
12 #ifndef _DEVICE_H_
13 #define _DEVICE_H_
14
15 #include <linux/dev_printk.h>
16 #include <linux/energy_model.h>
17 #include <linux/ioport.h>
18 #include <linux/kobject.h>
19 #include <linux/klist.h>
20 #include <linux/list.h>
21 #include <linux/lockdep.h>
22 #include <linux/compiler.h>
23 #include <linux/types.h>
24 #include <linux/mutex.h>
25 #include <linux/pm.h>
26 #include <linux/atomic.h>
27 #include <linux/uidgid.h>
28 #include <linux/gfp.h>
29 #include <linux/overflow.h>
30 #include <linux/device/bus.h>
31 #include <linux/device/class.h>
32 #include <linux/device/driver.h>
33 #include <linux/android_kabi.h>
34 #include <asm/device.h>
35
36 struct device;
37 struct device_private;
38 struct device_driver;
39 struct driver_private;
40 struct module;
41 struct class;
42 struct subsys_private;
43 struct device_node;
44 struct fwnode_handle;
45 struct iommu_ops;
46 struct iommu_group;
47 struct dev_pin_info;
48 struct dev_iommu;
49
50 /**
51 * struct subsys_interface - interfaces to device functions
52 * @name: name of the device function
53 * @subsys: subsytem of the devices to attach to
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
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);
68 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
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);
76 int subsys_virtual_register(struct bus_type *subsys,
77 const struct attribute_group **groups);
78
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 */
88 struct device_type {
89 const char *name;
90 const struct attribute_group **groups;
91 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
92 char *(*devnode)(struct device *dev, umode_t *mode,
93 kuid_t *uid, kgid_t *gid);
94 void (*release)(struct device *dev);
95
96 const struct dev_pm_ops *pm;
97 };
98
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
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);
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);
125
126 #define DEVICE_ATTR(_name, _mode, _show, _store) \
127 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
128 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
129 struct device_attribute dev_attr_##_name = \
130 __ATTR_PREALLOC(_name, _mode, _show, _store)
131 #define DEVICE_ATTR_RW(_name) \
132 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
133 #define DEVICE_ATTR_ADMIN_RW(_name) \
134 struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
135 #define DEVICE_ATTR_RO(_name) \
136 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
137 #define DEVICE_ATTR_ADMIN_RO(_name) \
138 struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
139 #define DEVICE_ATTR_WO(_name) \
140 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
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 = \
146 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
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) }
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)
153
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,
161 const struct bin_attribute *attr);
162 void device_remove_bin_file(struct device *dev,
163 const struct bin_attribute *attr);
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
169 #ifdef CONFIG_DEBUG_DEVRES
170 void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
171 int nid, const char *name) __malloc;
172 #define devres_alloc(release, size, gfp) \
173 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
174 #define devres_alloc_node(release, size, gfp, nid) \
175 __devres_alloc_node(release, size, gfp, nid, #release)
176 #else
177 void *devres_alloc_node(dr_release_t release, size_t size,
178 gfp_t gfp, int nid) __malloc;
devres_alloc(dr_release_t release,size_t size,gfp_t gfp)179 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
180 {
181 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
182 }
183 #endif
184
185 void devres_for_each_res(struct device *dev, dr_release_t release,
186 dr_match_t match, void *match_data,
187 void (*fn)(struct device *, void *, void *),
188 void *data);
189 void devres_free(void *res);
190 void devres_add(struct device *dev, void *res);
191 void *devres_find(struct device *dev, dr_release_t release,
192 dr_match_t match, void *match_data);
193 void *devres_get(struct device *dev, void *new_res,
194 dr_match_t match, void *match_data);
195 void *devres_remove(struct device *dev, dr_release_t release,
196 dr_match_t match, void *match_data);
197 int devres_destroy(struct device *dev, dr_release_t release,
198 dr_match_t match, void *match_data);
199 int devres_release(struct device *dev, dr_release_t release,
200 dr_match_t match, void *match_data);
201
202 /* devres group */
203 void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
204 void devres_close_group(struct device *dev, void *id);
205 void devres_remove_group(struct device *dev, void *id);
206 int devres_release_group(struct device *dev, void *id);
207
208 /* managed devm_k.alloc/kfree for device drivers */
209 void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
210 void *devm_krealloc(struct device *dev, void *ptr, size_t size,
211 gfp_t gfp) __must_check;
212 __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
213 const char *fmt, va_list ap) __malloc;
214 __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
215 const char *fmt, ...) __malloc;
devm_kzalloc(struct device * dev,size_t size,gfp_t gfp)216 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
217 {
218 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
219 }
devm_kmalloc_array(struct device * dev,size_t n,size_t size,gfp_t flags)220 static inline void *devm_kmalloc_array(struct device *dev,
221 size_t n, size_t size, gfp_t flags)
222 {
223 size_t bytes;
224
225 if (unlikely(check_mul_overflow(n, size, &bytes)))
226 return NULL;
227
228 return devm_kmalloc(dev, bytes, flags);
229 }
devm_kcalloc(struct device * dev,size_t n,size_t size,gfp_t flags)230 static inline void *devm_kcalloc(struct device *dev,
231 size_t n, size_t size, gfp_t flags)
232 {
233 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
234 }
235 void devm_kfree(struct device *dev, const void *p);
236 char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
237 const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
238 void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp);
239
240 unsigned long devm_get_free_pages(struct device *dev,
241 gfp_t gfp_mask, unsigned int order);
242 void devm_free_pages(struct device *dev, unsigned long addr);
243
244 void __iomem *devm_ioremap_resource(struct device *dev,
245 const struct resource *res);
246 void __iomem *devm_ioremap_resource_wc(struct device *dev,
247 const struct resource *res);
248
249 void __iomem *devm_of_iomap(struct device *dev,
250 struct device_node *node, int index,
251 resource_size_t *size);
252
253 /* allows to add/remove a custom action to devres stack */
254 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
255 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
256 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
257
devm_add_action_or_reset(struct device * dev,void (* action)(void *),void * data)258 static inline int devm_add_action_or_reset(struct device *dev,
259 void (*action)(void *), void *data)
260 {
261 int ret;
262
263 ret = devm_add_action(dev, action, data);
264 if (ret)
265 action(data);
266
267 return ret;
268 }
269
270 /**
271 * devm_alloc_percpu - Resource-managed alloc_percpu
272 * @dev: Device to allocate per-cpu memory for
273 * @type: Type to allocate per-cpu memory for
274 *
275 * Managed alloc_percpu. Per-cpu memory allocated with this function is
276 * automatically freed on driver detach.
277 *
278 * RETURNS:
279 * Pointer to allocated memory on success, NULL on failure.
280 */
281 #define devm_alloc_percpu(dev, type) \
282 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
283 __alignof__(type)))
284
285 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
286 size_t align);
287 void devm_free_percpu(struct device *dev, void __percpu *pdata);
288
289 struct device_dma_parameters {
290 /*
291 * a low level driver may set these to teach IOMMU code about
292 * sg limitations.
293 */
294 unsigned int max_segment_size;
295 unsigned int min_align_mask;
296 unsigned long segment_boundary_mask;
297 };
298
299 /**
300 * enum device_link_state - Device link states.
301 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
302 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
303 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
304 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
305 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
306 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
307 */
308 enum device_link_state {
309 DL_STATE_NONE = -1,
310 DL_STATE_DORMANT = 0,
311 DL_STATE_AVAILABLE,
312 DL_STATE_CONSUMER_PROBE,
313 DL_STATE_ACTIVE,
314 DL_STATE_SUPPLIER_UNBIND,
315 };
316
317 /*
318 * Device link flags.
319 *
320 * STATELESS: The core will not remove this link automatically.
321 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
322 * PM_RUNTIME: If set, the runtime PM framework will use this link.
323 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
324 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
325 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
326 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
327 * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
328 * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
329 */
330 #define DL_FLAG_STATELESS BIT(0)
331 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
332 #define DL_FLAG_PM_RUNTIME BIT(2)
333 #define DL_FLAG_RPM_ACTIVE BIT(3)
334 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
335 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
336 #define DL_FLAG_MANAGED BIT(6)
337 #define DL_FLAG_SYNC_STATE_ONLY BIT(7)
338 #define DL_FLAG_INFERRED BIT(8)
339
340 /**
341 * enum dl_dev_state - Device driver presence tracking information.
342 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
343 * @DL_DEV_PROBING: A driver is probing.
344 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
345 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
346 */
347 enum dl_dev_state {
348 DL_DEV_NO_DRIVER = 0,
349 DL_DEV_PROBING,
350 DL_DEV_DRIVER_BOUND,
351 DL_DEV_UNBINDING,
352 };
353
354 /**
355 * struct dev_links_info - Device data related to device links.
356 * @suppliers: List of links to supplier devices.
357 * @consumers: List of links to consumer devices.
358 * @defer_sync: Hook to global list of devices that have deferred sync_state.
359 * @status: Driver status information.
360 */
361 struct dev_links_info {
362 struct list_head suppliers;
363 struct list_head consumers;
364 struct list_head defer_sync;
365 enum dl_dev_state status;
366 };
367
368 /**
369 * struct device - The basic device structure
370 * @parent: The device's "parent" device, the device to which it is attached.
371 * In most cases, a parent device is some sort of bus or host
372 * controller. If parent is NULL, the device, is a top-level device,
373 * which is not usually what you want.
374 * @p: Holds the private data of the driver core portions of the device.
375 * See the comment of the struct device_private for detail.
376 * @kobj: A top-level, abstract class from which other classes are derived.
377 * @init_name: Initial name of the device.
378 * @type: The type of device.
379 * This identifies the device type and carries type-specific
380 * information.
381 * @mutex: Mutex to synchronize calls to its driver.
382 * @lockdep_mutex: An optional debug lock that a subsystem can use as a
383 * peer lock to gain localized lockdep coverage of the device_lock.
384 * @bus: Type of bus device is on.
385 * @driver: Which driver has allocated this
386 * @platform_data: Platform data specific to the device.
387 * Example: For devices on custom boards, as typical of embedded
388 * and SOC based hardware, Linux often uses platform_data to point
389 * to board-specific structures describing devices and how they
390 * are wired. That can include what ports are available, chip
391 * variants, which GPIO pins act in what additional roles, and so
392 * on. This shrinks the "Board Support Packages" (BSPs) and
393 * minimizes board-specific #ifdefs in drivers.
394 * @driver_data: Private pointer for driver specific info.
395 * @links: Links to suppliers and consumers of this device.
396 * @power: For device power management.
397 * See Documentation/driver-api/pm/devices.rst for details.
398 * @pm_domain: Provide callbacks that are executed during system suspend,
399 * hibernation, system resume and during runtime PM transitions
400 * along with subsystem-level and driver-level callbacks.
401 * @em_pd: device's energy model performance domain
402 * @pins: For device pin management.
403 * See Documentation/driver-api/pinctl.rst for details.
404 * @msi_list: Hosts MSI descriptors
405 * @msi_domain: The generic MSI domain this device is using.
406 * @numa_node: NUMA node this device is close to.
407 * @dma_ops: DMA mapping operations for this device.
408 * @dma_mask: Dma mask (if dma'ble device).
409 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
410 * hardware supports 64-bit addresses for consistent allocations
411 * such descriptors.
412 * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
413 * DMA limit than the device itself supports.
414 * @dma_range_map: map for DMA memory ranges relative to that of RAM
415 * @dma_parms: A low level driver may set these to teach IOMMU code about
416 * segment limitations.
417 * @dma_pools: Dma pools (if dma'ble device).
418 * @dma_mem: Internal for coherent mem override.
419 * @cma_area: Contiguous memory area for dma allocations
420 * @archdata: For arch-specific additions.
421 * @of_node: Associated device tree node.
422 * @fwnode: Associated device node supplied by platform firmware.
423 * @devt: For creating the sysfs "dev".
424 * @id: device instance
425 * @devres_lock: Spinlock to protect the resource of the device.
426 * @devres_head: The resources list of the device.
427 * @knode_class: The node used to add the device to the class list.
428 * @class: The class of the device.
429 * @groups: Optional attribute groups.
430 * @release: Callback to free the device after all references have
431 * gone away. This should be set by the allocator of the
432 * device (i.e. the bus driver that discovered the device).
433 * @iommu_group: IOMMU group the device belongs to.
434 * @iommu: Per device generic IOMMU runtime data
435 *
436 * @offline_disabled: If set, the device is permanently online.
437 * @offline: Set after successful invocation of bus type's .offline().
438 * @of_node_reused: Set if the device-tree node is shared with an ancestor
439 * device.
440 * @state_synced: The hardware state of this device has been synced to match
441 * the software state of this device by calling the driver/bus
442 * sync_state() callback.
443 * @dma_coherent: this particular device is dma coherent, even if the
444 * architecture supports non-coherent devices.
445 * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
446 * streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
447 * and optionall (if the coherent mask is large enough) also
448 * for dma allocations. This flag is managed by the dma ops
449 * instance from ->dma_supported.
450 *
451 * At the lowest level, every device in a Linux system is represented by an
452 * instance of struct device. The device structure contains the information
453 * that the device model core needs to model the system. Most subsystems,
454 * however, track additional information about the devices they host. As a
455 * result, it is rare for devices to be represented by bare device structures;
456 * instead, that structure, like kobject structures, is usually embedded within
457 * a higher-level representation of the device.
458 */
459 struct device {
460 struct kobject kobj;
461 struct device *parent;
462
463 struct device_private *p;
464
465 const char *init_name; /* initial name of the device */
466 const struct device_type *type;
467
468 struct bus_type *bus; /* type of bus device is on */
469 struct device_driver *driver; /* which driver has allocated this
470 device */
471 void *platform_data; /* Platform specific data, device
472 core doesn't touch it */
473 void *driver_data; /* Driver data, set and get with
474 dev_set_drvdata/dev_get_drvdata */
475 #ifdef CONFIG_PROVE_LOCKING
476 struct mutex lockdep_mutex;
477 #endif
478 struct mutex mutex; /* mutex to synchronize calls to
479 * its driver.
480 */
481
482 struct dev_links_info links;
483 struct dev_pm_info power;
484 struct dev_pm_domain *pm_domain;
485
486 #ifdef CONFIG_ENERGY_MODEL
487 struct em_perf_domain *em_pd;
488 #endif
489
490 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
491 struct irq_domain *msi_domain;
492 #endif
493 #ifdef CONFIG_PINCTRL
494 struct dev_pin_info *pins;
495 #endif
496 #ifdef CONFIG_GENERIC_MSI_IRQ
497 struct list_head msi_list;
498 #endif
499 #ifdef CONFIG_DMA_OPS
500 const struct dma_map_ops *dma_ops;
501 #endif
502 u64 *dma_mask; /* dma mask (if dma'able device) */
503 u64 coherent_dma_mask;/* Like dma_mask, but for
504 alloc_coherent mappings as
505 not all hardware supports
506 64 bit addresses for consistent
507 allocations such descriptors. */
508 u64 bus_dma_limit; /* upstream dma constraint */
509 const struct bus_dma_region *dma_range_map;
510
511 struct device_dma_parameters *dma_parms;
512
513 struct list_head dma_pools; /* dma pools (if dma'ble) */
514
515 #ifdef CONFIG_DMA_DECLARE_COHERENT
516 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
517 override */
518 #endif
519 #ifdef CONFIG_DMA_CMA
520 struct cma *cma_area; /* contiguous memory area for dma
521 allocations */
522 #endif
523 /* arch specific additions */
524 struct dev_archdata archdata;
525
526 struct device_node *of_node; /* associated device tree node */
527 struct fwnode_handle *fwnode; /* firmware device node */
528
529 #ifdef CONFIG_NUMA
530 int numa_node; /* NUMA node this device is close to */
531 #endif
532 dev_t devt; /* dev_t, creates the sysfs "dev" */
533 u32 id; /* device instance */
534
535 spinlock_t devres_lock;
536 struct list_head devres_head;
537
538 struct class *class;
539 const struct attribute_group **groups; /* optional groups */
540
541 void (*release)(struct device *dev);
542 struct iommu_group *iommu_group;
543 struct dev_iommu *iommu;
544
545 bool offline_disabled:1;
546 bool offline:1;
547 bool of_node_reused:1;
548 bool state_synced:1;
549 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
550 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
551 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
552 bool dma_coherent:1;
553 #endif
554 #ifdef CONFIG_DMA_OPS_BYPASS
555 bool dma_ops_bypass : 1;
556 #endif
557 ANDROID_KABI_RESERVE(1);
558 ANDROID_KABI_RESERVE(2);
559 ANDROID_KABI_RESERVE(3);
560 ANDROID_KABI_RESERVE(4);
561 ANDROID_KABI_RESERVE(5);
562 ANDROID_KABI_RESERVE(6);
563 ANDROID_KABI_RESERVE(7);
564 ANDROID_KABI_RESERVE(8);
565 };
566
567 /**
568 * struct device_link - Device link representation.
569 * @supplier: The device on the supplier end of the link.
570 * @s_node: Hook to the supplier device's list of links to consumers.
571 * @consumer: The device on the consumer end of the link.
572 * @c_node: Hook to the consumer device's list of links to suppliers.
573 * @link_dev: device used to expose link details in sysfs
574 * @status: The state of the link (with respect to the presence of drivers).
575 * @flags: Link flags.
576 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
577 * @kref: Count repeated addition of the same link.
578 * @rm_work: Work structure used for removing the link.
579 * @supplier_preactivated: Supplier has been made active before consumer probe.
580 */
581 struct device_link {
582 struct device *supplier;
583 struct list_head s_node;
584 struct device *consumer;
585 struct list_head c_node;
586 struct device link_dev;
587 enum device_link_state status;
588 u32 flags;
589 refcount_t rpm_active;
590 struct kref kref;
591 #ifdef CONFIG_SRCU
592 /* Not currently used, here for potential abi issues in the future */
593 struct rcu_head rcu_head;
594 #endif
595 struct work_struct rm_work;
596 bool supplier_preactivated; /* Owned by consumer probe. */
597 ANDROID_KABI_RESERVE(1);
598 ANDROID_KABI_RESERVE(2);
599 };
600
kobj_to_dev(struct kobject * kobj)601 static inline struct device *kobj_to_dev(struct kobject *kobj)
602 {
603 return container_of(kobj, struct device, kobj);
604 }
605
606 /**
607 * device_iommu_mapped - Returns true when the device DMA is translated
608 * by an IOMMU
609 * @dev: Device to perform the check on
610 */
device_iommu_mapped(struct device * dev)611 static inline bool device_iommu_mapped(struct device *dev)
612 {
613 return (dev->iommu_group != NULL);
614 }
615
616 /* Get the wakeup routines, which depend on struct device */
617 #include <linux/pm_wakeup.h>
618
dev_name(const struct device * dev)619 static inline const char *dev_name(const struct device *dev)
620 {
621 /* Use the init name until the kobject becomes available */
622 if (dev->init_name)
623 return dev->init_name;
624
625 return kobject_name(&dev->kobj);
626 }
627
628 /**
629 * dev_bus_name - Return a device's bus/class name, if at all possible
630 * @dev: struct device to get the bus/class name of
631 *
632 * Will return the name of the bus/class the device is attached to. If it is
633 * not attached to a bus/class, an empty string will be returned.
634 */
dev_bus_name(const struct device * dev)635 static inline const char *dev_bus_name(const struct device *dev)
636 {
637 return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
638 }
639
640 __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
641
642 #ifdef CONFIG_NUMA
dev_to_node(struct device * dev)643 static inline int dev_to_node(struct device *dev)
644 {
645 return dev->numa_node;
646 }
set_dev_node(struct device * dev,int node)647 static inline void set_dev_node(struct device *dev, int node)
648 {
649 dev->numa_node = node;
650 }
651 #else
dev_to_node(struct device * dev)652 static inline int dev_to_node(struct device *dev)
653 {
654 return NUMA_NO_NODE;
655 }
set_dev_node(struct device * dev,int node)656 static inline void set_dev_node(struct device *dev, int node)
657 {
658 }
659 #endif
660
dev_get_msi_domain(const struct device * dev)661 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
662 {
663 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
664 return dev->msi_domain;
665 #else
666 return NULL;
667 #endif
668 }
669
dev_set_msi_domain(struct device * dev,struct irq_domain * d)670 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
671 {
672 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
673 dev->msi_domain = d;
674 #endif
675 }
676
dev_get_drvdata(const struct device * dev)677 static inline void *dev_get_drvdata(const struct device *dev)
678 {
679 return dev->driver_data;
680 }
681
dev_set_drvdata(struct device * dev,void * data)682 static inline void dev_set_drvdata(struct device *dev, void *data)
683 {
684 dev->driver_data = data;
685 }
686
dev_to_psd(struct device * dev)687 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
688 {
689 return dev ? dev->power.subsys_data : NULL;
690 }
691
dev_get_uevent_suppress(const struct device * dev)692 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
693 {
694 return dev->kobj.uevent_suppress;
695 }
696
dev_set_uevent_suppress(struct device * dev,int val)697 static inline void dev_set_uevent_suppress(struct device *dev, int val)
698 {
699 dev->kobj.uevent_suppress = val;
700 }
701
device_is_registered(struct device * dev)702 static inline int device_is_registered(struct device *dev)
703 {
704 return dev->kobj.state_in_sysfs;
705 }
706
device_enable_async_suspend(struct device * dev)707 static inline void device_enable_async_suspend(struct device *dev)
708 {
709 if (!dev->power.is_prepared)
710 dev->power.async_suspend = true;
711 }
712
device_disable_async_suspend(struct device * dev)713 static inline void device_disable_async_suspend(struct device *dev)
714 {
715 if (!dev->power.is_prepared)
716 dev->power.async_suspend = false;
717 }
718
device_async_suspend_enabled(struct device * dev)719 static inline bool device_async_suspend_enabled(struct device *dev)
720 {
721 return !!dev->power.async_suspend;
722 }
723
device_pm_not_required(struct device * dev)724 static inline bool device_pm_not_required(struct device *dev)
725 {
726 return dev->power.no_pm;
727 }
728
device_set_pm_not_required(struct device * dev)729 static inline void device_set_pm_not_required(struct device *dev)
730 {
731 dev->power.no_pm = true;
732 }
733
dev_pm_syscore_device(struct device * dev,bool val)734 static inline void dev_pm_syscore_device(struct device *dev, bool val)
735 {
736 #ifdef CONFIG_PM_SLEEP
737 dev->power.syscore = val;
738 #endif
739 }
740
dev_pm_set_driver_flags(struct device * dev,u32 flags)741 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
742 {
743 dev->power.driver_flags = flags;
744 }
745
dev_pm_test_driver_flags(struct device * dev,u32 flags)746 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
747 {
748 return !!(dev->power.driver_flags & flags);
749 }
750
device_lock(struct device * dev)751 static inline void device_lock(struct device *dev)
752 {
753 mutex_lock(&dev->mutex);
754 }
755
device_lock_interruptible(struct device * dev)756 static inline int device_lock_interruptible(struct device *dev)
757 {
758 return mutex_lock_interruptible(&dev->mutex);
759 }
760
device_trylock(struct device * dev)761 static inline int device_trylock(struct device *dev)
762 {
763 return mutex_trylock(&dev->mutex);
764 }
765
device_unlock(struct device * dev)766 static inline void device_unlock(struct device *dev)
767 {
768 mutex_unlock(&dev->mutex);
769 }
770
device_lock_assert(struct device * dev)771 static inline void device_lock_assert(struct device *dev)
772 {
773 lockdep_assert_held(&dev->mutex);
774 }
775
dev_of_node(struct device * dev)776 static inline struct device_node *dev_of_node(struct device *dev)
777 {
778 if (!IS_ENABLED(CONFIG_OF) || !dev)
779 return NULL;
780 return dev->of_node;
781 }
782
dev_has_sync_state(struct device * dev)783 static inline bool dev_has_sync_state(struct device *dev)
784 {
785 if (!dev)
786 return false;
787 if (dev->driver && dev->driver->sync_state)
788 return true;
789 if (dev->bus && dev->bus->sync_state)
790 return true;
791 return false;
792 }
793
794 /*
795 * High level routines for use by the bus drivers
796 */
797 int __must_check device_register(struct device *dev);
798 void device_unregister(struct device *dev);
799 void device_initialize(struct device *dev);
800 int __must_check device_add(struct device *dev);
801 void device_del(struct device *dev);
802 int device_for_each_child(struct device *dev, void *data,
803 int (*fn)(struct device *dev, void *data));
804 int device_for_each_child_reverse(struct device *dev, void *data,
805 int (*fn)(struct device *dev, void *data));
806 struct device *device_find_child(struct device *dev, void *data,
807 int (*match)(struct device *dev, void *data));
808 struct device *device_find_child_by_name(struct device *parent,
809 const char *name);
810 int device_rename(struct device *dev, const char *new_name);
811 int device_move(struct device *dev, struct device *new_parent,
812 enum dpm_order dpm_order);
813 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
814 const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid,
815 kgid_t *gid, const char **tmp);
816 int device_is_dependent(struct device *dev, void *target);
817
device_supports_offline(struct device * dev)818 static inline bool device_supports_offline(struct device *dev)
819 {
820 return dev->bus && dev->bus->offline && dev->bus->online;
821 }
822
823 void lock_device_hotplug(void);
824 void unlock_device_hotplug(void);
825 int lock_device_hotplug_sysfs(void);
826 int device_offline(struct device *dev);
827 int device_online(struct device *dev);
828 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
829 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
830 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
831 void device_set_node(struct device *dev, struct fwnode_handle *fwnode);
832
dev_num_vf(struct device * dev)833 static inline int dev_num_vf(struct device *dev)
834 {
835 if (dev->bus && dev->bus->num_vf)
836 return dev->bus->num_vf(dev);
837 return 0;
838 }
839
840 /*
841 * Root device objects for grouping under /sys/devices
842 */
843 struct device *__root_device_register(const char *name, struct module *owner);
844
845 /* This is a macro to avoid include problems with THIS_MODULE */
846 #define root_device_register(name) \
847 __root_device_register(name, THIS_MODULE)
848
849 void root_device_unregister(struct device *root);
850
dev_get_platdata(const struct device * dev)851 static inline void *dev_get_platdata(const struct device *dev)
852 {
853 return dev->platform_data;
854 }
855
856 /*
857 * Manual binding of a device to driver. See drivers/base/bus.c
858 * for information on use.
859 */
860 int __must_check device_bind_driver(struct device *dev);
861 void device_release_driver(struct device *dev);
862 int __must_check device_attach(struct device *dev);
863 int __must_check driver_attach(struct device_driver *drv);
864 void device_initial_probe(struct device *dev);
865 int __must_check device_reprobe(struct device *dev);
866
867 bool device_is_bound(struct device *dev);
868
869 /*
870 * Easy functions for dynamically creating devices on the fly
871 */
872 __printf(5, 6) struct device *
873 device_create(struct class *cls, struct device *parent, dev_t devt,
874 void *drvdata, const char *fmt, ...);
875 __printf(6, 7) struct device *
876 device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
877 void *drvdata, const struct attribute_group **groups,
878 const char *fmt, ...);
879 void device_destroy(struct class *cls, dev_t devt);
880
881 int __must_check device_add_groups(struct device *dev,
882 const struct attribute_group **groups);
883 void device_remove_groups(struct device *dev,
884 const struct attribute_group **groups);
885
device_add_group(struct device * dev,const struct attribute_group * grp)886 static inline int __must_check device_add_group(struct device *dev,
887 const struct attribute_group *grp)
888 {
889 const struct attribute_group *groups[] = { grp, NULL };
890
891 return device_add_groups(dev, groups);
892 }
893
device_remove_group(struct device * dev,const struct attribute_group * grp)894 static inline void device_remove_group(struct device *dev,
895 const struct attribute_group *grp)
896 {
897 const struct attribute_group *groups[] = { grp, NULL };
898
899 return device_remove_groups(dev, groups);
900 }
901
902 int __must_check devm_device_add_groups(struct device *dev,
903 const struct attribute_group **groups);
904 void devm_device_remove_groups(struct device *dev,
905 const struct attribute_group **groups);
906 int __must_check devm_device_add_group(struct device *dev,
907 const struct attribute_group *grp);
908 void devm_device_remove_group(struct device *dev,
909 const struct attribute_group *grp);
910
911 /*
912 * Platform "fixup" functions - allow the platform to have their say
913 * about devices and actions that the general device layer doesn't
914 * know about.
915 */
916 /* Notify platform of device discovery */
917 extern int (*platform_notify)(struct device *dev);
918
919 extern int (*platform_notify_remove)(struct device *dev);
920
921
922 /*
923 * get_device - atomically increment the reference count for the device.
924 *
925 */
926 struct device *get_device(struct device *dev);
927 void put_device(struct device *dev);
928 bool kill_device(struct device *dev);
929
930 #ifdef CONFIG_DEVTMPFS
931 int devtmpfs_mount(void);
932 #else
devtmpfs_mount(void)933 static inline int devtmpfs_mount(void) { return 0; }
934 #endif
935
936 /* drivers/base/power/shutdown.c */
937 void device_shutdown(void);
938
939 /* debugging and troubleshooting/diagnostic helpers. */
940 const char *dev_driver_string(const struct device *dev);
941
942 /* Device links interface. */
943 struct device_link *device_link_add(struct device *consumer,
944 struct device *supplier, u32 flags);
945 void device_link_del(struct device_link *link);
946 void device_link_remove(void *consumer, struct device *supplier);
947 void device_links_supplier_sync_state_pause(void);
948 void device_links_supplier_sync_state_resume(void);
949
950 extern __printf(3, 4)
951 int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
952
953 /* Create alias, so I can be autoloaded. */
954 #define MODULE_ALIAS_CHARDEV(major,minor) \
955 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
956 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
957 MODULE_ALIAS("char-major-" __stringify(major) "-*")
958
959 #ifdef CONFIG_SYSFS_DEPRECATED
960 extern long sysfs_deprecated;
961 #else
962 #define sysfs_deprecated 0
963 #endif
964
965 #endif /* _DEVICE_H_ */
966