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