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);
54 int (*suspend)(struct device * dev, pm_message_t state);
55 int (*resume)(struct device * dev);
58 extern int bus_register(struct bus_type * bus);
59 extern void bus_unregister(struct bus_type * bus);
61 extern void bus_rescan_devices(struct bus_type * bus);
63 extern struct bus_type * get_bus(struct bus_type * bus);
64 extern void put_bus(struct bus_type * bus);
66 extern struct bus_type * find_bus(char * name);
68 /* iterator helpers for buses */
70 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
71 int (*fn)(struct device *, void *));
72 struct device * bus_find_device(struct bus_type *bus, struct device *start,
73 void *data, int (*match)(struct device *, void *));
75 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
76 void * data, int (*fn)(struct device_driver *, void *));
79 /* driverfs interface for exporting bus attributes */
81 struct bus_attribute {
82 struct attribute attr;
83 ssize_t (*show)(struct bus_type *, char * buf);
84 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
87 #define BUS_ATTR(_name,_mode,_show,_store) \
88 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
90 extern int bus_create_file(struct bus_type *, struct bus_attribute *);
91 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
93 struct device_driver {
95 struct bus_type * bus;
97 struct completion unloaded;
99 struct klist klist_devices;
100 struct klist_node knode_bus;
102 struct module * owner;
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);
112 extern int driver_register(struct device_driver * drv);
113 extern void driver_unregister(struct device_driver * drv);
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);
120 /* driverfs interface for exporting driver attributes */
122 struct driver_attribute {
123 struct attribute attr;
124 ssize_t (*show)(struct device_driver *, char * buf);
125 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
128 #define DRIVER_ATTR(_name,_mode,_show,_store) \
129 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
131 extern int driver_create_file(struct device_driver *, struct driver_attribute *);
132 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
134 extern int driver_for_each_device(struct device_driver * drv, struct device * start,
135 void * data, int (*fn)(struct device *, void *));
136 struct device * driver_find_device(struct device_driver *drv,
137 struct device *start, void *data,
138 int (*match)(struct device *, void *));
146 struct module * owner;
148 struct subsystem subsys;
149 struct list_head children;
150 struct list_head interfaces;
151 struct semaphore sem; /* locks both the children and interfaces lists */
153 struct class_attribute * class_attrs;
154 struct class_device_attribute * class_dev_attrs;
156 int (*uevent)(struct class_device *dev, char **envp,
157 int num_envp, char *buffer, int buffer_size);
159 void (*release)(struct class_device *dev);
160 void (*class_release)(struct class *class);
163 extern int class_register(struct class *);
164 extern void class_unregister(struct class *);
166 extern struct class * class_get(struct class *);
167 extern void class_put(struct class *);
170 struct class_attribute {
171 struct attribute attr;
172 ssize_t (*show)(struct class *, char * buf);
173 ssize_t (*store)(struct class *, const char * buf, size_t count);
176 #define CLASS_ATTR(_name,_mode,_show,_store) \
177 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
179 extern int class_create_file(struct class *, const struct class_attribute *);
180 extern void class_remove_file(struct class *, const struct class_attribute *);
182 struct class_device_attribute {
183 struct attribute attr;
184 ssize_t (*show)(struct class_device *, char * buf);
185 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
188 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
189 struct class_device_attribute class_device_attr_##_name = \
190 __ATTR(_name,_mode,_show,_store)
192 extern int class_device_create_file(struct class_device *,
193 const struct class_device_attribute *);
196 * struct class_device - class devices
197 * @class: pointer to the parent class for this class device. This is required.
198 * @devt: for internal use by the driver core only.
199 * @node: for internal use by the driver core only.
200 * @kobj: for internal use by the driver core only.
201 * @devt_attr: for internal use by the driver core only.
202 * @dev: if set, a symlink to the struct device is created in the sysfs
203 * directory for this struct class device.
204 * @class_data: pointer to whatever you want to store here for this struct
205 * class_device. Use class_get_devdata() and class_set_devdata() to get and
207 * @parent: pointer to a struct class_device that is the parent of this struct
208 * class_device. If NULL, this class_device will show up at the root of the
209 * struct class in sysfs (which is probably what you want to have happen.)
210 * @release: pointer to a release function for this struct class_device. If
211 * set, this will be called instead of the class specific release function.
212 * Only use this if you want to override the default release function, like
213 * when you are nesting class_device structures.
214 * @uevent: pointer to a uevent function for this struct class_device. If
215 * set, this will be called instead of the class specific uevent function.
216 * Only use this if you want to override the default uevent function, like
217 * when you are nesting class_device structures.
219 struct class_device {
220 struct list_head node;
223 struct class * class; /* required */
224 dev_t devt; /* dev_t, creates the sysfs "dev" */
225 struct class_device_attribute *devt_attr;
226 struct class_device_attribute uevent_attr;
227 struct device * dev; /* not necessary, but nice to have */
228 void * class_data; /* class-specific data */
229 struct class_device *parent; /* parent of this child device, if there is one */
231 void (*release)(struct class_device *dev);
232 int (*uevent)(struct class_device *dev, char **envp,
233 int num_envp, char *buffer, int buffer_size);
234 char class_id[BUS_ID_SIZE]; /* unique to this class */
238 class_get_devdata (struct class_device *dev)
240 return dev->class_data;
244 class_set_devdata (struct class_device *dev, void *data)
246 dev->class_data = data;
250 extern int class_device_register(struct class_device *);
251 extern void class_device_unregister(struct class_device *);
252 extern void class_device_initialize(struct class_device *);
253 extern int class_device_add(struct class_device *);
254 extern void class_device_del(struct class_device *);
256 extern int class_device_rename(struct class_device *, char *);
258 extern struct class_device * class_device_get(struct class_device *);
259 extern void class_device_put(struct class_device *);
261 extern void class_device_remove_file(struct class_device *,
262 const struct class_device_attribute *);
263 extern int class_device_create_bin_file(struct class_device *,
264 struct bin_attribute *);
265 extern void class_device_remove_bin_file(struct class_device *,
266 struct bin_attribute *);
268 struct class_interface {
269 struct list_head node;
272 int (*add) (struct class_device *, struct class_interface *);
273 void (*remove) (struct class_device *, struct class_interface *);
276 extern int class_interface_register(struct class_interface *);
277 extern void class_interface_unregister(struct class_interface *);
279 extern struct class *class_create(struct module *owner, char *name);
280 extern void class_destroy(struct class *cls);
281 extern struct class_device *class_device_create(struct class *cls,
282 struct class_device *parent,
284 struct device *device,
286 __attribute__((format(printf,5,6)));
287 extern void class_device_destroy(struct class *cls, dev_t devt);
290 /* interface for exporting device attributes */
291 struct device_attribute {
292 struct attribute attr;
293 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
295 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count);
299 #define DEVICE_ATTR(_name,_mode,_show,_store) \
300 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
302 extern int device_create_file(struct device *device, struct device_attribute * entry);
303 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
305 struct klist klist_children;
306 struct klist_node knode_parent; /* node in sibling list */
307 struct klist_node knode_driver;
308 struct klist_node knode_bus;
309 struct device * parent;
312 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
313 struct device_attribute uevent_attr;
315 struct semaphore sem; /* semaphore to synchronize calls to
319 struct bus_type * bus; /* type of bus device is on */
320 struct device_driver *driver; /* which driver has allocated this
322 void *driver_data; /* data private to the driver */
323 void *platform_data; /* Platform specific data, device
324 core doesn't touch it */
325 void *firmware_data; /* Firmware specific data (e.g. ACPI,
326 BIOS data),reserved for device core*/
327 struct dev_pm_info power;
329 u64 *dma_mask; /* dma mask (if dma'able device) */
330 u64 coherent_dma_mask;/* Like dma_mask, but for
331 alloc_coherent mappings as
332 not all hardware supports
333 64 bit addresses for consistent
334 allocations such descriptors. */
336 struct list_head dma_pools; /* dma pools (if dma'ble) */
338 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
341 void (*release)(struct device * dev);
345 dev_get_drvdata (struct device *dev)
347 return dev->driver_data;
351 dev_set_drvdata (struct device *dev, void *data)
353 dev->driver_data = data;
356 static inline int device_is_registered(struct device *dev)
358 return klist_node_attached(&dev->knode_bus);
362 * High level routines for use by the bus drivers
364 extern int device_register(struct device * dev);
365 extern void device_unregister(struct device * dev);
366 extern void device_initialize(struct device * dev);
367 extern int device_add(struct device * dev);
368 extern void device_del(struct device * dev);
369 extern int device_for_each_child(struct device *, void *,
370 int (*fn)(struct device *, void *));
373 * Manual binding of a device to driver. See drivers/base/bus.c
374 * for information on use.
376 extern void device_bind_driver(struct device * dev);
377 extern void device_release_driver(struct device * dev);
378 extern int device_attach(struct device * dev);
379 extern void driver_attach(struct device_driver * drv);
380 extern void device_reprobe(struct device *dev);
384 * Platform "fixup" functions - allow the platform to have their say
385 * about devices and actions that the general device layer doesn't
388 /* Notify platform of device discovery */
389 extern int (*platform_notify)(struct device * dev);
391 extern int (*platform_notify_remove)(struct device * dev);
395 * get_device - atomically increment the reference count for the device.
398 extern struct device * get_device(struct device * dev);
399 extern void put_device(struct device * dev);
402 /* drivers/base/power/shutdown.c */
403 extern void device_shutdown(void);
406 /* drivers/base/firmware.c */
407 extern int firmware_register(struct subsystem *);
408 extern void firmware_unregister(struct subsystem *);
410 /* debugging and troubleshooting/diagnostic helpers. */
411 #define dev_printk(level, dev, format, arg...) \
412 printk(level "%s %s: " format , (dev)->driver ? (dev)->driver->name : "" , (dev)->bus_id , ## arg)
415 #define dev_dbg(dev, format, arg...) \
416 dev_printk(KERN_DEBUG , dev , format , ## arg)
418 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
421 #define dev_err(dev, format, arg...) \
422 dev_printk(KERN_ERR , dev , format , ## arg)
423 #define dev_info(dev, format, arg...) \
424 dev_printk(KERN_INFO , dev , format , ## arg)
425 #define dev_warn(dev, format, arg...) \
426 dev_printk(KERN_WARNING , dev , format , ## arg)
427 #define dev_notice(dev, format, arg...) \
428 dev_printk(KERN_NOTICE , dev , format , ## arg)
430 /* Create alias, so I can be autoloaded. */
431 #define MODULE_ALIAS_CHARDEV(major,minor) \
432 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
433 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
434 MODULE_ALIAS("char-major-" __stringify(major) "-*")
435 #endif /* _DEVICE_H_ */