[mirror_ubuntu-bionic-kernel.git] / drivers / base / power / generic_ops.c

/*
 * drivers/base/power/generic_ops.c - Generic PM callbacks for subsystems
 *
 * Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
 *
 * This file is released under the GPLv2.
 */

#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <linux/export.h>

#ifdef CONFIG_PM
/**
 * pm_generic_runtime_suspend - Generic runtime suspend callback for subsystems.
 * @dev: Device to suspend.
 *
 * If PM operations are defined for the @dev's driver and they include
 * ->runtime_suspend(), execute it and return its error code.  Otherwise,
 * return 0.
 */
int pm_generic_runtime_suspend(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	int ret;

	ret = pm && pm->runtime_suspend ? pm->runtime_suspend(dev) : 0;

	return ret;
}
EXPORT_SYMBOL_GPL(pm_generic_runtime_suspend);

/**
 * pm_generic_runtime_resume - Generic runtime resume callback for subsystems.
 * @dev: Device to resume.
 *
 * If PM operations are defined for the @dev's driver and they include
 * ->runtime_resume(), execute it and return its error code.  Otherwise,
 * return 0.
 */
int pm_generic_runtime_resume(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	int ret;

	ret = pm && pm->runtime_resume ? pm->runtime_resume(dev) : 0;

	return ret;
}
EXPORT_SYMBOL_GPL(pm_generic_runtime_resume);
#endif /* CONFIG_PM */

#ifdef CONFIG_PM_SLEEP
/**
 * pm_generic_prepare - Generic routine preparing a device for power transition.
 * @dev: Device to prepare.
 *
 * Prepare a device for a system-wide power transition.
 */
int pm_generic_prepare(struct device *dev)
{
	struct device_driver *drv = dev->driver;
	int ret = 0;

	if (drv && drv->pm && drv->pm->prepare)
		ret = drv->pm->prepare(dev);

	return ret;
}

/**
 * pm_generic_suspend_noirq - Generic suspend_noirq callback for subsystems.
 * @dev: Device to suspend.
 */
int pm_generic_suspend_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->suspend_noirq ? pm->suspend_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_suspend_noirq);

/**
 * pm_generic_suspend_late - Generic suspend_late callback for subsystems.
 * @dev: Device to suspend.
 */
int pm_generic_suspend_late(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->suspend_late ? pm->suspend_late(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_suspend_late);

/**
 * pm_generic_suspend - Generic suspend callback for subsystems.
 * @dev: Device to suspend.
 */
int pm_generic_suspend(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->suspend ? pm->suspend(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_suspend);

/**
 * pm_generic_freeze_noirq - Generic freeze_noirq callback for subsystems.
 * @dev: Device to freeze.
 */
int pm_generic_freeze_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->freeze_noirq ? pm->freeze_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_freeze_noirq);

/**
 * pm_generic_freeze_late - Generic freeze_late callback for subsystems.
 * @dev: Device to freeze.
 */
int pm_generic_freeze_late(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->freeze_late ? pm->freeze_late(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_freeze_late);

/**
 * pm_generic_freeze - Generic freeze callback for subsystems.
 * @dev: Device to freeze.
 */
int pm_generic_freeze(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->freeze ? pm->freeze(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_freeze);

/**
 * pm_generic_poweroff_noirq - Generic poweroff_noirq callback for subsystems.
 * @dev: Device to handle.
 */
int pm_generic_poweroff_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->poweroff_noirq ? pm->poweroff_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_poweroff_noirq);

/**
 * pm_generic_poweroff_late - Generic poweroff_late callback for subsystems.
 * @dev: Device to handle.
 */
int pm_generic_poweroff_late(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->poweroff_late ? pm->poweroff_late(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_poweroff_late);

/**
 * pm_generic_poweroff - Generic poweroff callback for subsystems.
 * @dev: Device to handle.
 */
int pm_generic_poweroff(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->poweroff ? pm->poweroff(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_poweroff);

/**
 * pm_generic_thaw_noirq - Generic thaw_noirq callback for subsystems.
 * @dev: Device to thaw.
 */
int pm_generic_thaw_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->thaw_noirq ? pm->thaw_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_thaw_noirq);

/**
 * pm_generic_thaw_early - Generic thaw_early callback for subsystems.
 * @dev: Device to thaw.
 */
int pm_generic_thaw_early(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->thaw_early ? pm->thaw_early(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_thaw_early);

/**
 * pm_generic_thaw - Generic thaw callback for subsystems.
 * @dev: Device to thaw.
 */
int pm_generic_thaw(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->thaw ? pm->thaw(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_thaw);

/**
 * pm_generic_resume_noirq - Generic resume_noirq callback for subsystems.
 * @dev: Device to resume.
 */
int pm_generic_resume_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->resume_noirq ? pm->resume_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_resume_noirq);

/**
 * pm_generic_resume_early - Generic resume_early callback for subsystems.
 * @dev: Device to resume.
 */
int pm_generic_resume_early(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->resume_early ? pm->resume_early(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_resume_early);

/**
 * pm_generic_resume - Generic resume callback for subsystems.
 * @dev: Device to resume.
 */
int pm_generic_resume(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->resume ? pm->resume(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_resume);

/**
 * pm_generic_restore_noirq - Generic restore_noirq callback for subsystems.
 * @dev: Device to restore.
 */
int pm_generic_restore_noirq(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->restore_noirq ? pm->restore_noirq(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_restore_noirq);

/**
 * pm_generic_restore_early - Generic restore_early callback for subsystems.
 * @dev: Device to resume.
 */
int pm_generic_restore_early(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->restore_early ? pm->restore_early(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_restore_early);

/**
 * pm_generic_restore - Generic restore callback for subsystems.
 * @dev: Device to restore.
 */
int pm_generic_restore(struct device *dev)
{
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

	return pm && pm->restore ? pm->restore(dev) : 0;
}
EXPORT_SYMBOL_GPL(pm_generic_restore);

/**
 * pm_generic_complete - Generic routine completing a device power transition.
 * @dev: Device to handle.
 *
 * Complete a device power transition during a system-wide power transition.
 */
void pm_generic_complete(struct device *dev)
{
	struct device_driver *drv = dev->driver;

	if (drv && drv->pm && drv->pm->complete)
		drv->pm->complete(dev);
}
#endif /* CONFIG_PM_SLEEP */
Commit	Line	Data
d690b2cd RW	1	/*
	2	* drivers/base/power/generic_ops.c - Generic PM callbacks for subsystems
	3	*
	4	* Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
	5	*
	6	* This file is released under the GPLv2.
	7	*/
	8
	9	#include <linux/pm.h>
	10	#include <linux/pm_runtime.h>
1b6bc32f	11	#include <linux/export.h>
d690b2cd	12
717e5d45	13	#ifdef CONFIG_PM
d690b2cd RW	14	/**
	15	* pm_generic_runtime_suspend - Generic runtime suspend callback for subsystems.
	16	* @dev: Device to suspend.
	17	*
	18	* If PM operations are defined for the @dev's driver and they include
	19	* ->runtime_suspend(), execute it and return its error code. Otherwise,
6675bc05	20	* return 0.
d690b2cd RW	21	*/
	22	int pm_generic_runtime_suspend(struct device *dev)
	23	{
	24	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	25	int ret;
	26
05aa55dd	27	ret = pm && pm->runtime_suspend ? pm->runtime_suspend(dev) : 0;
d690b2cd RW	28
	29	return ret;
	30	}
	31	EXPORT_SYMBOL_GPL(pm_generic_runtime_suspend);
	32
	33	/**
	34	* pm_generic_runtime_resume - Generic runtime resume callback for subsystems.
	35	* @dev: Device to resume.
	36	*
	37	* If PM operations are defined for the @dev's driver and they include
	38	* ->runtime_resume(), execute it and return its error code. Otherwise,
6675bc05	39	* return 0.
d690b2cd RW	40	*/
	41	int pm_generic_runtime_resume(struct device *dev)
	42	{
	43	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	44	int ret;
	45
05aa55dd	46	ret = pm && pm->runtime_resume ? pm->runtime_resume(dev) : 0;
d690b2cd RW	47
	48	return ret;
	49	}
	50	EXPORT_SYMBOL_GPL(pm_generic_runtime_resume);
717e5d45	51	#endif /* CONFIG_PM */
d690b2cd RW	52
d690b2cd RW	53	#ifdef CONFIG_PM_SLEEP
6538df80 RW	54	/**
	55	* pm_generic_prepare - Generic routine preparing a device for power transition.
	56	* @dev: Device to prepare.
	57	*
	58	* Prepare a device for a system-wide power transition.
	59	*/
	60	int pm_generic_prepare(struct device *dev)
	61	{
	62	struct device_driver *drv = dev->driver;
	63	int ret = 0;
	64
	65	if (drv && drv->pm && drv->pm->prepare)
	66	ret = drv->pm->prepare(dev);
	67
	68	return ret;
	69	}
	70
d690b2cd	71	/**
e470d066 RW	72	* pm_generic_suspend_noirq - Generic suspend_noirq callback for subsystems.
e470d066 RW	73	* @dev: Device to suspend.
d690b2cd	74	*/
e470d066	75	int pm_generic_suspend_noirq(struct device *dev)
d690b2cd RW	76	{
d690b2cd RW	77	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
d690b2cd	78
e470d066	79	return pm && pm->suspend_noirq ? pm->suspend_noirq(dev) : 0;
d690b2cd	80	}
e470d066	81	EXPORT_SYMBOL_GPL(pm_generic_suspend_noirq);
d690b2cd	82
e5291928	83	/**
e470d066	84	* pm_generic_suspend_late - Generic suspend_late callback for subsystems.
e5291928 RW	85	* @dev: Device to suspend.
e5291928 RW	86	*/
e470d066	87	int pm_generic_suspend_late(struct device *dev)
e5291928	88	{
e470d066 RW	89	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	90
	91	return pm && pm->suspend_late ? pm->suspend_late(dev) : 0;
e5291928	92	}
e470d066	93	EXPORT_SYMBOL_GPL(pm_generic_suspend_late);
e5291928	94
d690b2cd RW	95	/**
	96	* pm_generic_suspend - Generic suspend callback for subsystems.
	97	* @dev: Device to suspend.
	98	*/
	99	int pm_generic_suspend(struct device *dev)
	100	{
e470d066 RW	101	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	102
	103	return pm && pm->suspend ? pm->suspend(dev) : 0;
d690b2cd RW	104	}
	105	EXPORT_SYMBOL_GPL(pm_generic_suspend);
	106
e5291928 RW	107	/**
	108	* pm_generic_freeze_noirq - Generic freeze_noirq callback for subsystems.
	109	* @dev: Device to freeze.
	110	*/
	111	int pm_generic_freeze_noirq(struct device *dev)
	112	{
e470d066 RW	113	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	114
	115	return pm && pm->freeze_noirq ? pm->freeze_noirq(dev) : 0;
e5291928 RW	116	}
	117	EXPORT_SYMBOL_GPL(pm_generic_freeze_noirq);
	118
e470d066 RW	119	/**
	120	* pm_generic_freeze_late - Generic freeze_late callback for subsystems.
	121	* @dev: Device to freeze.
	122	*/
	123	int pm_generic_freeze_late(struct device *dev)
	124	{
	125	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	126
	127	return pm && pm->freeze_late ? pm->freeze_late(dev) : 0;
	128	}
	129	EXPORT_SYMBOL_GPL(pm_generic_freeze_late);
	130
d690b2cd RW	131	/**
	132	* pm_generic_freeze - Generic freeze callback for subsystems.
	133	* @dev: Device to freeze.
	134	*/
	135	int pm_generic_freeze(struct device *dev)
	136	{
e470d066 RW	137	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	138
	139	return pm && pm->freeze ? pm->freeze(dev) : 0;
d690b2cd RW	140	}
	141	EXPORT_SYMBOL_GPL(pm_generic_freeze);
	142
e5291928 RW	143	/**
	144	* pm_generic_poweroff_noirq - Generic poweroff_noirq callback for subsystems.
	145	* @dev: Device to handle.
	146	*/
	147	int pm_generic_poweroff_noirq(struct device *dev)
	148	{
e470d066 RW	149	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	150
	151	return pm && pm->poweroff_noirq ? pm->poweroff_noirq(dev) : 0;
e5291928 RW	152	}
	153	EXPORT_SYMBOL_GPL(pm_generic_poweroff_noirq);
	154
e470d066 RW	155	/**
	156	* pm_generic_poweroff_late - Generic poweroff_late callback for subsystems.
	157	* @dev: Device to handle.
	158	*/
	159	int pm_generic_poweroff_late(struct device *dev)
	160	{
	161	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	162
	163	return pm && pm->poweroff_late ? pm->poweroff_late(dev) : 0;
	164	}
	165	EXPORT_SYMBOL_GPL(pm_generic_poweroff_late);
	166
d690b2cd RW	167	/**
	168	* pm_generic_poweroff - Generic poweroff callback for subsystems.
	169	* @dev: Device to handle.
	170	*/
	171	int pm_generic_poweroff(struct device *dev)
	172	{
e470d066 RW	173	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	174
	175	return pm && pm->poweroff ? pm->poweroff(dev) : 0;
d690b2cd RW	176	}
	177	EXPORT_SYMBOL_GPL(pm_generic_poweroff);
	178
e5291928 RW	179	/**
	180	* pm_generic_thaw_noirq - Generic thaw_noirq callback for subsystems.
	181	* @dev: Device to thaw.
	182	*/
	183	int pm_generic_thaw_noirq(struct device *dev)
	184	{
e470d066 RW	185	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	186
	187	return pm && pm->thaw_noirq ? pm->thaw_noirq(dev) : 0;
e5291928 RW	188	}
	189	EXPORT_SYMBOL_GPL(pm_generic_thaw_noirq);
	190
e470d066 RW	191	/**
	192	* pm_generic_thaw_early - Generic thaw_early callback for subsystems.
	193	* @dev: Device to thaw.
	194	*/
	195	int pm_generic_thaw_early(struct device *dev)
	196	{
	197	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	198
	199	return pm && pm->thaw_early ? pm->thaw_early(dev) : 0;
	200	}
	201	EXPORT_SYMBOL_GPL(pm_generic_thaw_early);
	202
d690b2cd RW	203	/**
	204	* pm_generic_thaw - Generic thaw callback for subsystems.
	205	* @dev: Device to thaw.
	206	*/
	207	int pm_generic_thaw(struct device *dev)
	208	{
e470d066 RW	209	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	210
	211	return pm && pm->thaw ? pm->thaw(dev) : 0;
d690b2cd RW	212	}
	213	EXPORT_SYMBOL_GPL(pm_generic_thaw);
	214
e5291928 RW	215	/**
	216	* pm_generic_resume_noirq - Generic resume_noirq callback for subsystems.
	217	* @dev: Device to resume.
	218	*/
	219	int pm_generic_resume_noirq(struct device *dev)
	220	{
e470d066 RW	221	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	222
	223	return pm && pm->resume_noirq ? pm->resume_noirq(dev) : 0;
e5291928 RW	224	}
	225	EXPORT_SYMBOL_GPL(pm_generic_resume_noirq);
	226
e470d066 RW	227	/**
	228	* pm_generic_resume_early - Generic resume_early callback for subsystems.
	229	* @dev: Device to resume.
	230	*/
	231	int pm_generic_resume_early(struct device *dev)
	232	{
	233	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	234
	235	return pm && pm->resume_early ? pm->resume_early(dev) : 0;
	236	}
	237	EXPORT_SYMBOL_GPL(pm_generic_resume_early);
	238
d690b2cd RW	239	/**
	240	* pm_generic_resume - Generic resume callback for subsystems.
	241	* @dev: Device to resume.
	242	*/
	243	int pm_generic_resume(struct device *dev)
	244	{
e470d066 RW	245	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	246
	247	return pm && pm->resume ? pm->resume(dev) : 0;
d690b2cd RW	248	}
	249	EXPORT_SYMBOL_GPL(pm_generic_resume);
	250
e5291928 RW	251	/**
	252	* pm_generic_restore_noirq - Generic restore_noirq callback for subsystems.
	253	* @dev: Device to restore.
	254	*/
	255	int pm_generic_restore_noirq(struct device *dev)
	256	{
e470d066 RW	257	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	258
	259	return pm && pm->restore_noirq ? pm->restore_noirq(dev) : 0;
e5291928 RW	260	}
	261	EXPORT_SYMBOL_GPL(pm_generic_restore_noirq);
	262
e470d066 RW	263	/**
	264	* pm_generic_restore_early - Generic restore_early callback for subsystems.
	265	* @dev: Device to resume.
	266	*/
	267	int pm_generic_restore_early(struct device *dev)
	268	{
	269	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	270
	271	return pm && pm->restore_early ? pm->restore_early(dev) : 0;
	272	}
	273	EXPORT_SYMBOL_GPL(pm_generic_restore_early);
	274
d690b2cd RW	275	/**
	276	* pm_generic_restore - Generic restore callback for subsystems.
	277	* @dev: Device to restore.
	278	*/
	279	int pm_generic_restore(struct device *dev)
	280	{
e470d066 RW	281	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	282
	283	return pm && pm->restore ? pm->restore(dev) : 0;
d690b2cd RW	284	}
d690b2cd RW	285	EXPORT_SYMBOL_GPL(pm_generic_restore);
6538df80 RW	286
6538df80 RW	287	/**
9accff57	288	* pm_generic_complete - Generic routine completing a device power transition.
6538df80 RW	289	* @dev: Device to handle.
	290	*
	291	* Complete a device power transition during a system-wide power transition.
	292	*/
	293	void pm_generic_complete(struct device *dev)
	294	{
	295	struct device_driver *drv = dev->driver;
	296
	297	if (drv && drv->pm && drv->pm->complete)
	298	drv->pm->complete(dev);
6538df80	299	}
d690b2cd	300	#endif /* CONFIG_PM_SLEEP */