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/device/bus.h>
30#include <linux/device/class.h>
31#include <linux/device/devres.h>
32#include <linux/device/driver.h>
33#include <linux/cleanup.h>
34#include <asm/device.h>
35
36struct device;
37struct device_private;
38struct device_driver;
39struct driver_private;
40struct module;
41struct class;
42struct subsys_private;
43struct device_node;
44struct fwnode_handle;
45struct iommu_group;
46struct dev_pin_info;
47struct dev_iommu;
48struct msi_device_data;
49
50/**
51 * struct subsys_interface - interfaces to device functions
52 * @name: name of the device function
53 * @subsys: subsystem 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 */
63struct subsys_interface {
64 const char *name;
65 const 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
71int subsys_interface_register(struct subsys_interface *sif);
72void subsys_interface_unregister(struct subsys_interface *sif);
73
74int subsys_system_register(const struct bus_type *subsys,
75 const struct attribute_group **groups);
76int subsys_virtual_register(const 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 */
88struct device_type {
89 const char *name;
90 const struct attribute_group **groups;
91 int (*uevent)(const struct device *dev, struct kobj_uevent_env *env);
92 char *(*devnode)(const 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/**
100 * struct device_attribute - Interface for exporting device attributes.
101 * @attr: sysfs attribute definition.
102 * @show: Show handler.
103 * @store: Store handler.
104 */
105struct device_attribute {
106 struct attribute attr;
107 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
108 char *buf);
109 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
110 const char *buf, size_t count);
111};
112
113/**
114 * struct dev_ext_attribute - Exported device attribute with extra context.
115 * @attr: Exported device attribute.
116 * @var: Pointer to context.
117 */
118struct dev_ext_attribute {
119 struct device_attribute attr;
120 void *var;
121};
122
123ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
124 char *buf);
125ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
126 const char *buf, size_t count);
127ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
128 char *buf);
129ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
130 const char *buf, size_t count);
131ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
132 char *buf);
133ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
134 const char *buf, size_t count);
135ssize_t device_show_string(struct device *dev, struct device_attribute *attr,
136 char *buf);
137
138/**
139 * DEVICE_ATTR - Define a device attribute.
140 * @_name: Attribute name.
141 * @_mode: File mode.
142 * @_show: Show handler. Optional, but mandatory if attribute is readable.
143 * @_store: Store handler. Optional, but mandatory if attribute is writable.
144 *
145 * Convenience macro for defining a struct device_attribute.
146 *
147 * For example, ``DEVICE_ATTR(foo, 0644, foo_show, foo_store);`` expands to:
148 *
149 * .. code-block:: c
150 *
151 * struct device_attribute dev_attr_foo = {
152 * .attr = { .name = "foo", .mode = 0644 },
153 * .show = foo_show,
154 * .store = foo_store,
155 * };
156 */
157#define DEVICE_ATTR(_name, _mode, _show, _store) \
158 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
159
160/**
161 * DEVICE_ATTR_PREALLOC - Define a preallocated device attribute.
162 * @_name: Attribute name.
163 * @_mode: File mode.
164 * @_show: Show handler. Optional, but mandatory if attribute is readable.
165 * @_store: Store handler. Optional, but mandatory if attribute is writable.
166 *
167 * Like DEVICE_ATTR(), but ``SYSFS_PREALLOC`` is set on @_mode.
168 */
169#define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
170 struct device_attribute dev_attr_##_name = \
171 __ATTR_PREALLOC(_name, _mode, _show, _store)
172
173/**
174 * DEVICE_ATTR_RW - Define a read-write device attribute.
175 * @_name: Attribute name.
176 *
177 * Like DEVICE_ATTR(), but @_mode is 0644, @_show is <_name>_show,
178 * and @_store is <_name>_store.
179 */
180#define DEVICE_ATTR_RW(_name) \
181 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
182
183/**
184 * DEVICE_ATTR_ADMIN_RW - Define an admin-only read-write device attribute.
185 * @_name: Attribute name.
186 *
187 * Like DEVICE_ATTR_RW(), but @_mode is 0600.
188 */
189#define DEVICE_ATTR_ADMIN_RW(_name) \
190 struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
191
192/**
193 * DEVICE_ATTR_RO - Define a readable device attribute.
194 * @_name: Attribute name.
195 *
196 * Like DEVICE_ATTR(), but @_mode is 0444 and @_show is <_name>_show.
197 */
198#define DEVICE_ATTR_RO(_name) \
199 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
200
201/**
202 * DEVICE_ATTR_ADMIN_RO - Define an admin-only readable device attribute.
203 * @_name: Attribute name.
204 *
205 * Like DEVICE_ATTR_RO(), but @_mode is 0400.
206 */
207#define DEVICE_ATTR_ADMIN_RO(_name) \
208 struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
209
210/**
211 * DEVICE_ATTR_WO - Define an admin-only writable device attribute.
212 * @_name: Attribute name.
213 *
214 * Like DEVICE_ATTR(), but @_mode is 0200 and @_store is <_name>_store.
215 */
216#define DEVICE_ATTR_WO(_name) \
217 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
218
219/**
220 * DEVICE_ULONG_ATTR - Define a device attribute backed by an unsigned long.
221 * @_name: Attribute name.
222 * @_mode: File mode.
223 * @_var: Identifier of unsigned long.
224 *
225 * Like DEVICE_ATTR(), but @_show and @_store are automatically provided
226 * such that reads and writes to the attribute from userspace affect @_var.
227 */
228#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
229 struct dev_ext_attribute dev_attr_##_name = \
230 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
231
232/**
233 * DEVICE_INT_ATTR - Define a device attribute backed by an int.
234 * @_name: Attribute name.
235 * @_mode: File mode.
236 * @_var: Identifier of int.
237 *
238 * Like DEVICE_ULONG_ATTR(), but @_var is an int.
239 */
240#define DEVICE_INT_ATTR(_name, _mode, _var) \
241 struct dev_ext_attribute dev_attr_##_name = \
242 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
243
244/**
245 * DEVICE_BOOL_ATTR - Define a device attribute backed by a bool.
246 * @_name: Attribute name.
247 * @_mode: File mode.
248 * @_var: Identifier of bool.
249 *
250 * Like DEVICE_ULONG_ATTR(), but @_var is a bool.
251 */
252#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
253 struct dev_ext_attribute dev_attr_##_name = \
254 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
255
256/**
257 * DEVICE_STRING_ATTR_RO - Define a device attribute backed by a r/o string.
258 * @_name: Attribute name.
259 * @_mode: File mode.
260 * @_var: Identifier of string.
261 *
262 * Like DEVICE_ULONG_ATTR(), but @_var is a string. Because the length of the
263 * string allocation is unknown, the attribute must be read-only.
264 */
265#define DEVICE_STRING_ATTR_RO(_name, _mode, _var) \
266 struct dev_ext_attribute dev_attr_##_name = \
267 { __ATTR(_name, (_mode) & ~0222, device_show_string, NULL), (_var) }
268
269#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
270 struct device_attribute dev_attr_##_name = \
271 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
272
273int device_create_file(struct device *device,
274 const struct device_attribute *entry);
275void device_remove_file(struct device *dev,
276 const struct device_attribute *attr);
277bool device_remove_file_self(struct device *dev,
278 const struct device_attribute *attr);
279int __must_check device_create_bin_file(struct device *dev,
280 const struct bin_attribute *attr);
281void device_remove_bin_file(struct device *dev,
282 const struct bin_attribute *attr);
283
284/**
285 * devm_alloc_percpu - Resource-managed alloc_percpu
286 * @dev: Device to allocate per-cpu memory for
287 * @type: Type to allocate per-cpu memory for
288 *
289 * Managed alloc_percpu. Per-cpu memory allocated with this function is
290 * automatically freed on driver detach.
291 *
292 * RETURNS:
293 * Pointer to allocated memory on success, NULL on failure.
294 */
295#define devm_alloc_percpu(dev, type) \
296 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
297 __alignof__(type)))
298
299void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
300 size_t align);
301void devm_free_percpu(struct device *dev, void __percpu *pdata);
302
303struct device_dma_parameters {
304 /*
305 * a low level driver may set these to teach IOMMU code about
306 * sg limitations.
307 */
308 unsigned int max_segment_size;
309 unsigned int min_align_mask;
310 unsigned long segment_boundary_mask;
311};
312
313/**
314 * enum device_link_state - Device link states.
315 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
316 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
317 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
318 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
319 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
320 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
321 */
322enum device_link_state {
323 DL_STATE_NONE = -1,
324 DL_STATE_DORMANT = 0,
325 DL_STATE_AVAILABLE,
326 DL_STATE_CONSUMER_PROBE,
327 DL_STATE_ACTIVE,
328 DL_STATE_SUPPLIER_UNBIND,
329};
330
331/*
332 * Device link flags.
333 *
334 * STATELESS: The core will not remove this link automatically.
335 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
336 * PM_RUNTIME: If set, the runtime PM framework will use this link.
337 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
338 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
339 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
340 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
341 * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
342 * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
343 */
344#define DL_FLAG_STATELESS BIT(0)
345#define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
346#define DL_FLAG_PM_RUNTIME BIT(2)
347#define DL_FLAG_RPM_ACTIVE BIT(3)
348#define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
349#define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
350#define DL_FLAG_MANAGED BIT(6)
351#define DL_FLAG_SYNC_STATE_ONLY BIT(7)
352#define DL_FLAG_INFERRED BIT(8)
353#define DL_FLAG_CYCLE BIT(9)
354
355/**
356 * enum dl_dev_state - Device driver presence tracking information.
357 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
358 * @DL_DEV_PROBING: A driver is probing.
359 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
360 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
361 */
362enum dl_dev_state {
363 DL_DEV_NO_DRIVER = 0,
364 DL_DEV_PROBING,
365 DL_DEV_DRIVER_BOUND,
366 DL_DEV_UNBINDING,
367};
368
369/**
370 * enum device_removable - Whether the device is removable. The criteria for a
371 * device to be classified as removable is determined by its subsystem or bus.
372 * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this
373 * device (default).
374 * @DEVICE_REMOVABLE_UNKNOWN: Device location is Unknown.
375 * @DEVICE_FIXED: Device is not removable by the user.
376 * @DEVICE_REMOVABLE: Device is removable by the user.
377 */
378enum device_removable {
379 DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */
380 DEVICE_REMOVABLE_UNKNOWN,
381 DEVICE_FIXED,
382 DEVICE_REMOVABLE,
383};
384
385/**
386 * struct dev_links_info - Device data related to device links.
387 * @suppliers: List of links to supplier devices.
388 * @consumers: List of links to consumer devices.
389 * @defer_sync: Hook to global list of devices that have deferred sync_state.
390 * @status: Driver status information.
391 */
392struct dev_links_info {
393 struct list_head suppliers;
394 struct list_head consumers;
395 struct list_head defer_sync;
396 enum dl_dev_state status;
397};
398
399/**
400 * struct dev_msi_info - Device data related to MSI
401 * @domain: The MSI interrupt domain associated to the device
402 * @data: Pointer to MSI device data
403 */
404struct dev_msi_info {
405#ifdef CONFIG_GENERIC_MSI_IRQ
406 struct irq_domain *domain;
407 struct msi_device_data *data;
408#endif
409};
410
411/**
412 * enum device_physical_location_panel - Describes which panel surface of the
413 * system's housing the device connection point resides on.
414 * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
415 * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
416 * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
417 * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
418 * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
419 * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
420 * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
421 */
422enum device_physical_location_panel {
423 DEVICE_PANEL_TOP,
424 DEVICE_PANEL_BOTTOM,
425 DEVICE_PANEL_LEFT,
426 DEVICE_PANEL_RIGHT,
427 DEVICE_PANEL_FRONT,
428 DEVICE_PANEL_BACK,
429 DEVICE_PANEL_UNKNOWN,
430};
431
432/**
433 * enum device_physical_location_vertical_position - Describes vertical
434 * position of the device connection point on the panel surface.
435 * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
436 * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
437 * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
438 */
439enum device_physical_location_vertical_position {
440 DEVICE_VERT_POS_UPPER,
441 DEVICE_VERT_POS_CENTER,
442 DEVICE_VERT_POS_LOWER,
443};
444
445/**
446 * enum device_physical_location_horizontal_position - Describes horizontal
447 * position of the device connection point on the panel surface.
448 * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
449 * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
450 * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
451 */
452enum device_physical_location_horizontal_position {
453 DEVICE_HORI_POS_LEFT,
454 DEVICE_HORI_POS_CENTER,
455 DEVICE_HORI_POS_RIGHT,
456};
457
458/**
459 * struct device_physical_location - Device data related to physical location
460 * of the device connection point.
461 * @panel: Panel surface of the system's housing that the device connection
462 * point resides on.
463 * @vertical_position: Vertical position of the device connection point within
464 * the panel.
465 * @horizontal_position: Horizontal position of the device connection point
466 * within the panel.
467 * @dock: Set if the device connection point resides in a docking station or
468 * port replicator.
469 * @lid: Set if this device connection point resides on the lid of laptop
470 * system.
471 */
472struct device_physical_location {
473 enum device_physical_location_panel panel;
474 enum device_physical_location_vertical_position vertical_position;
475 enum device_physical_location_horizontal_position horizontal_position;
476 bool dock;
477 bool lid;
478};
479
480/**
481 * struct device - The basic device structure
482 * @parent: The device's "parent" device, the device to which it is attached.
483 * In most cases, a parent device is some sort of bus or host
484 * controller. If parent is NULL, the device, is a top-level device,
485 * which is not usually what you want.
486 * @p: Holds the private data of the driver core portions of the device.
487 * See the comment of the struct device_private for detail.
488 * @kobj: A top-level, abstract class from which other classes are derived.
489 * @init_name: Initial name of the device.
490 * @type: The type of device.
491 * This identifies the device type and carries type-specific
492 * information.
493 * @mutex: Mutex to synchronize calls to its driver.
494 * @bus: Type of bus device is on.
495 * @driver: Which driver has allocated this
496 * @platform_data: Platform data specific to the device.
497 * Example: For devices on custom boards, as typical of embedded
498 * and SOC based hardware, Linux often uses platform_data to point
499 * to board-specific structures describing devices and how they
500 * are wired. That can include what ports are available, chip
501 * variants, which GPIO pins act in what additional roles, and so
502 * on. This shrinks the "Board Support Packages" (BSPs) and
503 * minimizes board-specific #ifdefs in drivers.
504 * @driver_data: Private pointer for driver specific info.
505 * @links: Links to suppliers and consumers of this device.
506 * @power: For device power management.
507 * See Documentation/driver-api/pm/devices.rst for details.
508 * @pm_domain: Provide callbacks that are executed during system suspend,
509 * hibernation, system resume and during runtime PM transitions
510 * along with subsystem-level and driver-level callbacks.
511 * @em_pd: device's energy model performance domain
512 * @pins: For device pin management.
513 * See Documentation/driver-api/pin-control.rst for details.
514 * @msi: MSI related data
515 * @numa_node: NUMA node this device is close to.
516 * @dma_ops: DMA mapping operations for this device.
517 * @dma_mask: Dma mask (if dma'ble device).
518 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
519 * hardware supports 64-bit addresses for consistent allocations
520 * such descriptors.
521 * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
522 * DMA limit than the device itself supports.
523 * @dma_range_map: map for DMA memory ranges relative to that of RAM
524 * @dma_parms: A low level driver may set these to teach IOMMU code about
525 * segment limitations.
526 * @dma_pools: Dma pools (if dma'ble device).
527 * @dma_mem: Internal for coherent mem override.
528 * @cma_area: Contiguous memory area for dma allocations
529 * @dma_io_tlb_mem: Software IO TLB allocator. Not for driver use.
530 * @dma_io_tlb_pools: List of transient swiotlb memory pools.
531 * @dma_io_tlb_lock: Protects changes to the list of active pools.
532 * @dma_uses_io_tlb: %true if device has used the software IO TLB.
533 * @archdata: For arch-specific additions.
534 * @of_node: Associated device tree node.
535 * @fwnode: Associated device node supplied by platform firmware.
536 * @devt: For creating the sysfs "dev".
537 * @id: device instance
538 * @devres_lock: Spinlock to protect the resource of the device.
539 * @devres_head: The resources list of the device.
540 * @class: The class of the device.
541 * @groups: Optional attribute groups.
542 * @release: Callback to free the device after all references have
543 * gone away. This should be set by the allocator of the
544 * device (i.e. the bus driver that discovered the device).
545 * @iommu_group: IOMMU group the device belongs to.
546 * @iommu: Per device generic IOMMU runtime data
547 * @physical_location: Describes physical location of the device connection
548 * point in the system housing.
549 * @removable: Whether the device can be removed from the system. This
550 * should be set by the subsystem / bus driver that discovered
551 * the device.
552 *
553 * @offline_disabled: If set, the device is permanently online.
554 * @offline: Set after successful invocation of bus type's .offline().
555 * @of_node_reused: Set if the device-tree node is shared with an ancestor
556 * device.
557 * @state_synced: The hardware state of this device has been synced to match
558 * the software state of this device by calling the driver/bus
559 * sync_state() callback.
560 * @can_match: The device has matched with a driver at least once or it is in
561 * a bus (like AMBA) which can't check for matching drivers until
562 * other devices probe successfully.
563 * @dma_coherent: this particular device is dma coherent, even if the
564 * architecture supports non-coherent devices.
565 * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
566 * streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
567 * and optionall (if the coherent mask is large enough) also
568 * for dma allocations. This flag is managed by the dma ops
569 * instance from ->dma_supported.
570 * @dma_skip_sync: DMA sync operations can be skipped for coherent buffers.
571 * @dma_iommu: Device is using default IOMMU implementation for DMA and
572 * doesn't rely on dma_ops structure.
573 *
574 * At the lowest level, every device in a Linux system is represented by an
575 * instance of struct device. The device structure contains the information
576 * that the device model core needs to model the system. Most subsystems,
577 * however, track additional information about the devices they host. As a
578 * result, it is rare for devices to be represented by bare device structures;
579 * instead, that structure, like kobject structures, is usually embedded within
580 * a higher-level representation of the device.
581 */
582struct device {
583 struct kobject kobj;
584 struct device *parent;
585
586 struct device_private *p;
587
588 const char *init_name; /* initial name of the device */
589 const struct device_type *type;
590
591 const struct bus_type *bus; /* type of bus device is on */
592 struct device_driver *driver; /* which driver has allocated this
593 device */
594 void *platform_data; /* Platform specific data, device
595 core doesn't touch it */
596 void *driver_data; /* Driver data, set and get with
597 dev_set_drvdata/dev_get_drvdata */
598 struct mutex mutex; /* mutex to synchronize calls to
599 * its driver.
600 */
601
602 struct dev_links_info links;
603 struct dev_pm_info power;
604 struct dev_pm_domain *pm_domain;
605
606#ifdef CONFIG_ENERGY_MODEL
607 struct em_perf_domain *em_pd;
608#endif
609
610#ifdef CONFIG_PINCTRL
611 struct dev_pin_info *pins;
612#endif
613 struct dev_msi_info msi;
614#ifdef CONFIG_ARCH_HAS_DMA_OPS
615 const struct dma_map_ops *dma_ops;
616#endif
617 u64 *dma_mask; /* dma mask (if dma'able device) */
618 u64 coherent_dma_mask;/* Like dma_mask, but for
619 alloc_coherent mappings as
620 not all hardware supports
621 64 bit addresses for consistent
622 allocations such descriptors. */
623 u64 bus_dma_limit; /* upstream dma constraint */
624 const struct bus_dma_region *dma_range_map;
625
626 struct device_dma_parameters *dma_parms;
627
628 struct list_head dma_pools; /* dma pools (if dma'ble) */
629
630#ifdef CONFIG_DMA_DECLARE_COHERENT
631 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
632 override */
633#endif
634#ifdef CONFIG_DMA_CMA
635 struct cma *cma_area; /* contiguous memory area for dma
636 allocations */
637#endif
638#ifdef CONFIG_SWIOTLB
639 struct io_tlb_mem *dma_io_tlb_mem;
640#endif
641#ifdef CONFIG_SWIOTLB_DYNAMIC
642 struct list_head dma_io_tlb_pools;
643 spinlock_t dma_io_tlb_lock;
644 bool dma_uses_io_tlb;
645#endif
646 /* arch specific additions */
647 struct dev_archdata archdata;
648
649 struct device_node *of_node; /* associated device tree node */
650 struct fwnode_handle *fwnode; /* firmware device node */
651
652#ifdef CONFIG_NUMA
653 int numa_node; /* NUMA node this device is close to */
654#endif
655 dev_t devt; /* dev_t, creates the sysfs "dev" */
656 u32 id; /* device instance */
657
658 spinlock_t devres_lock;
659 struct list_head devres_head;
660
661 const struct class *class;
662 const struct attribute_group **groups; /* optional groups */
663
664 void (*release)(struct device *dev);
665 struct iommu_group *iommu_group;
666 struct dev_iommu *iommu;
667
668 struct device_physical_location *physical_location;
669
670 enum device_removable removable;
671
672 bool offline_disabled:1;
673 bool offline:1;
674 bool of_node_reused:1;
675 bool state_synced:1;
676 bool can_match:1;
677#if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
678 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
679 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
680 bool dma_coherent:1;
681#endif
682#ifdef CONFIG_DMA_OPS_BYPASS
683 bool dma_ops_bypass : 1;
684#endif
685#ifdef CONFIG_DMA_NEED_SYNC
686 bool dma_skip_sync:1;
687#endif
688#ifdef CONFIG_IOMMU_DMA
689 bool dma_iommu:1;
690#endif
691};
692
693/**
694 * struct device_link - Device link representation.
695 * @supplier: The device on the supplier end of the link.
696 * @s_node: Hook to the supplier device's list of links to consumers.
697 * @consumer: The device on the consumer end of the link.
698 * @c_node: Hook to the consumer device's list of links to suppliers.
699 * @link_dev: device used to expose link details in sysfs
700 * @status: The state of the link (with respect to the presence of drivers).
701 * @flags: Link flags.
702 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
703 * @kref: Count repeated addition of the same link.
704 * @rm_work: Work structure used for removing the link.
705 * @supplier_preactivated: Supplier has been made active before consumer probe.
706 */
707struct device_link {
708 struct device *supplier;
709 struct list_head s_node;
710 struct device *consumer;
711 struct list_head c_node;
712 struct device link_dev;
713 enum device_link_state status;
714 u32 flags;
715 refcount_t rpm_active;
716 struct kref kref;
717 struct work_struct rm_work;
718 bool supplier_preactivated; /* Owned by consumer probe. */
719};
720
721#define kobj_to_dev(__kobj) container_of_const(__kobj, struct device, kobj)
722
723/**
724 * device_iommu_mapped - Returns true when the device DMA is translated
725 * by an IOMMU
726 * @dev: Device to perform the check on
727 */
728static inline bool device_iommu_mapped(struct device *dev)
729{
730 return (dev->iommu_group != NULL);
731}
732
733/* Get the wakeup routines, which depend on struct device */
734#include <linux/pm_wakeup.h>
735
736/**
737 * dev_name - Return a device's name.
738 * @dev: Device with name to get.
739 * Return: The kobject name of the device, or its initial name if unavailable.
740 */
741static inline const char *dev_name(const struct device *dev)
742{
743 /* Use the init name until the kobject becomes available */
744 if (dev->init_name)
745 return dev->init_name;
746
747 return kobject_name(kobj: &dev->kobj);
748}
749
750/**
751 * dev_bus_name - Return a device's bus/class name, if at all possible
752 * @dev: struct device to get the bus/class name of
753 *
754 * Will return the name of the bus/class the device is attached to. If it is
755 * not attached to a bus/class, an empty string will be returned.
756 */
757static inline const char *dev_bus_name(const struct device *dev)
758{
759 return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
760}
761
762__printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
763
764#ifdef CONFIG_NUMA
765static inline int dev_to_node(struct device *dev)
766{
767 return dev->numa_node;
768}
769static inline void set_dev_node(struct device *dev, int node)
770{
771 dev->numa_node = node;
772}
773#else
774static inline int dev_to_node(struct device *dev)
775{
776 return NUMA_NO_NODE;
777}
778static inline void set_dev_node(struct device *dev, int node)
779{
780}
781#endif
782
783static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
784{
785#ifdef CONFIG_GENERIC_MSI_IRQ
786 return dev->msi.domain;
787#else
788 return NULL;
789#endif
790}
791
792static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
793{
794#ifdef CONFIG_GENERIC_MSI_IRQ
795 dev->msi.domain = d;
796#endif
797}
798
799static inline void *dev_get_drvdata(const struct device *dev)
800{
801 return dev->driver_data;
802}
803
804static inline void dev_set_drvdata(struct device *dev, void *data)
805{
806 dev->driver_data = data;
807}
808
809static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
810{
811 return dev ? dev->power.subsys_data : NULL;
812}
813
814static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
815{
816 return dev->kobj.uevent_suppress;
817}
818
819static inline void dev_set_uevent_suppress(struct device *dev, int val)
820{
821 dev->kobj.uevent_suppress = val;
822}
823
824static inline int device_is_registered(struct device *dev)
825{
826 return dev->kobj.state_in_sysfs;
827}
828
829static inline void device_enable_async_suspend(struct device *dev)
830{
831 if (!dev->power.is_prepared)
832 dev->power.async_suspend = true;
833}
834
835static inline void device_disable_async_suspend(struct device *dev)
836{
837 if (!dev->power.is_prepared)
838 dev->power.async_suspend = false;
839}
840
841static inline bool device_async_suspend_enabled(struct device *dev)
842{
843 return !!dev->power.async_suspend;
844}
845
846static inline bool device_pm_not_required(struct device *dev)
847{
848 return dev->power.no_pm;
849}
850
851static inline void device_set_pm_not_required(struct device *dev)
852{
853 dev->power.no_pm = true;
854#ifdef CONFIG_PM
855 dev->power.no_callbacks = true;
856#endif
857}
858
859static inline void dev_pm_syscore_device(struct device *dev, bool val)
860{
861#ifdef CONFIG_PM_SLEEP
862 dev->power.syscore = val;
863#endif
864}
865
866static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
867{
868 dev->power.driver_flags = flags;
869}
870
871static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
872{
873 return !!(dev->power.driver_flags & flags);
874}
875
876static inline bool dev_pm_smart_suspend(struct device *dev)
877{
878#ifdef CONFIG_PM_SLEEP
879 return dev->power.smart_suspend;
880#else
881 return false;
882#endif
883}
884
885/*
886 * dev_pm_set_strict_midlayer - Update the device's power.strict_midlayer flag
887 * @dev: Target device.
888 * @val: New flag value.
889 *
890 * When set, power.strict_midlayer means that the middle layer power management
891 * code (typically, a bus type or a PM domain) does not expect its runtime PM
892 * suspend callback to be invoked at all during system-wide PM transitions and
893 * it does not expect its runtime PM resume callback to be invoked at any point
894 * when runtime PM is disabled for the device during system-wide PM transitions.
895 */
896static inline void dev_pm_set_strict_midlayer(struct device *dev, bool val)
897{
898#ifdef CONFIG_PM_SLEEP
899 dev->power.strict_midlayer = val;
900#endif
901}
902
903static inline bool dev_pm_strict_midlayer_is_set(struct device *dev)
904{
905#ifdef CONFIG_PM_SLEEP
906 return dev->power.strict_midlayer;
907#else
908 return false;
909#endif
910}
911
912static inline void device_lock(struct device *dev)
913{
914 mutex_lock(lock: &dev->mutex);
915}
916
917static inline int device_lock_interruptible(struct device *dev)
918{
919 return mutex_lock_interruptible(lock: &dev->mutex);
920}
921
922static inline int device_trylock(struct device *dev)
923{
924 return mutex_trylock(lock: &dev->mutex);
925}
926
927static inline void device_unlock(struct device *dev)
928{
929 mutex_unlock(lock: &dev->mutex);
930}
931
932DEFINE_GUARD(device, struct device *, device_lock(_T), device_unlock(_T))
933
934static inline void device_lock_assert(struct device *dev)
935{
936 lockdep_assert_held(&dev->mutex);
937}
938
939static inline bool dev_has_sync_state(struct device *dev)
940{
941 if (!dev)
942 return false;
943 if (dev->driver && dev->driver->sync_state)
944 return true;
945 if (dev->bus && dev->bus->sync_state)
946 return true;
947 return false;
948}
949
950static inline int dev_set_drv_sync_state(struct device *dev,
951 void (*fn)(struct device *dev))
952{
953 if (!dev || !dev->driver)
954 return 0;
955 if (dev->driver->sync_state && dev->driver->sync_state != fn)
956 return -EBUSY;
957 if (!dev->driver->sync_state)
958 dev->driver->sync_state = fn;
959 return 0;
960}
961
962static inline void dev_set_removable(struct device *dev,
963 enum device_removable removable)
964{
965 dev->removable = removable;
966}
967
968static inline bool dev_is_removable(struct device *dev)
969{
970 return dev->removable == DEVICE_REMOVABLE;
971}
972
973static inline bool dev_removable_is_valid(struct device *dev)
974{
975 return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;
976}
977
978/*
979 * High level routines for use by the bus drivers
980 */
981int __must_check device_register(struct device *dev);
982void device_unregister(struct device *dev);
983void device_initialize(struct device *dev);
984int __must_check device_add(struct device *dev);
985void device_del(struct device *dev);
986
987DEFINE_FREE(device_del, struct device *, if (_T) device_del(_T))
988
989int device_for_each_child(struct device *parent, void *data,
990 device_iter_t fn);
991int device_for_each_child_reverse(struct device *parent, void *data,
992 device_iter_t fn);
993int device_for_each_child_reverse_from(struct device *parent,
994 struct device *from, void *data,
995 device_iter_t fn);
996struct device *device_find_child(struct device *parent, const void *data,
997 device_match_t match);
998/**
999 * device_find_child_by_name - device iterator for locating a child device.
1000 * @parent: parent struct device
1001 * @name: name of the child device
1002 *
1003 * This is similar to the device_find_child() function above, but it
1004 * returns a reference to a device that has the name @name.
1005 *
1006 * NOTE: you will need to drop the reference with put_device() after use.
1007 */
1008static inline struct device *device_find_child_by_name(struct device *parent,
1009 const char *name)
1010{
1011 return device_find_child(parent, data: name, match: device_match_name);
1012}
1013
1014/**
1015 * device_find_any_child - device iterator for locating a child device, if any.
1016 * @parent: parent struct device
1017 *
1018 * This is similar to the device_find_child() function above, but it
1019 * returns a reference to a child device, if any.
1020 *
1021 * NOTE: you will need to drop the reference with put_device() after use.
1022 */
1023static inline struct device *device_find_any_child(struct device *parent)
1024{
1025 return device_find_child(parent, NULL, match: device_match_any);
1026}
1027
1028int device_rename(struct device *dev, const char *new_name);
1029int device_move(struct device *dev, struct device *new_parent,
1030 enum dpm_order dpm_order);
1031int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
1032
1033static inline bool device_supports_offline(struct device *dev)
1034{
1035 return dev->bus && dev->bus->offline && dev->bus->online;
1036}
1037
1038#define __device_lock_set_class(dev, name, key) \
1039do { \
1040 struct device *__d2 __maybe_unused = dev; \
1041 lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
1042} while (0)
1043
1044/**
1045 * device_lock_set_class - Specify a temporary lock class while a device
1046 * is attached to a driver
1047 * @dev: device to modify
1048 * @key: lock class key data
1049 *
1050 * This must be called with the device_lock() already held, for example
1051 * from driver ->probe(). Take care to only override the default
1052 * lockdep_no_validate class.
1053 */
1054#ifdef CONFIG_LOCKDEP
1055#define device_lock_set_class(dev, key) \
1056do { \
1057 struct device *__d = dev; \
1058 dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex, \
1059 &__lockdep_no_validate__), \
1060 "overriding existing custom lock class\n"); \
1061 __device_lock_set_class(__d, #key, key); \
1062} while (0)
1063#else
1064#define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key)
1065#endif
1066
1067/**
1068 * device_lock_reset_class - Return a device to the default lockdep novalidate state
1069 * @dev: device to modify
1070 *
1071 * This must be called with the device_lock() already held, for example
1072 * from driver ->remove().
1073 */
1074#define device_lock_reset_class(dev) \
1075do { \
1076 struct device *__d __maybe_unused = dev; \
1077 lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex", \
1078 _THIS_IP_); \
1079} while (0)
1080
1081void lock_device_hotplug(void);
1082void unlock_device_hotplug(void);
1083int lock_device_hotplug_sysfs(void);
1084int device_offline(struct device *dev);
1085int device_online(struct device *dev);
1086
1087void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1088void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1089void device_set_node(struct device *dev, struct fwnode_handle *fwnode);
1090int device_add_of_node(struct device *dev, struct device_node *of_node);
1091void device_remove_of_node(struct device *dev);
1092void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1093struct device *get_dev_from_fwnode(struct fwnode_handle *fwnode);
1094
1095static inline struct device_node *dev_of_node(struct device *dev)
1096{
1097 if (!IS_ENABLED(CONFIG_OF) || !dev)
1098 return NULL;
1099 return dev->of_node;
1100}
1101
1102static inline int dev_num_vf(struct device *dev)
1103{
1104 if (dev->bus && dev->bus->num_vf)
1105 return dev->bus->num_vf(dev);
1106 return 0;
1107}
1108
1109/*
1110 * Root device objects for grouping under /sys/devices
1111 */
1112struct device *__root_device_register(const char *name, struct module *owner);
1113
1114/* This is a macro to avoid include problems with THIS_MODULE */
1115#define root_device_register(name) \
1116 __root_device_register(name, THIS_MODULE)
1117
1118void root_device_unregister(struct device *root);
1119
1120static inline void *dev_get_platdata(const struct device *dev)
1121{
1122 return dev->platform_data;
1123}
1124
1125/*
1126 * Manual binding of a device to driver. See drivers/base/bus.c
1127 * for information on use.
1128 */
1129int __must_check device_driver_attach(const struct device_driver *drv,
1130 struct device *dev);
1131int __must_check device_bind_driver(struct device *dev);
1132void device_release_driver(struct device *dev);
1133int __must_check device_attach(struct device *dev);
1134int __must_check driver_attach(const struct device_driver *drv);
1135void device_initial_probe(struct device *dev);
1136int __must_check device_reprobe(struct device *dev);
1137
1138bool device_is_bound(struct device *dev);
1139
1140/*
1141 * Easy functions for dynamically creating devices on the fly
1142 */
1143__printf(5, 6) struct device *
1144device_create(const struct class *cls, struct device *parent, dev_t devt,
1145 void *drvdata, const char *fmt, ...);
1146__printf(6, 7) struct device *
1147device_create_with_groups(const struct class *cls, struct device *parent, dev_t devt,
1148 void *drvdata, const struct attribute_group **groups,
1149 const char *fmt, ...);
1150void device_destroy(const struct class *cls, dev_t devt);
1151
1152int __must_check device_add_groups(struct device *dev,
1153 const struct attribute_group **groups);
1154void device_remove_groups(struct device *dev,
1155 const struct attribute_group **groups);
1156
1157static inline int __must_check device_add_group(struct device *dev,
1158 const struct attribute_group *grp)
1159{
1160 const struct attribute_group *groups[] = { grp, NULL };
1161
1162 return device_add_groups(dev, groups);
1163}
1164
1165static inline void device_remove_group(struct device *dev,
1166 const struct attribute_group *grp)
1167{
1168 const struct attribute_group *groups[] = { grp, NULL };
1169
1170 device_remove_groups(dev, groups);
1171}
1172
1173int __must_check devm_device_add_group(struct device *dev,
1174 const struct attribute_group *grp);
1175
1176/*
1177 * get_device - atomically increment the reference count for the device.
1178 *
1179 */
1180struct device *get_device(struct device *dev);
1181void put_device(struct device *dev);
1182
1183DEFINE_FREE(put_device, struct device *, if (_T) put_device(_T))
1184
1185bool kill_device(struct device *dev);
1186
1187#ifdef CONFIG_DEVTMPFS
1188int devtmpfs_mount(void);
1189#else
1190static inline int devtmpfs_mount(void) { return 0; }
1191#endif
1192
1193/* drivers/base/power/shutdown.c */
1194void device_shutdown(void);
1195
1196/* debugging and troubleshooting/diagnostic helpers. */
1197const char *dev_driver_string(const struct device *dev);
1198
1199/* Device links interface. */
1200struct device_link *device_link_add(struct device *consumer,
1201 struct device *supplier, u32 flags);
1202void device_link_del(struct device_link *link);
1203void device_link_remove(void *consumer, struct device *supplier);
1204void device_links_supplier_sync_state_pause(void);
1205void device_links_supplier_sync_state_resume(void);
1206void device_link_wait_removal(void);
1207
1208static inline bool device_link_test(const struct device_link *link, u32 flags)
1209{
1210 return !!(link->flags & flags);
1211}
1212
1213/* Create alias, so I can be autoloaded. */
1214#define MODULE_ALIAS_CHARDEV(major,minor) \
1215 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1216#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1217 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1218
1219#endif /* _DEVICE_H_ */
1220