b3da9a870cfc129258a5ae07d79fc4ec5bb4d6c8
[linux-3.10.git] / include / linux / device.h
1 /*
2  * device.h - generic, centralized driver model
3  *
4  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5  *
6  * This file is released under the GPLv2
7  *
8  * See Documentation/driver-model/ for more information.
9  */
10
11 #ifndef _DEVICE_H_
12 #define _DEVICE_H_
13
14 #include <linux/ioport.h>
15 #include <linux/kobject.h>
16 #include <linux/klist.h>
17 #include <linux/list.h>
18 #include <linux/compiler.h>
19 #include <linux/types.h>
20 #include <linux/module.h>
21 #include <linux/pm.h>
22 #include <asm/semaphore.h>
23 #include <asm/atomic.h>
24
25 #define DEVICE_NAME_SIZE        50
26 #define DEVICE_NAME_HALF        __stringify(20) /* Less than half to accommodate slop */
27 #define DEVICE_ID_SIZE          32
28 #define BUS_ID_SIZE             KOBJ_NAME_LEN
29
30
31 struct device;
32 struct device_driver;
33 struct class;
34 struct class_device;
35
36 struct bus_type {
37         const char              * name;
38
39         struct subsystem        subsys;
40         struct kset             drivers;
41         struct kset             devices;
42         struct klist            klist_devices;
43         struct klist            klist_drivers;
44
45         struct bus_attribute    * bus_attrs;
46         struct device_attribute * dev_attrs;
47         struct driver_attribute * drv_attrs;
48
49         int             (*match)(struct device * dev, struct device_driver * drv);
50         int             (*uevent)(struct device *dev, char **envp,
51                                   int num_envp, char *buffer, int buffer_size);
52         int             (*probe)(struct device * dev);
53         int             (*remove)(struct device * dev);
54         void            (*shutdown)(struct device * dev);
55
56         int (*suspend)(struct device * dev, pm_message_t state);
57         int (*suspend_late)(struct device * dev, pm_message_t state);
58         int (*resume_early)(struct device * dev);
59         int (*resume)(struct device * dev);
60 };
61
62 extern int __must_check bus_register(struct bus_type * bus);
63 extern void bus_unregister(struct bus_type * bus);
64
65 extern int __must_check bus_rescan_devices(struct bus_type * bus);
66
67 /* iterator helpers for buses */
68
69 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
70                      int (*fn)(struct device *, void *));
71 struct device * bus_find_device(struct bus_type *bus, struct device *start,
72                                 void *data, int (*match)(struct device *, void *));
73
74 int __must_check bus_for_each_drv(struct bus_type *bus,
75                 struct device_driver *start, void *data,
76                 int (*fn)(struct device_driver *, void *));
77
78 /* driverfs interface for exporting bus attributes */
79
80 struct bus_attribute {
81         struct attribute        attr;
82         ssize_t (*show)(struct bus_type *, char * buf);
83         ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
84 };
85
86 #define BUS_ATTR(_name,_mode,_show,_store)      \
87 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
88
89 extern int __must_check bus_create_file(struct bus_type *,
90                                         struct bus_attribute *);
91 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
92
93 struct device_driver {
94         const char              * name;
95         struct bus_type         * bus;
96
97         struct completion       unloaded;
98         struct kobject          kobj;
99         struct klist            klist_devices;
100         struct klist_node       knode_bus;
101
102         struct module           * owner;
103
104         int     (*probe)        (struct device * dev);
105         int     (*remove)       (struct device * dev);
106         void    (*shutdown)     (struct device * dev);
107         int     (*suspend)      (struct device * dev, pm_message_t state);
108         int     (*resume)       (struct device * dev);
109 };
110
111
112 extern int __must_check driver_register(struct device_driver * drv);
113 extern void driver_unregister(struct device_driver * drv);
114
115 extern struct device_driver * get_driver(struct device_driver * drv);
116 extern void put_driver(struct device_driver * drv);
117 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
118
119 /* driverfs interface for exporting driver attributes */
120
121 struct driver_attribute {
122         struct attribute        attr;
123         ssize_t (*show)(struct device_driver *, char * buf);
124         ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
125 };
126
127 #define DRIVER_ATTR(_name,_mode,_show,_store)   \
128 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
129
130 extern int __must_check driver_create_file(struct device_driver *,
131                                         struct driver_attribute *);
132 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
133
134 extern int __must_check driver_for_each_device(struct device_driver * drv,
135                 struct device *start, void *data,
136                 int (*fn)(struct device *, void *));
137 struct device * driver_find_device(struct device_driver *drv,
138                                    struct device *start, void *data,
139                                    int (*match)(struct device *, void *));
140
141 /*
142  * device classes
143  */
144 struct class {
145         const char              * name;
146         struct module           * owner;
147
148         struct subsystem        subsys;
149         struct list_head        children;
150         struct list_head        devices;
151         struct list_head        interfaces;
152         struct semaphore        sem;    /* locks both the children and interfaces lists */
153
154         struct kobject          *virtual_dir;
155
156         struct class_attribute          * class_attrs;
157         struct class_device_attribute   * class_dev_attrs;
158         struct device_attribute         * dev_attrs;
159
160         int     (*uevent)(struct class_device *dev, char **envp,
161                            int num_envp, char *buffer, int buffer_size);
162         int     (*dev_uevent)(struct device *dev, char **envp, int num_envp,
163                                 char *buffer, int buffer_size);
164
165         void    (*release)(struct class_device *dev);
166         void    (*class_release)(struct class *class);
167         void    (*dev_release)(struct device *dev);
168
169         int     (*suspend)(struct device *, pm_message_t state);
170         int     (*resume)(struct device *);
171 };
172
173 extern int __must_check class_register(struct class *);
174 extern void class_unregister(struct class *);
175
176
177 struct class_attribute {
178         struct attribute        attr;
179         ssize_t (*show)(struct class *, char * buf);
180         ssize_t (*store)(struct class *, const char * buf, size_t count);
181 };
182
183 #define CLASS_ATTR(_name,_mode,_show,_store)                    \
184 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store) 
185
186 extern int __must_check class_create_file(struct class *,
187                                         const struct class_attribute *);
188 extern void class_remove_file(struct class *, const struct class_attribute *);
189
190 struct class_device_attribute {
191         struct attribute        attr;
192         ssize_t (*show)(struct class_device *, char * buf);
193         ssize_t (*store)(struct class_device *, const char * buf, size_t count);
194 };
195
196 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store)             \
197 struct class_device_attribute class_device_attr_##_name =       \
198         __ATTR(_name,_mode,_show,_store)
199
200 extern int __must_check class_device_create_file(struct class_device *,
201                                     const struct class_device_attribute *);
202
203 /**
204  * struct class_device - class devices
205  * @class: pointer to the parent class for this class device.  This is required.
206  * @devt: for internal use by the driver core only.
207  * @node: for internal use by the driver core only.
208  * @kobj: for internal use by the driver core only.
209  * @devt_attr: for internal use by the driver core only.
210  * @groups: optional additional groups to be created
211  * @dev: if set, a symlink to the struct device is created in the sysfs
212  * directory for this struct class device.
213  * @class_data: pointer to whatever you want to store here for this struct
214  * class_device.  Use class_get_devdata() and class_set_devdata() to get and
215  * set this pointer.
216  * @parent: pointer to a struct class_device that is the parent of this struct
217  * class_device.  If NULL, this class_device will show up at the root of the
218  * struct class in sysfs (which is probably what you want to have happen.)
219  * @release: pointer to a release function for this struct class_device.  If
220  * set, this will be called instead of the class specific release function.
221  * Only use this if you want to override the default release function, like
222  * when you are nesting class_device structures.
223  * @uevent: pointer to a uevent function for this struct class_device.  If
224  * set, this will be called instead of the class specific uevent function.
225  * Only use this if you want to override the default uevent function, like
226  * when you are nesting class_device structures.
227  */
228 struct class_device {
229         struct list_head        node;
230
231         struct kobject          kobj;
232         struct class            * class;        /* required */
233         dev_t                   devt;           /* dev_t, creates the sysfs "dev" */
234         struct class_device_attribute *devt_attr;
235         struct class_device_attribute uevent_attr;
236         struct device           * dev;          /* not necessary, but nice to have */
237         void                    * class_data;   /* class-specific data */
238         struct class_device     *parent;        /* parent of this child device, if there is one */
239         struct attribute_group  ** groups;      /* optional groups */
240
241         void    (*release)(struct class_device *dev);
242         int     (*uevent)(struct class_device *dev, char **envp,
243                            int num_envp, char *buffer, int buffer_size);
244         char    class_id[BUS_ID_SIZE];  /* unique to this class */
245 };
246
247 static inline void *
248 class_get_devdata (struct class_device *dev)
249 {
250         return dev->class_data;
251 }
252
253 static inline void
254 class_set_devdata (struct class_device *dev, void *data)
255 {
256         dev->class_data = data;
257 }
258
259
260 extern int __must_check class_device_register(struct class_device *);
261 extern void class_device_unregister(struct class_device *);
262 extern void class_device_initialize(struct class_device *);
263 extern int __must_check class_device_add(struct class_device *);
264 extern void class_device_del(struct class_device *);
265
266 extern int class_device_rename(struct class_device *, char *);
267
268 extern struct class_device * class_device_get(struct class_device *);
269 extern void class_device_put(struct class_device *);
270
271 extern void class_device_remove_file(struct class_device *, 
272                                      const struct class_device_attribute *);
273 extern int __must_check class_device_create_bin_file(struct class_device *,
274                                         struct bin_attribute *);
275 extern void class_device_remove_bin_file(struct class_device *,
276                                          struct bin_attribute *);
277
278 struct class_interface {
279         struct list_head        node;
280         struct class            *class;
281
282         int (*add)      (struct class_device *, struct class_interface *);
283         void (*remove)  (struct class_device *, struct class_interface *);
284         int (*add_dev)          (struct device *, struct class_interface *);
285         void (*remove_dev)      (struct device *, struct class_interface *);
286 };
287
288 extern int __must_check class_interface_register(struct class_interface *);
289 extern void class_interface_unregister(struct class_interface *);
290
291 extern struct class *class_create(struct module *owner, const char *name);
292 extern void class_destroy(struct class *cls);
293 extern struct class_device *class_device_create(struct class *cls,
294                                                 struct class_device *parent,
295                                                 dev_t devt,
296                                                 struct device *device,
297                                                 const char *fmt, ...)
298                                         __attribute__((format(printf,5,6)));
299 extern void class_device_destroy(struct class *cls, dev_t devt);
300
301 /* interface for exporting device attributes */
302 struct device_attribute {
303         struct attribute        attr;
304         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
305                         char *buf);
306         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
307                          const char *buf, size_t count);
308 };
309
310 #define DEVICE_ATTR(_name,_mode,_show,_store) \
311 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
312
313 extern int __must_check device_create_file(struct device *device,
314                                         struct device_attribute * entry);
315 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
316 extern int __must_check device_create_bin_file(struct device *dev,
317                                                struct bin_attribute *attr);
318 extern void device_remove_bin_file(struct device *dev,
319                                    struct bin_attribute *attr);
320 struct device {
321         struct klist            klist_children;
322         struct klist_node       knode_parent;           /* node in sibling list */
323         struct klist_node       knode_driver;
324         struct klist_node       knode_bus;
325         struct device   * parent;
326
327         struct kobject kobj;
328         char    bus_id[BUS_ID_SIZE];    /* position on parent bus */
329         struct device_attribute uevent_attr;
330         struct device_attribute *devt_attr;
331
332         struct semaphore        sem;    /* semaphore to synchronize calls to
333                                          * its driver.
334                                          */
335
336         struct bus_type * bus;          /* type of bus device is on */
337         struct device_driver *driver;   /* which driver has allocated this
338                                            device */
339         void            *driver_data;   /* data private to the driver */
340         void            *platform_data; /* Platform specific data, device
341                                            core doesn't touch it */
342         void            *firmware_data; /* Firmware specific data (e.g. ACPI,
343                                            BIOS data),reserved for device core*/
344         struct dev_pm_info      power;
345
346         u64             *dma_mask;      /* dma mask (if dma'able device) */
347         u64             coherent_dma_mask;/* Like dma_mask, but for
348                                              alloc_coherent mappings as
349                                              not all hardware supports
350                                              64 bit addresses for consistent
351                                              allocations such descriptors. */
352
353         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
354
355         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
356                                              override */
357
358         /* class_device migration path */
359         struct list_head        node;
360         struct class            *class;         /* optional*/
361         dev_t                   devt;           /* dev_t, creates the sysfs "dev" */
362         struct attribute_group  **groups;       /* optional groups */
363
364         void    (*release)(struct device * dev);
365 };
366
367 static inline void *
368 dev_get_drvdata (struct device *dev)
369 {
370         return dev->driver_data;
371 }
372
373 static inline void
374 dev_set_drvdata (struct device *dev, void *data)
375 {
376         dev->driver_data = data;
377 }
378
379 static inline int device_is_registered(struct device *dev)
380 {
381         return klist_node_attached(&dev->knode_bus);
382 }
383
384 /*
385  * High level routines for use by the bus drivers
386  */
387 extern int __must_check device_register(struct device * dev);
388 extern void device_unregister(struct device * dev);
389 extern void device_initialize(struct device * dev);
390 extern int __must_check device_add(struct device * dev);
391 extern void device_del(struct device * dev);
392 extern int __must_check device_for_each_child(struct device *, void *,
393                      int (*fn)(struct device *, void *));
394 extern int device_rename(struct device *dev, char *new_name);
395
396 /*
397  * Manual binding of a device to driver. See drivers/base/bus.c
398  * for information on use.
399  */
400 extern int __must_check device_bind_driver(struct device *dev);
401 extern void device_release_driver(struct device * dev);
402 extern int  __must_check device_attach(struct device * dev);
403 extern int __must_check driver_attach(struct device_driver *drv);
404 extern int __must_check device_reprobe(struct device *dev);
405
406 /*
407  * Easy functions for dynamically creating devices on the fly
408  */
409 extern struct device *device_create(struct class *cls, struct device *parent,
410                                     dev_t devt, const char *fmt, ...)
411                                     __attribute__((format(printf,4,5)));
412 extern void device_destroy(struct class *cls, dev_t devt);
413
414 extern int virtual_device_parent(struct device *dev);
415
416 /*
417  * Platform "fixup" functions - allow the platform to have their say
418  * about devices and actions that the general device layer doesn't
419  * know about.
420  */
421 /* Notify platform of device discovery */
422 extern int (*platform_notify)(struct device * dev);
423
424 extern int (*platform_notify_remove)(struct device * dev);
425
426
427 /**
428  * get_device - atomically increment the reference count for the device.
429  *
430  */
431 extern struct device * get_device(struct device * dev);
432 extern void put_device(struct device * dev);
433
434
435 /* drivers/base/power/shutdown.c */
436 extern void device_shutdown(void);
437
438
439 /* drivers/base/firmware.c */
440 extern int __must_check firmware_register(struct subsystem *);
441 extern void firmware_unregister(struct subsystem *);
442
443 /* debugging and troubleshooting/diagnostic helpers. */
444 extern const char *dev_driver_string(struct device *dev);
445 #define dev_printk(level, dev, format, arg...)  \
446         printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
447
448 #ifdef DEBUG
449 #define dev_dbg(dev, format, arg...)            \
450         dev_printk(KERN_DEBUG , dev , format , ## arg)
451 #else
452 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
453 #endif
454
455 #define dev_err(dev, format, arg...)            \
456         dev_printk(KERN_ERR , dev , format , ## arg)
457 #define dev_info(dev, format, arg...)           \
458         dev_printk(KERN_INFO , dev , format , ## arg)
459 #define dev_warn(dev, format, arg...)           \
460         dev_printk(KERN_WARNING , dev , format , ## arg)
461 #define dev_notice(dev, format, arg...)         \
462         dev_printk(KERN_NOTICE , dev , format , ## arg)
463
464 /* Create alias, so I can be autoloaded. */
465 #define MODULE_ALIAS_CHARDEV(major,minor) \
466         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
467 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
468         MODULE_ALIAS("char-major-" __stringify(major) "-*")
469 #endif /* _DEVICE_H_ */