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