1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * device.h - generic, centralized driver model 4 * 5 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> 6 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> 7 * Copyright (c) 2008-2009 Novell Inc. 8 * 9 * See Documentation/driver-api/driver-model/ for more information. 10 */ 11 12 #ifndef _DEVICE_H_ 13 #define _DEVICE_H_ 14 15 #include <linux/dev_printk.h> 16 #include <linux/energy_model.h> 17 #include <linux/ioport.h> 18 #include <linux/kobject.h> 19 #include <linux/klist.h> 20 #include <linux/list.h> 21 #include <linux/lockdep.h> 22 #include <linux/compiler.h> 23 #include <linux/types.h> 24 #include <linux/mutex.h> 25 #include <linux/pm.h> 26 #include <linux/atomic.h> 27 #include <linux/uidgid.h> 28 #include <linux/gfp.h> 29 #include <linux/overflow.h> 30 #include <linux/device/bus.h> 31 #include <linux/device/class.h> 32 #include <linux/device/driver.h> 33 #include <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 * struct device - The basic device structure 391 * @parent: The device's "parent" device, the device to which it is attached. 392 * In most cases, a parent device is some sort of bus or host 393 * controller. If parent is NULL, the device, is a top-level device, 394 * which is not usually what you want. 395 * @p: Holds the private data of the driver core portions of the device. 396 * See the comment of the struct device_private for detail. 397 * @kobj: A top-level, abstract class from which other classes are derived. 398 * @init_name: Initial name of the device. 399 * @type: The type of device. 400 * This identifies the device type and carries type-specific 401 * information. 402 * @mutex: Mutex to synchronize calls to its driver. 403 * @lockdep_mutex: An optional debug lock that a subsystem can use as a 404 * peer lock to gain localized lockdep coverage of the device_lock. 405 * @bus: Type of bus device is on. 406 * @driver: Which driver has allocated this 407 * @platform_data: Platform data specific to the device. 408 * Example: For devices on custom boards, as typical of embedded 409 * and SOC based hardware, Linux often uses platform_data to point 410 * to board-specific structures describing devices and how they 411 * are wired. That can include what ports are available, chip 412 * variants, which GPIO pins act in what additional roles, and so 413 * on. This shrinks the "Board Support Packages" (BSPs) and 414 * minimizes board-specific #ifdefs in drivers. 415 * @driver_data: Private pointer for driver specific info. 416 * @links: Links to suppliers and consumers of this device. 417 * @power: For device power management. 418 * See Documentation/driver-api/pm/devices.rst for details. 419 * @pm_domain: Provide callbacks that are executed during system suspend, 420 * hibernation, system resume and during runtime PM transitions 421 * along with subsystem-level and driver-level callbacks. 422 * @em_pd: device's energy model performance domain 423 * @pins: For device pin management. 424 * See Documentation/driver-api/pin-control.rst for details. 425 * @msi: MSI related data 426 * @numa_node: NUMA node this device is close to. 427 * @dma_ops: DMA mapping operations for this device. 428 * @dma_mask: Dma mask (if dma'ble device). 429 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all 430 * hardware supports 64-bit addresses for consistent allocations 431 * such descriptors. 432 * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller 433 * DMA limit than the device itself supports. 434 * @dma_range_map: map for DMA memory ranges relative to that of RAM 435 * @dma_parms: A low level driver may set these to teach IOMMU code about 436 * segment limitations. 437 * @dma_pools: Dma pools (if dma'ble device). 438 * @dma_mem: Internal for coherent mem override. 439 * @cma_area: Contiguous memory area for dma allocations 440 * @dma_io_tlb_mem: Pointer to the swiotlb pool used. Not for driver use. 441 * @archdata: For arch-specific additions. 442 * @of_node: Associated device tree node. 443 * @fwnode: Associated device node supplied by platform firmware. 444 * @devt: For creating the sysfs "dev". 445 * @id: device instance 446 * @devres_lock: Spinlock to protect the resource of the device. 447 * @devres_head: The resources list of the device. 448 * @knode_class: The node used to add the device to the class list. 449 * @class: The class of the device. 450 * @groups: Optional attribute groups. 451 * @release: Callback to free the device after all references have 452 * gone away. This should be set by the allocator of the 453 * device (i.e. the bus driver that discovered the device). 454 * @iommu_group: IOMMU group the device belongs to. 455 * @iommu: Per device generic IOMMU runtime data 456 * @removable: Whether the device can be removed from the system. This 457 * should be set by the subsystem / bus driver that discovered 458 * the device. 459 * 460 * @offline_disabled: If set, the device is permanently online. 461 * @offline: Set after successful invocation of bus type's .offline(). 462 * @of_node_reused: Set if the device-tree node is shared with an ancestor 463 * device. 464 * @state_synced: The hardware state of this device has been synced to match 465 * the software state of this device by calling the driver/bus 466 * sync_state() callback. 467 * @can_match: The device has matched with a driver at least once or it is in 468 * a bus (like AMBA) which can't check for matching drivers until 469 * other devices probe successfully. 470 * @dma_coherent: this particular device is dma coherent, even if the 471 * architecture supports non-coherent devices. 472 * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the 473 * streaming DMA operations (->map_* / ->unmap_* / ->sync_*), 474 * and optionall (if the coherent mask is large enough) also 475 * for dma allocations. This flag is managed by the dma ops 476 * instance from ->dma_supported. 477 * 478 * At the lowest level, every device in a Linux system is represented by an 479 * instance of struct device. The device structure contains the information 480 * that the device model core needs to model the system. Most subsystems, 481 * however, track additional information about the devices they host. As a 482 * result, it is rare for devices to be represented by bare device structures; 483 * instead, that structure, like kobject structures, is usually embedded within 484 * a higher-level representation of the device. 485 */ 486 struct device { 487 struct kobject kobj; 488 struct device *parent; 489 490 struct device_private *p; 491 492 const char *init_name; /* initial name of the device */ 493 const struct device_type *type; 494 495 struct bus_type *bus; /* type of bus device is on */ 496 struct device_driver *driver; /* which driver has allocated this 497 device */ 498 void *platform_data; /* Platform specific data, device 499 core doesn't touch it */ 500 void *driver_data; /* Driver data, set and get with 501 dev_set_drvdata/dev_get_drvdata */ 502 #ifdef CONFIG_PROVE_LOCKING 503 struct mutex lockdep_mutex; 504 #endif 505 struct mutex mutex; /* mutex to synchronize calls to 506 * its driver. 507 */ 508 509 struct dev_links_info links; 510 struct dev_pm_info power; 511 struct dev_pm_domain *pm_domain; 512 513 #ifdef CONFIG_ENERGY_MODEL 514 struct em_perf_domain *em_pd; 515 #endif 516 517 #ifdef CONFIG_PINCTRL 518 struct dev_pin_info *pins; 519 #endif 520 struct dev_msi_info msi; 521 #ifdef CONFIG_DMA_OPS 522 const struct dma_map_ops *dma_ops; 523 #endif 524 u64 *dma_mask; /* dma mask (if dma'able device) */ 525 u64 coherent_dma_mask;/* Like dma_mask, but for 526 alloc_coherent mappings as 527 not all hardware supports 528 64 bit addresses for consistent 529 allocations such descriptors. */ 530 u64 bus_dma_limit; /* upstream dma constraint */ 531 const struct bus_dma_region *dma_range_map; 532 533 struct device_dma_parameters *dma_parms; 534 535 struct list_head dma_pools; /* dma pools (if dma'ble) */ 536 537 #ifdef CONFIG_DMA_DECLARE_COHERENT 538 struct dma_coherent_mem *dma_mem; /* internal for coherent mem 539 override */ 540 #endif 541 #ifdef CONFIG_DMA_CMA 542 struct cma *cma_area; /* contiguous memory area for dma 543 allocations */ 544 #endif 545 #ifdef CONFIG_SWIOTLB 546 struct io_tlb_mem *dma_io_tlb_mem; 547 #endif 548 /* arch specific additions */ 549 struct dev_archdata archdata; 550 551 struct device_node *of_node; /* associated device tree node */ 552 struct fwnode_handle *fwnode; /* firmware device node */ 553 554 #ifdef CONFIG_NUMA 555 int numa_node; /* NUMA node this device is close to */ 556 #endif 557 dev_t devt; /* dev_t, creates the sysfs "dev" */ 558 u32 id; /* device instance */ 559 560 spinlock_t devres_lock; 561 struct list_head devres_head; 562 563 struct class *class; 564 const struct attribute_group **groups; /* optional groups */ 565 566 void (*release)(struct device *dev); 567 struct iommu_group *iommu_group; 568 struct dev_iommu *iommu; 569 570 enum device_removable removable; 571 572 bool offline_disabled:1; 573 bool offline:1; 574 bool of_node_reused:1; 575 bool state_synced:1; 576 bool can_match:1; 577 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ 578 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ 579 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) 580 bool dma_coherent:1; 581 #endif 582 #ifdef CONFIG_DMA_OPS_BYPASS 583 bool dma_ops_bypass : 1; 584 #endif 585 }; 586 587 /** 588 * struct device_link - Device link representation. 589 * @supplier: The device on the supplier end of the link. 590 * @s_node: Hook to the supplier device's list of links to consumers. 591 * @consumer: The device on the consumer end of the link. 592 * @c_node: Hook to the consumer device's list of links to suppliers. 593 * @link_dev: device used to expose link details in sysfs 594 * @status: The state of the link (with respect to the presence of drivers). 595 * @flags: Link flags. 596 * @rpm_active: Whether or not the consumer device is runtime-PM-active. 597 * @kref: Count repeated addition of the same link. 598 * @rm_work: Work structure used for removing the link. 599 * @supplier_preactivated: Supplier has been made active before consumer probe. 600 */ 601 struct device_link { 602 struct device *supplier; 603 struct list_head s_node; 604 struct device *consumer; 605 struct list_head c_node; 606 struct device link_dev; 607 enum device_link_state status; 608 u32 flags; 609 refcount_t rpm_active; 610 struct kref kref; 611 struct work_struct rm_work; 612 bool supplier_preactivated; /* Owned by consumer probe. */ 613 }; 614 615 static inline struct device *kobj_to_dev(struct kobject *kobj) 616 { 617 return container_of(kobj, struct device, kobj); 618 } 619 620 /** 621 * device_iommu_mapped - Returns true when the device DMA is translated 622 * by an IOMMU 623 * @dev: Device to perform the check on 624 */ 625 static inline bool device_iommu_mapped(struct device *dev) 626 { 627 return (dev->iommu_group != NULL); 628 } 629 630 /* Get the wakeup routines, which depend on struct device */ 631 #include <linux/pm_wakeup.h> 632 633 static inline const char *dev_name(const struct device *dev) 634 { 635 /* Use the init name until the kobject becomes available */ 636 if (dev->init_name) 637 return dev->init_name; 638 639 return kobject_name(&dev->kobj); 640 } 641 642 /** 643 * dev_bus_name - Return a device's bus/class name, if at all possible 644 * @dev: struct device to get the bus/class name of 645 * 646 * Will return the name of the bus/class the device is attached to. If it is 647 * not attached to a bus/class, an empty string will be returned. 648 */ 649 static inline const char *dev_bus_name(const struct device *dev) 650 { 651 return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : ""); 652 } 653 654 __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...); 655 656 #ifdef CONFIG_NUMA 657 static inline int dev_to_node(struct device *dev) 658 { 659 return dev->numa_node; 660 } 661 static inline void set_dev_node(struct device *dev, int node) 662 { 663 dev->numa_node = node; 664 } 665 #else 666 static inline int dev_to_node(struct device *dev) 667 { 668 return NUMA_NO_NODE; 669 } 670 static inline void set_dev_node(struct device *dev, int node) 671 { 672 } 673 #endif 674 675 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) 676 { 677 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 678 return dev->msi.domain; 679 #else 680 return NULL; 681 #endif 682 } 683 684 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) 685 { 686 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 687 dev->msi.domain = d; 688 #endif 689 } 690 691 static inline void *dev_get_drvdata(const struct device *dev) 692 { 693 return dev->driver_data; 694 } 695 696 static inline void dev_set_drvdata(struct device *dev, void *data) 697 { 698 dev->driver_data = data; 699 } 700 701 static inline struct pm_subsys_data *dev_to_psd(struct device *dev) 702 { 703 return dev ? dev->power.subsys_data : NULL; 704 } 705 706 static inline unsigned int dev_get_uevent_suppress(const struct device *dev) 707 { 708 return dev->kobj.uevent_suppress; 709 } 710 711 static inline void dev_set_uevent_suppress(struct device *dev, int val) 712 { 713 dev->kobj.uevent_suppress = val; 714 } 715 716 static inline int device_is_registered(struct device *dev) 717 { 718 return dev->kobj.state_in_sysfs; 719 } 720 721 static inline void device_enable_async_suspend(struct device *dev) 722 { 723 if (!dev->power.is_prepared) 724 dev->power.async_suspend = true; 725 } 726 727 static inline void device_disable_async_suspend(struct device *dev) 728 { 729 if (!dev->power.is_prepared) 730 dev->power.async_suspend = false; 731 } 732 733 static inline bool device_async_suspend_enabled(struct device *dev) 734 { 735 return !!dev->power.async_suspend; 736 } 737 738 static inline bool device_pm_not_required(struct device *dev) 739 { 740 return dev->power.no_pm; 741 } 742 743 static inline void device_set_pm_not_required(struct device *dev) 744 { 745 dev->power.no_pm = true; 746 } 747 748 static inline void dev_pm_syscore_device(struct device *dev, bool val) 749 { 750 #ifdef CONFIG_PM_SLEEP 751 dev->power.syscore = val; 752 #endif 753 } 754 755 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) 756 { 757 dev->power.driver_flags = flags; 758 } 759 760 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) 761 { 762 return !!(dev->power.driver_flags & flags); 763 } 764 765 static inline void device_lock(struct device *dev) 766 { 767 mutex_lock(&dev->mutex); 768 } 769 770 static inline int device_lock_interruptible(struct device *dev) 771 { 772 return mutex_lock_interruptible(&dev->mutex); 773 } 774 775 static inline int device_trylock(struct device *dev) 776 { 777 return mutex_trylock(&dev->mutex); 778 } 779 780 static inline void device_unlock(struct device *dev) 781 { 782 mutex_unlock(&dev->mutex); 783 } 784 785 static inline void device_lock_assert(struct device *dev) 786 { 787 lockdep_assert_held(&dev->mutex); 788 } 789 790 static inline struct device_node *dev_of_node(struct device *dev) 791 { 792 if (!IS_ENABLED(CONFIG_OF) || !dev) 793 return NULL; 794 return dev->of_node; 795 } 796 797 static inline bool dev_has_sync_state(struct device *dev) 798 { 799 if (!dev) 800 return false; 801 if (dev->driver && dev->driver->sync_state) 802 return true; 803 if (dev->bus && dev->bus->sync_state) 804 return true; 805 return false; 806 } 807 808 static inline void dev_set_removable(struct device *dev, 809 enum device_removable removable) 810 { 811 dev->removable = removable; 812 } 813 814 static inline bool dev_is_removable(struct device *dev) 815 { 816 return dev->removable == DEVICE_REMOVABLE; 817 } 818 819 static inline bool dev_removable_is_valid(struct device *dev) 820 { 821 return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED; 822 } 823 824 /* 825 * High level routines for use by the bus drivers 826 */ 827 int __must_check device_register(struct device *dev); 828 void device_unregister(struct device *dev); 829 void device_initialize(struct device *dev); 830 int __must_check device_add(struct device *dev); 831 void device_del(struct device *dev); 832 int device_for_each_child(struct device *dev, void *data, 833 int (*fn)(struct device *dev, void *data)); 834 int device_for_each_child_reverse(struct device *dev, void *data, 835 int (*fn)(struct device *dev, void *data)); 836 struct device *device_find_child(struct device *dev, void *data, 837 int (*match)(struct device *dev, void *data)); 838 struct device *device_find_child_by_name(struct device *parent, 839 const char *name); 840 int device_rename(struct device *dev, const char *new_name); 841 int device_move(struct device *dev, struct device *new_parent, 842 enum dpm_order dpm_order); 843 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid); 844 const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid, 845 kgid_t *gid, const char **tmp); 846 int device_is_dependent(struct device *dev, void *target); 847 848 static inline bool device_supports_offline(struct device *dev) 849 { 850 return dev->bus && dev->bus->offline && dev->bus->online; 851 } 852 853 void lock_device_hotplug(void); 854 void unlock_device_hotplug(void); 855 int lock_device_hotplug_sysfs(void); 856 int device_offline(struct device *dev); 857 int device_online(struct device *dev); 858 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 859 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 860 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); 861 void device_set_node(struct device *dev, struct fwnode_handle *fwnode); 862 863 static inline int dev_num_vf(struct device *dev) 864 { 865 if (dev->bus && dev->bus->num_vf) 866 return dev->bus->num_vf(dev); 867 return 0; 868 } 869 870 /* 871 * Root device objects for grouping under /sys/devices 872 */ 873 struct device *__root_device_register(const char *name, struct module *owner); 874 875 /* This is a macro to avoid include problems with THIS_MODULE */ 876 #define root_device_register(name) \ 877 __root_device_register(name, THIS_MODULE) 878 879 void root_device_unregister(struct device *root); 880 881 static inline void *dev_get_platdata(const struct device *dev) 882 { 883 return dev->platform_data; 884 } 885 886 /* 887 * Manual binding of a device to driver. See drivers/base/bus.c 888 * for information on use. 889 */ 890 int __must_check device_driver_attach(struct device_driver *drv, 891 struct device *dev); 892 int __must_check device_bind_driver(struct device *dev); 893 void device_release_driver(struct device *dev); 894 int __must_check device_attach(struct device *dev); 895 int __must_check driver_attach(struct device_driver *drv); 896 void device_initial_probe(struct device *dev); 897 int __must_check device_reprobe(struct device *dev); 898 899 bool device_is_bound(struct device *dev); 900 901 /* 902 * Easy functions for dynamically creating devices on the fly 903 */ 904 __printf(5, 6) struct device * 905 device_create(struct class *cls, struct device *parent, dev_t devt, 906 void *drvdata, const char *fmt, ...); 907 __printf(6, 7) struct device * 908 device_create_with_groups(struct class *cls, struct device *parent, dev_t devt, 909 void *drvdata, const struct attribute_group **groups, 910 const char *fmt, ...); 911 void device_destroy(struct class *cls, dev_t devt); 912 913 int __must_check device_add_groups(struct device *dev, 914 const struct attribute_group **groups); 915 void device_remove_groups(struct device *dev, 916 const struct attribute_group **groups); 917 918 static inline int __must_check device_add_group(struct device *dev, 919 const struct attribute_group *grp) 920 { 921 const struct attribute_group *groups[] = { grp, NULL }; 922 923 return device_add_groups(dev, groups); 924 } 925 926 static inline void device_remove_group(struct device *dev, 927 const struct attribute_group *grp) 928 { 929 const struct attribute_group *groups[] = { grp, NULL }; 930 931 return device_remove_groups(dev, groups); 932 } 933 934 int __must_check devm_device_add_groups(struct device *dev, 935 const struct attribute_group **groups); 936 void devm_device_remove_groups(struct device *dev, 937 const struct attribute_group **groups); 938 int __must_check devm_device_add_group(struct device *dev, 939 const struct attribute_group *grp); 940 void devm_device_remove_group(struct device *dev, 941 const struct attribute_group *grp); 942 943 /* 944 * Platform "fixup" functions - allow the platform to have their say 945 * about devices and actions that the general device layer doesn't 946 * know about. 947 */ 948 /* Notify platform of device discovery */ 949 extern int (*platform_notify)(struct device *dev); 950 951 extern int (*platform_notify_remove)(struct device *dev); 952 953 954 /* 955 * get_device - atomically increment the reference count for the device. 956 * 957 */ 958 struct device *get_device(struct device *dev); 959 void put_device(struct device *dev); 960 bool kill_device(struct device *dev); 961 962 #ifdef CONFIG_DEVTMPFS 963 int devtmpfs_mount(void); 964 #else 965 static inline int devtmpfs_mount(void) { return 0; } 966 #endif 967 968 /* drivers/base/power/shutdown.c */ 969 void device_shutdown(void); 970 971 /* debugging and troubleshooting/diagnostic helpers. */ 972 const char *dev_driver_string(const struct device *dev); 973 974 /* Device links interface. */ 975 struct device_link *device_link_add(struct device *consumer, 976 struct device *supplier, u32 flags); 977 void device_link_del(struct device_link *link); 978 void device_link_remove(void *consumer, struct device *supplier); 979 void device_links_supplier_sync_state_pause(void); 980 void device_links_supplier_sync_state_resume(void); 981 982 extern __printf(3, 4) 983 int dev_err_probe(const struct device *dev, int err, const char *fmt, ...); 984 985 /* Create alias, so I can be autoloaded. */ 986 #define MODULE_ALIAS_CHARDEV(major,minor) \ 987 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) 988 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ 989 MODULE_ALIAS("char-major-" __stringify(major) "-*") 990 991 #ifdef CONFIG_SYSFS_DEPRECATED 992 extern long sysfs_deprecated; 993 #else 994 #define sysfs_deprecated 0 995 #endif 996 997 #endif /* _DEVICE_H_ */ 998