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