[mirror_ubuntu-bionic-kernel.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/compiler.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 blocking_notifier_head bus_notifier;

	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 __must_check bus_register(struct bus_type * bus);
extern void bus_unregister(struct bus_type * bus);

extern int __must_check 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 __must_check bus_for_each_drv(struct bus_type *bus,
		struct device_driver *start, void *data,
		int (*fn)(struct device_driver *, void *));

/*
 * Bus notifiers: Get notified of addition/removal of devices
 * and binding/unbinding of drivers to devices.
 * In the long run, it should be a replacement for the platform
 * notify hooks.
 */
struct notifier_block;

extern int bus_register_notifier(struct bus_type *bus,
				 struct notifier_block *nb);
extern int bus_unregister_notifier(struct bus_type *bus,
				   struct notifier_block *nb);

/* All 4 notifers below get called with the target struct device *
 * as an argument. Note that those functions are likely to be called
 * with the device semaphore held in the core, so be careful.
 */
#define BUS_NOTIFY_ADD_DEVICE		0x00000001 /* device added */
#define BUS_NOTIFY_DEL_DEVICE		0x00000002 /* device removed */
#define BUS_NOTIFY_BOUND_DRIVER		0x00000003 /* driver bound to device */
#define BUS_NOTIFY_UNBIND_DRIVER	0x00000004 /* driver about to be
						      unbound */

/* 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 __must_check 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);

	unsigned int multithread_probe:1;
};


extern int __must_check 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);
extern int driver_probe_done(void);

/* 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 __must_check driver_create_file(struct device_driver *,
					struct driver_attribute *);
extern void driver_remove_file(struct device_driver *, struct driver_attribute *);

extern int __must_check 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 __must_check 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 __must_check 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 __must_check 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 __must_check class_device_register(struct class_device *);
extern void class_device_unregister(struct class_device *);
extern void class_device_initialize(struct class_device *);
extern int __must_check 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 __must_check 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 __must_check 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 __must_check 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 */
	unsigned		is_registered:1;
	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 dev->is_registered;
}

/*
 * High level routines for use by the bus drivers
 */
extern int __must_check device_register(struct device * dev);
extern void device_unregister(struct device * dev);
extern void device_initialize(struct device * dev);
extern int __must_check 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 int __must_check device_bind_driver(struct device *dev);
extern void device_release_driver(struct device * dev);
extern int  __must_check device_attach(struct device * dev);
extern int __must_check driver_attach(struct device_driver *drv);
extern int __must_check 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);

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