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/pinctrl/devinfo.h> 24 #include <linux/pm.h> 25 #include <linux/atomic.h> 26 #include <linux/ratelimit.h> 27 #include <linux/uidgid.h> 28 #include <linux/gfp.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 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_RW(_name) \ 578 struct device_attribute dev_attr_##_name = __ATTR_RW(_name) 579 #define DEVICE_ATTR_RO(_name) \ 580 struct device_attribute dev_attr_##_name = __ATTR_RO(_name) 581 #define DEVICE_ATTR_WO(_name) \ 582 struct device_attribute dev_attr_##_name = __ATTR_WO(_name) 583 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \ 584 struct dev_ext_attribute dev_attr_##_name = \ 585 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) } 586 #define DEVICE_INT_ATTR(_name, _mode, _var) \ 587 struct dev_ext_attribute dev_attr_##_name = \ 588 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) } 589 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \ 590 struct dev_ext_attribute dev_attr_##_name = \ 591 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) } 592 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ 593 struct device_attribute dev_attr_##_name = \ 594 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) 595 596 extern int device_create_file(struct device *device, 597 const struct device_attribute *entry); 598 extern void device_remove_file(struct device *dev, 599 const struct device_attribute *attr); 600 extern bool device_remove_file_self(struct device *dev, 601 const struct device_attribute *attr); 602 extern int __must_check device_create_bin_file(struct device *dev, 603 const struct bin_attribute *attr); 604 extern void device_remove_bin_file(struct device *dev, 605 const struct bin_attribute *attr); 606 607 /* device resource management */ 608 typedef void (*dr_release_t)(struct device *dev, void *res); 609 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); 610 611 #ifdef CONFIG_DEBUG_DEVRES 612 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, 613 int nid, const char *name) __malloc; 614 #define devres_alloc(release, size, gfp) \ 615 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release) 616 #define devres_alloc_node(release, size, gfp, nid) \ 617 __devres_alloc_node(release, size, gfp, nid, #release) 618 #else 619 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, 620 int nid) __malloc; 621 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp) 622 { 623 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE); 624 } 625 #endif 626 627 extern void devres_for_each_res(struct device *dev, dr_release_t release, 628 dr_match_t match, void *match_data, 629 void (*fn)(struct device *, void *, void *), 630 void *data); 631 extern void devres_free(void *res); 632 extern void devres_add(struct device *dev, void *res); 633 extern void *devres_find(struct device *dev, dr_release_t release, 634 dr_match_t match, void *match_data); 635 extern void *devres_get(struct device *dev, void *new_res, 636 dr_match_t match, void *match_data); 637 extern void *devres_remove(struct device *dev, dr_release_t release, 638 dr_match_t match, void *match_data); 639 extern int devres_destroy(struct device *dev, dr_release_t release, 640 dr_match_t match, void *match_data); 641 extern int devres_release(struct device *dev, dr_release_t release, 642 dr_match_t match, void *match_data); 643 644 /* devres group */ 645 extern void * __must_check devres_open_group(struct device *dev, void *id, 646 gfp_t gfp); 647 extern void devres_close_group(struct device *dev, void *id); 648 extern void devres_remove_group(struct device *dev, void *id); 649 extern int devres_release_group(struct device *dev, void *id); 650 651 /* managed devm_k.alloc/kfree for device drivers */ 652 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc; 653 extern __printf(3, 0) 654 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt, 655 va_list ap) __malloc; 656 extern __printf(3, 4) 657 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc; 658 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp) 659 { 660 return devm_kmalloc(dev, size, gfp | __GFP_ZERO); 661 } 662 static inline void *devm_kmalloc_array(struct device *dev, 663 size_t n, size_t size, gfp_t flags) 664 { 665 if (size != 0 && n > SIZE_MAX / size) 666 return NULL; 667 return devm_kmalloc(dev, n * size, flags); 668 } 669 static inline void *devm_kcalloc(struct device *dev, 670 size_t n, size_t size, gfp_t flags) 671 { 672 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO); 673 } 674 extern void devm_kfree(struct device *dev, void *p); 675 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc; 676 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len, 677 gfp_t gfp); 678 679 extern unsigned long devm_get_free_pages(struct device *dev, 680 gfp_t gfp_mask, unsigned int order); 681 extern void devm_free_pages(struct device *dev, unsigned long addr); 682 683 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res); 684 685 /* allows to add/remove a custom action to devres stack */ 686 int devm_add_action(struct device *dev, void (*action)(void *), void *data); 687 void devm_remove_action(struct device *dev, void (*action)(void *), void *data); 688 689 static inline int devm_add_action_or_reset(struct device *dev, 690 void (*action)(void *), void *data) 691 { 692 int ret; 693 694 ret = devm_add_action(dev, action, data); 695 if (ret) 696 action(data); 697 698 return ret; 699 } 700 701 /** 702 * devm_alloc_percpu - Resource-managed alloc_percpu 703 * @dev: Device to allocate per-cpu memory for 704 * @type: Type to allocate per-cpu memory for 705 * 706 * Managed alloc_percpu. Per-cpu memory allocated with this function is 707 * automatically freed on driver detach. 708 * 709 * RETURNS: 710 * Pointer to allocated memory on success, NULL on failure. 711 */ 712 #define devm_alloc_percpu(dev, type) \ 713 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \ 714 __alignof__(type))) 715 716 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size, 717 size_t align); 718 void devm_free_percpu(struct device *dev, void __percpu *pdata); 719 720 struct device_dma_parameters { 721 /* 722 * a low level driver may set these to teach IOMMU code about 723 * sg limitations. 724 */ 725 unsigned int max_segment_size; 726 unsigned long segment_boundary_mask; 727 }; 728 729 /** 730 * enum device_link_state - Device link states. 731 * @DL_STATE_NONE: The presence of the drivers is not being tracked. 732 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. 733 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. 734 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). 735 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. 736 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. 737 */ 738 enum device_link_state { 739 DL_STATE_NONE = -1, 740 DL_STATE_DORMANT = 0, 741 DL_STATE_AVAILABLE, 742 DL_STATE_CONSUMER_PROBE, 743 DL_STATE_ACTIVE, 744 DL_STATE_SUPPLIER_UNBIND, 745 }; 746 747 /* 748 * Device link flags. 749 * 750 * STATELESS: The core won't track the presence of supplier/consumer drivers. 751 * AUTOREMOVE: Remove this link automatically on consumer driver unbind. 752 * PM_RUNTIME: If set, the runtime PM framework will use this link. 753 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. 754 */ 755 #define DL_FLAG_STATELESS BIT(0) 756 #define DL_FLAG_AUTOREMOVE BIT(1) 757 #define DL_FLAG_PM_RUNTIME BIT(2) 758 #define DL_FLAG_RPM_ACTIVE BIT(3) 759 760 /** 761 * struct device_link - Device link representation. 762 * @supplier: The device on the supplier end of the link. 763 * @s_node: Hook to the supplier device's list of links to consumers. 764 * @consumer: The device on the consumer end of the link. 765 * @c_node: Hook to the consumer device's list of links to suppliers. 766 * @status: The state of the link (with respect to the presence of drivers). 767 * @flags: Link flags. 768 * @rpm_active: Whether or not the consumer device is runtime-PM-active. 769 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks. 770 */ 771 struct device_link { 772 struct device *supplier; 773 struct list_head s_node; 774 struct device *consumer; 775 struct list_head c_node; 776 enum device_link_state status; 777 u32 flags; 778 bool rpm_active; 779 #ifdef CONFIG_SRCU 780 struct rcu_head rcu_head; 781 #endif 782 }; 783 784 /** 785 * enum dl_dev_state - Device driver presence tracking information. 786 * @DL_DEV_NO_DRIVER: There is no driver attached to the device. 787 * @DL_DEV_PROBING: A driver is probing. 788 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. 789 * @DL_DEV_UNBINDING: The driver is unbinding from the device. 790 */ 791 enum dl_dev_state { 792 DL_DEV_NO_DRIVER = 0, 793 DL_DEV_PROBING, 794 DL_DEV_DRIVER_BOUND, 795 DL_DEV_UNBINDING, 796 }; 797 798 /** 799 * struct dev_links_info - Device data related to device links. 800 * @suppliers: List of links to supplier devices. 801 * @consumers: List of links to consumer devices. 802 * @status: Driver status information. 803 */ 804 struct dev_links_info { 805 struct list_head suppliers; 806 struct list_head consumers; 807 enum dl_dev_state status; 808 }; 809 810 /** 811 * struct device - The basic device structure 812 * @parent: The device's "parent" device, the device to which it is attached. 813 * In most cases, a parent device is some sort of bus or host 814 * controller. If parent is NULL, the device, is a top-level device, 815 * which is not usually what you want. 816 * @p: Holds the private data of the driver core portions of the device. 817 * See the comment of the struct device_private for detail. 818 * @kobj: A top-level, abstract class from which other classes are derived. 819 * @init_name: Initial name of the device. 820 * @type: The type of device. 821 * This identifies the device type and carries type-specific 822 * information. 823 * @mutex: Mutex to synchronize calls to its driver. 824 * @bus: Type of bus device is on. 825 * @driver: Which driver has allocated this 826 * @platform_data: Platform data specific to the device. 827 * Example: For devices on custom boards, as typical of embedded 828 * and SOC based hardware, Linux often uses platform_data to point 829 * to board-specific structures describing devices and how they 830 * are wired. That can include what ports are available, chip 831 * variants, which GPIO pins act in what additional roles, and so 832 * on. This shrinks the "Board Support Packages" (BSPs) and 833 * minimizes board-specific #ifdefs in drivers. 834 * @driver_data: Private pointer for driver specific info. 835 * @links: Links to suppliers and consumers of this device. 836 * @power: For device power management. 837 * See Documentation/driver-api/pm/devices.rst for details. 838 * @pm_domain: Provide callbacks that are executed during system suspend, 839 * hibernation, system resume and during runtime PM transitions 840 * along with subsystem-level and driver-level callbacks. 841 * @pins: For device pin management. 842 * See Documentation/driver-api/pinctl.rst for details. 843 * @msi_list: Hosts MSI descriptors 844 * @msi_domain: The generic MSI domain this device is using. 845 * @numa_node: NUMA node this device is close to. 846 * @dma_ops: DMA mapping operations for this device. 847 * @dma_mask: Dma mask (if dma'ble device). 848 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all 849 * hardware supports 64-bit addresses for consistent allocations 850 * such descriptors. 851 * @dma_pfn_offset: offset of DMA memory range relatively of RAM 852 * @dma_parms: A low level driver may set these to teach IOMMU code about 853 * segment limitations. 854 * @dma_pools: Dma pools (if dma'ble device). 855 * @dma_mem: Internal for coherent mem override. 856 * @cma_area: Contiguous memory area for dma allocations 857 * @archdata: For arch-specific additions. 858 * @of_node: Associated device tree node. 859 * @fwnode: Associated device node supplied by platform firmware. 860 * @devt: For creating the sysfs "dev". 861 * @id: device instance 862 * @devres_lock: Spinlock to protect the resource of the device. 863 * @devres_head: The resources list of the device. 864 * @knode_class: The node used to add the device to the class list. 865 * @class: The class of the device. 866 * @groups: Optional attribute groups. 867 * @release: Callback to free the device after all references have 868 * gone away. This should be set by the allocator of the 869 * device (i.e. the bus driver that discovered the device). 870 * @iommu_group: IOMMU group the device belongs to. 871 * @iommu_fwspec: IOMMU-specific properties supplied by firmware. 872 * 873 * @offline_disabled: If set, the device is permanently online. 874 * @offline: Set after successful invocation of bus type's .offline(). 875 * @of_node_reused: Set if the device-tree node is shared with an ancestor 876 * device. 877 * 878 * At the lowest level, every device in a Linux system is represented by an 879 * instance of struct device. The device structure contains the information 880 * that the device model core needs to model the system. Most subsystems, 881 * however, track additional information about the devices they host. As a 882 * result, it is rare for devices to be represented by bare device structures; 883 * instead, that structure, like kobject structures, is usually embedded within 884 * a higher-level representation of the device. 885 */ 886 struct device { 887 struct device *parent; 888 889 struct device_private *p; 890 891 struct kobject kobj; 892 const char *init_name; /* initial name of the device */ 893 const struct device_type *type; 894 895 struct mutex mutex; /* mutex to synchronize calls to 896 * its driver. 897 */ 898 899 struct bus_type *bus; /* type of bus device is on */ 900 struct device_driver *driver; /* which driver has allocated this 901 device */ 902 void *platform_data; /* Platform specific data, device 903 core doesn't touch it */ 904 void *driver_data; /* Driver data, set and get with 905 dev_set/get_drvdata */ 906 struct dev_links_info links; 907 struct dev_pm_info power; 908 struct dev_pm_domain *pm_domain; 909 910 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 911 struct irq_domain *msi_domain; 912 #endif 913 #ifdef CONFIG_PINCTRL 914 struct dev_pin_info *pins; 915 #endif 916 #ifdef CONFIG_GENERIC_MSI_IRQ 917 struct list_head msi_list; 918 #endif 919 920 #ifdef CONFIG_NUMA 921 int numa_node; /* NUMA node this device is close to */ 922 #endif 923 const struct dma_map_ops *dma_ops; 924 u64 *dma_mask; /* dma mask (if dma'able device) */ 925 u64 coherent_dma_mask;/* Like dma_mask, but for 926 alloc_coherent mappings as 927 not all hardware supports 928 64 bit addresses for consistent 929 allocations such descriptors. */ 930 unsigned long dma_pfn_offset; 931 932 struct device_dma_parameters *dma_parms; 933 934 struct list_head dma_pools; /* dma pools (if dma'ble) */ 935 936 struct dma_coherent_mem *dma_mem; /* internal for coherent mem 937 override */ 938 #ifdef CONFIG_DMA_CMA 939 struct cma *cma_area; /* contiguous memory area for dma 940 allocations */ 941 #endif 942 /* arch specific additions */ 943 struct dev_archdata archdata; 944 945 struct device_node *of_node; /* associated device tree node */ 946 struct fwnode_handle *fwnode; /* firmware device node */ 947 948 dev_t devt; /* dev_t, creates the sysfs "dev" */ 949 u32 id; /* device instance */ 950 951 spinlock_t devres_lock; 952 struct list_head devres_head; 953 954 struct klist_node knode_class; 955 struct class *class; 956 const struct attribute_group **groups; /* optional groups */ 957 958 void (*release)(struct device *dev); 959 struct iommu_group *iommu_group; 960 struct iommu_fwspec *iommu_fwspec; 961 962 bool offline_disabled:1; 963 bool offline:1; 964 bool of_node_reused:1; 965 }; 966 967 static inline struct device *kobj_to_dev(struct kobject *kobj) 968 { 969 return container_of(kobj, struct device, kobj); 970 } 971 972 /* Get the wakeup routines, which depend on struct device */ 973 #include <linux/pm_wakeup.h> 974 975 static inline const char *dev_name(const struct device *dev) 976 { 977 /* Use the init name until the kobject becomes available */ 978 if (dev->init_name) 979 return dev->init_name; 980 981 return kobject_name(&dev->kobj); 982 } 983 984 extern __printf(2, 3) 985 int dev_set_name(struct device *dev, const char *name, ...); 986 987 #ifdef CONFIG_NUMA 988 static inline int dev_to_node(struct device *dev) 989 { 990 return dev->numa_node; 991 } 992 static inline void set_dev_node(struct device *dev, int node) 993 { 994 dev->numa_node = node; 995 } 996 #else 997 static inline int dev_to_node(struct device *dev) 998 { 999 return -1; 1000 } 1001 static inline void set_dev_node(struct device *dev, int node) 1002 { 1003 } 1004 #endif 1005 1006 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) 1007 { 1008 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 1009 return dev->msi_domain; 1010 #else 1011 return NULL; 1012 #endif 1013 } 1014 1015 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) 1016 { 1017 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN 1018 dev->msi_domain = d; 1019 #endif 1020 } 1021 1022 static inline void *dev_get_drvdata(const struct device *dev) 1023 { 1024 return dev->driver_data; 1025 } 1026 1027 static inline void dev_set_drvdata(struct device *dev, void *data) 1028 { 1029 dev->driver_data = data; 1030 } 1031 1032 static inline struct pm_subsys_data *dev_to_psd(struct device *dev) 1033 { 1034 return dev ? dev->power.subsys_data : NULL; 1035 } 1036 1037 static inline unsigned int dev_get_uevent_suppress(const struct device *dev) 1038 { 1039 return dev->kobj.uevent_suppress; 1040 } 1041 1042 static inline void dev_set_uevent_suppress(struct device *dev, int val) 1043 { 1044 dev->kobj.uevent_suppress = val; 1045 } 1046 1047 static inline int device_is_registered(struct device *dev) 1048 { 1049 return dev->kobj.state_in_sysfs; 1050 } 1051 1052 static inline void device_enable_async_suspend(struct device *dev) 1053 { 1054 if (!dev->power.is_prepared) 1055 dev->power.async_suspend = true; 1056 } 1057 1058 static inline void device_disable_async_suspend(struct device *dev) 1059 { 1060 if (!dev->power.is_prepared) 1061 dev->power.async_suspend = false; 1062 } 1063 1064 static inline bool device_async_suspend_enabled(struct device *dev) 1065 { 1066 return !!dev->power.async_suspend; 1067 } 1068 1069 static inline void dev_pm_syscore_device(struct device *dev, bool val) 1070 { 1071 #ifdef CONFIG_PM_SLEEP 1072 dev->power.syscore = val; 1073 #endif 1074 } 1075 1076 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) 1077 { 1078 dev->power.driver_flags = flags; 1079 } 1080 1081 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) 1082 { 1083 return !!(dev->power.driver_flags & flags); 1084 } 1085 1086 static inline void device_lock(struct device *dev) 1087 { 1088 mutex_lock(&dev->mutex); 1089 } 1090 1091 static inline int device_lock_interruptible(struct device *dev) 1092 { 1093 return mutex_lock_interruptible(&dev->mutex); 1094 } 1095 1096 static inline int device_trylock(struct device *dev) 1097 { 1098 return mutex_trylock(&dev->mutex); 1099 } 1100 1101 static inline void device_unlock(struct device *dev) 1102 { 1103 mutex_unlock(&dev->mutex); 1104 } 1105 1106 static inline void device_lock_assert(struct device *dev) 1107 { 1108 lockdep_assert_held(&dev->mutex); 1109 } 1110 1111 static inline struct device_node *dev_of_node(struct device *dev) 1112 { 1113 if (!IS_ENABLED(CONFIG_OF)) 1114 return NULL; 1115 return dev->of_node; 1116 } 1117 1118 void driver_init(void); 1119 1120 /* 1121 * High level routines for use by the bus drivers 1122 */ 1123 extern int __must_check device_register(struct device *dev); 1124 extern void device_unregister(struct device *dev); 1125 extern void device_initialize(struct device *dev); 1126 extern int __must_check device_add(struct device *dev); 1127 extern void device_del(struct device *dev); 1128 extern int device_for_each_child(struct device *dev, void *data, 1129 int (*fn)(struct device *dev, void *data)); 1130 extern int device_for_each_child_reverse(struct device *dev, void *data, 1131 int (*fn)(struct device *dev, void *data)); 1132 extern struct device *device_find_child(struct device *dev, void *data, 1133 int (*match)(struct device *dev, void *data)); 1134 extern int device_rename(struct device *dev, const char *new_name); 1135 extern int device_move(struct device *dev, struct device *new_parent, 1136 enum dpm_order dpm_order); 1137 extern const char *device_get_devnode(struct device *dev, 1138 umode_t *mode, kuid_t *uid, kgid_t *gid, 1139 const char **tmp); 1140 1141 static inline bool device_supports_offline(struct device *dev) 1142 { 1143 return dev->bus && dev->bus->offline && dev->bus->online; 1144 } 1145 1146 extern void lock_device_hotplug(void); 1147 extern void unlock_device_hotplug(void); 1148 extern int lock_device_hotplug_sysfs(void); 1149 extern int device_offline(struct device *dev); 1150 extern int device_online(struct device *dev); 1151 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 1152 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); 1153 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); 1154 1155 static inline int dev_num_vf(struct device *dev) 1156 { 1157 if (dev->bus && dev->bus->num_vf) 1158 return dev->bus->num_vf(dev); 1159 return 0; 1160 } 1161 1162 /* 1163 * Root device objects for grouping under /sys/devices 1164 */ 1165 extern struct device *__root_device_register(const char *name, 1166 struct module *owner); 1167 1168 /* This is a macro to avoid include problems with THIS_MODULE */ 1169 #define root_device_register(name) \ 1170 __root_device_register(name, THIS_MODULE) 1171 1172 extern void root_device_unregister(struct device *root); 1173 1174 static inline void *dev_get_platdata(const struct device *dev) 1175 { 1176 return dev->platform_data; 1177 } 1178 1179 /* 1180 * Manual binding of a device to driver. See drivers/base/bus.c 1181 * for information on use. 1182 */ 1183 extern int __must_check device_bind_driver(struct device *dev); 1184 extern void device_release_driver(struct device *dev); 1185 extern int __must_check device_attach(struct device *dev); 1186 extern int __must_check driver_attach(struct device_driver *drv); 1187 extern void device_initial_probe(struct device *dev); 1188 extern int __must_check device_reprobe(struct device *dev); 1189 1190 extern bool device_is_bound(struct device *dev); 1191 1192 /* 1193 * Easy functions for dynamically creating devices on the fly 1194 */ 1195 extern __printf(5, 0) 1196 struct device *device_create_vargs(struct class *cls, struct device *parent, 1197 dev_t devt, void *drvdata, 1198 const char *fmt, va_list vargs); 1199 extern __printf(5, 6) 1200 struct device *device_create(struct class *cls, struct device *parent, 1201 dev_t devt, void *drvdata, 1202 const char *fmt, ...); 1203 extern __printf(6, 7) 1204 struct device *device_create_with_groups(struct class *cls, 1205 struct device *parent, dev_t devt, void *drvdata, 1206 const struct attribute_group **groups, 1207 const char *fmt, ...); 1208 extern void device_destroy(struct class *cls, dev_t devt); 1209 1210 extern int __must_check device_add_groups(struct device *dev, 1211 const struct attribute_group **groups); 1212 extern void device_remove_groups(struct device *dev, 1213 const struct attribute_group **groups); 1214 1215 static inline int __must_check device_add_group(struct device *dev, 1216 const struct attribute_group *grp) 1217 { 1218 const struct attribute_group *groups[] = { grp, NULL }; 1219 1220 return device_add_groups(dev, groups); 1221 } 1222 1223 static inline void device_remove_group(struct device *dev, 1224 const struct attribute_group *grp) 1225 { 1226 const struct attribute_group *groups[] = { grp, NULL }; 1227 1228 return device_remove_groups(dev, groups); 1229 } 1230 1231 extern int __must_check devm_device_add_groups(struct device *dev, 1232 const struct attribute_group **groups); 1233 extern void devm_device_remove_groups(struct device *dev, 1234 const struct attribute_group **groups); 1235 extern int __must_check devm_device_add_group(struct device *dev, 1236 const struct attribute_group *grp); 1237 extern void devm_device_remove_group(struct device *dev, 1238 const struct attribute_group *grp); 1239 1240 /* 1241 * Platform "fixup" functions - allow the platform to have their say 1242 * about devices and actions that the general device layer doesn't 1243 * know about. 1244 */ 1245 /* Notify platform of device discovery */ 1246 extern int (*platform_notify)(struct device *dev); 1247 1248 extern int (*platform_notify_remove)(struct device *dev); 1249 1250 1251 /* 1252 * get_device - atomically increment the reference count for the device. 1253 * 1254 */ 1255 extern struct device *get_device(struct device *dev); 1256 extern void put_device(struct device *dev); 1257 1258 #ifdef CONFIG_DEVTMPFS 1259 extern int devtmpfs_create_node(struct device *dev); 1260 extern int devtmpfs_delete_node(struct device *dev); 1261 extern int devtmpfs_mount(const char *mntdir); 1262 #else 1263 static inline int devtmpfs_create_node(struct device *dev) { return 0; } 1264 static inline int devtmpfs_delete_node(struct device *dev) { return 0; } 1265 static inline int devtmpfs_mount(const char *mountpoint) { return 0; } 1266 #endif 1267 1268 /* drivers/base/power/shutdown.c */ 1269 extern void device_shutdown(void); 1270 1271 /* debugging and troubleshooting/diagnostic helpers. */ 1272 extern const char *dev_driver_string(const struct device *dev); 1273 1274 /* Device links interface. */ 1275 struct device_link *device_link_add(struct device *consumer, 1276 struct device *supplier, u32 flags); 1277 void device_link_del(struct device_link *link); 1278 1279 #ifdef CONFIG_PRINTK 1280 1281 extern __printf(3, 0) 1282 int dev_vprintk_emit(int level, const struct device *dev, 1283 const char *fmt, va_list args); 1284 extern __printf(3, 4) 1285 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...); 1286 1287 extern __printf(3, 4) 1288 void dev_printk(const char *level, const struct device *dev, 1289 const char *fmt, ...); 1290 extern __printf(2, 3) 1291 void dev_emerg(const struct device *dev, const char *fmt, ...); 1292 extern __printf(2, 3) 1293 void dev_alert(const struct device *dev, const char *fmt, ...); 1294 extern __printf(2, 3) 1295 void dev_crit(const struct device *dev, const char *fmt, ...); 1296 extern __printf(2, 3) 1297 void dev_err(const struct device *dev, const char *fmt, ...); 1298 extern __printf(2, 3) 1299 void dev_warn(const struct device *dev, const char *fmt, ...); 1300 extern __printf(2, 3) 1301 void dev_notice(const struct device *dev, const char *fmt, ...); 1302 extern __printf(2, 3) 1303 void _dev_info(const struct device *dev, const char *fmt, ...); 1304 1305 #else 1306 1307 static inline __printf(3, 0) 1308 int dev_vprintk_emit(int level, const struct device *dev, 1309 const char *fmt, va_list args) 1310 { return 0; } 1311 static inline __printf(3, 4) 1312 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...) 1313 { return 0; } 1314 1315 static inline void __dev_printk(const char *level, const struct device *dev, 1316 struct va_format *vaf) 1317 {} 1318 static inline __printf(3, 4) 1319 void dev_printk(const char *level, const struct device *dev, 1320 const char *fmt, ...) 1321 {} 1322 1323 static inline __printf(2, 3) 1324 void dev_emerg(const struct device *dev, const char *fmt, ...) 1325 {} 1326 static inline __printf(2, 3) 1327 void dev_crit(const struct device *dev, const char *fmt, ...) 1328 {} 1329 static inline __printf(2, 3) 1330 void dev_alert(const struct device *dev, const char *fmt, ...) 1331 {} 1332 static inline __printf(2, 3) 1333 void dev_err(const struct device *dev, const char *fmt, ...) 1334 {} 1335 static inline __printf(2, 3) 1336 void dev_warn(const struct device *dev, const char *fmt, ...) 1337 {} 1338 static inline __printf(2, 3) 1339 void dev_notice(const struct device *dev, const char *fmt, ...) 1340 {} 1341 static inline __printf(2, 3) 1342 void _dev_info(const struct device *dev, const char *fmt, ...) 1343 {} 1344 1345 #endif 1346 1347 /* 1348 * Stupid hackaround for existing uses of non-printk uses dev_info 1349 * 1350 * Note that the definition of dev_info below is actually _dev_info 1351 * and a macro is used to avoid redefining dev_info 1352 */ 1353 1354 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg) 1355 1356 #if defined(CONFIG_DYNAMIC_DEBUG) 1357 #define dev_dbg(dev, format, ...) \ 1358 do { \ 1359 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \ 1360 } while (0) 1361 #elif defined(DEBUG) 1362 #define dev_dbg(dev, format, arg...) \ 1363 dev_printk(KERN_DEBUG, dev, format, ##arg) 1364 #else 1365 #define dev_dbg(dev, format, arg...) \ 1366 ({ \ 1367 if (0) \ 1368 dev_printk(KERN_DEBUG, dev, format, ##arg); \ 1369 }) 1370 #endif 1371 1372 #ifdef CONFIG_PRINTK 1373 #define dev_level_once(dev_level, dev, fmt, ...) \ 1374 do { \ 1375 static bool __print_once __read_mostly; \ 1376 \ 1377 if (!__print_once) { \ 1378 __print_once = true; \ 1379 dev_level(dev, fmt, ##__VA_ARGS__); \ 1380 } \ 1381 } while (0) 1382 #else 1383 #define dev_level_once(dev_level, dev, fmt, ...) \ 1384 do { \ 1385 if (0) \ 1386 dev_level(dev, fmt, ##__VA_ARGS__); \ 1387 } while (0) 1388 #endif 1389 1390 #define dev_emerg_once(dev, fmt, ...) \ 1391 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__) 1392 #define dev_alert_once(dev, fmt, ...) \ 1393 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__) 1394 #define dev_crit_once(dev, fmt, ...) \ 1395 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__) 1396 #define dev_err_once(dev, fmt, ...) \ 1397 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__) 1398 #define dev_warn_once(dev, fmt, ...) \ 1399 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__) 1400 #define dev_notice_once(dev, fmt, ...) \ 1401 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__) 1402 #define dev_info_once(dev, fmt, ...) \ 1403 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__) 1404 #define dev_dbg_once(dev, fmt, ...) \ 1405 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__) 1406 1407 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \ 1408 do { \ 1409 static DEFINE_RATELIMIT_STATE(_rs, \ 1410 DEFAULT_RATELIMIT_INTERVAL, \ 1411 DEFAULT_RATELIMIT_BURST); \ 1412 if (__ratelimit(&_rs)) \ 1413 dev_level(dev, fmt, ##__VA_ARGS__); \ 1414 } while (0) 1415 1416 #define dev_emerg_ratelimited(dev, fmt, ...) \ 1417 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__) 1418 #define dev_alert_ratelimited(dev, fmt, ...) \ 1419 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__) 1420 #define dev_crit_ratelimited(dev, fmt, ...) \ 1421 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__) 1422 #define dev_err_ratelimited(dev, fmt, ...) \ 1423 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__) 1424 #define dev_warn_ratelimited(dev, fmt, ...) \ 1425 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__) 1426 #define dev_notice_ratelimited(dev, fmt, ...) \ 1427 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__) 1428 #define dev_info_ratelimited(dev, fmt, ...) \ 1429 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__) 1430 #if defined(CONFIG_DYNAMIC_DEBUG) 1431 /* descriptor check is first to prevent flooding with "callbacks suppressed" */ 1432 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1433 do { \ 1434 static DEFINE_RATELIMIT_STATE(_rs, \ 1435 DEFAULT_RATELIMIT_INTERVAL, \ 1436 DEFAULT_RATELIMIT_BURST); \ 1437 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ 1438 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \ 1439 __ratelimit(&_rs)) \ 1440 __dynamic_dev_dbg(&descriptor, dev, fmt, \ 1441 ##__VA_ARGS__); \ 1442 } while (0) 1443 #elif defined(DEBUG) 1444 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1445 do { \ 1446 static DEFINE_RATELIMIT_STATE(_rs, \ 1447 DEFAULT_RATELIMIT_INTERVAL, \ 1448 DEFAULT_RATELIMIT_BURST); \ 1449 if (__ratelimit(&_rs)) \ 1450 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \ 1451 } while (0) 1452 #else 1453 #define dev_dbg_ratelimited(dev, fmt, ...) \ 1454 do { \ 1455 if (0) \ 1456 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \ 1457 } while (0) 1458 #endif 1459 1460 #ifdef VERBOSE_DEBUG 1461 #define dev_vdbg dev_dbg 1462 #else 1463 #define dev_vdbg(dev, format, arg...) \ 1464 ({ \ 1465 if (0) \ 1466 dev_printk(KERN_DEBUG, dev, format, ##arg); \ 1467 }) 1468 #endif 1469 1470 /* 1471 * dev_WARN*() acts like dev_printk(), but with the key difference of 1472 * using WARN/WARN_ONCE to include file/line information and a backtrace. 1473 */ 1474 #define dev_WARN(dev, format, arg...) \ 1475 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg); 1476 1477 #define dev_WARN_ONCE(dev, condition, format, arg...) \ 1478 WARN_ONCE(condition, "%s %s: " format, \ 1479 dev_driver_string(dev), dev_name(dev), ## arg) 1480 1481 /* Create alias, so I can be autoloaded. */ 1482 #define MODULE_ALIAS_CHARDEV(major,minor) \ 1483 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) 1484 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ 1485 MODULE_ALIAS("char-major-" __stringify(major) "-*") 1486 1487 #ifdef CONFIG_SYSFS_DEPRECATED 1488 extern long sysfs_deprecated; 1489 #else 1490 #define sysfs_deprecated 0 1491 #endif 1492 1493 /** 1494 * module_driver() - Helper macro for drivers that don't do anything 1495 * special in module init/exit. This eliminates a lot of boilerplate. 1496 * Each module may only use this macro once, and calling it replaces 1497 * module_init() and module_exit(). 1498 * 1499 * @__driver: driver name 1500 * @__register: register function for this driver type 1501 * @__unregister: unregister function for this driver type 1502 * @...: Additional arguments to be passed to __register and __unregister. 1503 * 1504 * Use this macro to construct bus specific macros for registering 1505 * drivers, and do not use it on its own. 1506 */ 1507 #define module_driver(__driver, __register, __unregister, ...) \ 1508 static int __init __driver##_init(void) \ 1509 { \ 1510 return __register(&(__driver) , ##__VA_ARGS__); \ 1511 } \ 1512 module_init(__driver##_init); \ 1513 static void __exit __driver##_exit(void) \ 1514 { \ 1515 __unregister(&(__driver) , ##__VA_ARGS__); \ 1516 } \ 1517 module_exit(__driver##_exit); 1518 1519 /** 1520 * builtin_driver() - Helper macro for drivers that don't do anything 1521 * special in init and have no exit. This eliminates some boilerplate. 1522 * Each driver may only use this macro once, and calling it replaces 1523 * device_initcall (or in some cases, the legacy __initcall). This is 1524 * meant to be a direct parallel of module_driver() above but without 1525 * the __exit stuff that is not used for builtin cases. 1526 * 1527 * @__driver: driver name 1528 * @__register: register function for this driver type 1529 * @...: Additional arguments to be passed to __register 1530 * 1531 * Use this macro to construct bus specific macros for registering 1532 * drivers, and do not use it on its own. 1533 */ 1534 #define builtin_driver(__driver, __register, ...) \ 1535 static int __init __driver##_init(void) \ 1536 { \ 1537 return __register(&(__driver) , ##__VA_ARGS__); \ 1538 } \ 1539 device_initcall(__driver##_init); 1540 1541 #endif /* _DEVICE_H_ */ 1542