blob: 1e5f30da98bc528b9ab9aaf629a673cb50e6f8ae [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 *
6 * This file is released under the GPLv2
7 *
8 * See Documentation/driver-model/ for more information.
9 */
10
11#ifndef _DEVICE_H_
12#define _DEVICE_H_
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/ioport.h>
15#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080016#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/list.h>
18#include <linux/types.h>
19#include <linux/module.h>
20#include <linux/pm.h>
21#include <asm/semaphore.h>
22#include <asm/atomic.h>
23
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
28
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030struct device;
31struct device_driver;
32struct class;
33struct class_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35struct bus_type {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -050036 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38 struct subsystem subsys;
39 struct kset drivers;
40 struct kset devices;
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080041 struct klist klist_devices;
mochel@digitalimplant.org38fdac32005-03-21 12:00:18 -080042 struct klist klist_drivers;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44 struct bus_attribute * bus_attrs;
45 struct device_attribute * dev_attrs;
46 struct driver_attribute * drv_attrs;
47
48 int (*match)(struct device * dev, struct device_driver * drv);
Kay Sievers312c0042005-11-16 09:00:00 +010049 int (*uevent)(struct device *dev, char **envp,
50 int num_envp, char *buffer, int buffer_size);
Russell King594c8282006-01-05 14:29:51 +000051 int (*probe)(struct device * dev);
52 int (*remove)(struct device * dev);
53 void (*shutdown)(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 int (*suspend)(struct device * dev, pm_message_t state);
55 int (*resume)(struct device * dev);
56};
57
58extern int bus_register(struct bus_type * bus);
59extern void bus_unregister(struct bus_type * bus);
60
Greg Kroah-Hartman23d3d602005-06-22 16:09:05 -070061extern void bus_rescan_devices(struct bus_type * bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/* iterator helpers for buses */
64
65int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
66 int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +020067struct device * bus_find_device(struct bus_type *bus, struct device *start,
68 void *data, int (*match)(struct device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
71 void * data, int (*fn)(struct device_driver *, void *));
72
73
74/* driverfs interface for exporting bus attributes */
75
76struct bus_attribute {
77 struct attribute attr;
78 ssize_t (*show)(struct bus_type *, char * buf);
79 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
80};
81
82#define BUS_ATTR(_name,_mode,_show,_store) \
83struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
84
85extern int bus_create_file(struct bus_type *, struct bus_attribute *);
86extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
87
88struct device_driver {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -050089 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 struct bus_type * bus;
91
92 struct completion unloaded;
93 struct kobject kobj;
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -080094 struct klist klist_devices;
mochel@digitalimplant.org38fdac32005-03-21 12:00:18 -080095 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Dmitry Torokhov8d790d72005-04-26 02:34:05 -050097 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99 int (*probe) (struct device * dev);
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500100 int (*remove) (struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 void (*shutdown) (struct device * dev);
Russell King9480e302005-10-28 09:52:56 -0700102 int (*suspend) (struct device * dev, pm_message_t state);
103 int (*resume) (struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104};
105
106
107extern int driver_register(struct device_driver * drv);
108extern void driver_unregister(struct device_driver * drv);
109
110extern struct device_driver * get_driver(struct device_driver * drv);
111extern void put_driver(struct device_driver * drv);
112extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
113
114
115/* driverfs interface for exporting driver attributes */
116
117struct driver_attribute {
118 struct attribute attr;
119 ssize_t (*show)(struct device_driver *, char * buf);
120 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
121};
122
123#define DRIVER_ATTR(_name,_mode,_show,_store) \
124struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
125
126extern int driver_create_file(struct device_driver *, struct driver_attribute *);
127extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
128
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800129extern int driver_for_each_device(struct device_driver * drv, struct device * start,
130 void * data, int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +0200131struct device * driver_find_device(struct device_driver *drv,
132 struct device *start, void *data,
133 int (*match)(struct device *, void *));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/*
137 * device classes
138 */
139struct class {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500140 const char * name;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800141 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143 struct subsystem subsys;
144 struct list_head children;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700145 struct list_head devices;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 struct list_head interfaces;
147 struct semaphore sem; /* locks both the children and interfaces lists */
148
149 struct class_attribute * class_attrs;
150 struct class_device_attribute * class_dev_attrs;
151
Kay Sievers312c0042005-11-16 09:00:00 +0100152 int (*uevent)(struct class_device *dev, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 int num_envp, char *buffer, int buffer_size);
154
155 void (*release)(struct class_device *dev);
156 void (*class_release)(struct class *class);
157};
158
159extern int class_register(struct class *);
160extern void class_unregister(struct class *);
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163struct class_attribute {
164 struct attribute attr;
165 ssize_t (*show)(struct class *, char * buf);
166 ssize_t (*store)(struct class *, const char * buf, size_t count);
167};
168
169#define CLASS_ATTR(_name,_mode,_show,_store) \
170struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
171
172extern int class_create_file(struct class *, const struct class_attribute *);
173extern void class_remove_file(struct class *, const struct class_attribute *);
174
Kay Sieversa7fd6702005-10-01 14:49:43 +0200175struct class_device_attribute {
176 struct attribute attr;
177 ssize_t (*show)(struct class_device *, char * buf);
178 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
179};
180
181#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
182struct class_device_attribute class_device_attr_##_name = \
183 __ATTR(_name,_mode,_show,_store)
184
185extern int class_device_create_file(struct class_device *,
186 const struct class_device_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700188/**
189 * struct class_device - class devices
190 * @class: pointer to the parent class for this class device. This is required.
191 * @devt: for internal use by the driver core only.
192 * @node: for internal use by the driver core only.
193 * @kobj: for internal use by the driver core only.
194 * @devt_attr: for internal use by the driver core only.
Stephen Hemminger14982212006-05-06 17:55:11 -0700195 * @groups: optional additional groups to be created
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700196 * @dev: if set, a symlink to the struct device is created in the sysfs
197 * directory for this struct class device.
198 * @class_data: pointer to whatever you want to store here for this struct
199 * class_device. Use class_get_devdata() and class_set_devdata() to get and
200 * set this pointer.
201 * @parent: pointer to a struct class_device that is the parent of this struct
202 * class_device. If NULL, this class_device will show up at the root of the
203 * struct class in sysfs (which is probably what you want to have happen.)
204 * @release: pointer to a release function for this struct class_device. If
205 * set, this will be called instead of the class specific release function.
206 * Only use this if you want to override the default release function, like
207 * when you are nesting class_device structures.
Kay Sievers312c0042005-11-16 09:00:00 +0100208 * @uevent: pointer to a uevent function for this struct class_device. If
209 * set, this will be called instead of the class specific uevent function.
210 * Only use this if you want to override the default uevent function, like
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700211 * when you are nesting class_device structures.
212 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213struct class_device {
214 struct list_head node;
215
216 struct kobject kobj;
217 struct class * class; /* required */
218 dev_t devt; /* dev_t, creates the sysfs "dev" */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800219 struct class_device_attribute *devt_attr;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200220 struct class_device_attribute uevent_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 struct device * dev; /* not necessary, but nice to have */
222 void * class_data; /* class-specific data */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700223 struct class_device *parent; /* parent of this child device, if there is one */
Stephen Hemminger14982212006-05-06 17:55:11 -0700224 struct attribute_group ** groups; /* optional groups */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700226 void (*release)(struct class_device *dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100227 int (*uevent)(struct class_device *dev, char **envp,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700228 int num_envp, char *buffer, int buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 char class_id[BUS_ID_SIZE]; /* unique to this class */
230};
231
232static inline void *
233class_get_devdata (struct class_device *dev)
234{
235 return dev->class_data;
236}
237
238static inline void
239class_set_devdata (struct class_device *dev, void *data)
240{
241 dev->class_data = data;
242}
243
244
245extern int class_device_register(struct class_device *);
246extern void class_device_unregister(struct class_device *);
247extern void class_device_initialize(struct class_device *);
248extern int class_device_add(struct class_device *);
249extern void class_device_del(struct class_device *);
250
251extern int class_device_rename(struct class_device *, char *);
252
253extern struct class_device * class_device_get(struct class_device *);
254extern void class_device_put(struct class_device *);
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256extern void class_device_remove_file(struct class_device *,
257 const struct class_device_attribute *);
258extern int class_device_create_bin_file(struct class_device *,
259 struct bin_attribute *);
260extern void class_device_remove_bin_file(struct class_device *,
261 struct bin_attribute *);
262
263struct class_interface {
264 struct list_head node;
265 struct class *class;
266
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500267 int (*add) (struct class_device *, struct class_interface *);
268 void (*remove) (struct class_device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269};
270
271extern int class_interface_register(struct class_interface *);
272extern void class_interface_unregister(struct class_interface *);
273
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800274extern struct class *class_create(struct module *owner, char *name);
275extern void class_destroy(struct class *cls);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700276extern struct class_device *class_device_create(struct class *cls,
277 struct class_device *parent,
278 dev_t devt,
279 struct device *device,
280 char *fmt, ...)
281 __attribute__((format(printf,5,6)));
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800282extern void class_device_destroy(struct class *cls, dev_t devt);
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Kay Sieversa7fd6702005-10-01 14:49:43 +0200285/* interface for exporting device attributes */
286struct device_attribute {
287 struct attribute attr;
288 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
289 char *buf);
290 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
291 const char *buf, size_t count);
292};
293
294#define DEVICE_ATTR(_name,_mode,_show,_store) \
295struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
296
297extern int device_create_file(struct device *device, struct device_attribute * entry);
298extern void device_remove_file(struct device * dev, struct device_attribute * attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299struct device {
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800300 struct klist klist_children;
301 struct klist_node knode_parent; /* node in sibling list */
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -0800302 struct klist_node knode_driver;
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -0800303 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 struct device * parent;
305
306 struct kobject kobj;
307 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
Kay Sieversa7fd6702005-10-01 14:49:43 +0200308 struct device_attribute uevent_attr;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700309 struct device_attribute *devt_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800311 struct semaphore sem; /* semaphore to synchronize calls to
312 * its driver.
313 */
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 struct bus_type * bus; /* type of bus device is on */
316 struct device_driver *driver; /* which driver has allocated this
317 device */
318 void *driver_data; /* data private to the driver */
David Shaohua Li4e10d122005-03-18 18:45:35 -0500319 void *platform_data; /* Platform specific data, device
320 core doesn't touch it */
321 void *firmware_data; /* Firmware specific data (e.g. ACPI,
322 BIOS data),reserved for device core*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 struct dev_pm_info power;
324
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 u64 *dma_mask; /* dma mask (if dma'able device) */
326 u64 coherent_dma_mask;/* Like dma_mask, but for
327 alloc_coherent mappings as
328 not all hardware supports
329 64 bit addresses for consistent
330 allocations such descriptors. */
331
332 struct list_head dma_pools; /* dma pools (if dma'ble) */
333
334 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
335 override */
336
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700337 /* class_device migration path */
338 struct list_head node;
339 struct class *class; /* optional*/
340 dev_t devt; /* dev_t, creates the sysfs "dev" */
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 void (*release)(struct device * dev);
343};
344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345static inline void *
346dev_get_drvdata (struct device *dev)
347{
348 return dev->driver_data;
349}
350
351static inline void
352dev_set_drvdata (struct device *dev, void *data)
353{
354 dev->driver_data = data;
355}
356
Daniel Ritzd305ef52005-09-22 00:47:24 -0700357static inline int device_is_registered(struct device *dev)
358{
359 return klist_node_attached(&dev->knode_bus);
360}
361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362/*
363 * High level routines for use by the bus drivers
364 */
365extern int device_register(struct device * dev);
366extern void device_unregister(struct device * dev);
367extern void device_initialize(struct device * dev);
368extern int device_add(struct device * dev);
369extern void device_del(struct device * dev);
370extern int device_for_each_child(struct device *, void *,
371 int (*fn)(struct device *, void *));
372
373/*
374 * Manual binding of a device to driver. See drivers/base/bus.c
375 * for information on use.
376 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377extern void device_bind_driver(struct device * dev);
378extern void device_release_driver(struct device * dev);
379extern int device_attach(struct device * dev);
380extern void driver_attach(struct device_driver * drv);
Moore, Erice935d5d2006-03-14 09:18:18 -0700381extern void device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700383/*
384 * Easy functions for dynamically creating devices on the fly
385 */
386extern struct device *device_create(struct class *cls, struct device *parent,
387 dev_t devt, char *fmt, ...)
388 __attribute__((format(printf,4,5)));
389extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391/*
392 * Platform "fixup" functions - allow the platform to have their say
393 * about devices and actions that the general device layer doesn't
394 * know about.
395 */
396/* Notify platform of device discovery */
397extern int (*platform_notify)(struct device * dev);
398
399extern int (*platform_notify_remove)(struct device * dev);
400
401
402/**
403 * get_device - atomically increment the reference count for the device.
404 *
405 */
406extern struct device * get_device(struct device * dev);
407extern void put_device(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
409
Rytchkov Alexey116f232b2006-03-22 00:58:53 +0100410/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411extern void device_shutdown(void);
412
413
414/* drivers/base/firmware.c */
415extern int firmware_register(struct subsystem *);
416extern void firmware_unregister(struct subsystem *);
417
418/* debugging and troubleshooting/diagnostic helpers. */
Alan Stern3e956372006-06-16 17:10:48 -0400419extern const char *dev_driver_string(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#define dev_printk(level, dev, format, arg...) \
Alan Stern3e956372006-06-16 17:10:48 -0400421 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423#ifdef DEBUG
424#define dev_dbg(dev, format, arg...) \
425 dev_printk(KERN_DEBUG , dev , format , ## arg)
426#else
427#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
428#endif
429
430#define dev_err(dev, format, arg...) \
431 dev_printk(KERN_ERR , dev , format , ## arg)
432#define dev_info(dev, format, arg...) \
433 dev_printk(KERN_INFO , dev , format , ## arg)
434#define dev_warn(dev, format, arg...) \
435 dev_printk(KERN_WARNING , dev , format , ## arg)
Tilman Schmidt4f2928d2006-02-24 11:05:45 +0100436#define dev_notice(dev, format, arg...) \
437 dev_printk(KERN_NOTICE , dev , format , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439/* Create alias, so I can be autoloaded. */
440#define MODULE_ALIAS_CHARDEV(major,minor) \
441 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
442#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
443 MODULE_ALIAS("char-major-" __stringify(major) "-*")
444#endif /* _DEVICE_H_ */