2 * device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
6 * This file is released under the GPLv2
8 * See Documentation/driver-model/ for more information.
14 #include <linux/ioport.h>
15 #include <linux/kobject.h>
16 #include <linux/klist.h>
17 #include <linux/list.h>
18 #include <linux/types.h>
19 #include <linux/module.h>
21 #include <asm/semaphore.h>
22 #include <asm/atomic.h>
24 #define DEVICE_NAME_SIZE 50
25 #define DEVICE_NAME_HALF __stringify(20) /* Less than half to accommodate slop */
26 #define DEVICE_ID_SIZE 32
27 #define BUS_ID_SIZE KOBJ_NAME_LEN
38 struct subsystem subsys;
41 struct klist klist_devices;
42 struct klist klist_drivers;
44 struct bus_attribute * bus_attrs;
45 struct device_attribute * dev_attrs;
46 struct driver_attribute * drv_attrs;
48 int (*match)(struct device * dev, struct device_driver * drv);
49 int (*uevent)(struct device *dev, char **envp,
50 int num_envp, char *buffer, int buffer_size);
51 int (*probe)(struct device * dev);
52 int (*remove)(struct device * dev);
53 void (*shutdown)(struct device * dev);
55 int (*suspend)(struct device * dev, pm_message_t state);
56 int (*suspend_late)(struct device * dev, pm_message_t state);
57 int (*resume_early)(struct device * dev);
58 int (*resume)(struct device * dev);
61 extern int bus_register(struct bus_type * bus);
62 extern void bus_unregister(struct bus_type * bus);
64 extern void bus_rescan_devices(struct bus_type * bus);
66 /* iterator helpers for buses */
68 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
69 int (*fn)(struct device *, void *));
70 struct device * bus_find_device(struct bus_type *bus, struct device *start,
71 void *data, int (*match)(struct device *, void *));
73 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
74 void * data, int (*fn)(struct device_driver *, void *));
77 /* driverfs interface for exporting bus attributes */
79 struct bus_attribute {
80 struct attribute attr;
81 ssize_t (*show)(struct bus_type *, char * buf);
82 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
85 #define BUS_ATTR(_name,_mode,_show,_store) \
86 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
88 extern int bus_create_file(struct bus_type *, struct bus_attribute *);
89 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
91 struct device_driver {
93 struct bus_type * bus;
95 struct completion unloaded;
97 struct klist klist_devices;
98 struct klist_node knode_bus;
100 struct module * owner;
102 int (*probe) (struct device * dev);
103 int (*remove) (struct device * dev);
104 void (*shutdown) (struct device * dev);
105 int (*suspend) (struct device * dev, pm_message_t state);
106 int (*resume) (struct device * dev);
110 extern int driver_register(struct device_driver * drv);
111 extern void driver_unregister(struct device_driver * drv);
113 extern struct device_driver * get_driver(struct device_driver * drv);
114 extern void put_driver(struct device_driver * drv);
115 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
118 /* driverfs interface for exporting driver attributes */
120 struct driver_attribute {
121 struct attribute attr;
122 ssize_t (*show)(struct device_driver *, char * buf);
123 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
126 #define DRIVER_ATTR(_name,_mode,_show,_store) \
127 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
129 extern int driver_create_file(struct device_driver *, struct driver_attribute *);
130 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
132 extern int driver_for_each_device(struct device_driver * drv, struct device * start,
133 void * data, int (*fn)(struct device *, void *));
134 struct device * driver_find_device(struct device_driver *drv,
135 struct device *start, void *data,
136 int (*match)(struct device *, void *));
144 struct module * owner;
146 struct subsystem subsys;
147 struct list_head children;
148 struct list_head devices;
149 struct list_head interfaces;
150 struct semaphore sem; /* locks both the children and interfaces lists */
152 struct class_attribute * class_attrs;
153 struct class_device_attribute * class_dev_attrs;
154 struct device_attribute * dev_attrs;
156 int (*uevent)(struct class_device *dev, char **envp,
157 int num_envp, char *buffer, int buffer_size);
158 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
159 char *buffer, int buffer_size);
161 void (*release)(struct class_device *dev);
162 void (*class_release)(struct class *class);
163 void (*dev_release)(struct device *dev);
165 int (*suspend)(struct device *, pm_message_t state);
166 int (*resume)(struct device *);
169 extern int class_register(struct class *);
170 extern void class_unregister(struct class *);
173 struct class_attribute {
174 struct attribute attr;
175 ssize_t (*show)(struct class *, char * buf);
176 ssize_t (*store)(struct class *, const char * buf, size_t count);
179 #define CLASS_ATTR(_name,_mode,_show,_store) \
180 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
182 extern int class_create_file(struct class *, const struct class_attribute *);
183 extern void class_remove_file(struct class *, const struct class_attribute *);
185 struct class_device_attribute {
186 struct attribute attr;
187 ssize_t (*show)(struct class_device *, char * buf);
188 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
191 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
192 struct class_device_attribute class_device_attr_##_name = \
193 __ATTR(_name,_mode,_show,_store)
195 extern int class_device_create_file(struct class_device *,
196 const struct class_device_attribute *);
199 * struct class_device - class devices
200 * @class: pointer to the parent class for this class device. This is required.
201 * @devt: for internal use by the driver core only.
202 * @node: for internal use by the driver core only.
203 * @kobj: for internal use by the driver core only.
204 * @devt_attr: for internal use by the driver core only.
205 * @groups: optional additional groups to be created
206 * @dev: if set, a symlink to the struct device is created in the sysfs
207 * directory for this struct class device.
208 * @class_data: pointer to whatever you want to store here for this struct
209 * class_device. Use class_get_devdata() and class_set_devdata() to get and
211 * @parent: pointer to a struct class_device that is the parent of this struct
212 * class_device. If NULL, this class_device will show up at the root of the
213 * struct class in sysfs (which is probably what you want to have happen.)
214 * @release: pointer to a release function for this struct class_device. If
215 * set, this will be called instead of the class specific release function.
216 * Only use this if you want to override the default release function, like
217 * when you are nesting class_device structures.
218 * @uevent: pointer to a uevent function for this struct class_device. If
219 * set, this will be called instead of the class specific uevent function.
220 * Only use this if you want to override the default uevent function, like
221 * when you are nesting class_device structures.
223 struct class_device {
224 struct list_head node;
227 struct class * class; /* required */
228 dev_t devt; /* dev_t, creates the sysfs "dev" */
229 struct class_device_attribute *devt_attr;
230 struct class_device_attribute uevent_attr;
231 struct device * dev; /* not necessary, but nice to have */
232 void * class_data; /* class-specific data */
233 struct class_device *parent; /* parent of this child device, if there is one */
234 struct attribute_group ** groups; /* optional groups */
236 void (*release)(struct class_device *dev);
237 int (*uevent)(struct class_device *dev, char **envp,
238 int num_envp, char *buffer, int buffer_size);
239 char class_id[BUS_ID_SIZE]; /* unique to this class */
243 class_get_devdata (struct class_device *dev)
245 return dev->class_data;
249 class_set_devdata (struct class_device *dev, void *data)
251 dev->class_data = data;
255 extern int class_device_register(struct class_device *);
256 extern void class_device_unregister(struct class_device *);
257 extern void class_device_initialize(struct class_device *);
258 extern int class_device_add(struct class_device *);
259 extern void class_device_del(struct class_device *);
261 extern int class_device_rename(struct class_device *, char *);
263 extern struct class_device * class_device_get(struct class_device *);
264 extern void class_device_put(struct class_device *);
266 extern void class_device_remove_file(struct class_device *,
267 const struct class_device_attribute *);
268 extern int class_device_create_bin_file(struct class_device *,
269 struct bin_attribute *);
270 extern void class_device_remove_bin_file(struct class_device *,
271 struct bin_attribute *);
273 struct class_interface {
274 struct list_head node;
277 int (*add) (struct class_device *, struct class_interface *);
278 void (*remove) (struct class_device *, struct class_interface *);
281 extern int class_interface_register(struct class_interface *);
282 extern void class_interface_unregister(struct class_interface *);
284 extern struct class *class_create(struct module *owner, const char *name);
285 extern void class_destroy(struct class *cls);
286 extern struct class_device *class_device_create(struct class *cls,
287 struct class_device *parent,
289 struct device *device,
290 const char *fmt, ...)
291 __attribute__((format(printf,5,6)));
292 extern void class_device_destroy(struct class *cls, dev_t devt);
295 /* interface for exporting device attributes */
296 struct device_attribute {
297 struct attribute attr;
298 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
300 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
301 const char *buf, size_t count);
304 #define DEVICE_ATTR(_name,_mode,_show,_store) \
305 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
307 extern int device_create_file(struct device *device, struct device_attribute * entry);
308 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
310 struct klist klist_children;
311 struct klist_node knode_parent; /* node in sibling list */
312 struct klist_node knode_driver;
313 struct klist_node knode_bus;
314 struct device * parent;
317 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
318 struct device_attribute uevent_attr;
319 struct device_attribute *devt_attr;
321 struct semaphore sem; /* semaphore to synchronize calls to
325 struct bus_type * bus; /* type of bus device is on */
326 struct device_driver *driver; /* which driver has allocated this
328 void *driver_data; /* data private to the driver */
329 void *platform_data; /* Platform specific data, device
330 core doesn't touch it */
331 void *firmware_data; /* Firmware specific data (e.g. ACPI,
332 BIOS data),reserved for device core*/
333 struct dev_pm_info power;
335 u64 *dma_mask; /* dma mask (if dma'able device) */
336 u64 coherent_dma_mask;/* Like dma_mask, but for
337 alloc_coherent mappings as
338 not all hardware supports
339 64 bit addresses for consistent
340 allocations such descriptors. */
342 struct list_head dma_pools; /* dma pools (if dma'ble) */
344 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
347 /* class_device migration path */
348 struct list_head node;
349 struct class *class; /* optional*/
350 dev_t devt; /* dev_t, creates the sysfs "dev" */
351 struct attribute_group **groups; /* optional groups */
353 void (*release)(struct device * dev);
357 dev_get_drvdata (struct device *dev)
359 return dev->driver_data;
363 dev_set_drvdata (struct device *dev, void *data)
365 dev->driver_data = data;
368 static inline int device_is_registered(struct device *dev)
370 return klist_node_attached(&dev->knode_bus);
374 * High level routines for use by the bus drivers
376 extern int device_register(struct device * dev);
377 extern void device_unregister(struct device * dev);
378 extern void device_initialize(struct device * dev);
379 extern int device_add(struct device * dev);
380 extern void device_del(struct device * dev);
381 extern int device_for_each_child(struct device *, void *,
382 int (*fn)(struct device *, void *));
385 * Manual binding of a device to driver. See drivers/base/bus.c
386 * for information on use.
388 extern void device_bind_driver(struct device * dev);
389 extern void device_release_driver(struct device * dev);
390 extern int device_attach(struct device * dev);
391 extern void driver_attach(struct device_driver * drv);
392 extern void device_reprobe(struct device *dev);
395 * Easy functions for dynamically creating devices on the fly
397 extern struct device *device_create(struct class *cls, struct device *parent,
398 dev_t devt, const char *fmt, ...)
399 __attribute__((format(printf,4,5)));
400 extern void device_destroy(struct class *cls, dev_t devt);
403 * Platform "fixup" functions - allow the platform to have their say
404 * about devices and actions that the general device layer doesn't
407 /* Notify platform of device discovery */
408 extern int (*platform_notify)(struct device * dev);
410 extern int (*platform_notify_remove)(struct device * dev);
414 * get_device - atomically increment the reference count for the device.
417 extern struct device * get_device(struct device * dev);
418 extern void put_device(struct device * dev);
421 /* drivers/base/power/shutdown.c */
422 extern void device_shutdown(void);
425 /* drivers/base/firmware.c */
426 extern int firmware_register(struct subsystem *);
427 extern void firmware_unregister(struct subsystem *);
429 /* debugging and troubleshooting/diagnostic helpers. */
430 extern const char *dev_driver_string(struct device *dev);
431 #define dev_printk(level, dev, format, arg...) \
432 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
435 #define dev_dbg(dev, format, arg...) \
436 dev_printk(KERN_DEBUG , dev , format , ## arg)
438 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
441 #define dev_err(dev, format, arg...) \
442 dev_printk(KERN_ERR , dev , format , ## arg)
443 #define dev_info(dev, format, arg...) \
444 dev_printk(KERN_INFO , dev , format , ## arg)
445 #define dev_warn(dev, format, arg...) \
446 dev_printk(KERN_WARNING , dev , format , ## arg)
447 #define dev_notice(dev, format, arg...) \
448 dev_printk(KERN_NOTICE , dev , format , ## arg)
450 /* Create alias, so I can be autoloaded. */
451 #define MODULE_ALIAS_CHARDEV(major,minor) \
452 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
453 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
454 MODULE_ALIAS("char-major-" __stringify(major) "-*")
455 #endif /* _DEVICE_H_ */