[mirror_ubuntu-artful-kernel.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;

		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)

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