blob: eeb33315514c332ddf83b9fcf4183a580555bab6 [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>
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +110029#include <asm/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031struct device;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080032struct device_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033struct device_driver;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080034struct driver_private;
Paul Gortmakerde477252011-05-26 13:46:22 -040035struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036struct class;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010037struct subsys_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010038struct bus_type;
Grant Likelyd706c1b2010-04-13 16:12:28 -070039struct device_node;
Joerg Roedelff217762011-08-26 16:48:26 +020040struct iommu_ops;
Alex Williamson74416e12012-05-30 14:18:41 -060041struct iommu_group;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010042
43struct bus_attribute {
44 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080045 ssize_t (*show)(struct bus_type *bus, char *buf);
46 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010047};
48
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080049#define BUS_ATTR(_name, _mode, _show, _store) \
50struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010051
52extern int __must_check bus_create_file(struct bus_type *,
53 struct bus_attribute *);
54extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Wanlong Gao880ffb52011-05-05 07:55:36 +080056/**
57 * struct bus_type - The bus type of the device
58 *
59 * @name: The name of the bus.
Kay Sieversca22e562011-12-14 14:29:38 -080060 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
61 * @dev_root: Default device to use as the parent.
Wanlong Gao880ffb52011-05-05 07:55:36 +080062 * @bus_attrs: Default attributes of the bus.
63 * @dev_attrs: Default attributes of the devices on the bus.
64 * @drv_attrs: Default attributes of the device drivers on the bus.
65 * @match: Called, perhaps multiple times, whenever a new device or driver
66 * is added for this bus. It should return a nonzero value if the
67 * given device can be handled by the given driver.
68 * @uevent: Called when a device is added, removed, or a few other things
69 * that generate uevents to add the environment variables.
70 * @probe: Called when a new device or driver add to this bus, and callback
71 * the specific driver's probe to initial the matched device.
72 * @remove: Called when a device removed from this bus.
73 * @shutdown: Called at shut-down time to quiesce the device.
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +020074 *
75 * @online: Called to put the device back online (after offlining it).
76 * @offline: Called to put the device offline for hot-removal. May fail.
77 *
Wanlong Gao880ffb52011-05-05 07:55:36 +080078 * @suspend: Called when a device on this bus wants to go to sleep mode.
79 * @resume: Called to bring a device on this bus out of sleep mode.
80 * @pm: Power management operations of this bus, callback the specific
81 * device driver's pm-ops.
Marcos Paulo de Souza7b08fae82011-11-01 11:15:40 -070082 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
Joerg Roedelff217762011-08-26 16:48:26 +020083 * driver implementations to a bus and allow the driver to do
84 * bus-specific setup
Wanlong Gao880ffb52011-05-05 07:55:36 +080085 * @p: The private data of the driver core, only the driver core can
86 * touch this.
87 *
88 * A bus is a channel between the processor and one or more devices. For the
89 * purposes of the device model, all devices are connected via a bus, even if
90 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
91 * A USB controller is usually a PCI device, for example. The device model
92 * represents the actual connections between buses and the devices they control.
93 * A bus is represented by the bus_type structure. It contains the name, the
94 * default attributes, the bus' methods, PM operations, and the driver core's
95 * private data.
96 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080098 const char *name;
Kay Sieversca22e562011-12-14 14:29:38 -080099 const char *dev_name;
100 struct device *dev_root;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800101 struct bus_attribute *bus_attrs;
102 struct device_attribute *dev_attrs;
103 struct driver_attribute *drv_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800105 int (*match)(struct device *dev, struct device_driver *drv);
106 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
107 int (*probe)(struct device *dev);
108 int (*remove)(struct device *dev);
109 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700110
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200111 int (*online)(struct device *dev);
112 int (*offline)(struct device *dev);
113
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800114 int (*suspend)(struct device *dev, pm_message_t state);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800115 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +0100116
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700117 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200118
Joerg Roedelff217762011-08-26 16:48:26 +0200119 struct iommu_ops *iommu_ops;
120
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100121 struct subsys_private *p;
Michal Hockobe871b72013-03-12 17:21:19 +0100122 struct lock_class_key lock_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
Michal Hockobe871b72013-03-12 17:21:19 +0100125extern int __must_check bus_register(struct bus_type *bus);
126
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800127extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800129extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131/* iterator helpers for buses */
Kay Sieversca22e562011-12-14 14:29:38 -0800132struct subsys_dev_iter {
133 struct klist_iter ki;
134 const struct device_type *type;
135};
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700136void subsys_dev_iter_init(struct subsys_dev_iter *iter,
Kay Sieversca22e562011-12-14 14:29:38 -0800137 struct bus_type *subsys,
138 struct device *start,
139 const struct device_type *type);
140struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
141void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800143int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
144 int (*fn)(struct device *dev, void *data));
145struct device *bus_find_device(struct bus_type *bus, struct device *start,
146 void *data,
147 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -0800148struct device *bus_find_device_by_name(struct bus_type *bus,
149 struct device *start,
150 const char *name);
Kay Sieversca22e562011-12-14 14:29:38 -0800151struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
152 struct device *hint);
Jean Delvarecc7447a2010-06-16 11:44:18 +0200153int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
154 void *data, int (*fn)(struct device_driver *, void *));
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -0500155void bus_sort_breadthfirst(struct bus_type *bus,
156 int (*compare)(const struct device *a,
157 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000158/*
159 * Bus notifiers: Get notified of addition/removal of devices
160 * and binding/unbinding of drivers to devices.
161 * In the long run, it should be a replacement for the platform
162 * notify hooks.
163 */
164struct notifier_block;
165
166extern int bus_register_notifier(struct bus_type *bus,
167 struct notifier_block *nb);
168extern int bus_unregister_notifier(struct bus_type *bus,
169 struct notifier_block *nb);
170
171/* All 4 notifers below get called with the target struct device *
172 * as an argument. Note that those functions are likely to be called
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800173 * with the device lock held in the core, so be careful.
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000174 */
175#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
176#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
Magnus Damm45daef02010-07-23 19:56:18 +0900177#define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
178 bound */
179#define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
180#define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000181 unbound */
Magnus Damm45daef02010-07-23 19:56:18 +0900182#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
Joerg Roedel309b7d62009-04-24 14:57:00 +0200183 from the device */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000184
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700185extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700186extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700187
Wanlong Gao880ffb52011-05-05 07:55:36 +0800188/**
189 * struct device_driver - The basic device driver structure
190 * @name: Name of the device driver.
191 * @bus: The bus which the device of this driver belongs to.
192 * @owner: The module owner.
193 * @mod_name: Used for built-in modules.
194 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
195 * @of_match_table: The open firmware table.
Mika Westerberg06f64c82012-10-31 22:44:33 +0100196 * @acpi_match_table: The ACPI match table.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800197 * @probe: Called to query the existence of a specific device,
198 * whether this driver can work with it, and bind the driver
199 * to a specific device.
200 * @remove: Called when the device is removed from the system to
201 * unbind a device from this driver.
202 * @shutdown: Called at shut-down time to quiesce the device.
203 * @suspend: Called to put the device to sleep mode. Usually to a
204 * low power state.
205 * @resume: Called to bring a device from sleep mode.
206 * @groups: Default attributes that get created by the driver core
207 * automatically.
208 * @pm: Power management operations of the device which matched
209 * this driver.
210 * @p: Driver core's private data, no one other than the driver
211 * core can touch this.
212 *
213 * The device driver-model tracks all of the drivers known to the system.
214 * The main reason for this tracking is to enable the driver core to match
215 * up drivers with new devices. Once drivers are known objects within the
216 * system, however, a number of other things become possible. Device drivers
217 * can export information and configuration variables that are independent
218 * of any specific device.
219 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800221 const char *name;
222 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800224 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700225 const char *mod_name; /* used for built-in modules */
226
227 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Grant Likely597b9d12010-04-13 16:13:01 -0700229 const struct of_device_id *of_match_table;
Mika Westerberg06f64c82012-10-31 22:44:33 +0100230 const struct acpi_device_id *acpi_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700231
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800232 int (*probe) (struct device *dev);
233 int (*remove) (struct device *dev);
234 void (*shutdown) (struct device *dev);
235 int (*suspend) (struct device *dev, pm_message_t state);
236 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700237 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800238
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700239 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200240
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800241 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242};
243
244
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800245extern int __must_check driver_register(struct device_driver *drv);
246extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800248extern struct device_driver *driver_find(const char *name,
249 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700250extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800251extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100254/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800257 struct attribute attr;
258 ssize_t (*show)(struct device_driver *driver, char *buf);
259 ssize_t (*store)(struct device_driver *driver, const char *buf,
260 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261};
262
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800263#define DRIVER_ATTR(_name, _mode, _show, _store) \
264struct driver_attribute driver_attr_##_name = \
265 __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800267extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200268 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800269extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200270 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800272extern int __must_check driver_for_each_device(struct device_driver *drv,
273 struct device *start,
274 void *data,
275 int (*fn)(struct device *dev,
276 void *));
277struct device *driver_find_device(struct device_driver *drv,
278 struct device *start, void *data,
279 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800280
Wanlong Gao880ffb52011-05-05 07:55:36 +0800281/**
Kay Sieversca22e562011-12-14 14:29:38 -0800282 * struct subsys_interface - interfaces to device functions
Randy Dunlap2eda0132012-01-21 11:02:51 -0800283 * @name: name of the device function
284 * @subsys: subsytem of the devices to attach to
285 * @node: the list of functions registered at the subsystem
286 * @add_dev: device hookup to device function handler
287 * @remove_dev: device hookup to device function handler
Kay Sieversca22e562011-12-14 14:29:38 -0800288 *
289 * Simple interfaces attached to a subsystem. Multiple interfaces can
290 * attach to a subsystem and its devices. Unlike drivers, they do not
291 * exclusively claim or control devices. Interfaces usually represent
292 * a specific functionality of a subsystem/class of devices.
293 */
294struct subsys_interface {
295 const char *name;
296 struct bus_type *subsys;
297 struct list_head node;
298 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
299 int (*remove_dev)(struct device *dev, struct subsys_interface *sif);
300};
301
302int subsys_interface_register(struct subsys_interface *sif);
303void subsys_interface_unregister(struct subsys_interface *sif);
304
305int subsys_system_register(struct bus_type *subsys,
306 const struct attribute_group **groups);
Tejun Heod73ce002013-03-12 11:30:05 -0700307int subsys_virtual_register(struct bus_type *subsys,
308 const struct attribute_group **groups);
Kay Sieversca22e562011-12-14 14:29:38 -0800309
310/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800311 * struct class - device classes
312 * @name: Name of the class.
313 * @owner: The module owner.
314 * @class_attrs: Default attributes of this class.
315 * @dev_attrs: Default attributes of the devices belong to the class.
316 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
317 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
318 * @dev_uevent: Called when a device is added, removed from this class, or a
319 * few other things that generate uevents to add the environment
320 * variables.
321 * @devnode: Callback to provide the devtmpfs.
322 * @class_release: Called to release this class.
323 * @dev_release: Called to release the device.
324 * @suspend: Used to put the device to sleep mode, usually to a low power
325 * state.
326 * @resume: Used to bring the device from the sleep mode.
327 * @ns_type: Callbacks so sysfs can detemine namespaces.
328 * @namespace: Namespace of the device belongs to this class.
329 * @pm: The default device power management operations of this class.
330 * @p: The private data of the driver core, no one other than the
331 * driver core can touch this.
332 *
333 * A class is a higher-level view of a device that abstracts out low-level
334 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
335 * at the class level, they are all simply disks. Classes allow user space
336 * to work with devices based on what they do, rather than how they are
337 * connected or how they work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 */
339struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800340 const char *name;
341 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800343 struct class_attribute *class_attrs;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800344 struct device_attribute *dev_attrs;
Stefan Achatzc97415a2010-11-26 19:57:29 +0000345 struct bin_attribute *dev_bin_attrs;
Dan Williamse105b8b2008-04-21 10:51:07 -0700346 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800348 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Al Viro2c9ede52011-07-23 20:24:48 -0400349 char *(*devnode)(struct device *dev, umode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800351 void (*class_release)(struct class *class);
352 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700353
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800354 int (*suspend)(struct device *dev, pm_message_t state);
355 int (*resume)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200356
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700357 const struct kobj_ns_type_operations *ns_type;
358 const void *(*namespace)(struct device *dev);
359
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700360 const struct dev_pm_ops *pm;
361
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100362 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363};
364
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200365struct class_dev_iter {
366 struct klist_iter ki;
367 const struct device_type *type;
368};
369
Dan Williamse105b8b2008-04-21 10:51:07 -0700370extern struct kobject *sysfs_dev_block_kobj;
371extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700372extern int __must_check __class_register(struct class *class,
373 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800374extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700375
376/* This is a #define to keep the compiler from merging different
377 * instances of the __key variable */
378#define class_register(class) \
379({ \
380 static struct lock_class_key __key; \
381 __class_register(class, &__key); \
382})
383
Jean Delvare46227092009-08-04 12:55:34 +0200384struct class_compat;
385struct class_compat *class_compat_register(const char *name);
386void class_compat_unregister(struct class_compat *cls);
387int class_compat_create_link(struct class_compat *cls, struct device *dev,
388 struct device *device_link);
389void class_compat_remove_link(struct class_compat *cls, struct device *dev,
390 struct device *device_link);
391
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700392extern void class_dev_iter_init(struct class_dev_iter *iter,
393 struct class *class,
394 struct device *start,
395 const struct device_type *type);
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200396extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
397extern void class_dev_iter_exit(struct class_dev_iter *iter);
398
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400399extern int class_for_each_device(struct class *class, struct device *start,
400 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800401 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400402extern struct device *class_find_device(struct class *class,
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100403 struct device *start, const void *data,
404 int (*match)(struct device *, const void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800407 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100408 ssize_t (*show)(struct class *class, struct class_attribute *attr,
409 char *buf);
410 ssize_t (*store)(struct class *class, struct class_attribute *attr,
411 const char *buf, size_t count);
Eric W. Biederman672d82c2011-10-12 21:55:08 +0000412 const void *(*namespace)(struct class *class,
413 const struct class_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414};
415
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800416#define CLASS_ATTR(_name, _mode, _show, _store) \
417struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800419extern int __must_check class_create_file(struct class *class,
420 const struct class_attribute *attr);
421extern void class_remove_file(struct class *class,
422 const struct class_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Andi Kleen869dfc82010-01-05 12:48:08 +0100424/* Simple class attribute that is just a static string */
425
426struct class_attribute_string {
427 struct class_attribute attr;
428 char *str;
429};
430
431/* Currently read-only only */
432#define _CLASS_ATTR_STRING(_name, _mode, _str) \
433 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
434#define CLASS_ATTR_STRING(_name, _mode, _str) \
435 struct class_attribute_string class_attr_##_name = \
436 _CLASS_ATTR_STRING(_name, _mode, _str)
437
438extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
439 char *buf);
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441struct class_interface {
442 struct list_head node;
443 struct class *class;
444
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200445 int (*add_dev) (struct device *, struct class_interface *);
446 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447};
448
Andrew Morton4a7fb632006-08-14 22:43:17 -0700449extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450extern void class_interface_unregister(struct class_interface *);
451
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700452extern struct class * __must_check __class_create(struct module *owner,
453 const char *name,
454 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800455extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800456
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700457/* This is a #define to keep the compiler from merging different
458 * instances of the __key variable */
459#define class_create(owner, name) \
460({ \
461 static struct lock_class_key __key; \
462 __class_create(owner, name, &__key); \
463})
464
Kay Sievers414264f2007-03-12 21:08:57 +0100465/*
466 * The type of device, "struct device" is embedded in. A class
467 * or bus can contain devices of different types
468 * like "partitions" and "disks", "mouse" and "event".
469 * This identifies the device type and carries type-specific
470 * information, equivalent to the kobj_type of a kobject.
471 * If "name" is specified, the uevent will contain it in
472 * the DEVTYPE variable.
473 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200474struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100475 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700476 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200477 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sievers3c2670e2013-04-06 09:56:00 -0700478 char *(*devnode)(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700479 kuid_t *uid, kgid_t *gid);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200480 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200481
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700482 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200483};
484
Kay Sieversa7fd6702005-10-01 14:49:43 +0200485/* interface for exporting device attributes */
486struct device_attribute {
487 struct attribute attr;
488 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
489 char *buf);
490 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
491 const char *buf, size_t count);
492};
493
Kay Sieversca22e562011-12-14 14:29:38 -0800494struct dev_ext_attribute {
495 struct device_attribute attr;
496 void *var;
497};
Kay Sieversa7fd6702005-10-01 14:49:43 +0200498
Kay Sieversca22e562011-12-14 14:29:38 -0800499ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
500 char *buf);
501ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
502 const char *buf, size_t count);
503ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
504 char *buf);
505ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
506 const char *buf, size_t count);
Borislav Petkov91872392012-10-09 19:52:05 +0200507ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
508 char *buf);
509ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
510 const char *buf, size_t count);
Kay Sieversca22e562011-12-14 14:29:38 -0800511
Kay Sieversa7fd6702005-10-01 14:49:43 +0200512#define DEVICE_ATTR(_name, _mode, _show, _store) \
Kay Sieversca22e562011-12-14 14:29:38 -0800513 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
514#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
515 struct dev_ext_attribute dev_attr_##_name = \
516 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
517#define DEVICE_INT_ATTR(_name, _mode, _var) \
518 struct dev_ext_attribute dev_attr_##_name = \
Michael Davidson94758182012-05-03 16:19:02 -0700519 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
Borislav Petkov91872392012-10-09 19:52:05 +0200520#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
521 struct dev_ext_attribute dev_attr_##_name = \
522 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
Alan Stern356c05d2012-05-14 13:30:03 -0400523#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
524 struct device_attribute dev_attr_##_name = \
525 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200526
Greg Kroah-Hartmanb9d4e712012-01-04 15:05:10 -0800527extern int device_create_file(struct device *device,
528 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800529extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200530 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700531extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200532 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700533extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200534 const struct bin_attribute *attr);
Alan Stern523ded72007-04-26 00:12:04 -0700535extern int device_schedule_callback_owner(struct device *dev,
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800536 void (*func)(struct device *dev), struct module *owner);
Alan Stern523ded72007-04-26 00:12:04 -0700537
538/* This is a macro to avoid include problems with THIS_MODULE */
539#define device_schedule_callback(dev, func) \
540 device_schedule_callback_owner(dev, func, THIS_MODULE)
Tejun Heo9ac78492007-01-20 16:00:26 +0900541
542/* device resource management */
543typedef void (*dr_release_t)(struct device *dev, void *res);
544typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
545
546#ifdef CONFIG_DEBUG_DEVRES
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800547extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
Tejun Heo9ac78492007-01-20 16:00:26 +0900548 const char *name);
549#define devres_alloc(release, size, gfp) \
550 __devres_alloc(release, size, gfp, #release)
551#else
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800552extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900553#endif
Ming Leibddb1b92012-08-04 12:01:26 +0800554extern void devres_for_each_res(struct device *dev, dr_release_t release,
555 dr_match_t match, void *match_data,
556 void (*fn)(struct device *, void *, void *),
557 void *data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900558extern void devres_free(void *res);
559extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800560extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900561 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800562extern void *devres_get(struct device *dev, void *new_res,
563 dr_match_t match, void *match_data);
564extern void *devres_remove(struct device *dev, dr_release_t release,
565 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900566extern int devres_destroy(struct device *dev, dr_release_t release,
567 dr_match_t match, void *match_data);
Mark Brownd926d0e2012-05-03 18:15:13 +0100568extern int devres_release(struct device *dev, dr_release_t release,
569 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900570
571/* devres group */
572extern void * __must_check devres_open_group(struct device *dev, void *id,
573 gfp_t gfp);
574extern void devres_close_group(struct device *dev, void *id);
575extern void devres_remove_group(struct device *dev, void *id);
576extern int devres_release_group(struct device *dev, void *id);
577
578/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
579extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
580extern void devm_kfree(struct device *dev, void *p);
581
Thierry Reding75096572013-01-21 11:08:54 +0100582void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200583void __iomem *devm_request_and_ioremap(struct device *dev,
584 struct resource *res);
585
Dmitry Torokhovd6b0c582013-02-23 13:11:14 -0800586/* allows to add/remove a custom action to devres stack */
587int devm_add_action(struct device *dev, void (*action)(void *), void *data);
588void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
589
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800590struct device_dma_parameters {
591 /*
592 * a low level driver may set these to teach IOMMU code about
593 * sg limitations.
594 */
595 unsigned int max_segment_size;
596 unsigned long segment_boundary_mask;
597};
598
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100599struct acpi_dev_node {
600#ifdef CONFIG_ACPI
601 void *handle;
602#endif
603};
604
Wanlong Gao880ffb52011-05-05 07:55:36 +0800605/**
606 * struct device - The basic device structure
607 * @parent: The device's "parent" device, the device to which it is attached.
608 * In most cases, a parent device is some sort of bus or host
609 * controller. If parent is NULL, the device, is a top-level device,
610 * which is not usually what you want.
611 * @p: Holds the private data of the driver core portions of the device.
612 * See the comment of the struct device_private for detail.
613 * @kobj: A top-level, abstract class from which other classes are derived.
614 * @init_name: Initial name of the device.
615 * @type: The type of device.
616 * This identifies the device type and carries type-specific
617 * information.
618 * @mutex: Mutex to synchronize calls to its driver.
619 * @bus: Type of bus device is on.
620 * @driver: Which driver has allocated this
621 * @platform_data: Platform data specific to the device.
622 * Example: For devices on custom boards, as typical of embedded
623 * and SOC based hardware, Linux often uses platform_data to point
624 * to board-specific structures describing devices and how they
625 * are wired. That can include what ports are available, chip
626 * variants, which GPIO pins act in what additional roles, and so
627 * on. This shrinks the "Board Support Packages" (BSPs) and
628 * minimizes board-specific #ifdefs in drivers.
629 * @power: For device power management.
630 * See Documentation/power/devices.txt for details.
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200631 * @pm_domain: Provide callbacks that are executed during system suspend,
Wanlong Gao880ffb52011-05-05 07:55:36 +0800632 * hibernation, system resume and during runtime PM transitions
633 * along with subsystem-level and driver-level callbacks.
Linus Walleijab780292013-01-22 10:56:14 -0700634 * @pins: For device pin management.
635 * See Documentation/pinctrl.txt for details.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800636 * @numa_node: NUMA node this device is close to.
637 * @dma_mask: Dma mask (if dma'ble device).
638 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
639 * hardware supports 64-bit addresses for consistent allocations
640 * such descriptors.
641 * @dma_parms: A low level driver may set these to teach IOMMU code about
642 * segment limitations.
643 * @dma_pools: Dma pools (if dma'ble device).
644 * @dma_mem: Internal for coherent mem override.
645 * @archdata: For arch-specific additions.
646 * @of_node: Associated device tree node.
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100647 * @acpi_node: Associated ACPI device node.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800648 * @devt: For creating the sysfs "dev".
Randy Dunlap2eda0132012-01-21 11:02:51 -0800649 * @id: device instance
Wanlong Gao880ffb52011-05-05 07:55:36 +0800650 * @devres_lock: Spinlock to protect the resource of the device.
651 * @devres_head: The resources list of the device.
652 * @knode_class: The node used to add the device to the class list.
653 * @class: The class of the device.
654 * @groups: Optional attribute groups.
655 * @release: Callback to free the device after all references have
656 * gone away. This should be set by the allocator of the
657 * device (i.e. the bus driver that discovered the device).
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200658 * @offline_disabled: If set, the device is permanently online.
659 * @offline: Set after successful invocation of bus type's .offline().
Wanlong Gao880ffb52011-05-05 07:55:36 +0800660 *
661 * At the lowest level, every device in a Linux system is represented by an
662 * instance of struct device. The device structure contains the information
663 * that the device model core needs to model the system. Most subsystems,
664 * however, track additional information about the devices they host. As a
665 * result, it is rare for devices to be represented by bare device structures;
666 * instead, that structure, like kobject structures, is usually embedded within
667 * a higher-level representation of the device.
668 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700670 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800672 struct device_private *p;
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700675 const char *init_name; /* initial name of the device */
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700676 const struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Thomas Gleixner31427882010-01-29 20:39:02 +0000678 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800679 * its driver.
680 */
681
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800682 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 struct device_driver *driver; /* which driver has allocated this
684 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800685 void *platform_data; /* Platform specific data, device
686 core doesn't touch it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 struct dev_pm_info power;
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200688 struct dev_pm_domain *pm_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Linus Walleijab780292013-01-22 10:56:14 -0700690#ifdef CONFIG_PINCTRL
691 struct dev_pin_info *pins;
692#endif
693
Christoph Hellwig87348132006-12-06 20:32:33 -0800694#ifdef CONFIG_NUMA
695 int numa_node; /* NUMA node this device is close to */
696#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 u64 *dma_mask; /* dma mask (if dma'able device) */
698 u64 coherent_dma_mask;/* Like dma_mask, but for
699 alloc_coherent mappings as
700 not all hardware supports
701 64 bit addresses for consistent
702 allocations such descriptors. */
703
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800704 struct device_dma_parameters *dma_parms;
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 struct list_head dma_pools; /* dma pools (if dma'ble) */
707
708 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
709 override */
Marek Szyprowskic64be2b2011-12-29 13:09:51 +0100710#ifdef CONFIG_CMA
711 struct cma *cma_area; /* contiguous memory area for dma
712 allocations */
713#endif
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100714 /* arch specific additions */
715 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700716
717 struct device_node *of_node; /* associated device tree node */
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100718 struct acpi_dev_node acpi_node; /* associated ACPI device node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600720 dev_t devt; /* dev_t, creates the sysfs "dev" */
Kay Sieversca22e562011-12-14 14:29:38 -0800721 u32 id; /* device instance */
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600722
Tejun Heo9ac78492007-01-20 16:00:26 +0900723 spinlock_t devres_lock;
724 struct list_head devres_head;
725
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200726 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200727 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700728 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700729
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800730 void (*release)(struct device *dev);
Alex Williamson74416e12012-05-30 14:18:41 -0600731 struct iommu_group *iommu_group;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200732
733 bool offline_disabled:1;
734 bool offline:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735};
736
Lars-Peter Clausena4232962012-07-03 18:49:35 +0200737static inline struct device *kobj_to_dev(struct kobject *kobj)
738{
739 return container_of(kobj, struct device, kobj);
740}
741
Rafael J. Wysocki95f8a082012-11-21 00:21:50 +0100742#ifdef CONFIG_ACPI
743#define ACPI_HANDLE(dev) ((dev)->acpi_node.handle)
744#define ACPI_HANDLE_SET(dev, _handle_) (dev)->acpi_node.handle = (_handle_)
745#else
746#define ACPI_HANDLE(dev) (NULL)
747#define ACPI_HANDLE_SET(dev, _handle_) do { } while (0)
748#endif
749
Alan Stern9a3df1f2008-03-19 22:39:13 +0100750/* Get the wakeup routines, which depend on struct device */
751#include <linux/pm_wakeup.h>
752
Jean Delvarebf9ca692008-07-30 12:29:21 -0700753static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200754{
Paul Mundta636ee72010-03-09 06:57:53 +0000755 /* Use the init name until the kobject becomes available */
756 if (dev->init_name)
757 return dev->init_name;
758
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100759 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200760}
761
Joe Perchesb9075fa2011-10-31 17:11:33 -0700762extern __printf(2, 3)
763int dev_set_name(struct device *dev, const char *name, ...);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000764
Christoph Hellwig87348132006-12-06 20:32:33 -0800765#ifdef CONFIG_NUMA
766static inline int dev_to_node(struct device *dev)
767{
768 return dev->numa_node;
769}
770static inline void set_dev_node(struct device *dev, int node)
771{
772 dev->numa_node = node;
773}
774#else
775static inline int dev_to_node(struct device *dev)
776{
777 return -1;
778}
779static inline void set_dev_node(struct device *dev, int node)
780{
781}
782#endif
783
Rafael J. Wysocki5c095a02011-08-25 15:33:50 +0200784static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
785{
786 return dev ? dev->power.subsys_data : NULL;
787}
788
Ming Leif67f1292009-03-01 21:10:49 +0800789static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
790{
791 return dev->kobj.uevent_suppress;
792}
793
794static inline void dev_set_uevent_suppress(struct device *dev, int val)
795{
796 dev->kobj.uevent_suppress = val;
797}
798
Daniel Ritzd305ef52005-09-22 00:47:24 -0700799static inline int device_is_registered(struct device *dev)
800{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -0400801 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700802}
803
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100804static inline void device_enable_async_suspend(struct device *dev)
805{
Alan Sternf76b168b2011-06-18 20:22:23 +0200806 if (!dev->power.is_prepared)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +0100807 dev->power.async_suspend = true;
808}
809
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100810static inline void device_disable_async_suspend(struct device *dev)
811{
Alan Sternf76b168b2011-06-18 20:22:23 +0200812 if (!dev->power.is_prepared)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +0100813 dev->power.async_suspend = false;
814}
815
816static inline bool device_async_suspend_enabled(struct device *dev)
817{
818 return !!dev->power.async_suspend;
819}
820
Rafael J. Wysocki8b258cc2011-11-17 21:39:33 +0100821static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
822{
823 dev->power.ignore_children = enable;
824}
825
Rafael J. Wysockifeb70af2012-08-13 14:00:25 +0200826static inline void dev_pm_syscore_device(struct device *dev, bool val)
827{
828#ifdef CONFIG_PM_SLEEP
829 dev->power.syscore = val;
830#endif
831}
832
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800833static inline void device_lock(struct device *dev)
834{
Thomas Gleixner31427882010-01-29 20:39:02 +0000835 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800836}
837
838static inline int device_trylock(struct device *dev)
839{
Thomas Gleixner31427882010-01-29 20:39:02 +0000840 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800841}
842
843static inline void device_unlock(struct device *dev)
844{
Thomas Gleixner31427882010-01-29 20:39:02 +0000845 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800846}
847
Adrian Bunk1f217822006-12-19 13:01:28 -0800848void driver_init(void);
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850/*
851 * High level routines for use by the bus drivers
852 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800853extern int __must_check device_register(struct device *dev);
854extern void device_unregister(struct device *dev);
855extern void device_initialize(struct device *dev);
856extern int __must_check device_add(struct device *dev);
857extern void device_del(struct device *dev);
858extern int device_for_each_child(struct device *dev, void *data,
859 int (*fn)(struct device *dev, void *data));
860extern struct device *device_find_child(struct device *dev, void *data,
861 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +0200862extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +0100863extern int device_move(struct device *dev, struct device *new_parent,
864 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +0200865extern const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700866 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -0700867 const char **tmp);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -0700868extern void *dev_get_drvdata(const struct device *dev);
Uwe Kleine-Königc8705082011-04-20 09:44:46 +0200869extern int dev_set_drvdata(struct device *dev, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200871static inline bool device_supports_offline(struct device *dev)
872{
873 return dev->bus && dev->bus->offline && dev->bus->online;
874}
875
876extern void lock_device_hotplug(void);
877extern void unlock_device_hotplug(void);
878extern int device_offline(struct device *dev);
879extern int device_online(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000881 * Root device objects for grouping under /sys/devices
882 */
883extern struct device *__root_device_register(const char *name,
884 struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400885
886/*
887 * This is a macro to avoid include problems with THIS_MODULE,
888 * just as per what is done for device_schedule_callback() above.
889 */
890#define root_device_register(name) \
891 __root_device_register(name, THIS_MODULE)
892
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000893extern void root_device_unregister(struct device *root);
894
Mark Browna5b8b1a2009-07-17 15:06:08 +0100895static inline void *dev_get_platdata(const struct device *dev)
896{
897 return dev->platform_data;
898}
899
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +0000900/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 * Manual binding of a device to driver. See drivers/base/bus.c
902 * for information on use.
903 */
Andrew Mortonf86db392006-08-14 22:43:20 -0700904extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800905extern void device_release_driver(struct device *dev);
906extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -0700907extern int __must_check driver_attach(struct device_driver *drv);
908extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700910/*
911 * Easy functions for dynamically creating devices on the fly
912 */
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -0700913extern struct device *device_create_vargs(struct class *cls,
914 struct device *parent,
915 dev_t devt,
916 void *drvdata,
917 const char *fmt,
918 va_list vargs);
Joe Perchesb9075fa2011-10-31 17:11:33 -0700919extern __printf(5, 6)
920struct device *device_create(struct class *cls, struct device *parent,
921 dev_t devt, void *drvdata,
922 const char *fmt, ...);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700923extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925/*
926 * Platform "fixup" functions - allow the platform to have their say
927 * about devices and actions that the general device layer doesn't
928 * know about.
929 */
930/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800931extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800933extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935
Wanlong Gao880ffb52011-05-05 07:55:36 +0800936/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 * get_device - atomically increment the reference count for the device.
938 *
939 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800940extern struct device *get_device(struct device *dev);
941extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
Kay Sievers2b2af542009-04-30 15:23:42 +0200943#ifdef CONFIG_DEVTMPFS
944extern int devtmpfs_create_node(struct device *dev);
945extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +0100946extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +0200947#else
948static inline int devtmpfs_create_node(struct device *dev) { return 0; }
949static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
950static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
951#endif
952
Rytchkov Alexey116f232b2006-03-22 00:58:53 +0100953/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954extern void device_shutdown(void);
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -0700957extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Joe Perches99bcf212010-06-27 01:02:34 +0000959
960#ifdef CONFIG_PRINTK
961
Joe Perches0a18b052012-09-25 18:19:57 -0700962extern __printf(3, 0)
963int dev_vprintk_emit(int level, const struct device *dev,
964 const char *fmt, va_list args);
Joe Perches05e4e5b2012-09-12 20:13:37 -0700965extern __printf(3, 4)
966int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
Joe Perches798efc62012-09-12 20:11:29 -0700967
Joe Perchesb9075fa2011-10-31 17:11:33 -0700968extern __printf(3, 4)
969int dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -0700970 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -0700971extern __printf(2, 3)
972int dev_emerg(const struct device *dev, const char *fmt, ...);
973extern __printf(2, 3)
974int dev_alert(const struct device *dev, const char *fmt, ...);
975extern __printf(2, 3)
976int dev_crit(const struct device *dev, const char *fmt, ...);
977extern __printf(2, 3)
978int dev_err(const struct device *dev, const char *fmt, ...);
979extern __printf(2, 3)
980int dev_warn(const struct device *dev, const char *fmt, ...);
981extern __printf(2, 3)
982int dev_notice(const struct device *dev, const char *fmt, ...);
983extern __printf(2, 3)
984int _dev_info(const struct device *dev, const char *fmt, ...);
Joe Perches99bcf212010-06-27 01:02:34 +0000985
986#else
987
Joe Perches0a18b052012-09-25 18:19:57 -0700988static inline __printf(3, 0)
989int dev_vprintk_emit(int level, const struct device *dev,
990 const char *fmt, va_list args)
Joe Perches05e4e5b2012-09-12 20:13:37 -0700991{ return 0; }
992static inline __printf(3, 4)
993int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
994{ return 0; }
995
Joe Perchescbc46632011-08-11 14:36:21 -0400996static inline int __dev_printk(const char *level, const struct device *dev,
997 struct va_format *vaf)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700998{ return 0; }
999static inline __printf(3, 4)
1000int dev_printk(const char *level, const struct device *dev,
1001 const char *fmt, ...)
1002{ return 0; }
Joe Perches99bcf212010-06-27 01:02:34 +00001003
Joe Perchesb9075fa2011-10-31 17:11:33 -07001004static inline __printf(2, 3)
1005int dev_emerg(const struct device *dev, const char *fmt, ...)
1006{ return 0; }
1007static inline __printf(2, 3)
1008int dev_crit(const struct device *dev, const char *fmt, ...)
1009{ return 0; }
1010static inline __printf(2, 3)
1011int dev_alert(const struct device *dev, const char *fmt, ...)
1012{ return 0; }
1013static inline __printf(2, 3)
1014int dev_err(const struct device *dev, const char *fmt, ...)
1015{ return 0; }
1016static inline __printf(2, 3)
1017int dev_warn(const struct device *dev, const char *fmt, ...)
1018{ return 0; }
1019static inline __printf(2, 3)
1020int dev_notice(const struct device *dev, const char *fmt, ...)
1021{ return 0; }
1022static inline __printf(2, 3)
1023int _dev_info(const struct device *dev, const char *fmt, ...)
1024{ return 0; }
Joe Perches99bcf212010-06-27 01:02:34 +00001025
1026#endif
1027
1028/*
1029 * Stupid hackaround for existing uses of non-printk uses dev_info
1030 *
1031 * Note that the definition of dev_info below is actually _dev_info
1032 * and a macro is used to avoid redefining dev_info
1033 */
1034
1035#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -05001036
Jim Cromieb558c962011-12-19 17:11:18 -05001037#if defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +00001038#define dev_dbg(dev, format, ...) \
1039do { \
Jason Baron346e15b2008-08-12 16:46:19 -04001040 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +00001041} while (0)
Jim Cromieb558c962011-12-19 17:11:18 -05001042#elif defined(DEBUG)
1043#define dev_dbg(dev, format, arg...) \
1044 dev_printk(KERN_DEBUG, dev, format, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045#else
Joe Perches99bcf212010-06-27 01:02:34 +00001046#define dev_dbg(dev, format, arg...) \
1047({ \
1048 if (0) \
1049 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1050 0; \
1051})
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052#endif
1053
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001054#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1055do { \
1056 static DEFINE_RATELIMIT_STATE(_rs, \
1057 DEFAULT_RATELIMIT_INTERVAL, \
1058 DEFAULT_RATELIMIT_BURST); \
1059 if (__ratelimit(&_rs)) \
1060 dev_level(dev, fmt, ##__VA_ARGS__); \
1061} while (0)
1062
1063#define dev_emerg_ratelimited(dev, fmt, ...) \
1064 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1065#define dev_alert_ratelimited(dev, fmt, ...) \
1066 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1067#define dev_crit_ratelimited(dev, fmt, ...) \
1068 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1069#define dev_err_ratelimited(dev, fmt, ...) \
1070 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1071#define dev_warn_ratelimited(dev, fmt, ...) \
1072 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1073#define dev_notice_ratelimited(dev, fmt, ...) \
1074 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1075#define dev_info_ratelimited(dev, fmt, ...) \
1076 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1077#if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
1078#define dev_dbg_ratelimited(dev, fmt, ...) \
1079do { \
1080 static DEFINE_RATELIMIT_STATE(_rs, \
1081 DEFAULT_RATELIMIT_INTERVAL, \
1082 DEFAULT_RATELIMIT_BURST); \
1083 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1084 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1085 __ratelimit(&_rs)) \
1086 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
1087 ##__VA_ARGS__); \
1088} while (0)
1089#else
1090#define dev_dbg_ratelimited(dev, fmt, ...) \
1091 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1092#endif
1093
David Brownellaebdc3b2007-07-12 22:08:22 -07001094#ifdef VERBOSE_DEBUG
1095#define dev_vdbg dev_dbg
1096#else
Joe Perches99bcf212010-06-27 01:02:34 +00001097#define dev_vdbg(dev, format, arg...) \
1098({ \
1099 if (0) \
1100 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1101 0; \
1102})
David Brownellaebdc3b2007-07-12 22:08:22 -07001103#endif
1104
Arjan van de Vene6139662008-09-20 19:08:39 -07001105/*
Felipe Balbibcdd3232011-03-16 15:59:35 +02001106 * dev_WARN*() acts like dev_printk(), but with the key difference
Arjan van de Vene6139662008-09-20 19:08:39 -07001107 * of using a WARN/WARN_ON to get the message out, including the
1108 * file/line information and a backtrace.
1109 */
1110#define dev_WARN(dev, format, arg...) \
1111 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1112
Felipe Balbibcdd3232011-03-16 15:59:35 +02001113#define dev_WARN_ONCE(dev, condition, format, arg...) \
1114 WARN_ONCE(condition, "Device %s\n" format, \
1115 dev_driver_string(dev), ## arg)
1116
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117/* Create alias, so I can be autoloaded. */
1118#define MODULE_ALIAS_CHARDEV(major,minor) \
1119 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1120#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1121 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +02001122
1123#ifdef CONFIG_SYSFS_DEPRECATED
1124extern long sysfs_deprecated;
1125#else
1126#define sysfs_deprecated 0
1127#endif
1128
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001129/**
1130 * module_driver() - Helper macro for drivers that don't do anything
1131 * special in module init/exit. This eliminates a lot of boilerplate.
1132 * Each module may only use this macro once, and calling it replaces
1133 * module_init() and module_exit().
1134 *
Randy Dunlap2eda0132012-01-21 11:02:51 -08001135 * @__driver: driver name
1136 * @__register: register function for this driver type
1137 * @__unregister: unregister function for this driver type
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001138 * @...: Additional arguments to be passed to __register and __unregister.
Randy Dunlap2eda0132012-01-21 11:02:51 -08001139 *
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001140 * Use this macro to construct bus specific macros for registering
1141 * drivers, and do not use it on its own.
1142 */
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001143#define module_driver(__driver, __register, __unregister, ...) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001144static int __init __driver##_init(void) \
1145{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001146 return __register(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001147} \
1148module_init(__driver##_init); \
1149static void __exit __driver##_exit(void) \
1150{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001151 __unregister(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001152} \
1153module_exit(__driver##_exit);
1154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155#endif /* _DEVICE_H_ */