blob: 43d183aeb25b4ee73f811fb572803bc48bb8324f [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;
Joerg Roedelff217762011-08-26 16:48:26 +020041struct iommu_ops;
Alex Williamson74416e12012-05-30 14:18:41 -060042struct iommu_group;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010043
44struct bus_attribute {
45 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080046 ssize_t (*show)(struct bus_type *bus, char *buf);
47 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010048};
49
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080050#define BUS_ATTR(_name, _mode, _show, _store) \
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -070051 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
52#define BUS_ATTR_RW(_name) \
53 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
54#define BUS_ATTR_RO(_name) \
55 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010056
57extern int __must_check bus_create_file(struct bus_type *,
58 struct bus_attribute *);
59extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Wanlong Gao880ffb52011-05-05 07:55:36 +080061/**
62 * struct bus_type - The bus type of the device
63 *
64 * @name: The name of the bus.
Kay Sieversca22e562011-12-14 14:29:38 -080065 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
66 * @dev_root: Default device to use as the parent.
Wanlong Gao880ffb52011-05-05 07:55:36 +080067 * @dev_attrs: Default attributes of the devices on the bus.
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -070068 * @bus_groups: Default attributes of the bus.
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -070069 * @dev_groups: Default attributes of the devices on the bus.
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -070070 * @drv_groups: Default attributes of the device drivers on the bus.
Wanlong Gao880ffb52011-05-05 07:55:36 +080071 * @match: Called, perhaps multiple times, whenever a new device or driver
72 * is added for this bus. It should return a nonzero value if the
73 * given device can be handled by the given driver.
74 * @uevent: Called when a device is added, removed, or a few other things
75 * that generate uevents to add the environment variables.
76 * @probe: Called when a new device or driver add to this bus, and callback
77 * the specific driver's probe to initial the matched device.
78 * @remove: Called when a device removed from this bus.
79 * @shutdown: Called at shut-down time to quiesce the device.
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +020080 *
81 * @online: Called to put the device back online (after offlining it).
82 * @offline: Called to put the device offline for hot-removal. May fail.
83 *
Wanlong Gao880ffb52011-05-05 07:55:36 +080084 * @suspend: Called when a device on this bus wants to go to sleep mode.
85 * @resume: Called to bring a device on this bus out of sleep mode.
86 * @pm: Power management operations of this bus, callback the specific
87 * device driver's pm-ops.
Marcos Paulo de Souza7b08fae2011-11-01 11:15:40 -070088 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
Joerg Roedelff217762011-08-26 16:48:26 +020089 * driver implementations to a bus and allow the driver to do
90 * bus-specific setup
Wanlong Gao880ffb52011-05-05 07:55:36 +080091 * @p: The private data of the driver core, only the driver core can
92 * touch this.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +020093 * @lock_key: Lock class key for use by the lock validator
Wanlong Gao880ffb52011-05-05 07:55:36 +080094 *
95 * A bus is a channel between the processor and one or more devices. For the
96 * purposes of the device model, all devices are connected via a bus, even if
97 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
98 * A USB controller is usually a PCI device, for example. The device model
99 * represents the actual connections between buses and the devices they control.
100 * A bus is represented by the bus_type structure. It contains the name, the
101 * default attributes, the bus' methods, PM operations, and the driver core's
102 * private data.
103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800105 const char *name;
Kay Sieversca22e562011-12-14 14:29:38 -0800106 const char *dev_name;
107 struct device *dev_root;
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700108 struct device_attribute *dev_attrs; /* use dev_groups instead */
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -0700109 const struct attribute_group **bus_groups;
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700110 const struct attribute_group **dev_groups;
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -0700111 const struct attribute_group **drv_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800113 int (*match)(struct device *dev, struct device_driver *drv);
114 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
115 int (*probe)(struct device *dev);
116 int (*remove)(struct device *dev);
117 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700118
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200119 int (*online)(struct device *dev);
120 int (*offline)(struct device *dev);
121
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800122 int (*suspend)(struct device *dev, pm_message_t state);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800123 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +0100124
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700125 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200126
Thierry Redingb22f6432014-06-27 09:03:12 +0200127 const struct iommu_ops *iommu_ops;
Joerg Roedelff217762011-08-26 16:48:26 +0200128
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100129 struct subsys_private *p;
Michal Hockobe871b72013-03-12 17:21:19 +0100130 struct lock_class_key lock_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131};
132
Michal Hockobe871b72013-03-12 17:21:19 +0100133extern int __must_check bus_register(struct bus_type *bus);
134
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800135extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800137extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/* iterator helpers for buses */
Kay Sieversca22e562011-12-14 14:29:38 -0800140struct subsys_dev_iter {
141 struct klist_iter ki;
142 const struct device_type *type;
143};
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700144void subsys_dev_iter_init(struct subsys_dev_iter *iter,
Kay Sieversca22e562011-12-14 14:29:38 -0800145 struct bus_type *subsys,
146 struct device *start,
147 const struct device_type *type);
148struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
149void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800151int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
152 int (*fn)(struct device *dev, void *data));
153struct device *bus_find_device(struct bus_type *bus, struct device *start,
154 void *data,
155 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -0800156struct device *bus_find_device_by_name(struct bus_type *bus,
157 struct device *start,
158 const char *name);
Kay Sieversca22e562011-12-14 14:29:38 -0800159struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
160 struct device *hint);
Jean Delvarecc7447a2010-06-16 11:44:18 +0200161int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
162 void *data, int (*fn)(struct device_driver *, void *));
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -0500163void bus_sort_breadthfirst(struct bus_type *bus,
164 int (*compare)(const struct device *a,
165 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000166/*
167 * Bus notifiers: Get notified of addition/removal of devices
168 * and binding/unbinding of drivers to devices.
169 * In the long run, it should be a replacement for the platform
170 * notify hooks.
171 */
172struct notifier_block;
173
174extern int bus_register_notifier(struct bus_type *bus,
175 struct notifier_block *nb);
176extern int bus_unregister_notifier(struct bus_type *bus,
177 struct notifier_block *nb);
178
179/* All 4 notifers below get called with the target struct device *
180 * as an argument. Note that those functions are likely to be called
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800181 * with the device lock held in the core, so be careful.
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000182 */
183#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
184#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
Magnus Damm45daef02010-07-23 19:56:18 +0900185#define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
186 bound */
187#define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
188#define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000189 unbound */
Magnus Damm45daef02010-07-23 19:56:18 +0900190#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
Joerg Roedel309b7d62009-04-24 14:57:00 +0200191 from the device */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000192
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700193extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700194extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700195
Wanlong Gao880ffb52011-05-05 07:55:36 +0800196/**
197 * struct device_driver - The basic device driver structure
198 * @name: Name of the device driver.
199 * @bus: The bus which the device of this driver belongs to.
200 * @owner: The module owner.
201 * @mod_name: Used for built-in modules.
202 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
203 * @of_match_table: The open firmware table.
Mika Westerberg06f64c82012-10-31 22:44:33 +0100204 * @acpi_match_table: The ACPI match table.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800205 * @probe: Called to query the existence of a specific device,
206 * whether this driver can work with it, and bind the driver
207 * to a specific device.
208 * @remove: Called when the device is removed from the system to
209 * unbind a device from this driver.
210 * @shutdown: Called at shut-down time to quiesce the device.
211 * @suspend: Called to put the device to sleep mode. Usually to a
212 * low power state.
213 * @resume: Called to bring a device from sleep mode.
214 * @groups: Default attributes that get created by the driver core
215 * automatically.
216 * @pm: Power management operations of the device which matched
217 * this driver.
218 * @p: Driver core's private data, no one other than the driver
219 * core can touch this.
220 *
221 * The device driver-model tracks all of the drivers known to the system.
222 * The main reason for this tracking is to enable the driver core to match
223 * up drivers with new devices. Once drivers are known objects within the
224 * system, however, a number of other things become possible. Device drivers
225 * can export information and configuration variables that are independent
226 * of any specific device.
227 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800229 const char *name;
230 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800232 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700233 const char *mod_name; /* used for built-in modules */
234
235 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Grant Likely597b9d12010-04-13 16:13:01 -0700237 const struct of_device_id *of_match_table;
Mika Westerberg06f64c82012-10-31 22:44:33 +0100238 const struct acpi_device_id *acpi_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700239
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800240 int (*probe) (struct device *dev);
241 int (*remove) (struct device *dev);
242 void (*shutdown) (struct device *dev);
243 int (*suspend) (struct device *dev, pm_message_t state);
244 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700245 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800246
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700247 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200248
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800249 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250};
251
252
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800253extern int __must_check driver_register(struct device_driver *drv);
254extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800256extern struct device_driver *driver_find(const char *name,
257 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700258extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800259extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100262/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800265 struct attribute attr;
266 ssize_t (*show)(struct device_driver *driver, char *buf);
267 ssize_t (*store)(struct device_driver *driver, const char *buf,
268 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269};
270
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700271#define DRIVER_ATTR(_name, _mode, _show, _store) \
272 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
273#define DRIVER_ATTR_RW(_name) \
274 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
275#define DRIVER_ATTR_RO(_name) \
276 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700277#define DRIVER_ATTR_WO(_name) \
278 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800280extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200281 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800282extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200283 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800285extern int __must_check driver_for_each_device(struct device_driver *drv,
286 struct device *start,
287 void *data,
288 int (*fn)(struct device *dev,
289 void *));
290struct device *driver_find_device(struct device_driver *drv,
291 struct device *start, void *data,
292 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800293
Wanlong Gao880ffb52011-05-05 07:55:36 +0800294/**
Kay Sieversca22e562011-12-14 14:29:38 -0800295 * struct subsys_interface - interfaces to device functions
Randy Dunlap2eda0132012-01-21 11:02:51 -0800296 * @name: name of the device function
297 * @subsys: subsytem of the devices to attach to
298 * @node: the list of functions registered at the subsystem
299 * @add_dev: device hookup to device function handler
300 * @remove_dev: device hookup to device function handler
Kay Sieversca22e562011-12-14 14:29:38 -0800301 *
302 * Simple interfaces attached to a subsystem. Multiple interfaces can
303 * attach to a subsystem and its devices. Unlike drivers, they do not
304 * exclusively claim or control devices. Interfaces usually represent
305 * a specific functionality of a subsystem/class of devices.
306 */
307struct subsys_interface {
308 const char *name;
309 struct bus_type *subsys;
310 struct list_head node;
311 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
312 int (*remove_dev)(struct device *dev, struct subsys_interface *sif);
313};
314
315int subsys_interface_register(struct subsys_interface *sif);
316void subsys_interface_unregister(struct subsys_interface *sif);
317
318int subsys_system_register(struct bus_type *subsys,
319 const struct attribute_group **groups);
Tejun Heod73ce002013-03-12 11:30:05 -0700320int subsys_virtual_register(struct bus_type *subsys,
321 const struct attribute_group **groups);
Kay Sieversca22e562011-12-14 14:29:38 -0800322
323/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800324 * struct class - device classes
325 * @name: Name of the class.
326 * @owner: The module owner.
327 * @class_attrs: Default attributes of this class.
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700328 * @dev_groups: Default attributes of the devices that belong to the class.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800329 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
330 * @dev_uevent: Called when a device is added, removed from this class, or a
331 * few other things that generate uevents to add the environment
332 * variables.
333 * @devnode: Callback to provide the devtmpfs.
334 * @class_release: Called to release this class.
335 * @dev_release: Called to release the device.
336 * @suspend: Used to put the device to sleep mode, usually to a low power
337 * state.
338 * @resume: Used to bring the device from the sleep mode.
339 * @ns_type: Callbacks so sysfs can detemine namespaces.
340 * @namespace: Namespace of the device belongs to this class.
341 * @pm: The default device power management operations of this class.
342 * @p: The private data of the driver core, no one other than the
343 * driver core can touch this.
344 *
345 * A class is a higher-level view of a device that abstracts out low-level
346 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
347 * at the class level, they are all simply disks. Classes allow user space
348 * to work with devices based on what they do, rather than how they are
349 * connected or how they work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 */
351struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800352 const char *name;
353 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800355 struct class_attribute *class_attrs;
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700356 const struct attribute_group **dev_groups;
Dan Williamse105b8b2008-04-21 10:51:07 -0700357 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800359 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Al Viro2c9ede52011-07-23 20:24:48 -0400360 char *(*devnode)(struct device *dev, umode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800362 void (*class_release)(struct class *class);
363 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700364
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800365 int (*suspend)(struct device *dev, pm_message_t state);
366 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200367
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700368 const struct kobj_ns_type_operations *ns_type;
369 const void *(*namespace)(struct device *dev);
370
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700371 const struct dev_pm_ops *pm;
372
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100373 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374};
375
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200376struct class_dev_iter {
377 struct klist_iter ki;
378 const struct device_type *type;
379};
380
Dan Williamse105b8b2008-04-21 10:51:07 -0700381extern struct kobject *sysfs_dev_block_kobj;
382extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700383extern int __must_check __class_register(struct class *class,
384 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800385extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700386
387/* This is a #define to keep the compiler from merging different
388 * instances of the __key variable */
389#define class_register(class) \
390({ \
391 static struct lock_class_key __key; \
392 __class_register(class, &__key); \
393})
394
Jean Delvare46227092009-08-04 12:55:34 +0200395struct class_compat;
396struct class_compat *class_compat_register(const char *name);
397void class_compat_unregister(struct class_compat *cls);
398int class_compat_create_link(struct class_compat *cls, struct device *dev,
399 struct device *device_link);
400void class_compat_remove_link(struct class_compat *cls, struct device *dev,
401 struct device *device_link);
402
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700403extern void class_dev_iter_init(struct class_dev_iter *iter,
404 struct class *class,
405 struct device *start,
406 const struct device_type *type);
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200407extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
408extern void class_dev_iter_exit(struct class_dev_iter *iter);
409
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400410extern int class_for_each_device(struct class *class, struct device *start,
411 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800412 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400413extern struct device *class_find_device(struct class *class,
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100414 struct device *start, const void *data,
415 int (*match)(struct device *, const void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
417struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800418 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100419 ssize_t (*show)(struct class *class, struct class_attribute *attr,
420 char *buf);
421 ssize_t (*store)(struct class *class, struct class_attribute *attr,
422 const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423};
424
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700425#define CLASS_ATTR(_name, _mode, _show, _store) \
426 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
427#define CLASS_ATTR_RW(_name) \
428 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
429#define CLASS_ATTR_RO(_name) \
430 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Tejun Heo58292cbe2013-09-11 22:29:04 -0400432extern int __must_check class_create_file_ns(struct class *class,
433 const struct class_attribute *attr,
434 const void *ns);
435extern void class_remove_file_ns(struct class *class,
436 const struct class_attribute *attr,
437 const void *ns);
438
439static inline int __must_check class_create_file(struct class *class,
440 const struct class_attribute *attr)
441{
442 return class_create_file_ns(class, attr, NULL);
443}
444
445static inline void class_remove_file(struct class *class,
446 const struct class_attribute *attr)
447{
448 return class_remove_file_ns(class, attr, NULL);
449}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Andi Kleen869dfc82010-01-05 12:48:08 +0100451/* Simple class attribute that is just a static string */
Andi Kleen869dfc82010-01-05 12:48:08 +0100452struct class_attribute_string {
453 struct class_attribute attr;
454 char *str;
455};
456
457/* Currently read-only only */
458#define _CLASS_ATTR_STRING(_name, _mode, _str) \
459 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
460#define CLASS_ATTR_STRING(_name, _mode, _str) \
461 struct class_attribute_string class_attr_##_name = \
462 _CLASS_ATTR_STRING(_name, _mode, _str)
463
464extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
465 char *buf);
466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467struct class_interface {
468 struct list_head node;
469 struct class *class;
470
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200471 int (*add_dev) (struct device *, struct class_interface *);
472 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473};
474
Andrew Morton4a7fb632006-08-14 22:43:17 -0700475extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476extern void class_interface_unregister(struct class_interface *);
477
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700478extern struct class * __must_check __class_create(struct module *owner,
479 const char *name,
480 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800481extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800482
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700483/* This is a #define to keep the compiler from merging different
484 * instances of the __key variable */
485#define class_create(owner, name) \
486({ \
487 static struct lock_class_key __key; \
488 __class_create(owner, name, &__key); \
489})
490
Kay Sievers414264f2007-03-12 21:08:57 +0100491/*
492 * The type of device, "struct device" is embedded in. A class
493 * or bus can contain devices of different types
494 * like "partitions" and "disks", "mouse" and "event".
495 * This identifies the device type and carries type-specific
496 * information, equivalent to the kobj_type of a kobject.
497 * If "name" is specified, the uevent will contain it in
498 * the DEVTYPE variable.
499 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200500struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100501 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700502 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200503 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sievers3c2670e2013-04-06 09:56:00 -0700504 char *(*devnode)(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700505 kuid_t *uid, kgid_t *gid);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200506 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200507
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700508 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200509};
510
Kay Sieversa7fd6702005-10-01 14:49:43 +0200511/* interface for exporting device attributes */
512struct device_attribute {
513 struct attribute attr;
514 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
515 char *buf);
516 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
517 const char *buf, size_t count);
518};
519
Kay Sieversca22e562011-12-14 14:29:38 -0800520struct dev_ext_attribute {
521 struct device_attribute attr;
522 void *var;
523};
Kay Sieversa7fd6702005-10-01 14:49:43 +0200524
Kay Sieversca22e562011-12-14 14:29:38 -0800525ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
526 char *buf);
527ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
528 const char *buf, size_t count);
529ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
530 char *buf);
531ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
532 const char *buf, size_t count);
Borislav Petkov91872392012-10-09 19:52:05 +0200533ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
534 char *buf);
535ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
536 const char *buf, size_t count);
Kay Sieversca22e562011-12-14 14:29:38 -0800537
Kay Sieversa7fd6702005-10-01 14:49:43 +0200538#define DEVICE_ATTR(_name, _mode, _show, _store) \
Kay Sieversca22e562011-12-14 14:29:38 -0800539 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700540#define DEVICE_ATTR_RW(_name) \
541 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
542#define DEVICE_ATTR_RO(_name) \
543 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700544#define DEVICE_ATTR_WO(_name) \
545 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
Kay Sieversca22e562011-12-14 14:29:38 -0800546#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
547 struct dev_ext_attribute dev_attr_##_name = \
548 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
549#define DEVICE_INT_ATTR(_name, _mode, _var) \
550 struct dev_ext_attribute dev_attr_##_name = \
Michael Davidson94758182012-05-03 16:19:02 -0700551 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
Borislav Petkov91872392012-10-09 19:52:05 +0200552#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
553 struct dev_ext_attribute dev_attr_##_name = \
554 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
Alan Stern356c05d2012-05-14 13:30:03 -0400555#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
556 struct device_attribute dev_attr_##_name = \
557 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200558
Greg Kroah-Hartmanb9d4e712012-01-04 15:05:10 -0800559extern int device_create_file(struct device *device,
560 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800561extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200562 const struct device_attribute *attr);
Tejun Heo6b0afc22014-02-03 14:03:01 -0500563extern bool device_remove_file_self(struct device *dev,
564 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700565extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200566 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700567extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200568 const struct bin_attribute *attr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900569
570/* device resource management */
571typedef void (*dr_release_t)(struct device *dev, void *res);
572typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
573
574#ifdef CONFIG_DEBUG_DEVRES
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800575extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
Tejun Heo9ac78492007-01-20 16:00:26 +0900576 const char *name);
577#define devres_alloc(release, size, gfp) \
578 __devres_alloc(release, size, gfp, #release)
579#else
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800580extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900581#endif
Ming Leibddb1b92012-08-04 12:01:26 +0800582extern void devres_for_each_res(struct device *dev, dr_release_t release,
583 dr_match_t match, void *match_data,
584 void (*fn)(struct device *, void *, void *),
585 void *data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900586extern void devres_free(void *res);
587extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800588extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900589 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800590extern void *devres_get(struct device *dev, void *new_res,
591 dr_match_t match, void *match_data);
592extern void *devres_remove(struct device *dev, dr_release_t release,
593 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900594extern int devres_destroy(struct device *dev, dr_release_t release,
595 dr_match_t match, void *match_data);
Mark Brownd926d0e2012-05-03 18:15:13 +0100596extern int devres_release(struct device *dev, dr_release_t release,
597 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900598
599/* devres group */
600extern void * __must_check devres_open_group(struct device *dev, void *id,
601 gfp_t gfp);
602extern void devres_close_group(struct device *dev, void *id);
603extern void devres_remove_group(struct device *dev, void *id);
604extern int devres_release_group(struct device *dev, void *id);
605
Joe Perches64c862a82013-10-11 13:11:38 -0700606/* managed devm_k.alloc/kfree for device drivers */
607extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
Himangi Saraogi75f2a4e2014-07-17 02:27:52 +0530608extern char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
609 va_list ap);
610extern char *devm_kasprintf(struct device *dev, gfp_t gfp,
611 const char *fmt, ...);
Joe Perches64c862a82013-10-11 13:11:38 -0700612static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
613{
614 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
615}
616static inline void *devm_kmalloc_array(struct device *dev,
617 size_t n, size_t size, gfp_t flags)
618{
619 if (size != 0 && n > SIZE_MAX / size)
620 return NULL;
621 return devm_kmalloc(dev, n * size, flags);
622}
623static inline void *devm_kcalloc(struct device *dev,
624 size_t n, size_t size, gfp_t flags)
625{
626 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
627}
Tejun Heo9ac78492007-01-20 16:00:26 +0900628extern void devm_kfree(struct device *dev, void *p);
Manish Badarkhee31108c2014-01-29 20:27:27 +0530629extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
Srinivas Pandruvada30463652014-04-29 00:51:00 +0100630extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
631 gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900632
Eli Billauer43339be2014-05-16 11:26:35 +0300633extern unsigned long devm_get_free_pages(struct device *dev,
634 gfp_t gfp_mask, unsigned int order);
635extern void devm_free_pages(struct device *dev, unsigned long addr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700636
Thierry Reding75096572013-01-21 11:08:54 +0100637void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200638
Dmitry Torokhovd6b0c582013-02-23 13:11:14 -0800639/* allows to add/remove a custom action to devres stack */
640int devm_add_action(struct device *dev, void (*action)(void *), void *data);
641void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
642
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800643struct device_dma_parameters {
644 /*
645 * a low level driver may set these to teach IOMMU code about
646 * sg limitations.
647 */
648 unsigned int max_segment_size;
649 unsigned long segment_boundary_mask;
650};
651
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100652struct acpi_device;
653
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100654struct acpi_dev_node {
655#ifdef CONFIG_ACPI
Rafael J. Wysocki7b199812013-11-11 22:41:56 +0100656 struct acpi_device *companion;
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100657#endif
658};
659
Wanlong Gao880ffb52011-05-05 07:55:36 +0800660/**
661 * struct device - The basic device structure
662 * @parent: The device's "parent" device, the device to which it is attached.
663 * In most cases, a parent device is some sort of bus or host
664 * controller. If parent is NULL, the device, is a top-level device,
665 * which is not usually what you want.
666 * @p: Holds the private data of the driver core portions of the device.
667 * See the comment of the struct device_private for detail.
668 * @kobj: A top-level, abstract class from which other classes are derived.
669 * @init_name: Initial name of the device.
670 * @type: The type of device.
671 * This identifies the device type and carries type-specific
672 * information.
673 * @mutex: Mutex to synchronize calls to its driver.
674 * @bus: Type of bus device is on.
675 * @driver: Which driver has allocated this
676 * @platform_data: Platform data specific to the device.
677 * Example: For devices on custom boards, as typical of embedded
678 * and SOC based hardware, Linux often uses platform_data to point
679 * to board-specific structures describing devices and how they
680 * are wired. That can include what ports are available, chip
681 * variants, which GPIO pins act in what additional roles, and so
682 * on. This shrinks the "Board Support Packages" (BSPs) and
683 * minimizes board-specific #ifdefs in drivers.
Jean Delvare1bb6c082014-04-14 12:54:47 +0200684 * @driver_data: Private pointer for driver specific info.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800685 * @power: For device power management.
686 * See Documentation/power/devices.txt for details.
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200687 * @pm_domain: Provide callbacks that are executed during system suspend,
Wanlong Gao880ffb52011-05-05 07:55:36 +0800688 * hibernation, system resume and during runtime PM transitions
689 * along with subsystem-level and driver-level callbacks.
Linus Walleijab780292013-01-22 10:56:14 -0700690 * @pins: For device pin management.
691 * See Documentation/pinctrl.txt for details.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800692 * @numa_node: NUMA node this device is close to.
693 * @dma_mask: Dma mask (if dma'ble device).
694 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
695 * hardware supports 64-bit addresses for consistent allocations
696 * such descriptors.
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400697 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
Wanlong Gao880ffb52011-05-05 07:55:36 +0800698 * @dma_parms: A low level driver may set these to teach IOMMU code about
699 * segment limitations.
700 * @dma_pools: Dma pools (if dma'ble device).
701 * @dma_mem: Internal for coherent mem override.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200702 * @cma_area: Contiguous memory area for dma allocations
Wanlong Gao880ffb52011-05-05 07:55:36 +0800703 * @archdata: For arch-specific additions.
704 * @of_node: Associated device tree node.
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100705 * @acpi_node: Associated ACPI device node.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800706 * @devt: For creating the sysfs "dev".
Randy Dunlap2eda0132012-01-21 11:02:51 -0800707 * @id: device instance
Wanlong Gao880ffb52011-05-05 07:55:36 +0800708 * @devres_lock: Spinlock to protect the resource of the device.
709 * @devres_head: The resources list of the device.
710 * @knode_class: The node used to add the device to the class list.
711 * @class: The class of the device.
712 * @groups: Optional attribute groups.
713 * @release: Callback to free the device after all references have
714 * gone away. This should be set by the allocator of the
715 * device (i.e. the bus driver that discovered the device).
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200716 * @iommu_group: IOMMU group the device belongs to.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800717 *
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200718 * @offline_disabled: If set, the device is permanently online.
719 * @offline: Set after successful invocation of bus type's .offline().
Wanlong Gao880ffb52011-05-05 07:55:36 +0800720 *
721 * At the lowest level, every device in a Linux system is represented by an
722 * instance of struct device. The device structure contains the information
723 * that the device model core needs to model the system. Most subsystems,
724 * however, track additional information about the devices they host. As a
725 * result, it is rare for devices to be represented by bare device structures;
726 * instead, that structure, like kobject structures, is usually embedded within
727 * a higher-level representation of the device.
728 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700730 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800732 struct device_private *p;
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700735 const char *init_name; /* initial name of the device */
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700736 const struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Thomas Gleixner31427882010-01-29 20:39:02 +0000738 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800739 * its driver.
740 */
741
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800742 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 struct device_driver *driver; /* which driver has allocated this
744 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800745 void *platform_data; /* Platform specific data, device
746 core doesn't touch it */
Jean Delvare1bb6c082014-04-14 12:54:47 +0200747 void *driver_data; /* Driver data, set and get with
748 dev_set/get_drvdata */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 struct dev_pm_info power;
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200750 struct dev_pm_domain *pm_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Linus Walleijab780292013-01-22 10:56:14 -0700752#ifdef CONFIG_PINCTRL
753 struct dev_pin_info *pins;
754#endif
755
Christoph Hellwig87348132006-12-06 20:32:33 -0800756#ifdef CONFIG_NUMA
757 int numa_node; /* NUMA node this device is close to */
758#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 u64 *dma_mask; /* dma mask (if dma'able device) */
760 u64 coherent_dma_mask;/* Like dma_mask, but for
761 alloc_coherent mappings as
762 not all hardware supports
763 64 bit addresses for consistent
764 allocations such descriptors. */
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400765 unsigned long dma_pfn_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800767 struct device_dma_parameters *dma_parms;
768
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 struct list_head dma_pools; /* dma pools (if dma'ble) */
770
771 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
772 override */
Marek Szyprowskia2547382013-07-29 14:31:45 +0200773#ifdef CONFIG_DMA_CMA
Marek Szyprowskic64be2b2011-12-29 13:09:51 +0100774 struct cma *cma_area; /* contiguous memory area for dma
775 allocations */
776#endif
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100777 /* arch specific additions */
778 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700779
780 struct device_node *of_node; /* associated device tree node */
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100781 struct acpi_dev_node acpi_node; /* associated ACPI device node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600783 dev_t devt; /* dev_t, creates the sysfs "dev" */
Kay Sieversca22e562011-12-14 14:29:38 -0800784 u32 id; /* device instance */
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600785
Tejun Heo9ac78492007-01-20 16:00:26 +0900786 spinlock_t devres_lock;
787 struct list_head devres_head;
788
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200789 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200790 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700791 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700792
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800793 void (*release)(struct device *dev);
Alex Williamson74416e12012-05-30 14:18:41 -0600794 struct iommu_group *iommu_group;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200795
796 bool offline_disabled:1;
797 bool offline:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798};
799
Lars-Peter Clausena4232962012-07-03 18:49:35 +0200800static inline struct device *kobj_to_dev(struct kobject *kobj)
801{
802 return container_of(kobj, struct device, kobj);
803}
804
Alan Stern9a3df1f2008-03-19 22:39:13 +0100805/* Get the wakeup routines, which depend on struct device */
806#include <linux/pm_wakeup.h>
807
Jean Delvarebf9ca692008-07-30 12:29:21 -0700808static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200809{
Paul Mundta636ee72010-03-09 06:57:53 +0000810 /* Use the init name until the kobject becomes available */
811 if (dev->init_name)
812 return dev->init_name;
813
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100814 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200815}
816
Joe Perchesb9075fa2011-10-31 17:11:33 -0700817extern __printf(2, 3)
818int dev_set_name(struct device *dev, const char *name, ...);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000819
Christoph Hellwig87348132006-12-06 20:32:33 -0800820#ifdef CONFIG_NUMA
821static inline int dev_to_node(struct device *dev)
822{
823 return dev->numa_node;
824}
825static inline void set_dev_node(struct device *dev, int node)
826{
827 dev->numa_node = node;
828}
829#else
830static inline int dev_to_node(struct device *dev)
831{
832 return -1;
833}
834static inline void set_dev_node(struct device *dev, int node)
835{
836}
837#endif
838
Jean Delvarea996d012014-04-14 12:58:53 +0200839static inline void *dev_get_drvdata(const struct device *dev)
840{
841 return dev->driver_data;
842}
843
844static inline void dev_set_drvdata(struct device *dev, void *data)
845{
846 dev->driver_data = data;
847}
848
Rafael J. Wysocki5c095a02011-08-25 15:33:50 +0200849static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
850{
851 return dev ? dev->power.subsys_data : NULL;
852}
853
Ming Leif67f1292009-03-01 21:10:49 +0800854static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
855{
856 return dev->kobj.uevent_suppress;
857}
858
859static inline void dev_set_uevent_suppress(struct device *dev, int val)
860{
861 dev->kobj.uevent_suppress = val;
862}
863
Daniel Ritzd305ef52005-09-22 00:47:24 -0700864static inline int device_is_registered(struct device *dev)
865{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400866 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700867}
868
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100869static inline void device_enable_async_suspend(struct device *dev)
870{
Alan Sternf76b168b2011-06-18 20:22:23 +0200871 if (!dev->power.is_prepared)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100872 dev->power.async_suspend = true;
873}
874
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100875static inline void device_disable_async_suspend(struct device *dev)
876{
Alan Sternf76b168b2011-06-18 20:22:23 +0200877 if (!dev->power.is_prepared)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100878 dev->power.async_suspend = false;
879}
880
881static inline bool device_async_suspend_enabled(struct device *dev)
882{
883 return !!dev->power.async_suspend;
884}
885
Rafael J. Wysocki8b258cc2011-11-17 21:39:33 +0100886static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
887{
888 dev->power.ignore_children = enable;
889}
890
Rafael J. Wysockifeb70af2012-08-13 14:00:25 +0200891static inline void dev_pm_syscore_device(struct device *dev, bool val)
892{
893#ifdef CONFIG_PM_SLEEP
894 dev->power.syscore = val;
895#endif
896}
897
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800898static inline void device_lock(struct device *dev)
899{
Thomas Gleixner31427882010-01-29 20:39:02 +0000900 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800901}
902
903static inline int device_trylock(struct device *dev)
904{
Thomas Gleixner31427882010-01-29 20:39:02 +0000905 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800906}
907
908static inline void device_unlock(struct device *dev)
909{
Thomas Gleixner31427882010-01-29 20:39:02 +0000910 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800911}
912
Adrian Bunk1f217822006-12-19 13:01:28 -0800913void driver_init(void);
914
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915/*
916 * High level routines for use by the bus drivers
917 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800918extern int __must_check device_register(struct device *dev);
919extern void device_unregister(struct device *dev);
920extern void device_initialize(struct device *dev);
921extern int __must_check device_add(struct device *dev);
922extern void device_del(struct device *dev);
923extern int device_for_each_child(struct device *dev, void *data,
924 int (*fn)(struct device *dev, void *data));
925extern struct device *device_find_child(struct device *dev, void *data,
926 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +0200927extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +0100928extern int device_move(struct device *dev, struct device *new_parent,
929 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +0200930extern const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700931 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -0700932 const char **tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200934static inline bool device_supports_offline(struct device *dev)
935{
936 return dev->bus && dev->bus->offline && dev->bus->online;
937}
938
939extern void lock_device_hotplug(void);
940extern void unlock_device_hotplug(void);
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200941extern int lock_device_hotplug_sysfs(void);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200942extern int device_offline(struct device *dev);
943extern int device_online(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000945 * Root device objects for grouping under /sys/devices
946 */
947extern struct device *__root_device_register(const char *name,
948 struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400949
Tejun Heo33ac1252014-01-10 08:57:31 -0500950/* This is a macro to avoid include problems with THIS_MODULE */
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400951#define root_device_register(name) \
952 __root_device_register(name, THIS_MODULE)
953
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000954extern void root_device_unregister(struct device *root);
955
Mark Browna5b8b1a2009-07-17 15:06:08 +0100956static inline void *dev_get_platdata(const struct device *dev)
957{
958 return dev->platform_data;
959}
960
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000961/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * Manual binding of a device to driver. See drivers/base/bus.c
963 * for information on use.
964 */
Andrew Mortonf86db392006-08-14 22:43:20 -0700965extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800966extern void device_release_driver(struct device *dev);
967extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -0700968extern int __must_check driver_attach(struct device_driver *drv);
969extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700971/*
972 * Easy functions for dynamically creating devices on the fly
973 */
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700974extern struct device *device_create_vargs(struct class *cls,
975 struct device *parent,
976 dev_t devt,
977 void *drvdata,
978 const char *fmt,
979 va_list vargs);
Joe Perchesb9075fa2011-10-31 17:11:33 -0700980extern __printf(5, 6)
981struct device *device_create(struct class *cls, struct device *parent,
982 dev_t devt, void *drvdata,
983 const char *fmt, ...);
Guenter Roeck39ef3112013-07-14 16:05:57 -0700984extern __printf(6, 7)
985struct device *device_create_with_groups(struct class *cls,
986 struct device *parent, dev_t devt, void *drvdata,
987 const struct attribute_group **groups,
988 const char *fmt, ...);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700989extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991/*
992 * Platform "fixup" functions - allow the platform to have their say
993 * about devices and actions that the general device layer doesn't
994 * know about.
995 */
996/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800997extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800999extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
1001
Wanlong Gao880ffb52011-05-05 07:55:36 +08001002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 * get_device - atomically increment the reference count for the device.
1004 *
1005 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001006extern struct device *get_device(struct device *dev);
1007extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Kay Sievers2b2af542009-04-30 15:23:42 +02001009#ifdef CONFIG_DEVTMPFS
1010extern int devtmpfs_create_node(struct device *dev);
1011extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +01001012extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +02001013#else
1014static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1015static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1016static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1017#endif
1018
Rytchkov Alexey116f232b2006-03-22 00:58:53 +01001019/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020extern void device_shutdown(void);
1021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -07001023extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Joe Perches99bcf212010-06-27 01:02:34 +00001025
1026#ifdef CONFIG_PRINTK
1027
Joe Perches0a18b052012-09-25 18:19:57 -07001028extern __printf(3, 0)
1029int dev_vprintk_emit(int level, const struct device *dev,
1030 const char *fmt, va_list args);
Joe Perches05e4e5b2012-09-12 20:13:37 -07001031extern __printf(3, 4)
1032int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
Joe Perches798efc62012-09-12 20:11:29 -07001033
Joe Perchesb9075fa2011-10-31 17:11:33 -07001034extern __printf(3, 4)
1035int dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -07001036 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001037extern __printf(2, 3)
1038int dev_emerg(const struct device *dev, const char *fmt, ...);
1039extern __printf(2, 3)
1040int dev_alert(const struct device *dev, const char *fmt, ...);
1041extern __printf(2, 3)
1042int dev_crit(const struct device *dev, const char *fmt, ...);
1043extern __printf(2, 3)
1044int dev_err(const struct device *dev, const char *fmt, ...);
1045extern __printf(2, 3)
1046int dev_warn(const struct device *dev, const char *fmt, ...);
1047extern __printf(2, 3)
1048int dev_notice(const struct device *dev, const char *fmt, ...);
1049extern __printf(2, 3)
1050int _dev_info(const struct device *dev, const char *fmt, ...);
Joe Perches99bcf212010-06-27 01:02:34 +00001051
1052#else
1053
Joe Perches0a18b052012-09-25 18:19:57 -07001054static inline __printf(3, 0)
1055int dev_vprintk_emit(int level, const struct device *dev,
1056 const char *fmt, va_list args)
Joe Perches05e4e5b2012-09-12 20:13:37 -07001057{ return 0; }
1058static inline __printf(3, 4)
1059int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1060{ return 0; }
1061
Joe Perchescbc46632011-08-11 14:36:21 -04001062static inline int __dev_printk(const char *level, const struct device *dev,
1063 struct va_format *vaf)
Joe Perchesb9075fa2011-10-31 17:11:33 -07001064{ return 0; }
1065static inline __printf(3, 4)
1066int dev_printk(const char *level, const struct device *dev,
1067 const char *fmt, ...)
1068{ return 0; }
Joe Perches99bcf212010-06-27 01:02:34 +00001069
Joe Perchesb9075fa2011-10-31 17:11:33 -07001070static inline __printf(2, 3)
1071int dev_emerg(const struct device *dev, const char *fmt, ...)
1072{ return 0; }
1073static inline __printf(2, 3)
1074int dev_crit(const struct device *dev, const char *fmt, ...)
1075{ return 0; }
1076static inline __printf(2, 3)
1077int dev_alert(const struct device *dev, const char *fmt, ...)
1078{ return 0; }
1079static inline __printf(2, 3)
1080int dev_err(const struct device *dev, const char *fmt, ...)
1081{ return 0; }
1082static inline __printf(2, 3)
1083int dev_warn(const struct device *dev, const char *fmt, ...)
1084{ return 0; }
1085static inline __printf(2, 3)
1086int dev_notice(const struct device *dev, const char *fmt, ...)
1087{ return 0; }
1088static inline __printf(2, 3)
1089int _dev_info(const struct device *dev, const char *fmt, ...)
1090{ return 0; }
Joe Perches99bcf212010-06-27 01:02:34 +00001091
1092#endif
1093
1094/*
1095 * Stupid hackaround for existing uses of non-printk uses dev_info
1096 *
1097 * Note that the definition of dev_info below is actually _dev_info
1098 * and a macro is used to avoid redefining dev_info
1099 */
1100
1101#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -05001102
Jim Cromieb558c962011-12-19 17:11:18 -05001103#if defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +00001104#define dev_dbg(dev, format, ...) \
1105do { \
Jason Baron346e15b2008-08-12 16:46:19 -04001106 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +00001107} while (0)
Jim Cromieb558c962011-12-19 17:11:18 -05001108#elif defined(DEBUG)
1109#define dev_dbg(dev, format, arg...) \
1110 dev_printk(KERN_DEBUG, dev, format, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111#else
Joe Perches99bcf212010-06-27 01:02:34 +00001112#define dev_dbg(dev, format, arg...) \
1113({ \
1114 if (0) \
1115 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1116 0; \
1117})
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118#endif
1119
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001120#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1121do { \
1122 static DEFINE_RATELIMIT_STATE(_rs, \
1123 DEFAULT_RATELIMIT_INTERVAL, \
1124 DEFAULT_RATELIMIT_BURST); \
1125 if (__ratelimit(&_rs)) \
1126 dev_level(dev, fmt, ##__VA_ARGS__); \
1127} while (0)
1128
1129#define dev_emerg_ratelimited(dev, fmt, ...) \
1130 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1131#define dev_alert_ratelimited(dev, fmt, ...) \
1132 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1133#define dev_crit_ratelimited(dev, fmt, ...) \
1134 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1135#define dev_err_ratelimited(dev, fmt, ...) \
1136 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1137#define dev_warn_ratelimited(dev, fmt, ...) \
1138 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1139#define dev_notice_ratelimited(dev, fmt, ...) \
1140 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1141#define dev_info_ratelimited(dev, fmt, ...) \
1142 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001143#if defined(CONFIG_DYNAMIC_DEBUG)
1144/* descriptor check is first to prevent flooding with "callbacks suppressed" */
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001145#define dev_dbg_ratelimited(dev, fmt, ...) \
1146do { \
1147 static DEFINE_RATELIMIT_STATE(_rs, \
1148 DEFAULT_RATELIMIT_INTERVAL, \
1149 DEFAULT_RATELIMIT_BURST); \
1150 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1151 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1152 __ratelimit(&_rs)) \
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001153 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1154 ##__VA_ARGS__); \
1155} while (0)
1156#elif defined(DEBUG)
1157#define dev_dbg_ratelimited(dev, fmt, ...) \
1158do { \
1159 static DEFINE_RATELIMIT_STATE(_rs, \
1160 DEFAULT_RATELIMIT_INTERVAL, \
1161 DEFAULT_RATELIMIT_BURST); \
1162 if (__ratelimit(&_rs)) \
1163 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001164} while (0)
1165#else
1166#define dev_dbg_ratelimited(dev, fmt, ...) \
1167 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1168#endif
1169
David Brownellaebdc3b2007-07-12 22:08:22 -07001170#ifdef VERBOSE_DEBUG
1171#define dev_vdbg dev_dbg
1172#else
Joe Perches99bcf212010-06-27 01:02:34 +00001173#define dev_vdbg(dev, format, arg...) \
1174({ \
1175 if (0) \
1176 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1177 0; \
1178})
David Brownellaebdc3b2007-07-12 22:08:22 -07001179#endif
1180
Arjan van de Vene6139662008-09-20 19:08:39 -07001181/*
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001182 * dev_WARN*() acts like dev_printk(), but with the key difference of
1183 * using WARN/WARN_ONCE to include file/line information and a backtrace.
Arjan van de Vene6139662008-09-20 19:08:39 -07001184 */
1185#define dev_WARN(dev, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001186 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
Arjan van de Vene6139662008-09-20 19:08:39 -07001187
Felipe Balbibcdd3232011-03-16 15:59:35 +02001188#define dev_WARN_ONCE(dev, condition, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001189 WARN_ONCE(condition, "%s %s: " format, \
1190 dev_driver_string(dev), dev_name(dev), ## arg)
Felipe Balbibcdd3232011-03-16 15:59:35 +02001191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192/* Create alias, so I can be autoloaded. */
1193#define MODULE_ALIAS_CHARDEV(major,minor) \
1194 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1195#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1196 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +02001197
1198#ifdef CONFIG_SYSFS_DEPRECATED
1199extern long sysfs_deprecated;
1200#else
1201#define sysfs_deprecated 0
1202#endif
1203
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001204/**
1205 * module_driver() - Helper macro for drivers that don't do anything
1206 * special in module init/exit. This eliminates a lot of boilerplate.
1207 * Each module may only use this macro once, and calling it replaces
1208 * module_init() and module_exit().
1209 *
Randy Dunlap2eda0132012-01-21 11:02:51 -08001210 * @__driver: driver name
1211 * @__register: register function for this driver type
1212 * @__unregister: unregister function for this driver type
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001213 * @...: Additional arguments to be passed to __register and __unregister.
Randy Dunlap2eda0132012-01-21 11:02:51 -08001214 *
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001215 * Use this macro to construct bus specific macros for registering
1216 * drivers, and do not use it on its own.
1217 */
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001218#define module_driver(__driver, __register, __unregister, ...) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001219static int __init __driver##_init(void) \
1220{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001221 return __register(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001222} \
1223module_init(__driver##_init); \
1224static void __exit __driver##_exit(void) \
1225{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001226 __unregister(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001227} \
1228module_exit(__driver##_exit);
1229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230#endif /* _DEVICE_H_ */