blob: e0fae0e76fa99ac53325bdac014152862cb347f5 [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 Torvalds7c8265f2006-06-24 14:50:29 -070054
Linus Torvalds7c8265f2006-06-24 14:50:29 -070055 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059};
60
61extern int bus_register(struct bus_type * bus);
62extern void bus_unregister(struct bus_type * bus);
63
Greg Kroah-Hartman23d3d602005-06-22 16:09:05 -070064extern void bus_rescan_devices(struct bus_type * bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/* iterator helpers for buses */
67
68int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
69 int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +020070struct device * bus_find_device(struct bus_type *bus, struct device *start,
71 void *data, int (*match)(struct device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
74 void * data, int (*fn)(struct device_driver *, void *));
75
76
77/* driverfs interface for exporting bus attributes */
78
79struct 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);
83};
84
85#define BUS_ATTR(_name,_mode,_show,_store) \
86struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
87
88extern int bus_create_file(struct bus_type *, struct bus_attribute *);
89extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
90
91struct device_driver {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -050092 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 struct bus_type * bus;
94
95 struct completion unloaded;
96 struct kobject kobj;
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -080097 struct klist klist_devices;
mochel@digitalimplant.org38fdac32005-03-21 12:00:18 -080098 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500100 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 int (*probe) (struct device * dev);
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500103 int (*remove) (struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 void (*shutdown) (struct device * dev);
Russell King9480e302005-10-28 09:52:56 -0700105 int (*suspend) (struct device * dev, pm_message_t state);
106 int (*resume) (struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107};
108
109
110extern int driver_register(struct device_driver * drv);
111extern void driver_unregister(struct device_driver * drv);
112
113extern struct device_driver * get_driver(struct device_driver * drv);
114extern void put_driver(struct device_driver * drv);
115extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
116
117
118/* driverfs interface for exporting driver attributes */
119
120struct 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);
124};
125
126#define DRIVER_ATTR(_name,_mode,_show,_store) \
127struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
128
129extern int driver_create_file(struct device_driver *, struct driver_attribute *);
130extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
131
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800132extern int driver_for_each_device(struct device_driver * drv, struct device * start,
133 void * data, int (*fn)(struct device *, void *));
Cornelia Huck0edb5862005-06-22 16:59:51 +0200134struct device * driver_find_device(struct device_driver *drv,
135 struct device *start, void *data,
136 int (*match)(struct device *, void *));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/*
140 * device classes
141 */
142struct class {
Dmitry Torokhov8d790d72005-04-26 02:34:05 -0500143 const char * name;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800144 struct module * owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146 struct subsystem subsys;
147 struct list_head children;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700148 struct list_head devices;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 struct list_head interfaces;
150 struct semaphore sem; /* locks both the children and interfaces lists */
151
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700152 struct kobject *virtual_dir;
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 struct class_attribute * class_attrs;
155 struct class_device_attribute * class_dev_attrs;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700156 struct device_attribute * dev_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Kay Sievers312c0042005-11-16 09:00:00 +0100158 int (*uevent)(struct class_device *dev, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 int num_envp, char *buffer, int buffer_size);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700160 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
161 char *buffer, int buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 void (*release)(struct class_device *dev);
164 void (*class_release)(struct class *class);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700165 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700166
167 int (*suspend)(struct device *, pm_message_t state);
168 int (*resume)(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169};
170
171extern int class_register(struct class *);
172extern void class_unregister(struct class *);
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175struct 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);
179};
180
181#define CLASS_ATTR(_name,_mode,_show,_store) \
182struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
183
184extern int class_create_file(struct class *, const struct class_attribute *);
185extern void class_remove_file(struct class *, const struct class_attribute *);
186
Kay Sieversa7fd6702005-10-01 14:49:43 +0200187struct 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);
191};
192
193#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
194struct class_device_attribute class_device_attr_##_name = \
195 __ATTR(_name,_mode,_show,_store)
196
197extern int class_device_create_file(struct class_device *,
198 const struct class_device_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700200/**
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.
Stephen Hemminger14982212006-05-06 17:55:11 -0700207 * @groups: optional additional groups to be created
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700208 * @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
212 * set this pointer.
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.
Kay Sievers312c0042005-11-16 09:00:00 +0100220 * @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
Greg Kroah-Hartman74be2272005-10-27 22:25:43 -0700223 * when you are nesting class_device structures.
224 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225struct class_device {
226 struct list_head node;
227
228 struct kobject kobj;
229 struct class * class; /* required */
230 dev_t devt; /* dev_t, creates the sysfs "dev" */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800231 struct class_device_attribute *devt_attr;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200232 struct class_device_attribute uevent_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct device * dev; /* not necessary, but nice to have */
234 void * class_data; /* class-specific data */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700235 struct class_device *parent; /* parent of this child device, if there is one */
Stephen Hemminger14982212006-05-06 17:55:11 -0700236 struct attribute_group ** groups; /* optional groups */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700238 void (*release)(struct class_device *dev);
Kay Sievers312c0042005-11-16 09:00:00 +0100239 int (*uevent)(struct class_device *dev, char **envp,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700240 int num_envp, char *buffer, int buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 char class_id[BUS_ID_SIZE]; /* unique to this class */
242};
243
244static inline void *
245class_get_devdata (struct class_device *dev)
246{
247 return dev->class_data;
248}
249
250static inline void
251class_set_devdata (struct class_device *dev, void *data)
252{
253 dev->class_data = data;
254}
255
256
257extern int class_device_register(struct class_device *);
258extern void class_device_unregister(struct class_device *);
259extern void class_device_initialize(struct class_device *);
260extern int class_device_add(struct class_device *);
261extern void class_device_del(struct class_device *);
262
263extern int class_device_rename(struct class_device *, char *);
264
265extern struct class_device * class_device_get(struct class_device *);
266extern void class_device_put(struct class_device *);
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268extern void class_device_remove_file(struct class_device *,
269 const struct class_device_attribute *);
270extern int class_device_create_bin_file(struct class_device *,
271 struct bin_attribute *);
272extern void class_device_remove_bin_file(struct class_device *,
273 struct bin_attribute *);
274
275struct class_interface {
276 struct list_head node;
277 struct class *class;
278
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500279 int (*add) (struct class_device *, struct class_interface *);
280 void (*remove) (struct class_device *, struct class_interface *);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200281 int (*add_dev) (struct device *, struct class_interface *);
282 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283};
284
285extern int class_interface_register(struct class_interface *);
286extern void class_interface_unregister(struct class_interface *);
287
Miguel Ojeda Sandonisab7d7372006-09-13 15:34:05 +0200288extern struct class *class_create(struct module *owner, const char *name);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800289extern void class_destroy(struct class *cls);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700290extern struct class_device *class_device_create(struct class *cls,
291 struct class_device *parent,
292 dev_t devt,
293 struct device *device,
Dmitry Torokhovddd5d352006-08-10 01:18:18 -0400294 const char *fmt, ...)
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700295 __attribute__((format(printf,5,6)));
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800296extern void class_device_destroy(struct class *cls, dev_t devt);
297
Kay Sieversa7fd6702005-10-01 14:49:43 +0200298/* interface for exporting device attributes */
299struct device_attribute {
300 struct attribute attr;
301 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
302 char *buf);
303 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
304 const char *buf, size_t count);
305};
306
307#define DEVICE_ATTR(_name,_mode,_show,_store) \
308struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
309
310extern int device_create_file(struct device *device, struct device_attribute * entry);
311extern void device_remove_file(struct device * dev, struct device_attribute * attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312struct device {
mochel@digitalimplant.org36239572005-03-24 19:08:30 -0800313 struct klist klist_children;
314 struct klist_node knode_parent; /* node in sibling list */
mochel@digitalimplant.org94e7b1c52005-03-21 12:25:36 -0800315 struct klist_node knode_driver;
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -0800316 struct klist_node knode_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 struct device * parent;
318
319 struct kobject kobj;
320 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
Kay Sieversa7fd6702005-10-01 14:49:43 +0200321 struct device_attribute uevent_attr;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700322 struct device_attribute *devt_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800324 struct semaphore sem; /* semaphore to synchronize calls to
325 * its driver.
326 */
327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 struct bus_type * bus; /* type of bus device is on */
329 struct device_driver *driver; /* which driver has allocated this
330 device */
331 void *driver_data; /* data private to the driver */
David Shaohua Li4e10d122005-03-18 18:45:35 -0500332 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*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 struct dev_pm_info power;
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 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. */
344
345 struct list_head dma_pools; /* dma pools (if dma'ble) */
346
347 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
348 override */
349
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700350 /* class_device migration path */
351 struct list_head node;
352 struct class *class; /* optional*/
353 dev_t devt; /* dev_t, creates the sysfs "dev" */
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -0700354 struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 void (*release)(struct device * dev);
357};
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359static inline void *
360dev_get_drvdata (struct device *dev)
361{
362 return dev->driver_data;
363}
364
365static inline void
366dev_set_drvdata (struct device *dev, void *data)
367{
368 dev->driver_data = data;
369}
370
Daniel Ritzd305ef52005-09-22 00:47:24 -0700371static inline int device_is_registered(struct device *dev)
372{
373 return klist_node_attached(&dev->knode_bus);
374}
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376/*
377 * High level routines for use by the bus drivers
378 */
379extern int device_register(struct device * dev);
380extern void device_unregister(struct device * dev);
381extern void device_initialize(struct device * dev);
382extern int device_add(struct device * dev);
383extern void device_del(struct device * dev);
384extern int device_for_each_child(struct device *, void *,
385 int (*fn)(struct device *, void *));
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -0700386extern int device_rename(struct device *dev, char *new_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388/*
389 * Manual binding of a device to driver. See drivers/base/bus.c
390 * for information on use.
391 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392extern void device_bind_driver(struct device * dev);
393extern void device_release_driver(struct device * dev);
394extern int device_attach(struct device * dev);
395extern void driver_attach(struct device_driver * drv);
Moore, Erice935d5d2006-03-14 09:18:18 -0700396extern void device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700398/*
399 * Easy functions for dynamically creating devices on the fly
400 */
401extern struct device *device_create(struct class *cls, struct device *parent,
Greg Kroah-Hartman5cbe5f82006-08-10 01:19:19 -0400402 dev_t devt, const char *fmt, ...)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700403 __attribute__((format(printf,4,5)));
404extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -0700406extern int virtual_device_parent(struct device *dev);
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/*
409 * Platform "fixup" functions - allow the platform to have their say
410 * about devices and actions that the general device layer doesn't
411 * know about.
412 */
413/* Notify platform of device discovery */
414extern int (*platform_notify)(struct device * dev);
415
416extern int (*platform_notify_remove)(struct device * dev);
417
418
419/**
420 * get_device - atomically increment the reference count for the device.
421 *
422 */
423extern struct device * get_device(struct device * dev);
424extern void put_device(struct device * dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426
Rytchkov Alexey116f232b2006-03-22 00:58:53 +0100427/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428extern void device_shutdown(void);
429
430
431/* drivers/base/firmware.c */
432extern int firmware_register(struct subsystem *);
433extern void firmware_unregister(struct subsystem *);
434
435/* debugging and troubleshooting/diagnostic helpers. */
Alan Stern3e956372006-06-16 17:10:48 -0400436extern const char *dev_driver_string(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437#define dev_printk(level, dev, format, arg...) \
Alan Stern3e956372006-06-16 17:10:48 -0400438 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440#ifdef DEBUG
441#define dev_dbg(dev, format, arg...) \
442 dev_printk(KERN_DEBUG , dev , format , ## arg)
443#else
444#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
445#endif
446
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)
Tilman Schmidt4f2928d2006-02-24 11:05:45 +0100453#define dev_notice(dev, format, arg...) \
454 dev_printk(KERN_NOTICE , dev , format , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
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_ */