blob: b8f411b57dcb2c77fcaee7194fd439b739bf1e04 [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 Souza7b08fae2011-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 */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000194
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700195extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700196extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700197
Wanlong Gao880ffb52011-05-05 07:55:36 +0800198/**
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700199 * enum probe_type - device driver probe type to try
200 * Device drivers may opt in for special handling of their
201 * respective probe routines. This tells the core what to
202 * expect and prefer.
203 *
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700204 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
205 * whether probed synchronously or asynchronously.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700206 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
207 * probing order is not essential for booting the system may
208 * opt into executing their probes asynchronously.
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700209 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
210 * their probe routines to run synchronously with driver and
211 * device registration (with the exception of -EPROBE_DEFER
212 * handling - re-probing always ends up being done asynchronously).
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700213 *
214 * Note that the end goal is to switch the kernel to use asynchronous
215 * probing by default, so annotating drivers with
216 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
217 * to speed up boot process while we are validating the rest of the
218 * drivers.
219 */
220enum probe_type {
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700221 PROBE_DEFAULT_STRATEGY,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700222 PROBE_PREFER_ASYNCHRONOUS,
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700223 PROBE_FORCE_SYNCHRONOUS,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700224};
225
226/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800227 * struct device_driver - The basic device driver structure
228 * @name: Name of the device driver.
229 * @bus: The bus which the device of this driver belongs to.
230 * @owner: The module owner.
231 * @mod_name: Used for built-in modules.
232 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700233 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800234 * @of_match_table: The open firmware table.
Mika Westerberg06f64c82012-10-31 22:44:33 +0100235 * @acpi_match_table: The ACPI match table.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800236 * @probe: Called to query the existence of a specific device,
237 * whether this driver can work with it, and bind the driver
238 * to a specific device.
239 * @remove: Called when the device is removed from the system to
240 * unbind a device from this driver.
241 * @shutdown: Called at shut-down time to quiesce the device.
242 * @suspend: Called to put the device to sleep mode. Usually to a
243 * low power state.
244 * @resume: Called to bring a device from sleep mode.
245 * @groups: Default attributes that get created by the driver core
246 * automatically.
247 * @pm: Power management operations of the device which matched
248 * this driver.
249 * @p: Driver core's private data, no one other than the driver
250 * core can touch this.
251 *
252 * The device driver-model tracks all of the drivers known to the system.
253 * The main reason for this tracking is to enable the driver core to match
254 * up drivers with new devices. Once drivers are known objects within the
255 * system, however, a number of other things become possible. Device drivers
256 * can export information and configuration variables that are independent
257 * of any specific device.
258 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800260 const char *name;
261 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800263 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700264 const char *mod_name; /* used for built-in modules */
265
266 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700267 enum probe_type probe_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Grant Likely597b9d12010-04-13 16:13:01 -0700269 const struct of_device_id *of_match_table;
Mika Westerberg06f64c82012-10-31 22:44:33 +0100270 const struct acpi_device_id *acpi_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700271
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800272 int (*probe) (struct device *dev);
273 int (*remove) (struct device *dev);
274 void (*shutdown) (struct device *dev);
275 int (*suspend) (struct device *dev, pm_message_t state);
276 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700277 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800278
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700279 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200280
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800281 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282};
283
284
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800285extern int __must_check driver_register(struct device_driver *drv);
286extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800288extern struct device_driver *driver_find(const char *name,
289 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700290extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800291extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100294/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800297 struct attribute attr;
298 ssize_t (*show)(struct device_driver *driver, char *buf);
299 ssize_t (*store)(struct device_driver *driver, const char *buf,
300 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301};
302
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700303#define DRIVER_ATTR(_name, _mode, _show, _store) \
304 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
305#define DRIVER_ATTR_RW(_name) \
306 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
307#define DRIVER_ATTR_RO(_name) \
308 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700309#define DRIVER_ATTR_WO(_name) \
310 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800312extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200313 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800314extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200315 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800317extern int __must_check driver_for_each_device(struct device_driver *drv,
318 struct device *start,
319 void *data,
320 int (*fn)(struct device *dev,
321 void *));
322struct device *driver_find_device(struct device_driver *drv,
323 struct device *start, void *data,
324 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800325
Wanlong Gao880ffb52011-05-05 07:55:36 +0800326/**
Kay Sieversca22e562011-12-14 14:29:38 -0800327 * struct subsys_interface - interfaces to device functions
Randy Dunlap2eda0132012-01-21 11:02:51 -0800328 * @name: name of the device function
329 * @subsys: subsytem of the devices to attach to
330 * @node: the list of functions registered at the subsystem
331 * @add_dev: device hookup to device function handler
332 * @remove_dev: device hookup to device function handler
Kay Sieversca22e562011-12-14 14:29:38 -0800333 *
334 * Simple interfaces attached to a subsystem. Multiple interfaces can
335 * attach to a subsystem and its devices. Unlike drivers, they do not
336 * exclusively claim or control devices. Interfaces usually represent
337 * a specific functionality of a subsystem/class of devices.
338 */
339struct subsys_interface {
340 const char *name;
341 struct bus_type *subsys;
342 struct list_head node;
343 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
Viresh Kumar71db87b2015-07-30 15:04:01 +0530344 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
Kay Sieversca22e562011-12-14 14:29:38 -0800345};
346
347int subsys_interface_register(struct subsys_interface *sif);
348void subsys_interface_unregister(struct subsys_interface *sif);
349
350int subsys_system_register(struct bus_type *subsys,
351 const struct attribute_group **groups);
Tejun Heod73ce002013-03-12 11:30:05 -0700352int subsys_virtual_register(struct bus_type *subsys,
353 const struct attribute_group **groups);
Kay Sieversca22e562011-12-14 14:29:38 -0800354
355/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800356 * struct class - device classes
357 * @name: Name of the class.
358 * @owner: The module owner.
359 * @class_attrs: Default attributes of this class.
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700360 * @dev_groups: Default attributes of the devices that belong to the class.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800361 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
362 * @dev_uevent: Called when a device is added, removed from this class, or a
363 * few other things that generate uevents to add the environment
364 * variables.
365 * @devnode: Callback to provide the devtmpfs.
366 * @class_release: Called to release this class.
367 * @dev_release: Called to release the device.
368 * @suspend: Used to put the device to sleep mode, usually to a low power
369 * state.
370 * @resume: Used to bring the device from the sleep mode.
371 * @ns_type: Callbacks so sysfs can detemine namespaces.
372 * @namespace: Namespace of the device belongs to this class.
373 * @pm: The default device power management operations of this class.
374 * @p: The private data of the driver core, no one other than the
375 * driver core can touch this.
376 *
377 * A class is a higher-level view of a device that abstracts out low-level
378 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
379 * at the class level, they are all simply disks. Classes allow user space
380 * to work with devices based on what they do, rather than how they are
381 * connected or how they work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 */
383struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800384 const char *name;
385 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800387 struct class_attribute *class_attrs;
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700388 const struct attribute_group **dev_groups;
Dan Williamse105b8b2008-04-21 10:51:07 -0700389 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800391 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Al Viro2c9ede52011-07-23 20:24:48 -0400392 char *(*devnode)(struct device *dev, umode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800394 void (*class_release)(struct class *class);
395 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700396
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800397 int (*suspend)(struct device *dev, pm_message_t state);
398 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200399
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700400 const struct kobj_ns_type_operations *ns_type;
401 const void *(*namespace)(struct device *dev);
402
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700403 const struct dev_pm_ops *pm;
404
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100405 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406};
407
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200408struct class_dev_iter {
409 struct klist_iter ki;
410 const struct device_type *type;
411};
412
Dan Williamse105b8b2008-04-21 10:51:07 -0700413extern struct kobject *sysfs_dev_block_kobj;
414extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700415extern int __must_check __class_register(struct class *class,
416 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800417extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700418
419/* This is a #define to keep the compiler from merging different
420 * instances of the __key variable */
421#define class_register(class) \
422({ \
423 static struct lock_class_key __key; \
424 __class_register(class, &__key); \
425})
426
Jean Delvare46227092009-08-04 12:55:34 +0200427struct class_compat;
428struct class_compat *class_compat_register(const char *name);
429void class_compat_unregister(struct class_compat *cls);
430int class_compat_create_link(struct class_compat *cls, struct device *dev,
431 struct device *device_link);
432void class_compat_remove_link(struct class_compat *cls, struct device *dev,
433 struct device *device_link);
434
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700435extern void class_dev_iter_init(struct class_dev_iter *iter,
436 struct class *class,
437 struct device *start,
438 const struct device_type *type);
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200439extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
440extern void class_dev_iter_exit(struct class_dev_iter *iter);
441
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400442extern int class_for_each_device(struct class *class, struct device *start,
443 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800444 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400445extern struct device *class_find_device(struct class *class,
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100446 struct device *start, const void *data,
447 int (*match)(struct device *, const void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800450 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100451 ssize_t (*show)(struct class *class, struct class_attribute *attr,
452 char *buf);
453 ssize_t (*store)(struct class *class, struct class_attribute *attr,
454 const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455};
456
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700457#define CLASS_ATTR(_name, _mode, _show, _store) \
458 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
459#define CLASS_ATTR_RW(_name) \
460 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
461#define CLASS_ATTR_RO(_name) \
462 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Tejun Heo58292cbe2013-09-11 22:29:04 -0400464extern int __must_check class_create_file_ns(struct class *class,
465 const struct class_attribute *attr,
466 const void *ns);
467extern void class_remove_file_ns(struct class *class,
468 const struct class_attribute *attr,
469 const void *ns);
470
471static inline int __must_check class_create_file(struct class *class,
472 const struct class_attribute *attr)
473{
474 return class_create_file_ns(class, attr, NULL);
475}
476
477static inline void class_remove_file(struct class *class,
478 const struct class_attribute *attr)
479{
480 return class_remove_file_ns(class, attr, NULL);
481}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Andi Kleen869dfc82010-01-05 12:48:08 +0100483/* Simple class attribute that is just a static string */
Andi Kleen869dfc82010-01-05 12:48:08 +0100484struct class_attribute_string {
485 struct class_attribute attr;
486 char *str;
487};
488
489/* Currently read-only only */
490#define _CLASS_ATTR_STRING(_name, _mode, _str) \
491 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
492#define CLASS_ATTR_STRING(_name, _mode, _str) \
493 struct class_attribute_string class_attr_##_name = \
494 _CLASS_ATTR_STRING(_name, _mode, _str)
495
496extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
497 char *buf);
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499struct class_interface {
500 struct list_head node;
501 struct class *class;
502
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200503 int (*add_dev) (struct device *, struct class_interface *);
504 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
Andrew Morton4a7fb632006-08-14 22:43:17 -0700507extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508extern void class_interface_unregister(struct class_interface *);
509
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700510extern struct class * __must_check __class_create(struct module *owner,
511 const char *name,
512 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800513extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800514
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700515/* This is a #define to keep the compiler from merging different
516 * instances of the __key variable */
517#define class_create(owner, name) \
518({ \
519 static struct lock_class_key __key; \
520 __class_create(owner, name, &__key); \
521})
522
Kay Sievers414264f2007-03-12 21:08:57 +0100523/*
524 * The type of device, "struct device" is embedded in. A class
525 * or bus can contain devices of different types
526 * like "partitions" and "disks", "mouse" and "event".
527 * This identifies the device type and carries type-specific
528 * information, equivalent to the kobj_type of a kobject.
529 * If "name" is specified, the uevent will contain it in
530 * the DEVTYPE variable.
531 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200532struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100533 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700534 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200535 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sievers3c2670e2013-04-06 09:56:00 -0700536 char *(*devnode)(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700537 kuid_t *uid, kgid_t *gid);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200538 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200539
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700540 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200541};
542
Kay Sieversa7fd6702005-10-01 14:49:43 +0200543/* interface for exporting device attributes */
544struct device_attribute {
545 struct attribute attr;
546 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
547 char *buf);
548 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
549 const char *buf, size_t count);
550};
551
Kay Sieversca22e562011-12-14 14:29:38 -0800552struct dev_ext_attribute {
553 struct device_attribute attr;
554 void *var;
555};
Kay Sieversa7fd6702005-10-01 14:49:43 +0200556
Kay Sieversca22e562011-12-14 14:29:38 -0800557ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
558 char *buf);
559ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
560 const char *buf, size_t count);
561ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
562 char *buf);
563ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
564 const char *buf, size_t count);
Borislav Petkov91872392012-10-09 19:52:05 +0200565ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
566 char *buf);
567ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
568 const char *buf, size_t count);
Kay Sieversca22e562011-12-14 14:29:38 -0800569
Kay Sieversa7fd6702005-10-01 14:49:43 +0200570#define DEVICE_ATTR(_name, _mode, _show, _store) \
Kay Sieversca22e562011-12-14 14:29:38 -0800571 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700572#define DEVICE_ATTR_RW(_name) \
573 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
574#define DEVICE_ATTR_RO(_name) \
575 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700576#define DEVICE_ATTR_WO(_name) \
577 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
Kay Sieversca22e562011-12-14 14:29:38 -0800578#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
579 struct dev_ext_attribute dev_attr_##_name = \
580 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
581#define DEVICE_INT_ATTR(_name, _mode, _var) \
582 struct dev_ext_attribute dev_attr_##_name = \
Michael Davidson94758182012-05-03 16:19:02 -0700583 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
Borislav Petkov91872392012-10-09 19:52:05 +0200584#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
585 struct dev_ext_attribute dev_attr_##_name = \
586 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
Alan Stern356c05d2012-05-14 13:30:03 -0400587#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
588 struct device_attribute dev_attr_##_name = \
589 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200590
Greg Kroah-Hartmanb9d4e712012-01-04 15:05:10 -0800591extern int device_create_file(struct device *device,
592 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800593extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200594 const struct device_attribute *attr);
Tejun Heo6b0afc22014-02-03 14:03:01 -0500595extern bool device_remove_file_self(struct device *dev,
596 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700597extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200598 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700599extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200600 const struct bin_attribute *attr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900601
602/* device resource management */
603typedef void (*dr_release_t)(struct device *dev, void *res);
604typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
605
606#ifdef CONFIG_DEBUG_DEVRES
Dan Williams7c683942015-10-05 20:35:55 -0400607extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
608 int nid, const char *name);
Tejun Heo9ac78492007-01-20 16:00:26 +0900609#define devres_alloc(release, size, gfp) \
Dan Williams7c683942015-10-05 20:35:55 -0400610 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
611#define devres_alloc_node(release, size, gfp, nid) \
612 __devres_alloc_node(release, size, gfp, nid, #release)
Tejun Heo9ac78492007-01-20 16:00:26 +0900613#else
Dan Williams7c683942015-10-05 20:35:55 -0400614extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
615 int nid);
616static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
617{
618 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
619}
Tejun Heo9ac78492007-01-20 16:00:26 +0900620#endif
Dan Williams7c683942015-10-05 20:35:55 -0400621
Ming Leibddb1b92012-08-04 12:01:26 +0800622extern void devres_for_each_res(struct device *dev, dr_release_t release,
623 dr_match_t match, void *match_data,
624 void (*fn)(struct device *, void *, void *),
625 void *data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900626extern void devres_free(void *res);
627extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800628extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900629 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800630extern void *devres_get(struct device *dev, void *new_res,
631 dr_match_t match, void *match_data);
632extern void *devres_remove(struct device *dev, dr_release_t release,
633 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900634extern int devres_destroy(struct device *dev, dr_release_t release,
635 dr_match_t match, void *match_data);
Mark Brownd926d0e2012-05-03 18:15:13 +0100636extern int devres_release(struct device *dev, dr_release_t release,
637 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900638
639/* devres group */
640extern void * __must_check devres_open_group(struct device *dev, void *id,
641 gfp_t gfp);
642extern void devres_close_group(struct device *dev, void *id);
643extern void devres_remove_group(struct device *dev, void *id);
644extern int devres_release_group(struct device *dev, void *id);
645
Joe Perches64c862a82013-10-11 13:11:38 -0700646/* managed devm_k.alloc/kfree for device drivers */
647extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
Nicolas Iooss8db14862015-07-17 16:23:42 -0700648extern __printf(3, 0)
649char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
650 va_list ap);
Geert Uytterhoevenbef59c52014-08-20 15:26:35 +0200651extern __printf(3, 4)
652char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
Joe Perches64c862a82013-10-11 13:11:38 -0700653static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
654{
655 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
656}
657static inline void *devm_kmalloc_array(struct device *dev,
658 size_t n, size_t size, gfp_t flags)
659{
660 if (size != 0 && n > SIZE_MAX / size)
661 return NULL;
662 return devm_kmalloc(dev, n * size, flags);
663}
664static inline void *devm_kcalloc(struct device *dev,
665 size_t n, size_t size, gfp_t flags)
666{
667 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
668}
Tejun Heo9ac78492007-01-20 16:00:26 +0900669extern void devm_kfree(struct device *dev, void *p);
Manish Badarkhee31108c2014-01-29 20:27:27 +0530670extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
Srinivas Pandruvada30463652014-04-29 00:51:00 +0100671extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
672 gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900673
Eli Billauer43339be2014-05-16 11:26:35 +0300674extern unsigned long devm_get_free_pages(struct device *dev,
675 gfp_t gfp_mask, unsigned int order);
676extern void devm_free_pages(struct device *dev, unsigned long addr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700677
Thierry Reding75096572013-01-21 11:08:54 +0100678void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200679
Dmitry Torokhovd6b0c582013-02-23 13:11:14 -0800680/* allows to add/remove a custom action to devres stack */
681int devm_add_action(struct device *dev, void (*action)(void *), void *data);
682void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
683
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800684struct device_dma_parameters {
685 /*
686 * a low level driver may set these to teach IOMMU code about
687 * sg limitations.
688 */
689 unsigned int max_segment_size;
690 unsigned long segment_boundary_mask;
691};
692
Wanlong Gao880ffb52011-05-05 07:55:36 +0800693/**
694 * struct device - The basic device structure
695 * @parent: The device's "parent" device, the device to which it is attached.
696 * In most cases, a parent device is some sort of bus or host
697 * controller. If parent is NULL, the device, is a top-level device,
698 * which is not usually what you want.
699 * @p: Holds the private data of the driver core portions of the device.
700 * See the comment of the struct device_private for detail.
701 * @kobj: A top-level, abstract class from which other classes are derived.
702 * @init_name: Initial name of the device.
703 * @type: The type of device.
704 * This identifies the device type and carries type-specific
705 * information.
706 * @mutex: Mutex to synchronize calls to its driver.
707 * @bus: Type of bus device is on.
708 * @driver: Which driver has allocated this
709 * @platform_data: Platform data specific to the device.
710 * Example: For devices on custom boards, as typical of embedded
711 * and SOC based hardware, Linux often uses platform_data to point
712 * to board-specific structures describing devices and how they
713 * are wired. That can include what ports are available, chip
714 * variants, which GPIO pins act in what additional roles, and so
715 * on. This shrinks the "Board Support Packages" (BSPs) and
716 * minimizes board-specific #ifdefs in drivers.
Jean Delvare1bb6c082014-04-14 12:54:47 +0200717 * @driver_data: Private pointer for driver specific info.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800718 * @power: For device power management.
719 * See Documentation/power/devices.txt for details.
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200720 * @pm_domain: Provide callbacks that are executed during system suspend,
Wanlong Gao880ffb52011-05-05 07:55:36 +0800721 * hibernation, system resume and during runtime PM transitions
722 * along with subsystem-level and driver-level callbacks.
Linus Walleijab780292013-01-22 10:56:14 -0700723 * @pins: For device pin management.
724 * See Documentation/pinctrl.txt for details.
Jiang Liu4a7cc832015-07-09 16:00:44 +0800725 * @msi_list: Hosts MSI descriptors
Marc Zyngierf1421db2015-07-28 14:46:10 +0100726 * @msi_domain: The generic MSI domain this device is using.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800727 * @numa_node: NUMA node this device is close to.
728 * @dma_mask: Dma mask (if dma'ble device).
729 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
730 * hardware supports 64-bit addresses for consistent allocations
731 * such descriptors.
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400732 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
Wanlong Gao880ffb52011-05-05 07:55:36 +0800733 * @dma_parms: A low level driver may set these to teach IOMMU code about
734 * segment limitations.
735 * @dma_pools: Dma pools (if dma'ble device).
736 * @dma_mem: Internal for coherent mem override.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200737 * @cma_area: Contiguous memory area for dma allocations
Wanlong Gao880ffb52011-05-05 07:55:36 +0800738 * @archdata: For arch-specific additions.
739 * @of_node: Associated device tree node.
Rafael J. Wysockice793482015-03-16 23:49:03 +0100740 * @fwnode: Associated device node supplied by platform firmware.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800741 * @devt: For creating the sysfs "dev".
Randy Dunlap2eda0132012-01-21 11:02:51 -0800742 * @id: device instance
Wanlong Gao880ffb52011-05-05 07:55:36 +0800743 * @devres_lock: Spinlock to protect the resource of the device.
744 * @devres_head: The resources list of the device.
745 * @knode_class: The node used to add the device to the class list.
746 * @class: The class of the device.
747 * @groups: Optional attribute groups.
748 * @release: Callback to free the device after all references have
749 * gone away. This should be set by the allocator of the
750 * device (i.e. the bus driver that discovered the device).
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200751 * @iommu_group: IOMMU group the device belongs to.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800752 *
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200753 * @offline_disabled: If set, the device is permanently online.
754 * @offline: Set after successful invocation of bus type's .offline().
Wanlong Gao880ffb52011-05-05 07:55:36 +0800755 *
756 * At the lowest level, every device in a Linux system is represented by an
757 * instance of struct device. The device structure contains the information
758 * that the device model core needs to model the system. Most subsystems,
759 * however, track additional information about the devices they host. As a
760 * result, it is rare for devices to be represented by bare device structures;
761 * instead, that structure, like kobject structures, is usually embedded within
762 * a higher-level representation of the device.
763 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700765 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800767 struct device_private *p;
768
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700770 const char *init_name; /* initial name of the device */
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700771 const struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Thomas Gleixner31427882010-01-29 20:39:02 +0000773 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800774 * its driver.
775 */
776
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800777 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 struct device_driver *driver; /* which driver has allocated this
779 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800780 void *platform_data; /* Platform specific data, device
781 core doesn't touch it */
Jean Delvare1bb6c082014-04-14 12:54:47 +0200782 void *driver_data; /* Driver data, set and get with
783 dev_set/get_drvdata */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 struct dev_pm_info power;
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200785 struct dev_pm_domain *pm_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Marc Zyngierf1421db2015-07-28 14:46:10 +0100787#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
788 struct irq_domain *msi_domain;
789#endif
Linus Walleijab780292013-01-22 10:56:14 -0700790#ifdef CONFIG_PINCTRL
791 struct dev_pin_info *pins;
792#endif
Jiang Liu4a7cc832015-07-09 16:00:44 +0800793#ifdef CONFIG_GENERIC_MSI_IRQ
794 struct list_head msi_list;
795#endif
Linus Walleijab780292013-01-22 10:56:14 -0700796
Christoph Hellwig87348132006-12-06 20:32:33 -0800797#ifdef CONFIG_NUMA
798 int numa_node; /* NUMA node this device is close to */
799#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 u64 *dma_mask; /* dma mask (if dma'able device) */
801 u64 coherent_dma_mask;/* Like dma_mask, but for
802 alloc_coherent mappings as
803 not all hardware supports
804 64 bit addresses for consistent
805 allocations such descriptors. */
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400806 unsigned long dma_pfn_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800808 struct device_dma_parameters *dma_parms;
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 struct list_head dma_pools; /* dma pools (if dma'ble) */
811
812 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
813 override */
Marek Szyprowskia2547382013-07-29 14:31:45 +0200814#ifdef CONFIG_DMA_CMA
Marek Szyprowskic64be2b2011-12-29 13:09:51 +0100815 struct cma *cma_area; /* contiguous memory area for dma
816 allocations */
817#endif
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100818 /* arch specific additions */
819 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700820
821 struct device_node *of_node; /* associated device tree node */
Rafael J. Wysockice793482015-03-16 23:49:03 +0100822 struct fwnode_handle *fwnode; /* firmware device node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600824 dev_t devt; /* dev_t, creates the sysfs "dev" */
Kay Sieversca22e562011-12-14 14:29:38 -0800825 u32 id; /* device instance */
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600826
Tejun Heo9ac78492007-01-20 16:00:26 +0900827 spinlock_t devres_lock;
828 struct list_head devres_head;
829
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200830 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200831 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700832 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700833
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800834 void (*release)(struct device *dev);
Alex Williamson74416e12012-05-30 14:18:41 -0600835 struct iommu_group *iommu_group;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200836
837 bool offline_disabled:1;
838 bool offline:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839};
840
Lars-Peter Clausena4232962012-07-03 18:49:35 +0200841static inline struct device *kobj_to_dev(struct kobject *kobj)
842{
843 return container_of(kobj, struct device, kobj);
844}
845
Alan Stern9a3df1f2008-03-19 22:39:13 +0100846/* Get the wakeup routines, which depend on struct device */
847#include <linux/pm_wakeup.h>
848
Jean Delvarebf9ca692008-07-30 12:29:21 -0700849static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200850{
Paul Mundta636ee72010-03-09 06:57:53 +0000851 /* Use the init name until the kobject becomes available */
852 if (dev->init_name)
853 return dev->init_name;
854
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100855 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200856}
857
Joe Perchesb9075fa2011-10-31 17:11:33 -0700858extern __printf(2, 3)
859int dev_set_name(struct device *dev, const char *name, ...);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000860
Christoph Hellwig87348132006-12-06 20:32:33 -0800861#ifdef CONFIG_NUMA
862static inline int dev_to_node(struct device *dev)
863{
864 return dev->numa_node;
865}
866static inline void set_dev_node(struct device *dev, int node)
867{
868 dev->numa_node = node;
869}
870#else
871static inline int dev_to_node(struct device *dev)
872{
873 return -1;
874}
875static inline void set_dev_node(struct device *dev, int node)
876{
877}
878#endif
879
Marc Zyngierf1421db2015-07-28 14:46:10 +0100880static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
881{
882#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
883 return dev->msi_domain;
884#else
885 return NULL;
886#endif
887}
888
889static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
890{
891#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
892 dev->msi_domain = d;
893#endif
894}
895
Jean Delvarea996d012014-04-14 12:58:53 +0200896static inline void *dev_get_drvdata(const struct device *dev)
897{
898 return dev->driver_data;
899}
900
901static inline void dev_set_drvdata(struct device *dev, void *data)
902{
903 dev->driver_data = data;
904}
905
Rafael J. Wysocki5c095a02011-08-25 15:33:50 +0200906static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
907{
908 return dev ? dev->power.subsys_data : NULL;
909}
910
Ming Leif67f1292009-03-01 21:10:49 +0800911static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
912{
913 return dev->kobj.uevent_suppress;
914}
915
916static inline void dev_set_uevent_suppress(struct device *dev, int val)
917{
918 dev->kobj.uevent_suppress = val;
919}
920
Daniel Ritzd305ef52005-09-22 00:47:24 -0700921static inline int device_is_registered(struct device *dev)
922{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400923 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700924}
925
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100926static inline void device_enable_async_suspend(struct device *dev)
927{
Alan Sternf76b168b2011-06-18 20:22:23 +0200928 if (!dev->power.is_prepared)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100929 dev->power.async_suspend = true;
930}
931
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100932static inline void device_disable_async_suspend(struct device *dev)
933{
Alan Sternf76b168b2011-06-18 20:22:23 +0200934 if (!dev->power.is_prepared)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100935 dev->power.async_suspend = false;
936}
937
938static inline bool device_async_suspend_enabled(struct device *dev)
939{
940 return !!dev->power.async_suspend;
941}
942
Rafael J. Wysocki8b258cc2011-11-17 21:39:33 +0100943static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
944{
945 dev->power.ignore_children = enable;
946}
947
Rafael J. Wysockifeb70af2012-08-13 14:00:25 +0200948static inline void dev_pm_syscore_device(struct device *dev, bool val)
949{
950#ifdef CONFIG_PM_SLEEP
951 dev->power.syscore = val;
952#endif
953}
954
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800955static inline void device_lock(struct device *dev)
956{
Thomas Gleixner31427882010-01-29 20:39:02 +0000957 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800958}
959
960static inline int device_trylock(struct device *dev)
961{
Thomas Gleixner31427882010-01-29 20:39:02 +0000962 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800963}
964
965static inline void device_unlock(struct device *dev)
966{
Thomas Gleixner31427882010-01-29 20:39:02 +0000967 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800968}
969
Konrad Rzeszutek Wilkac801022014-12-03 16:40:27 -0500970static inline void device_lock_assert(struct device *dev)
971{
972 lockdep_assert_held(&dev->mutex);
973}
974
Benjamin Herrenschmidte8a51e12015-02-17 19:03:41 -0600975static inline struct device_node *dev_of_node(struct device *dev)
976{
977 if (!IS_ENABLED(CONFIG_OF))
978 return NULL;
979 return dev->of_node;
980}
981
Adrian Bunk1f217822006-12-19 13:01:28 -0800982void driver_init(void);
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984/*
985 * High level routines for use by the bus drivers
986 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800987extern int __must_check device_register(struct device *dev);
988extern void device_unregister(struct device *dev);
989extern void device_initialize(struct device *dev);
990extern int __must_check device_add(struct device *dev);
991extern void device_del(struct device *dev);
992extern int device_for_each_child(struct device *dev, void *data,
993 int (*fn)(struct device *dev, void *data));
Andy Shevchenko3d060ae2015-07-27 18:04:00 +0300994extern int device_for_each_child_reverse(struct device *dev, void *data,
995 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800996extern struct device *device_find_child(struct device *dev, void *data,
997 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +0200998extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +0100999extern int device_move(struct device *dev, struct device *new_parent,
1000 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +02001001extern const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001002 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001003 const char **tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001005static inline bool device_supports_offline(struct device *dev)
1006{
1007 return dev->bus && dev->bus->offline && dev->bus->online;
1008}
1009
1010extern void lock_device_hotplug(void);
1011extern void unlock_device_hotplug(void);
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001012extern int lock_device_hotplug_sysfs(void);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001013extern int device_offline(struct device *dev);
1014extern int device_online(struct device *dev);
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02001015extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1016extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001019 * Root device objects for grouping under /sys/devices
1020 */
1021extern struct device *__root_device_register(const char *name,
1022 struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001023
Tejun Heo33ac1252014-01-10 08:57:31 -05001024/* This is a macro to avoid include problems with THIS_MODULE */
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001025#define root_device_register(name) \
1026 __root_device_register(name, THIS_MODULE)
1027
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001028extern void root_device_unregister(struct device *root);
1029
Mark Browna5b8b1a2009-07-17 15:06:08 +01001030static inline void *dev_get_platdata(const struct device *dev)
1031{
1032 return dev->platform_data;
1033}
1034
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001035/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 * Manual binding of a device to driver. See drivers/base/bus.c
1037 * for information on use.
1038 */
Andrew Mortonf86db392006-08-14 22:43:20 -07001039extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001040extern void device_release_driver(struct device *dev);
1041extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001042extern int __must_check driver_attach(struct device_driver *drv);
Dmitry Torokhov765230b2015-03-30 16:20:04 -07001043extern void device_initial_probe(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001044extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001046/*
1047 * Easy functions for dynamically creating devices on the fly
1048 */
Nicolas Iooss8db14862015-07-17 16:23:42 -07001049extern __printf(5, 0)
1050struct device *device_create_vargs(struct class *cls, struct device *parent,
1051 dev_t devt, void *drvdata,
1052 const char *fmt, va_list vargs);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001053extern __printf(5, 6)
1054struct device *device_create(struct class *cls, struct device *parent,
1055 dev_t devt, void *drvdata,
1056 const char *fmt, ...);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001057extern __printf(6, 7)
1058struct device *device_create_with_groups(struct class *cls,
1059 struct device *parent, dev_t devt, void *drvdata,
1060 const struct attribute_group **groups,
1061 const char *fmt, ...);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001062extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064/*
1065 * Platform "fixup" functions - allow the platform to have their say
1066 * about devices and actions that the general device layer doesn't
1067 * know about.
1068 */
1069/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001070extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001072extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074
Wanlong Gao880ffb52011-05-05 07:55:36 +08001075/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 * get_device - atomically increment the reference count for the device.
1077 *
1078 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001079extern struct device *get_device(struct device *dev);
1080extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Kay Sievers2b2af542009-04-30 15:23:42 +02001082#ifdef CONFIG_DEVTMPFS
1083extern int devtmpfs_create_node(struct device *dev);
1084extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +01001085extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +02001086#else
1087static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1088static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1089static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1090#endif
1091
Rytchkov Alexey116f232b2006-03-22 00:58:53 +01001092/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093extern void device_shutdown(void);
1094
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -07001096extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
Joe Perches99bcf212010-06-27 01:02:34 +00001098
1099#ifdef CONFIG_PRINTK
1100
Joe Perches0a18b052012-09-25 18:19:57 -07001101extern __printf(3, 0)
1102int dev_vprintk_emit(int level, const struct device *dev,
1103 const char *fmt, va_list args);
Joe Perches05e4e5b2012-09-12 20:13:37 -07001104extern __printf(3, 4)
1105int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
Joe Perches798efc62012-09-12 20:11:29 -07001106
Joe Perchesb9075fa2011-10-31 17:11:33 -07001107extern __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001108void dev_printk(const char *level, const struct device *dev,
1109 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001110extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001111void dev_emerg(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001112extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001113void dev_alert(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001114extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001115void dev_crit(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001116extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001117void dev_err(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001118extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001119void dev_warn(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_notice(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_info(const struct device *dev, const char *fmt, ...);
Joe Perches99bcf212010-06-27 01:02:34 +00001124
1125#else
1126
Joe Perches0a18b052012-09-25 18:19:57 -07001127static inline __printf(3, 0)
1128int dev_vprintk_emit(int level, const struct device *dev,
1129 const char *fmt, va_list args)
Joe Perches05e4e5b2012-09-12 20:13:37 -07001130{ return 0; }
1131static inline __printf(3, 4)
1132int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1133{ return 0; }
1134
Joe Perchesd1f10522014-12-25 15:07:04 -08001135static inline void __dev_printk(const char *level, const struct device *dev,
1136 struct va_format *vaf)
1137{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001138static inline __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001139void dev_printk(const char *level, const struct device *dev,
1140 const char *fmt, ...)
1141{}
Joe Perches99bcf212010-06-27 01:02:34 +00001142
Joe Perchesb9075fa2011-10-31 17:11:33 -07001143static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001144void dev_emerg(const struct device *dev, const char *fmt, ...)
1145{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001146static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001147void dev_crit(const struct device *dev, const char *fmt, ...)
1148{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001149static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001150void dev_alert(const struct device *dev, const char *fmt, ...)
1151{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001152static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001153void dev_err(const struct device *dev, const char *fmt, ...)
1154{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001155static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001156void dev_warn(const struct device *dev, const char *fmt, ...)
1157{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001158static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001159void dev_notice(const struct device *dev, const char *fmt, ...)
1160{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001161static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001162void _dev_info(const struct device *dev, const char *fmt, ...)
1163{}
Joe Perches99bcf212010-06-27 01:02:34 +00001164
1165#endif
1166
1167/*
1168 * Stupid hackaround for existing uses of non-printk uses dev_info
1169 *
1170 * Note that the definition of dev_info below is actually _dev_info
1171 * and a macro is used to avoid redefining dev_info
1172 */
1173
1174#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -05001175
Jim Cromieb558c962011-12-19 17:11:18 -05001176#if defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +00001177#define dev_dbg(dev, format, ...) \
1178do { \
Jason Baron346e15b2008-08-12 16:46:19 -04001179 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +00001180} while (0)
Jim Cromieb558c962011-12-19 17:11:18 -05001181#elif defined(DEBUG)
1182#define dev_dbg(dev, format, arg...) \
1183 dev_printk(KERN_DEBUG, dev, format, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184#else
Joe Perches99bcf212010-06-27 01:02:34 +00001185#define dev_dbg(dev, format, arg...) \
1186({ \
1187 if (0) \
1188 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001189})
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190#endif
1191
Joe Perchese1353032014-11-17 18:18:22 -08001192#ifdef CONFIG_PRINTK
1193#define dev_level_once(dev_level, dev, fmt, ...) \
1194do { \
1195 static bool __print_once __read_mostly; \
1196 \
1197 if (!__print_once) { \
1198 __print_once = true; \
1199 dev_level(dev, fmt, ##__VA_ARGS__); \
1200 } \
1201} while (0)
1202#else
1203#define dev_level_once(dev_level, dev, fmt, ...) \
1204do { \
1205 if (0) \
1206 dev_level(dev, fmt, ##__VA_ARGS__); \
1207} while (0)
1208#endif
1209
1210#define dev_emerg_once(dev, fmt, ...) \
1211 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1212#define dev_alert_once(dev, fmt, ...) \
1213 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1214#define dev_crit_once(dev, fmt, ...) \
1215 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1216#define dev_err_once(dev, fmt, ...) \
1217 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1218#define dev_warn_once(dev, fmt, ...) \
1219 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1220#define dev_notice_once(dev, fmt, ...) \
1221 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1222#define dev_info_once(dev, fmt, ...) \
1223 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1224#define dev_dbg_once(dev, fmt, ...) \
Joe Perchesa2a15d52015-01-03 09:51:33 -08001225 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
Joe Perchese1353032014-11-17 18:18:22 -08001226
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001227#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1228do { \
1229 static DEFINE_RATELIMIT_STATE(_rs, \
1230 DEFAULT_RATELIMIT_INTERVAL, \
1231 DEFAULT_RATELIMIT_BURST); \
1232 if (__ratelimit(&_rs)) \
1233 dev_level(dev, fmt, ##__VA_ARGS__); \
1234} while (0)
1235
1236#define dev_emerg_ratelimited(dev, fmt, ...) \
1237 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1238#define dev_alert_ratelimited(dev, fmt, ...) \
1239 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1240#define dev_crit_ratelimited(dev, fmt, ...) \
1241 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1242#define dev_err_ratelimited(dev, fmt, ...) \
1243 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1244#define dev_warn_ratelimited(dev, fmt, ...) \
1245 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1246#define dev_notice_ratelimited(dev, fmt, ...) \
1247 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1248#define dev_info_ratelimited(dev, fmt, ...) \
1249 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001250#if defined(CONFIG_DYNAMIC_DEBUG)
1251/* descriptor check is first to prevent flooding with "callbacks suppressed" */
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001252#define dev_dbg_ratelimited(dev, fmt, ...) \
1253do { \
1254 static DEFINE_RATELIMIT_STATE(_rs, \
1255 DEFAULT_RATELIMIT_INTERVAL, \
1256 DEFAULT_RATELIMIT_BURST); \
1257 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1258 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1259 __ratelimit(&_rs)) \
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001260 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1261 ##__VA_ARGS__); \
1262} while (0)
1263#elif defined(DEBUG)
1264#define dev_dbg_ratelimited(dev, fmt, ...) \
1265do { \
1266 static DEFINE_RATELIMIT_STATE(_rs, \
1267 DEFAULT_RATELIMIT_INTERVAL, \
1268 DEFAULT_RATELIMIT_BURST); \
1269 if (__ratelimit(&_rs)) \
1270 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001271} while (0)
1272#else
1273#define dev_dbg_ratelimited(dev, fmt, ...) \
1274 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1275#endif
1276
David Brownellaebdc3b2007-07-12 22:08:22 -07001277#ifdef VERBOSE_DEBUG
1278#define dev_vdbg dev_dbg
1279#else
Joe Perches99bcf212010-06-27 01:02:34 +00001280#define dev_vdbg(dev, format, arg...) \
1281({ \
1282 if (0) \
1283 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001284})
David Brownellaebdc3b2007-07-12 22:08:22 -07001285#endif
1286
Arjan van de Vene6139662008-09-20 19:08:39 -07001287/*
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001288 * dev_WARN*() acts like dev_printk(), but with the key difference of
1289 * using WARN/WARN_ONCE to include file/line information and a backtrace.
Arjan van de Vene6139662008-09-20 19:08:39 -07001290 */
1291#define dev_WARN(dev, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001292 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
Arjan van de Vene6139662008-09-20 19:08:39 -07001293
Felipe Balbibcdd3232011-03-16 15:59:35 +02001294#define dev_WARN_ONCE(dev, condition, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001295 WARN_ONCE(condition, "%s %s: " format, \
1296 dev_driver_string(dev), dev_name(dev), ## arg)
Felipe Balbibcdd3232011-03-16 15:59:35 +02001297
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298/* Create alias, so I can be autoloaded. */
1299#define MODULE_ALIAS_CHARDEV(major,minor) \
1300 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1301#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1302 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +02001303
1304#ifdef CONFIG_SYSFS_DEPRECATED
1305extern long sysfs_deprecated;
1306#else
1307#define sysfs_deprecated 0
1308#endif
1309
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001310/**
1311 * module_driver() - Helper macro for drivers that don't do anything
1312 * special in module init/exit. This eliminates a lot of boilerplate.
1313 * Each module may only use this macro once, and calling it replaces
1314 * module_init() and module_exit().
1315 *
Randy Dunlap2eda0132012-01-21 11:02:51 -08001316 * @__driver: driver name
1317 * @__register: register function for this driver type
1318 * @__unregister: unregister function for this driver type
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001319 * @...: Additional arguments to be passed to __register and __unregister.
Randy Dunlap2eda0132012-01-21 11:02:51 -08001320 *
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001321 * Use this macro to construct bus specific macros for registering
1322 * drivers, and do not use it on its own.
1323 */
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001324#define module_driver(__driver, __register, __unregister, ...) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001325static int __init __driver##_init(void) \
1326{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001327 return __register(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001328} \
1329module_init(__driver##_init); \
1330static void __exit __driver##_exit(void) \
1331{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001332 __unregister(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001333} \
1334module_exit(__driver##_exit);
1335
Paul Gortmakerf309d442015-05-01 20:10:57 -04001336/**
1337 * builtin_driver() - Helper macro for drivers that don't do anything
1338 * special in init and have no exit. This eliminates some boilerplate.
1339 * Each driver may only use this macro once, and calling it replaces
1340 * device_initcall (or in some cases, the legacy __initcall). This is
1341 * meant to be a direct parallel of module_driver() above but without
1342 * the __exit stuff that is not used for builtin cases.
1343 *
1344 * @__driver: driver name
1345 * @__register: register function for this driver type
1346 * @...: Additional arguments to be passed to __register
1347 *
1348 * Use this macro to construct bus specific macros for registering
1349 * drivers, and do not use it on its own.
1350 */
1351#define builtin_driver(__driver, __register, ...) \
1352static int __init __driver##_init(void) \
1353{ \
1354 return __register(&(__driver) , ##__VA_ARGS__); \
1355} \
1356device_initcall(__driver##_init);
1357
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358#endif /* _DEVICE_H_ */