device.h 46.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
 * device.h - generic, centralized driver model
 *
 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 6
 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
 * Copyright (c) 2008-2009 Novell Inc.
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15 16 17
 *
 * This file is released under the GPLv2
 *
 * See Documentation/driver-model/ for more information.
 */

#ifndef _DEVICE_H_
#define _DEVICE_H_

#include <linux/ioport.h>
#include <linux/kobject.h>
18
#include <linux/klist.h>
L
Linus Torvalds 已提交
19
#include <linux/list.h>
20
#include <linux/lockdep.h>
21
#include <linux/compiler.h>
L
Linus Torvalds 已提交
22
#include <linux/types.h>
23
#include <linux/mutex.h>
24
#include <linux/pinctrl/devinfo.h>
L
Linus Torvalds 已提交
25
#include <linux/pm.h>
A
Arun Sharma 已提交
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>
L
Linus Torvalds 已提交
31 32

struct device;
33
struct device_private;
L
Linus Torvalds 已提交
34
struct device_driver;
35
struct driver_private;
36
struct module;
L
Linus Torvalds 已提交
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 46

struct bus_attribute {
	struct attribute	attr;
47 48
	ssize_t (*show)(struct bus_type *bus, char *buf);
	ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
49 50
};

51
#define BUS_ATTR(_name, _mode, _show, _store)	\
52 53 54 55 56
	struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
#define BUS_ATTR_RW(_name) \
	struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
#define BUS_ATTR_RO(_name) \
	struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
57 58 59 60

extern int __must_check bus_create_file(struct bus_type *,
					struct bus_attribute *);
extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
L
Linus Torvalds 已提交
61

62 63 64 65
/**
 * struct bus_type - The bus type of the device
 *
 * @name:	The name of the bus.
66 67
 * @dev_name:	Used for subsystems to enumerate devices like ("foo%u", dev->id).
 * @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 73 74 75 76 77 78 79 80
 * @match:	Called, perhaps multiple times, whenever a new device or driver
 *		is added for this bus. It should return a nonzero value if the
 *		given device can be handled by the given driver.
 * @uevent:	Called when a device is added, removed, or a few other things
 *		that generate uevents to add the environment variables.
 * @probe:	Called when a new device or driver add to this bus, and callback
 *		the specific driver's probe to initial the matched device.
 * @remove:	Called when a device removed from this bus.
 * @shutdown:	Called at shut-down time to quiesce the device.
81 82 83 84
 *
 * @online:	Called to put the device back online (after offlining it).
 * @offline:	Called to put the device offline for hot-removal. May fail.
 *
85 86 87 88
 * @suspend:	Called when a device on this bus wants to go to sleep mode.
 * @resume:	Called to bring a device on this bus out of sleep mode.
 * @pm:		Power management operations of this bus, callback the specific
 *		device driver's pm-ops.
89
 * @iommu_ops:  IOMMU specific operations for this bus, used to attach IOMMU
90 91
 *              driver implementations to a bus and allow the driver to do
 *              bus-specific setup
92 93
 * @p:		The private data of the driver core, only the driver core can
 *		touch this.
94
 * @lock_key:	Lock class key for use by the lock validator
95 96 97 98 99 100 101 102 103 104
 *
 * A bus is a channel between the processor and one or more devices. For the
 * purposes of the device model, all devices are connected via a bus, even if
 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
 * A USB controller is usually a PCI device, for example. The device model
 * represents the actual connections between buses and the devices they control.
 * A bus is represented by the bus_type structure. It contains the name, the
 * default attributes, the bus' methods, PM operations, and the driver core's
 * private data.
 */
L
Linus Torvalds 已提交
105
struct bus_type {
106
	const char		*name;
107 108
	const char		*dev_name;
	struct device		*dev_root;
109
	struct device_attribute	*dev_attrs;	/* use dev_groups instead */
110
	const struct attribute_group **bus_groups;
111
	const struct attribute_group **dev_groups;
112
	const struct attribute_group **drv_groups;
113 114 115 116 117 118 119

	int (*match)(struct device *dev, struct device_driver *drv);
	int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
	int (*probe)(struct device *dev);
	int (*remove)(struct device *dev);
	void (*shutdown)(struct device *dev);

120 121 122
	int (*online)(struct device *dev);
	int (*offline)(struct device *dev);

123 124
	int (*suspend)(struct device *dev, pm_message_t state);
	int (*resume)(struct device *dev);
125

126
	const struct dev_pm_ops *pm;
127

128
	const struct iommu_ops *iommu_ops;
129

130
	struct subsys_private *p;
131
	struct lock_class_key lock_key;
L
Linus Torvalds 已提交
132 133
};

134 135
extern int __must_check bus_register(struct bus_type *bus);

136
extern void bus_unregister(struct bus_type *bus);
L
Linus Torvalds 已提交
137

138
extern int __must_check bus_rescan_devices(struct bus_type *bus);
L
Linus Torvalds 已提交
139 140

/* iterator helpers for buses */
141 142 143 144
struct subsys_dev_iter {
	struct klist_iter		ki;
	const struct device_type	*type;
};
145
void subsys_dev_iter_init(struct subsys_dev_iter *iter,
146 147 148 149 150
			 struct bus_type *subsys,
			 struct device *start,
			 const struct device_type *type);
struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
L
Linus Torvalds 已提交
151

152 153 154 155 156
int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
		     int (*fn)(struct device *dev, void *data));
struct device *bus_find_device(struct bus_type *bus, struct device *start,
			       void *data,
			       int (*match)(struct device *dev, void *data));
157 158 159
struct device *bus_find_device_by_name(struct bus_type *bus,
				       struct device *start,
				       const char *name);
160 161
struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
					struct device *hint);
162 163
int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
		     void *data, int (*fn)(struct device_driver *, void *));
164 165 166
void bus_sort_breadthfirst(struct bus_type *bus,
			   int (*compare)(const struct device *a,
					  const struct device *b));
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/*
 * Bus notifiers: Get notified of addition/removal of devices
 * and binding/unbinding of drivers to devices.
 * In the long run, it should be a replacement for the platform
 * notify hooks.
 */
struct notifier_block;

extern int bus_register_notifier(struct bus_type *bus,
				 struct notifier_block *nb);
extern int bus_unregister_notifier(struct bus_type *bus,
				   struct notifier_block *nb);

/* All 4 notifers below get called with the target struct device *
 * as an argument. Note that those functions are likely to be called
182
 * with the device lock held in the core, so be careful.
183 184
 */
#define BUS_NOTIFY_ADD_DEVICE		0x00000001 /* device added */
185 186 187
#define BUS_NOTIFY_DEL_DEVICE		0x00000002 /* device to be removed */
#define BUS_NOTIFY_REMOVED_DEVICE	0x00000003 /* device removed */
#define BUS_NOTIFY_BIND_DRIVER		0x00000004 /* driver about to be
188
						      bound */
189 190
#define BUS_NOTIFY_BOUND_DRIVER		0x00000005 /* driver bound to device */
#define BUS_NOTIFY_UNBIND_DRIVER	0x00000006 /* driver about to be
191
						      unbound */
192
#define BUS_NOTIFY_UNBOUND_DRIVER	0x00000007 /* driver is unbound
193
						      from the device */
194

195
extern struct kset *bus_get_kset(struct bus_type *bus);
196
extern struct klist *bus_get_device_klist(struct bus_type *bus);
197

198 199 200 201 202 203
/**
 * enum probe_type - device driver probe type to try
 *	Device drivers may opt in for special handling of their
 *	respective probe routines. This tells the core what to
 *	expect and prefer.
 *
204 205
 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
 *	whether probed synchronously or asynchronously.
206 207 208
 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
 *	probing order is not essential for booting the system may
 *	opt into executing their probes asynchronously.
209 210 211 212
 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
 *	their probe routines to run synchronously with driver and
 *	device registration (with the exception of -EPROBE_DEFER
 *	handling - re-probing always ends up being done asynchronously).
213 214 215 216 217 218 219 220
 *
 * Note that the end goal is to switch the kernel to use asynchronous
 * probing by default, so annotating drivers with
 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
 * to speed up boot process while we are validating the rest of the
 * drivers.
 */
enum probe_type {
221
	PROBE_DEFAULT_STRATEGY,
222
	PROBE_PREFER_ASYNCHRONOUS,
223
	PROBE_FORCE_SYNCHRONOUS,
224 225
};

226 227 228 229 230 231 232
/**
 * struct device_driver - The basic device driver structure
 * @name:	Name of the device driver.
 * @bus:	The bus which the device of this driver belongs to.
 * @owner:	The module owner.
 * @mod_name:	Used for built-in modules.
 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
233
 * @probe_type:	Type of the probe (synchronous or asynchronous) to use.
234
 * @of_match_table: The open firmware table.
235
 * @acpi_match_table: The ACPI match table.
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
 * @probe:	Called to query the existence of a specific device,
 *		whether this driver can work with it, and bind the driver
 *		to a specific device.
 * @remove:	Called when the device is removed from the system to
 *		unbind a device from this driver.
 * @shutdown:	Called at shut-down time to quiesce the device.
 * @suspend:	Called to put the device to sleep mode. Usually to a
 *		low power state.
 * @resume:	Called to bring a device from sleep mode.
 * @groups:	Default attributes that get created by the driver core
 *		automatically.
 * @pm:		Power management operations of the device which matched
 *		this driver.
 * @p:		Driver core's private data, no one other than the driver
 *		core can touch this.
 *
 * The device driver-model tracks all of the drivers known to the system.
 * The main reason for this tracking is to enable the driver core to match
 * up drivers with new devices. Once drivers are known objects within the
 * system, however, a number of other things become possible. Device drivers
 * can export information and configuration variables that are independent
 * of any specific device.
 */
L
Linus Torvalds 已提交
259
struct device_driver {
260 261
	const char		*name;
	struct bus_type		*bus;
L
Linus Torvalds 已提交
262

263
	struct module		*owner;
264 265 266
	const char		*mod_name;	/* used for built-in modules */

	bool suppress_bind_attrs;	/* disables bind/unbind via sysfs */
267
	enum probe_type probe_type;
L
Linus Torvalds 已提交
268

269
	const struct of_device_id	*of_match_table;
270
	const struct acpi_device_id	*acpi_match_table;
271

272 273 274 275 276
	int (*probe) (struct device *dev);
	int (*remove) (struct device *dev);
	void (*shutdown) (struct device *dev);
	int (*suspend) (struct device *dev, pm_message_t state);
	int (*resume) (struct device *dev);
277
	const struct attribute_group **groups;
278

279
	const struct dev_pm_ops *pm;
280

281
	struct driver_private *p;
L
Linus Torvalds 已提交
282 283 284
};


285 286
extern int __must_check driver_register(struct device_driver *drv);
extern void driver_unregister(struct device_driver *drv);
L
Linus Torvalds 已提交
287

288 289
extern struct device_driver *driver_find(const char *name,
					 struct bus_type *bus);
290
extern int driver_probe_done(void);
291
extern void wait_for_device_probe(void);
292

L
Linus Torvalds 已提交
293

294
/* sysfs interface for exporting driver attributes */
L
Linus Torvalds 已提交
295 296

struct driver_attribute {
297 298 299 300
	struct attribute attr;
	ssize_t (*show)(struct device_driver *driver, char *buf);
	ssize_t (*store)(struct device_driver *driver, const char *buf,
			 size_t count);
L
Linus Torvalds 已提交
301 302
};

303 304 305 306 307 308
#define DRIVER_ATTR(_name, _mode, _show, _store) \
	struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
#define DRIVER_ATTR_RW(_name) \
	struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
#define DRIVER_ATTR_RO(_name) \
	struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
309 310
#define DRIVER_ATTR_WO(_name) \
	struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
L
Linus Torvalds 已提交
311

312
extern int __must_check driver_create_file(struct device_driver *driver,
313
					const struct driver_attribute *attr);
314
extern void driver_remove_file(struct device_driver *driver,
315
			       const struct driver_attribute *attr);
L
Linus Torvalds 已提交
316

317 318 319 320 321 322 323 324
extern int __must_check driver_for_each_device(struct device_driver *drv,
					       struct device *start,
					       void *data,
					       int (*fn)(struct device *dev,
							 void *));
struct device *driver_find_device(struct device_driver *drv,
				  struct device *start, void *data,
				  int (*match)(struct device *dev, void *data));
325

326 327
/**
 * struct subsys_interface - interfaces to device functions
328 329 330 331 332
 * @name:       name of the device function
 * @subsys:     subsytem of the devices to attach to
 * @node:       the list of functions registered at the subsystem
 * @add_dev:    device hookup to device function handler
 * @remove_dev: device hookup to device function handler
333 334 335 336 337 338 339 340 341 342 343
 *
 * Simple interfaces attached to a subsystem. Multiple interfaces can
 * attach to a subsystem and its devices. Unlike drivers, they do not
 * exclusively claim or control devices. Interfaces usually represent
 * a specific functionality of a subsystem/class of devices.
 */
struct subsys_interface {
	const char *name;
	struct bus_type *subsys;
	struct list_head node;
	int (*add_dev)(struct device *dev, struct subsys_interface *sif);
344
	void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
345 346 347 348 349 350 351
};

int subsys_interface_register(struct subsys_interface *sif);
void subsys_interface_unregister(struct subsys_interface *sif);

int subsys_system_register(struct bus_type *subsys,
			   const struct attribute_group **groups);
352 353
int subsys_virtual_register(struct bus_type *subsys,
			    const struct attribute_group **groups);
354

355 356 357 358 359
/**
 * struct class - device classes
 * @name:	Name of the class.
 * @owner:	The module owner.
 * @class_attrs: Default attributes of this class.
360
 * @dev_groups:	Default attributes of the devices that belong to the class.
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
 * @dev_kobj:	The kobject that represents this class and links it into the hierarchy.
 * @dev_uevent:	Called when a device is added, removed from this class, or a
 *		few other things that generate uevents to add the environment
 *		variables.
 * @devnode:	Callback to provide the devtmpfs.
 * @class_release: Called to release this class.
 * @dev_release: Called to release the device.
 * @suspend:	Used to put the device to sleep mode, usually to a low power
 *		state.
 * @resume:	Used to bring the device from the sleep mode.
 * @ns_type:	Callbacks so sysfs can detemine namespaces.
 * @namespace:	Namespace of the device belongs to this class.
 * @pm:		The default device power management operations of this class.
 * @p:		The private data of the driver core, no one other than the
 *		driver core can touch this.
 *
 * A class is a higher-level view of a device that abstracts out low-level
 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
 * at the class level, they are all simply disks. Classes allow user space
 * to work with devices based on what they do, rather than how they are
 * connected or how they work.
L
Linus Torvalds 已提交
382 383
 */
struct class {
384 385
	const char		*name;
	struct module		*owner;
L
Linus Torvalds 已提交
386

387
	struct class_attribute		*class_attrs;
388
	const struct attribute_group	**dev_groups;
389
	struct kobject			*dev_kobj;
L
Linus Torvalds 已提交
390

391
	int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
392
	char *(*devnode)(struct device *dev, umode_t *mode);
L
Linus Torvalds 已提交
393

394 395
	void (*class_release)(struct class *class);
	void (*dev_release)(struct device *dev);
396

397 398
	int (*suspend)(struct device *dev, pm_message_t state);
	int (*resume)(struct device *dev);
399

400 401 402
	const struct kobj_ns_type_operations *ns_type;
	const void *(*namespace)(struct device *dev);

403 404
	const struct dev_pm_ops *pm;

405
	struct subsys_private *p;
L
Linus Torvalds 已提交
406 407
};

408 409 410 411 412
struct class_dev_iter {
	struct klist_iter		ki;
	const struct device_type	*type;
};

413 414
extern struct kobject *sysfs_dev_block_kobj;
extern struct kobject *sysfs_dev_char_kobj;
415 416
extern int __must_check __class_register(struct class *class,
					 struct lock_class_key *key);
417
extern void class_unregister(struct class *class);
418 419 420 421 422 423 424 425 426

/* This is a #define to keep the compiler from merging different
 * instances of the __key variable */
#define class_register(class)			\
({						\
	static struct lock_class_key __key;	\
	__class_register(class, &__key);	\
})

427 428 429 430 431 432 433 434
struct class_compat;
struct class_compat *class_compat_register(const char *name);
void class_compat_unregister(struct class_compat *cls);
int class_compat_create_link(struct class_compat *cls, struct device *dev,
			     struct device *device_link);
void class_compat_remove_link(struct class_compat *cls, struct device *dev,
			      struct device *device_link);

435 436 437 438
extern void class_dev_iter_init(struct class_dev_iter *iter,
				struct class *class,
				struct device *start,
				const struct device_type *type);
439 440 441
extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
extern void class_dev_iter_exit(struct class_dev_iter *iter);

442 443
extern int class_for_each_device(struct class *class, struct device *start,
				 void *data,
444
				 int (*fn)(struct device *dev, void *data));
445
extern struct device *class_find_device(struct class *class,
446 447
					struct device *start, const void *data,
					int (*match)(struct device *, const void *));
L
Linus Torvalds 已提交
448 449

struct class_attribute {
450
	struct attribute attr;
451 452 453 454
	ssize_t (*show)(struct class *class, struct class_attribute *attr,
			char *buf);
	ssize_t (*store)(struct class *class, struct class_attribute *attr,
			const char *buf, size_t count);
L
Linus Torvalds 已提交
455 456
};

457 458 459 460 461 462
#define CLASS_ATTR(_name, _mode, _show, _store) \
	struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
#define CLASS_ATTR_RW(_name) \
	struct class_attribute class_attr_##_name = __ATTR_RW(_name)
#define CLASS_ATTR_RO(_name) \
	struct class_attribute class_attr_##_name = __ATTR_RO(_name)
L
Linus Torvalds 已提交
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
extern int __must_check class_create_file_ns(struct class *class,
					     const struct class_attribute *attr,
					     const void *ns);
extern void class_remove_file_ns(struct class *class,
				 const struct class_attribute *attr,
				 const void *ns);

static inline int __must_check class_create_file(struct class *class,
					const struct class_attribute *attr)
{
	return class_create_file_ns(class, attr, NULL);
}

static inline void class_remove_file(struct class *class,
				     const struct class_attribute *attr)
{
	return class_remove_file_ns(class, attr, NULL);
}
L
Linus Torvalds 已提交
482

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
/* Simple class attribute that is just a static string */
struct class_attribute_string {
	struct class_attribute attr;
	char *str;
};

/* Currently read-only only */
#define _CLASS_ATTR_STRING(_name, _mode, _str) \
	{ __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
#define CLASS_ATTR_STRING(_name, _mode, _str) \
	struct class_attribute_string class_attr_##_name = \
		_CLASS_ATTR_STRING(_name, _mode, _str)

extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
                        char *buf);

L
Linus Torvalds 已提交
499 500 501 502
struct class_interface {
	struct list_head	node;
	struct class		*class;

503 504
	int (*add_dev)		(struct device *, struct class_interface *);
	void (*remove_dev)	(struct device *, struct class_interface *);
L
Linus Torvalds 已提交
505 506
};

507
extern int __must_check class_interface_register(struct class_interface *);
L
Linus Torvalds 已提交
508 509
extern void class_interface_unregister(struct class_interface *);

510 511 512
extern struct class * __must_check __class_create(struct module *owner,
						  const char *name,
						  struct lock_class_key *key);
513 514
extern void class_destroy(struct class *cls);

515 516 517 518 519 520 521 522
/* This is a #define to keep the compiler from merging different
 * instances of the __key variable */
#define class_create(owner, name)		\
({						\
	static struct lock_class_key __key;	\
	__class_create(owner, name, &__key);	\
})

523 524 525 526 527 528 529 530 531
/*
 * The type of device, "struct device" is embedded in. A class
 * or bus can contain devices of different types
 * like "partitions" and "disks", "mouse" and "event".
 * This identifies the device type and carries type-specific
 * information, equivalent to the kobj_type of a kobject.
 * If "name" is specified, the uevent will contain it in
 * the DEVTYPE variable.
 */
532
struct device_type {
533
	const char *name;
534
	const struct attribute_group **groups;
535
	int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
536
	char *(*devnode)(struct device *dev, umode_t *mode,
537
			 kuid_t *uid, kgid_t *gid);
538
	void (*release)(struct device *dev);
539

540
	const struct dev_pm_ops *pm;
541 542
};

543 544 545 546 547 548 549 550 551
/* interface for exporting device attributes */
struct device_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct device *dev, struct device_attribute *attr,
			char *buf);
	ssize_t (*store)(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count);
};

552 553 554 555 556 557 558 559 560 561 562 563 564
struct dev_ext_attribute {
	struct device_attribute attr;
	void *var;
};

ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
			  char *buf);
ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
			   const char *buf, size_t count);
ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
			char *buf);
ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count);
565 566 567 568
ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
			char *buf);
ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count);
569

570
#define DEVICE_ATTR(_name, _mode, _show, _store) \
571
	struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
572 573 574 575
#define DEVICE_ATTR_RW(_name) \
	struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
#define DEVICE_ATTR_RO(_name) \
	struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
576 577
#define DEVICE_ATTR_WO(_name) \
	struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
578 579 580 581 582
#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
	struct dev_ext_attribute dev_attr_##_name = \
		{ __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
#define DEVICE_INT_ATTR(_name, _mode, _var) \
	struct dev_ext_attribute dev_attr_##_name = \
583
		{ __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
584 585 586
#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
	struct dev_ext_attribute dev_attr_##_name = \
		{ __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
587 588 589
#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
	struct device_attribute dev_attr_##_name =		\
		__ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
590

591 592
extern int device_create_file(struct device *device,
			      const struct device_attribute *entry);
593
extern void device_remove_file(struct device *dev,
594
			       const struct device_attribute *attr);
595 596
extern bool device_remove_file_self(struct device *dev,
				    const struct device_attribute *attr);
597
extern int __must_check device_create_bin_file(struct device *dev,
598
					const struct bin_attribute *attr);
599
extern void device_remove_bin_file(struct device *dev,
600
				   const struct bin_attribute *attr);
T
Tejun Heo 已提交
601 602 603 604 605 606

/* device resource management */
typedef void (*dr_release_t)(struct device *dev, void *res);
typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);

#ifdef CONFIG_DEBUG_DEVRES
607 608
extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
				 int nid, const char *name);
T
Tejun Heo 已提交
609
#define devres_alloc(release, size, gfp) \
610 611 612
	__devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
#define devres_alloc_node(release, size, gfp, nid) \
	__devres_alloc_node(release, size, gfp, nid, #release)
T
Tejun Heo 已提交
613
#else
614 615 616 617 618 619
extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
			       int nid);
static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
{
	return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
}
T
Tejun Heo 已提交
620
#endif
621

622 623 624 625
extern void devres_for_each_res(struct device *dev, dr_release_t release,
				dr_match_t match, void *match_data,
				void (*fn)(struct device *, void *, void *),
				void *data);
T
Tejun Heo 已提交
626 627
extern void devres_free(void *res);
extern void devres_add(struct device *dev, void *res);
628
extern void *devres_find(struct device *dev, dr_release_t release,
T
Tejun Heo 已提交
629
			 dr_match_t match, void *match_data);
630 631 632 633
extern void *devres_get(struct device *dev, void *new_res,
			dr_match_t match, void *match_data);
extern void *devres_remove(struct device *dev, dr_release_t release,
			   dr_match_t match, void *match_data);
T
Tejun Heo 已提交
634 635
extern int devres_destroy(struct device *dev, dr_release_t release,
			  dr_match_t match, void *match_data);
M
Mark Brown 已提交
636 637
extern int devres_release(struct device *dev, dr_release_t release,
			  dr_match_t match, void *match_data);
T
Tejun Heo 已提交
638 639 640 641 642 643 644 645

/* devres group */
extern void * __must_check devres_open_group(struct device *dev, void *id,
					     gfp_t gfp);
extern void devres_close_group(struct device *dev, void *id);
extern void devres_remove_group(struct device *dev, void *id);
extern int devres_release_group(struct device *dev, void *id);

646 647
/* managed devm_k.alloc/kfree for device drivers */
extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
648 649 650
extern __printf(3, 0)
char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
		      va_list ap);
651 652
extern __printf(3, 4)
char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
{
	return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
}
static inline void *devm_kmalloc_array(struct device *dev,
				       size_t n, size_t size, gfp_t flags)
{
	if (size != 0 && n > SIZE_MAX / size)
		return NULL;
	return devm_kmalloc(dev, n * size, flags);
}
static inline void *devm_kcalloc(struct device *dev,
				 size_t n, size_t size, gfp_t flags)
{
	return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
}
T
Tejun Heo 已提交
669
extern void devm_kfree(struct device *dev, void *p);
670
extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
671 672
extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
			  gfp_t gfp);
T
Tejun Heo 已提交
673

674 675 676
extern unsigned long devm_get_free_pages(struct device *dev,
					 gfp_t gfp_mask, unsigned int order);
extern void devm_free_pages(struct device *dev, unsigned long addr);
T
Tejun Heo 已提交
677

678
void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
679

680 681 682 683
/* allows to add/remove a custom action to devres stack */
int devm_add_action(struct device *dev, void (*action)(void *), void *data);
void devm_remove_action(struct device *dev, void (*action)(void *), void *data);

684 685 686 687 688 689 690 691 692
struct device_dma_parameters {
	/*
	 * a low level driver may set these to teach IOMMU code about
	 * sg limitations.
	 */
	unsigned int max_segment_size;
	unsigned long segment_boundary_mask;
};

693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
/**
 * struct device - The basic device structure
 * @parent:	The device's "parent" device, the device to which it is attached.
 * 		In most cases, a parent device is some sort of bus or host
 * 		controller. If parent is NULL, the device, is a top-level device,
 * 		which is not usually what you want.
 * @p:		Holds the private data of the driver core portions of the device.
 * 		See the comment of the struct device_private for detail.
 * @kobj:	A top-level, abstract class from which other classes are derived.
 * @init_name:	Initial name of the device.
 * @type:	The type of device.
 * 		This identifies the device type and carries type-specific
 * 		information.
 * @mutex:	Mutex to synchronize calls to its driver.
 * @bus:	Type of bus device is on.
 * @driver:	Which driver has allocated this
 * @platform_data: Platform data specific to the device.
 * 		Example: For devices on custom boards, as typical of embedded
 * 		and SOC based hardware, Linux often uses platform_data to point
 * 		to board-specific structures describing devices and how they
 * 		are wired.  That can include what ports are available, chip
 * 		variants, which GPIO pins act in what additional roles, and so
 * 		on.  This shrinks the "Board Support Packages" (BSPs) and
 * 		minimizes board-specific #ifdefs in drivers.
717
 * @driver_data: Private pointer for driver specific info.
718 719
 * @power:	For device power management.
 * 		See Documentation/power/devices.txt for details.
720
 * @pm_domain:	Provide callbacks that are executed during system suspend,
721 722
 * 		hibernation, system resume and during runtime PM transitions
 * 		along with subsystem-level and driver-level callbacks.
723 724
 * @pins:	For device pin management.
 *		See Documentation/pinctrl.txt for details.
725
 * @msi_list:	Hosts MSI descriptors
726
 * @msi_domain: The generic MSI domain this device is using.
727 728 729 730 731
 * @numa_node:	NUMA node this device is close to.
 * @dma_mask:	Dma mask (if dma'ble device).
 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
 * 		hardware supports 64-bit addresses for consistent allocations
 * 		such descriptors.
732
 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
733 734 735 736
 * @dma_parms:	A low level driver may set these to teach IOMMU code about
 * 		segment limitations.
 * @dma_pools:	Dma pools (if dma'ble device).
 * @dma_mem:	Internal for coherent mem override.
737
 * @cma_area:	Contiguous memory area for dma allocations
738 739
 * @archdata:	For arch-specific additions.
 * @of_node:	Associated device tree node.
740
 * @fwnode:	Associated device node supplied by platform firmware.
741
 * @devt:	For creating the sysfs "dev".
742
 * @id:		device instance
743 744 745 746 747 748 749 750
 * @devres_lock: Spinlock to protect the resource of the device.
 * @devres_head: The resources list of the device.
 * @knode_class: The node used to add the device to the class list.
 * @class:	The class of the device.
 * @groups:	Optional attribute groups.
 * @release:	Callback to free the device after all references have
 * 		gone away. This should be set by the allocator of the
 * 		device (i.e. the bus driver that discovered the device).
751
 * @iommu_group: IOMMU group the device belongs to.
752
 *
753 754
 * @offline_disabled: If set, the device is permanently online.
 * @offline:	Set after successful invocation of bus type's .offline().
755 756 757 758 759 760 761 762 763
 *
 * At the lowest level, every device in a Linux system is represented by an
 * instance of struct device. The device structure contains the information
 * that the device model core needs to model the system. Most subsystems,
 * however, track additional information about the devices they host. As a
 * result, it is rare for devices to be represented by bare device structures;
 * instead, that structure, like kobject structures, is usually embedded within
 * a higher-level representation of the device.
 */
L
Linus Torvalds 已提交
764
struct device {
765
	struct device		*parent;
L
Linus Torvalds 已提交
766

767 768
	struct device_private	*p;

L
Linus Torvalds 已提交
769
	struct kobject kobj;
770
	const char		*init_name; /* initial name of the device */
771
	const struct device_type *type;
L
Linus Torvalds 已提交
772

773
	struct mutex		mutex;	/* mutex to synchronize calls to
774 775 776
					 * its driver.
					 */

777
	struct bus_type	*bus;		/* type of bus device is on */
L
Linus Torvalds 已提交
778 779
	struct device_driver *driver;	/* which driver has allocated this
					   device */
780 781
	void		*platform_data;	/* Platform specific data, device
					   core doesn't touch it */
782 783
	void		*driver_data;	/* Driver data, set and get with
					   dev_set/get_drvdata */
L
Linus Torvalds 已提交
784
	struct dev_pm_info	power;
785
	struct dev_pm_domain	*pm_domain;
L
Linus Torvalds 已提交
786

787 788 789
#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
	struct irq_domain	*msi_domain;
#endif
790 791 792
#ifdef CONFIG_PINCTRL
	struct dev_pin_info	*pins;
#endif
793 794 795
#ifdef CONFIG_GENERIC_MSI_IRQ
	struct list_head	msi_list;
#endif
796

797 798 799
#ifdef CONFIG_NUMA
	int		numa_node;	/* NUMA node this device is close to */
#endif
L
Linus Torvalds 已提交
800 801 802 803 804 805
	u64		*dma_mask;	/* dma mask (if dma'able device) */
	u64		coherent_dma_mask;/* Like dma_mask, but for
					     alloc_coherent mappings as
					     not all hardware supports
					     64 bit addresses for consistent
					     allocations such descriptors. */
806
	unsigned long	dma_pfn_offset;
L
Linus Torvalds 已提交
807

808 809
	struct device_dma_parameters *dma_parms;

L
Linus Torvalds 已提交
810 811 812 813
	struct list_head	dma_pools;	/* dma pools (if dma'ble) */

	struct dma_coherent_mem	*dma_mem; /* internal for coherent mem
					     override */
814
#ifdef CONFIG_DMA_CMA
815 816 817
	struct cma *cma_area;		/* contiguous memory area for dma
					   allocations */
#endif
818 819
	/* arch specific additions */
	struct dev_archdata	archdata;
820 821

	struct device_node	*of_node; /* associated device tree node */
822
	struct fwnode_handle	*fwnode; /* firmware device node */
L
Linus Torvalds 已提交
823

824
	dev_t			devt;	/* dev_t, creates the sysfs "dev" */
825
	u32			id;	/* device instance */
826

T
Tejun Heo 已提交
827 828 829
	spinlock_t		devres_lock;
	struct list_head	devres_head;

830
	struct klist_node	knode_class;
831
	struct class		*class;
832
	const struct attribute_group **groups;	/* optional groups */
833

834
	void	(*release)(struct device *dev);
835
	struct iommu_group	*iommu_group;
836 837 838

	bool			offline_disabled:1;
	bool			offline:1;
L
Linus Torvalds 已提交
839 840
};

841 842 843 844 845
static inline struct device *kobj_to_dev(struct kobject *kobj)
{
	return container_of(kobj, struct device, kobj);
}

846 847 848
/* Get the wakeup routines, which depend on struct device */
#include <linux/pm_wakeup.h>

849
static inline const char *dev_name(const struct device *dev)
850
{
851 852 853 854
	/* Use the init name until the kobject becomes available */
	if (dev->init_name)
		return dev->init_name;

855
	return kobject_name(&dev->kobj);
856 857
}

858 859
extern __printf(2, 3)
int dev_set_name(struct device *dev, const char *name, ...);
860

861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
#ifdef CONFIG_NUMA
static inline int dev_to_node(struct device *dev)
{
	return dev->numa_node;
}
static inline void set_dev_node(struct device *dev, int node)
{
	dev->numa_node = node;
}
#else
static inline int dev_to_node(struct device *dev)
{
	return -1;
}
static inline void set_dev_node(struct device *dev, int node)
{
}
#endif

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
{
#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
	return dev->msi_domain;
#else
	return NULL;
#endif
}

static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
{
#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
	dev->msi_domain = d;
#endif
}

896 897 898 899 900 901 902 903 904 905
static inline void *dev_get_drvdata(const struct device *dev)
{
	return dev->driver_data;
}

static inline void dev_set_drvdata(struct device *dev, void *data)
{
	dev->driver_data = data;
}

906 907 908 909 910
static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
{
	return dev ? dev->power.subsys_data : NULL;
}

911 912 913 914 915 916 917 918 919 920
static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
{
	return dev->kobj.uevent_suppress;
}

static inline void dev_set_uevent_suppress(struct device *dev, int val)
{
	dev->kobj.uevent_suppress = val;
}

921 922
static inline int device_is_registered(struct device *dev)
{
923
	return dev->kobj.state_in_sysfs;
924 925
}

926 927
static inline void device_enable_async_suspend(struct device *dev)
{
928
	if (!dev->power.is_prepared)
929 930 931
		dev->power.async_suspend = true;
}

932 933
static inline void device_disable_async_suspend(struct device *dev)
{
934
	if (!dev->power.is_prepared)
935 936 937 938 939 940 941 942
		dev->power.async_suspend = false;
}

static inline bool device_async_suspend_enabled(struct device *dev)
{
	return !!dev->power.async_suspend;
}

943 944 945 946 947
static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
{
	dev->power.ignore_children = enable;
}

948 949 950 951 952 953 954
static inline void dev_pm_syscore_device(struct device *dev, bool val)
{
#ifdef CONFIG_PM_SLEEP
	dev->power.syscore = val;
#endif
}

955 956
static inline void device_lock(struct device *dev)
{
957
	mutex_lock(&dev->mutex);
958 959 960 961
}

static inline int device_trylock(struct device *dev)
{
962
	return mutex_trylock(&dev->mutex);
963 964 965 966
}

static inline void device_unlock(struct device *dev)
{
967
	mutex_unlock(&dev->mutex);
968 969
}

970 971 972 973 974
static inline void device_lock_assert(struct device *dev)
{
	lockdep_assert_held(&dev->mutex);
}

975 976 977 978 979 980 981
static inline struct device_node *dev_of_node(struct device *dev)
{
	if (!IS_ENABLED(CONFIG_OF))
		return NULL;
	return dev->of_node;
}

982 983
void driver_init(void);

L
Linus Torvalds 已提交
984 985 986
/*
 * High level routines for use by the bus drivers
 */
987 988 989 990 991 992 993
extern int __must_check device_register(struct device *dev);
extern void device_unregister(struct device *dev);
extern void device_initialize(struct device *dev);
extern int __must_check device_add(struct device *dev);
extern void device_del(struct device *dev);
extern int device_for_each_child(struct device *dev, void *data,
		     int (*fn)(struct device *dev, void *data));
994 995
extern int device_for_each_child_reverse(struct device *dev, void *data,
		     int (*fn)(struct device *dev, void *data));
996 997
extern struct device *device_find_child(struct device *dev, void *data,
				int (*match)(struct device *dev, void *data));
998
extern int device_rename(struct device *dev, const char *new_name);
999 1000
extern int device_move(struct device *dev, struct device *new_parent,
		       enum dpm_order dpm_order);
1001
extern const char *device_get_devnode(struct device *dev,
1002
				      umode_t *mode, kuid_t *uid, kgid_t *gid,
1003
				      const char **tmp);
L
Linus Torvalds 已提交
1004

1005 1006 1007 1008 1009 1010 1011
static inline bool device_supports_offline(struct device *dev)
{
	return dev->bus && dev->bus->offline && dev->bus->online;
}

extern void lock_device_hotplug(void);
extern void unlock_device_hotplug(void);
1012
extern int lock_device_hotplug_sysfs(void);
1013 1014
extern int device_offline(struct device *dev);
extern int device_online(struct device *dev);
1015 1016 1017
extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);

1018 1019 1020 1021 1022
/*
 * Root device objects for grouping under /sys/devices
 */
extern struct device *__root_device_register(const char *name,
					     struct module *owner);
1023

1024
/* This is a macro to avoid include problems with THIS_MODULE */
1025 1026 1027
#define root_device_register(name) \
	__root_device_register(name, THIS_MODULE)

1028 1029
extern void root_device_unregister(struct device *root);

1030 1031 1032 1033 1034
static inline void *dev_get_platdata(const struct device *dev)
{
	return dev->platform_data;
}

L
Linus Torvalds 已提交
1035 1036 1037 1038
/*
 * Manual binding of a device to driver. See drivers/base/bus.c
 * for information on use.
 */
A
Andrew Morton 已提交
1039
extern int __must_check device_bind_driver(struct device *dev);
1040 1041
extern void device_release_driver(struct device *dev);
extern int  __must_check device_attach(struct device *dev);
A
Andrew Morton 已提交
1042
extern int __must_check driver_attach(struct device_driver *drv);
1043
extern void device_initial_probe(struct device *dev);
A
Andrew Morton 已提交
1044
extern int __must_check device_reprobe(struct device *dev);
L
Linus Torvalds 已提交
1045

1046 1047 1048
/*
 * Easy functions for dynamically creating devices on the fly
 */
1049 1050 1051 1052
extern __printf(5, 0)
struct device *device_create_vargs(struct class *cls, struct device *parent,
				   dev_t devt, void *drvdata,
				   const char *fmt, va_list vargs);
1053 1054 1055 1056
extern __printf(5, 6)
struct device *device_create(struct class *cls, struct device *parent,
			     dev_t devt, void *drvdata,
			     const char *fmt, ...);
1057 1058 1059 1060 1061
extern __printf(6, 7)
struct device *device_create_with_groups(struct class *cls,
			     struct device *parent, dev_t devt, void *drvdata,
			     const struct attribute_group **groups,
			     const char *fmt, ...);
1062
extern void device_destroy(struct class *cls, dev_t devt);
L
Linus Torvalds 已提交
1063 1064 1065 1066 1067 1068 1069

/*
 * Platform "fixup" functions - allow the platform to have their say
 * about devices and actions that the general device layer doesn't
 * know about.
 */
/* Notify platform of device discovery */
1070
extern int (*platform_notify)(struct device *dev);
L
Linus Torvalds 已提交
1071

1072
extern int (*platform_notify_remove)(struct device *dev);
L
Linus Torvalds 已提交
1073 1074


1075
/*
L
Linus Torvalds 已提交
1076 1077 1078
 * get_device - atomically increment the reference count for the device.
 *
 */
1079 1080
extern struct device *get_device(struct device *dev);
extern void put_device(struct device *dev);
L
Linus Torvalds 已提交
1081

1082 1083 1084
#ifdef CONFIG_DEVTMPFS
extern int devtmpfs_create_node(struct device *dev);
extern int devtmpfs_delete_node(struct device *dev);
1085
extern int devtmpfs_mount(const char *mntdir);
1086 1087 1088 1089 1090 1091
#else
static inline int devtmpfs_create_node(struct device *dev) { return 0; }
static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
#endif

1092
/* drivers/base/power/shutdown.c */
L
Linus Torvalds 已提交
1093 1094 1095
extern void device_shutdown(void);

/* debugging and troubleshooting/diagnostic helpers. */
1096
extern const char *dev_driver_string(const struct device *dev);
1097 1098 1099 1100


#ifdef CONFIG_PRINTK

1101 1102 1103
extern __printf(3, 0)
int dev_vprintk_emit(int level, const struct device *dev,
		     const char *fmt, va_list args);
1104 1105
extern __printf(3, 4)
int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1106

1107
extern __printf(3, 4)
1108 1109
void dev_printk(const char *level, const struct device *dev,
		const char *fmt, ...);
1110
extern __printf(2, 3)
1111
void dev_emerg(const struct device *dev, const char *fmt, ...);
1112
extern __printf(2, 3)
1113
void dev_alert(const struct device *dev, const char *fmt, ...);
1114
extern __printf(2, 3)
1115
void dev_crit(const struct device *dev, const char *fmt, ...);
1116
extern __printf(2, 3)
1117
void dev_err(const struct device *dev, const char *fmt, ...);
1118
extern __printf(2, 3)
1119
void dev_warn(const struct device *dev, const char *fmt, ...);
1120
extern __printf(2, 3)
1121
void dev_notice(const struct device *dev, const char *fmt, ...);
1122
extern __printf(2, 3)
1123
void _dev_info(const struct device *dev, const char *fmt, ...);
1124 1125 1126

#else

1127 1128 1129
static inline __printf(3, 0)
int dev_vprintk_emit(int level, const struct device *dev,
		     const char *fmt, va_list args)
1130 1131 1132 1133 1134
{ return 0; }
static inline __printf(3, 4)
int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
{ return 0; }

1135 1136 1137
static inline void __dev_printk(const char *level, const struct device *dev,
				struct va_format *vaf)
{}
1138
static inline __printf(3, 4)
1139 1140 1141
void dev_printk(const char *level, const struct device *dev,
		const char *fmt, ...)
{}
1142 1143

static inline __printf(2, 3)
1144 1145
void dev_emerg(const struct device *dev, const char *fmt, ...)
{}
1146
static inline __printf(2, 3)
1147 1148
void dev_crit(const struct device *dev, const char *fmt, ...)
{}
1149
static inline __printf(2, 3)
1150 1151
void dev_alert(const struct device *dev, const char *fmt, ...)
{}
1152
static inline __printf(2, 3)
1153 1154
void dev_err(const struct device *dev, const char *fmt, ...)
{}
1155
static inline __printf(2, 3)
1156 1157
void dev_warn(const struct device *dev, const char *fmt, ...)
{}
1158
static inline __printf(2, 3)
1159 1160
void dev_notice(const struct device *dev, const char *fmt, ...)
{}
1161
static inline __printf(2, 3)
1162 1163
void _dev_info(const struct device *dev, const char *fmt, ...)
{}
1164 1165 1166

#endif

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
/*
 * Stupid hackaround for existing uses of non-printk uses dev_info
 *
 * Note that the definition of dev_info below is actually _dev_info
 * and a macro is used to avoid redefining dev_info
 */

#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)

#if defined(CONFIG_DYNAMIC_DEBUG)
#define dev_dbg(dev, format, ...)		     \
do {						     \
	dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
} while (0)
#elif defined(DEBUG)
#define dev_dbg(dev, format, arg...)		\
	dev_printk(KERN_DEBUG, dev, format, ##arg)
#else
#define dev_dbg(dev, format, arg...)				\
({								\
	if (0)							\
		dev_printk(KERN_DEBUG, dev, format, ##arg);	\
})
#endif

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
#ifdef CONFIG_PRINTK
#define dev_level_once(dev_level, dev, fmt, ...)			\
do {									\
	static bool __print_once __read_mostly;				\
									\
	if (!__print_once) {						\
		__print_once = true;					\
		dev_level(dev, fmt, ##__VA_ARGS__);			\
	}								\
} while (0)
#else
#define dev_level_once(dev_level, dev, fmt, ...)			\
do {									\
	if (0)								\
		dev_level(dev, fmt, ##__VA_ARGS__);			\
} while (0)
#endif

#define dev_emerg_once(dev, fmt, ...)					\
	dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
#define dev_alert_once(dev, fmt, ...)					\
	dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
#define dev_crit_once(dev, fmt, ...)					\
	dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
#define dev_err_once(dev, fmt, ...)					\
	dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
#define dev_warn_once(dev, fmt, ...)					\
	dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
#define dev_notice_once(dev, fmt, ...)					\
	dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
#define dev_info_once(dev, fmt, ...)					\
	dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
#define dev_dbg_once(dev, fmt, ...)					\
J
Joe Perches 已提交
1225
	dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1226

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
#define dev_level_ratelimited(dev_level, dev, fmt, ...)			\
do {									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	if (__ratelimit(&_rs))						\
		dev_level(dev, fmt, ##__VA_ARGS__);			\
} while (0)

#define dev_emerg_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
#define dev_alert_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
#define dev_crit_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
#define dev_err_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
#define dev_warn_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
#define dev_notice_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
#define dev_info_ratelimited(dev, fmt, ...)				\
	dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1250 1251
#if defined(CONFIG_DYNAMIC_DEBUG)
/* descriptor check is first to prevent flooding with "callbacks suppressed" */
1252
#define dev_dbg_ratelimited(dev, fmt, ...)				\
1253 1254 1255 1256 1257 1258 1259
do {									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);			\
	if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&	\
	    __ratelimit(&_rs))						\
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
		__dynamic_dev_dbg(&descriptor, dev, fmt,		\
				  ##__VA_ARGS__);			\
} while (0)
#elif defined(DEBUG)
#define dev_dbg_ratelimited(dev, fmt, ...)				\
do {									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	if (__ratelimit(&_rs))						\
		dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__);	\
1271
} while (0)
L
Linus Torvalds 已提交
1272
#else
1273 1274
#define dev_dbg_ratelimited(dev, fmt, ...)			\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
L
Linus Torvalds 已提交
1275 1276
#endif

1277 1278 1279
#ifdef VERBOSE_DEBUG
#define dev_vdbg	dev_dbg
#else
1280 1281 1282 1283 1284
#define dev_vdbg(dev, format, arg...)				\
({								\
	if (0)							\
		dev_printk(KERN_DEBUG, dev, format, ##arg);	\
})
1285 1286
#endif

1287
/*
1288 1289
 * dev_WARN*() acts like dev_printk(), but with the key difference of
 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1290 1291
 */
#define dev_WARN(dev, format, arg...) \
1292
	WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1293

F
Felipe Balbi 已提交
1294
#define dev_WARN_ONCE(dev, condition, format, arg...) \
1295 1296
	WARN_ONCE(condition, "%s %s: " format, \
			dev_driver_string(dev), dev_name(dev), ## arg)
F
Felipe Balbi 已提交
1297

L
Linus Torvalds 已提交
1298 1299 1300 1301 1302
/* Create alias, so I can be autoloaded. */
#define MODULE_ALIAS_CHARDEV(major,minor) \
	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
	MODULE_ALIAS("char-major-" __stringify(major) "-*")
1303 1304 1305 1306 1307 1308 1309

#ifdef CONFIG_SYSFS_DEPRECATED
extern long sysfs_deprecated;
#else
#define sysfs_deprecated 0
#endif

1310 1311 1312 1313 1314 1315
/**
 * module_driver() - Helper macro for drivers that don't do anything
 * special in module init/exit. This eliminates a lot of boilerplate.
 * Each module may only use this macro once, and calling it replaces
 * module_init() and module_exit().
 *
1316 1317 1318
 * @__driver: driver name
 * @__register: register function for this driver type
 * @__unregister: unregister function for this driver type
1319
 * @...: Additional arguments to be passed to __register and __unregister.
1320
 *
1321 1322 1323
 * Use this macro to construct bus specific macros for registering
 * drivers, and do not use it on its own.
 */
1324
#define module_driver(__driver, __register, __unregister, ...) \
1325 1326
static int __init __driver##_init(void) \
{ \
1327
	return __register(&(__driver) , ##__VA_ARGS__); \
1328 1329 1330 1331
} \
module_init(__driver##_init); \
static void __exit __driver##_exit(void) \
{ \
1332
	__unregister(&(__driver) , ##__VA_ARGS__); \
1333 1334 1335
} \
module_exit(__driver##_exit);

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
/**
 * builtin_driver() - Helper macro for drivers that don't do anything
 * special in init and have no exit. This eliminates some boilerplate.
 * Each driver may only use this macro once, and calling it replaces
 * device_initcall (or in some cases, the legacy __initcall).  This is
 * meant to be a direct parallel of module_driver() above but without
 * the __exit stuff that is not used for builtin cases.
 *
 * @__driver: driver name
 * @__register: register function for this driver type
 * @...: Additional arguments to be passed to __register
 *
 * Use this macro to construct bus specific macros for registering
 * drivers, and do not use it on its own.
 */
#define builtin_driver(__driver, __register, ...) \
static int __init __driver##_init(void) \
{ \
	return __register(&(__driver) , ##__VA_ARGS__); \
} \
device_initcall(__driver##_init);

L
Linus Torvalds 已提交
1358
#endif /* _DEVICE_H_ */