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