sysfs: add /sys/dev/{char,block} to lookup sysfs path by major:minor
[linux-2.6.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  * Copyright (c) 2004-2007 Greg Kroah-Hartman <gregkh@suse.de>
6  *
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
15 #include <linux/ioport.h>
16 #include <linux/kobject.h>
17 #include <linux/klist.h>
18 #include <linux/list.h>
19 #include <linux/compiler.h>
20 #include <linux/types.h>
21 #include <linux/module.h>
22 #include <linux/pm.h>
23 #include <linux/semaphore.h>
24 #include <asm/atomic.h>
25 #include <asm/device.h>
26
27 #define DEVICE_NAME_SIZE        50
28 /* DEVICE_NAME_HALF is really less than half to accommodate slop */
29 #define DEVICE_NAME_HALF        __stringify(20)
30 #define DEVICE_ID_SIZE          32
31 #define BUS_ID_SIZE             KOBJ_NAME_LEN
32
33
34 struct device;
35 struct device_driver;
36 struct driver_private;
37 struct class;
38 struct bus_type;
39 struct bus_type_private;
40
41 struct bus_attribute {
42         struct attribute        attr;
43         ssize_t (*show)(struct bus_type *bus, char *buf);
44         ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
45 };
46
47 #define BUS_ATTR(_name, _mode, _show, _store)   \
48 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
49
50 extern int __must_check bus_create_file(struct bus_type *,
51                                         struct bus_attribute *);
52 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
53
54 struct bus_type {
55         const char              *name;
56         struct bus_attribute    *bus_attrs;
57         struct device_attribute *dev_attrs;
58         struct driver_attribute *drv_attrs;
59
60         int (*match)(struct device *dev, struct device_driver *drv);
61         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
62         int (*probe)(struct device *dev);
63         int (*remove)(struct device *dev);
64         void (*shutdown)(struct device *dev);
65
66         int (*suspend)(struct device *dev, pm_message_t state);
67         int (*suspend_late)(struct device *dev, pm_message_t state);
68         int (*resume_early)(struct device *dev);
69         int (*resume)(struct device *dev);
70
71         struct pm_ext_ops *pm;
72
73         struct bus_type_private *p;
74 };
75
76 extern int __must_check bus_register(struct bus_type *bus);
77 extern void bus_unregister(struct bus_type *bus);
78
79 extern int __must_check bus_rescan_devices(struct bus_type *bus);
80
81 /* iterator helpers for buses */
82
83 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
84                      int (*fn)(struct device *dev, void *data));
85 struct device *bus_find_device(struct bus_type *bus, struct device *start,
86                                void *data,
87                                int (*match)(struct device *dev, void *data));
88 struct device *bus_find_device_by_name(struct bus_type *bus,
89                                        struct device *start,
90                                        const char *name);
91
92 int __must_check bus_for_each_drv(struct bus_type *bus,
93                                   struct device_driver *start, void *data,
94                                   int (*fn)(struct device_driver *, void *));
95
96 /*
97  * Bus notifiers: Get notified of addition/removal of devices
98  * and binding/unbinding of drivers to devices.
99  * In the long run, it should be a replacement for the platform
100  * notify hooks.
101  */
102 struct notifier_block;
103
104 extern int bus_register_notifier(struct bus_type *bus,
105                                  struct notifier_block *nb);
106 extern int bus_unregister_notifier(struct bus_type *bus,
107                                    struct notifier_block *nb);
108
109 /* All 4 notifers below get called with the target struct device *
110  * as an argument. Note that those functions are likely to be called
111  * with the device semaphore held in the core, so be careful.
112  */
113 #define BUS_NOTIFY_ADD_DEVICE           0x00000001 /* device added */
114 #define BUS_NOTIFY_DEL_DEVICE           0x00000002 /* device removed */
115 #define BUS_NOTIFY_BOUND_DRIVER         0x00000003 /* driver bound to device */
116 #define BUS_NOTIFY_UNBIND_DRIVER        0x00000004 /* driver about to be
117                                                       unbound */
118
119 extern struct kset *bus_get_kset(struct bus_type *bus);
120 extern struct klist *bus_get_device_klist(struct bus_type *bus);
121
122 struct device_driver {
123         const char              *name;
124         struct bus_type         *bus;
125
126         struct module           *owner;
127         const char              *mod_name;      /* used for built-in modules */
128
129         int (*probe) (struct device *dev);
130         int (*remove) (struct device *dev);
131         void (*shutdown) (struct device *dev);
132         int (*suspend) (struct device *dev, pm_message_t state);
133         int (*resume) (struct device *dev);
134         struct attribute_group **groups;
135
136         struct pm_ops *pm;
137
138         struct driver_private *p;
139 };
140
141
142 extern int __must_check driver_register(struct device_driver *drv);
143 extern void driver_unregister(struct device_driver *drv);
144
145 extern struct device_driver *get_driver(struct device_driver *drv);
146 extern void put_driver(struct device_driver *drv);
147 extern struct device_driver *driver_find(const char *name,
148                                          struct bus_type *bus);
149 extern int driver_probe_done(void);
150
151 /* sysfs interface for exporting driver attributes */
152
153 struct driver_attribute {
154         struct attribute attr;
155         ssize_t (*show)(struct device_driver *driver, char *buf);
156         ssize_t (*store)(struct device_driver *driver, const char *buf,
157                          size_t count);
158 };
159
160 #define DRIVER_ATTR(_name, _mode, _show, _store)        \
161 struct driver_attribute driver_attr_##_name =           \
162         __ATTR(_name, _mode, _show, _store)
163
164 extern int __must_check driver_create_file(struct device_driver *driver,
165                                            struct driver_attribute *attr);
166 extern void driver_remove_file(struct device_driver *driver,
167                                struct driver_attribute *attr);
168
169 extern int __must_check driver_add_kobj(struct device_driver *drv,
170                                         struct kobject *kobj,
171                                         const char *fmt, ...);
172
173 extern int __must_check driver_for_each_device(struct device_driver *drv,
174                                                struct device *start,
175                                                void *data,
176                                                int (*fn)(struct device *dev,
177                                                          void *));
178 struct device *driver_find_device(struct device_driver *drv,
179                                   struct device *start, void *data,
180                                   int (*match)(struct device *dev, void *data));
181
182 /*
183  * device classes
184  */
185 struct class {
186         const char              *name;
187         struct module           *owner;
188
189         struct kset             subsys;
190         struct list_head        devices;
191         struct list_head        interfaces;
192         struct kset             class_dirs;
193         struct semaphore        sem; /* locks children, devices, interfaces */
194         struct class_attribute          *class_attrs;
195         struct device_attribute         *dev_attrs;
196         struct kobject                  *dev_kobj;
197
198         int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
199
200         void (*class_release)(struct class *class);
201         void (*dev_release)(struct device *dev);
202
203         int (*suspend)(struct device *dev, pm_message_t state);
204         int (*resume)(struct device *dev);
205
206         struct pm_ops *pm;
207 };
208
209 extern struct kobject *sysfs_dev_block_kobj;
210 extern struct kobject *sysfs_dev_char_kobj;
211 extern int __must_check class_register(struct class *class);
212 extern void class_unregister(struct class *class);
213 extern int class_for_each_device(struct class *class, void *data,
214                                  int (*fn)(struct device *dev, void *data));
215 extern struct device *class_find_device(struct class *class, void *data,
216                                         int (*match)(struct device *, void *));
217
218 struct class_attribute {
219         struct attribute attr;
220         ssize_t (*show)(struct class *class, char *buf);
221         ssize_t (*store)(struct class *class, const char *buf, size_t count);
222 };
223
224 #define CLASS_ATTR(_name, _mode, _show, _store)                 \
225 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
226
227 extern int __must_check class_create_file(struct class *class,
228                                           const struct class_attribute *attr);
229 extern void class_remove_file(struct class *class,
230                               const struct class_attribute *attr);
231
232 struct class_interface {
233         struct list_head        node;
234         struct class            *class;
235
236         int (*add_dev)          (struct device *, struct class_interface *);
237         void (*remove_dev)      (struct device *, struct class_interface *);
238 };
239
240 extern int __must_check class_interface_register(struct class_interface *);
241 extern void class_interface_unregister(struct class_interface *);
242
243 extern struct class *class_create(struct module *owner, const char *name);
244 extern void class_destroy(struct class *cls);
245
246 /*
247  * The type of device, "struct device" is embedded in. A class
248  * or bus can contain devices of different types
249  * like "partitions" and "disks", "mouse" and "event".
250  * This identifies the device type and carries type-specific
251  * information, equivalent to the kobj_type of a kobject.
252  * If "name" is specified, the uevent will contain it in
253  * the DEVTYPE variable.
254  */
255 struct device_type {
256         const char *name;
257         struct attribute_group **groups;
258         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
259         void (*release)(struct device *dev);
260
261         int (*suspend)(struct device *dev, pm_message_t state);
262         int (*resume)(struct device *dev);
263
264         struct pm_ops *pm;
265 };
266
267 /* interface for exporting device attributes */
268 struct device_attribute {
269         struct attribute        attr;
270         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
271                         char *buf);
272         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
273                          const char *buf, size_t count);
274 };
275
276 #define DEVICE_ATTR(_name, _mode, _show, _store) \
277 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
278
279 extern int __must_check device_create_file(struct device *device,
280                                            struct device_attribute *entry);
281 extern void device_remove_file(struct device *dev,
282                                struct device_attribute *attr);
283 extern int __must_check device_create_bin_file(struct device *dev,
284                                                struct bin_attribute *attr);
285 extern void device_remove_bin_file(struct device *dev,
286                                    struct bin_attribute *attr);
287 extern int device_schedule_callback_owner(struct device *dev,
288                 void (*func)(struct device *dev), struct module *owner);
289
290 /* This is a macro to avoid include problems with THIS_MODULE */
291 #define device_schedule_callback(dev, func)                     \
292         device_schedule_callback_owner(dev, func, THIS_MODULE)
293
294 /* device resource management */
295 typedef void (*dr_release_t)(struct device *dev, void *res);
296 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
297
298 #ifdef CONFIG_DEBUG_DEVRES
299 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
300                              const char *name);
301 #define devres_alloc(release, size, gfp) \
302         __devres_alloc(release, size, gfp, #release)
303 #else
304 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
305 #endif
306 extern void devres_free(void *res);
307 extern void devres_add(struct device *dev, void *res);
308 extern void *devres_find(struct device *dev, dr_release_t release,
309                          dr_match_t match, void *match_data);
310 extern void *devres_get(struct device *dev, void *new_res,
311                         dr_match_t match, void *match_data);
312 extern void *devres_remove(struct device *dev, dr_release_t release,
313                            dr_match_t match, void *match_data);
314 extern int devres_destroy(struct device *dev, dr_release_t release,
315                           dr_match_t match, void *match_data);
316
317 /* devres group */
318 extern void * __must_check devres_open_group(struct device *dev, void *id,
319                                              gfp_t gfp);
320 extern void devres_close_group(struct device *dev, void *id);
321 extern void devres_remove_group(struct device *dev, void *id);
322 extern int devres_release_group(struct device *dev, void *id);
323
324 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
325 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
326 extern void devm_kfree(struct device *dev, void *p);
327
328 struct device_dma_parameters {
329         /*
330          * a low level driver may set these to teach IOMMU code about
331          * sg limitations.
332          */
333         unsigned int max_segment_size;
334         unsigned long segment_boundary_mask;
335 };
336
337 struct device {
338         struct klist            klist_children;
339         struct klist_node       knode_parent;   /* node in sibling list */
340         struct klist_node       knode_driver;
341         struct klist_node       knode_bus;
342         struct device           *parent;
343
344         struct kobject kobj;
345         char    bus_id[BUS_ID_SIZE];    /* position on parent bus */
346         struct device_type      *type;
347         unsigned                uevent_suppress:1;
348
349         struct semaphore        sem;    /* semaphore to synchronize calls to
350                                          * its driver.
351                                          */
352
353         struct bus_type *bus;           /* type of bus device is on */
354         struct device_driver *driver;   /* which driver has allocated this
355                                            device */
356         void            *driver_data;   /* data private to the driver */
357         void            *platform_data; /* Platform specific data, device
358                                            core doesn't touch it */
359         struct dev_pm_info      power;
360
361 #ifdef CONFIG_NUMA
362         int             numa_node;      /* NUMA node this device is close to */
363 #endif
364         u64             *dma_mask;      /* dma mask (if dma'able device) */
365         u64             coherent_dma_mask;/* Like dma_mask, but for
366                                              alloc_coherent mappings as
367                                              not all hardware supports
368                                              64 bit addresses for consistent
369                                              allocations such descriptors. */
370
371         struct device_dma_parameters *dma_parms;
372
373         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
374
375         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
376                                              override */
377         /* arch specific additions */
378         struct dev_archdata     archdata;
379
380         spinlock_t              devres_lock;
381         struct list_head        devres_head;
382
383         struct list_head        node;
384         struct class            *class;
385         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
386         struct attribute_group  **groups;       /* optional groups */
387
388         void    (*release)(struct device *dev);
389 };
390
391 /* Get the wakeup routines, which depend on struct device */
392 #include <linux/pm_wakeup.h>
393
394 static inline const char *dev_name(struct device *dev)
395 {
396         /* will be changed into kobject_name(&dev->kobj) in the near future */
397         return dev->bus_id;
398 }
399
400 extern int dev_set_name(struct device *dev, const char *name, ...)
401                         __attribute__((format(printf, 2, 3)));
402
403 #ifdef CONFIG_NUMA
404 static inline int dev_to_node(struct device *dev)
405 {
406         return dev->numa_node;
407 }
408 static inline void set_dev_node(struct device *dev, int node)
409 {
410         dev->numa_node = node;
411 }
412 #else
413 static inline int dev_to_node(struct device *dev)
414 {
415         return -1;
416 }
417 static inline void set_dev_node(struct device *dev, int node)
418 {
419 }
420 #endif
421
422 static inline void *dev_get_drvdata(struct device *dev)
423 {
424         return dev->driver_data;
425 }
426
427 static inline void dev_set_drvdata(struct device *dev, void *data)
428 {
429         dev->driver_data = data;
430 }
431
432 static inline int device_is_registered(struct device *dev)
433 {
434         return dev->kobj.state_in_sysfs;
435 }
436
437 void driver_init(void);
438
439 /*
440  * High level routines for use by the bus drivers
441  */
442 extern int __must_check device_register(struct device *dev);
443 extern void device_unregister(struct device *dev);
444 extern void device_initialize(struct device *dev);
445 extern int __must_check device_add(struct device *dev);
446 extern void device_del(struct device *dev);
447 extern int device_for_each_child(struct device *dev, void *data,
448                      int (*fn)(struct device *dev, void *data));
449 extern struct device *device_find_child(struct device *dev, void *data,
450                                 int (*match)(struct device *dev, void *data));
451 extern int device_rename(struct device *dev, char *new_name);
452 extern int device_move(struct device *dev, struct device *new_parent);
453
454 /*
455  * Manual binding of a device to driver. See drivers/base/bus.c
456  * for information on use.
457  */
458 extern int __must_check device_bind_driver(struct device *dev);
459 extern void device_release_driver(struct device *dev);
460 extern int  __must_check device_attach(struct device *dev);
461 extern int __must_check driver_attach(struct device_driver *drv);
462 extern int __must_check device_reprobe(struct device *dev);
463
464 /*
465  * Easy functions for dynamically creating devices on the fly
466  */
467 extern struct device *device_create_vargs(struct class *cls,
468                                           struct device *parent,
469                                           dev_t devt,
470                                           void *drvdata,
471                                           const char *fmt,
472                                           va_list vargs);
473 extern struct device *device_create(struct class *cls, struct device *parent,
474                                     dev_t devt, const char *fmt, ...)
475                                     __attribute__((format(printf, 4, 5)));
476 extern struct device *device_create_drvdata(struct class *cls,
477                                             struct device *parent,
478                                             dev_t devt,
479                                             void *drvdata,
480                                             const char *fmt, ...)
481                                     __attribute__((format(printf, 5, 6)));
482 extern void device_destroy(struct class *cls, dev_t devt);
483
484 /*
485  * Platform "fixup" functions - allow the platform to have their say
486  * about devices and actions that the general device layer doesn't
487  * know about.
488  */
489 /* Notify platform of device discovery */
490 extern int (*platform_notify)(struct device *dev);
491
492 extern int (*platform_notify_remove)(struct device *dev);
493
494
495 /**
496  * get_device - atomically increment the reference count for the device.
497  *
498  */
499 extern struct device *get_device(struct device *dev);
500 extern void put_device(struct device *dev);
501
502
503 /* drivers/base/power/shutdown.c */
504 extern void device_shutdown(void);
505
506 /* drivers/base/sys.c */
507 extern void sysdev_shutdown(void);
508
509 /* debugging and troubleshooting/diagnostic helpers. */
510 extern const char *dev_driver_string(struct device *dev);
511 #define dev_printk(level, dev, format, arg...)  \
512         printk(level "%s %s: " format , dev_driver_string(dev) , \
513                dev_name(dev) , ## arg)
514
515 #define dev_emerg(dev, format, arg...)          \
516         dev_printk(KERN_EMERG , dev , format , ## arg)
517 #define dev_alert(dev, format, arg...)          \
518         dev_printk(KERN_ALERT , dev , format , ## arg)
519 #define dev_crit(dev, format, arg...)           \
520         dev_printk(KERN_CRIT , dev , format , ## arg)
521 #define dev_err(dev, format, arg...)            \
522         dev_printk(KERN_ERR , dev , format , ## arg)
523 #define dev_warn(dev, format, arg...)           \
524         dev_printk(KERN_WARNING , dev , format , ## arg)
525 #define dev_notice(dev, format, arg...)         \
526         dev_printk(KERN_NOTICE , dev , format , ## arg)
527 #define dev_info(dev, format, arg...)           \
528         dev_printk(KERN_INFO , dev , format , ## arg)
529
530 #ifdef DEBUG
531 #define dev_dbg(dev, format, arg...)            \
532         dev_printk(KERN_DEBUG , dev , format , ## arg)
533 #else
534 #define dev_dbg(dev, format, arg...)            \
535         ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
536 #endif
537
538 #ifdef VERBOSE_DEBUG
539 #define dev_vdbg        dev_dbg
540 #else
541
542 #define dev_vdbg(dev, format, arg...)           \
543         ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
544 #endif
545
546 /* Create alias, so I can be autoloaded. */
547 #define MODULE_ALIAS_CHARDEV(major,minor) \
548         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
549 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
550         MODULE_ALIAS("char-major-" __stringify(major) "-*")
551 #endif /* _DEVICE_H_ */