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/ioport.h> 16 #include <linux/kobject.h> 17 #include <linux/klist.h> 18 #include <linux/list.h> 19 #include <linux/lockdep.h> 20 #include <linux/compiler.h> 21 #include <linux/types.h> 22 #include <linux/mutex.h> 23 #include <linux/pm.h> 24 #include <linux/atomic.h> 25 #include <linux/ratelimit.h> 26 #include <linux/uidgid.h> 27 #include <linux/gfp.h> 28 #include <linux/overflow.h> 29 #include <asm/device.h> 30 31 struct device; 32 struct device_private; 33 struct device_driver; 34 struct driver_private; 35 struct module; 36 struct class; 37 struct subsys_private; 38 struct bus_type; 39 struct device_node; 40 struct fwnode_handle; 41 struct iommu_ops; 42 struct iommu_group; 43 struct iommu_fwspec; 44 struct dev_pin_info; 45 struct iommu_param; 46 47 struct bus_attribute { 48 struct attribute attr; 49 ssize_t (*show)(struct bus_type *bus, char *buf); 50 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count); 51 }; 52 53 #define BUS_ATTR_RW(_name) \ 54 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name) 55 #define BUS_ATTR_RO(_name) \ 56 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name) 57 #define BUS_ATTR_WO(_name) \ 58 struct bus_attribute bus_attr_##_name = __ATTR_WO(_name) 59 60 extern int __must_check bus_create_file(struct bus_type *, 61 struct bus_attribute *); 62 extern void bus_remove_file(struct bus_type *, struct bus_attribute *); 63 64 /** 65 * struct bus_type - The bus type of the device 66 * 67 * @name: The name of the bus. 68 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id). 69 * @dev_root: Default device to use as the parent. 70 * @bus_groups: Default attributes of the bus. 71 * @dev_groups: Default attributes of the devices on the bus. 72 * @drv_groups: Default attributes of the device drivers on the bus. 73 * @match: Called, perhaps multiple times, whenever a new device or driver 74 * is added for this bus. It should return a positive value if the 75 * given device can be handled by the given driver and zero 76 * otherwise. It may also return error code if determining that 77 * the driver supports the device is not possible. In case of 78 * -EPROBE_DEFER it will queue the device for deferred probing. 79 * @uevent: Called when a device is added, removed, or a few other things 80 * that generate uevents to add the environment variables. 81 * @probe: Called when a new device or driver add to this bus, and callback 82 * the specific driver's probe to initial the matched device. 83 * @remove: Called when a device removed from this bus. 84 * @shutdown: Called at shut-down time to quiesce the device. 85 * 86 * @online: Called to put the device back online (after offlining it). 87 * @offline: Called to put the device offline for hot-removal. May fail. 88 * 89 * @suspend: Called when a device on this bus wants to go to sleep mode. 90 * @resume: Called to bring a device on this bus out of sleep mode. 91 * @num_vf: Called to find out how many virtual functions a device on this 92 * bus supports. 93 * @dma_configure: Called to setup DMA configuration on a device on 94 * this bus. 95 * @pm: Power management operations of this bus, callback the specific 96 * device driver's pm-ops. 97 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU 98 * driver implementations to a bus and allow the driver to do 99 * bus-specific setup 100 * @p: The private data of the driver core, only the driver core can 101 * touch this. 102 * @lock_key: Lock class key for use by the lock validator 103 * @need_parent_lock: When probing or removing a device on this bus, the 104 * device core should lock the device's parent. 105 * 106 * A bus is a channel between the processor and one or more devices. For the 107 * purposes of the device model, all devices are connected via a bus, even if 108 * it is an internal, virtual, "platform" bus. Buses can plug into each other. 109 * A USB controller is usually a PCI device, for example. The device model 110 * represents the actual connections between buses and the devices they control. 111 * A bus is represented by the bus_type structure. It contains the name, the 112 * default attributes, the bus' methods, PM operations, and the driver core's 113 * private data. 114 */ 115 struct bus_type { 116 const char *name; 117 const char *dev_name; 118 struct device *dev_root; 119 const struct attribute_group **bus_groups; 120 const struct attribute_group **dev_groups; 121 const struct attribute_group **drv_groups; 122 123 int (*match)(struct device *dev, struct device_driver *drv); 124 int (*uevent)(struct device *dev, struct kobj_uevent_env *env); 125 int (*probe)(struct device *dev); 126 int (*remove)(struct device *dev); 127 void (*shutdown)(struct device *dev); 128 129 int (*online)(struct device *dev); 130 int (*offline)(struct device *dev); 131 132 int (*suspend)(struct device *dev, pm_message_t state); 133 int (*resume)(struct device *dev); 134 135 int (*num_vf)(struct device *dev); 136 137 int (*dma_configure)(struct device *dev); 138 139 const struct dev_pm_ops *pm; 140 141 const struct iommu_ops *iommu_ops; 142 143 struct subsys_private *p; 144 struct lock_class_key lock_key; 145 146 bool need_parent_lock; 147 }; 148 149 extern int __must_check bus_register(struct bus_type *bus); 150 151 extern void bus_unregister(struct bus_type *bus); 152 153 extern int __must_check bus_rescan_devices(struct bus_type *bus); 154 155 /* iterator helpers for buses */ 156 struct subsys_dev_iter { 157 struct klist_iter ki; 158 const struct device_type *type; 159 }; 160 void subsys_dev_iter_init(struct subsys_dev_iter *iter, 161 struct bus_type *subsys, 162 struct device *start, 163 const struct device_type *type); 164 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter); 165 void subsys_dev_iter_exit(struct subsys_dev_iter *iter); 166 167 int device_match_of_node(struct device *dev, const void *np); 168 169 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, 170 int (*fn)(struct device *dev, void *data)); 171 struct device *bus_find_device(struct bus_type *bus, struct device *start, 172 const void *data, 173 int (*match)(struct device *dev, const void *data)); 174 struct device *bus_find_device_by_name(struct bus_type *bus, 175 struct device *start, 176 const char *name); 177 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id, 178 struct device *hint); 179 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start, 180 void *data, int (*fn)(struct device_driver *, void *)); 181 void bus_sort_breadthfirst(struct bus_type *bus, 182 int (*compare)(const struct device *a, 183 const struct device *b)); 184 /* 185 * Bus notifiers: Get notified of addition/removal of devices 186 * and binding/unbinding of drivers to devices. 187 * In the long run, it should be a replacement for the platform 188 * notify hooks. 189 */ 190 struct notifier_block; 191 192 extern int bus_register_notifier(struct bus_type *bus, 193 struct notifier_block *nb); 194 extern int bus_unregister_notifier(struct bus_type *bus, 195 struct notifier_block *nb); 196 197 /* All 4 notifers below get called with the target struct device * 198 * as an argument. Note that those functions are likely to be called 199 * with the device lock held in the core, so be careful. 200 */ 201 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ 202 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */ 203 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */ 204 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be 205 bound */ 206 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */ 207 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be 208 unbound */ 209 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound 210 from the device */ 211 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */ 212 213 extern struct kset *bus_get_kset(struct bus_type *bus); 214 extern struct klist *bus_get_device_klist(struct bus_type *bus); 215 216 /** 217 * enum probe_type - device driver probe type to try 218 * Device drivers may opt in for special handling of their 219 * respective probe routines. This tells the core what to 220 * expect and prefer. 221 * 222 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well 223 * whether probed synchronously or asynchronously. 224 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which 225 * probing order is not essential for booting the system may 226 * opt into executing their probes asynchronously. 227 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need 228 * their probe routines to run synchronously with driver and 229 * device registration (with the exception of -EPROBE_DEFER 230 * handling - re-probing always ends up being done asynchronously). 231 * 232 * Note that the end goal is to switch the kernel to use asynchronous 233 * probing by default, so annotating drivers with 234 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us 235 * to speed up boot process while we are validating the rest of the 236 * drivers. 237 */ 238 enum probe_type { 239 PROBE_DEFAULT_STRATEGY, 240 PROBE_PREFER_ASYNCHRONOUS, 241 PROBE_FORCE_SYNCHRONOUS, 242 }; 243 244 /** 245 * struct device_driver - The basic device driver structure 246 * @name: Name of the device driver. 247 * @bus: The bus which the device of this driver belongs to. 248 * @owner: The module owner. 249 * @mod_name: Used for built-in modules. 250 * @suppress_bind_attrs: Disables bind/unbind via sysfs. 251 * @probe_type: Type of the probe (synchronous or asynchronous) to use. 252 * @of_match_table: The open firmware table. 253 * @acpi_match_table: The ACPI match table. 254 * @probe: Called to query the existence of a specific device, 255 * whether this driver can work with it, and bind the driver 256 * to a specific device. 257 * @remove: Called when the device is removed from the system to 258 * unbind a device from this driver. 259 * @shutdown: Called at shut-down time to quiesce the device. 260 * @suspend: Called to put the device to sleep mode. Usually to a 261 * low power state. 262 * @resume: Called to bring a device from sleep mode. 263 * @groups: Default attributes that get created by the driver core 264 * automatically. 265 * @dev_groups: Additional attributes attached to device instance once the 266 * it is bound to the driver. 267 * @pm: Power management operations of the device which matched 268 * this driver. 269 * @coredump: Called when sysfs entry is written to. The device driver 270 * is expected to call the dev_coredump API resulting in a 271 * uevent. 272 * @p: Driver core's private data, no one other than the driver 273 * core can touch this. 274 * 275 * The device driver-model tracks all of the drivers known to the system. 276 * The main reason for this tracking is to enable the driver core to match 277 * up drivers with new devices. Once drivers are known objects within the 278 * system, however, a number of other things become possible. Device drivers 279 * can export information and configuration variables that are independent 280 * of any specific device. 281 */ 282 struct device_driver { 283 const char *name; 284 struct bus_type *bus; 285 286 struct module *owner; 287 const char *mod_name; /* used for built-in modules */ 288 289 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */ 290 enum probe_type probe_type; 291 292 const struct of_device_id *of_match_table; 293 const struct acpi_device_id *acpi_match_table; 294 295 int (*probe) (struct device *dev); 296 int (*remove) (struct device *dev); 297 void (*shutdown) (struct device *dev); 298 int (*suspend) (struct device *dev, pm_message_t state); 299 int (*resume) (struct device *dev); 300 const struct attribute_group **groups; 301 const struct attribute_group **dev_groups; 302 303 const struct dev_pm_ops *pm; 304 void (*coredump) (struct device *dev); 305 306 struct driver_private *p; 307 }; 308 309 310 extern int __must_check driver_register(struct device_driver *drv); 311 extern void driver_unregister(struct device_driver *drv); 312 313 extern struct device_driver *driver_find(const char *name, 314 struct bus_type *bus); 315 extern int driver_probe_done(void); 316 extern void wait_for_device_probe(void); 317 318 /* sysfs interface for exporting driver attributes */ 319 320 struct driver_attribute { 321 struct attribute attr; 322 ssize_t (*show)(struct device_driver *driver, char *buf); 323 ssize_t (*store)(struct device_driver *driver, const char *buf, 324 size_t count); 325 }; 326 327 #define DRIVER_ATTR_RW(_name) \ 328 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name) 329 #define DRIVER_ATTR_RO(_name) \ 330 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name) 331 #define DRIVER_ATTR_WO(_name) \ 332 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name) 333 334 extern int __must_check driver_create_file(struct device_driver *driver, 335 const struct driver_attribute *attr); 336 extern void driver_remove_file(struct device_driver *driver, 337 const struct driver_attribute *attr); 338 339 extern int __must_check driver_for_each_device(struct device_driver *drv, 340 struct device *start, 341 void *data, 342 int (*fn)(struct device *dev, 343 void *)); 344 struct device *driver_find_device(struct device_driver *drv, 345 struct device *start, const void *data, 346 int (*match)(struct device *dev, const void *data)); 347 348 void driver_deferred_probe_add(struct device *dev); 349 int driver_deferred_probe_check_state(struct device *dev); 350 int driver_deferred_probe_check_state_continue(struct device *dev); 351 352 /** 353 * struct subsys_interface - interfaces to device functions 354 * @name: name of the device function 355 * @subsys: subsytem of the devices to attach to 356 * @node: the list of functions registered at the subsystem 357 * @add_dev: device hookup to device function handler 358 * @remove_dev: device hookup to device function handler 359 * 360 * Simple interfaces attached to a subsystem. Multiple interfaces can 361 * attach to a subsystem and its devices. Unlike drivers, they do not 362 * exclusively claim or control devices. Interfaces usually represent 363 * a specific functionality of a subsystem/class of devices. 364 */ 365 struct subsys_interface { 366 const char *name; 367 struct bus_type *subsys; 368 struct list_head node; 369 int (*add_dev)(struct device *dev, struct subsys_interface *sif); 370 void (*remove_dev)(struct device *dev, struct subsys_interface *sif); 371 }; 372 373 int subsys_interface_register(struct subsys_interface *sif); 374 void subsys_interface_unregister(struct subsys_interface *sif); 375 376 int subsys_system_register(struct bus_type *subsys, 377 const struct attribute_group **groups); 378 int subsys_virtual_register(struct bus_type *subsys, 379 const struct attribute_group **groups); 380 381 /** 382 * struct class - device classes 383 * @name: Name of the class. 384 * @owner: The module owner. 385 * @class_groups: Default attributes of this class. 386 * @dev_groups: Default attributes of the devices that belong to the class. 387 * @dev_kobj: The kobject that represents this class and links it into the hierarchy. 388 * @dev_uevent: Called when a device is added, removed from this class, or a 389 * few other things that generate uevents to add the environment 390 * variables. 391 * @devnode: Callback to provide the devtmpfs. 392 * @class_release: Called to release this class. 393 * @dev_release: Called to release the device. 394 * @shutdown_pre: Called at shut-down time before driver shutdown. 395 * @ns_type: Callbacks so sysfs can detemine namespaces. 396 * @namespace: Namespace of the device belongs to this class. 397 * @get_ownership: Allows class to specify uid/gid of the sysfs directories 398 * for the devices belonging to the class. Usually tied to 399 * device's namespace. 400 * @pm: The default device power management operations of this class. 401 * @p: The private data of the driver core, no one other than the 402 * driver core can touch this. 403 * 404 * A class is a higher-level view of a device that abstracts out low-level 405 * implementation details. Drivers may see a SCSI disk or an ATA disk, but, 406 * at the class level, they are all simply disks. Classes allow user space 407 * to work with devices based on what they do, rather than how they are 408 * connected or how they work. 409 */ 410 struct class { 411 const char *name; 412 struct module *owner; 413 414 const struct attribute_group **class_groups; 415 const struct attribute_group **dev_groups; 416 struct kobject *dev_kobj; 417 418 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); 419 char *(*devnode)(struct device *dev, umode_t *mode); 420 421 void (*class_release)(struct class *class); 422 void (*dev_release)(struct device *dev); 423 424 int (*shutdown_pre)(struct device *dev); 425 426 const struct kobj_ns_type_operations *ns_type; 427 const void *(*namespace)(struct device *dev); 428 429 void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid); 430 431 const struct dev_pm_ops *pm; 432 433 struct subsys_private *p; 434 }; 435 436 struct class_dev_iter { 437 struct klist_iter ki; 438 const struct device_type *type; 439 }; 440 441 extern struct kobject *sysfs_dev_block_kobj; 442 extern struct kobject *sysfs_dev_char_kobj; 443 extern int __must_check __class_register(struct class *class, 444 struct lock_class_key *key); 445 extern void class_unregister(struct class *class); 446 447 /* This is a #define to keep the compiler from merging different 448 * instances of the __key variable */ 449 #define class_register(class) \ 450 ({ \ 451 static struct lock_class_key __key; \ 452 __class_register(class, &__key); \ 453 }) 454 455 struct class_compat; 456 struct class_compat *class_compat_register(const char *name); 457 void class_compat_unregister(struct class_compat *cls); 458 int class_compat_create_link(struct class_compat *cls, struct device *dev, 459 struct device *device_link); 460 void class_compat_remove_link(struct class_compat *cls, struct device *dev, 461 struct device *device_link); 462 463 extern void class_dev_iter_init(struct class_dev_iter *iter, 464 struct class *class, 465 struct device *start, 466 const struct device_type *type); 467 extern struct device *class_dev_iter_next(struct class_dev_iter *iter); 468 extern void class_dev_iter_exit(struct class_dev_iter *iter); 469 470 extern int class_for_each_device(struct class *class, struct device *start, 471 void *data, 472 int (*fn)(struct device *dev, void *data)); 473 extern struct device *class_find_device(struct class *class, 474 struct device *start, const void *data, 475 int (*match)(struct device *, const void *)); 476 477 struct class_attribute { 478 struct attribute attr; 479 ssize_t (*show)(struct class *class, struct class_attribute *attr, 480 char *buf); 481 ssize_t (*store)(struct class *class, struct class_attribute *attr, 482 const char *buf, size_t count); 483 }; 484 485 #define CLASS_ATTR_RW(_name) \ 486 struct class_attribute class_attr_##_name = __ATTR_RW(_name) 487 #define CLASS_ATTR_RO(_name) \ 488 struct class_attribute class_attr_##_name = __ATTR_RO(_name) 489 #define CLASS_ATTR_WO(_name) \ 490 struct class_attribute class_attr_##_name = __ATTR_WO(_name) 491 492 extern int __must_check class_create_file_ns(struct class *class, 493 const struct class_attribute *attr, 494 const void *ns); 495 extern void class_remove_file_ns(struct class *class, 496 const struct class_attribute *attr, 497 const void *ns); 498 499 static inline int __must_check class_create_file(struct class *class, 500 const struct class_attribute *attr) 501 { 502 return class_create_file_ns(class, attr, NULL); 503 } 504 505 static inline void class_remove_file(struct class *class, 506 const struct class_attribute *attr) 507 { 508 return class_remove_file_ns(class, attr, NULL); 509 } 510 511 /* Simple class attribute that is just a static string */ 512 struct class_attribute_string { 513 struct class_attribute attr; 514 char *str; 515 }; 516 517 /* Currently read-only only */ 518 #define _CLASS_ATTR_STRING(_name, _mode, _str) \ 519 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } 520 #define CLASS_ATTR_STRING(_name, _mode, _str) \ 521 struct class_attribute_string class_attr_##_name = \ 522 _CLASS_ATTR_STRING(_name, _mode, _str) 523 524 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr, 525 char *buf); 526 527 struct class_interface { 528 struct list_head node; 529 struct class *class; 530 531 int (*add_dev) (struct device *, struct class_interface *); 532 void (*remove_dev) (struct device *, struct class_interface *); 533 }; 534 535 extern int __must_check class_interface_register(struct class_interface *); 536 extern void class_interface_unregister(struct class_interface *); 537 538 extern struct class * __must_check __class_create(struct module *owner, 539 const char *name, 540 struct lock_class_key *key); 541 extern void class_destroy(struct class *cls); 542 543 /* This is a #define to keep the compiler from merging different 544 * instances of the __key variable */ 545 #define class_create(owner, name) \ 546 ({ \ 547 static struct lock_class_key __key; \ 548 __class_create(owner, name, &__key); \ 549 }) 550 551 /* 552 * The type of device, "struct device" is embedded in. A class 553 * or bus can contain devices of different types 554 * like "partitions" and "disks", "mouse" and "event". 555 * This identifies the device type and carries type-specific 556 * information, equivalent to the kobj_type of a kobject. 557 * If "name" is specified, the uevent will contain it in 558 * the DEVTYPE variable. 559 */ 560 struct device_type { 561 const char *name; 562 const struct attribute_group **groups; 563 int (*uevent)(struct device *dev, struct kobj_uevent_env *env); 564 char *(*devnode)(struct device *dev, umode_t *mode, 565 kuid_t *uid, kgid_t *gid); 566 void (*release)(struct device *dev); 567 568 const struct dev_pm_ops *pm; 569 }; 570 571 /* interface for exporting device attributes */ 572 struct device_attribute { 573 struct attribute attr; 574 ssize_t (*show)(struct device *dev, struct device_attribute *attr, 575 char *buf); 576 ssize_t (*store)(struct device *dev, struct device_attribute *attr, 577 const char *buf, size_t count); 578 }; 579 580 struct dev_ext_attribute { 581 struct device_attribute attr; 582 void *var; 583 }; 584 585 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr, 586 char *buf); 587 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr, 588 const char *buf, size_t count); 589 ssize_t device_show_int(struct device *dev, struct device_attribute *attr, 590 char *buf); 591 ssize_t device_store_int(struct device *dev, struct device_attribute *attr, 592 const char *buf, size_t count); 593 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, 594 char *buf); 595 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, 596 const char *buf, size_t count); 597 598 #define DEVICE_ATTR(_name, _mode, _show, _store) \ 599 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) 600 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \ 601 struct device_attribute dev_attr_##_name = \ 602 __ATTR_PREALLOC(_name, _mode, _show, _store) 603 #define DEVICE_ATTR_RW(_name) \ 604 struct device_attribute dev_attr_##_name = __ATTR_RW(_name) 605 #define DEVICE_ATTR_RO(_name) \ 606 struct device_attribute dev_attr_##_name = __ATTR_RO(_name) 607 #define DEVICE_ATTR_WO(_name) \ 608 struct device_attribute dev_attr_##_name = __ATTR_WO(_name) 609 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \ 610 struct dev_ext_attribute dev_attr_##_name = \ 611 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) } 612 #define DEVICE_INT_ATTR(_name, _mode, _var) \ 613 struct dev_ext_attribute dev_attr_##_name = \ 614 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) } 615 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \ 616 struct dev_ext_attribute dev_attr_##_name = \ 617 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) } 618 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ 619 struct device_attribute dev_attr_##_name = \ 620 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) 621 622 extern int device_create_file(struct device *device, 623 const struct device_attribute *entry); 624 extern void device_remove_file(struct device *dev, 625 const struct device_attribute *attr); 626 extern bool device_remove_file_self(struct device *dev, 627 const struct device_attribute *attr); 628 extern int __must_check device_create_bin_file(struct device *dev, 629 const struct bin_attribute *attr); 630 extern void device_remove_bin_file(struct device *dev, 631 const struct bin_attribute *attr); 632 633 /* device resource management */ 634 typedef void (*dr_release_t)(struct device *dev, void *res); 635 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); 636 637 #ifdef CONFIG_DEBUG_DEVRES 638 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, 639 int nid, const char *name) __malloc; 640 #define devres_alloc(release, size, gfp) \ 641 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release) 642 #define devres_alloc_node(release, size, gfp, nid) \ 643 __devres_alloc_node(release, size, gfp, nid, #release) 644 #else 645 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, 646 int nid) __malloc; 647 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp) 648 { 649 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE); 650 } 651 #endif 652 653 extern void devres_for_each_res(struct device *dev, dr_release_t release, 654 dr_match_t match, void *match_data, 655 void (*fn)(struct device *, void *, void *), 656 void *data); 657 extern void devres_free(void *res); 658 extern void devres_add(struct device *dev, void *res); 659 extern void *devres_find(struct device *dev, dr_release_t release, 660 dr_match_t match, void *match_data); 661 extern void *devres_get(struct device *dev, void *new_res, 662 dr_match_t match, void *match_data); 663 extern void *devres_remove(struct device *dev, dr_release_t release, 664 dr_match_t match, void *match_data); 665 extern int devres_destroy(struct device *dev, dr_release_t release, 666 dr_match_t match, void *match_data); 667 extern int devres_release(struct device *dev, dr_release_t release, 668 dr_match_t match, void *match_data); 669 670 /* devres group */ 671 extern void * __must_check devres_open_group(struct device *dev, void *id, 672 gfp_t gfp); 673 extern void devres_close_group(struct device *dev, void *id); 674 extern void devres_remove_group(struct device *dev, void *id); 675 extern int devres_release_group(struct device *dev, void *id); 676 677 /* managed devm_k.alloc/kfree for device drivers */ 678 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc; 679 extern __printf(3, 0) 680 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt, 681 va_list ap) __malloc; 682 extern __printf(3, 4) 683 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc; 684 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp) 685 { 686 return devm_kmalloc(dev, size, gfp | __GFP_ZERO); 687 } 688 static inline void *devm_kmalloc_array(struct device *dev, 689 size_t n, size_t size, gfp_t flags) 690 { 691 size_t bytes; 692 693 if (unlikely(check_mul_overflow(n, size, &bytes))) 694 return NULL; 695 696 return devm_kmalloc(dev, bytes, flags); 697 } 698 static inline void *devm_kcalloc(struct device *dev, 699 size_t n, size_t size, gfp_t flags) 700 { 701 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO); 702 } 703 extern void devm_kfree(struct device *dev, const void *p); 704 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc; 705 extern const char *devm_kstrdup_const(struct device *dev, 706 const char *s, gfp_t gfp); 707 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len, 708 gfp_t gfp); 709 710 extern unsigned long devm_get_free_pages(struct device *dev, 711 gfp_t gfp_mask, unsigned int order); 712 extern void devm_free_pages(struct device *dev, unsigned long addr); 713 714 void __iomem *devm_ioremap_resource(struct device *dev, 715 const struct resource *res); 716 717 void __iomem *devm_of_iomap(struct device *dev, 718 struct device_node *node, int index, 719 resource_size_t *size); 720 721 /* allows to add/remove a custom action to devres stack */ 722 int devm_add_action(struct device *dev, void (*action)(void *), void *data); 723 void devm_remove_action(struct device *dev, void (*action)(void *), void *data); 724 void devm_release_action(struct device *dev, void (*action)(void *), void *data); 725 726 static inline int devm_add_action_or_reset(struct device *dev, 727 void (*action)(void *), void *data) 728 { 729 int ret; 730 731 ret = devm_add_action(dev, action, data); 732 if (ret) 733 action(data); 734 735 return ret; 736 } 737 738 /** 739 * devm_alloc_percpu - Resource-managed alloc_percpu 740 * @dev: Device to allocate per-cpu memory for 741 * @type: Type to allocate per-cpu memory for 742 * 743 * Managed alloc_percpu. Per-cpu memory allocated with this function is 744 * automatically freed on driver detach. 745 * 746 * RETURNS: 747 * Pointer to allocated memory on success, NULL on failure. 748 */ 749 #define devm_alloc_percpu(dev, type) \ 750 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \ 751 __alignof__(type))) 752 753 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size, 754 size_t align); 755 void devm_free_percpu(struct device *dev, void __percpu *pdata); 756 757 struct device_dma_parameters { 758 /* 759 * a low level driver may set these to teach IOMMU code about 760 * sg limitations. 761 */ 762 unsigned int max_segment_size; 763 unsigned long segment_boundary_mask; 764 }; 765 766 /** 767 * struct device_connection - Device Connection Descriptor 768 * @fwnode: The device node of the connected device 769 * @endpoint: The names of the two devices connected together 770 * @id: Unique identifier for the connection 771 * @list: List head, private, for internal use only 772 * 773 * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when 774 * platform firmware defines the connection. When the connection is registered 775 * with device_connection_add() @endpoint is used instead. 776 */ 777 struct device_connection { 778 struct fwnode_handle *fwnode; 779 const char *endpoint[2]; 780 const char *id; 781 struct list_head list; 782 }; 783 784 void *device_connection_find_match(struct device *dev, const char *con_id, 785 void *data, 786 void *(*match)(struct device_connection *con, 787 int ep, void *data)); 788 789 struct device *device_connection_find(struct device *dev, const char *con_id); 790 791 void device_connection_add(struct device_connection *con); 792 void device_connection_remove(struct device_connection *con); 793 794 /** 795 * device_connections_add - Add multiple device connections at once 796 * @cons: Zero terminated array of device connection descriptors 797 */ 798 static inline void device_connections_add(struct device_connection *cons) 799 { 800 struct device_connection *c; 801 802 for (c = cons; c->endpoint[0]; c++) 803 device_connection_add(c); 804 } 805 806 /** 807 * device_connections_remove - Remove multiple device connections at once 808 * @cons: Zero terminated array of device connection descriptors 809 */ 810 static inline void device_connections_remove(struct device_connection *cons) 811 { 812 struct device_connection *c; 813 814 for (c = cons; c->endpoint[0]; c++) 815 device_connection_remove(c); 816 } 817 818 /** 819 * enum device_link_state - Device link states. 820 * @DL_STATE_NONE: The presence of the drivers is not being tracked. 821 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. 822 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. 823 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). 824 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. 825 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. 826 */ 827 enum device_link_state { 828 DL_STATE_NONE = -1, 829 DL_STATE_DORMANT = 0, 830 DL_STATE_AVAILABLE, 831 DL_STATE_CONSUMER_PROBE, 832 DL_STATE_ACTIVE, 833 DL_STATE_SUPPLIER_UNBIND, 834 }; 835 836 /* 837 * Device link flags. 838 * 839 * STATELESS: The core won't track the presence of supplier/consumer drivers. 840 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind. 841 * PM_RUNTIME: If set, the runtime PM framework will use this link. 842 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. 843 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind. 844 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds. 845 */ 846 #define DL_FLAG_STATELESS BIT(0) 847 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1) 848 #define DL_FLAG_PM_RUNTIME BIT(2) 849 #define DL_FLAG_RPM_ACTIVE BIT(3) 850 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4) 851 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5) 852 853 /** 854 * struct device_link - Device link representation. 855 * @supplier: The device on the supplier end of the link. 856 * @s_node: Hook to the supplier device's list of links to consumers. 857 * @consumer: The device on the consumer end of the link. 858 * @c_node: Hook to the consumer device's list of links to suppliers. 859 * @status: The state of the link (with respect to the presence of drivers). 860 * @flags: Link flags. 861 * @rpm_active: Whether or not the consumer device is runtime-PM-active. 862 * @kref: Count repeated addition of the same link. 863 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks. 864 * @supplier_preactivated: Supplier has been made active before consumer probe. 865 */ 866 struct device_link { 867 struct device *supplier; 868 struct list_head s_node; 869 struct device *consumer; 870 struct list_head c_node; 871 enum device_link_state status; 872 u32 flags; 873 refcount_t rpm_active; 874 struct kref kref; 875 #ifdef CONFIG_SRCU 876 struct rcu_head rcu_head; 877 #endif 878 bool supplier_preactivated; /* Owned by consumer probe. */ 879 }; 880 881 /** 882 * enum dl_dev_state - Device driver presence tracking information. 883 * @DL_DEV_NO_DRIVER: There is no driver attached to the device. 884 * @DL_DEV_PROBING: A driver is probing. 885 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. 886 * @DL_DEV_UNBINDING: The driver is unbinding from the device. 887 */ 888 enum dl_dev_state { 889 DL_DEV_NO_DRIVER = 0, 890 DL_DEV_PROBING, 891 DL_DEV_DRIVER_BOUND, 892 DL_DEV_UNBINDING, 893 }; 894 895 /** 896 * struct dev_links_info - Device data related to device links. 897 * @suppliers: List of links to supplier devices. 898 * @consumers: List of links to consumer devices. 899 * @status: Driver status information. 900 */ 901 struct dev_links_info { 902 struct list_head suppliers; 903 struct list_head consumers; 904 enum dl_dev_state status; 905 }; 906 907 /** 908 * struct device - The basic device structure 909 * @parent: The device's "parent" device, the device to which it is attached. 910 * In most cases, a parent device is some sort of bus or host 911 * controller. If parent is NULL, the device, is a top-level device, 912 * which is not usually what you want. 913 * @p: Holds the private data of the driver core portions of the device. 914 * See the comment of the struct device_private for detail. 915 * @kobj: A top-level, abstract class from which other classes are derived. 916 * @init_name: Initial name of the device. 917 * @type: The type of device. 918 * This identifies the device type and carries type-specific 919 * information. 920 * @mutex: Mutex to synchronize calls to its driver. 921 * @lockdep_mutex: An optional debug lock that a subsystem can use as a 922 * peer lock to gain localized lockdep coverage of the device_lock. 923 * @bus: Type of bus device is on. 924 * @driver: Which driver has allocated this 925 * @platform_data: Platform data specific to the device. 926 * Example: For devices on custom boards, as typical of embedded 927 * and SOC based hardware, Linux often uses platform_data to point 928 * to board-specific structures describing devices and how they 929 * are wired. That can include what ports are available, chip 930 * variants, which GPIO pins act in what additional roles, and so 931 * on. This shrinks the "Board Support Packages" (BSPs) and 932 * minimizes board-specific #ifdefs in drivers. 933 * @driver_data: Private pointer for driver specific info. 934 * @links: Links to suppliers and consumers of this device. 935 * @power: For device power management. 936 * See Documentation/driver-api/pm/devices.rst for details. 937 * @pm_domain: Provide callbacks that are executed during system suspend, 938 * hibernation, system resume and during runtime PM transitions 939 * along with subsystem-level and driver-level callbacks. 940 * @pins: For device pin management. 941 * See Documentation/driver-api/pinctl.rst for details. 942 * @msi_list: Hosts MSI descriptors 943 * @msi_domain: The generic MSI domain this device is using. 944 * @numa_node: NUMA node this device is close to. 945 * @dma_ops: DMA mapping operations for this device. 946 * @dma_mask: Dma mask (if dma'ble device). 947 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all 948 * hardware supports 64-bit addresses for consistent allocations 949 * such descriptors. 950 * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA 951 * limit than the device itself supports. 952 * @dma_pfn_offset: offset of DMA memory range relatively of RAM 953 * @dma_parms: A low level driver may set these to teach IOMMU code about 954 * segment limitations. 955 * @dma_pools: Dma pools (if dma'ble device). 956 * @dma_mem: Internal for coherent mem override. 957 * @cma_area: Contiguous memory area for dma allocations 958 * @archdata: For arch-specific additions. 959 * @of_node: Associated device tree node. 960 * @fwnode: Associated device node supplied by platform firmware. 961 * @devt: For creating the sysfs "dev". 962 * @id: device instance 963 * @devres_lock: Spinlock to protect the resource of the device. 964 * @devres_head: The resources list of the device. 965 * @knode_class: The node used to add the device to the class list. 966 * @class: The class of the device. 967 * @groups: Optional attribute groups. 968 * @release: Callback to free the device after all references have 969 * gone away. This should be set by the allocator of the 970 * device (i.e. the bus driver that discovered the device). 971 * @iommu_group: IOMMU group the device belongs to. 972 * @iommu_fwspec: IOMMU-specific properties supplied by firmware. 973 * @iommu_param: Per device generic IOMMU runtime data 974 * 975 * @offline_disabled: If set, the device is permanently online. 976 * @offline: Set after successful invocation of bus type's .offline(). 977 * @of_node_reused: Set if the device-tree node is shared with an ancestor 978 * device. 979 * @dma_coherent: this particular device is dma coherent, even if the 980 * architecture supports non-coherent devices. 981 * 982 * At the lowest level, every device in a Linux system is represented by an 983 * instance of struct device. The device structure contains the information 984 * that the device model core needs to model the system. Most subsystems, 985 * however, track additional information about the devices they host. As a 986 * result, it is rare for devices to be represented by bare device structures; 987 * instead, that structure, like kobject structures, is usually embedded within 988 * a higher-level representation of the device. 989 */ 990 struct device { 991 struct kobject kobj; 992 struct device *parent; 993 994 struct device_private *p; 995 996 const char *init_name; /* initial name of the device */ 997 const struct device_type *type; 998 999 struct bus_type *bus; /* type of bus device is on */ 1000 struct device_driver *driver; /* which driver has allocated this 1001 device */ 1002 void *platform_data; /* Platform specific data, device 1003 core doesn't touch it */ 1004 void *driver_data; /* Driver data, set and get with 1005 dev_set_drvdata/dev_get_drvdata */ 1006 #ifdef CONFIG_PROVE_LOCKING 1007 struct mutex lockdep_mutex; 1008 #endif 1009 struct mutex mutex; /* mutex to synchronize calls to 1010 * its driver. 1011 */ 1012 1013 struct dev_links_info links; 1014 struct dev_pm_info power; 1015 struct dev_pm_domain *pm_domain; 1016 1017 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 1018 struct irq_domain *msi_domain; 1019 #endif 1020 #ifdef CONFIG_PINCTRL 1021 struct dev_pin_info *pins; 1022 #endif 1023 #ifdef CONFIG_GENERIC_MSI_IRQ 1024 struct list_head msi_list; 1025 #endif 1026 1027 const struct dma_map_ops *dma_ops; 1028 u64 *dma_mask; /* dma mask (if dma'able device) */ 1029 u64 coherent_dma_mask;/* Like dma_mask, but for 1030 alloc_coherent mappings as 1031 not all hardware supports 1032 64 bit addresses for consistent 1033 allocations such descriptors. */ 1034 u64 bus_dma_mask; /* upstream dma_mask constraint */ 1035 unsigned long dma_pfn_offset; 1036 1037 struct device_dma_parameters *dma_parms; 1038 1039 struct list_head dma_pools; /* dma pools (if dma'ble) */ 1040 1041 #ifdef CONFIG_DMA_DECLARE_COHERENT 1042 struct dma_coherent_mem *dma_mem; /* internal for coherent mem 1043 override */ 1044 #endif 1045 #ifdef CONFIG_DMA_CMA 1046 struct cma *cma_area; /* contiguous memory area for dma 1047 allocations */ 1048 #endif 1049 /* arch specific additions */ 1050 struct dev_archdata archdata; 1051 1052 struct device_node *of_node; /* associated device tree node */ 1053 struct fwnode_handle *fwnode; /* firmware device node */ 1054 1055 #ifdef CONFIG_NUMA 1056 int numa_node; /* NUMA node this device is close to */ 1057 #endif 1058 dev_t devt; /* dev_t, creates the sysfs "dev" */ 1059 u32 id; /* device instance */ 1060 1061 spinlock_t devres_lock; 1062 struct list_head devres_head; 1063 1064 struct class *class; 1065 const struct attribute_group **groups; /* optional groups */ 1066 1067 void (*release)(struct device *dev); 1068 struct iommu_group *iommu_group; 1069 struct iommu_fwspec *iommu_fwspec; 1070 struct iommu_param *iommu_param; 1071 1072 bool offline_disabled:1; 1073 bool offline:1; 1074 bool of_node_reused:1; 1075 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ 1076 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ 1077 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) 1078 bool dma_coherent:1; 1079 #endif 1080 }; 1081 1082 static inline struct device *kobj_to_dev(struct kobject *kobj) 1083 { 1084 return container_of(kobj, struct device, kobj); 1085 } 1086 1087 /** 1088 * device_iommu_mapped - Returns true when the device DMA is translated 1089 * by an IOMMU 1090 * @dev: Device to perform the check on 1091 */ 1092 static inline bool device_iommu_mapped(struct device *dev) 1093 { 1094 return (dev->iommu_group != NULL); 1095 } 1096 1097 /* Get the wakeup routines, which depend on struct device */ 1098 #include <linux/pm_wakeup.h> 1099 1100 static inline const char *dev_name(const struct device *dev) 1101 { 1102 /* Use the init name until the kobject becomes available */ 1103 if (dev->init_name) 1104 return dev->init_name; 1105 1106 return kobject_name(&dev->kobj); 1107 } 1108 1109 extern __printf(2, 3) 1110 int dev_set_name(struct device *dev, const char *name, ...); 1111 1112 #ifdef CONFIG_NUMA 1113 static inline int dev_to_node(struct device *dev) 1114 { 1115 return dev->numa_node; 1116 } 1117 static inline void set_dev_node(struct device *dev, int node) 1118 { 1119 dev->numa_node = node; 1120 } 1121 #else 1122 static inline int dev_to_node(struct device *dev) 1123 { 1124 return NUMA_NO_NODE; 1125 } 1126 static inline void set_dev_node(struct device *dev, int node) 1127 { 1128 } 1129 #endif 1130 1131 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) 1132 { 1133 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 1134 return dev->msi_domain; 1135 #else 1136 return NULL; 1137 #endif 1138 } 1139 1140 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) 1141 { 1142 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 1143 dev->msi_domain = d; 1144 #endif 1145 } 1146 1147 static inline void *dev_get_drvdata(const struct device *dev) 1148 { 1149 return dev->driver_data; 1150 } 1151 1152 static inline void dev_set_drvdata(struct device *dev, void *data) 1153 { 1154 dev->driver_data = data; 1155 } 1156 1157 static inline struct pm_subsys_data *dev_to_psd(struct device *dev) 1158 { 1159 return dev ? dev->power.subsys_data : NULL; 1160 } 1161 1162 static inline unsigned int dev_get_uevent_suppress(const struct device *dev) 1163 { 1164 return dev->kobj.uevent_suppress; 1165 } 1166 1167 static inline void dev_set_uevent_suppress(struct device *dev, int val) 1168 { 1169 dev->kobj.uevent_suppress = val; 1170 } 1171 1172 static inline int device_is_registered(struct device *dev) 1173 { 1174 return dev->kobj.state_in_sysfs; 1175 } 1176 1177 static inline void device_enable_async_suspend(struct device *dev) 1178 { 1179 if (!dev->power.is_prepared) 1180 dev->power.async_suspend = true; 1181 } 1182 1183 static inline void device_disable_async_suspend(struct device *dev) 1184 { 1185 if (!dev->power.is_prepared) 1186 dev->power.async_suspend = false; 1187 } 1188 1189 static inline bool device_async_suspend_enabled(struct device *dev) 1190 { 1191 return !!dev->power.async_suspend; 1192 } 1193 1194 static inline bool device_pm_not_required(struct device *dev) 1195 { 1196 return dev->power.no_pm; 1197 } 1198 1199 static inline void device_set_pm_not_required(struct device *dev) 1200 { 1201 dev->power.no_pm = true; 1202 } 1203 1204 static inline void dev_pm_syscore_device(struct device *dev, bool val) 1205 { 1206 #ifdef CONFIG_PM_SLEEP 1207 dev->power.syscore = val; 1208 #endif 1209 } 1210 1211 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) 1212 { 1213 dev->power.driver_flags = flags; 1214 } 1215 1216 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) 1217 { 1218 return !!(dev->power.driver_flags & flags); 1219 } 1220 1221 static inline void device_lock(struct device *dev) 1222 { 1223 mutex_lock(&dev->mutex); 1224 } 1225 1226 static inline int device_lock_interruptible(struct device *dev) 1227 { 1228 return mutex_lock_interruptible(&dev->mutex); 1229 } 1230 1231 static inline int device_trylock(struct device *dev) 1232 { 1233 return mutex_trylock(&dev->mutex); 1234 } 1235 1236 static inline void device_unlock(struct device *dev) 1237 { 1238 mutex_unlock(&dev->mutex); 1239 } 1240 1241 static inline void device_lock_assert(struct device *dev) 1242 { 1243 lockdep_assert_held(&dev->mutex); 1244 } 1245 1246 static inline struct device_node *dev_of_node(struct device *dev) 1247 { 1248 if (!IS_ENABLED(CONFIG_OF) || !dev) 1249 return NULL; 1250 return dev->of_node; 1251 } 1252 1253 void driver_init(void); 1254 1255 /* 1256 * High level routines for use by the bus drivers 1257 */ 1258 extern int __must_check device_register(struct device *dev); 1259 extern void device_unregister(struct device *dev); 1260 extern void device_initialize(struct device *dev); 1261 extern int __must_check device_add(struct device *dev); 1262 extern void device_del(struct device *dev); 1263 extern int device_for_each_child(struct device *dev, void *data, 1264 int (*fn)(struct device *dev, void *data)); 1265 extern int device_for_each_child_reverse(struct device *dev, void *data, 1266 int (*fn)(struct device *dev, void *data)); 1267 extern struct device *device_find_child(struct device *dev, void *data, 1268 int (*match)(struct device *dev, void *data)); 1269 extern struct device *device_find_child_by_name(struct device *parent, 1270 const char *name); 1271 extern int device_rename(struct device *dev, const char *new_name); 1272 extern int device_move(struct device *dev, struct device *new_parent, 1273 enum dpm_order dpm_order); 1274 extern const char *device_get_devnode(struct device *dev, 1275 umode_t *mode, kuid_t *uid, kgid_t *gid, 1276 const char **tmp); 1277 1278 static inline bool device_supports_offline(struct device *dev) 1279 { 1280 return dev->bus && dev->bus->offline && dev->bus->online; 1281 } 1282 1283 extern void lock_device_hotplug(void); 1284 extern void unlock_device_hotplug(void); 1285 extern int lock_device_hotplug_sysfs(void); 1286 extern int device_offline(struct device *dev); 1287 extern int device_online(struct device *dev); 1288 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 1289 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 1290 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); 1291 1292 static inline int dev_num_vf(struct device *dev) 1293 { 1294 if (dev->bus && dev->bus->num_vf) 1295 return dev->bus->num_vf(dev); 1296 return 0; 1297 } 1298 1299 /* 1300 * Root device objects for grouping under /sys/devices 1301 */ 1302 extern struct device *__root_device_register(const char *name, 1303 struct module *owner); 1304 1305 /* This is a macro to avoid include problems with THIS_MODULE */ 1306 #define root_device_register(name) \ 1307 __root_device_register(name, THIS_MODULE) 1308 1309 extern void root_device_unregister(struct device *root); 1310 1311 static inline void *dev_get_platdata(const struct device *dev) 1312 { 1313 return dev->platform_data; 1314 } 1315 1316 /* 1317 * Manual binding of a device to driver. See drivers/base/bus.c 1318 * for information on use. 1319 */ 1320 extern int __must_check device_bind_driver(struct device *dev); 1321 extern void device_release_driver(struct device *dev); 1322 extern int __must_check device_attach(struct device *dev); 1323 extern int __must_check driver_attach(struct device_driver *drv); 1324 extern void device_initial_probe(struct device *dev); 1325 extern int __must_check device_reprobe(struct device *dev); 1326 1327 extern bool device_is_bound(struct device *dev); 1328 1329 /* 1330 * Easy functions for dynamically creating devices on the fly 1331 */ 1332 extern __printf(5, 0) 1333 struct device *device_create_vargs(struct class *cls, struct device *parent, 1334 dev_t devt, void *drvdata, 1335 const char *fmt, va_list vargs); 1336 extern __printf(5, 6) 1337 struct device *device_create(struct class *cls, struct device *parent, 1338 dev_t devt, void *drvdata, 1339 const char *fmt, ...); 1340 extern __printf(6, 7) 1341 struct device *device_create_with_groups(struct class *cls, 1342 struct device *parent, dev_t devt, void *drvdata, 1343 const struct attribute_group **groups, 1344 const char *fmt, ...); 1345 extern void device_destroy(struct class *cls, dev_t devt); 1346 1347 extern int __must_check device_add_groups(struct device *dev, 1348 const struct attribute_group **groups); 1349 extern void device_remove_groups(struct device *dev, 1350 const struct attribute_group **groups); 1351 1352 static inline int __must_check device_add_group(struct device *dev, 1353 const struct attribute_group *grp) 1354 { 1355 const struct attribute_group *groups[] = { grp, NULL }; 1356 1357 return device_add_groups(dev, groups); 1358 } 1359 1360 static inline void device_remove_group(struct device *dev, 1361 const struct attribute_group *grp) 1362 { 1363 const struct attribute_group *groups[] = { grp, NULL }; 1364 1365 return device_remove_groups(dev, groups); 1366 } 1367 1368 extern int __must_check devm_device_add_groups(struct device *dev, 1369 const struct attribute_group **groups); 1370 extern void devm_device_remove_groups(struct device *dev, 1371 const struct attribute_group **groups); 1372 extern int __must_check devm_device_add_group(struct device *dev, 1373 const struct attribute_group *grp); 1374 extern void devm_device_remove_group(struct device *dev, 1375 const struct attribute_group *grp); 1376 1377 /* 1378 * Platform "fixup" functions - allow the platform to have their say 1379 * about devices and actions that the general device layer doesn't 1380 * know about. 1381 */ 1382 /* Notify platform of device discovery */ 1383 extern int (*platform_notify)(struct device *dev); 1384 1385 extern int (*platform_notify_remove)(struct device *dev); 1386 1387 1388 /* 1389 * get_device - atomically increment the reference count for the device. 1390 * 1391 */ 1392 extern struct device *get_device(struct device *dev); 1393 extern void put_device(struct device *dev); 1394 extern bool kill_device(struct device *dev); 1395 1396 #ifdef CONFIG_DEVTMPFS 1397 extern int devtmpfs_create_node(struct device *dev); 1398 extern int devtmpfs_delete_node(struct device *dev); 1399 extern int devtmpfs_mount(const char *mntdir); 1400 #else 1401 static inline int devtmpfs_create_node(struct device *dev) { return 0; } 1402 static inline int devtmpfs_delete_node(struct device *dev) { return 0; } 1403 static inline int devtmpfs_mount(const char *mountpoint) { return 0; } 1404 #endif 1405 1406 /* drivers/base/power/shutdown.c */ 1407 extern void device_shutdown(void); 1408 1409 /* debugging and troubleshooting/diagnostic helpers. */ 1410 extern const char *dev_driver_string(const struct device *dev); 1411 1412 /* Device links interface. */ 1413 struct device_link *device_link_add(struct device *consumer, 1414 struct device *supplier, u32 flags); 1415 void device_link_del(struct device_link *link); 1416 void device_link_remove(void *consumer, struct device *supplier); 1417 1418 #ifndef dev_fmt 1419 #define dev_fmt(fmt) fmt 1420 #endif 1421 1422 #ifdef CONFIG_PRINTK 1423 1424 __printf(3, 0) __cold 1425 int dev_vprintk_emit(int level, const struct device *dev, 1426 const char *fmt, va_list args); 1427 __printf(3, 4) __cold 1428 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...); 1429 1430 __printf(3, 4) __cold 1431 void dev_printk(const char *level, const struct device *dev, 1432 const char *fmt, ...); 1433 __printf(2, 3) __cold 1434 void _dev_emerg(const struct device *dev, const char *fmt, ...); 1435 __printf(2, 3) __cold 1436 void _dev_alert(const struct device *dev, const char *fmt, ...); 1437 __printf(2, 3) __cold 1438 void _dev_crit(const struct device *dev, const char *fmt, ...); 1439 __printf(2, 3) __cold 1440 void _dev_err(const struct device *dev, const char *fmt, ...); 1441 __printf(2, 3) __cold 1442 void _dev_warn(const struct device *dev, const char *fmt, ...); 1443 __printf(2, 3) __cold 1444 void _dev_notice(const struct device *dev, const char *fmt, ...); 1445 __printf(2, 3) __cold 1446 void _dev_info(const struct device *dev, const char *fmt, ...); 1447 1448 #else 1449 1450 static inline __printf(3, 0) 1451 int dev_vprintk_emit(int level, const struct device *dev, 1452 const char *fmt, va_list args) 1453 { return 0; } 1454 static inline __printf(3, 4) 1455 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...) 1456 { return 0; } 1457 1458 static inline void __dev_printk(const char *level, const struct device *dev, 1459 struct va_format *vaf) 1460 {} 1461 static inline __printf(3, 4) 1462 void dev_printk(const char *level, const struct device *dev, 1463 const char *fmt, ...) 1464 {} 1465 1466 static inline __printf(2, 3) 1467 void _dev_emerg(const struct device *dev, const char *fmt, ...) 1468 {} 1469 static inline __printf(2, 3) 1470 void _dev_crit(const struct device *dev, const char *fmt, ...) 1471 {} 1472 static inline __printf(2, 3) 1473 void _dev_alert(const struct device *dev, const char *fmt, ...) 1474 {} 1475 static inline __printf(2, 3) 1476 void _dev_err(const struct device *dev, const char *fmt, ...) 1477 {} 1478 static inline __printf(2, 3) 1479 void _dev_warn(const struct device *dev, const char *fmt, ...) 1480 {} 1481 static inline __printf(2, 3) 1482 void _dev_notice(const struct device *dev, const char *fmt, ...) 1483 {} 1484 static inline __printf(2, 3) 1485 void _dev_info(const struct device *dev, const char *fmt, ...) 1486 {} 1487 1488 #endif 1489 1490 /* 1491 * #defines for all the dev_<level> macros to prefix with whatever 1492 * possible use of #define dev_fmt(fmt) ... 1493 */ 1494 1495 #define dev_emerg(dev, fmt, ...) \ 1496 _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__) 1497 #define dev_crit(dev, fmt, ...) \ 1498 _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__) 1499 #define dev_alert(dev, fmt, ...) \ 1500 _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__) 1501 #define dev_err(dev, fmt, ...) \ 1502 _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__) 1503 #define dev_warn(dev, fmt, ...) \ 1504 _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__) 1505 #define dev_notice(dev, fmt, ...) \ 1506 _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__) 1507 #define dev_info(dev, fmt, ...) \ 1508 _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__) 1509 1510 #if defined(CONFIG_DYNAMIC_DEBUG) 1511 #define dev_dbg(dev, fmt, ...) \ 1512 dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__) 1513 #elif defined(DEBUG) 1514 #define dev_dbg(dev, fmt, ...) \ 1515 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__) 1516 #else 1517 #define dev_dbg(dev, fmt, ...) \ 1518 ({ \ 1519 if (0) \ 1520 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ 1521 }) 1522 #endif 1523 1524 #ifdef CONFIG_PRINTK 1525 #define dev_level_once(dev_level, dev, fmt, ...) \ 1526 do { \ 1527 static bool __print_once __read_mostly; \ 1528 \ 1529 if (!__print_once) { \ 1530 __print_once = true; \ 1531 dev_level(dev, fmt, ##__VA_ARGS__); \ 1532 } \ 1533 } while (0) 1534 #else 1535 #define dev_level_once(dev_level, dev, fmt, ...) \ 1536 do { \ 1537 if (0) \ 1538 dev_level(dev, fmt, ##__VA_ARGS__); \ 1539 } while (0) 1540 #endif 1541 1542 #define dev_emerg_once(dev, fmt, ...) \ 1543 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__) 1544 #define dev_alert_once(dev, fmt, ...) \ 1545 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__) 1546 #define dev_crit_once(dev, fmt, ...) \ 1547 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__) 1548 #define dev_err_once(dev, fmt, ...) \ 1549 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__) 1550 #define dev_warn_once(dev, fmt, ...) \ 1551 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__) 1552 #define dev_notice_once(dev, fmt, ...) \ 1553 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__) 1554 #define dev_info_once(dev, fmt, ...) \ 1555 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__) 1556 #define dev_dbg_once(dev, fmt, ...) \ 1557 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__) 1558 1559 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \ 1560 do { \ 1561 static DEFINE_RATELIMIT_STATE(_rs, \ 1562 DEFAULT_RATELIMIT_INTERVAL, \ 1563 DEFAULT_RATELIMIT_BURST); \ 1564 if (__ratelimit(&_rs)) \ 1565 dev_level(dev, fmt, ##__VA_ARGS__); \ 1566 } while (0) 1567 1568 #define dev_emerg_ratelimited(dev, fmt, ...) \ 1569 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__) 1570 #define dev_alert_ratelimited(dev, fmt, ...) \ 1571 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__) 1572 #define dev_crit_ratelimited(dev, fmt, ...) \ 1573 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__) 1574 #define dev_err_ratelimited(dev, fmt, ...) \ 1575 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__) 1576 #define dev_warn_ratelimited(dev, fmt, ...) \ 1577 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__) 1578 #define dev_notice_ratelimited(dev, fmt, ...) \ 1579 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__) 1580 #define dev_info_ratelimited(dev, fmt, ...) \ 1581 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__) 1582 #if defined(CONFIG_DYNAMIC_DEBUG) 1583 /* descriptor check is first to prevent flooding with "callbacks suppressed" */ 1584 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1585 do { \ 1586 static DEFINE_RATELIMIT_STATE(_rs, \ 1587 DEFAULT_RATELIMIT_INTERVAL, \ 1588 DEFAULT_RATELIMIT_BURST); \ 1589 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ 1590 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \ 1591 __ratelimit(&_rs)) \ 1592 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt), \ 1593 ##__VA_ARGS__); \ 1594 } while (0) 1595 #elif defined(DEBUG) 1596 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1597 do { \ 1598 static DEFINE_RATELIMIT_STATE(_rs, \ 1599 DEFAULT_RATELIMIT_INTERVAL, \ 1600 DEFAULT_RATELIMIT_BURST); \ 1601 if (__ratelimit(&_rs)) \ 1602 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ 1603 } while (0) 1604 #else 1605 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1606 do { \ 1607 if (0) \ 1608 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ 1609 } while (0) 1610 #endif 1611 1612 #ifdef VERBOSE_DEBUG 1613 #define dev_vdbg dev_dbg 1614 #else 1615 #define dev_vdbg(dev, fmt, ...) \ 1616 ({ \ 1617 if (0) \ 1618 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ 1619 }) 1620 #endif 1621 1622 /* 1623 * dev_WARN*() acts like dev_printk(), but with the key difference of 1624 * using WARN/WARN_ONCE to include file/line information and a backtrace. 1625 */ 1626 #define dev_WARN(dev, format, arg...) \ 1627 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg); 1628 1629 #define dev_WARN_ONCE(dev, condition, format, arg...) \ 1630 WARN_ONCE(condition, "%s %s: " format, \ 1631 dev_driver_string(dev), dev_name(dev), ## arg) 1632 1633 /* Create alias, so I can be autoloaded. */ 1634 #define MODULE_ALIAS_CHARDEV(major,minor) \ 1635 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) 1636 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ 1637 MODULE_ALIAS("char-major-" __stringify(major) "-*") 1638 1639 #ifdef CONFIG_SYSFS_DEPRECATED 1640 extern long sysfs_deprecated; 1641 #else 1642 #define sysfs_deprecated 0 1643 #endif 1644 1645 /** 1646 * module_driver() - Helper macro for drivers that don't do anything 1647 * special in module init/exit. This eliminates a lot of boilerplate. 1648 * Each module may only use this macro once, and calling it replaces 1649 * module_init() and module_exit(). 1650 * 1651 * @__driver: driver name 1652 * @__register: register function for this driver type 1653 * @__unregister: unregister function for this driver type 1654 * @...: Additional arguments to be passed to __register and __unregister. 1655 * 1656 * Use this macro to construct bus specific macros for registering 1657 * drivers, and do not use it on its own. 1658 */ 1659 #define module_driver(__driver, __register, __unregister, ...) \ 1660 static int __init __driver##_init(void) \ 1661 { \ 1662 return __register(&(__driver) , ##__VA_ARGS__); \ 1663 } \ 1664 module_init(__driver##_init); \ 1665 static void __exit __driver##_exit(void) \ 1666 { \ 1667 __unregister(&(__driver) , ##__VA_ARGS__); \ 1668 } \ 1669 module_exit(__driver##_exit); 1670 1671 /** 1672 * builtin_driver() - Helper macro for drivers that don't do anything 1673 * special in init and have no exit. This eliminates some boilerplate. 1674 * Each driver may only use this macro once, and calling it replaces 1675 * device_initcall (or in some cases, the legacy __initcall). This is 1676 * meant to be a direct parallel of module_driver() above but without 1677 * the __exit stuff that is not used for builtin cases. 1678 * 1679 * @__driver: driver name 1680 * @__register: register function for this driver type 1681 * @...: Additional arguments to be passed to __register 1682 * 1683 * Use this macro to construct bus specific macros for registering 1684 * drivers, and do not use it on its own. 1685 */ 1686 #define builtin_driver(__driver, __register, ...) \ 1687 static int __init __driver##_init(void) \ 1688 { \ 1689 return __register(&(__driver) , ##__VA_ARGS__); \ 1690 } \ 1691 device_initcall(__driver##_init); 1692 1693 #endif /* _DEVICE_H_ */ 1694