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 kobject
*virtual_dir
;
154 struct class_attribute
* class_attrs
;
155 struct class_device_attribute
* class_dev_attrs
;
156 struct device_attribute
* dev_attrs
;
158 int (*uevent
)(struct class_device
*dev
, char **envp
,
159 int num_envp
, char *buffer
, int buffer_size
);
160 int (*dev_uevent
)(struct device
*dev
, char **envp
, int num_envp
,
161 char *buffer
, int buffer_size
);
163 void (*release
)(struct class_device
*dev
);
164 void (*class_release
)(struct class *class);
165 void (*dev_release
)(struct device
*dev
);
167 int (*suspend
)(struct device
*, pm_message_t state
);
168 int (*resume
)(struct device
*);
171 extern int class_register(struct class *);
172 extern void class_unregister(struct class *);
175 struct class_attribute
{
176 struct attribute attr
;
177 ssize_t (*show
)(struct class *, char * buf
);
178 ssize_t (*store
)(struct class *, const char * buf
, size_t count
);
181 #define CLASS_ATTR(_name,_mode,_show,_store) \
182 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
184 extern int class_create_file(struct class *, const struct class_attribute
*);
185 extern void class_remove_file(struct class *, const struct class_attribute
*);
187 struct class_device_attribute
{
188 struct attribute attr
;
189 ssize_t (*show
)(struct class_device
*, char * buf
);
190 ssize_t (*store
)(struct class_device
*, const char * buf
, size_t count
);
193 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
194 struct class_device_attribute class_device_attr_##_name = \
195 __ATTR(_name,_mode,_show,_store)
197 extern int class_device_create_file(struct class_device
*,
198 const struct class_device_attribute
*);
201 * struct class_device - class devices
202 * @class: pointer to the parent class for this class device. This is required.
203 * @devt: for internal use by the driver core only.
204 * @node: for internal use by the driver core only.
205 * @kobj: for internal use by the driver core only.
206 * @devt_attr: for internal use by the driver core only.
207 * @groups: optional additional groups to be created
208 * @dev: if set, a symlink to the struct device is created in the sysfs
209 * directory for this struct class device.
210 * @class_data: pointer to whatever you want to store here for this struct
211 * class_device. Use class_get_devdata() and class_set_devdata() to get and
213 * @parent: pointer to a struct class_device that is the parent of this struct
214 * class_device. If NULL, this class_device will show up at the root of the
215 * struct class in sysfs (which is probably what you want to have happen.)
216 * @release: pointer to a release function for this struct class_device. If
217 * set, this will be called instead of the class specific release function.
218 * Only use this if you want to override the default release function, like
219 * when you are nesting class_device structures.
220 * @uevent: pointer to a uevent function for this struct class_device. If
221 * set, this will be called instead of the class specific uevent function.
222 * Only use this if you want to override the default uevent function, like
223 * when you are nesting class_device structures.
225 struct class_device
{
226 struct list_head node
;
229 struct class * class; /* required */
230 dev_t devt
; /* dev_t, creates the sysfs "dev" */
231 struct class_device_attribute
*devt_attr
;
232 struct class_device_attribute uevent_attr
;
233 struct device
* dev
; /* not necessary, but nice to have */
234 void * class_data
; /* class-specific data */
235 struct class_device
*parent
; /* parent of this child device, if there is one */
236 struct attribute_group
** groups
; /* optional groups */
238 void (*release
)(struct class_device
*dev
);
239 int (*uevent
)(struct class_device
*dev
, char **envp
,
240 int num_envp
, char *buffer
, int buffer_size
);
241 char class_id
[BUS_ID_SIZE
]; /* unique to this class */
245 class_get_devdata (struct class_device
*dev
)
247 return dev
->class_data
;
251 class_set_devdata (struct class_device
*dev
, void *data
)
253 dev
->class_data
= data
;
257 extern int class_device_register(struct class_device
*);
258 extern void class_device_unregister(struct class_device
*);
259 extern void class_device_initialize(struct class_device
*);
260 extern int class_device_add(struct class_device
*);
261 extern void class_device_del(struct class_device
*);
263 extern int class_device_rename(struct class_device
*, char *);
265 extern struct class_device
* class_device_get(struct class_device
*);
266 extern void class_device_put(struct class_device
*);
268 extern void class_device_remove_file(struct class_device
*,
269 const struct class_device_attribute
*);
270 extern int class_device_create_bin_file(struct class_device
*,
271 struct bin_attribute
*);
272 extern void class_device_remove_bin_file(struct class_device
*,
273 struct bin_attribute
*);
275 struct class_interface
{
276 struct list_head node
;
279 int (*add
) (struct class_device
*, struct class_interface
*);
280 void (*remove
) (struct class_device
*, struct class_interface
*);
281 int (*add_dev
) (struct device
*, struct class_interface
*);
282 void (*remove_dev
) (struct device
*, struct class_interface
*);
285 extern int class_interface_register(struct class_interface
*);
286 extern void class_interface_unregister(struct class_interface
*);
288 extern struct class *class_create(struct module
*owner
, const char *name
);
289 extern void class_destroy(struct class *cls
);
290 extern struct class_device
*class_device_create(struct class *cls
,
291 struct class_device
*parent
,
293 struct device
*device
,
294 const char *fmt
, ...)
295 __attribute__((format(printf
,5,6)));
296 extern void class_device_destroy(struct class *cls
, dev_t devt
);
298 /* interface for exporting device attributes */
299 struct device_attribute
{
300 struct attribute attr
;
301 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
303 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
304 const char *buf
, size_t count
);
307 #define DEVICE_ATTR(_name,_mode,_show,_store) \
308 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
310 extern int device_create_file(struct device
*device
, struct device_attribute
* entry
);
311 extern void device_remove_file(struct device
* dev
, struct device_attribute
* attr
);
313 struct klist klist_children
;
314 struct klist_node knode_parent
; /* node in sibling list */
315 struct klist_node knode_driver
;
316 struct klist_node knode_bus
;
317 struct device
* parent
;
320 char bus_id
[BUS_ID_SIZE
]; /* position on parent bus */
321 struct device_attribute uevent_attr
;
322 struct device_attribute
*devt_attr
;
324 struct semaphore sem
; /* semaphore to synchronize calls to
328 struct bus_type
* bus
; /* type of bus device is on */
329 struct device_driver
*driver
; /* which driver has allocated this
331 void *driver_data
; /* data private to the driver */
332 void *platform_data
; /* Platform specific data, device
333 core doesn't touch it */
334 void *firmware_data
; /* Firmware specific data (e.g. ACPI,
335 BIOS data),reserved for device core*/
336 struct dev_pm_info power
;
338 u64
*dma_mask
; /* dma mask (if dma'able device) */
339 u64 coherent_dma_mask
;/* Like dma_mask, but for
340 alloc_coherent mappings as
341 not all hardware supports
342 64 bit addresses for consistent
343 allocations such descriptors. */
345 struct list_head dma_pools
; /* dma pools (if dma'ble) */
347 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
350 /* class_device migration path */
351 struct list_head node
;
352 struct class *class; /* optional*/
353 dev_t devt
; /* dev_t, creates the sysfs "dev" */
354 struct attribute_group
**groups
; /* optional groups */
356 void (*release
)(struct device
* dev
);
360 dev_get_drvdata (struct device
*dev
)
362 return dev
->driver_data
;
366 dev_set_drvdata (struct device
*dev
, void *data
)
368 dev
->driver_data
= data
;
371 static inline int device_is_registered(struct device
*dev
)
373 return klist_node_attached(&dev
->knode_bus
);
377 * High level routines for use by the bus drivers
379 extern int device_register(struct device
* dev
);
380 extern void device_unregister(struct device
* dev
);
381 extern void device_initialize(struct device
* dev
);
382 extern int device_add(struct device
* dev
);
383 extern void device_del(struct device
* dev
);
384 extern int device_for_each_child(struct device
*, void *,
385 int (*fn
)(struct device
*, void *));
386 extern int device_rename(struct device
*dev
, char *new_name
);
389 * Manual binding of a device to driver. See drivers/base/bus.c
390 * for information on use.
392 extern void device_bind_driver(struct device
* dev
);
393 extern void device_release_driver(struct device
* dev
);
394 extern int device_attach(struct device
* dev
);
395 extern void driver_attach(struct device_driver
* drv
);
396 extern void device_reprobe(struct device
*dev
);
399 * Easy functions for dynamically creating devices on the fly
401 extern struct device
*device_create(struct class *cls
, struct device
*parent
,
402 dev_t devt
, const char *fmt
, ...)
403 __attribute__((format(printf
,4,5)));
404 extern void device_destroy(struct class *cls
, dev_t devt
);
406 extern int virtual_device_parent(struct device
*dev
);
409 * Platform "fixup" functions - allow the platform to have their say
410 * about devices and actions that the general device layer doesn't
413 /* Notify platform of device discovery */
414 extern int (*platform_notify
)(struct device
* dev
);
416 extern int (*platform_notify_remove
)(struct device
* dev
);
420 * get_device - atomically increment the reference count for the device.
423 extern struct device
* get_device(struct device
* dev
);
424 extern void put_device(struct device
* dev
);
427 /* drivers/base/power/shutdown.c */
428 extern void device_shutdown(void);
431 /* drivers/base/firmware.c */
432 extern int firmware_register(struct subsystem
*);
433 extern void firmware_unregister(struct subsystem
*);
435 /* debugging and troubleshooting/diagnostic helpers. */
436 extern const char *dev_driver_string(struct device
*dev
);
437 #define dev_printk(level, dev, format, arg...) \
438 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
441 #define dev_dbg(dev, format, arg...) \
442 dev_printk(KERN_DEBUG , dev , format , ## arg)
444 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
447 #define dev_err(dev, format, arg...) \
448 dev_printk(KERN_ERR , dev , format , ## arg)
449 #define dev_info(dev, format, arg...) \
450 dev_printk(KERN_INFO , dev , format , ## arg)
451 #define dev_warn(dev, format, arg...) \
452 dev_printk(KERN_WARNING , dev , format , ## arg)
453 #define dev_notice(dev, format, arg...) \
454 dev_printk(KERN_NOTICE , dev , format , ## arg)
456 /* Create alias, so I can be autoloaded. */
457 #define MODULE_ALIAS_CHARDEV(major,minor) \
458 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
459 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
460 MODULE_ALIAS("char-major-" __stringify(major) "-*")
461 #endif /* _DEVICE_H_ */