[deliverable/linux.git] / include / linux / device.h

/*
 * device.h - generic, centralized driver model
 *
 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
 *
 * This file is released under the GPLv2
 *
 * See Documentation/driver-model/ for more information.
 */

#ifndef _DEVICE_H_
#define _DEVICE_H_

#include <linux/ioport.h>
#include <linux/kobject.h>
#include <linux/klist.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/module.h>
#include <linux/pm.h>
#include <asm/semaphore.h>
#include <asm/atomic.h>

#define DEVICE_NAME_SIZE	50
#define DEVICE_NAME_HALF	__stringify(20)	/* Less than half to accommodate slop */
#define DEVICE_ID_SIZE		32
#define BUS_ID_SIZE		KOBJ_NAME_LEN


struct device;
struct device_driver;
struct class;
struct class_device;

struct bus_type {
	const char		* name;

	struct subsystem	subsys;
	struct kset		drivers;
	struct kset		devices;
	struct klist		klist_devices;
	struct klist		klist_drivers;

	struct bus_attribute	* bus_attrs;
	struct device_attribute	* dev_attrs;
	struct driver_attribute	* drv_attrs;

	int		(*match)(struct device * dev, struct device_driver * drv);
	int		(*uevent)(struct device *dev, char **envp,
				  int num_envp, char *buffer, int buffer_size);
	int		(*probe)(struct device * dev);
	int		(*remove)(struct device * dev);
	void		(*shutdown)(struct device * dev);

	int (*suspend)(struct device * dev, pm_message_t state);
	int (*suspend_late)(struct device * dev, pm_message_t state);
	int (*resume_early)(struct device * dev);
	int (*resume)(struct device * dev);
};

extern int bus_register(struct bus_type * bus);
extern void bus_unregister(struct bus_type * bus);

extern void bus_rescan_devices(struct bus_type * bus);

/* iterator helpers for buses */

int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
		     int (*fn)(struct device *, void *));
struct device * bus_find_device(struct bus_type *bus, struct device *start,
				void *data, int (*match)(struct device *, void *));

int bus_for_each_drv(struct bus_type * bus, struct device_driver * start, 
		     void * data, int (*fn)(struct device_driver *, void *));


/* driverfs interface for exporting bus attributes */

struct bus_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct bus_type *, char * buf);
	ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
};

#define BUS_ATTR(_name,_mode,_show,_store)	\
struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)

extern int bus_create_file(struct bus_type *, struct bus_attribute *);
extern void bus_remove_file(struct bus_type *, struct bus_attribute *);

struct device_driver {
	const char		* name;
	struct bus_type		* bus;

	struct completion	unloaded;
	struct kobject		kobj;
	struct klist		klist_devices;
	struct klist_node	knode_bus;

	struct module		* owner;

	int	(*probe)	(struct device * dev);
	int	(*remove)	(struct device * dev);
	void	(*shutdown)	(struct device * dev);
	int	(*suspend)	(struct device * dev, pm_message_t state);
	int	(*resume)	(struct device * dev);
};


extern int driver_register(struct device_driver * drv);
extern void driver_unregister(struct device_driver * drv);

extern struct device_driver * get_driver(struct device_driver * drv);
extern void put_driver(struct device_driver * drv);
extern struct device_driver *driver_find(const char *name, struct bus_type *bus);


/* driverfs interface for exporting driver attributes */

struct driver_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct device_driver *, char * buf);
	ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
};

#define DRIVER_ATTR(_name,_mode,_show,_store)	\
struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)

extern int driver_create_file(struct device_driver *, struct driver_attribute *);
extern void driver_remove_file(struct device_driver *, struct driver_attribute *);

extern int driver_for_each_device(struct device_driver * drv, struct device * start,
				  void * data, int (*fn)(struct device *, void *));
struct device * driver_find_device(struct device_driver *drv,
				   struct device *start, void *data,
				   int (*match)(struct device *, void *));


/*
 * device classes
 */
struct class {
	const char		* name;
	struct module		* owner;

	struct subsystem	subsys;
	struct list_head	children;
	struct list_head	devices;
	struct list_head	interfaces;
	struct semaphore	sem;	/* locks both the children and interfaces lists */

	struct kobject		*virtual_dir;

	struct class_attribute		* class_attrs;
	struct class_device_attribute	* class_dev_attrs;
	struct device_attribute		* dev_attrs;

	int	(*uevent)(struct class_device *dev, char **envp,
			   int num_envp, char *buffer, int buffer_size);
	int	(*dev_uevent)(struct device *dev, char **envp, int num_envp,
				char *buffer, int buffer_size);

	void	(*release)(struct class_device *dev);
	void	(*class_release)(struct class *class);
	void	(*dev_release)(struct device *dev);

	int	(*suspend)(struct device *, pm_message_t state);
	int	(*resume)(struct device *);
};

extern int class_register(struct class *);
extern void class_unregister(struct class *);


struct class_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct class *, char * buf);
	ssize_t (*store)(struct class *, const char * buf, size_t count);
};

#define CLASS_ATTR(_name,_mode,_show,_store)			\
struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store) 

extern int class_create_file(struct class *, const struct class_attribute *);
extern void class_remove_file(struct class *, const struct class_attribute *);

struct class_device_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct class_device *, char * buf);
	ssize_t (*store)(struct class_device *, const char * buf, size_t count);
};

#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store)		\
struct class_device_attribute class_device_attr_##_name = 	\
	__ATTR(_name,_mode,_show,_store)

extern int class_device_create_file(struct class_device *,
				    const struct class_device_attribute *);

/**
 * struct class_device - class devices
 * @class: pointer to the parent class for this class device.  This is required.
 * @devt: for internal use by the driver core only.
 * @node: for internal use by the driver core only.
 * @kobj: for internal use by the driver core only.
 * @devt_attr: for internal use by the driver core only.
 * @groups: optional additional groups to be created
 * @dev: if set, a symlink to the struct device is created in the sysfs
 * directory for this struct class device.
 * @class_data: pointer to whatever you want to store here for this struct
 * class_device.  Use class_get_devdata() and class_set_devdata() to get and
 * set this pointer.
 * @parent: pointer to a struct class_device that is the parent of this struct
 * class_device.  If NULL, this class_device will show up at the root of the
 * struct class in sysfs (which is probably what you want to have happen.)
 * @release: pointer to a release function for this struct class_device.  If
 * set, this will be called instead of the class specific release function.
 * Only use this if you want to override the default release function, like
 * when you are nesting class_device structures.
 * @uevent: pointer to a uevent function for this struct class_device.  If
 * set, this will be called instead of the class specific uevent function.
 * Only use this if you want to override the default uevent function, like
 * when you are nesting class_device structures.
 */
struct class_device {
	struct list_head	node;

	struct kobject		kobj;
	struct class		* class;	/* required */
	dev_t			devt;		/* dev_t, creates the sysfs "dev" */
	struct class_device_attribute *devt_attr;
	struct class_device_attribute uevent_attr;
	struct device		* dev;		/* not necessary, but nice to have */
	void			* class_data;	/* class-specific data */
	struct class_device	*parent;	/* parent of this child device, if there is one */
	struct attribute_group  ** groups;	/* optional groups */

	void	(*release)(struct class_device *dev);
	int	(*uevent)(struct class_device *dev, char **envp,
			   int num_envp, char *buffer, int buffer_size);
	char	class_id[BUS_ID_SIZE];	/* unique to this class */
};

static inline void *
class_get_devdata (struct class_device *dev)
{
	return dev->class_data;
}

static inline void
class_set_devdata (struct class_device *dev, void *data)
{
	dev->class_data = data;
}


extern int class_device_register(struct class_device *);
extern void class_device_unregister(struct class_device *);
extern void class_device_initialize(struct class_device *);
extern int class_device_add(struct class_device *);
extern void class_device_del(struct class_device *);

extern int class_device_rename(struct class_device *, char *);

extern struct class_device * class_device_get(struct class_device *);
extern void class_device_put(struct class_device *);

extern void class_device_remove_file(struct class_device *, 
				     const struct class_device_attribute *);
extern int class_device_create_bin_file(struct class_device *,
					struct bin_attribute *);
extern void class_device_remove_bin_file(struct class_device *,
					 struct bin_attribute *);

struct class_interface {
	struct list_head	node;
	struct class		*class;

	int (*add)	(struct class_device *, struct class_interface *);
	void (*remove)	(struct class_device *, struct class_interface *);
	int (*add_dev)		(struct device *, struct class_interface *);
	void (*remove_dev)	(struct device *, struct class_interface *);
};

extern int class_interface_register(struct class_interface *);
extern void class_interface_unregister(struct class_interface *);

extern struct class *class_create(struct module *owner, const char *name);
extern void class_destroy(struct class *cls);
extern struct class_device *class_device_create(struct class *cls,
						struct class_device *parent,
						dev_t devt,
						struct device *device,
						const char *fmt, ...)
					__attribute__((format(printf,5,6)));
extern void class_device_destroy(struct class *cls, dev_t devt);

/* interface for exporting device attributes */
struct device_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct device *dev, struct device_attribute *attr,
			char *buf);
	ssize_t (*store)(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count);
};

#define DEVICE_ATTR(_name,_mode,_show,_store) \
struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)

extern int device_create_file(struct device *device, struct device_attribute * entry);
extern void device_remove_file(struct device * dev, struct device_attribute * attr);
extern int __must_check device_create_bin_file(struct device *dev,
					       struct bin_attribute *attr);
extern void device_remove_bin_file(struct device *dev,
				   struct bin_attribute *attr);
struct device {
	struct klist		klist_children;
	struct klist_node	knode_parent;		/* node in sibling list */
	struct klist_node	knode_driver;
	struct klist_node	knode_bus;
	struct device 	* parent;

	struct kobject kobj;
	char	bus_id[BUS_ID_SIZE];	/* position on parent bus */
	struct device_attribute uevent_attr;
	struct device_attribute *devt_attr;

	struct semaphore	sem;	/* semaphore to synchronize calls to
					 * its driver.
					 */

	struct bus_type	* bus;		/* type of bus device is on */
	struct device_driver *driver;	/* which driver has allocated this
					   device */
	void		*driver_data;	/* data private to the driver */
	void		*platform_data;	/* Platform specific data, device
					   core doesn't touch it */
	void		*firmware_data; /* Firmware specific data (e.g. ACPI,
					   BIOS data),reserved for device core*/
	struct dev_pm_info	power;

	u64		*dma_mask;	/* dma mask (if dma'able device) */
	u64		coherent_dma_mask;/* Like dma_mask, but for
					     alloc_coherent mappings as
					     not all hardware supports
					     64 bit addresses for consistent
					     allocations such descriptors. */

	struct list_head	dma_pools;	/* dma pools (if dma'ble) */

	struct dma_coherent_mem	*dma_mem; /* internal for coherent mem
					     override */

	/* class_device migration path */
	struct list_head	node;
	struct class		*class;		/* optional*/
	dev_t			devt;		/* dev_t, creates the sysfs "dev" */
	struct attribute_group	**groups;	/* optional groups */

	void	(*release)(struct device * dev);
};

static inline void *
dev_get_drvdata (struct device *dev)
{
	return dev->driver_data;
}

static inline void
dev_set_drvdata (struct device *dev, void *data)
{
	dev->driver_data = data;
}

static inline int device_is_registered(struct device *dev)
{
	return klist_node_attached(&dev->knode_bus);
}

/*
 * High level routines for use by the bus drivers
 */
extern int device_register(struct device * dev);
extern void device_unregister(struct device * dev);
extern void device_initialize(struct device * dev);
extern int device_add(struct device * dev);
extern void device_del(struct device * dev);
extern int device_for_each_child(struct device *, void *,
		     int (*fn)(struct device *, void *));
extern int device_rename(struct device *dev, char *new_name);

/*
 * Manual binding of a device to driver. See drivers/base/bus.c
 * for information on use.
 */
extern void device_bind_driver(struct device * dev);
extern void device_release_driver(struct device * dev);
extern int  device_attach(struct device * dev);
extern void driver_attach(struct device_driver * drv);
extern void device_reprobe(struct device *dev);

/*
 * Easy functions for dynamically creating devices on the fly
 */
extern struct device *device_create(struct class *cls, struct device *parent,
				    dev_t devt, const char *fmt, ...)
				    __attribute__((format(printf,4,5)));
extern void device_destroy(struct class *cls, dev_t devt);

extern int virtual_device_parent(struct device *dev);

/*
 * Platform "fixup" functions - allow the platform to have their say
 * about devices and actions that the general device layer doesn't
 * know about.
 */
/* Notify platform of device discovery */
extern int (*platform_notify)(struct device * dev);

extern int (*platform_notify_remove)(struct device * dev);


/**
 * get_device - atomically increment the reference count for the device.
 *
 */
extern struct device * get_device(struct device * dev);
extern void put_device(struct device * dev);


/* drivers/base/power/shutdown.c */
extern void device_shutdown(void);


/* drivers/base/firmware.c */
extern int firmware_register(struct subsystem *);
extern void firmware_unregister(struct subsystem *);

/* debugging and troubleshooting/diagnostic helpers. */
extern const char *dev_driver_string(struct device *dev);
#define dev_printk(level, dev, format, arg...)	\
	printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)

#ifdef DEBUG
#define dev_dbg(dev, format, arg...)		\
	dev_printk(KERN_DEBUG , dev , format , ## arg)
#else
#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
#endif

#define dev_err(dev, format, arg...)		\
	dev_printk(KERN_ERR , dev , format , ## arg)
#define dev_info(dev, format, arg...)		\
	dev_printk(KERN_INFO , dev , format , ## arg)
#define dev_warn(dev, format, arg...)		\
	dev_printk(KERN_WARNING , dev , format , ## arg)
#define dev_notice(dev, format, arg...)		\
	dev_printk(KERN_NOTICE , dev , format , ## arg)

/* Create alias, so I can be autoloaded. */
#define MODULE_ALIAS_CHARDEV(major,minor) \
	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
	MODULE_ALIAS("char-major-" __stringify(major) "-*")
#endif /* _DEVICE_H_ */
Commit	Line	Data
1da177e4 LT	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
1da177e4 LT	14	#include <linux/ioport.h>
1da177e4 LT	15	#include <linux/kobject.h>
465c7a3a	16	#include <linux/klist.h>
1da177e4 LT	17	#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
1da177e4 LT	30	struct device;
	31	struct device_driver;
	32	struct class;
	33	struct class_device;
1da177e4 LT	34
1da177e4 LT	35	struct bus_type {
8d790d74	36	const char * name;
1da177e4 LT	37
	38	struct subsystem subsys;
	39	struct kset drivers;
	40	struct kset devices;
465c7a3a	41	struct klist klist_devices;
38fdac3c	42	struct klist klist_drivers;
1da177e4 LT	43
	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);
312c004d KS	49	int (uevent)(struct device dev, char **envp,
312c004d KS	50	int num_envp, char *buffer, int buffer_size);
594c8281 RK	51	int (probe)(struct device dev);
	52	int (remove)(struct device dev);
	53	void (shutdown)(struct device dev);
7c8265f5	54
7c8265f5 LT	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);
1da177e4 LT	59	};
	60
	61	extern int bus_register(struct bus_type * bus);
	62	extern void bus_unregister(struct bus_type * bus);
	63
23d3d602	64	extern void bus_rescan_devices(struct bus_type * bus);
1da177e4	65
1da177e4 LT	66	/* iterator helpers for buses */
	67
	68	int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
	69	int (fn)(struct device , void *));
0edb5860 CH	70	struct device * bus_find_device(struct bus_type bus, struct device start,
0edb5860 CH	71	void data, int (match)(struct device , void ));
1da177e4 LT	72
	73	int 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
	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);
	83	};
	84
	85	#define BUS_ATTR(_name,_mode,_show,_store) \
	86	struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
	87
	88	extern int bus_create_file(struct bus_type , struct bus_attribute );
	89	extern void bus_remove_file(struct bus_type , struct bus_attribute );
	90
	91	struct device_driver {
8d790d74	92	const char * name;
1da177e4 LT	93	struct bus_type * bus;
	94
	95	struct completion unloaded;
	96	struct kobject kobj;
94e7b1c5	97	struct klist klist_devices;
38fdac3c	98	struct klist_node knode_bus;
1da177e4	99
8d790d74	100	struct module * owner;
1da177e4 LT	101
1da177e4 LT	102	int (probe) (struct device dev);
8d790d74	103	int (remove) (struct device dev);
1da177e4	104	void (shutdown) (struct device dev);
9480e307 RK	105	int (suspend) (struct device dev, pm_message_t state);
9480e307 RK	106	int (resume) (struct device dev);
1da177e4 LT	107	};
	108
	109
	110	extern int driver_register(struct device_driver * drv);
	111	extern void driver_unregister(struct device_driver * drv);
	112
	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);
	116
	117
	118	/* driverfs interface for exporting driver attributes */
	119
	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);
	124	};
	125
	126	#define DRIVER_ATTR(_name,_mode,_show,_store) \
	127	struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
	128
	129	extern int driver_create_file(struct device_driver , struct driver_attribute );
	130	extern void driver_remove_file(struct device_driver , struct driver_attribute );
	131
fae3cd00	132	extern int driver_for_each_device(struct device_driver * drv, struct device * start,
fae3cd00	133	void * data, int (fn)(struct device , void *));
0edb5860 CH	134	struct device * driver_find_device(struct device_driver *drv,
	135	struct device start, void data,
	136	int (match)(struct device , void *));
fae3cd00	137
1da177e4 LT	138
	139	/*
	140	* device classes
	141	*/
	142	struct class {
8d790d74	143	const char * name;
e9ba6365	144	struct module * owner;
1da177e4 LT	145
	146	struct subsystem subsys;
	147	struct list_head children;
23681e47	148	struct list_head devices;
1da177e4 LT	149	struct list_head interfaces;
	150	struct semaphore sem; /* locks both the children and interfaces lists */
	151
c205ef48 GKH	152	struct kobject *virtual_dir;
c205ef48 GKH	153
1da177e4 LT	154	struct class_attribute * class_attrs;
1da177e4 LT	155	struct class_device_attribute * class_dev_attrs;
2620efef	156	struct device_attribute * dev_attrs;
1da177e4	157
312c004d	158	int (uevent)(struct class_device dev, char **envp,
1da177e4	159	int num_envp, char *buffer, int buffer_size);
2620efef GKH	160	int (dev_uevent)(struct device dev, char **envp, int num_envp,
2620efef GKH	161	char *buffer, int buffer_size);
1da177e4 LT	162
	163	void (release)(struct class_device dev);
	164	void (class_release)(struct class class);
2620efef	165	void (dev_release)(struct device dev);
7c8265f5 LT	166
	167	int (suspend)(struct device , pm_message_t state);
	168	int (resume)(struct device );
1da177e4 LT	169	};
	170
	171	extern int class_register(struct class *);
	172	extern void class_unregister(struct class *);
	173
1da177e4 LT	174
	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);
	179	};
	180
	181	#define CLASS_ATTR(_name,_mode,_show,_store) \
	182	struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
	183
	184	extern int class_create_file(struct class , const struct class_attribute );
	185	extern void class_remove_file(struct class , const struct class_attribute );
	186
a7fd6706 KS	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);
	191	};
	192
	193	#define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
	194	struct class_device_attribute class_device_attr_##_name = \
	195	__ATTR(_name,_mode,_show,_store)
	196
	197	extern int class_device_create_file(struct class_device *,
	198	const struct class_device_attribute *);
1da177e4	199
74be227f GKH	200	/**
	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.
1498221d	207	* @groups: optional additional groups to be created
74be227f GKH	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
	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.
312c004d KS	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
74be227f GKH	223	* when you are nesting class_device structures.
74be227f GKH	224	*/
1da177e4 LT	225	struct 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" */
e9ba6365	231	struct class_device_attribute *devt_attr;
a7fd6706	232	struct class_device_attribute uevent_attr;
1da177e4 LT	233	struct device * dev; /* not necessary, but nice to have */
1da177e4 LT	234	void * class_data; /* class-specific data */
51d172d5	235	struct class_device parent; / parent of this child device, if there is one */
1498221d	236	struct attribute_group ** groups; /* optional groups */
1da177e4	237
51d172d5	238	void (release)(struct class_device dev);
312c004d	239	int (uevent)(struct class_device dev, char **envp,
51d172d5	240	int num_envp, char *buffer, int buffer_size);
1da177e4 LT	241	char class_id[BUS_ID_SIZE]; /* unique to this class */
	242	};
	243
	244	static inline void *
	245	class_get_devdata (struct class_device *dev)
	246	{
	247	return dev->class_data;
	248	}
	249
	250	static inline void
	251	class_set_devdata (struct class_device dev, void data)
	252	{
	253	dev->class_data = data;
	254	}
	255
	256
	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 *);
	262
	263	extern int class_device_rename(struct class_device , char );
	264
	265	extern struct class_device * class_device_get(struct class_device *);
	266	extern void class_device_put(struct class_device *);
	267
1da177e4 LT	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 *);
	274
	275	struct class_interface {
	276	struct list_head node;
	277	struct class *class;
	278
d8539d81 DT	279	int (add) (struct class_device , struct class_interface *);
d8539d81 DT	280	void (remove) (struct class_device , struct class_interface *);
c47ed219 GKH	281	int (add_dev) (struct device , struct class_interface *);
c47ed219 GKH	282	void (remove_dev) (struct device , struct class_interface *);
1da177e4 LT	283	};
	284
	285	extern int class_interface_register(struct class_interface *);
	286	extern void class_interface_unregister(struct class_interface *);
	287
ab7d7371	288	extern struct class class_create(struct module owner, const char *name);
e9ba6365	289	extern void class_destroy(struct class *cls);
51d172d5 GKH	290	extern struct class_device class_device_create(struct class cls,
	291	struct class_device *parent,
	292	dev_t devt,
	293	struct device *device,
ddd5d35a	294	const char *fmt, ...)
51d172d5	295	__attribute__((format(printf,5,6)));
e9ba6365	296	extern void class_device_destroy(struct class *cls, dev_t devt);
e9ba6365	297
a7fd6706 KS	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,
	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) \
	308	struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
	309
	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);
2589f188 GKH	312	extern int __must_check device_create_bin_file(struct device *dev,
	313	struct bin_attribute *attr);
	314	extern void device_remove_bin_file(struct device *dev,
	315	struct bin_attribute *attr);
1da177e4	316	struct device {
36239577	317	struct klist klist_children;
36239577	318	struct klist_node knode_parent; /* node in sibling list */
94e7b1c5	319	struct klist_node knode_driver;
465c7a3a	320	struct klist_node knode_bus;
1da177e4 LT	321	struct device * parent;
	322
	323	struct kobject kobj;
	324	char bus_id[BUS_ID_SIZE]; /* position on parent bus */
a7fd6706	325	struct device_attribute uevent_attr;
23681e47	326	struct device_attribute *devt_attr;
1da177e4	327
af70316a	328	struct semaphore sem; /* semaphore to synchronize calls to
	329	* its driver.
	330	*/
	331
1da177e4 LT	332	struct bus_type * bus; /* type of bus device is on */
	333	struct device_driver driver; / which driver has allocated this
	334	device */
	335	void driver_data; / data private to the driver */
4e10d12a DSL	336	void platform_data; / Platform specific data, device
	337	core doesn't touch it */
	338	void firmware_data; / Firmware specific data (e.g. ACPI,
	339	BIOS data),reserved for device core*/
1da177e4 LT	340	struct dev_pm_info power;
1da177e4 LT	341
1da177e4 LT	342	u64 dma_mask; / dma mask (if dma'able device) */
	343	u64 coherent_dma_mask;/* Like dma_mask, but for
	344	alloc_coherent mappings as
	345	not all hardware supports
	346	64 bit addresses for consistent
	347	allocations such descriptors. */
	348
	349	struct list_head dma_pools; /* dma pools (if dma'ble) */
	350
	351	struct dma_coherent_mem dma_mem; / internal for coherent mem
	352	override */
	353
23681e47 GKH	354	/* class_device migration path */
	355	struct list_head node;
	356	struct class class; / optional*/
	357	dev_t devt; /* dev_t, creates the sysfs "dev" */
de0ff00d	358	struct attribute_group *groups; / optional groups */
23681e47	359
1da177e4 LT	360	void (release)(struct device dev);
	361	};
	362
1da177e4 LT	363	static inline void *
	364	dev_get_drvdata (struct device *dev)
	365	{
	366	return dev->driver_data;
	367	}
	368
	369	static inline void
	370	dev_set_drvdata (struct device dev, void data)
	371	{
	372	dev->driver_data = data;
	373	}
	374
d305ef5d DR	375	static inline int device_is_registered(struct device *dev)
	376	{
	377	return klist_node_attached(&dev->knode_bus);
	378	}
	379
1da177e4 LT	380	/*
	381	* High level routines for use by the bus drivers
	382	*/
	383	extern int device_register(struct device * dev);
	384	extern void device_unregister(struct device * dev);
	385	extern void device_initialize(struct device * dev);
	386	extern int device_add(struct device * dev);
	387	extern void device_del(struct device * dev);
	388	extern int device_for_each_child(struct device , void ,
	389	int (fn)(struct device , void *));
a2de48ca	390	extern int device_rename(struct device dev, char new_name);
1da177e4 LT	391
	392	/*
	393	* Manual binding of a device to driver. See drivers/base/bus.c
	394	* for information on use.
	395	*/
1da177e4 LT	396	extern void device_bind_driver(struct device * dev);
	397	extern void device_release_driver(struct device * dev);
	398	extern int device_attach(struct device * dev);
	399	extern void driver_attach(struct device_driver * drv);
e935d5da	400	extern void device_reprobe(struct device *dev);
1da177e4	401
23681e47 GKH	402	/*
	403	* Easy functions for dynamically creating devices on the fly
	404	*/
	405	extern struct device device_create(struct class cls, struct device *parent,
5cbe5f8a	406	dev_t devt, const char *fmt, ...)
23681e47 GKH	407	__attribute__((format(printf,4,5)));
23681e47 GKH	408	extern void device_destroy(struct class *cls, dev_t devt);
1da177e4	409
c205ef48 GKH	410	extern int virtual_device_parent(struct device *dev);
c205ef48 GKH	411
1da177e4 LT	412	/*
	413	* Platform "fixup" functions - allow the platform to have their say
	414	* about devices and actions that the general device layer doesn't
	415	* know about.
	416	*/
	417	/* Notify platform of device discovery */
	418	extern int (platform_notify)(struct device dev);
	419
	420	extern int (platform_notify_remove)(struct device dev);
	421
	422
	423	/**
	424	* get_device - atomically increment the reference count for the device.
	425	*
	426	*/
	427	extern struct device * get_device(struct device * dev);
	428	extern void put_device(struct device * dev);
1da177e4 LT	429
1da177e4 LT	430
116f232b	431	/* drivers/base/power/shutdown.c */
1da177e4 LT	432	extern void device_shutdown(void);
	433
	434
	435	/* drivers/base/firmware.c */
	436	extern int firmware_register(struct subsystem *);
	437	extern void firmware_unregister(struct subsystem *);
	438
	439	/* debugging and troubleshooting/diagnostic helpers. */
3e95637a	440	extern const char dev_driver_string(struct device dev);
1da177e4	441	#define dev_printk(level, dev, format, arg...) \
3e95637a	442	printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
1da177e4 LT	443
	444	#ifdef DEBUG
	445	#define dev_dbg(dev, format, arg...) \
	446	dev_printk(KERN_DEBUG , dev , format , ## arg)
	447	#else
	448	#define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
	449	#endif
	450
	451	#define dev_err(dev, format, arg...) \
	452	dev_printk(KERN_ERR , dev , format , ## arg)
	453	#define dev_info(dev, format, arg...) \
	454	dev_printk(KERN_INFO , dev , format , ## arg)
	455	#define dev_warn(dev, format, arg...) \
	456	dev_printk(KERN_WARNING , dev , format , ## arg)
4f2928d0 TS	457	#define dev_notice(dev, format, arg...) \
4f2928d0 TS	458	dev_printk(KERN_NOTICE , dev , format , ## arg)
1da177e4 LT	459
	460	/* Create alias, so I can be autoloaded. */
	461	#define MODULE_ALIAS_CHARDEV(major,minor) \
	462	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
	463	#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
	464	MODULE_ALIAS("char-major-" __stringify(major) "-*")
	465	#endif /* _DEVICE_H_ */