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