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