[GitHub/mt8127/android_kernel_alcatel_ttab.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;
};

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

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