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/config.h>
15 #include <linux/ioport.h>
16 #include <linux/kobject.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
52 struct subsystem subsys
;
56 struct bus_attribute
* bus_attrs
;
57 struct device_attribute
* dev_attrs
;
58 struct driver_attribute
* drv_attrs
;
60 int (*match
)(struct device
* dev
, struct device_driver
* drv
);
61 int (*hotplug
) (struct device
*dev
, char **envp
,
62 int num_envp
, char *buffer
, int buffer_size
);
63 int (*suspend
)(struct device
* dev
, pm_message_t state
);
64 int (*resume
)(struct device
* dev
);
67 extern int bus_register(struct bus_type
* bus
);
68 extern void bus_unregister(struct bus_type
* bus
);
70 extern int bus_rescan_devices(struct bus_type
* bus
);
72 extern struct bus_type
* get_bus(struct bus_type
* bus
);
73 extern void put_bus(struct bus_type
* bus
);
75 extern struct bus_type
* find_bus(char * name
);
77 /* iterator helpers for buses */
79 int bus_for_each_dev(struct bus_type
* bus
, struct device
* start
, void * data
,
80 int (*fn
)(struct device
*, void *));
82 int bus_for_each_drv(struct bus_type
* bus
, struct device_driver
* start
,
83 void * data
, int (*fn
)(struct device_driver
*, void *));
86 /* driverfs interface for exporting bus attributes */
88 struct bus_attribute
{
89 struct attribute attr
;
90 ssize_t (*show
)(struct bus_type
*, char * buf
);
91 ssize_t (*store
)(struct bus_type
*, const char * buf
, size_t count
);
94 #define BUS_ATTR(_name,_mode,_show,_store) \
95 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
97 extern int bus_create_file(struct bus_type
*, struct bus_attribute
*);
98 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
100 struct device_driver
{
102 struct bus_type
* bus
;
104 struct completion unloaded
;
106 struct list_head devices
;
108 struct module
* owner
;
110 int (*probe
) (struct device
* dev
);
111 int (*remove
) (struct device
* dev
);
112 void (*shutdown
) (struct device
* dev
);
113 int (*suspend
) (struct device
* dev
, pm_message_t state
, u32 level
);
114 int (*resume
) (struct device
* dev
, u32 level
);
118 extern int driver_register(struct device_driver
* drv
);
119 extern void driver_unregister(struct device_driver
* drv
);
121 extern struct device_driver
* get_driver(struct device_driver
* drv
);
122 extern void put_driver(struct device_driver
* drv
);
123 extern struct device_driver
*driver_find(const char *name
, struct bus_type
*bus
);
126 /* driverfs interface for exporting driver attributes */
128 struct driver_attribute
{
129 struct attribute attr
;
130 ssize_t (*show
)(struct device_driver
*, char * buf
);
131 ssize_t (*store
)(struct device_driver
*, const char * buf
, size_t count
);
134 #define DRIVER_ATTR(_name,_mode,_show,_store) \
135 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
137 extern int driver_create_file(struct device_driver
*, struct driver_attribute
*);
138 extern void driver_remove_file(struct device_driver
*, struct driver_attribute
*);
147 struct subsystem subsys
;
148 struct list_head children
;
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
;
155 int (*hotplug
)(struct class_device
*dev
, char **envp
,
156 int num_envp
, char *buffer
, int buffer_size
);
158 void (*release
)(struct class_device
*dev
);
159 void (*class_release
)(struct class *class);
162 extern int class_register(struct class *);
163 extern void class_unregister(struct class *);
165 extern struct class * class_get(struct class *);
166 extern void class_put(struct class *);
169 struct class_attribute
{
170 struct attribute attr
;
171 ssize_t (*show
)(struct class *, char * buf
);
172 ssize_t (*store
)(struct class *, const char * buf
, size_t count
);
175 #define CLASS_ATTR(_name,_mode,_show,_store) \
176 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
178 extern int class_create_file(struct class *, const struct class_attribute
*);
179 extern void class_remove_file(struct class *, const struct class_attribute
*);
182 struct class_device
{
183 struct list_head node
;
186 struct class * class; /* required */
187 dev_t devt
; /* dev_t, creates the sysfs "dev" */
188 struct device
* dev
; /* not necessary, but nice to have */
189 void * class_data
; /* class-specific data */
191 char class_id
[BUS_ID_SIZE
]; /* unique to this class */
195 class_get_devdata (struct class_device
*dev
)
197 return dev
->class_data
;
201 class_set_devdata (struct class_device
*dev
, void *data
)
203 dev
->class_data
= data
;
207 extern int class_device_register(struct class_device
*);
208 extern void class_device_unregister(struct class_device
*);
209 extern void class_device_initialize(struct class_device
*);
210 extern int class_device_add(struct class_device
*);
211 extern void class_device_del(struct class_device
*);
213 extern int class_device_rename(struct class_device
*, char *);
215 extern struct class_device
* class_device_get(struct class_device
*);
216 extern void class_device_put(struct class_device
*);
218 struct class_device_attribute
{
219 struct attribute attr
;
220 ssize_t (*show
)(struct class_device
*, char * buf
);
221 ssize_t (*store
)(struct class_device
*, const char * buf
, size_t count
);
224 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
225 struct class_device_attribute class_device_attr_##_name = \
226 __ATTR(_name,_mode,_show,_store)
228 extern int class_device_create_file(struct class_device
*,
229 const struct class_device_attribute
*);
230 extern void class_device_remove_file(struct class_device
*,
231 const struct class_device_attribute
*);
232 extern int class_device_create_bin_file(struct class_device
*,
233 struct bin_attribute
*);
234 extern void class_device_remove_bin_file(struct class_device
*,
235 struct bin_attribute
*);
237 struct class_interface
{
238 struct list_head node
;
241 int (*add
) (struct class_device
*);
242 void (*remove
) (struct class_device
*);
245 extern int class_interface_register(struct class_interface
*);
246 extern void class_interface_unregister(struct class_interface
*);
248 /* interface for class simple stuff */
249 extern struct class_simple
*class_simple_create(struct module
*owner
, char *name
);
250 extern void class_simple_destroy(struct class_simple
*cs
);
251 extern struct class_device
*class_simple_device_add(struct class_simple
*cs
, dev_t dev
, struct device
*device
, const char *fmt
, ...)
252 __attribute__((format(printf
,4,5)));
253 extern int class_simple_set_hotplug(struct class_simple
*,
254 int (*hotplug
)(struct class_device
*dev
, char **envp
, int num_envp
, char *buffer
, int buffer_size
));
255 extern void class_simple_device_remove(dev_t dev
);
259 struct list_head node
; /* node in sibling list */
260 struct list_head bus_list
; /* node in bus's list */
261 struct list_head driver_list
;
262 struct list_head children
;
263 struct device
* parent
;
266 char bus_id
[BUS_ID_SIZE
]; /* position on parent bus */
268 struct bus_type
* bus
; /* type of bus device is on */
269 struct device_driver
*driver
; /* which driver has allocated this
271 void *driver_data
; /* data private to the driver */
272 void *platform_data
; /* Platform specific data, device
273 core doesn't touch it */
274 void *firmware_data
; /* Firmware specific data (e.g. ACPI,
275 BIOS data),reserved for device core*/
276 struct dev_pm_info power
;
278 u64
*dma_mask
; /* dma mask (if dma'able device) */
279 u64 coherent_dma_mask
;/* Like dma_mask, but for
280 alloc_coherent mappings as
281 not all hardware supports
282 64 bit addresses for consistent
283 allocations such descriptors. */
285 struct list_head dma_pools
; /* dma pools (if dma'ble) */
287 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
290 void (*release
)(struct device
* dev
);
293 static inline struct device
*
294 list_to_dev(struct list_head
*node
)
296 return list_entry(node
, struct device
, node
);
300 dev_get_drvdata (struct device
*dev
)
302 return dev
->driver_data
;
306 dev_set_drvdata (struct device
*dev
, void *data
)
308 dev
->driver_data
= data
;
312 * High level routines for use by the bus drivers
314 extern int device_register(struct device
* dev
);
315 extern void device_unregister(struct device
* dev
);
316 extern void device_initialize(struct device
* dev
);
317 extern int device_add(struct device
* dev
);
318 extern void device_del(struct device
* dev
);
319 extern int device_for_each_child(struct device
*, void *,
320 int (*fn
)(struct device
*, void *));
323 * Manual binding of a device to driver. See drivers/base/bus.c
324 * for information on use.
326 extern int driver_probe_device(struct device_driver
* drv
, struct device
* dev
);
327 extern void device_bind_driver(struct device
* dev
);
328 extern void device_release_driver(struct device
* dev
);
329 extern int device_attach(struct device
* dev
);
330 extern void driver_attach(struct device_driver
* drv
);
333 /* driverfs interface for exporting device attributes */
335 struct device_attribute
{
336 struct attribute attr
;
337 ssize_t (*show
)(struct device
* dev
, char * buf
);
338 ssize_t (*store
)(struct device
* dev
, const char * buf
, size_t count
);
341 #define DEVICE_ATTR(_name,_mode,_show,_store) \
342 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
345 extern int device_create_file(struct device
*device
, struct device_attribute
* entry
);
346 extern void device_remove_file(struct device
* dev
, struct device_attribute
* attr
);
349 * Platform "fixup" functions - allow the platform to have their say
350 * about devices and actions that the general device layer doesn't
353 /* Notify platform of device discovery */
354 extern int (*platform_notify
)(struct device
* dev
);
356 extern int (*platform_notify_remove
)(struct device
* dev
);
360 * get_device - atomically increment the reference count for the device.
363 extern struct device
* get_device(struct device
* dev
);
364 extern void put_device(struct device
* dev
);
365 extern struct device
*device_find(const char *name
, struct bus_type
*bus
);
368 /* drivers/base/platform.c */
370 struct platform_device
{
375 struct resource
* resource
;
378 #define to_platform_device(x) container_of((x), struct platform_device, dev)
380 extern int platform_device_register(struct platform_device
*);
381 extern void platform_device_unregister(struct platform_device
*);
383 extern struct bus_type platform_bus_type
;
384 extern struct device platform_bus
;
386 extern struct resource
*platform_get_resource(struct platform_device
*, unsigned int, unsigned int);
387 extern int platform_get_irq(struct platform_device
*, unsigned int);
388 extern struct resource
*platform_get_resource_byname(struct platform_device
*, unsigned int, char *);
389 extern int platform_get_irq_byname(struct platform_device
*, char *);
390 extern int platform_add_devices(struct platform_device
**, int);
392 extern struct platform_device
*platform_device_register_simple(char *, unsigned int, struct resource
*, unsigned int);
394 /* drivers/base/power.c */
395 extern void device_shutdown(void);
398 /* drivers/base/firmware.c */
399 extern int firmware_register(struct subsystem
*);
400 extern void firmware_unregister(struct subsystem
*);
402 /* debugging and troubleshooting/diagnostic helpers. */
403 #define dev_printk(level, dev, format, arg...) \
404 printk(level "%s %s: " format , (dev)->driver ? (dev)->driver->name : "" , (dev)->bus_id , ## arg)
407 #define dev_dbg(dev, format, arg...) \
408 dev_printk(KERN_DEBUG , dev , format , ## arg)
410 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
413 #define dev_err(dev, format, arg...) \
414 dev_printk(KERN_ERR , dev , format , ## arg)
415 #define dev_info(dev, format, arg...) \
416 dev_printk(KERN_INFO , dev , format , ## arg)
417 #define dev_warn(dev, format, arg...) \
418 dev_printk(KERN_WARNING , dev , format , ## arg)
420 /* Create alias, so I can be autoloaded. */
421 #define MODULE_ALIAS_CHARDEV(major,minor) \
422 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
423 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
424 MODULE_ALIAS("char-major-" __stringify(major) "-*")
425 #endif /* _DEVICE_H_ */