Blame view

include/linux/device.h 31.3 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
  /*
   * device.h - generic, centralized driver model
   *
   * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
b40284378   Greg Kroah-Hartman   Driver core: move...
5
6
   * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
   * Copyright (c) 2008-2009 Novell Inc.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
7
8
9
10
11
12
13
14
   *
   * This file is released under the GPLv2
   *
   * See Documentation/driver-model/ for more information.
   */
  
  #ifndef _DEVICE_H_
  #define _DEVICE_H_
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
15
16
  #include <linux/ioport.h>
  #include <linux/kobject.h>
465c7a3a3   Patrick Mochel   [PATCH] Add a kli...
17
  #include <linux/klist.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
18
  #include <linux/list.h>
d2a3b9146   Matthew Wilcox   class: add lockde...
19
  #include <linux/lockdep.h>
4a7fb6363   Andrew Morton   add __must_check ...
20
  #include <linux/compiler.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
21
  #include <linux/types.h>
de4772542   Paul Gortmaker   include: replace ...
22
  #include <linux/mutex.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
23
  #include <linux/pm.h>
60063497a   Arun Sharma   atomic: use <linu...
24
  #include <linux/atomic.h>
c6dbaef22   Benjamin Herrenschmidt   Driver core: add ...
25
  #include <asm/device.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
27
  struct device;
fb069a5d1   Greg Kroah-Hartman   driver core: crea...
28
  struct device_private;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
29
  struct device_driver;
e5dd12784   Greg Kroah-Hartman   Driver core: move...
30
  struct driver_private;
de4772542   Paul Gortmaker   include: replace ...
31
  struct module;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
32
  struct class;
6b6e39a6a   Kay Sievers   driver-core: merg...
33
  struct subsys_private;
b8c5cec23   Kay Sievers   Driver core: udev...
34
  struct bus_type;
d706c1b05   Grant Likely   driver-core: Add ...
35
  struct device_node;
ff21776d1   Joerg Roedel   Driver core: Add ...
36
  struct iommu_ops;
b8c5cec23   Kay Sievers   Driver core: udev...
37
38
39
  
  struct bus_attribute {
  	struct attribute	attr;
d462943af   Greg Kroah-Hartman   Driver core: fix ...
40
41
  	ssize_t (*show)(struct bus_type *bus, char *buf);
  	ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
b8c5cec23   Kay Sievers   Driver core: udev...
42
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
43
44
  #define BUS_ATTR(_name, _mode, _show, _store)	\
  struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
b8c5cec23   Kay Sievers   Driver core: udev...
45
46
47
48
  
  extern int __must_check bus_create_file(struct bus_type *,
  					struct bus_attribute *);
  extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
49

880ffb5c6   Wanlong Gao   driver core: Add ...
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
  /**
   * struct bus_type - The bus type of the device
   *
   * @name:	The name of the bus.
   * @bus_attrs:	Default attributes of the bus.
   * @dev_attrs:	Default attributes of the devices on the bus.
   * @drv_attrs:	Default attributes of the device drivers on the bus.
   * @match:	Called, perhaps multiple times, whenever a new device or driver
   *		is added for this bus. It should return a nonzero value if the
   *		given device can be handled by the given driver.
   * @uevent:	Called when a device is added, removed, or a few other things
   *		that generate uevents to add the environment variables.
   * @probe:	Called when a new device or driver add to this bus, and callback
   *		the specific driver's probe to initial the matched device.
   * @remove:	Called when a device removed from this bus.
   * @shutdown:	Called at shut-down time to quiesce the device.
   * @suspend:	Called when a device on this bus wants to go to sleep mode.
   * @resume:	Called to bring a device on this bus out of sleep mode.
   * @pm:		Power management operations of this bus, callback the specific
   *		device driver's pm-ops.
7b08fae8f   Marcos Paulo de Souza   device.h: Fix str...
70
   * @iommu_ops:  IOMMU specific operations for this bus, used to attach IOMMU
ff21776d1   Joerg Roedel   Driver core: Add ...
71
72
   *              driver implementations to a bus and allow the driver to do
   *              bus-specific setup
880ffb5c6   Wanlong Gao   driver core: Add ...
73
74
75
76
77
78
79
80
81
82
83
84
   * @p:		The private data of the driver core, only the driver core can
   *		touch this.
   *
   * A bus is a channel between the processor and one or more devices. For the
   * purposes of the device model, all devices are connected via a bus, even if
   * it is an internal, virtual, "platform" bus. Buses can plug into each other.
   * A USB controller is usually a PCI device, for example. The device model
   * represents the actual connections between buses and the devices they control.
   * A bus is represented by the bus_type structure. It contains the name, the
   * default attributes, the bus' methods, PM operations, and the driver core's
   * private data.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
85
  struct bus_type {
d462943af   Greg Kroah-Hartman   Driver core: fix ...
86
87
88
89
90
91
92
93
94
95
96
97
  	const char		*name;
  	struct bus_attribute	*bus_attrs;
  	struct device_attribute	*dev_attrs;
  	struct driver_attribute	*drv_attrs;
  
  	int (*match)(struct device *dev, struct device_driver *drv);
  	int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
  	int (*probe)(struct device *dev);
  	int (*remove)(struct device *dev);
  	void (*shutdown)(struct device *dev);
  
  	int (*suspend)(struct device *dev, pm_message_t state);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
98
  	int (*resume)(struct device *dev);
b8c5cec23   Kay Sievers   Driver core: udev...
99

8150f32b9   Dmitry Torokhov   Driver Core: Make...
100
  	const struct dev_pm_ops *pm;
1eede070a   Rafael J. Wysocki   Introduce new top...
101

ff21776d1   Joerg Roedel   Driver core: Add ...
102
  	struct iommu_ops *iommu_ops;
6b6e39a6a   Kay Sievers   driver-core: merg...
103
  	struct subsys_private *p;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
104
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
105
106
  extern int __must_check bus_register(struct bus_type *bus);
  extern void bus_unregister(struct bus_type *bus);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
107

d462943af   Greg Kroah-Hartman   Driver core: fix ...
108
  extern int __must_check bus_rescan_devices(struct bus_type *bus);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
109

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
110
  /* iterator helpers for buses */
d462943af   Greg Kroah-Hartman   Driver core: fix ...
111
112
113
114
115
  int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
  		     int (*fn)(struct device *dev, void *data));
  struct device *bus_find_device(struct bus_type *bus, struct device *start,
  			       void *data,
  			       int (*match)(struct device *dev, void *data));
1f9ffc049   Greg Kroah-Hartman   Driver core: add ...
116
117
118
  struct device *bus_find_device_by_name(struct bus_type *bus,
  				       struct device *start,
  				       const char *name);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
119

cc7447a5f   Jean Delvare   Driver core: Drop...
120
121
  int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
  		     void *data, int (*fn)(struct device_driver *, void *));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
122

99178b036   Greg Kroah-Hartman   Driver core: add ...
123
124
125
  void bus_sort_breadthfirst(struct bus_type *bus,
  			   int (*compare)(const struct device *a,
  					  const struct device *b));
116af3782   Benjamin Herrenschmidt   Driver core: add ...
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  /*
   * Bus notifiers: Get notified of addition/removal of devices
   * and binding/unbinding of drivers to devices.
   * In the long run, it should be a replacement for the platform
   * notify hooks.
   */
  struct notifier_block;
  
  extern int bus_register_notifier(struct bus_type *bus,
  				 struct notifier_block *nb);
  extern int bus_unregister_notifier(struct bus_type *bus,
  				   struct notifier_block *nb);
  
  /* All 4 notifers below get called with the target struct device *
   * as an argument. Note that those functions are likely to be called
8e9394ce2   Greg Kroah-Hartman   Driver core: crea...
141
   * with the device lock held in the core, so be careful.
116af3782   Benjamin Herrenschmidt   Driver core: add ...
142
143
144
   */
  #define BUS_NOTIFY_ADD_DEVICE		0x00000001 /* device added */
  #define BUS_NOTIFY_DEL_DEVICE		0x00000002 /* device removed */
45daef0fd   Magnus Damm   Driver core: Add ...
145
146
147
148
  #define BUS_NOTIFY_BIND_DRIVER		0x00000003 /* driver about to be
  						      bound */
  #define BUS_NOTIFY_BOUND_DRIVER		0x00000004 /* driver bound to device */
  #define BUS_NOTIFY_UNBIND_DRIVER	0x00000005 /* driver about to be
116af3782   Benjamin Herrenschmidt   Driver core: add ...
149
  						      unbound */
45daef0fd   Magnus Damm   Driver core: Add ...
150
  #define BUS_NOTIFY_UNBOUND_DRIVER	0x00000006 /* driver is unbound
309b7d60a   Joerg Roedel   driver core: add ...
151
  						      from the device */
116af3782   Benjamin Herrenschmidt   Driver core: add ...
152

0fed80f7a   Greg Kroah-Hartman   driver core: add ...
153
  extern struct kset *bus_get_kset(struct bus_type *bus);
b249072ee   Greg Kroah-Hartman   driver core: add ...
154
  extern struct klist *bus_get_device_klist(struct bus_type *bus);
0fed80f7a   Greg Kroah-Hartman   driver core: add ...
155

880ffb5c6   Wanlong Gao   driver core: Add ...
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
  /**
   * struct device_driver - The basic device driver structure
   * @name:	Name of the device driver.
   * @bus:	The bus which the device of this driver belongs to.
   * @owner:	The module owner.
   * @mod_name:	Used for built-in modules.
   * @suppress_bind_attrs: Disables bind/unbind via sysfs.
   * @of_match_table: The open firmware table.
   * @probe:	Called to query the existence of a specific device,
   *		whether this driver can work with it, and bind the driver
   *		to a specific device.
   * @remove:	Called when the device is removed from the system to
   *		unbind a device from this driver.
   * @shutdown:	Called at shut-down time to quiesce the device.
   * @suspend:	Called to put the device to sleep mode. Usually to a
   *		low power state.
   * @resume:	Called to bring a device from sleep mode.
   * @groups:	Default attributes that get created by the driver core
   *		automatically.
   * @pm:		Power management operations of the device which matched
   *		this driver.
   * @p:		Driver core's private data, no one other than the driver
   *		core can touch this.
   *
   * The device driver-model tracks all of the drivers known to the system.
   * The main reason for this tracking is to enable the driver core to match
   * up drivers with new devices. Once drivers are known objects within the
   * system, however, a number of other things become possible. Device drivers
   * can export information and configuration variables that are independent
   * of any specific device.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
187
  struct device_driver {
e5dd12784   Greg Kroah-Hartman   Driver core: move...
188
189
  	const char		*name;
  	struct bus_type		*bus;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
190

e5dd12784   Greg Kroah-Hartman   Driver core: move...
191
  	struct module		*owner;
1a6f2a751   Dmitry Torokhov   Driver core: allo...
192
193
194
  	const char		*mod_name;	/* used for built-in modules */
  
  	bool suppress_bind_attrs;	/* disables bind/unbind via sysfs */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
195

597b9d1e4   Grant Likely   drivercore: Add o...
196
  	const struct of_device_id	*of_match_table;
597b9d1e4   Grant Likely   drivercore: Add o...
197

d462943af   Greg Kroah-Hartman   Driver core: fix ...
198
199
200
201
202
  	int (*probe) (struct device *dev);
  	int (*remove) (struct device *dev);
  	void (*shutdown) (struct device *dev);
  	int (*suspend) (struct device *dev, pm_message_t state);
  	int (*resume) (struct device *dev);
a4dbd6740   David Brownell   driver model: con...
203
  	const struct attribute_group **groups;
e5dd12784   Greg Kroah-Hartman   Driver core: move...
204

8150f32b9   Dmitry Torokhov   Driver Core: Make...
205
  	const struct dev_pm_ops *pm;
1eede070a   Rafael J. Wysocki   Introduce new top...
206

e5dd12784   Greg Kroah-Hartman   Driver core: move...
207
  	struct driver_private *p;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
208
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
209
210
  extern int __must_check driver_register(struct device_driver *drv);
  extern void driver_unregister(struct device_driver *drv);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
211

d462943af   Greg Kroah-Hartman   Driver core: fix ...
212
213
214
215
  extern struct device_driver *get_driver(struct device_driver *drv);
  extern void put_driver(struct device_driver *drv);
  extern struct device_driver *driver_find(const char *name,
  					 struct bus_type *bus);
d779249ed   Greg Kroah-Hartman   Driver Core: add ...
216
  extern int driver_probe_done(void);
b23530ebc   Ming Lei   driver core: remo...
217
  extern void wait_for_device_probe(void);
216773a78   Arjan van de Ven   Consolidate drive...
218

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
219

405ae7d38   Robert P. J. Day   Replace remaining...
220
  /* sysfs interface for exporting driver attributes */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
221
222
  
  struct driver_attribute {
d462943af   Greg Kroah-Hartman   Driver core: fix ...
223
224
225
226
  	struct attribute attr;
  	ssize_t (*show)(struct device_driver *driver, char *buf);
  	ssize_t (*store)(struct device_driver *driver, const char *buf,
  			 size_t count);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
227
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
228
229
230
  #define DRIVER_ATTR(_name, _mode, _show, _store)	\
  struct driver_attribute driver_attr_##_name =		\
  	__ATTR(_name, _mode, _show, _store)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
231

d462943af   Greg Kroah-Hartman   Driver core: fix ...
232
  extern int __must_check driver_create_file(struct device_driver *driver,
099c2f21d   Phil Carmody   Driver core: driv...
233
  					const struct driver_attribute *attr);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
234
  extern void driver_remove_file(struct device_driver *driver,
099c2f21d   Phil Carmody   Driver core: driv...
235
  			       const struct driver_attribute *attr);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
236

cbe9c595f   Greg Kroah-Hartman   Driver: add drive...
237
238
239
  extern int __must_check driver_add_kobj(struct device_driver *drv,
  					struct kobject *kobj,
  					const char *fmt, ...);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
240
241
242
243
244
245
246
247
  extern int __must_check driver_for_each_device(struct device_driver *drv,
  					       struct device *start,
  					       void *data,
  					       int (*fn)(struct device *dev,
  							 void *));
  struct device *driver_find_device(struct device_driver *drv,
  				  struct device *start, void *data,
  				  int (*match)(struct device *dev, void *data));
fae3cd002   Patrick Mochel   [PATCH] Add drive...
248

880ffb5c6   Wanlong Gao   driver core: Add ...
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
  /**
   * struct class - device classes
   * @name:	Name of the class.
   * @owner:	The module owner.
   * @class_attrs: Default attributes of this class.
   * @dev_attrs:	Default attributes of the devices belong to the class.
   * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
   * @dev_kobj:	The kobject that represents this class and links it into the hierarchy.
   * @dev_uevent:	Called when a device is added, removed from this class, or a
   *		few other things that generate uevents to add the environment
   *		variables.
   * @devnode:	Callback to provide the devtmpfs.
   * @class_release: Called to release this class.
   * @dev_release: Called to release the device.
   * @suspend:	Used to put the device to sleep mode, usually to a low power
   *		state.
   * @resume:	Used to bring the device from the sleep mode.
   * @ns_type:	Callbacks so sysfs can detemine namespaces.
   * @namespace:	Namespace of the device belongs to this class.
   * @pm:		The default device power management operations of this class.
   * @p:		The private data of the driver core, no one other than the
   *		driver core can touch this.
   *
   * A class is a higher-level view of a device that abstracts out low-level
   * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
   * at the class level, they are all simply disks. Classes allow user space
   * to work with devices based on what they do, rather than how they are
   * connected or how they work.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
277
278
   */
  struct class {
d462943af   Greg Kroah-Hartman   Driver core: fix ...
279
280
  	const char		*name;
  	struct module		*owner;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
281

d462943af   Greg Kroah-Hartman   Driver core: fix ...
282
  	struct class_attribute		*class_attrs;
d462943af   Greg Kroah-Hartman   Driver core: fix ...
283
  	struct device_attribute		*dev_attrs;
c97415a72   Stefan Achatz   sysfs: Introducin...
284
  	struct bin_attribute		*dev_bin_attrs;
e105b8bfc   Dan Williams   sysfs: add /sys/d...
285
  	struct kobject			*dev_kobj;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
286

d462943af   Greg Kroah-Hartman   Driver core: fix ...
287
  	int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
e454cea20   Kay Sievers   Driver-Core: exte...
288
  	char *(*devnode)(struct device *dev, mode_t *mode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
289

d462943af   Greg Kroah-Hartman   Driver core: fix ...
290
291
  	void (*class_release)(struct class *class);
  	void (*dev_release)(struct device *dev);
7c8265f51   Linus Torvalds   Suspend infrastru...
292

d462943af   Greg Kroah-Hartman   Driver core: fix ...
293
294
  	int (*suspend)(struct device *dev, pm_message_t state);
  	int (*resume)(struct device *dev);
1eede070a   Rafael J. Wysocki   Introduce new top...
295

bc451f205   Eric W. Biederman   kobj: Add basic i...
296
297
  	const struct kobj_ns_type_operations *ns_type;
  	const void *(*namespace)(struct device *dev);
8150f32b9   Dmitry Torokhov   Driver Core: Make...
298
  	const struct dev_pm_ops *pm;
6b6e39a6a   Kay Sievers   driver-core: merg...
299
  	struct subsys_private *p;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
300
  };
5a3ceb861   Tejun Heo   driver-core: use ...
301
302
303
304
  struct class_dev_iter {
  	struct klist_iter		ki;
  	const struct device_type	*type;
  };
e105b8bfc   Dan Williams   sysfs: add /sys/d...
305
306
  extern struct kobject *sysfs_dev_block_kobj;
  extern struct kobject *sysfs_dev_char_kobj;
d2a3b9146   Matthew Wilcox   class: add lockde...
307
308
  extern int __must_check __class_register(struct class *class,
  					 struct lock_class_key *key);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
309
  extern void class_unregister(struct class *class);
d2a3b9146   Matthew Wilcox   class: add lockde...
310
311
312
313
314
315
316
317
  
  /* This is a #define to keep the compiler from merging different
   * instances of the __key variable */
  #define class_register(class)			\
  ({						\
  	static struct lock_class_key __key;	\
  	__class_register(class, &__key);	\
  })
462270944   Jean Delvare   Driver core: Add ...
318
319
320
321
322
323
324
  struct class_compat;
  struct class_compat *class_compat_register(const char *name);
  void class_compat_unregister(struct class_compat *cls);
  int class_compat_create_link(struct class_compat *cls, struct device *dev,
  			     struct device *device_link);
  void class_compat_remove_link(struct class_compat *cls, struct device *dev,
  			      struct device *device_link);
5a3ceb861   Tejun Heo   driver-core: use ...
325
326
327
328
329
330
  extern void class_dev_iter_init(struct class_dev_iter *iter,
  				struct class *class,
  				struct device *start,
  				const struct device_type *type);
  extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
  extern void class_dev_iter_exit(struct class_dev_iter *iter);
93562b537   Greg Kroah-Hartman   Driver Core: add ...
331
332
  extern int class_for_each_device(struct class *class, struct device *start,
  				 void *data,
fd04897bb   Dave Young   Driver Core: add ...
333
  				 int (*fn)(struct device *dev, void *data));
695794ae0   Greg Kroah-Hartman   Driver Core: add ...
334
335
  extern struct device *class_find_device(struct class *class,
  					struct device *start, void *data,
fd04897bb   Dave Young   Driver Core: add ...
336
  					int (*match)(struct device *, void *));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
337
338
  
  struct class_attribute {
d462943af   Greg Kroah-Hartman   Driver core: fix ...
339
  	struct attribute attr;
28812fe11   Andi Kleen   driver-core: Add ...
340
341
342
343
  	ssize_t (*show)(struct class *class, struct class_attribute *attr,
  			char *buf);
  	ssize_t (*store)(struct class *class, struct class_attribute *attr,
  			const char *buf, size_t count);
672d82c18   Eric W. Biederman   class: Implement ...
344
345
  	const void *(*namespace)(struct class *class,
  				 const struct class_attribute *attr);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
346
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
347
348
  #define CLASS_ATTR(_name, _mode, _show, _store)			\
  struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
349

d462943af   Greg Kroah-Hartman   Driver core: fix ...
350
351
352
353
  extern int __must_check class_create_file(struct class *class,
  					  const struct class_attribute *attr);
  extern void class_remove_file(struct class *class,
  			      const struct class_attribute *attr);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
354

869dfc875   Andi Kleen   driver core: Add ...
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
  /* Simple class attribute that is just a static string */
  
  struct class_attribute_string {
  	struct class_attribute attr;
  	char *str;
  };
  
  /* Currently read-only only */
  #define _CLASS_ATTR_STRING(_name, _mode, _str) \
  	{ __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
  #define CLASS_ATTR_STRING(_name, _mode, _str) \
  	struct class_attribute_string class_attr_##_name = \
  		_CLASS_ATTR_STRING(_name, _mode, _str)
  
  extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
                          char *buf);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
371
372
373
  struct class_interface {
  	struct list_head	node;
  	struct class		*class;
c47ed219b   Greg Kroah-Hartman   Class: add suppor...
374
375
  	int (*add_dev)		(struct device *, struct class_interface *);
  	void (*remove_dev)	(struct device *, struct class_interface *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
376
  };
4a7fb6363   Andrew Morton   add __must_check ...
377
  extern int __must_check class_interface_register(struct class_interface *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
378
  extern void class_interface_unregister(struct class_interface *);
d2a3b9146   Matthew Wilcox   class: add lockde...
379
380
381
  extern struct class * __must_check __class_create(struct module *owner,
  						  const char *name,
  						  struct lock_class_key *key);
e9ba6365f   Greg Kroah-Hartman   [PATCH] CLASS: mo...
382
  extern void class_destroy(struct class *cls);
e9ba6365f   Greg Kroah-Hartman   [PATCH] CLASS: mo...
383

d2a3b9146   Matthew Wilcox   class: add lockde...
384
385
386
387
388
389
390
  /* This is a #define to keep the compiler from merging different
   * instances of the __key variable */
  #define class_create(owner, name)		\
  ({						\
  	static struct lock_class_key __key;	\
  	__class_create(owner, name, &__key);	\
  })
414264f95   Kay Sievers   Driver core: add ...
391
392
393
394
395
396
397
398
399
  /*
   * The type of device, "struct device" is embedded in. A class
   * or bus can contain devices of different types
   * like "partitions" and "disks", "mouse" and "event".
   * This identifies the device type and carries type-specific
   * information, equivalent to the kobj_type of a kobject.
   * If "name" is specified, the uevent will contain it in
   * the DEVTYPE variable.
   */
f9f852df2   Kay Sievers   Driver core: add ...
400
  struct device_type {
414264f95   Kay Sievers   Driver core: add ...
401
  	const char *name;
a4dbd6740   David Brownell   driver model: con...
402
  	const struct attribute_group **groups;
7eff2e7a8   Kay Sievers   Driver core: chan...
403
  	int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
e454cea20   Kay Sievers   Driver-Core: exte...
404
  	char *(*devnode)(struct device *dev, mode_t *mode);
f9f852df2   Kay Sievers   Driver core: add ...
405
  	void (*release)(struct device *dev);
1eede070a   Rafael J. Wysocki   Introduce new top...
406

8150f32b9   Dmitry Torokhov   Driver Core: Make...
407
  	const struct dev_pm_ops *pm;
f9f852df2   Kay Sievers   Driver core: add ...
408
  };
a7fd67062   Kay Sievers   [PATCH] add sysfs...
409
410
411
412
413
414
415
416
  /* interface for exporting device attributes */
  struct device_attribute {
  	struct attribute	attr;
  	ssize_t (*show)(struct device *dev, struct device_attribute *attr,
  			char *buf);
  	ssize_t (*store)(struct device *dev, struct device_attribute *attr,
  			 const char *buf, size_t count);
  };
d462943af   Greg Kroah-Hartman   Driver core: fix ...
417
418
  #define DEVICE_ATTR(_name, _mode, _show, _store) \
  struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
a7fd67062   Kay Sievers   [PATCH] add sysfs...
419

4a7fb6363   Andrew Morton   add __must_check ...
420
  extern int __must_check device_create_file(struct device *device,
66ecb92be   Phil Carmody   Driver core: bin_...
421
  					const struct device_attribute *entry);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
422
  extern void device_remove_file(struct device *dev,
26579ab70   Phil Carmody   Driver core: devi...
423
  			       const struct device_attribute *attr);
2589f1887   Greg Kroah-Hartman   Driver core: add ...
424
  extern int __must_check device_create_bin_file(struct device *dev,
66ecb92be   Phil Carmody   Driver core: bin_...
425
  					const struct bin_attribute *attr);
2589f1887   Greg Kroah-Hartman   Driver core: add ...
426
  extern void device_remove_bin_file(struct device *dev,
66ecb92be   Phil Carmody   Driver core: bin_...
427
  				   const struct bin_attribute *attr);
523ded71d   Alan Stern   device_schedule_c...
428
  extern int device_schedule_callback_owner(struct device *dev,
d462943af   Greg Kroah-Hartman   Driver core: fix ...
429
  		void (*func)(struct device *dev), struct module *owner);
523ded71d   Alan Stern   device_schedule_c...
430
431
432
433
  
  /* This is a macro to avoid include problems with THIS_MODULE */
  #define device_schedule_callback(dev, func)			\
  	device_schedule_callback_owner(dev, func, THIS_MODULE)
9ac7849e3   Tejun Heo   devres: device re...
434
435
436
437
438
439
  
  /* device resource management */
  typedef void (*dr_release_t)(struct device *dev, void *res);
  typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
  
  #ifdef CONFIG_DEBUG_DEVRES
d462943af   Greg Kroah-Hartman   Driver core: fix ...
440
  extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
9ac7849e3   Tejun Heo   devres: device re...
441
442
443
444
  			     const char *name);
  #define devres_alloc(release, size, gfp) \
  	__devres_alloc(release, size, gfp, #release)
  #else
d462943af   Greg Kroah-Hartman   Driver core: fix ...
445
  extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
9ac7849e3   Tejun Heo   devres: device re...
446
447
448
  #endif
  extern void devres_free(void *res);
  extern void devres_add(struct device *dev, void *res);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
449
  extern void *devres_find(struct device *dev, dr_release_t release,
9ac7849e3   Tejun Heo   devres: device re...
450
  			 dr_match_t match, void *match_data);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
451
452
453
454
  extern void *devres_get(struct device *dev, void *new_res,
  			dr_match_t match, void *match_data);
  extern void *devres_remove(struct device *dev, dr_release_t release,
  			   dr_match_t match, void *match_data);
9ac7849e3   Tejun Heo   devres: device re...
455
456
457
458
459
460
461
462
463
464
465
466
467
  extern int devres_destroy(struct device *dev, dr_release_t release,
  			  dr_match_t match, void *match_data);
  
  /* devres group */
  extern void * __must_check devres_open_group(struct device *dev, void *id,
  					     gfp_t gfp);
  extern void devres_close_group(struct device *dev, void *id);
  extern void devres_remove_group(struct device *dev, void *id);
  extern int devres_release_group(struct device *dev, void *id);
  
  /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
  extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
  extern void devm_kfree(struct device *dev, void *p);
6b7b65105   FUJITA Tomonori   iommu sg merging:...
468
469
470
471
472
473
474
475
  struct device_dma_parameters {
  	/*
  	 * a low level driver may set these to teach IOMMU code about
  	 * sg limitations.
  	 */
  	unsigned int max_segment_size;
  	unsigned long segment_boundary_mask;
  };
880ffb5c6   Wanlong Gao   driver core: Add ...
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  /**
   * struct device - The basic device structure
   * @parent:	The device's "parent" device, the device to which it is attached.
   * 		In most cases, a parent device is some sort of bus or host
   * 		controller. If parent is NULL, the device, is a top-level device,
   * 		which is not usually what you want.
   * @p:		Holds the private data of the driver core portions of the device.
   * 		See the comment of the struct device_private for detail.
   * @kobj:	A top-level, abstract class from which other classes are derived.
   * @init_name:	Initial name of the device.
   * @type:	The type of device.
   * 		This identifies the device type and carries type-specific
   * 		information.
   * @mutex:	Mutex to synchronize calls to its driver.
   * @bus:	Type of bus device is on.
   * @driver:	Which driver has allocated this
   * @platform_data: Platform data specific to the device.
   * 		Example: For devices on custom boards, as typical of embedded
   * 		and SOC based hardware, Linux often uses platform_data to point
   * 		to board-specific structures describing devices and how they
   * 		are wired.  That can include what ports are available, chip
   * 		variants, which GPIO pins act in what additional roles, and so
   * 		on.  This shrinks the "Board Support Packages" (BSPs) and
   * 		minimizes board-specific #ifdefs in drivers.
   * @power:	For device power management.
   * 		See Documentation/power/devices.txt for details.
564b905ab   Rafael J. Wysocki   PM / Domains: Ren...
502
   * @pm_domain:	Provide callbacks that are executed during system suspend,
880ffb5c6   Wanlong Gao   driver core: Add ...
503
504
505
506
507
508
509
510
511
512
513
514
515
   * 		hibernation, system resume and during runtime PM transitions
   * 		along with subsystem-level and driver-level callbacks.
   * @numa_node:	NUMA node this device is close to.
   * @dma_mask:	Dma mask (if dma'ble device).
   * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
   * 		hardware supports 64-bit addresses for consistent allocations
   * 		such descriptors.
   * @dma_parms:	A low level driver may set these to teach IOMMU code about
   * 		segment limitations.
   * @dma_pools:	Dma pools (if dma'ble device).
   * @dma_mem:	Internal for coherent mem override.
   * @archdata:	For arch-specific additions.
   * @of_node:	Associated device tree node.
880ffb5c6   Wanlong Gao   driver core: Add ...
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
   * @devt:	For creating the sysfs "dev".
   * @devres_lock: Spinlock to protect the resource of the device.
   * @devres_head: The resources list of the device.
   * @knode_class: The node used to add the device to the class list.
   * @class:	The class of the device.
   * @groups:	Optional attribute groups.
   * @release:	Callback to free the device after all references have
   * 		gone away. This should be set by the allocator of the
   * 		device (i.e. the bus driver that discovered the device).
   *
   * At the lowest level, every device in a Linux system is represented by an
   * instance of struct device. The device structure contains the information
   * that the device model core needs to model the system. Most subsystems,
   * however, track additional information about the devices they host. As a
   * result, it is rare for devices to be represented by bare device structures;
   * instead, that structure, like kobject structures, is usually embedded within
   * a higher-level representation of the device.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
534
  struct device {
49a4ec188   David Brownell   fix hotplug for l...
535
  	struct device		*parent;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
536

fb069a5d1   Greg Kroah-Hartman   driver core: crea...
537
  	struct device_private	*p;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
538
  	struct kobject kobj;
c906a48ad   Greg Kroah-Hartman   driver core: add ...
539
  	const char		*init_name; /* initial name of the device */
aed65af1c   Stephen Hemminger   drivers: make dev...
540
  	const struct device_type *type;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
541

3142788b7   Thomas Gleixner   drivers/base: Con...
542
  	struct mutex		mutex;	/* mutex to synchronize calls to
af70316af   Patrick Mochel   [PATCH] Add a sem...
543
544
  					 * its driver.
  					 */
d462943af   Greg Kroah-Hartman   Driver core: fix ...
545
  	struct bus_type	*bus;		/* type of bus device is on */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
546
547
  	struct device_driver *driver;	/* which driver has allocated this
  					   device */
e67c85626   Greg Kroah-Hartman   Revert driver cor...
548
549
  	void		*platform_data;	/* Platform specific data, device
  					   core doesn't touch it */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
550
  	struct dev_pm_info	power;
564b905ab   Rafael J. Wysocki   PM / Domains: Ren...
551
  	struct dev_pm_domain	*pm_domain;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
552

873481367   Christoph Hellwig   [PATCH] add numa ...
553
554
555
  #ifdef CONFIG_NUMA
  	int		numa_node;	/* NUMA node this device is close to */
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
556
557
558
559
560
561
  	u64		*dma_mask;	/* dma mask (if dma'able device) */
  	u64		coherent_dma_mask;/* Like dma_mask, but for
  					     alloc_coherent mappings as
  					     not all hardware supports
  					     64 bit addresses for consistent
  					     allocations such descriptors. */
6b7b65105   FUJITA Tomonori   iommu sg merging:...
562
  	struct device_dma_parameters *dma_parms;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
563
564
565
566
  	struct list_head	dma_pools;	/* dma pools (if dma'ble) */
  
  	struct dma_coherent_mem	*dma_mem; /* internal for coherent mem
  					     override */
c6dbaef22   Benjamin Herrenschmidt   Driver core: add ...
567
568
  	/* arch specific additions */
  	struct dev_archdata	archdata;
c9e358dfc   Grant Likely   driver-core: remo...
569
570
  
  	struct device_node	*of_node; /* associated device tree node */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
571

929d2fa59   Matthew Wilcox   driver core: Rear...
572
  	dev_t			devt;	/* dev_t, creates the sysfs "dev" */
9ac7849e3   Tejun Heo   devres: device re...
573
574
  	spinlock_t		devres_lock;
  	struct list_head	devres_head;
5a3ceb861   Tejun Heo   driver-core: use ...
575
  	struct klist_node	knode_class;
b7a3e813f   Kay Sievers   Driver core: allo...
576
  	struct class		*class;
a4dbd6740   David Brownell   driver model: con...
577
  	const struct attribute_group **groups;	/* optional groups */
23681e479   Greg Kroah-Hartman   [PATCH] Driver co...
578

d462943af   Greg Kroah-Hartman   Driver core: fix ...
579
  	void	(*release)(struct device *dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
580
  };
9a3df1f7d   Alan Stern   PM: Convert wakeu...
581
582
  /* Get the wakeup routines, which depend on struct device */
  #include <linux/pm_wakeup.h>
bf9ca69fc   Jean Delvare   dev_printk(): con...
583
  static inline const char *dev_name(const struct device *dev)
06916639e   Kay Sievers   driver-core: add ...
584
  {
a636ee7fb   Paul Mundt   driver core: Earl...
585
586
587
  	/* Use the init name until the kobject becomes available */
  	if (dev->init_name)
  		return dev->init_name;
1fa5ae857   Kay Sievers   driver core: get ...
588
  	return kobject_name(&dev->kobj);
06916639e   Kay Sievers   driver-core: add ...
589
  }
b9075fa96   Joe Perches   treewide: use __p...
590
591
  extern __printf(2, 3)
  int dev_set_name(struct device *dev, const char *name, ...);
413c239fa   Stephen Rothwell   driver-core: prep...
592

873481367   Christoph Hellwig   [PATCH] add numa ...
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
  #ifdef CONFIG_NUMA
  static inline int dev_to_node(struct device *dev)
  {
  	return dev->numa_node;
  }
  static inline void set_dev_node(struct device *dev, int node)
  {
  	dev->numa_node = node;
  }
  #else
  static inline int dev_to_node(struct device *dev)
  {
  	return -1;
  }
  static inline void set_dev_node(struct device *dev, int node)
  {
  }
  #endif
5c095a0e0   Rafael J. Wysocki   PM: Introduce str...
611
612
613
614
  static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
  {
  	return dev ? dev->power.subsys_data : NULL;
  }
f67f129e5   Ming Lei   Driver core: impl...
615
616
617
618
619
620
621
622
623
  static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
  {
  	return dev->kobj.uevent_suppress;
  }
  
  static inline void dev_set_uevent_suppress(struct device *dev, int val)
  {
  	dev->kobj.uevent_suppress = val;
  }
d305ef5d2   Daniel Ritz   [PATCH] driver co...
624
625
  static inline int device_is_registered(struct device *dev)
  {
3f62e5700   Greg Kroah-Hartman   Driver core: make...
626
  	return dev->kobj.state_in_sysfs;
d305ef5d2   Daniel Ritz   [PATCH] driver co...
627
  }
5af84b827   Rafael J. Wysocki   PM: Asynchronous ...
628
629
  static inline void device_enable_async_suspend(struct device *dev)
  {
f76b168b6   Alan Stern   PM: Rename dev_pm...
630
  	if (!dev->power.is_prepared)
5af84b827   Rafael J. Wysocki   PM: Asynchronous ...
631
632
  		dev->power.async_suspend = true;
  }
5a2eb8585   Rafael J. Wysocki   PM: Add facility ...
633
634
  static inline void device_disable_async_suspend(struct device *dev)
  {
f76b168b6   Alan Stern   PM: Rename dev_pm...
635
  	if (!dev->power.is_prepared)
5a2eb8585   Rafael J. Wysocki   PM: Add facility ...
636
637
638
639
640
641
642
  		dev->power.async_suspend = false;
  }
  
  static inline bool device_async_suspend_enabled(struct device *dev)
  {
  	return !!dev->power.async_suspend;
  }
8b258cc8a   Rafael J. Wysocki   PM Sleep: Do not ...
643
644
645
646
  static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
  {
  	dev->power.ignore_children = enable;
  }
8e9394ce2   Greg Kroah-Hartman   Driver core: crea...
647
648
  static inline void device_lock(struct device *dev)
  {
3142788b7   Thomas Gleixner   drivers/base: Con...
649
  	mutex_lock(&dev->mutex);
8e9394ce2   Greg Kroah-Hartman   Driver core: crea...
650
651
652
653
  }
  
  static inline int device_trylock(struct device *dev)
  {
3142788b7   Thomas Gleixner   drivers/base: Con...
654
  	return mutex_trylock(&dev->mutex);
8e9394ce2   Greg Kroah-Hartman   Driver core: crea...
655
656
657
658
  }
  
  static inline void device_unlock(struct device *dev)
  {
3142788b7   Thomas Gleixner   drivers/base: Con...
659
  	mutex_unlock(&dev->mutex);
8e9394ce2   Greg Kroah-Hartman   Driver core: crea...
660
  }
1f21782e6   Adrian Bunk   Driver core: prop...
661
  void driver_init(void);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
662
663
664
  /*
   * High level routines for use by the bus drivers
   */
d462943af   Greg Kroah-Hartman   Driver core: fix ...
665
666
667
668
669
670
671
672
673
  extern int __must_check device_register(struct device *dev);
  extern void device_unregister(struct device *dev);
  extern void device_initialize(struct device *dev);
  extern int __must_check device_add(struct device *dev);
  extern void device_del(struct device *dev);
  extern int device_for_each_child(struct device *dev, void *data,
  		     int (*fn)(struct device *dev, void *data));
  extern struct device *device_find_child(struct device *dev, void *data,
  				int (*match)(struct device *dev, void *data));
6937e8f8c   Johannes Berg   driver core: devi...
674
  extern int device_rename(struct device *dev, const char *new_name);
ffa6a7054   Cornelia Huck   Driver core: Fix ...
675
676
  extern int device_move(struct device *dev, struct device *new_parent,
  		       enum dpm_order dpm_order);
e454cea20   Kay Sievers   Driver-Core: exte...
677
678
  extern const char *device_get_devnode(struct device *dev,
  				      mode_t *mode, const char **tmp);
b40284378   Greg Kroah-Hartman   Driver core: move...
679
  extern void *dev_get_drvdata(const struct device *dev);
c87050824   Uwe Kleine-König   driver core: let ...
680
  extern int dev_set_drvdata(struct device *dev, void *data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
681
682
  
  /*
0aa0dc41b   Mark McLoughlin   driver core: add ...
683
684
685
686
   * Root device objects for grouping under /sys/devices
   */
  extern struct device *__root_device_register(const char *name,
  					     struct module *owner);
eb5589a8f   Paul Gortmaker   include: convert ...
687
688
689
690
691
692
693
  
  /*
   * This is a macro to avoid include problems with THIS_MODULE,
   * just as per what is done for device_schedule_callback() above.
   */
  #define root_device_register(name) \
  	__root_device_register(name, THIS_MODULE)
0aa0dc41b   Mark McLoughlin   driver core: add ...
694
  extern void root_device_unregister(struct device *root);
a5b8b1ada   Mark Brown   Driver core: Add ...
695
696
697
698
  static inline void *dev_get_platdata(const struct device *dev)
  {
  	return dev->platform_data;
  }
0aa0dc41b   Mark McLoughlin   driver core: add ...
699
  /*
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
700
701
702
   * Manual binding of a device to driver. See drivers/base/bus.c
   * for information on use.
   */
f86db396f   Andrew Morton   drivers/base: che...
703
  extern int __must_check device_bind_driver(struct device *dev);
d462943af   Greg Kroah-Hartman   Driver core: fix ...
704
705
  extern void device_release_driver(struct device *dev);
  extern int  __must_check device_attach(struct device *dev);
f86db396f   Andrew Morton   drivers/base: che...
706
707
  extern int __must_check driver_attach(struct device_driver *drv);
  extern int __must_check device_reprobe(struct device *dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
708

23681e479   Greg Kroah-Hartman   [PATCH] Driver co...
709
710
711
  /*
   * Easy functions for dynamically creating devices on the fly
   */
8882b3942   Greg Kroah-Hartman   Driver core: add ...
712
713
714
715
716
717
  extern struct device *device_create_vargs(struct class *cls,
  					  struct device *parent,
  					  dev_t devt,
  					  void *drvdata,
  					  const char *fmt,
  					  va_list vargs);
b9075fa96   Joe Perches   treewide: use __p...
718
719
720
721
  extern __printf(5, 6)
  struct device *device_create(struct class *cls, struct device *parent,
  			     dev_t devt, void *drvdata,
  			     const char *fmt, ...);
23681e479   Greg Kroah-Hartman   [PATCH] Driver co...
722
  extern void device_destroy(struct class *cls, dev_t devt);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
723

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
724
725
726
727
728
729
  /*
   * Platform "fixup" functions - allow the platform to have their say
   * about devices and actions that the general device layer doesn't
   * know about.
   */
  /* Notify platform of device discovery */
d462943af   Greg Kroah-Hartman   Driver core: fix ...
730
  extern int (*platform_notify)(struct device *dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
731

d462943af   Greg Kroah-Hartman   Driver core: fix ...
732
  extern int (*platform_notify_remove)(struct device *dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
733

880ffb5c6   Wanlong Gao   driver core: Add ...
734
  /*
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
735
736
737
   * get_device - atomically increment the reference count for the device.
   *
   */
d462943af   Greg Kroah-Hartman   Driver core: fix ...
738
739
  extern struct device *get_device(struct device *dev);
  extern void put_device(struct device *dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
740

d4d5291c8   Arjan van de Ven   driver synchroniz...
741
  extern void wait_for_device_probe(void);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
742

2b2af54a5   Kay Sievers   Driver Core: devt...
743
744
745
  #ifdef CONFIG_DEVTMPFS
  extern int devtmpfs_create_node(struct device *dev);
  extern int devtmpfs_delete_node(struct device *dev);
073120cc2   Kay Sievers   Driver Core: devt...
746
  extern int devtmpfs_mount(const char *mntdir);
2b2af54a5   Kay Sievers   Driver Core: devt...
747
748
749
750
751
  #else
  static inline int devtmpfs_create_node(struct device *dev) { return 0; }
  static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
  static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
  #endif
116f232b3   Rytchkov Alexey   fixed path to mov...
752
  /* drivers/base/power/shutdown.c */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
753
  extern void device_shutdown(void);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
754
  /* debugging and troubleshooting/diagnostic helpers. */
bf9ca69fc   Jean Delvare   dev_printk(): con...
755
  extern const char *dev_driver_string(const struct device *dev);
99bcf2171   Joe Perches   device.h drivers/...
756
757
758
  
  
  #ifdef CONFIG_PRINTK
cbc466355   Joe Perches   dynamic_debug: Ad...
759
760
  extern int __dev_printk(const char *level, const struct device *dev,
  			struct va_format *vaf);
b9075fa96   Joe Perches   treewide: use __p...
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
  extern __printf(3, 4)
  int dev_printk(const char *level, const struct device *dev,
  	       const char *fmt, ...)
  	;
  extern __printf(2, 3)
  int dev_emerg(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int dev_alert(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int dev_crit(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int dev_err(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int dev_warn(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int dev_notice(const struct device *dev, const char *fmt, ...);
  extern __printf(2, 3)
  int _dev_info(const struct device *dev, const char *fmt, ...);
99bcf2171   Joe Perches   device.h drivers/...
779
780
  
  #else
cbc466355   Joe Perches   dynamic_debug: Ad...
781
782
  static inline int __dev_printk(const char *level, const struct device *dev,
  			       struct va_format *vaf)
b9075fa96   Joe Perches   treewide: use __p...
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
  { return 0; }
  static inline __printf(3, 4)
  int dev_printk(const char *level, const struct device *dev,
  	       const char *fmt, ...)
  { return 0; }
  
  static inline __printf(2, 3)
  int dev_emerg(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int dev_crit(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int dev_alert(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int dev_err(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int dev_warn(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int dev_notice(const struct device *dev, const char *fmt, ...)
  { return 0; }
  static inline __printf(2, 3)
  int _dev_info(const struct device *dev, const char *fmt, ...)
  { return 0; }
99bcf2171   Joe Perches   device.h drivers/...
810
811
812
813
814
815
816
817
818
819
820
  
  #endif
  
  /*
   * Stupid hackaround for existing uses of non-printk uses dev_info
   *
   * Note that the definition of dev_info below is actually _dev_info
   * and a macro is used to avoid redefining dev_info
   */
  
  #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
7b8712e56   Emil Medve   driver core: Make...
821

d0d85ff98   Cornelia Huck   Make DEBUG take p...
822
823
  #if defined(DEBUG)
  #define dev_dbg(dev, format, arg...)		\
99bcf2171   Joe Perches   device.h drivers/...
824
  	dev_printk(KERN_DEBUG, dev, format, ##arg)
e9d376f0f   Jason Baron   dynamic debug: co...
825
  #elif defined(CONFIG_DYNAMIC_DEBUG)
99bcf2171   Joe Perches   device.h drivers/...
826
827
  #define dev_dbg(dev, format, ...)		     \
  do {						     \
346e15beb   Jason Baron   driver core: basi...
828
  	dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
99bcf2171   Joe Perches   device.h drivers/...
829
  } while (0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
830
  #else
99bcf2171   Joe Perches   device.h drivers/...
831
832
833
834
835
836
  #define dev_dbg(dev, format, arg...)				\
  ({								\
  	if (0)							\
  		dev_printk(KERN_DEBUG, dev, format, ##arg);	\
  	0;							\
  })
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
837
  #endif
aebdc3b45   David Brownell   dev_vdbg(), avail...
838
839
840
  #ifdef VERBOSE_DEBUG
  #define dev_vdbg	dev_dbg
  #else
99bcf2171   Joe Perches   device.h drivers/...
841
842
843
844
845
846
  #define dev_vdbg(dev, format, arg...)				\
  ({								\
  	if (0)							\
  		dev_printk(KERN_DEBUG, dev, format, ##arg);	\
  	0;							\
  })
aebdc3b45   David Brownell   dev_vdbg(), avail...
847
  #endif
e61396627   Arjan van de Ven   debug: Introduce ...
848
  /*
bcdd323b8   Felipe Balbi   device: add dev_W...
849
   * dev_WARN*() acts like dev_printk(), but with the key difference
e61396627   Arjan van de Ven   debug: Introduce ...
850
851
852
853
854
855
   * of using a WARN/WARN_ON to get the message out, including the
   * file/line information and a backtrace.
   */
  #define dev_WARN(dev, format, arg...) \
  	WARN(1, "Device: %s
  " format, dev_driver_string(dev), ## arg);
bcdd323b8   Felipe Balbi   device: add dev_W...
856
857
858
859
  #define dev_WARN_ONCE(dev, condition, format, arg...) \
  	WARN_ONCE(condition, "Device %s
  " format, \
  			dev_driver_string(dev), ## arg)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
860
861
862
863
864
  /* Create alias, so I can be autoloaded. */
  #define MODULE_ALIAS_CHARDEV(major,minor) \
  	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
  #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
  	MODULE_ALIAS("char-major-" __stringify(major) "-*")
e52eec13c   Andi Kleen   SYSFS: Allow boot...
865
866
867
868
869
870
  
  #ifdef CONFIG_SYSFS_DEPRECATED
  extern long sysfs_deprecated;
  #else
  #define sysfs_deprecated 0
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
871
  #endif /* _DEVICE_H_ */