Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
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
14#include <linux/ioport.h>
15#include <linux/kobject.h>
16#include <linux/klist.h>
17#include <linux/list.h>
18#include <linux/compiler.h>
19#include <linux/types.h>
20#include <linux/module.h>
21#include <linux/pm.h>
22#include <asm/semaphore.h>
23#include <asm/atomic.h>
24
25#define DEVICE_NAME_SIZE 50
26#define DEVICE_NAME_HALF __stringify(20) /* Less than half to accommodate slop */
27#define DEVICE_ID_SIZE 32
28#define BUS_ID_SIZE KOBJ_NAME_LEN
29
30
31struct device;
32struct device_driver;
33struct class;
34struct class_device;
35
36struct bus_type {
37 const char * name;
38
39 struct subsystem subsys;
40 struct kset drivers;
41 struct kset devices;
42 struct klist klist_devices;
43 struct klist klist_drivers;
44
45 struct bus_attribute * bus_attrs;
46 struct device_attribute * dev_attrs;
47 struct driver_attribute * drv_attrs;
48
49 int (*match)(struct device * dev, struct device_driver * drv);
50 int (*uevent)(struct device *dev, char **envp,
51 int num_envp, char *buffer, int buffer_size);
52 int (*probe)(struct device * dev);
53 int (*remove)(struct device * dev);
54 void (*shutdown)(struct device * dev);
55
56 int (*suspend)(struct device * dev, pm_message_t state);
57 int (*suspend_late)(struct device * dev, pm_message_t state);
58 int (*resume_early)(struct device * dev);
59 int (*resume)(struct device * dev);
60};
61
62extern int __must_check bus_register(struct bus_type * bus);
63extern void bus_unregister(struct bus_type * bus);
64
65extern int __must_check bus_rescan_devices(struct bus_type * bus);
66
67/* iterator helpers for buses */
68
69int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
70 int (*fn)(struct device *, void *));
71struct device * bus_find_device(struct bus_type *bus, struct device *start,
72 void *data, int (*match)(struct device *, void *));
73
74int __must_check bus_for_each_drv(struct bus_type *bus,
75 struct device_driver *start, void *data,
76 int (*fn)(struct device_driver *, void *));
77
78/* driverfs interface for exporting bus attributes */
79
80struct bus_attribute {
81 struct attribute attr;
82 ssize_t (*show)(struct bus_type *, char * buf);
83 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
84};
85
86#define BUS_ATTR(_name,_mode,_show,_store) \
87struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
88
89extern int __must_check bus_create_file(struct bus_type *,
90 struct bus_attribute *);
91extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
92
93struct device_driver {
94 const char * name;
95 struct bus_type * bus;
96
97 struct completion unloaded;
98 struct kobject kobj;
99 struct klist klist_devices;
100 struct klist_node knode_bus;
101
102 struct module * owner;
103
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);
109
110 unsigned int multithread_probe:1;
111};
112
113
114extern int __must_check driver_register(struct device_driver * drv);
115extern void driver_unregister(struct device_driver * drv);
116
117extern struct device_driver * get_driver(struct device_driver * drv);
118extern void put_driver(struct device_driver * drv);
119extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
120extern int driver_probe_done(void);
121
122/* driverfs interface for exporting driver attributes */
123
124struct driver_attribute {
125 struct attribute attr;
126 ssize_t (*show)(struct device_driver *, char * buf);
127 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
128};
129
130#define DRIVER_ATTR(_name,_mode,_show,_store) \
131struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
132
133extern int __must_check driver_create_file(struct device_driver *,
134 struct driver_attribute *);
135extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
136
137extern int __must_check driver_for_each_device(struct device_driver * drv,
138 struct device *start, void *data,
139 int (*fn)(struct device *, void *));
140struct device * driver_find_device(struct device_driver *drv,
141 struct device *start, void *data,
142 int (*match)(struct device *, void *));
143
144/*
145 * device classes
146 */
147struct class {
148 const char * name;
149 struct module * owner;
150
151 struct subsystem subsys;
152 struct list_head children;
153 struct list_head devices;
154 struct list_head interfaces;
155 struct semaphore sem; /* locks both the children and interfaces lists */
156
157 struct kobject *virtual_dir;
158
159 struct class_attribute * class_attrs;
160 struct class_device_attribute * class_dev_attrs;
161 struct device_attribute * dev_attrs;
162
163 int (*uevent)(struct class_device *dev, char **envp,
164 int num_envp, char *buffer, int buffer_size);
165 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
166 char *buffer, int buffer_size);
167
168 void (*release)(struct class_device *dev);
169 void (*class_release)(struct class *class);
170 void (*dev_release)(struct device *dev);
171
172 int (*suspend)(struct device *, pm_message_t state);
173 int (*resume)(struct device *);
174};
175
176extern int __must_check class_register(struct class *);
177extern void class_unregister(struct class *);
178
179
180struct class_attribute {
181 struct attribute attr;
182 ssize_t (*show)(struct class *, char * buf);
183 ssize_t (*store)(struct class *, const char * buf, size_t count);
184};
185
186#define CLASS_ATTR(_name,_mode,_show,_store) \
187struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
188
189extern int __must_check class_create_file(struct class *,
190 const struct class_attribute *);
191extern void class_remove_file(struct class *, const struct class_attribute *);
192
193struct class_device_attribute {
194 struct attribute attr;
195 ssize_t (*show)(struct class_device *, char * buf);
196 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
197};
198
199#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
200struct class_device_attribute class_device_attr_##_name = \
201 __ATTR(_name,_mode,_show,_store)
202
203extern int __must_check class_device_create_file(struct class_device *,
204 const struct class_device_attribute *);
205
206/**
207 * struct class_device - class devices
208 * @class: pointer to the parent class for this class device. This is required.
209 * @devt: for internal use by the driver core only.
210 * @node: for internal use by the driver core only.
211 * @kobj: for internal use by the driver core only.
212 * @devt_attr: for internal use by the driver core only.
213 * @groups: optional additional groups to be created
214 * @dev: if set, a symlink to the struct device is created in the sysfs
215 * directory for this struct class device.
216 * @class_data: pointer to whatever you want to store here for this struct
217 * class_device. Use class_get_devdata() and class_set_devdata() to get and
218 * set this pointer.
219 * @parent: pointer to a struct class_device that is the parent of this struct
220 * class_device. If NULL, this class_device will show up at the root of the
221 * struct class in sysfs (which is probably what you want to have happen.)
222 * @release: pointer to a release function for this struct class_device. If
223 * set, this will be called instead of the class specific release function.
224 * Only use this if you want to override the default release function, like
225 * when you are nesting class_device structures.
226 * @uevent: pointer to a uevent function for this struct class_device. If
227 * set, this will be called instead of the class specific uevent function.
228 * Only use this if you want to override the default uevent function, like
229 * when you are nesting class_device structures.
230 */
231struct class_device {
232 struct list_head node;
233
234 struct kobject kobj;
235 struct class * class; /* required */
236 dev_t devt; /* dev_t, creates the sysfs "dev" */
237 struct class_device_attribute *devt_attr;
238 struct class_device_attribute uevent_attr;
239 struct device * dev; /* not necessary, but nice to have */
240 void * class_data; /* class-specific data */
241 struct class_device *parent; /* parent of this child device, if there is one */
242 struct attribute_group ** groups; /* optional groups */
243
244 void (*release)(struct class_device *dev);
245 int (*uevent)(struct class_device *dev, char **envp,
246 int num_envp, char *buffer, int buffer_size);
247 char class_id[BUS_ID_SIZE]; /* unique to this class */
248};
249
250static inline void *
251class_get_devdata (struct class_device *dev)
252{
253 return dev->class_data;
254}
255
256static inline void
257class_set_devdata (struct class_device *dev, void *data)
258{
259 dev->class_data = data;
260}
261
262
263extern int __must_check class_device_register(struct class_device *);
264extern void class_device_unregister(struct class_device *);
265extern void class_device_initialize(struct class_device *);
266extern int __must_check class_device_add(struct class_device *);
267extern void class_device_del(struct class_device *);
268
269extern int class_device_rename(struct class_device *, char *);
270
271extern struct class_device * class_device_get(struct class_device *);
272extern void class_device_put(struct class_device *);
273
274extern void class_device_remove_file(struct class_device *,
275 const struct class_device_attribute *);
276extern int __must_check class_device_create_bin_file(struct class_device *,
277 struct bin_attribute *);
278extern void class_device_remove_bin_file(struct class_device *,
279 struct bin_attribute *);
280
281struct class_interface {
282 struct list_head node;
283 struct class *class;
284
285 int (*add) (struct class_device *, struct class_interface *);
286 void (*remove) (struct class_device *, struct class_interface *);
287 int (*add_dev) (struct device *, struct class_interface *);
288 void (*remove_dev) (struct device *, struct class_interface *);
289};
290
291extern int __must_check class_interface_register(struct class_interface *);
292extern void class_interface_unregister(struct class_interface *);
293
294extern struct class *class_create(struct module *owner, const char *name);
295extern void class_destroy(struct class *cls);
296extern struct class_device *class_device_create(struct class *cls,
297 struct class_device *parent,
298 dev_t devt,
299 struct device *device,
300 const char *fmt, ...)
301 __attribute__((format(printf,5,6)));
302extern void class_device_destroy(struct class *cls, dev_t devt);
303
304/* interface for exporting device attributes */
305struct device_attribute {
306 struct attribute attr;
307 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
308 char *buf);
309 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
310 const char *buf, size_t count);
311};
312
313#define DEVICE_ATTR(_name,_mode,_show,_store) \
314struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
315
316extern int __must_check device_create_file(struct device *device,
317 struct device_attribute * entry);
318extern void device_remove_file(struct device * dev, struct device_attribute * attr);
319extern int __must_check device_create_bin_file(struct device *dev,
320 struct bin_attribute *attr);
321extern void device_remove_bin_file(struct device *dev,
322 struct bin_attribute *attr);
323struct device {
324 struct klist klist_children;
325 struct klist_node knode_parent; /* node in sibling list */
326 struct klist_node knode_driver;
327 struct klist_node knode_bus;
328 struct device * parent;
329
330 struct kobject kobj;
331 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
332 unsigned is_registered:1;
333 struct device_attribute uevent_attr;
334 struct device_attribute *devt_attr;
335
336 struct semaphore sem; /* semaphore to synchronize calls to
337 * its driver.
338 */
339
340 struct bus_type * bus; /* type of bus device is on */
341 struct device_driver *driver; /* which driver has allocated this
342 device */
343 void *driver_data; /* data private to the driver */
344 void *platform_data; /* Platform specific data, device
345 core doesn't touch it */
346 void *firmware_data; /* Firmware specific data (e.g. ACPI,
347 BIOS data),reserved for device core*/
348 struct dev_pm_info power;
349
350 u64 *dma_mask; /* dma mask (if dma'able device) */
351 u64 coherent_dma_mask;/* Like dma_mask, but for
352 alloc_coherent mappings as
353 not all hardware supports
354 64 bit addresses for consistent
355 allocations such descriptors. */
356
357 struct list_head dma_pools; /* dma pools (if dma'ble) */
358
359 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
360 override */
361
362 /* class_device migration path */
363 struct list_head node;
364 struct class *class; /* optional*/
365 dev_t devt; /* dev_t, creates the sysfs "dev" */
366 struct attribute_group **groups; /* optional groups */
367
368 void (*release)(struct device * dev);
369};
370
371static inline void *
372dev_get_drvdata (struct device *dev)
373{
374 return dev->driver_data;
375}
376
377static inline void
378dev_set_drvdata (struct device *dev, void *data)
379{
380 dev->driver_data = data;
381}
382
383static inline int device_is_registered(struct device *dev)
384{
385 return dev->is_registered;
386}
387
388/*
389 * High level routines for use by the bus drivers
390 */
391extern int __must_check device_register(struct device * dev);
392extern void device_unregister(struct device * dev);
393extern void device_initialize(struct device * dev);
394extern int __must_check device_add(struct device * dev);
395extern void device_del(struct device * dev);
396extern int device_for_each_child(struct device *, void *,
397 int (*fn)(struct device *, void *));
398extern int device_rename(struct device *dev, char *new_name);
399
400/*
401 * Manual binding of a device to driver. See drivers/base/bus.c
402 * for information on use.
403 */
404extern int __must_check device_bind_driver(struct device *dev);
405extern void device_release_driver(struct device * dev);
406extern int __must_check device_attach(struct device * dev);
407extern int __must_check driver_attach(struct device_driver *drv);
408extern int __must_check device_reprobe(struct device *dev);
409
410/*
411 * Easy functions for dynamically creating devices on the fly
412 */
413extern struct device *device_create(struct class *cls, struct device *parent,
414 dev_t devt, const char *fmt, ...)
415 __attribute__((format(printf,4,5)));
416extern void device_destroy(struct class *cls, dev_t devt);
417
418extern int virtual_device_parent(struct device *dev);
419
420/*
421 * Platform "fixup" functions - allow the platform to have their say
422 * about devices and actions that the general device layer doesn't
423 * know about.
424 */
425/* Notify platform of device discovery */
426extern int (*platform_notify)(struct device * dev);
427
428extern int (*platform_notify_remove)(struct device * dev);
429
430
431/**
432 * get_device - atomically increment the reference count for the device.
433 *
434 */
435extern struct device * get_device(struct device * dev);
436extern void put_device(struct device * dev);
437
438
439/* drivers/base/power/shutdown.c */
440extern void device_shutdown(void);
441
442
443/* drivers/base/firmware.c */
444extern int __must_check firmware_register(struct subsystem *);
445extern void firmware_unregister(struct subsystem *);
446
447/* debugging and troubleshooting/diagnostic helpers. */
448extern const char *dev_driver_string(struct device *dev);
449#define dev_printk(level, dev, format, arg...) \
450 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
451
452#ifdef DEBUG
453#define dev_dbg(dev, format, arg...) \
454 dev_printk(KERN_DEBUG , dev , format , ## arg)
455#else
456#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
457#endif
458
459#define dev_err(dev, format, arg...) \
460 dev_printk(KERN_ERR , dev , format , ## arg)
461#define dev_info(dev, format, arg...) \
462 dev_printk(KERN_INFO , dev , format , ## arg)
463#define dev_warn(dev, format, arg...) \
464 dev_printk(KERN_WARNING , dev , format , ## arg)
465#define dev_notice(dev, format, arg...) \
466 dev_printk(KERN_NOTICE , dev , format , ## arg)
467
468/* Create alias, so I can be autoloaded. */
469#define MODULE_ALIAS_CHARDEV(major,minor) \
470 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
471#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
472 MODULE_ALIAS("char-major-" __stringify(major) "-*")
473#endif /* _DEVICE_H_ */