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