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