blob: 2d0e6e541d525dd0be21dfe2dea20df7204e791a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07005 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/ioport.h>
17#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080018#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/list.h>
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -070020#include <linux/lockdep.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070021#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/types.h>
Paul Gortmakerde477252011-05-26 13:46:22 -040023#include <linux/mutex.h>
Linus Walleijab780292013-01-22 10:56:14 -070024#include <linux/pinctrl/devinfo.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/pm.h>
Arun Sharma600634972011-07-26 16:09:06 -070026#include <linux/atomic.h>
Hiroshi DOYU6ca04592012-05-14 10:47:57 +030027#include <linux/ratelimit.h>
Kay Sievers3c2670e2013-04-06 09:56:00 -070028#include <linux/uidgid.h>
Joe Perches64c862a82013-10-11 13:11:38 -070029#include <linux/gfp.h>
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +110030#include <asm/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct device;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080033struct device_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034struct device_driver;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080035struct driver_private;
Paul Gortmakerde477252011-05-26 13:46:22 -040036struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037struct class;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010038struct subsys_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010039struct bus_type;
Grant Likelyd706c1b2010-04-13 16:12:28 -070040struct device_node;
Rafael J. Wysockice793482015-03-16 23:49:03 +010041struct fwnode_handle;
Joerg Roedelff217762011-08-26 16:48:26 +020042struct iommu_ops;
Alex Williamson74416e12012-05-30 14:18:41 -060043struct iommu_group;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010044
45struct bus_attribute {
46 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080047 ssize_t (*show)(struct bus_type *bus, char *buf);
48 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010049};
50
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080051#define BUS_ATTR(_name, _mode, _show, _store) \
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -070052 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)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010057
58extern int __must_check bus_create_file(struct bus_type *,
59 struct bus_attribute *);
60extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Wanlong Gao880ffb52011-05-05 07:55:36 +080062/**
63 * struct bus_type - The bus type of the device
64 *
65 * @name: The name of the bus.
Kay Sieversca22e562011-12-14 14:29:38 -080066 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
67 * @dev_root: Default device to use as the parent.
Wanlong Gao880ffb52011-05-05 07:55:36 +080068 * @dev_attrs: Default attributes of the devices on the bus.
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -070069 * @bus_groups: Default attributes of the bus.
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -070070 * @dev_groups: Default attributes of the devices on the bus.
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -070071 * @drv_groups: Default attributes of the device drivers on the bus.
Wanlong Gao880ffb52011-05-05 07:55:36 +080072 * @match: Called, perhaps multiple times, whenever a new device or driver
73 * is added for this bus. It should return a nonzero value if the
74 * given device can be handled by the given driver.
75 * @uevent: Called when a device is added, removed, or a few other things
76 * that generate uevents to add the environment variables.
77 * @probe: Called when a new device or driver add to this bus, and callback
78 * the specific driver's probe to initial the matched device.
79 * @remove: Called when a device removed from this bus.
80 * @shutdown: Called at shut-down time to quiesce the device.
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +020081 *
82 * @online: Called to put the device back online (after offlining it).
83 * @offline: Called to put the device offline for hot-removal. May fail.
84 *
Wanlong Gao880ffb52011-05-05 07:55:36 +080085 * @suspend: Called when a device on this bus wants to go to sleep mode.
86 * @resume: Called to bring a device on this bus out of sleep mode.
87 * @pm: Power management operations of this bus, callback the specific
88 * device driver's pm-ops.
Marcos Paulo de Souza7b08fae82011-11-01 11:15:40 -070089 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
Joerg Roedelff217762011-08-26 16:48:26 +020090 * driver implementations to a bus and allow the driver to do
91 * bus-specific setup
Wanlong Gao880ffb52011-05-05 07:55:36 +080092 * @p: The private data of the driver core, only the driver core can
93 * touch this.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +020094 * @lock_key: Lock class key for use by the lock validator
Wanlong Gao880ffb52011-05-05 07:55:36 +080095 *
96 * A bus is a channel between the processor and one or more devices. For the
97 * purposes of the device model, all devices are connected via a bus, even if
98 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
99 * A USB controller is usually a PCI device, for example. The device model
100 * represents the actual connections between buses and the devices they control.
101 * A bus is represented by the bus_type structure. It contains the name, the
102 * default attributes, the bus' methods, PM operations, and the driver core's
103 * private data.
104 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800106 const char *name;
Kay Sieversca22e562011-12-14 14:29:38 -0800107 const char *dev_name;
108 struct device *dev_root;
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700109 struct device_attribute *dev_attrs; /* use dev_groups instead */
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -0700110 const struct attribute_group **bus_groups;
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700111 const struct attribute_group **dev_groups;
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -0700112 const struct attribute_group **drv_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800114 int (*match)(struct device *dev, struct device_driver *drv);
115 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
116 int (*probe)(struct device *dev);
117 int (*remove)(struct device *dev);
118 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700119
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200120 int (*online)(struct device *dev);
121 int (*offline)(struct device *dev);
122
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800123 int (*suspend)(struct device *dev, pm_message_t state);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800124 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +0100125
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700126 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200127
Thierry Redingb22f6432014-06-27 09:03:12 +0200128 const struct iommu_ops *iommu_ops;
Joerg Roedelff217762011-08-26 16:48:26 +0200129
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100130 struct subsys_private *p;
Michal Hockobe871b72013-03-12 17:21:19 +0100131 struct lock_class_key lock_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132};
133
Michal Hockobe871b72013-03-12 17:21:19 +0100134extern int __must_check bus_register(struct bus_type *bus);
135
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800136extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800138extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140/* iterator helpers for buses */
Kay Sieversca22e562011-12-14 14:29:38 -0800141struct subsys_dev_iter {
142 struct klist_iter ki;
143 const struct device_type *type;
144};
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700145void subsys_dev_iter_init(struct subsys_dev_iter *iter,
Kay Sieversca22e562011-12-14 14:29:38 -0800146 struct bus_type *subsys,
147 struct device *start,
148 const struct device_type *type);
149struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
150void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800152int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
153 int (*fn)(struct device *dev, void *data));
154struct device *bus_find_device(struct bus_type *bus, struct device *start,
155 void *data,
156 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -0800157struct device *bus_find_device_by_name(struct bus_type *bus,
158 struct device *start,
159 const char *name);
Kay Sieversca22e562011-12-14 14:29:38 -0800160struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
161 struct device *hint);
Jean Delvarecc7447a2010-06-16 11:44:18 +0200162int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
163 void *data, int (*fn)(struct device_driver *, void *));
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -0500164void bus_sort_breadthfirst(struct bus_type *bus,
165 int (*compare)(const struct device *a,
166 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000167/*
168 * Bus notifiers: Get notified of addition/removal of devices
169 * and binding/unbinding of drivers to devices.
170 * In the long run, it should be a replacement for the platform
171 * notify hooks.
172 */
173struct notifier_block;
174
175extern int bus_register_notifier(struct bus_type *bus,
176 struct notifier_block *nb);
177extern int bus_unregister_notifier(struct bus_type *bus,
178 struct notifier_block *nb);
179
180/* All 4 notifers below get called with the target struct device *
181 * as an argument. Note that those functions are likely to be called
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800182 * with the device lock held in the core, so be careful.
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000183 */
184#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
Joerg Roedel599bad32014-09-30 13:02:02 +0200185#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
186#define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
187#define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
Magnus Damm45daef02010-07-23 19:56:18 +0900188 bound */
Joerg Roedel599bad32014-09-30 13:02:02 +0200189#define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
190#define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000191 unbound */
Joerg Roedel599bad32014-09-30 13:02:02 +0200192#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
Joerg Roedel309b7d62009-04-24 14:57:00 +0200193 from the device */
Andy Shevchenko14b62572015-12-04 23:49:17 +0200194#define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000195
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700196extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700197extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700198
Wanlong Gao880ffb52011-05-05 07:55:36 +0800199/**
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700200 * enum probe_type - device driver probe type to try
201 * Device drivers may opt in for special handling of their
202 * respective probe routines. This tells the core what to
203 * expect and prefer.
204 *
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700205 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
206 * whether probed synchronously or asynchronously.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700207 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
208 * probing order is not essential for booting the system may
209 * opt into executing their probes asynchronously.
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700210 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
211 * their probe routines to run synchronously with driver and
212 * device registration (with the exception of -EPROBE_DEFER
213 * handling - re-probing always ends up being done asynchronously).
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700214 *
215 * Note that the end goal is to switch the kernel to use asynchronous
216 * probing by default, so annotating drivers with
217 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
218 * to speed up boot process while we are validating the rest of the
219 * drivers.
220 */
221enum probe_type {
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700222 PROBE_DEFAULT_STRATEGY,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700223 PROBE_PREFER_ASYNCHRONOUS,
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700224 PROBE_FORCE_SYNCHRONOUS,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700225};
226
227/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800228 * struct device_driver - The basic device driver structure
229 * @name: Name of the device driver.
230 * @bus: The bus which the device of this driver belongs to.
231 * @owner: The module owner.
232 * @mod_name: Used for built-in modules.
233 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700234 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800235 * @of_match_table: The open firmware table.
Mika Westerberg06f64c82012-10-31 22:44:33 +0100236 * @acpi_match_table: The ACPI match table.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800237 * @probe: Called to query the existence of a specific device,
238 * whether this driver can work with it, and bind the driver
239 * to a specific device.
240 * @remove: Called when the device is removed from the system to
241 * unbind a device from this driver.
242 * @shutdown: Called at shut-down time to quiesce the device.
243 * @suspend: Called to put the device to sleep mode. Usually to a
244 * low power state.
245 * @resume: Called to bring a device from sleep mode.
246 * @groups: Default attributes that get created by the driver core
247 * automatically.
248 * @pm: Power management operations of the device which matched
249 * this driver.
250 * @p: Driver core's private data, no one other than the driver
251 * core can touch this.
252 *
253 * The device driver-model tracks all of the drivers known to the system.
254 * The main reason for this tracking is to enable the driver core to match
255 * up drivers with new devices. Once drivers are known objects within the
256 * system, however, a number of other things become possible. Device drivers
257 * can export information and configuration variables that are independent
258 * of any specific device.
259 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800261 const char *name;
262 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800264 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700265 const char *mod_name; /* used for built-in modules */
266
267 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700268 enum probe_type probe_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Grant Likely597b9d12010-04-13 16:13:01 -0700270 const struct of_device_id *of_match_table;
Mika Westerberg06f64c82012-10-31 22:44:33 +0100271 const struct acpi_device_id *acpi_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700272
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800273 int (*probe) (struct device *dev);
274 int (*remove) (struct device *dev);
275 void (*shutdown) (struct device *dev);
276 int (*suspend) (struct device *dev, pm_message_t state);
277 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700278 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800279
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700280 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200281
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800282 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283};
284
285
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800286extern int __must_check driver_register(struct device_driver *drv);
287extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800289extern struct device_driver *driver_find(const char *name,
290 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700291extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800292extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100295/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800298 struct attribute attr;
299 ssize_t (*show)(struct device_driver *driver, char *buf);
300 ssize_t (*store)(struct device_driver *driver, const char *buf,
301 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302};
303
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700304#define DRIVER_ATTR(_name, _mode, _show, _store) \
305 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
306#define DRIVER_ATTR_RW(_name) \
307 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
308#define DRIVER_ATTR_RO(_name) \
309 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700310#define DRIVER_ATTR_WO(_name) \
311 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800313extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200314 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800315extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200316 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800318extern int __must_check driver_for_each_device(struct device_driver *drv,
319 struct device *start,
320 void *data,
321 int (*fn)(struct device *dev,
322 void *));
323struct device *driver_find_device(struct device_driver *drv,
324 struct device *start, void *data,
325 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800326
Wanlong Gao880ffb52011-05-05 07:55:36 +0800327/**
Kay Sieversca22e562011-12-14 14:29:38 -0800328 * struct subsys_interface - interfaces to device functions
Randy Dunlap2eda0132012-01-21 11:02:51 -0800329 * @name: name of the device function
330 * @subsys: subsytem of the devices to attach to
331 * @node: the list of functions registered at the subsystem
332 * @add_dev: device hookup to device function handler
333 * @remove_dev: device hookup to device function handler
Kay Sieversca22e562011-12-14 14:29:38 -0800334 *
335 * Simple interfaces attached to a subsystem. Multiple interfaces can
336 * attach to a subsystem and its devices. Unlike drivers, they do not
337 * exclusively claim or control devices. Interfaces usually represent
338 * a specific functionality of a subsystem/class of devices.
339 */
340struct subsys_interface {
341 const char *name;
342 struct bus_type *subsys;
343 struct list_head node;
344 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
Viresh Kumar71db87b2015-07-30 15:04:01 +0530345 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
Kay Sieversca22e562011-12-14 14:29:38 -0800346};
347
348int subsys_interface_register(struct subsys_interface *sif);
349void subsys_interface_unregister(struct subsys_interface *sif);
350
351int subsys_system_register(struct bus_type *subsys,
352 const struct attribute_group **groups);
Tejun Heod73ce002013-03-12 11:30:05 -0700353int subsys_virtual_register(struct bus_type *subsys,
354 const struct attribute_group **groups);
Kay Sieversca22e562011-12-14 14:29:38 -0800355
356/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800357 * struct class - device classes
358 * @name: Name of the class.
359 * @owner: The module owner.
360 * @class_attrs: Default attributes of this class.
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700361 * @dev_groups: Default attributes of the devices that belong to the class.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800362 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
363 * @dev_uevent: Called when a device is added, removed from this class, or a
364 * few other things that generate uevents to add the environment
365 * variables.
366 * @devnode: Callback to provide the devtmpfs.
367 * @class_release: Called to release this class.
368 * @dev_release: Called to release the device.
369 * @suspend: Used to put the device to sleep mode, usually to a low power
370 * state.
371 * @resume: Used to bring the device from the sleep mode.
372 * @ns_type: Callbacks so sysfs can detemine namespaces.
373 * @namespace: Namespace of the device belongs to this class.
374 * @pm: The default device power management operations of this class.
375 * @p: The private data of the driver core, no one other than the
376 * driver core can touch this.
377 *
378 * A class is a higher-level view of a device that abstracts out low-level
379 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
380 * at the class level, they are all simply disks. Classes allow user space
381 * to work with devices based on what they do, rather than how they are
382 * connected or how they work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 */
384struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800385 const char *name;
386 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800388 struct class_attribute *class_attrs;
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700389 const struct attribute_group **dev_groups;
Dan Williamse105b8b2008-04-21 10:51:07 -0700390 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800392 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Al Viro2c9ede52011-07-23 20:24:48 -0400393 char *(*devnode)(struct device *dev, umode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800395 void (*class_release)(struct class *class);
396 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700397
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800398 int (*suspend)(struct device *dev, pm_message_t state);
399 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200400
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700401 const struct kobj_ns_type_operations *ns_type;
402 const void *(*namespace)(struct device *dev);
403
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700404 const struct dev_pm_ops *pm;
405
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100406 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407};
408
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200409struct class_dev_iter {
410 struct klist_iter ki;
411 const struct device_type *type;
412};
413
Dan Williamse105b8b2008-04-21 10:51:07 -0700414extern struct kobject *sysfs_dev_block_kobj;
415extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700416extern int __must_check __class_register(struct class *class,
417 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800418extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700419
420/* This is a #define to keep the compiler from merging different
421 * instances of the __key variable */
422#define class_register(class) \
423({ \
424 static struct lock_class_key __key; \
425 __class_register(class, &__key); \
426})
427
Jean Delvare46227092009-08-04 12:55:34 +0200428struct class_compat;
429struct class_compat *class_compat_register(const char *name);
430void class_compat_unregister(struct class_compat *cls);
431int class_compat_create_link(struct class_compat *cls, struct device *dev,
432 struct device *device_link);
433void class_compat_remove_link(struct class_compat *cls, struct device *dev,
434 struct device *device_link);
435
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700436extern void class_dev_iter_init(struct class_dev_iter *iter,
437 struct class *class,
438 struct device *start,
439 const struct device_type *type);
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200440extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
441extern void class_dev_iter_exit(struct class_dev_iter *iter);
442
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400443extern int class_for_each_device(struct class *class, struct device *start,
444 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800445 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400446extern struct device *class_find_device(struct class *class,
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100447 struct device *start, const void *data,
448 int (*match)(struct device *, const void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800451 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100452 ssize_t (*show)(struct class *class, struct class_attribute *attr,
453 char *buf);
454 ssize_t (*store)(struct class *class, struct class_attribute *attr,
455 const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456};
457
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700458#define CLASS_ATTR(_name, _mode, _show, _store) \
459 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
460#define CLASS_ATTR_RW(_name) \
461 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
462#define CLASS_ATTR_RO(_name) \
463 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Tejun Heo58292cbe2013-09-11 22:29:04 -0400465extern int __must_check class_create_file_ns(struct class *class,
466 const struct class_attribute *attr,
467 const void *ns);
468extern void class_remove_file_ns(struct class *class,
469 const struct class_attribute *attr,
470 const void *ns);
471
472static inline int __must_check class_create_file(struct class *class,
473 const struct class_attribute *attr)
474{
475 return class_create_file_ns(class, attr, NULL);
476}
477
478static inline void class_remove_file(struct class *class,
479 const struct class_attribute *attr)
480{
481 return class_remove_file_ns(class, attr, NULL);
482}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Andi Kleen869dfc82010-01-05 12:48:08 +0100484/* Simple class attribute that is just a static string */
Andi Kleen869dfc82010-01-05 12:48:08 +0100485struct class_attribute_string {
486 struct class_attribute attr;
487 char *str;
488};
489
490/* Currently read-only only */
491#define _CLASS_ATTR_STRING(_name, _mode, _str) \
492 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
493#define CLASS_ATTR_STRING(_name, _mode, _str) \
494 struct class_attribute_string class_attr_##_name = \
495 _CLASS_ATTR_STRING(_name, _mode, _str)
496
497extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
498 char *buf);
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500struct class_interface {
501 struct list_head node;
502 struct class *class;
503
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200504 int (*add_dev) (struct device *, struct class_interface *);
505 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506};
507
Andrew Morton4a7fb632006-08-14 22:43:17 -0700508extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509extern void class_interface_unregister(struct class_interface *);
510
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700511extern struct class * __must_check __class_create(struct module *owner,
512 const char *name,
513 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800514extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800515
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700516/* This is a #define to keep the compiler from merging different
517 * instances of the __key variable */
518#define class_create(owner, name) \
519({ \
520 static struct lock_class_key __key; \
521 __class_create(owner, name, &__key); \
522})
523
Kay Sievers414264f2007-03-12 21:08:57 +0100524/*
525 * The type of device, "struct device" is embedded in. A class
526 * or bus can contain devices of different types
527 * like "partitions" and "disks", "mouse" and "event".
528 * This identifies the device type and carries type-specific
529 * information, equivalent to the kobj_type of a kobject.
530 * If "name" is specified, the uevent will contain it in
531 * the DEVTYPE variable.
532 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200533struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100534 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700535 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200536 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sievers3c2670e2013-04-06 09:56:00 -0700537 char *(*devnode)(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700538 kuid_t *uid, kgid_t *gid);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200539 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200540
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700541 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200542};
543
Kay Sieversa7fd6702005-10-01 14:49:43 +0200544/* interface for exporting device attributes */
545struct device_attribute {
546 struct attribute attr;
547 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
548 char *buf);
549 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
550 const char *buf, size_t count);
551};
552
Kay Sieversca22e562011-12-14 14:29:38 -0800553struct dev_ext_attribute {
554 struct device_attribute attr;
555 void *var;
556};
Kay Sieversa7fd6702005-10-01 14:49:43 +0200557
Kay Sieversca22e562011-12-14 14:29:38 -0800558ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
559 char *buf);
560ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
561 const char *buf, size_t count);
562ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
563 char *buf);
564ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
565 const char *buf, size_t count);
Borislav Petkov91872392012-10-09 19:52:05 +0200566ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
567 char *buf);
568ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
569 const char *buf, size_t count);
Kay Sieversca22e562011-12-14 14:29:38 -0800570
Kay Sieversa7fd6702005-10-01 14:49:43 +0200571#define DEVICE_ATTR(_name, _mode, _show, _store) \
Kay Sieversca22e562011-12-14 14:29:38 -0800572 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700573#define DEVICE_ATTR_RW(_name) \
574 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
575#define DEVICE_ATTR_RO(_name) \
576 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700577#define DEVICE_ATTR_WO(_name) \
578 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
Kay Sieversca22e562011-12-14 14:29:38 -0800579#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
580 struct dev_ext_attribute dev_attr_##_name = \
581 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
582#define DEVICE_INT_ATTR(_name, _mode, _var) \
583 struct dev_ext_attribute dev_attr_##_name = \
Michael Davidson94758182012-05-03 16:19:02 -0700584 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
Borislav Petkov91872392012-10-09 19:52:05 +0200585#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
586 struct dev_ext_attribute dev_attr_##_name = \
587 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
Alan Stern356c05d2012-05-14 13:30:03 -0400588#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
589 struct device_attribute dev_attr_##_name = \
590 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200591
Greg Kroah-Hartmanb9d4e712012-01-04 15:05:10 -0800592extern int device_create_file(struct device *device,
593 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800594extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200595 const struct device_attribute *attr);
Tejun Heo6b0afc22014-02-03 14:03:01 -0500596extern bool device_remove_file_self(struct device *dev,
597 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700598extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200599 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700600extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200601 const struct bin_attribute *attr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900602
603/* device resource management */
604typedef void (*dr_release_t)(struct device *dev, void *res);
605typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
606
607#ifdef CONFIG_DEBUG_DEVRES
Dan Williams7c683942015-10-05 20:35:55 -0400608extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
609 int nid, const char *name);
Tejun Heo9ac78492007-01-20 16:00:26 +0900610#define devres_alloc(release, size, gfp) \
Dan Williams7c683942015-10-05 20:35:55 -0400611 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
612#define devres_alloc_node(release, size, gfp, nid) \
613 __devres_alloc_node(release, size, gfp, nid, #release)
Tejun Heo9ac78492007-01-20 16:00:26 +0900614#else
Dan Williams7c683942015-10-05 20:35:55 -0400615extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
616 int nid);
617static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
618{
619 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
620}
Tejun Heo9ac78492007-01-20 16:00:26 +0900621#endif
Dan Williams7c683942015-10-05 20:35:55 -0400622
Ming Leibddb1b92012-08-04 12:01:26 +0800623extern void devres_for_each_res(struct device *dev, dr_release_t release,
624 dr_match_t match, void *match_data,
625 void (*fn)(struct device *, void *, void *),
626 void *data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900627extern void devres_free(void *res);
628extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800629extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900630 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800631extern void *devres_get(struct device *dev, void *new_res,
632 dr_match_t match, void *match_data);
633extern void *devres_remove(struct device *dev, dr_release_t release,
634 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900635extern int devres_destroy(struct device *dev, dr_release_t release,
636 dr_match_t match, void *match_data);
Mark Brownd926d0e2012-05-03 18:15:13 +0100637extern int devres_release(struct device *dev, dr_release_t release,
638 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900639
640/* devres group */
641extern void * __must_check devres_open_group(struct device *dev, void *id,
642 gfp_t gfp);
643extern void devres_close_group(struct device *dev, void *id);
644extern void devres_remove_group(struct device *dev, void *id);
645extern int devres_release_group(struct device *dev, void *id);
646
Joe Perches64c862a82013-10-11 13:11:38 -0700647/* managed devm_k.alloc/kfree for device drivers */
648extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
Nicolas Iooss8db14862015-07-17 16:23:42 -0700649extern __printf(3, 0)
650char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
651 va_list ap);
Geert Uytterhoevenbef59c52014-08-20 15:26:35 +0200652extern __printf(3, 4)
653char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
Joe Perches64c862a82013-10-11 13:11:38 -0700654static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
655{
656 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
657}
658static inline void *devm_kmalloc_array(struct device *dev,
659 size_t n, size_t size, gfp_t flags)
660{
661 if (size != 0 && n > SIZE_MAX / size)
662 return NULL;
663 return devm_kmalloc(dev, n * size, flags);
664}
665static inline void *devm_kcalloc(struct device *dev,
666 size_t n, size_t size, gfp_t flags)
667{
668 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
669}
Tejun Heo9ac78492007-01-20 16:00:26 +0900670extern void devm_kfree(struct device *dev, void *p);
Manish Badarkhee31108c2014-01-29 20:27:27 +0530671extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
Srinivas Pandruvada30463652014-04-29 00:51:00 +0100672extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
673 gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900674
Eli Billauer43339be2014-05-16 11:26:35 +0300675extern unsigned long devm_get_free_pages(struct device *dev,
676 gfp_t gfp_mask, unsigned int order);
677extern void devm_free_pages(struct device *dev, unsigned long addr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700678
Thierry Reding75096572013-01-21 11:08:54 +0100679void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200680
Dmitry Torokhovd6b0c582013-02-23 13:11:14 -0800681/* allows to add/remove a custom action to devres stack */
682int devm_add_action(struct device *dev, void (*action)(void *), void *data);
683void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
684
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800685struct device_dma_parameters {
686 /*
687 * a low level driver may set these to teach IOMMU code about
688 * sg limitations.
689 */
690 unsigned int max_segment_size;
691 unsigned long segment_boundary_mask;
692};
693
Wanlong Gao880ffb52011-05-05 07:55:36 +0800694/**
695 * struct device - The basic device structure
696 * @parent: The device's "parent" device, the device to which it is attached.
697 * In most cases, a parent device is some sort of bus or host
698 * controller. If parent is NULL, the device, is a top-level device,
699 * which is not usually what you want.
700 * @p: Holds the private data of the driver core portions of the device.
701 * See the comment of the struct device_private for detail.
702 * @kobj: A top-level, abstract class from which other classes are derived.
703 * @init_name: Initial name of the device.
704 * @type: The type of device.
705 * This identifies the device type and carries type-specific
706 * information.
707 * @mutex: Mutex to synchronize calls to its driver.
708 * @bus: Type of bus device is on.
709 * @driver: Which driver has allocated this
710 * @platform_data: Platform data specific to the device.
711 * Example: For devices on custom boards, as typical of embedded
712 * and SOC based hardware, Linux often uses platform_data to point
713 * to board-specific structures describing devices and how they
714 * are wired. That can include what ports are available, chip
715 * variants, which GPIO pins act in what additional roles, and so
716 * on. This shrinks the "Board Support Packages" (BSPs) and
717 * minimizes board-specific #ifdefs in drivers.
Jean Delvare1bb6c082014-04-14 12:54:47 +0200718 * @driver_data: Private pointer for driver specific info.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800719 * @power: For device power management.
720 * See Documentation/power/devices.txt for details.
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200721 * @pm_domain: Provide callbacks that are executed during system suspend,
Wanlong Gao880ffb52011-05-05 07:55:36 +0800722 * hibernation, system resume and during runtime PM transitions
723 * along with subsystem-level and driver-level callbacks.
Linus Walleijab780292013-01-22 10:56:14 -0700724 * @pins: For device pin management.
725 * See Documentation/pinctrl.txt for details.
Jiang Liu4a7cc832015-07-09 16:00:44 +0800726 * @msi_list: Hosts MSI descriptors
Marc Zyngierf1421db2015-07-28 14:46:10 +0100727 * @msi_domain: The generic MSI domain this device is using.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800728 * @numa_node: NUMA node this device is close to.
729 * @dma_mask: Dma mask (if dma'ble device).
730 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
731 * hardware supports 64-bit addresses for consistent allocations
732 * such descriptors.
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400733 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
Wanlong Gao880ffb52011-05-05 07:55:36 +0800734 * @dma_parms: A low level driver may set these to teach IOMMU code about
735 * segment limitations.
736 * @dma_pools: Dma pools (if dma'ble device).
737 * @dma_mem: Internal for coherent mem override.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200738 * @cma_area: Contiguous memory area for dma allocations
Wanlong Gao880ffb52011-05-05 07:55:36 +0800739 * @archdata: For arch-specific additions.
740 * @of_node: Associated device tree node.
Rafael J. Wysockice793482015-03-16 23:49:03 +0100741 * @fwnode: Associated device node supplied by platform firmware.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800742 * @devt: For creating the sysfs "dev".
Randy Dunlap2eda0132012-01-21 11:02:51 -0800743 * @id: device instance
Wanlong Gao880ffb52011-05-05 07:55:36 +0800744 * @devres_lock: Spinlock to protect the resource of the device.
745 * @devres_head: The resources list of the device.
746 * @knode_class: The node used to add the device to the class list.
747 * @class: The class of the device.
748 * @groups: Optional attribute groups.
749 * @release: Callback to free the device after all references have
750 * gone away. This should be set by the allocator of the
751 * device (i.e. the bus driver that discovered the device).
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200752 * @iommu_group: IOMMU group the device belongs to.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800753 *
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200754 * @offline_disabled: If set, the device is permanently online.
755 * @offline: Set after successful invocation of bus type's .offline().
Wanlong Gao880ffb52011-05-05 07:55:36 +0800756 *
757 * At the lowest level, every device in a Linux system is represented by an
758 * instance of struct device. The device structure contains the information
759 * that the device model core needs to model the system. Most subsystems,
760 * however, track additional information about the devices they host. As a
761 * result, it is rare for devices to be represented by bare device structures;
762 * instead, that structure, like kobject structures, is usually embedded within
763 * a higher-level representation of the device.
764 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700766 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800768 struct device_private *p;
769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700771 const char *init_name; /* initial name of the device */
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700772 const struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Thomas Gleixner31427882010-01-29 20:39:02 +0000774 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800775 * its driver.
776 */
777
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800778 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 struct device_driver *driver; /* which driver has allocated this
780 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800781 void *platform_data; /* Platform specific data, device
782 core doesn't touch it */
Jean Delvare1bb6c082014-04-14 12:54:47 +0200783 void *driver_data; /* Driver data, set and get with
784 dev_set/get_drvdata */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 struct dev_pm_info power;
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200786 struct dev_pm_domain *pm_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Marc Zyngierf1421db2015-07-28 14:46:10 +0100788#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
789 struct irq_domain *msi_domain;
790#endif
Linus Walleijab780292013-01-22 10:56:14 -0700791#ifdef CONFIG_PINCTRL
792 struct dev_pin_info *pins;
793#endif
Jiang Liu4a7cc832015-07-09 16:00:44 +0800794#ifdef CONFIG_GENERIC_MSI_IRQ
795 struct list_head msi_list;
796#endif
Linus Walleijab780292013-01-22 10:56:14 -0700797
Christoph Hellwig87348132006-12-06 20:32:33 -0800798#ifdef CONFIG_NUMA
799 int numa_node; /* NUMA node this device is close to */
800#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 u64 *dma_mask; /* dma mask (if dma'able device) */
802 u64 coherent_dma_mask;/* Like dma_mask, but for
803 alloc_coherent mappings as
804 not all hardware supports
805 64 bit addresses for consistent
806 allocations such descriptors. */
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400807 unsigned long dma_pfn_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800809 struct device_dma_parameters *dma_parms;
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 struct list_head dma_pools; /* dma pools (if dma'ble) */
812
813 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
814 override */
Marek Szyprowskia2547382013-07-29 14:31:45 +0200815#ifdef CONFIG_DMA_CMA
Marek Szyprowskic64be2b2011-12-29 13:09:51 +0100816 struct cma *cma_area; /* contiguous memory area for dma
817 allocations */
818#endif
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100819 /* arch specific additions */
820 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700821
822 struct device_node *of_node; /* associated device tree node */
Rafael J. Wysockice793482015-03-16 23:49:03 +0100823 struct fwnode_handle *fwnode; /* firmware device node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600825 dev_t devt; /* dev_t, creates the sysfs "dev" */
Kay Sieversca22e562011-12-14 14:29:38 -0800826 u32 id; /* device instance */
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600827
Tejun Heo9ac78492007-01-20 16:00:26 +0900828 spinlock_t devres_lock;
829 struct list_head devres_head;
830
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200831 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200832 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700833 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700834
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800835 void (*release)(struct device *dev);
Alex Williamson74416e12012-05-30 14:18:41 -0600836 struct iommu_group *iommu_group;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200837
838 bool offline_disabled:1;
839 bool offline:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840};
841
Lars-Peter Clausena4232962012-07-03 18:49:35 +0200842static inline struct device *kobj_to_dev(struct kobject *kobj)
843{
844 return container_of(kobj, struct device, kobj);
845}
846
Alan Stern9a3df1f2008-03-19 22:39:13 +0100847/* Get the wakeup routines, which depend on struct device */
848#include <linux/pm_wakeup.h>
849
Jean Delvarebf9ca692008-07-30 12:29:21 -0700850static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200851{
Paul Mundta636ee72010-03-09 06:57:53 +0000852 /* Use the init name until the kobject becomes available */
853 if (dev->init_name)
854 return dev->init_name;
855
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100856 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200857}
858
Joe Perchesb9075fa2011-10-31 17:11:33 -0700859extern __printf(2, 3)
860int dev_set_name(struct device *dev, const char *name, ...);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000861
Christoph Hellwig87348132006-12-06 20:32:33 -0800862#ifdef CONFIG_NUMA
863static inline int dev_to_node(struct device *dev)
864{
865 return dev->numa_node;
866}
867static inline void set_dev_node(struct device *dev, int node)
868{
869 dev->numa_node = node;
870}
871#else
872static inline int dev_to_node(struct device *dev)
873{
874 return -1;
875}
876static inline void set_dev_node(struct device *dev, int node)
877{
878}
879#endif
880
Marc Zyngierf1421db2015-07-28 14:46:10 +0100881static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
882{
883#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
884 return dev->msi_domain;
885#else
886 return NULL;
887#endif
888}
889
890static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
891{
892#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
893 dev->msi_domain = d;
894#endif
895}
896
Jean Delvarea996d012014-04-14 12:58:53 +0200897static inline void *dev_get_drvdata(const struct device *dev)
898{
899 return dev->driver_data;
900}
901
902static inline void dev_set_drvdata(struct device *dev, void *data)
903{
904 dev->driver_data = data;
905}
906
Rafael J. Wysocki5c095a02011-08-25 15:33:50 +0200907static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
908{
909 return dev ? dev->power.subsys_data : NULL;
910}
911
Ming Leif67f1292009-03-01 21:10:49 +0800912static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
913{
914 return dev->kobj.uevent_suppress;
915}
916
917static inline void dev_set_uevent_suppress(struct device *dev, int val)
918{
919 dev->kobj.uevent_suppress = val;
920}
921
Daniel Ritzd305ef52005-09-22 00:47:24 -0700922static inline int device_is_registered(struct device *dev)
923{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400924 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700925}
926
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100927static inline void device_enable_async_suspend(struct device *dev)
928{
Alan Sternf76b168b2011-06-18 20:22:23 +0200929 if (!dev->power.is_prepared)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100930 dev->power.async_suspend = true;
931}
932
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100933static inline void device_disable_async_suspend(struct device *dev)
934{
Alan Sternf76b168b2011-06-18 20:22:23 +0200935 if (!dev->power.is_prepared)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100936 dev->power.async_suspend = false;
937}
938
939static inline bool device_async_suspend_enabled(struct device *dev)
940{
941 return !!dev->power.async_suspend;
942}
943
Rafael J. Wysocki8b258cc2011-11-17 21:39:33 +0100944static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
945{
946 dev->power.ignore_children = enable;
947}
948
Rafael J. Wysockifeb70af2012-08-13 14:00:25 +0200949static inline void dev_pm_syscore_device(struct device *dev, bool val)
950{
951#ifdef CONFIG_PM_SLEEP
952 dev->power.syscore = val;
953#endif
954}
955
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800956static inline void device_lock(struct device *dev)
957{
Thomas Gleixner31427882010-01-29 20:39:02 +0000958 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800959}
960
Oliver Neukum7dd9cba2016-01-21 15:18:47 +0100961static inline int device_lock_interruptible(struct device *dev)
962{
963 return mutex_lock_interruptible(&dev->mutex);
964}
965
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800966static inline int device_trylock(struct device *dev)
967{
Thomas Gleixner31427882010-01-29 20:39:02 +0000968 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800969}
970
971static inline void device_unlock(struct device *dev)
972{
Thomas Gleixner31427882010-01-29 20:39:02 +0000973 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800974}
975
Konrad Rzeszutek Wilkac801022014-12-03 16:40:27 -0500976static inline void device_lock_assert(struct device *dev)
977{
978 lockdep_assert_held(&dev->mutex);
979}
980
Benjamin Herrenschmidte8a51e12015-02-17 19:03:41 -0600981static inline struct device_node *dev_of_node(struct device *dev)
982{
983 if (!IS_ENABLED(CONFIG_OF))
984 return NULL;
985 return dev->of_node;
986}
987
Adrian Bunk1f217822006-12-19 13:01:28 -0800988void driver_init(void);
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990/*
991 * High level routines for use by the bus drivers
992 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800993extern int __must_check device_register(struct device *dev);
994extern void device_unregister(struct device *dev);
995extern void device_initialize(struct device *dev);
996extern int __must_check device_add(struct device *dev);
997extern void device_del(struct device *dev);
998extern int device_for_each_child(struct device *dev, void *data,
999 int (*fn)(struct device *dev, void *data));
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001000extern int device_for_each_child_reverse(struct device *dev, void *data,
1001 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001002extern struct device *device_find_child(struct device *dev, void *data,
1003 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +02001004extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +01001005extern int device_move(struct device *dev, struct device *new_parent,
1006 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +02001007extern const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001008 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001009 const char **tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001011static inline bool device_supports_offline(struct device *dev)
1012{
1013 return dev->bus && dev->bus->offline && dev->bus->online;
1014}
1015
1016extern void lock_device_hotplug(void);
1017extern void unlock_device_hotplug(void);
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001018extern int lock_device_hotplug_sysfs(void);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001019extern int device_offline(struct device *dev);
1020extern int device_online(struct device *dev);
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02001021extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1022extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001025 * Root device objects for grouping under /sys/devices
1026 */
1027extern struct device *__root_device_register(const char *name,
1028 struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001029
Tejun Heo33ac1252014-01-10 08:57:31 -05001030/* This is a macro to avoid include problems with THIS_MODULE */
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001031#define root_device_register(name) \
1032 __root_device_register(name, THIS_MODULE)
1033
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001034extern void root_device_unregister(struct device *root);
1035
Mark Browna5b8b1a2009-07-17 15:06:08 +01001036static inline void *dev_get_platdata(const struct device *dev)
1037{
1038 return dev->platform_data;
1039}
1040
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001041/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 * Manual binding of a device to driver. See drivers/base/bus.c
1043 * for information on use.
1044 */
Andrew Mortonf86db392006-08-14 22:43:20 -07001045extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001046extern void device_release_driver(struct device *dev);
1047extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001048extern int __must_check driver_attach(struct device_driver *drv);
Dmitry Torokhov765230b2015-03-30 16:20:04 -07001049extern void device_initial_probe(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001050extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Tomeu Vizoso6b9cb422016-01-07 16:46:12 +01001052extern bool device_is_bound(struct device *dev);
1053
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001054/*
1055 * Easy functions for dynamically creating devices on the fly
1056 */
Nicolas Iooss8db14862015-07-17 16:23:42 -07001057extern __printf(5, 0)
1058struct device *device_create_vargs(struct class *cls, struct device *parent,
1059 dev_t devt, void *drvdata,
1060 const char *fmt, va_list vargs);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001061extern __printf(5, 6)
1062struct device *device_create(struct class *cls, struct device *parent,
1063 dev_t devt, void *drvdata,
1064 const char *fmt, ...);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001065extern __printf(6, 7)
1066struct device *device_create_with_groups(struct class *cls,
1067 struct device *parent, dev_t devt, void *drvdata,
1068 const struct attribute_group **groups,
1069 const char *fmt, ...);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001070extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072/*
1073 * Platform "fixup" functions - allow the platform to have their say
1074 * about devices and actions that the general device layer doesn't
1075 * know about.
1076 */
1077/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001078extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001080extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
1082
Wanlong Gao880ffb52011-05-05 07:55:36 +08001083/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 * get_device - atomically increment the reference count for the device.
1085 *
1086 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001087extern struct device *get_device(struct device *dev);
1088extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Kay Sievers2b2af542009-04-30 15:23:42 +02001090#ifdef CONFIG_DEVTMPFS
1091extern int devtmpfs_create_node(struct device *dev);
1092extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +01001093extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +02001094#else
1095static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1096static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1097static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1098#endif
1099
Rytchkov Alexey116f232b2006-03-22 00:58:53 +01001100/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101extern void device_shutdown(void);
1102
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -07001104extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Joe Perches99bcf212010-06-27 01:02:34 +00001106
1107#ifdef CONFIG_PRINTK
1108
Joe Perches0a18b052012-09-25 18:19:57 -07001109extern __printf(3, 0)
1110int dev_vprintk_emit(int level, const struct device *dev,
1111 const char *fmt, va_list args);
Joe Perches05e4e5b2012-09-12 20:13:37 -07001112extern __printf(3, 4)
1113int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
Joe Perches798efc62012-09-12 20:11:29 -07001114
Joe Perchesb9075fa2011-10-31 17:11:33 -07001115extern __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001116void dev_printk(const char *level, const struct device *dev,
1117 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001118extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001119void dev_emerg(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001120extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001121void dev_alert(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001122extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001123void dev_crit(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001124extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001125void dev_err(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001126extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001127void dev_warn(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001128extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001129void dev_notice(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001130extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001131void _dev_info(const struct device *dev, const char *fmt, ...);
Joe Perches99bcf212010-06-27 01:02:34 +00001132
1133#else
1134
Joe Perches0a18b052012-09-25 18:19:57 -07001135static inline __printf(3, 0)
1136int dev_vprintk_emit(int level, const struct device *dev,
1137 const char *fmt, va_list args)
Joe Perches05e4e5b2012-09-12 20:13:37 -07001138{ return 0; }
1139static inline __printf(3, 4)
1140int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1141{ return 0; }
1142
Joe Perchesd1f10522014-12-25 15:07:04 -08001143static inline void __dev_printk(const char *level, const struct device *dev,
1144 struct va_format *vaf)
1145{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001146static inline __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001147void dev_printk(const char *level, const struct device *dev,
1148 const char *fmt, ...)
1149{}
Joe Perches99bcf212010-06-27 01:02:34 +00001150
Joe Perchesb9075fa2011-10-31 17:11:33 -07001151static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001152void dev_emerg(const struct device *dev, const char *fmt, ...)
1153{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001154static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001155void dev_crit(const struct device *dev, const char *fmt, ...)
1156{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001157static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001158void dev_alert(const struct device *dev, const char *fmt, ...)
1159{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001160static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001161void dev_err(const struct device *dev, const char *fmt, ...)
1162{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001163static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001164void dev_warn(const struct device *dev, const char *fmt, ...)
1165{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001166static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001167void dev_notice(const struct device *dev, const char *fmt, ...)
1168{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001169static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001170void _dev_info(const struct device *dev, const char *fmt, ...)
1171{}
Joe Perches99bcf212010-06-27 01:02:34 +00001172
1173#endif
1174
1175/*
1176 * Stupid hackaround for existing uses of non-printk uses dev_info
1177 *
1178 * Note that the definition of dev_info below is actually _dev_info
1179 * and a macro is used to avoid redefining dev_info
1180 */
1181
1182#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -05001183
Jim Cromieb558c962011-12-19 17:11:18 -05001184#if defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +00001185#define dev_dbg(dev, format, ...) \
1186do { \
Jason Baron346e15b2008-08-12 16:46:19 -04001187 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +00001188} while (0)
Jim Cromieb558c962011-12-19 17:11:18 -05001189#elif defined(DEBUG)
1190#define dev_dbg(dev, format, arg...) \
1191 dev_printk(KERN_DEBUG, dev, format, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192#else
Joe Perches99bcf212010-06-27 01:02:34 +00001193#define dev_dbg(dev, format, arg...) \
1194({ \
1195 if (0) \
1196 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001197})
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198#endif
1199
Joe Perchese1353032014-11-17 18:18:22 -08001200#ifdef CONFIG_PRINTK
1201#define dev_level_once(dev_level, dev, fmt, ...) \
1202do { \
1203 static bool __print_once __read_mostly; \
1204 \
1205 if (!__print_once) { \
1206 __print_once = true; \
1207 dev_level(dev, fmt, ##__VA_ARGS__); \
1208 } \
1209} while (0)
1210#else
1211#define dev_level_once(dev_level, dev, fmt, ...) \
1212do { \
1213 if (0) \
1214 dev_level(dev, fmt, ##__VA_ARGS__); \
1215} while (0)
1216#endif
1217
1218#define dev_emerg_once(dev, fmt, ...) \
1219 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1220#define dev_alert_once(dev, fmt, ...) \
1221 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1222#define dev_crit_once(dev, fmt, ...) \
1223 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1224#define dev_err_once(dev, fmt, ...) \
1225 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1226#define dev_warn_once(dev, fmt, ...) \
1227 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1228#define dev_notice_once(dev, fmt, ...) \
1229 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1230#define dev_info_once(dev, fmt, ...) \
1231 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1232#define dev_dbg_once(dev, fmt, ...) \
Joe Perchesa2a15d52015-01-03 09:51:33 -08001233 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
Joe Perchese1353032014-11-17 18:18:22 -08001234
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001235#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1236do { \
1237 static DEFINE_RATELIMIT_STATE(_rs, \
1238 DEFAULT_RATELIMIT_INTERVAL, \
1239 DEFAULT_RATELIMIT_BURST); \
1240 if (__ratelimit(&_rs)) \
1241 dev_level(dev, fmt, ##__VA_ARGS__); \
1242} while (0)
1243
1244#define dev_emerg_ratelimited(dev, fmt, ...) \
1245 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1246#define dev_alert_ratelimited(dev, fmt, ...) \
1247 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1248#define dev_crit_ratelimited(dev, fmt, ...) \
1249 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1250#define dev_err_ratelimited(dev, fmt, ...) \
1251 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1252#define dev_warn_ratelimited(dev, fmt, ...) \
1253 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1254#define dev_notice_ratelimited(dev, fmt, ...) \
1255 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1256#define dev_info_ratelimited(dev, fmt, ...) \
1257 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001258#if defined(CONFIG_DYNAMIC_DEBUG)
1259/* descriptor check is first to prevent flooding with "callbacks suppressed" */
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001260#define dev_dbg_ratelimited(dev, fmt, ...) \
1261do { \
1262 static DEFINE_RATELIMIT_STATE(_rs, \
1263 DEFAULT_RATELIMIT_INTERVAL, \
1264 DEFAULT_RATELIMIT_BURST); \
1265 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1266 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1267 __ratelimit(&_rs)) \
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001268 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1269 ##__VA_ARGS__); \
1270} while (0)
1271#elif defined(DEBUG)
1272#define dev_dbg_ratelimited(dev, fmt, ...) \
1273do { \
1274 static DEFINE_RATELIMIT_STATE(_rs, \
1275 DEFAULT_RATELIMIT_INTERVAL, \
1276 DEFAULT_RATELIMIT_BURST); \
1277 if (__ratelimit(&_rs)) \
1278 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001279} while (0)
1280#else
1281#define dev_dbg_ratelimited(dev, fmt, ...) \
1282 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1283#endif
1284
David Brownellaebdc3b2007-07-12 22:08:22 -07001285#ifdef VERBOSE_DEBUG
1286#define dev_vdbg dev_dbg
1287#else
Joe Perches99bcf212010-06-27 01:02:34 +00001288#define dev_vdbg(dev, format, arg...) \
1289({ \
1290 if (0) \
1291 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001292})
David Brownellaebdc3b2007-07-12 22:08:22 -07001293#endif
1294
Arjan van de Vene6139662008-09-20 19:08:39 -07001295/*
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001296 * dev_WARN*() acts like dev_printk(), but with the key difference of
1297 * using WARN/WARN_ONCE to include file/line information and a backtrace.
Arjan van de Vene6139662008-09-20 19:08:39 -07001298 */
1299#define dev_WARN(dev, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001300 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
Arjan van de Vene6139662008-09-20 19:08:39 -07001301
Felipe Balbibcdd3232011-03-16 15:59:35 +02001302#define dev_WARN_ONCE(dev, condition, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001303 WARN_ONCE(condition, "%s %s: " format, \
1304 dev_driver_string(dev), dev_name(dev), ## arg)
Felipe Balbibcdd3232011-03-16 15:59:35 +02001305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306/* Create alias, so I can be autoloaded. */
1307#define MODULE_ALIAS_CHARDEV(major,minor) \
1308 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1309#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1310 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +02001311
1312#ifdef CONFIG_SYSFS_DEPRECATED
1313extern long sysfs_deprecated;
1314#else
1315#define sysfs_deprecated 0
1316#endif
1317
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001318/**
1319 * module_driver() - Helper macro for drivers that don't do anything
1320 * special in module init/exit. This eliminates a lot of boilerplate.
1321 * Each module may only use this macro once, and calling it replaces
1322 * module_init() and module_exit().
1323 *
Randy Dunlap2eda0132012-01-21 11:02:51 -08001324 * @__driver: driver name
1325 * @__register: register function for this driver type
1326 * @__unregister: unregister function for this driver type
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001327 * @...: Additional arguments to be passed to __register and __unregister.
Randy Dunlap2eda0132012-01-21 11:02:51 -08001328 *
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001329 * Use this macro to construct bus specific macros for registering
1330 * drivers, and do not use it on its own.
1331 */
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001332#define module_driver(__driver, __register, __unregister, ...) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001333static int __init __driver##_init(void) \
1334{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001335 return __register(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001336} \
1337module_init(__driver##_init); \
1338static void __exit __driver##_exit(void) \
1339{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001340 __unregister(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001341} \
1342module_exit(__driver##_exit);
1343
Paul Gortmakerf309d442015-05-01 20:10:57 -04001344/**
1345 * builtin_driver() - Helper macro for drivers that don't do anything
1346 * special in init and have no exit. This eliminates some boilerplate.
1347 * Each driver may only use this macro once, and calling it replaces
1348 * device_initcall (or in some cases, the legacy __initcall). This is
1349 * meant to be a direct parallel of module_driver() above but without
1350 * the __exit stuff that is not used for builtin cases.
1351 *
1352 * @__driver: driver name
1353 * @__register: register function for this driver type
1354 * @...: Additional arguments to be passed to __register
1355 *
1356 * Use this macro to construct bus specific macros for registering
1357 * drivers, and do not use it on its own.
1358 */
1359#define builtin_driver(__driver, __register, ...) \
1360static int __init __driver##_init(void) \
1361{ \
1362 return __register(&(__driver) , ##__VA_ARGS__); \
1363} \
1364device_initcall(__driver##_init);
1365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366#endif /* _DEVICE_H_ */