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