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