[net-next-2.6.git] / include / linux / platform_device.h

/*
 * platform_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 _PLATFORM_DEVICE_H_
#define _PLATFORM_DEVICE_H_

#include <linux/device.h>
#include <linux/mod_devicetable.h>

struct platform_device {
	const char	* name;
	int		id;
	struct device	dev;
	u32		num_resources;
	struct resource	* resource;

	const struct platform_device_id	*id_entry;

	/* arch specific additions */
	struct pdev_archdata	archdata;
};

#define platform_get_device_id(pdev)	((pdev)->id_entry)

#define to_platform_device(x) container_of((x), struct platform_device, dev)

extern int platform_device_register(struct platform_device *);
extern void platform_device_unregister(struct platform_device *);

extern struct bus_type platform_bus_type;
extern struct device platform_bus;

extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
extern int platform_get_irq(struct platform_device *, unsigned int);
extern struct resource *platform_get_resource_byname(struct platform_device *, unsigned int, const char *);
extern int platform_get_irq_byname(struct platform_device *, const char *);
extern int platform_add_devices(struct platform_device **, int);

extern struct platform_device *platform_device_register_resndata(
		struct device *parent, const char *name, int id,
		const struct resource *res, unsigned int num,
		const void *data, size_t size);

/**
 * platform_device_register_simple - add a platform-level device and its resources
 * @name: base name of the device we're adding
 * @id: instance id
 * @res: set of resources that needs to be allocated for the device
 * @num: number of resources
 *
 * This function creates a simple platform device that requires minimal
 * resource and memory management. Canned release function freeing memory
 * allocated for the device allows drivers using such devices to be
 * unloaded without waiting for the last reference to the device to be
 * dropped.
 *
 * This interface is primarily intended for use with legacy drivers which
 * probe hardware directly.  Because such drivers create sysfs device nodes
 * themselves, rather than letting system infrastructure handle such device
 * enumeration tasks, they don't fully conform to the Linux driver model.
 * In particular, when such drivers are built as modules, they can't be
 * "hotplugged".
 *
 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 */
static inline struct platform_device *platform_device_register_simple(
		const char *name, int id,
		const struct resource *res, unsigned int num)
{
	return platform_device_register_resndata(NULL, name, id,
			res, num, NULL, 0);
}

/**
 * platform_device_register_data - add a platform-level device with platform-specific data
 * @parent: parent device for the device we're adding
 * @name: base name of the device we're adding
 * @id: instance id
 * @data: platform specific data for this platform device
 * @size: size of platform specific data
 *
 * This function creates a simple platform device that requires minimal
 * resource and memory management. Canned release function freeing memory
 * allocated for the device allows drivers using such devices to be
 * unloaded without waiting for the last reference to the device to be
 * dropped.
 *
 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 */
static inline struct platform_device *platform_device_register_data(
		struct device *parent, const char *name, int id,
		const void *data, size_t size)
{
	return platform_device_register_resndata(parent, name, id,
			NULL, 0, data, size);
}

extern struct platform_device *platform_device_alloc(const char *name, int id);
extern int platform_device_add_resources(struct platform_device *pdev,
					 const struct resource *res,
					 unsigned int num);
extern int platform_device_add_data(struct platform_device *pdev, const void *data, size_t size);
extern int platform_device_add(struct platform_device *pdev);
extern void platform_device_del(struct platform_device *pdev);
extern void platform_device_put(struct platform_device *pdev);

struct platform_driver {
	int (*probe)(struct platform_device *);
	int (*remove)(struct platform_device *);
	void (*shutdown)(struct platform_device *);
	int (*suspend)(struct platform_device *, pm_message_t state);
	int (*resume)(struct platform_device *);
	struct device_driver driver;
	const struct platform_device_id *id_table;
};

extern int platform_driver_register(struct platform_driver *);
extern void platform_driver_unregister(struct platform_driver *);

/* non-hotpluggable platform devices may use this so that probe() and
 * its support may live in __init sections, conserving runtime memory.
 */
extern int platform_driver_probe(struct platform_driver *driver,
		int (*probe)(struct platform_device *));

#define platform_get_drvdata(_dev)	dev_get_drvdata(&(_dev)->dev)
#define platform_set_drvdata(_dev,data)	dev_set_drvdata(&(_dev)->dev, (data))

extern struct platform_device *platform_create_bundle(struct platform_driver *driver,
					int (*probe)(struct platform_device *),
					struct resource *res, unsigned int n_res,
					const void *data, size_t size);

/* early platform driver interface */
struct early_platform_driver {
	const char *class_str;
	struct platform_driver *pdrv;
	struct list_head list;
	int requested_id;
	char *buffer;
	int bufsize;
};

#define EARLY_PLATFORM_ID_UNSET -2
#define EARLY_PLATFORM_ID_ERROR -3

extern int early_platform_driver_register(struct early_platform_driver *epdrv,
					  char *buf);
extern void early_platform_add_devices(struct platform_device **devs, int num);

static inline int is_early_platform_device(struct platform_device *pdev)
{
	return !pdev->dev.driver;
}

extern void early_platform_driver_register_all(char *class_str);
extern int early_platform_driver_probe(char *class_str,
				       int nr_probe, int user_only);
extern void early_platform_cleanup(void);

#define early_platform_init(class_string, platdrv)		\
	early_platform_init_buffer(class_string, platdrv, NULL, 0)

#ifndef MODULE
#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz)	\
static __initdata struct early_platform_driver early_driver = {		\
	.class_str = class_string,					\
	.buffer = buf,							\
	.bufsize = bufsiz,						\
	.pdrv = platdrv,						\
	.requested_id = EARLY_PLATFORM_ID_UNSET,			\
};									\
static int __init early_platform_driver_setup_func(char *buffer)	\
{									\
	return early_platform_driver_register(&early_driver, buffer);	\
}									\
early_param(class_string, early_platform_driver_setup_func)
#else /* MODULE */
#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz)	\
static inline char *early_platform_driver_setup_func(void)		\
{									\
	return bufsiz ? buf : NULL;					\
}
#endif /* MODULE */

#endif /* _PLATFORM_DEVICE_H_ */
Commit	Line	Data
bbbf508d RK	1	/*
	2	* platform_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 _PLATFORM_DEVICE_H_
	12	#define _PLATFORM_DEVICE_H_
	13
	14	#include <linux/device.h>
57fee4a5	15	#include <linux/mod_devicetable.h>
bbbf508d RK	16
	17	struct platform_device {
	18	const char * name;
1359555e	19	int id;
bbbf508d RK	20	struct device dev;
	21	u32 num_resources;
	22	struct resource * resource;
57fee4a5	23
3d03ba4d	24	const struct platform_device_id *id_entry;
d7aacadd MD	25
	26	/* arch specific additions */
	27	struct pdev_archdata archdata;
bbbf508d RK	28	};
bbbf508d RK	29
57fee4a5 EM	30	#define platform_get_device_id(pdev) ((pdev)->id_entry)
57fee4a5 EM	31
bbbf508d RK	32	#define to_platform_device(x) container_of((x), struct platform_device, dev)
	33
	34	extern int platform_device_register(struct platform_device *);
	35	extern void platform_device_unregister(struct platform_device *);
	36
	37	extern struct bus_type platform_bus_type;
	38	extern struct device platform_bus;
	39
	40	extern struct resource platform_get_resource(struct platform_device , unsigned int, unsigned int);
	41	extern int platform_get_irq(struct platform_device *, unsigned int);
c0afe7ba LW	42	extern struct resource platform_get_resource_byname(struct platform_device , unsigned int, const char *);
c0afe7ba LW	43	extern int platform_get_irq_byname(struct platform_device , const char );
bbbf508d RK	44	extern int platform_add_devices(struct platform_device **, int);
bbbf508d RK	45
44f28bde UKK	46	extern struct platform_device *platform_device_register_resndata(
	47	struct device parent, const char name, int id,
	48	const struct resource *res, unsigned int num,
	49	const void *data, size_t size);
	50
	51	/**
	52	* platform_device_register_simple - add a platform-level device and its resources
	53	* @name: base name of the device we're adding
	54	* @id: instance id
	55	* @res: set of resources that needs to be allocated for the device
	56	* @num: number of resources
	57	*
	58	* This function creates a simple platform device that requires minimal
	59	* resource and memory management. Canned release function freeing memory
	60	* allocated for the device allows drivers using such devices to be
	61	* unloaded without waiting for the last reference to the device to be
	62	* dropped.
	63	*
	64	* This interface is primarily intended for use with legacy drivers which
	65	* probe hardware directly. Because such drivers create sysfs device nodes
	66	* themselves, rather than letting system infrastructure handle such device
	67	* enumeration tasks, they don't fully conform to the Linux driver model.
	68	* In particular, when such drivers are built as modules, they can't be
	69	* "hotplugged".
	70	*
	71	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	72	*/
	73	static inline struct platform_device *platform_device_register_simple(
	74	const char *name, int id,
	75	const struct resource *res, unsigned int num)
	76	{
	77	return platform_device_register_resndata(NULL, name, id,
	78	res, num, NULL, 0);
	79	}
	80
	81	/**
	82	* platform_device_register_data - add a platform-level device with platform-specific data
	83	* @parent: parent device for the device we're adding
	84	* @name: base name of the device we're adding
	85	* @id: instance id
	86	* @data: platform specific data for this platform device
	87	* @size: size of platform specific data
	88	*
	89	* This function creates a simple platform device that requires minimal
	90	* resource and memory management. Canned release function freeing memory
	91	* allocated for the device allows drivers using such devices to be
	92	* unloaded without waiting for the last reference to the device to be
	93	* dropped.
	94	*
	95	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	96	*/
	97	static inline struct platform_device *platform_device_register_data(
	98	struct device parent, const char name, int id,
	99	const void *data, size_t size)
	100	{
	101	return platform_device_register_resndata(parent, name, id,
	102	NULL, 0, data, size);
	103	}
bbbf508d	104
1359555e	105	extern struct platform_device platform_device_alloc(const char name, int id);
0b7f1a7e GU	106	extern int platform_device_add_resources(struct platform_device *pdev,
	107	const struct resource *res,
	108	unsigned int num);
6eefd34f	109	extern int platform_device_add_data(struct platform_device pdev, const void data, size_t size);
37c12e74	110	extern int platform_device_add(struct platform_device *pdev);
93ce3061	111	extern void platform_device_del(struct platform_device *pdev);
37c12e74 RK	112	extern void platform_device_put(struct platform_device *pdev);
37c12e74 RK	113
00d3dcdd RK	114	struct platform_driver {
	115	int (probe)(struct platform_device );
	116	int (remove)(struct platform_device );
	117	void (shutdown)(struct platform_device );
	118	int (suspend)(struct platform_device , pm_message_t state);
	119	int (resume)(struct platform_device );
	120	struct device_driver driver;
831fad2f	121	const struct platform_device_id *id_table;
00d3dcdd RK	122	};
	123
	124	extern int platform_driver_register(struct platform_driver *);
	125	extern void platform_driver_unregister(struct platform_driver *);
	126
c67334fb DB	127	/* non-hotpluggable platform devices may use this so that probe() and
	128	* its support may live in __init sections, conserving runtime memory.
	129	*/
	130	extern int platform_driver_probe(struct platform_driver *driver,
	131	int (probe)(struct platform_device ));
	132
00d3dcdd RK	133	#define platform_get_drvdata(_dev) dev_get_drvdata(&(_dev)->dev)
	134	#define platform_set_drvdata(_dev,data) dev_set_drvdata(&(_dev)->dev, (data))
	135
ecdf6ceb DT	136	extern struct platform_device platform_create_bundle(struct platform_driver driver,
	137	int (probe)(struct platform_device ),
	138	struct resource *res, unsigned int n_res,
	139	const void *data, size_t size);
	140
13977091 MD	141	/* early platform driver interface */
	142	struct early_platform_driver {
	143	const char *class_str;
	144	struct platform_driver *pdrv;
	145	struct list_head list;
	146	int requested_id;
c60e0504 MD	147	char *buffer;
c60e0504 MD	148	int bufsize;
13977091 MD	149	};
	150
	151	#define EARLY_PLATFORM_ID_UNSET -2
	152	#define EARLY_PLATFORM_ID_ERROR -3
	153
	154	extern int early_platform_driver_register(struct early_platform_driver *epdrv,
	155	char *buf);
	156	extern void early_platform_add_devices(struct platform_device **devs, int num);
	157
	158	static inline int is_early_platform_device(struct platform_device *pdev)
	159	{
	160	return !pdev->dev.driver;
	161	}
	162
	163	extern void early_platform_driver_register_all(char *class_str);
	164	extern int early_platform_driver_probe(char *class_str,
	165	int nr_probe, int user_only);
	166	extern void early_platform_cleanup(void);
	167
c60e0504 MD	168	#define early_platform_init(class_string, platdrv) \
c60e0504 MD	169	early_platform_init_buffer(class_string, platdrv, NULL, 0)
13977091 MD	170
13977091 MD	171	#ifndef MODULE
c60e0504	172	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
13977091 MD	173	static __initdata struct early_platform_driver early_driver = { \
13977091 MD	174	.class_str = class_string, \
c60e0504 MD	175	.buffer = buf, \
	176	.bufsize = bufsiz, \
	177	.pdrv = platdrv, \
13977091 MD	178	.requested_id = EARLY_PLATFORM_ID_UNSET, \
13977091 MD	179	}; \
c60e0504	180	static int __init early_platform_driver_setup_func(char *buffer) \
13977091	181	{ \
c60e0504	182	return early_platform_driver_register(&early_driver, buffer); \
13977091 MD	183	} \
	184	early_param(class_string, early_platform_driver_setup_func)
	185	#else /* MODULE */
c60e0504 MD	186	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
	187	static inline char *early_platform_driver_setup_func(void) \
	188	{ \
	189	return bufsiz ? buf : NULL; \
	190	}
13977091 MD	191	#endif /* MODULE */
13977091 MD	192
bbbf508d	193	#endif /* _PLATFORM_DEVICE_H_ */