blob: 3b64fdecd0418b48fa3ca6669ee79697c9cc0112 [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-Hartman89790fd2007-02-12 22:33:06 -08005 * Copyright (c) 2004-2007 Greg Kroah-Hartman <gregkh@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
7 * This file is released under the GPLv2
8 *
9 * See Documentation/driver-model/ for more information.
10 */
11
12#ifndef _DEVICE_H_
13#define _DEVICE_H_
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/ioport.h>
16#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080017#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/list.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070019#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/types.h>
21#include <linux/module.h>
22#include <linux/pm.h>
23#include <asm/semaphore.h>
24#include <asm/atomic.h>
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +110025#include <asm/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#define DEVICE_NAME_SIZE 50
28#define DEVICE_NAME_HALF __stringify(20) /* Less than half to accommodate slop */
29#define DEVICE_ID_SIZE 32
30#define BUS_ID_SIZE KOBJ_NAME_LEN
31
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033struct device;
34struct device_driver;
35struct class;
36struct class_device;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010037struct bus_type;
38
39struct bus_attribute {
40 struct attribute attr;
41 ssize_t (*show)(struct bus_type *, char * buf);
42 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
43};
44
45#define BUS_ATTR(_name,_mode,_show,_store) \
46struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
47
48extern int __must_check bus_create_file(struct bus_type *,
49 struct bus_attribute *);
50extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52struct bus_type {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -050053 const char * name;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010054 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56 struct subsystem subsys;
57 struct kset drivers;
58 struct kset devices;
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080059 struct klist klist_devices;
mochel@digitalimplant.org38fdac32005-03-21 12:00:18 -080060 struct klist klist_drivers;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100062 struct blocking_notifier_head bus_notifier;
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 struct bus_attribute * bus_attrs;
65 struct device_attribute * dev_attrs;
66 struct driver_attribute * drv_attrs;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010067 struct bus_attribute drivers_autoprobe_attr;
68 struct bus_attribute drivers_probe_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 int (*match)(struct device * dev, struct device_driver * drv);
Kay Sievers312c0042005-11-16 09:00:00 +010071 int (*uevent)(struct device *dev, char **envp,
72 int num_envp, char *buffer, int buffer_size);
Russell King594c8282006-01-05 14:29:51 +000073 int (*probe)(struct device * dev);
74 int (*remove)(struct device * dev);
75 void (*shutdown)(struct device * dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -070076
Linus Torvalds7c8265f2006-06-24 14:50:29 -070077 int (*suspend)(struct device * dev, pm_message_t state);
78 int (*suspend_late)(struct device * dev, pm_message_t state);
79 int (*resume_early)(struct device * dev);
80 int (*resume)(struct device * dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010081
82 unsigned int drivers_autoprobe:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083};
84
Andrew Morton4a7fb632006-08-14 22:43:17 -070085extern int __must_check bus_register(struct bus_type * bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086extern void bus_unregister(struct bus_type * bus);
87
Andrew Mortonf86db392006-08-14 22:43:20 -070088extern int __must_check bus_rescan_devices(struct bus_type * bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* iterator helpers for buses */
91
92int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
93 int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +020094struct device * bus_find_device(struct bus_type *bus, struct device *start,
95 void *data, int (*match)(struct device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Andrew Morton4a7fb632006-08-14 22:43:17 -070097int __must_check bus_for_each_drv(struct bus_type *bus,
98 struct device_driver *start, void *data,
99 int (*fn)(struct device_driver *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000101/*
102 * Bus notifiers: Get notified of addition/removal of devices
103 * and binding/unbinding of drivers to devices.
104 * In the long run, it should be a replacement for the platform
105 * notify hooks.
106 */
107struct notifier_block;
108
109extern int bus_register_notifier(struct bus_type *bus,
110 struct notifier_block *nb);
111extern int bus_unregister_notifier(struct bus_type *bus,
112 struct notifier_block *nb);
113
114/* All 4 notifers below get called with the target struct device *
115 * as an argument. Note that those functions are likely to be called
116 * with the device semaphore held in the core, so be careful.
117 */
118#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
119#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
120#define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
121#define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
122 unbound */
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124struct device_driver {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500125 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 struct bus_type * bus;
127
128 struct completion unloaded;
129 struct kobject kobj;
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -0800130 struct klist klist_devices;
mochel@digitalimplant.org38fdac32005-03-21 12:00:18 -0800131 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500133 struct module * owner;
Kay Sieversf30c53a2007-01-15 20:22:02 +0100134 const char * mod_name; /* used for built-in modules */
Kay Sievers0c84ce22007-04-01 23:49:48 -0700135 struct module_kobject * mkobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137 int (*probe) (struct device * dev);
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500138 int (*remove) (struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 void (*shutdown) (struct device * dev);
Russell King9480e302005-10-28 09:52:56 -0700140 int (*suspend) (struct device * dev, pm_message_t state);
141 int (*resume) (struct device * dev);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700142
143 unsigned int multithread_probe:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144};
145
146
Andrew Morton4a7fb632006-08-14 22:43:17 -0700147extern int __must_check driver_register(struct device_driver * drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148extern void driver_unregister(struct device_driver * drv);
149
150extern struct device_driver * get_driver(struct device_driver * drv);
151extern void put_driver(struct device_driver * drv);
152extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700153extern int driver_probe_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100155/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157struct driver_attribute {
158 struct attribute attr;
159 ssize_t (*show)(struct device_driver *, char * buf);
160 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
161};
162
163#define DRIVER_ATTR(_name,_mode,_show,_store) \
164struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
165
Andrew Morton4a7fb632006-08-14 22:43:17 -0700166extern int __must_check driver_create_file(struct device_driver *,
167 struct driver_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
169
Andrew Morton4a7fb632006-08-14 22:43:17 -0700170extern int __must_check driver_for_each_device(struct device_driver * drv,
171 struct device *start, void *data,
172 int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +0200173struct device * driver_find_device(struct device_driver *drv,
174 struct device *start, void *data,
175 int (*match)(struct device *, void *));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177/*
178 * device classes
179 */
180struct class {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500181 const char * name;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800182 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184 struct subsystem subsys;
185 struct list_head children;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700186 struct list_head devices;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 struct list_head interfaces;
Kay Sievers86406242007-03-14 03:25:56 +0100188 struct kset class_dirs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 struct semaphore sem; /* locks both the children and interfaces lists */
190
191 struct class_attribute * class_attrs;
192 struct class_device_attribute * class_dev_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700193 struct device_attribute * dev_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Kay Sievers312c0042005-11-16 09:00:00 +0100195 int (*uevent)(struct class_device *dev, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 int num_envp, char *buffer, int buffer_size);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700197 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
198 char *buffer, int buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 void (*release)(struct class_device *dev);
201 void (*class_release)(struct class *class);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700202 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700203
204 int (*suspend)(struct device *, pm_message_t state);
205 int (*resume)(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206};
207
Andrew Morton4a7fb632006-08-14 22:43:17 -0700208extern int __must_check class_register(struct class *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209extern void class_unregister(struct class *);
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212struct class_attribute {
213 struct attribute attr;
214 ssize_t (*show)(struct class *, char * buf);
215 ssize_t (*store)(struct class *, const char * buf, size_t count);
216};
217
218#define CLASS_ATTR(_name,_mode,_show,_store) \
219struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
220
Andrew Morton4a7fb632006-08-14 22:43:17 -0700221extern int __must_check class_create_file(struct class *,
222 const struct class_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223extern void class_remove_file(struct class *, const struct class_attribute *);
224
Kay Sieversa7fd6702005-10-01 14:49:43 +0200225struct class_device_attribute {
226 struct attribute attr;
227 ssize_t (*show)(struct class_device *, char * buf);
228 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
229};
230
231#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
232struct class_device_attribute class_device_attr_##_name = \
233 __ATTR(_name,_mode,_show,_store)
234
Andrew Morton4a7fb632006-08-14 22:43:17 -0700235extern int __must_check class_device_create_file(struct class_device *,
Kay Sieversa7fd6702005-10-01 14:49:43 +0200236 const struct class_device_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700238/**
239 * struct class_device - class devices
240 * @class: pointer to the parent class for this class device. This is required.
241 * @devt: for internal use by the driver core only.
242 * @node: for internal use by the driver core only.
243 * @kobj: for internal use by the driver core only.
244 * @devt_attr: for internal use by the driver core only.
Stephen Hemminger14982212006-05-06 17:55:11 -0700245 * @groups: optional additional groups to be created
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700246 * @dev: if set, a symlink to the struct device is created in the sysfs
247 * directory for this struct class device.
248 * @class_data: pointer to whatever you want to store here for this struct
249 * class_device. Use class_get_devdata() and class_set_devdata() to get and
250 * set this pointer.
251 * @parent: pointer to a struct class_device that is the parent of this struct
252 * class_device. If NULL, this class_device will show up at the root of the
253 * struct class in sysfs (which is probably what you want to have happen.)
254 * @release: pointer to a release function for this struct class_device. If
255 * set, this will be called instead of the class specific release function.
256 * Only use this if you want to override the default release function, like
257 * when you are nesting class_device structures.
Kay Sievers312c0042005-11-16 09:00:00 +0100258 * @uevent: pointer to a uevent function for this struct class_device. If
259 * set, this will be called instead of the class specific uevent function.
260 * Only use this if you want to override the default uevent function, like
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700261 * when you are nesting class_device structures.
262 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263struct class_device {
264 struct list_head node;
265
266 struct kobject kobj;
267 struct class * class; /* required */
268 dev_t devt; /* dev_t, creates the sysfs "dev" */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800269 struct class_device_attribute *devt_attr;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200270 struct class_device_attribute uevent_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 struct device * dev; /* not necessary, but nice to have */
272 void * class_data; /* class-specific data */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700273 struct class_device *parent; /* parent of this child device, if there is one */
Stephen Hemminger14982212006-05-06 17:55:11 -0700274 struct attribute_group ** groups; /* optional groups */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700276 void (*release)(struct class_device *dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100277 int (*uevent)(struct class_device *dev, char **envp,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700278 int num_envp, char *buffer, int buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 char class_id[BUS_ID_SIZE]; /* unique to this class */
280};
281
282static inline void *
283class_get_devdata (struct class_device *dev)
284{
285 return dev->class_data;
286}
287
288static inline void
289class_set_devdata (struct class_device *dev, void *data)
290{
291 dev->class_data = data;
292}
293
294
Andrew Morton4a7fb632006-08-14 22:43:17 -0700295extern int __must_check class_device_register(struct class_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296extern void class_device_unregister(struct class_device *);
297extern void class_device_initialize(struct class_device *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700298extern int __must_check class_device_add(struct class_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299extern void class_device_del(struct class_device *);
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301extern struct class_device * class_device_get(struct class_device *);
302extern void class_device_put(struct class_device *);
303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304extern void class_device_remove_file(struct class_device *,
305 const struct class_device_attribute *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700306extern int __must_check class_device_create_bin_file(struct class_device *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 struct bin_attribute *);
308extern void class_device_remove_bin_file(struct class_device *,
309 struct bin_attribute *);
310
311struct class_interface {
312 struct list_head node;
313 struct class *class;
314
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500315 int (*add) (struct class_device *, struct class_interface *);
316 void (*remove) (struct class_device *, struct class_interface *);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200317 int (*add_dev) (struct device *, struct class_interface *);
318 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319};
320
Andrew Morton4a7fb632006-08-14 22:43:17 -0700321extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322extern void class_interface_unregister(struct class_interface *);
323
Miguel Ojeda Sandonisab7d7372006-09-13 15:34:05 +0200324extern struct class *class_create(struct module *owner, const char *name);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800325extern void class_destroy(struct class *cls);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700326extern struct class_device *class_device_create(struct class *cls,
327 struct class_device *parent,
328 dev_t devt,
329 struct device *device,
Dmitry Torokhovddd5d352006-08-10 01:18:18 -0400330 const char *fmt, ...)
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700331 __attribute__((format(printf,5,6)));
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800332extern void class_device_destroy(struct class *cls, dev_t devt);
333
Kay Sieversf9f852d2006-10-07 21:54:55 +0200334struct device_type {
Dmitry Torokhov621a1672007-03-10 01:37:34 -0500335 struct attribute_group **groups;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200336 int (*uevent)(struct device *dev, char **envp, int num_envp,
337 char *buffer, int buffer_size);
338 void (*release)(struct device *dev);
339};
340
Kay Sieversa7fd6702005-10-01 14:49:43 +0200341/* interface for exporting device attributes */
342struct device_attribute {
343 struct attribute attr;
344 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
345 char *buf);
346 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
347 const char *buf, size_t count);
348};
349
350#define DEVICE_ATTR(_name,_mode,_show,_store) \
351struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
352
Andrew Morton4a7fb632006-08-14 22:43:17 -0700353extern int __must_check device_create_file(struct device *device,
354 struct device_attribute * entry);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200355extern void device_remove_file(struct device * dev, struct device_attribute * attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700356extern int __must_check device_create_bin_file(struct device *dev,
357 struct bin_attribute *attr);
358extern void device_remove_bin_file(struct device *dev,
359 struct bin_attribute *attr);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400360extern int device_schedule_callback(struct device *dev,
361 void (*func)(struct device *));
Tejun Heo9ac78492007-01-20 16:00:26 +0900362
363/* device resource management */
364typedef void (*dr_release_t)(struct device *dev, void *res);
365typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
366
367#ifdef CONFIG_DEBUG_DEVRES
368extern void * __devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
369 const char *name);
370#define devres_alloc(release, size, gfp) \
371 __devres_alloc(release, size, gfp, #release)
372#else
373extern void * devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
374#endif
375extern void devres_free(void *res);
376extern void devres_add(struct device *dev, void *res);
377extern void * devres_find(struct device *dev, dr_release_t release,
378 dr_match_t match, void *match_data);
379extern void * devres_get(struct device *dev, void *new_res,
380 dr_match_t match, void *match_data);
381extern void * devres_remove(struct device *dev, dr_release_t release,
382 dr_match_t match, void *match_data);
383extern int devres_destroy(struct device *dev, dr_release_t release,
384 dr_match_t match, void *match_data);
385
386/* devres group */
387extern void * __must_check devres_open_group(struct device *dev, void *id,
388 gfp_t gfp);
389extern void devres_close_group(struct device *dev, void *id);
390extern void devres_remove_group(struct device *dev, void *id);
391extern int devres_release_group(struct device *dev, void *id);
392
393/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
394extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
395extern void devm_kfree(struct device *dev, void *p);
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397struct device {
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800398 struct klist klist_children;
399 struct klist_node knode_parent; /* node in sibling list */
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -0800400 struct klist_node knode_driver;
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -0800401 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 struct device * parent;
403
404 struct kobject kobj;
405 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200406 struct device_type *type;
Alan Sternf2eaae12006-09-18 16:22:34 -0400407 unsigned is_registered:1;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200408 struct device_attribute uevent_attr;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700409 struct device_attribute *devt_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800411 struct semaphore sem; /* semaphore to synchronize calls to
412 * its driver.
413 */
414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 struct bus_type * bus; /* type of bus device is on */
416 struct device_driver *driver; /* which driver has allocated this
417 device */
418 void *driver_data; /* data private to the driver */
David Shaohua Li4e10d122005-03-18 18:45:35 -0500419 void *platform_data; /* Platform specific data, device
420 core doesn't touch it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 struct dev_pm_info power;
422
Christoph Hellwig87348132006-12-06 20:32:33 -0800423#ifdef CONFIG_NUMA
424 int numa_node; /* NUMA node this device is close to */
425#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 u64 *dma_mask; /* dma mask (if dma'able device) */
427 u64 coherent_dma_mask;/* Like dma_mask, but for
428 alloc_coherent mappings as
429 not all hardware supports
430 64 bit addresses for consistent
431 allocations such descriptors. */
432
433 struct list_head dma_pools; /* dma pools (if dma'ble) */
434
435 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
436 override */
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100437 /* arch specific additions */
438 struct dev_archdata archdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Tejun Heo9ac78492007-01-20 16:00:26 +0900440 spinlock_t devres_lock;
441 struct list_head devres_head;
442
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700443 /* class_device migration path */
444 struct list_head node;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200445 struct class *class;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700446 dev_t devt; /* dev_t, creates the sysfs "dev" */
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700447 struct attribute_group **groups; /* optional groups */
Kay Sieversb7a3e812006-10-07 21:54:55 +0200448 int uevent_suppress;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 void (*release)(struct device * dev);
451};
452
Christoph Hellwig87348132006-12-06 20:32:33 -0800453#ifdef CONFIG_NUMA
454static inline int dev_to_node(struct device *dev)
455{
456 return dev->numa_node;
457}
458static inline void set_dev_node(struct device *dev, int node)
459{
460 dev->numa_node = node;
461}
462#else
463static inline int dev_to_node(struct device *dev)
464{
465 return -1;
466}
467static inline void set_dev_node(struct device *dev, int node)
468{
469}
470#endif
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472static inline void *
473dev_get_drvdata (struct device *dev)
474{
475 return dev->driver_data;
476}
477
478static inline void
479dev_set_drvdata (struct device *dev, void *data)
480{
481 dev->driver_data = data;
482}
483
Daniel Ritzd305ef52005-09-22 00:47:24 -0700484static inline int device_is_registered(struct device *dev)
485{
Alan Sternf2eaae12006-09-18 16:22:34 -0400486 return dev->is_registered;
Daniel Ritzd305ef52005-09-22 00:47:24 -0700487}
488
Adrian Bunk1f217822006-12-19 13:01:28 -0800489void driver_init(void);
490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491/*
492 * High level routines for use by the bus drivers
493 */
Andrew Morton4a7fb632006-08-14 22:43:17 -0700494extern int __must_check device_register(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495extern void device_unregister(struct device * dev);
496extern void device_initialize(struct device * dev);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700497extern int __must_check device_add(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498extern void device_del(struct device * dev);
Russell King04fed362006-10-22 15:57:18 +0100499extern int device_for_each_child(struct device *, void *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 int (*fn)(struct device *, void *));
Cornelia Huck5ab69982006-11-16 15:42:07 +0100501extern struct device *device_find_child(struct device *, void *data,
502 int (*match)(struct device *, void *));
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -0700503extern int device_rename(struct device *dev, char *new_name);
Cornelia Huck8a824722006-11-20 17:07:51 +0100504extern int device_move(struct device *dev, struct device *new_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506/*
507 * Manual binding of a device to driver. See drivers/base/bus.c
508 * for information on use.
509 */
Andrew Mortonf86db392006-08-14 22:43:20 -0700510extern int __must_check device_bind_driver(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511extern void device_release_driver(struct device * dev);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700512extern int __must_check device_attach(struct device * dev);
Andrew Mortonf86db392006-08-14 22:43:20 -0700513extern int __must_check driver_attach(struct device_driver *drv);
514extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700516/*
517 * Easy functions for dynamically creating devices on the fly
518 */
519extern struct device *device_create(struct class *cls, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -0400520 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700521 __attribute__((format(printf,4,5)));
522extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524/*
525 * Platform "fixup" functions - allow the platform to have their say
526 * about devices and actions that the general device layer doesn't
527 * know about.
528 */
529/* Notify platform of device discovery */
530extern int (*platform_notify)(struct device * dev);
531
532extern int (*platform_notify_remove)(struct device * dev);
533
534
535/**
536 * get_device - atomically increment the reference count for the device.
537 *
538 */
539extern struct device * get_device(struct device * dev);
540extern void put_device(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542
Rytchkov Alexey116f232b2006-03-22 00:58:53 +0100543/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544extern void device_shutdown(void);
545
546
547/* drivers/base/firmware.c */
Andrew Morton4a7fb632006-08-14 22:43:17 -0700548extern int __must_check firmware_register(struct subsystem *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549extern void firmware_unregister(struct subsystem *);
550
551/* debugging and troubleshooting/diagnostic helpers. */
Alan Stern3e956372006-06-16 17:10:48 -0400552extern const char *dev_driver_string(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#define dev_printk(level, dev, format, arg...) \
Alan Stern3e956372006-06-16 17:10:48 -0400554 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
556#ifdef DEBUG
557#define dev_dbg(dev, format, arg...) \
558 dev_printk(KERN_DEBUG , dev , format , ## arg)
559#else
560#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
561#endif
562
563#define dev_err(dev, format, arg...) \
564 dev_printk(KERN_ERR , dev , format , ## arg)
565#define dev_info(dev, format, arg...) \
566 dev_printk(KERN_INFO , dev , format , ## arg)
567#define dev_warn(dev, format, arg...) \
568 dev_printk(KERN_WARNING , dev , format , ## arg)
Tilman Schmidt4f2928d2006-02-24 11:05:45 +0100569#define dev_notice(dev, format, arg...) \
570 dev_printk(KERN_NOTICE , dev , format , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
572/* Create alias, so I can be autoloaded. */
573#define MODULE_ALIAS_CHARDEV(major,minor) \
574 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
575#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
576 MODULE_ALIAS("char-major-" __stringify(major) "-*")
577#endif /* _DEVICE_H_ */