[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>

struct mfd_cell;

struct platform_device {
	const char	* name;
	int		id;
	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);

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

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

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_PM_SLEEP
extern int platform_pm_prepare(struct device *dev);
extern void platform_pm_complete(struct device *dev);
#else
#define platform_pm_prepare	NULL
#define platform_pm_complete	NULL
#endif

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

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

#ifdef CONFIG_PM_SLEEP
#define USE_PLATFORM_PM_SLEEP_OPS \
	.prepare = platform_pm_prepare, \
	.complete = platform_pm_complete, \
	.suspend = platform_pm_suspend, \
	.resume = platform_pm_resume, \
	.freeze = platform_pm_freeze, \
	.thaw = platform_pm_thaw, \
	.poweroff = platform_pm_poweroff, \
	.restore = platform_pm_restore, \
	.suspend_noirq = platform_pm_suspend_noirq, \
	.resume_noirq = platform_pm_resume_noirq, \
	.freeze_noirq = platform_pm_freeze_noirq, \
	.thaw_noirq = platform_pm_thaw_noirq, \
	.poweroff_noirq = platform_pm_poweroff_noirq, \
	.restore_noirq = platform_pm_restore_noirq,
#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
e710d7d5 SO	17	struct mfd_cell;
e710d7d5 SO	18
bbbf508d RK	19	struct platform_device {
bbbf508d RK	20	const char * name;
1359555e	21	int id;
bbbf508d RK	22	struct device dev;
	23	u32 num_resources;
	24	struct resource * resource;
57fee4a5	25
3d03ba4d	26	const struct platform_device_id *id_entry;
d7aacadd	27
e710d7d5 SO	28	/* MFD cell pointer */
	29	struct mfd_cell *mfd_cell;
	30
d7aacadd MD	31	/* arch specific additions */
d7aacadd MD	32	struct pdev_archdata archdata;
bbbf508d RK	33	};
bbbf508d RK	34
57fee4a5 EM	35	#define platform_get_device_id(pdev) ((pdev)->id_entry)
57fee4a5 EM	36
bbbf508d RK	37	#define to_platform_device(x) container_of((x), struct platform_device, dev)
	38
	39	extern int platform_device_register(struct platform_device *);
	40	extern void platform_device_unregister(struct platform_device *);
	41
	42	extern struct bus_type platform_bus_type;
	43	extern struct device platform_bus;
	44
a77ce816	45	extern void arch_setup_pdev_archdata(struct platform_device *);
bbbf508d RK	46	extern struct resource platform_get_resource(struct platform_device , unsigned int, unsigned int);
bbbf508d RK	47	extern int platform_get_irq(struct platform_device *, unsigned int);
c0afe7ba LW	48	extern struct resource platform_get_resource_byname(struct platform_device , unsigned int, const char *);
c0afe7ba LW	49	extern int platform_get_irq_byname(struct platform_device , const char );
bbbf508d RK	50	extern int platform_add_devices(struct platform_device **, int);
bbbf508d RK	51
44f28bde UKK	52	extern struct platform_device *platform_device_register_resndata(
	53	struct device parent, const char name, int id,
	54	const struct resource *res, unsigned int num,
	55	const void *data, size_t size);
	56
	57	/**
	58	* platform_device_register_simple - add a platform-level device and its resources
	59	* @name: base name of the device we're adding
	60	* @id: instance id
	61	* @res: set of resources that needs to be allocated for the device
	62	* @num: number of resources
	63	*
	64	* This function creates a simple platform device that requires minimal
	65	* resource and memory management. Canned release function freeing memory
	66	* allocated for the device allows drivers using such devices to be
	67	* unloaded without waiting for the last reference to the device to be
	68	* dropped.
	69	*
	70	* This interface is primarily intended for use with legacy drivers which
	71	* probe hardware directly. Because such drivers create sysfs device nodes
	72	* themselves, rather than letting system infrastructure handle such device
	73	* enumeration tasks, they don't fully conform to the Linux driver model.
	74	* In particular, when such drivers are built as modules, they can't be
	75	* "hotplugged".
	76	*
	77	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	78	*/
	79	static inline struct platform_device *platform_device_register_simple(
	80	const char *name, int id,
	81	const struct resource *res, unsigned int num)
	82	{
	83	return platform_device_register_resndata(NULL, name, id,
	84	res, num, NULL, 0);
	85	}
	86
	87	/**
	88	* platform_device_register_data - add a platform-level device with platform-specific data
	89	* @parent: parent device for the device we're adding
	90	* @name: base name of the device we're adding
	91	* @id: instance id
	92	* @data: platform specific data for this platform device
	93	* @size: size of platform specific data
	94	*
	95	* This function creates a simple platform device that requires minimal
	96	* resource and memory management. Canned release function freeing memory
	97	* allocated for the device allows drivers using such devices to be
	98	* unloaded without waiting for the last reference to the device to be
	99	* dropped.
	100	*
	101	* Returns &struct platform_device pointer on success, or ERR_PTR() on error.
	102	*/
	103	static inline struct platform_device *platform_device_register_data(
	104	struct device parent, const char name, int id,
	105	const void *data, size_t size)
	106	{
	107	return platform_device_register_resndata(parent, name, id,
	108	NULL, 0, data, size);
	109	}
bbbf508d	110
1359555e	111	extern struct platform_device platform_device_alloc(const char name, int id);
0b7f1a7e GU	112	extern int platform_device_add_resources(struct platform_device *pdev,
	113	const struct resource *res,
	114	unsigned int num);
6eefd34f	115	extern int platform_device_add_data(struct platform_device pdev, const void data, size_t size);
37c12e74	116	extern int platform_device_add(struct platform_device *pdev);
93ce3061	117	extern void platform_device_del(struct platform_device *pdev);
37c12e74 RK	118	extern void platform_device_put(struct platform_device *pdev);
37c12e74 RK	119
00d3dcdd RK	120	struct platform_driver {
	121	int (probe)(struct platform_device );
	122	int (remove)(struct platform_device );
	123	void (shutdown)(struct platform_device );
	124	int (suspend)(struct platform_device , pm_message_t state);
	125	int (resume)(struct platform_device );
	126	struct device_driver driver;
831fad2f	127	const struct platform_device_id *id_table;
00d3dcdd RK	128	};
	129
	130	extern int platform_driver_register(struct platform_driver *);
	131	extern void platform_driver_unregister(struct platform_driver *);
	132
c67334fb DB	133	/* non-hotpluggable platform devices may use this so that probe() and
	134	* its support may live in __init sections, conserving runtime memory.
	135	*/
	136	extern int platform_driver_probe(struct platform_driver *driver,
	137	int (probe)(struct platform_device ));
	138
71d64290 MKB	139	static inline void platform_get_drvdata(const struct platform_device pdev)
	140	{
	141	return dev_get_drvdata(&pdev->dev);
	142	}
	143
	144	static inline void platform_set_drvdata(struct platform_device pdev, void data)
	145	{
	146	dev_set_drvdata(&pdev->dev, data);
	147	}
00d3dcdd	148
ecdf6ceb DT	149	extern struct platform_device platform_create_bundle(struct platform_driver driver,
	150	int (probe)(struct platform_device ),
	151	struct resource *res, unsigned int n_res,
	152	const void *data, size_t size);
	153
13977091 MD	154	/* early platform driver interface */
	155	struct early_platform_driver {
	156	const char *class_str;
	157	struct platform_driver *pdrv;
	158	struct list_head list;
	159	int requested_id;
c60e0504 MD	160	char *buffer;
c60e0504 MD	161	int bufsize;
13977091 MD	162	};
	163
	164	#define EARLY_PLATFORM_ID_UNSET -2
	165	#define EARLY_PLATFORM_ID_ERROR -3
	166
	167	extern int early_platform_driver_register(struct early_platform_driver *epdrv,
	168	char *buf);
	169	extern void early_platform_add_devices(struct platform_device **devs, int num);
	170
	171	static inline int is_early_platform_device(struct platform_device *pdev)
	172	{
	173	return !pdev->dev.driver;
	174	}
	175
	176	extern void early_platform_driver_register_all(char *class_str);
	177	extern int early_platform_driver_probe(char *class_str,
	178	int nr_probe, int user_only);
	179	extern void early_platform_cleanup(void);
	180
c60e0504 MD	181	#define early_platform_init(class_string, platdrv) \
c60e0504 MD	182	early_platform_init_buffer(class_string, platdrv, NULL, 0)
13977091 MD	183
13977091 MD	184	#ifndef MODULE
c60e0504	185	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
13977091 MD	186	static __initdata struct early_platform_driver early_driver = { \
13977091 MD	187	.class_str = class_string, \
c60e0504 MD	188	.buffer = buf, \
	189	.bufsize = bufsiz, \
	190	.pdrv = platdrv, \
13977091 MD	191	.requested_id = EARLY_PLATFORM_ID_UNSET, \
13977091 MD	192	}; \
c60e0504	193	static int __init early_platform_driver_setup_func(char *buffer) \
13977091	194	{ \
c60e0504	195	return early_platform_driver_register(&early_driver, buffer); \
13977091 MD	196	} \
	197	early_param(class_string, early_platform_driver_setup_func)
	198	#else /* MODULE */
c60e0504 MD	199	#define early_platform_init_buffer(class_string, platdrv, buf, bufsiz) \
	200	static inline char *early_platform_driver_setup_func(void) \
	201	{ \
	202	return bufsiz ? buf : NULL; \
	203	}
13977091 MD	204	#endif /* MODULE */
13977091 MD	205
69c9dd1e RW	206	#ifdef CONFIG_PM_SLEEP
	207	extern int platform_pm_prepare(struct device *dev);
	208	extern void platform_pm_complete(struct device *dev);
	209	#else
	210	#define platform_pm_prepare NULL
	211	#define platform_pm_complete NULL
	212	#endif
	213
	214	#ifdef CONFIG_SUSPEND
	215	extern int platform_pm_suspend(struct device *dev);
	216	extern int platform_pm_suspend_noirq(struct device *dev);
	217	extern int platform_pm_resume(struct device *dev);
	218	extern int platform_pm_resume_noirq(struct device *dev);
	219	#else
	220	#define platform_pm_suspend NULL
	221	#define platform_pm_resume NULL
	222	#define platform_pm_suspend_noirq NULL
	223	#define platform_pm_resume_noirq NULL
	224	#endif
	225
	226	#ifdef CONFIG_HIBERNATE_CALLBACKS
	227	extern int platform_pm_freeze(struct device *dev);
	228	extern int platform_pm_freeze_noirq(struct device *dev);
	229	extern int platform_pm_thaw(struct device *dev);
	230	extern int platform_pm_thaw_noirq(struct device *dev);
	231	extern int platform_pm_poweroff(struct device *dev);
	232	extern int platform_pm_poweroff_noirq(struct device *dev);
	233	extern int platform_pm_restore(struct device *dev);
	234	extern int platform_pm_restore_noirq(struct device *dev);
	235	#else
	236	#define platform_pm_freeze NULL
	237	#define platform_pm_thaw NULL
	238	#define platform_pm_poweroff NULL
	239	#define platform_pm_restore NULL
	240	#define platform_pm_freeze_noirq NULL
	241	#define platform_pm_thaw_noirq NULL
	242	#define platform_pm_poweroff_noirq NULL
	243	#define platform_pm_restore_noirq NULL
	244	#endif
	245
	246	#ifdef CONFIG_PM_SLEEP
	247	#define USE_PLATFORM_PM_SLEEP_OPS \
	248	.prepare = platform_pm_prepare, \
	249	.complete = platform_pm_complete, \
	250	.suspend = platform_pm_suspend, \
	251	.resume = platform_pm_resume, \
	252	.freeze = platform_pm_freeze, \
	253	.thaw = platform_pm_thaw, \
	254	.poweroff = platform_pm_poweroff, \
	255	.restore = platform_pm_restore, \
	256	.suspend_noirq = platform_pm_suspend_noirq, \
	257	.resume_noirq = platform_pm_resume_noirq, \
	258	.freeze_noirq = platform_pm_freeze_noirq, \
	259	.thaw_noirq = platform_pm_thaw_noirq, \
	260	.poweroff_noirq = platform_pm_poweroff_noirq, \
	261	.restore_noirq = platform_pm_restore_noirq,
	262	#else
	263	#define USE_PLATFORM_PM_SLEEP_OPS
	264	#endif
	265
bbbf508d	266	#endif /* _PLATFORM_DEVICE_H_ */