[linux-2.6-block.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>

#define PLATFORM_DEVID_NONE	(-1)
#define PLATFORM_DEVID_AUTO	(-2)

struct mfd_cell;

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

	const struct platform_device_id	*id_entry;

	/* MFD cell pointer */
	struct mfd_cell *mfd_cell;

	/* 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 void arch_setup_pdev_archdata(struct platform_device *);
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);

struct platform_device_info {
		struct device *parent;
		struct acpi_dev_node acpi_node;

		const char *name;
		int id;

		const struct resource *res;
		unsigned int num_res;

		const void *data;
		size_t size_data;
		u64 dma_mask;
};
extern struct platform_device *platform_device_register_full(
		const struct platform_device_info *pdevinfo);

/**
 * platform_device_register_resndata - add a platform-level device with
 * resources and platform-specific data
 *
 * @parent: parent device for the device we're adding
 * @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
 * @data: platform specific data for this platform device
 * @size: size of platform specific data
 *
 * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 */
static inline 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) {

	struct platform_device_info pdevinfo = {
		.parent = parent,
		.name = name,
		.id = id,
		.res = res,
		.num_res = num,
		.data = data,
		.size_data = size,
		.dma_mask = 0,
	};

	return platform_device_register_full(&pdevinfo);
}

/**
 * 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;
};

/*
 * use a macro to avoid include chaining to get THIS_MODULE
 */
#define platform_driver_register(drv) \
	__platform_driver_register(drv, THIS_MODULE)
extern int __platform_driver_register(struct platform_driver *,
					struct module *);
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 *));

static inline void *platform_get_drvdata(const struct platform_device *pdev)
{
	return dev_get_drvdata(&pdev->dev);
}

static inline void platform_set_drvdata(struct platform_device *pdev,
					void *data)
{
	dev_set_drvdata(&pdev->dev, data);
}

/* module_platform_driver() - Helper macro for drivers that don't do
 * anything special in module init/exit.  This eliminates a lot of
 * boilerplate.  Each module may only use this macro once, and
 * calling it replaces module_init() and module_exit()
 */
#define module_platform_driver(__platform_driver) \
	module_driver(__platform_driver, platform_driver_register, \
			platform_driver_unregister)

/* module_platform_driver_probe() - Helper macro for drivers that don't do
 * anything special in module init/exit.  This eliminates a lot of
 * boilerplate.  Each module may only use this macro once, and
 * calling it replaces module_init() and module_exit()
 */
#define module_platform_driver_probe(__platform_driver, __platform_probe) \
static int __init __platform_driver##_init(void) \
{ \
	return platform_driver_probe(&(__platform_driver), \
				     __platform_probe);    \
} \
module_init(__platform_driver##_init); \
static void __exit __platform_driver##_exit(void) \
{ \
	platform_driver_unregister(&(__platform_driver)); \
} \
module_exit(__platform_driver##_exit);

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 */

#ifdef CONFIG_SUSPEND
extern int platform_pm_suspend(struct device *dev);
extern int platform_pm_resume(struct device *dev);
#else
#define platform_pm_suspend		NULL
#define platform_pm_resume		NULL
#endif

#ifdef CONFIG_HIBERNATE_CALLBACKS
extern int platform_pm_freeze(struct device *dev);
extern int platform_pm_thaw(struct device *dev);
extern int platform_pm_poweroff(struct device *dev);
extern int platform_pm_restore(struct device *dev);
#else
#define platform_pm_freeze		NULL
#define platform_pm_thaw		NULL
#define platform_pm_poweroff		NULL
#define platform_pm_restore		NULL
#endif

#ifdef CONFIG_PM_SLEEP
#define USE_PLATFORM_PM_SLEEP_OPS \
	.suspend = platform_pm_suspend, \
	.resume = platform_pm_resume, \
	.freeze = platform_pm_freeze, \
	.thaw = platform_pm_thaw, \
	.poweroff = platform_pm_poweroff, \
	.restore = platform_pm_restore,
#else
#define USE_PLATFORM_PM_SLEEP_OPS
#endif

#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	16
689ae231 JD	17	#define PLATFORM_DEVID_NONE (-1)
	18	#define PLATFORM_DEVID_AUTO (-2)
	19
e710d7d5 SO	20	struct mfd_cell;
e710d7d5 SO	21
bbbf508d	22	struct platform_device {
6ae07f27	23	const char *name;
1359555e	24	int id;
689ae231	25	bool id_auto;
bbbf508d RK	26	struct device dev;
bbbf508d RK	27	u32 num_resources;
6ae07f27	28	struct resource *resource;
57fee4a5	29
3d03ba4d	30	const struct platform_device_id *id_entry;
d7aacadd	31
e710d7d5 SO	32	/* MFD cell pointer */
	33	struct mfd_cell *mfd_cell;
	34
d7aacadd MD	35	/* arch specific additions */
d7aacadd MD	36	struct pdev_archdata archdata;
bbbf508d RK	37	};
bbbf508d RK	38
57fee4a5 EM	39	#define platform_get_device_id(pdev) ((pdev)->id_entry)
57fee4a5 EM	40
bbbf508d RK	41	#define to_platform_device(x) container_of((x), struct platform_device, dev)
	42
	43	extern int platform_device_register(struct platform_device *);
	44	extern void platform_device_unregister(struct platform_device *);
	45
	46	extern struct bus_type platform_bus_type;
	47	extern struct device platform_bus;
	48
a77ce816	49	extern void arch_setup_pdev_archdata(struct platform_device *);
6ae07f27 FP	50	extern struct resource platform_get_resource(struct platform_device ,
6ae07f27 FP	51	unsigned int, unsigned int);
bbbf508d	52	extern int platform_get_irq(struct platform_device *, unsigned int);
6ae07f27 FP	53	extern struct resource platform_get_resource_byname(struct platform_device ,
	54	unsigned int,
	55	const char *);
c0afe7ba	56	extern int platform_get_irq_byname(struct platform_device , const char );
bbbf508d RK	57	extern int platform_add_devices(struct platform_device **, int);
bbbf508d RK	58
01dcc60a UKK	59	struct platform_device_info {
01dcc60a UKK	60	struct device *parent;
863f9f30	61	struct acpi_dev_node acpi_node;
01dcc60a UKK	62
	63	const char *name;
	64	int id;
	65
	66	const struct resource *res;
	67	unsigned int num_res;
	68
	69	const void *data;
	70	size_t size_data;
	71	u64 dma_mask;
	72	};
	73	extern struct platform_device *platform_device_register_full(
5a3072be	74	const struct platform_device_info *pdevinfo);
01dcc60a UKK	75
	76	/**
	77	* platform_device_register_resndata - add a platform-level device with
	78	* resources and platform-specific data
	79	*
	80	* @parent: parent device for the device we're adding
	81	* @name: base name of the device we're adding
	82	* @id: instance id
	83	* @res: set of resources that needs to be allocated for the device
	84	* @num: number of resources
	85	* @data: platform specific data for this platform device
	86	* @size: size of platform specific data
	87	*
	88	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	89	*/
	90	static inline struct platform_device *platform_device_register_resndata(
44f28bde UKK	91	struct device parent, const char name, int id,
44f28bde UKK	92	const struct resource *res, unsigned int num,
01dcc60a UKK	93	const void *data, size_t size) {
	94
	95	struct platform_device_info pdevinfo = {
	96	.parent = parent,
	97	.name = name,
	98	.id = id,
	99	.res = res,
	100	.num_res = num,
	101	.data = data,
	102	.size_data = size,
	103	.dma_mask = 0,
	104	};
	105
	106	return platform_device_register_full(&pdevinfo);
	107	}
44f28bde UKK	108
	109	/**
	110	* platform_device_register_simple - add a platform-level device and its resources
	111	* @name: base name of the device we're adding
	112	* @id: instance id
	113	* @res: set of resources that needs to be allocated for the device
	114	* @num: number of resources
	115	*
	116	* This function creates a simple platform device that requires minimal
	117	* resource and memory management. Canned release function freeing memory
	118	* allocated for the device allows drivers using such devices to be
	119	* unloaded without waiting for the last reference to the device to be
	120	* dropped.
	121	*
	122	* This interface is primarily intended for use with legacy drivers which
	123	* probe hardware directly. Because such drivers create sysfs device nodes
	124	* themselves, rather than letting system infrastructure handle such device
	125	* enumeration tasks, they don't fully conform to the Linux driver model.
	126	* In particular, when such drivers are built as modules, they can't be
	127	* "hotplugged".
	128	*
	129	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	130	*/
	131	static inline struct platform_device *platform_device_register_simple(
	132	const char *name, int id,
	133	const struct resource *res, unsigned int num)
	134	{
	135	return platform_device_register_resndata(NULL, name, id,
	136	res, num, NULL, 0);
	137	}
	138
	139	/**
	140	* platform_device_register_data - add a platform-level device with platform-specific data
	141	* @parent: parent device for the device we're adding
	142	* @name: base name of the device we're adding
	143	* @id: instance id
	144	* @data: platform specific data for this platform device
	145	* @size: size of platform specific data
	146	*
	147	* This function creates a simple platform device that requires minimal
	148	* resource and memory management. Canned release function freeing memory
	149	* allocated for the device allows drivers using such devices to be
	150	* unloaded without waiting for the last reference to the device to be
	151	* dropped.
	152	*
	153	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	154	*/
	155	static inline struct platform_device *platform_device_register_data(
	156	struct device parent, const char name, int id,
	157	const void *data, size_t size)
	158	{
	159	return platform_device_register_resndata(parent, name, id,
	160	NULL, 0, data, size);
	161	}
bbbf508d	162
1359555e	163	extern struct platform_device platform_device_alloc(const char name, int id);
0b7f1a7e GU	164	extern int platform_device_add_resources(struct platform_device *pdev,
	165	const struct resource *res,
	166	unsigned int num);
6ae07f27 FP	167	extern int platform_device_add_data(struct platform_device *pdev,
6ae07f27 FP	168	const void *data, size_t size);
37c12e74	169	extern int platform_device_add(struct platform_device *pdev);
93ce3061	170	extern void platform_device_del(struct platform_device *pdev);
37c12e74 RK	171	extern void platform_device_put(struct platform_device *pdev);
37c12e74 RK	172
00d3dcdd RK	173	struct platform_driver {
	174	int (probe)(struct platform_device );
	175	int (remove)(struct platform_device );
	176	void (shutdown)(struct platform_device );
	177	int (suspend)(struct platform_device , pm_message_t state);
	178	int (resume)(struct platform_device );
	179	struct device_driver driver;
831fad2f	180	const struct platform_device_id *id_table;
00d3dcdd RK	181	};
00d3dcdd RK	182
9447057e LC	183	/*
	184	* use a macro to avoid include chaining to get THIS_MODULE
	185	*/
	186	#define platform_driver_register(drv) \
	187	__platform_driver_register(drv, THIS_MODULE)
	188	extern int __platform_driver_register(struct platform_driver *,
	189	struct module *);
00d3dcdd RK	190	extern void platform_driver_unregister(struct platform_driver *);
00d3dcdd RK	191
c67334fb DB	192	/* non-hotpluggable platform devices may use this so that probe() and
	193	* its support may live in __init sections, conserving runtime memory.
	194	*/
	195	extern int platform_driver_probe(struct platform_driver *driver,
	196	int (probe)(struct platform_device ));
	197
71d64290 MKB	198	static inline void platform_get_drvdata(const struct platform_device pdev)
	199	{
	200	return dev_get_drvdata(&pdev->dev);
	201	}
	202
6ae07f27 FP	203	static inline void platform_set_drvdata(struct platform_device *pdev,
6ae07f27 FP	204	void *data)
71d64290 MKB	205	{
	206	dev_set_drvdata(&pdev->dev, data);
	207	}
00d3dcdd	208
940ab889 GL	209	/* module_platform_driver() - Helper macro for drivers that don't do
	210	* anything special in module init/exit. This eliminates a lot of
	211	* boilerplate. Each module may only use this macro once, and
	212	* calling it replaces module_init() and module_exit()
	213	*/
	214	#define module_platform_driver(__platform_driver) \
907d0ed1 LPC	215	module_driver(__platform_driver, platform_driver_register, \
907d0ed1 LPC	216	platform_driver_unregister)
940ab889	217
bab734fc FP	218	/* module_platform_driver_probe() - Helper macro for drivers that don't do
	219	* anything special in module init/exit. This eliminates a lot of
	220	* boilerplate. Each module may only use this macro once, and
	221	* calling it replaces module_init() and module_exit()
	222	*/
	223	#define module_platform_driver_probe(__platform_driver, __platform_probe) \
	224	static int __init __platform_driver##_init(void) \
	225	{ \
	226	return platform_driver_probe(&(__platform_driver), \
	227	__platform_probe); \
	228	} \
	229	module_init(__platform_driver##_init); \
	230	static void __exit __platform_driver##_exit(void) \
	231	{ \
	232	platform_driver_unregister(&(__platform_driver)); \
	233	} \
	234	module_exit(__platform_driver##_exit);
	235
6ae07f27 FP	236	extern struct platform_device *platform_create_bundle(
	237	struct platform_driver driver, int (probe)(struct platform_device *),
	238	struct resource *res, unsigned int n_res,
	239	const void *data, size_t size);
ecdf6ceb	240
13977091 MD	241	/* early platform driver interface */
	242	struct early_platform_driver {
	243	const char *class_str;
	244	struct platform_driver *pdrv;
	245	struct list_head list;
	246	int requested_id;
c60e0504 MD	247	char *buffer;
c60e0504 MD	248	int bufsize;
13977091 MD	249	};
	250
	251	#define EARLY_PLATFORM_ID_UNSET -2
	252	#define EARLY_PLATFORM_ID_ERROR -3
	253
	254	extern int early_platform_driver_register(struct early_platform_driver *epdrv,
	255	char *buf);
	256	extern void early_platform_add_devices(struct platform_device **devs, int num);
	257
	258	static inline int is_early_platform_device(struct platform_device *pdev)
	259	{
	260	return !pdev->dev.driver;
	261	}
	262
	263	extern void early_platform_driver_register_all(char *class_str);
	264	extern int early_platform_driver_probe(char *class_str,
	265	int nr_probe, int user_only);
	266	extern void early_platform_cleanup(void);
	267
c60e0504 MD	268	#define early_platform_init(class_string, platdrv) \
c60e0504 MD	269	early_platform_init_buffer(class_string, platdrv, NULL, 0)
13977091 MD	270
13977091 MD	271	#ifndef MODULE
c60e0504	272	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
13977091 MD	273	static __initdata struct early_platform_driver early_driver = { \
13977091 MD	274	.class_str = class_string, \
c60e0504 MD	275	.buffer = buf, \
	276	.bufsize = bufsiz, \
	277	.pdrv = platdrv, \
13977091 MD	278	.requested_id = EARLY_PLATFORM_ID_UNSET, \
13977091 MD	279	}; \
c60e0504	280	static int __init early_platform_driver_setup_func(char *buffer) \
13977091	281	{ \
c60e0504	282	return early_platform_driver_register(&early_driver, buffer); \
13977091 MD	283	} \
	284	early_param(class_string, early_platform_driver_setup_func)
	285	#else /* MODULE */
c60e0504 MD	286	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
	287	static inline char *early_platform_driver_setup_func(void) \
	288	{ \
	289	return bufsiz ? buf : NULL; \
	290	}
13977091 MD	291	#endif /* MODULE */
13977091 MD	292
69c9dd1e RW	293	#ifdef CONFIG_SUSPEND
69c9dd1e RW	294	extern int platform_pm_suspend(struct device *dev);
69c9dd1e	295	extern int platform_pm_resume(struct device *dev);
69c9dd1e RW	296	#else
	297	#define platform_pm_suspend NULL
	298	#define platform_pm_resume NULL
69c9dd1e RW	299	#endif
	300
	301	#ifdef CONFIG_HIBERNATE_CALLBACKS
	302	extern int platform_pm_freeze(struct device *dev);
69c9dd1e	303	extern int platform_pm_thaw(struct device *dev);
69c9dd1e	304	extern int platform_pm_poweroff(struct device *dev);
69c9dd1e	305	extern int platform_pm_restore(struct device *dev);
69c9dd1e RW	306	#else
	307	#define platform_pm_freeze NULL
	308	#define platform_pm_thaw NULL
	309	#define platform_pm_poweroff NULL
	310	#define platform_pm_restore NULL
69c9dd1e RW	311	#endif
	312
	313	#ifdef CONFIG_PM_SLEEP
	314	#define USE_PLATFORM_PM_SLEEP_OPS \
69c9dd1e RW	315	.suspend = platform_pm_suspend, \
	316	.resume = platform_pm_resume, \
	317	.freeze = platform_pm_freeze, \
	318	.thaw = platform_pm_thaw, \
	319	.poweroff = platform_pm_poweroff, \
9b39e73d	320	.restore = platform_pm_restore,
69c9dd1e RW	321	#else
	322	#define USE_PLATFORM_PM_SLEEP_OPS
	323	#endif
	324
bbbf508d	325	#endif /* _PLATFORM_DEVICE_H_ */