[mirror_ubuntu-bionic-kernel.git] / drivers / cpuidle / cpuidle.c

/*
 * cpuidle.c - core cpuidle infrastructure
 *
 * (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
 *               Shaohua Li <shaohua.li@intel.com>
 *               Adam Belay <abelay@novell.com>
 *
 * This code is licenced under the GPL.
 */

#include <linux/clockchips.h>
#include <linux/kernel.h>
#include <linux/mutex.h>
#include <linux/sched.h>
#include <linux/notifier.h>
#include <linux/pm_qos.h>
#include <linux/cpu.h>
#include <linux/cpuidle.h>
#include <linux/ktime.h>
#include <linux/hrtimer.h>
#include <linux/module.h>
#include <trace/events/power.h>

#include "cpuidle.h"

DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
DEFINE_PER_CPU(struct cpuidle_device, cpuidle_dev);

DEFINE_MUTEX(cpuidle_lock);
LIST_HEAD(cpuidle_detected_devices);

static int enabled_devices;
static int off __read_mostly;
static int initialized __read_mostly;

int cpuidle_disabled(void)
{
	return off;
}
void disable_cpuidle(void)
{
	off = 1;
}

static int __cpuidle_register_device(struct cpuidle_device *dev);

/**
 * cpuidle_play_dead - cpu off-lining
 *
 * Returns in case of an error or no driver
 */
int cpuidle_play_dead(void)
{
	struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
	int i;

	if (!drv)
		return -ENODEV;

	/* Find lowest-power state that supports long-term idle */
	for (i = drv->state_count - 1; i >= CPUIDLE_DRIVER_STATE_START; i--)
		if (drv->states[i].enter_dead)
			return drv->states[i].enter_dead(dev, i);

	return -ENODEV;
}

/**
 * cpuidle_enter_state - enter the state and update stats
 * @dev: cpuidle device for this cpu
 * @drv: cpuidle driver for this cpu
 * @next_state: index into drv->states of the state to enter
 */
int cpuidle_enter_state(struct cpuidle_device *dev, struct cpuidle_driver *drv,
			int index)
{
	int entered_state;

	struct cpuidle_state *target_state = &drv->states[index];
	ktime_t time_start, time_end;
	s64 diff;

	time_start = ktime_get();

	entered_state = target_state->enter(dev, drv, index);

	time_end = ktime_get();

	local_irq_enable();

	diff = ktime_to_us(ktime_sub(time_end, time_start));
	if (diff > INT_MAX)
		diff = INT_MAX;

	dev->last_residency = (int) diff;

	if (entered_state >= 0) {
		/* Update cpuidle counters */
		/* This can be moved to within driver enter routine
		 * but that results in multiple copies of same code.
		 */
		dev->states_usage[entered_state].time += dev->last_residency;
		dev->states_usage[entered_state].usage++;
	} else {
		dev->last_residency = 0;
	}

	return entered_state;
}

/**
 * cpuidle_idle_call - the main idle loop
 *
 * NOTE: no locks or semaphores should be used here
 * return non-zero on failure
 */
int cpuidle_idle_call(void)
{
	struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
	struct cpuidle_driver *drv;
	int next_state, entered_state;

	if (off)
		return -ENODEV;

	if (!initialized)
		return -ENODEV;

	/* check if the device is ready */
	if (!dev || !dev->enabled)
		return -EBUSY;

	drv = cpuidle_get_cpu_driver(dev);

	/* ask the governor for the next state */
	next_state = cpuidle_curr_governor->select(drv, dev);
	if (need_resched()) {
		dev->last_residency = 0;
		/* give the governor an opportunity to reflect on the outcome */
		if (cpuidle_curr_governor->reflect)
			cpuidle_curr_governor->reflect(dev, next_state);
		local_irq_enable();
		return 0;
	}

	trace_cpu_idle_rcuidle(next_state, dev->cpu);

	if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
		clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_ENTER,
				   &dev->cpu);

	if (cpuidle_state_is_coupled(dev, drv, next_state))
		entered_state = cpuidle_enter_state_coupled(dev, drv,
							    next_state);
	else
		entered_state = cpuidle_enter_state(dev, drv, next_state);

	if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
		clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_EXIT,
				   &dev->cpu);

	trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);

	/* give the governor an opportunity to reflect on the outcome */
	if (cpuidle_curr_governor->reflect)
		cpuidle_curr_governor->reflect(dev, entered_state);

	return 0;
}

/**
 * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
 */
void cpuidle_install_idle_handler(void)
{
	if (enabled_devices) {
		/* Make sure all changes finished before we switch to new idle */
		smp_wmb();
		initialized = 1;
	}
}

/**
 * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
 */
void cpuidle_uninstall_idle_handler(void)
{
	if (enabled_devices) {
		initialized = 0;
		kick_all_cpus_sync();
	}
}

/**
 * cpuidle_pause_and_lock - temporarily disables CPUIDLE
 */
void cpuidle_pause_and_lock(void)
{
	mutex_lock(&cpuidle_lock);
	cpuidle_uninstall_idle_handler();
}

EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);

/**
 * cpuidle_resume_and_unlock - resumes CPUIDLE operation
 */
void cpuidle_resume_and_unlock(void)
{
	cpuidle_install_idle_handler();
	mutex_unlock(&cpuidle_lock);
}

EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);

/* Currently used in suspend/resume path to suspend cpuidle */
void cpuidle_pause(void)
{
	mutex_lock(&cpuidle_lock);
	cpuidle_uninstall_idle_handler();
	mutex_unlock(&cpuidle_lock);
}

/* Currently used in suspend/resume path to resume cpuidle */
void cpuidle_resume(void)
{
	mutex_lock(&cpuidle_lock);
	cpuidle_install_idle_handler();
	mutex_unlock(&cpuidle_lock);
}

#ifdef CONFIG_ARCH_HAS_CPU_RELAX
static int poll_idle(struct cpuidle_device *dev,
		struct cpuidle_driver *drv, int index)
{
	ktime_t	t1, t2;
	s64 diff;

	t1 = ktime_get();
	local_irq_enable();
	while (!need_resched())
		cpu_relax();

	t2 = ktime_get();
	diff = ktime_to_us(ktime_sub(t2, t1));
	if (diff > INT_MAX)
		diff = INT_MAX;

	dev->last_residency = (int) diff;

	return index;
}

static void poll_idle_init(struct cpuidle_driver *drv)
{
	struct cpuidle_state *state = &drv->states[0];

	snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
	snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
	state->exit_latency = 0;
	state->target_residency = 0;
	state->power_usage = -1;
	state->flags = 0;
	state->enter = poll_idle;
	state->disabled = false;
}
#else
static void poll_idle_init(struct cpuidle_driver *drv) {}
#endif /* CONFIG_ARCH_HAS_CPU_RELAX */

/**
 * cpuidle_enable_device - enables idle PM for a CPU
 * @dev: the CPU
 *
 * This function must be called between cpuidle_pause_and_lock and
 * cpuidle_resume_and_unlock when used externally.
 */
int cpuidle_enable_device(struct cpuidle_device *dev)
{
	int ret, i;
	struct cpuidle_driver *drv;

	if (!dev)
		return -EINVAL;

	if (dev->enabled)
		return 0;

	drv = cpuidle_get_cpu_driver(dev);

	if (!drv || !cpuidle_curr_governor)
		return -EIO;

	if (!dev->registered)
		return -EINVAL;

	if (!dev->state_count)
		dev->state_count = drv->state_count;

	poll_idle_init(drv);

	ret = cpuidle_add_device_sysfs(dev);
	if (ret)
		return ret;

	if (cpuidle_curr_governor->enable &&
	    (ret = cpuidle_curr_governor->enable(drv, dev)))
		goto fail_sysfs;

	for (i = 0; i < dev->state_count; i++) {
		dev->states_usage[i].usage = 0;
		dev->states_usage[i].time = 0;
	}
	dev->last_residency = 0;

	smp_wmb();

	dev->enabled = 1;

	enabled_devices++;
	return 0;

fail_sysfs:
	cpuidle_remove_device_sysfs(dev);

	return ret;
}

EXPORT_SYMBOL_GPL(cpuidle_enable_device);

/**
 * cpuidle_disable_device - disables idle PM for a CPU
 * @dev: the CPU
 *
 * This function must be called between cpuidle_pause_and_lock and
 * cpuidle_resume_and_unlock when used externally.
 */
void cpuidle_disable_device(struct cpuidle_device *dev)
{
	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);

	if (!dev || !dev->enabled)
		return;

	if (!drv || !cpuidle_curr_governor)
		return;

	dev->enabled = 0;

	if (cpuidle_curr_governor->disable)
		cpuidle_curr_governor->disable(drv, dev);

	cpuidle_remove_device_sysfs(dev);
	enabled_devices--;
}

EXPORT_SYMBOL_GPL(cpuidle_disable_device);

/**
 * __cpuidle_register_device - internal register function called before register
 * and enable routines
 * @dev: the cpu
 *
 * cpuidle_lock mutex must be held before this is called
 */
static int __cpuidle_register_device(struct cpuidle_device *dev)
{
	int ret;
	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);

	if (!try_module_get(drv->owner))
		return -EINVAL;

	per_cpu(cpuidle_devices, dev->cpu) = dev;
	list_add(&dev->device_list, &cpuidle_detected_devices);
	ret = cpuidle_add_sysfs(dev);
	if (ret)
		goto err_sysfs;

	ret = cpuidle_coupled_register_device(dev);
	if (ret)
		goto err_coupled;

	dev->registered = 1;
	return 0;

err_coupled:
	cpuidle_remove_sysfs(dev);
err_sysfs:
	list_del(&dev->device_list);
	per_cpu(cpuidle_devices, dev->cpu) = NULL;
	module_put(drv->owner);
	return ret;
}

/**
 * cpuidle_register_device - registers a CPU's idle PM feature
 * @dev: the cpu
 */
int cpuidle_register_device(struct cpuidle_device *dev)
{
	int ret;

	if (!dev)
		return -EINVAL;

	mutex_lock(&cpuidle_lock);

	if ((ret = __cpuidle_register_device(dev))) {
		mutex_unlock(&cpuidle_lock);
		return ret;
	}

	ret = cpuidle_enable_device(dev);
	if (ret) {
		mutex_unlock(&cpuidle_lock);
		return ret;
	}

	cpuidle_install_idle_handler();

	mutex_unlock(&cpuidle_lock);

	return 0;
}

EXPORT_SYMBOL_GPL(cpuidle_register_device);

/**
 * cpuidle_unregister_device - unregisters a CPU's idle PM feature
 * @dev: the cpu
 */
void cpuidle_unregister_device(struct cpuidle_device *dev)
{
	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);

	if (dev->registered == 0)
		return;

	cpuidle_pause_and_lock();

	cpuidle_disable_device(dev);

	cpuidle_remove_sysfs(dev);
	list_del(&dev->device_list);
	per_cpu(cpuidle_devices, dev->cpu) = NULL;

	cpuidle_coupled_unregister_device(dev);

	cpuidle_resume_and_unlock();

	module_put(drv->owner);
}

EXPORT_SYMBOL_GPL(cpuidle_unregister_device);

/**
 * cpuidle_unregister: unregister a driver and the devices. This function
 * can be used only if the driver has been previously registered through
 * the cpuidle_register function.
 *
 * @drv: a valid pointer to a struct cpuidle_driver
 */
void cpuidle_unregister(struct cpuidle_driver *drv)
{
	int cpu;
	struct cpuidle_device *device;

	for_each_cpu(cpu, drv->cpumask) {
		device = &per_cpu(cpuidle_dev, cpu);
		cpuidle_unregister_device(device);
	}

	cpuidle_unregister_driver(drv);
}
EXPORT_SYMBOL_GPL(cpuidle_unregister);

/**
 * cpuidle_register: registers the driver and the cpu devices with the
 * coupled_cpus passed as parameter. This function is used for all common
 * initialization pattern there are in the arch specific drivers. The
 * devices is globally defined in this file.
 *
 * @drv         : a valid pointer to a struct cpuidle_driver
 * @coupled_cpus: a cpumask for the coupled states
 *
 * Returns 0 on success, < 0 otherwise
 */
int cpuidle_register(struct cpuidle_driver *drv,
		     const struct cpumask *const coupled_cpus)
{
	int ret, cpu;
	struct cpuidle_device *device;

	ret = cpuidle_register_driver(drv);
	if (ret) {
		pr_err("failed to register cpuidle driver\n");
		return ret;
	}

	for_each_cpu(cpu, drv->cpumask) {
		device = &per_cpu(cpuidle_dev, cpu);
		device->cpu = cpu;

#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
		/*
		 * On multiplatform for ARM, the coupled idle states could
		 * enabled in the kernel even if the cpuidle driver does not
		 * use it. Note, coupled_cpus is a struct copy.
		 */
		if (coupled_cpus)
			device->coupled_cpus = *coupled_cpus;
#endif
		ret = cpuidle_register_device(device);
		if (!ret)
			continue;

		pr_err("Failed to register cpuidle device for cpu%d\n", cpu);

		cpuidle_unregister(drv);
		break;
	}

	return ret;
}
EXPORT_SYMBOL_GPL(cpuidle_register);

#ifdef CONFIG_SMP

static void smp_callback(void *v)
{
	/* we already woke the CPU up, nothing more to do */
}

/*
 * This function gets called when a part of the kernel has a new latency
 * requirement.  This means we need to get all processors out of their C-state,
 * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
 * wakes them all right up.
 */
static int cpuidle_latency_notify(struct notifier_block *b,
		unsigned long l, void *v)
{
	smp_call_function(smp_callback, NULL, 1);
	return NOTIFY_OK;
}

static struct notifier_block cpuidle_latency_notifier = {
	.notifier_call = cpuidle_latency_notify,
};

static inline void latency_notifier_init(struct notifier_block *n)
{
	pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
}

#else /* CONFIG_SMP */

#define latency_notifier_init(x) do { } while (0)

#endif /* CONFIG_SMP */

/**
 * cpuidle_init - core initializer
 */
static int __init cpuidle_init(void)
{
	int ret;

	if (cpuidle_disabled())
		return -ENODEV;

	ret = cpuidle_add_interface(cpu_subsys.dev_root);
	if (ret)
		return ret;

	latency_notifier_init(&cpuidle_latency_notifier);

	return 0;
}

module_param(off, int, 0444);
core_initcall(cpuidle_init);
Commit	Line	Data
4f86d3a8 LB	1	/*
	2	* cpuidle.c - core cpuidle infrastructure
	3	*
	4	* (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
	5	* Shaohua Li <shaohua.li@intel.com>
	6	* Adam Belay <abelay@novell.com>
	7	*
	8	* This code is licenced under the GPL.
	9	*/
	10
b60e6a0e	11	#include <linux/clockchips.h>
4f86d3a8 LB	12	#include <linux/kernel.h>
	13	#include <linux/mutex.h>
	14	#include <linux/sched.h>
	15	#include <linux/notifier.h>
e8db0be1	16	#include <linux/pm_qos.h>
4f86d3a8 LB	17	#include <linux/cpu.h>
4f86d3a8 LB	18	#include <linux/cpuidle.h>
9a0b8415	19	#include <linux/ktime.h>
2e94d1f7	20	#include <linux/hrtimer.h>
884b17e1	21	#include <linux/module.h>
288f023e	22	#include <trace/events/power.h>
4f86d3a8 LB	23
	24	#include "cpuidle.h"
	25
	26	DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
4c637b21	27	DEFINE_PER_CPU(struct cpuidle_device, cpuidle_dev);
4f86d3a8 LB	28
	29	DEFINE_MUTEX(cpuidle_lock);
	30	LIST_HEAD(cpuidle_detected_devices);
4f86d3a8 LB	31
4f86d3a8 LB	32	static int enabled_devices;
62027aea	33	static int off __read_mostly;
a0bfa137	34	static int initialized __read_mostly;
62027aea LB	35
	36	int cpuidle_disabled(void)
	37	{
	38	return off;
	39	}
d91ee586 LB	40	void disable_cpuidle(void)
	41	{
	42	off = 1;
	43	}
4f86d3a8	44
dcb84f33 VP	45	static int __cpuidle_register_device(struct cpuidle_device *dev);
dcb84f33 VP	46
1a022e3f BO	47	/**
	48	* cpuidle_play_dead - cpu off-lining
	49	*
ee01e663	50	* Returns in case of an error or no driver
1a022e3f BO	51	*/
	52	int cpuidle_play_dead(void)
	53	{
	54	struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
bf4d1b5d	55	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
8aef33a7	56	int i;
1a022e3f	57
ee01e663 TK	58	if (!drv)
	59	return -ENODEV;
	60
1a022e3f	61	/* Find lowest-power state that supports long-term idle */
8aef33a7 DL	62	for (i = drv->state_count - 1; i >= CPUIDLE_DRIVER_STATE_START; i--)
	63	if (drv->states[i].enter_dead)
	64	return drv->states[i].enter_dead(dev, i);
1a022e3f BO	65
	66	return -ENODEV;
	67	}
	68
56cfbf74 CC	69	/**
	70	* cpuidle_enter_state - enter the state and update stats
	71	* @dev: cpuidle device for this cpu
	72	* @drv: cpuidle driver for this cpu
	73	* @next_state: index into drv->states of the state to enter
	74	*/
	75	int cpuidle_enter_state(struct cpuidle_device dev, struct cpuidle_driver drv,
554c06ba	76	int index)
56cfbf74 CC	77	{
	78	int entered_state;
	79
554c06ba DL	80	struct cpuidle_state *target_state = &drv->states[index];
	81	ktime_t time_start, time_end;
	82	s64 diff;
	83
	84	time_start = ktime_get();
	85
	86	entered_state = target_state->enter(dev, drv, index);
	87
	88	time_end = ktime_get();
	89
	90	local_irq_enable();
	91
	92	diff = ktime_to_us(ktime_sub(time_end, time_start));
	93	if (diff > INT_MAX)
	94	diff = INT_MAX;
	95
	96	dev->last_residency = (int) diff;
56cfbf74 CC	97
	98	if (entered_state >= 0) {
	99	/* Update cpuidle counters */
	100	/* This can be moved to within driver enter routine
	101	* but that results in multiple copies of same code.
	102	*/
a474a515	103	dev->states_usage[entered_state].time += dev->last_residency;
56cfbf74 CC	104	dev->states_usage[entered_state].usage++;
	105	} else {
	106	dev->last_residency = 0;
	107	}
	108
	109	return entered_state;
	110	}
	111
4f86d3a8 LB	112	/**
	113	* cpuidle_idle_call - the main idle loop
	114	*
	115	* NOTE: no locks or semaphores should be used here
a0bfa137	116	* return non-zero on failure
4f86d3a8	117	*/
a0bfa137	118	int cpuidle_idle_call(void)
4f86d3a8	119	{
4a6f4fe8	120	struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
bf4d1b5d	121	struct cpuidle_driver *drv;
e978aa7d	122	int next_state, entered_state;
4f86d3a8	123
a0bfa137 LB	124	if (off)
	125	return -ENODEV;
	126
	127	if (!initialized)
	128	return -ENODEV;
	129
4f86d3a8	130	/* check if the device is ready */
a0bfa137 LB	131	if (!dev \|\| !dev->enabled)
a0bfa137 LB	132	return -EBUSY;
4f86d3a8	133
bf4d1b5d DL	134	drv = cpuidle_get_cpu_driver(dev);
bf4d1b5d DL	135
4f86d3a8	136	/* ask the governor for the next state */
46bcfad7	137	next_state = cpuidle_curr_governor->select(drv, dev);
246eb7f0	138	if (need_resched()) {
d73d68dc YS	139	dev->last_residency = 0;
	140	/* give the governor an opportunity to reflect on the outcome */
	141	if (cpuidle_curr_governor->reflect)
	142	cpuidle_curr_governor->reflect(dev, next_state);
246eb7f0	143	local_irq_enable();
a0bfa137	144	return 0;
246eb7f0 KH	145	}
246eb7f0 KH	146
76027ea8	147	trace_cpu_idle_rcuidle(next_state, dev->cpu);
f77cfe4e	148
b60e6a0e DL	149	if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
	150	clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_ENTER,
	151	&dev->cpu);
	152
4126c019 CC	153	if (cpuidle_state_is_coupled(dev, drv, next_state))
	154	entered_state = cpuidle_enter_state_coupled(dev, drv,
	155	next_state);
	156	else
	157	entered_state = cpuidle_enter_state(dev, drv, next_state);
f77cfe4e	158
b60e6a0e DL	159	if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
	160	clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_EXIT,
	161	&dev->cpu);
	162
76027ea8	163	trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);
f77cfe4e	164
4f86d3a8 LB	165	/* give the governor an opportunity to reflect on the outcome */
4f86d3a8 LB	166	if (cpuidle_curr_governor->reflect)
e978aa7d	167	cpuidle_curr_governor->reflect(dev, entered_state);
a0bfa137 LB	168
a0bfa137 LB	169	return 0;
4f86d3a8 LB	170	}
	171
	172	/**
	173	* cpuidle_install_idle_handler - installs the cpuidle idle loop handler
	174	*/
	175	void cpuidle_install_idle_handler(void)
	176	{
a0bfa137	177	if (enabled_devices) {
4f86d3a8 LB	178	/* Make sure all changes finished before we switch to new idle */
4f86d3a8 LB	179	smp_wmb();
a0bfa137	180	initialized = 1;
4f86d3a8 LB	181	}
	182	}
	183
	184	/**
	185	* cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
	186	*/
	187	void cpuidle_uninstall_idle_handler(void)
	188	{
a0bfa137 LB	189	if (enabled_devices) {
a0bfa137 LB	190	initialized = 0;
4a162513	191	kick_all_cpus_sync();
4f86d3a8 LB	192	}
	193	}
	194
	195	/**
	196	* cpuidle_pause_and_lock - temporarily disables CPUIDLE
	197	*/
	198	void cpuidle_pause_and_lock(void)
	199	{
	200	mutex_lock(&cpuidle_lock);
	201	cpuidle_uninstall_idle_handler();
	202	}
	203
	204	EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);
	205
	206	/**
	207	* cpuidle_resume_and_unlock - resumes CPUIDLE operation
	208	*/
	209	void cpuidle_resume_and_unlock(void)
	210	{
	211	cpuidle_install_idle_handler();
	212	mutex_unlock(&cpuidle_lock);
	213	}
	214
	215	EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);
	216
8651f97b PM	217	/* Currently used in suspend/resume path to suspend cpuidle */
	218	void cpuidle_pause(void)
	219	{
	220	mutex_lock(&cpuidle_lock);
	221	cpuidle_uninstall_idle_handler();
	222	mutex_unlock(&cpuidle_lock);
	223	}
	224
	225	/* Currently used in suspend/resume path to resume cpuidle */
	226	void cpuidle_resume(void)
	227	{
	228	mutex_lock(&cpuidle_lock);
	229	cpuidle_install_idle_handler();
	230	mutex_unlock(&cpuidle_lock);
	231	}
	232
d8c216cf	233	#ifdef CONFIG_ARCH_HAS_CPU_RELAX
46bcfad7 DD	234	static int poll_idle(struct cpuidle_device *dev,
46bcfad7 DD	235	struct cpuidle_driver *drv, int index)
d8c216cf RW	236	{
	237	ktime_t t1, t2;
	238	s64 diff;
d8c216cf RW	239
	240	t1 = ktime_get();
	241	local_irq_enable();
	242	while (!need_resched())
	243	cpu_relax();
	244
	245	t2 = ktime_get();
	246	diff = ktime_to_us(ktime_sub(t2, t1));
	247	if (diff > INT_MAX)
	248	diff = INT_MAX;
	249
e978aa7d DD	250	dev->last_residency = (int) diff;
	251
	252	return index;
d8c216cf RW	253	}
d8c216cf RW	254
46bcfad7	255	static void poll_idle_init(struct cpuidle_driver *drv)
d8c216cf	256	{
46bcfad7	257	struct cpuidle_state *state = &drv->states[0];
d8c216cf	258
720f1c30	259	snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
d8c216cf RW	260	snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
	261	state->exit_latency = 0;
	262	state->target_residency = 0;
	263	state->power_usage = -1;
d247632c	264	state->flags = 0;
d8c216cf	265	state->enter = poll_idle;
cbc9ef02	266	state->disabled = false;
d8c216cf RW	267	}
d8c216cf RW	268	#else
46bcfad7	269	static void poll_idle_init(struct cpuidle_driver *drv) {}
d8c216cf RW	270	#endif /* CONFIG_ARCH_HAS_CPU_RELAX */
d8c216cf RW	271
4f86d3a8 LB	272	/**
	273	* cpuidle_enable_device - enables idle PM for a CPU
	274	* @dev: the CPU
	275	*
	276	* This function must be called between cpuidle_pause_and_lock and
	277	* cpuidle_resume_and_unlock when used externally.
	278	*/
	279	int cpuidle_enable_device(struct cpuidle_device *dev)
	280	{
	281	int ret, i;
bf4d1b5d	282	struct cpuidle_driver *drv;
4f86d3a8	283
1b0a0e9a SB	284	if (!dev)
	285	return -EINVAL;
	286
4f86d3a8 LB	287	if (dev->enabled)
4f86d3a8 LB	288	return 0;
bf4d1b5d DL	289
	290	drv = cpuidle_get_cpu_driver(dev);
	291
e1689795	292	if (!drv \|\| !cpuidle_curr_governor)
4f86d3a8	293	return -EIO;
bf4d1b5d	294
10b9d3f8 DL	295	if (!dev->registered)
	296	return -EINVAL;
	297
4f86d3a8	298	if (!dev->state_count)
fc850f39	299	dev->state_count = drv->state_count;
4f86d3a8	300
e1689795	301	poll_idle_init(drv);
d8c216cf	302
bf4d1b5d DL	303	ret = cpuidle_add_device_sysfs(dev);
bf4d1b5d DL	304	if (ret)
4f86d3a8 LB	305	return ret;
	306
	307	if (cpuidle_curr_governor->enable &&
e1689795	308	(ret = cpuidle_curr_governor->enable(drv, dev)))
4f86d3a8 LB	309	goto fail_sysfs;
	310
	311	for (i = 0; i < dev->state_count; i++) {
4202735e DD	312	dev->states_usage[i].usage = 0;
4202735e DD	313	dev->states_usage[i].time = 0;
4f86d3a8 LB	314	}
4f86d3a8 LB	315	dev->last_residency = 0;
4f86d3a8 LB	316
	317	smp_wmb();
	318
	319	dev->enabled = 1;
	320
	321	enabled_devices++;
	322	return 0;
	323
	324	fail_sysfs:
bf4d1b5d	325	cpuidle_remove_device_sysfs(dev);
4f86d3a8 LB	326
	327	return ret;
	328	}
	329
	330	EXPORT_SYMBOL_GPL(cpuidle_enable_device);
	331
	332	/**
	333	* cpuidle_disable_device - disables idle PM for a CPU
	334	* @dev: the CPU
	335	*
	336	* This function must be called between cpuidle_pause_and_lock and
	337	* cpuidle_resume_and_unlock when used externally.
	338	*/
	339	void cpuidle_disable_device(struct cpuidle_device *dev)
	340	{
bf4d1b5d DL	341	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
bf4d1b5d DL	342
cf31cd1a	343	if (!dev \|\| !dev->enabled)
4f86d3a8	344	return;
bf4d1b5d DL	345
bf4d1b5d DL	346	if (!drv \|\| !cpuidle_curr_governor)
4f86d3a8 LB	347	return;
	348
	349	dev->enabled = 0;
	350
	351	if (cpuidle_curr_governor->disable)
bf4d1b5d	352	cpuidle_curr_governor->disable(drv, dev);
4f86d3a8	353
bf4d1b5d	354	cpuidle_remove_device_sysfs(dev);
4f86d3a8 LB	355	enabled_devices--;
	356	}
	357
	358	EXPORT_SYMBOL_GPL(cpuidle_disable_device);
	359
	360	/**
dcb84f33 VP	361	* __cpuidle_register_device - internal register function called before register
dcb84f33 VP	362	* and enable routines
4f86d3a8	363	* @dev: the cpu
dcb84f33 VP	364	*
dcb84f33 VP	365	* cpuidle_lock mutex must be held before this is called
4f86d3a8	366	*/
dcb84f33	367	static int __cpuidle_register_device(struct cpuidle_device *dev)
4f86d3a8 LB	368	{
4f86d3a8 LB	369	int ret;
bf4d1b5d	370	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
4f86d3a8	371
bf4d1b5d	372	if (!try_module_get(drv->owner))
4f86d3a8 LB	373	return -EINVAL;
4f86d3a8 LB	374
4f86d3a8 LB	375	per_cpu(cpuidle_devices, dev->cpu) = dev;
4f86d3a8 LB	376	list_add(&dev->device_list, &cpuidle_detected_devices);
1aef40e2	377	ret = cpuidle_add_sysfs(dev);
3af272ab CC	378	if (ret)
3af272ab CC	379	goto err_sysfs;
4f86d3a8	380
4126c019 CC	381	ret = cpuidle_coupled_register_device(dev);
	382	if (ret)
	383	goto err_coupled;
4f86d3a8	384
dcb84f33 VP	385	dev->registered = 1;
dcb84f33 VP	386	return 0;
3af272ab	387
4126c019	388	err_coupled:
1aef40e2	389	cpuidle_remove_sysfs(dev);
3af272ab CC	390	err_sysfs:
	391	list_del(&dev->device_list);
	392	per_cpu(cpuidle_devices, dev->cpu) = NULL;
bf4d1b5d	393	module_put(drv->owner);
3af272ab	394	return ret;
dcb84f33 VP	395	}
	396
	397	/**
	398	* cpuidle_register_device - registers a CPU's idle PM feature
	399	* @dev: the cpu
	400	*/
	401	int cpuidle_register_device(struct cpuidle_device *dev)
	402	{
	403	int ret;
	404
1b0a0e9a SB	405	if (!dev)
	406	return -EINVAL;
	407
dcb84f33 VP	408	mutex_lock(&cpuidle_lock);
	409
	410	if ((ret = __cpuidle_register_device(dev))) {
	411	mutex_unlock(&cpuidle_lock);
	412	return ret;
	413	}
	414
10b9d3f8 DL	415	ret = cpuidle_enable_device(dev);
	416	if (ret) {
	417	mutex_unlock(&cpuidle_lock);
	418	return ret;
	419	}
	420
4f86d3a8 LB	421	cpuidle_install_idle_handler();
	422
	423	mutex_unlock(&cpuidle_lock);
	424
	425	return 0;
4f86d3a8 LB	426	}
	427
	428	EXPORT_SYMBOL_GPL(cpuidle_register_device);
	429
	430	/**
	431	* cpuidle_unregister_device - unregisters a CPU's idle PM feature
	432	* @dev: the cpu
	433	*/
	434	void cpuidle_unregister_device(struct cpuidle_device *dev)
	435	{
bf4d1b5d	436	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
4f86d3a8	437
dcb84f33 VP	438	if (dev->registered == 0)
	439	return;
	440
4f86d3a8 LB	441	cpuidle_pause_and_lock();
	442
	443	cpuidle_disable_device(dev);
	444
1aef40e2	445	cpuidle_remove_sysfs(dev);
4f86d3a8	446	list_del(&dev->device_list);
4f86d3a8 LB	447	per_cpu(cpuidle_devices, dev->cpu) = NULL;
4f86d3a8 LB	448
4126c019 CC	449	cpuidle_coupled_unregister_device(dev);
4126c019 CC	450
4f86d3a8 LB	451	cpuidle_resume_and_unlock();
4f86d3a8 LB	452
bf4d1b5d	453	module_put(drv->owner);
4f86d3a8 LB	454	}
	455
	456	EXPORT_SYMBOL_GPL(cpuidle_unregister_device);
	457
1c192d04	458	/**
4c637b21 DL	459	* cpuidle_unregister: unregister a driver and the devices. This function
	460	* can be used only if the driver has been previously registered through
	461	* the cpuidle_register function.
	462	*
	463	* @drv: a valid pointer to a struct cpuidle_driver
	464	*/
	465	void cpuidle_unregister(struct cpuidle_driver *drv)
	466	{
	467	int cpu;
	468	struct cpuidle_device *device;
	469
82467a5a	470	for_each_cpu(cpu, drv->cpumask) {
4c637b21 DL	471	device = &per_cpu(cpuidle_dev, cpu);
	472	cpuidle_unregister_device(device);
	473	}
	474
	475	cpuidle_unregister_driver(drv);
	476	}
	477	EXPORT_SYMBOL_GPL(cpuidle_unregister);
	478
	479	/**
	480	* cpuidle_register: registers the driver and the cpu devices with the
	481	* coupled_cpus passed as parameter. This function is used for all common
	482	* initialization pattern there are in the arch specific drivers. The
	483	* devices is globally defined in this file.
	484	*
	485	* @drv : a valid pointer to a struct cpuidle_driver
	486	* @coupled_cpus: a cpumask for the coupled states
	487	*
	488	* Returns 0 on success, < 0 otherwise
	489	*/
	490	int cpuidle_register(struct cpuidle_driver *drv,
	491	const struct cpumask *const coupled_cpus)
	492	{
	493	int ret, cpu;
	494	struct cpuidle_device *device;
	495
	496	ret = cpuidle_register_driver(drv);
	497	if (ret) {
	498	pr_err("failed to register cpuidle driver\n");
	499	return ret;
	500	}
	501
82467a5a	502	for_each_cpu(cpu, drv->cpumask) {
4c637b21 DL	503	device = &per_cpu(cpuidle_dev, cpu);
	504	device->cpu = cpu;
	505
	506	#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
	507	/*
	508	* On multiplatform for ARM, the coupled idle states could
	509	* enabled in the kernel even if the cpuidle driver does not
	510	* use it. Note, coupled_cpus is a struct copy.
	511	*/
	512	if (coupled_cpus)
	513	device->coupled_cpus = *coupled_cpus;
	514	#endif
	515	ret = cpuidle_register_device(device);
	516	if (!ret)
	517	continue;
	518
	519	pr_err("Failed to register cpuidle device for cpu%d\n", cpu);
	520
	521	cpuidle_unregister(drv);
	522	break;
	523	}
	524
	525	return ret;
	526	}
	527	EXPORT_SYMBOL_GPL(cpuidle_register);
	528
4f86d3a8 LB	529	#ifdef CONFIG_SMP
	530
	531	static void smp_callback(void *v)
	532	{
	533	/* we already woke the CPU up, nothing more to do */
	534	}
	535
	536	/*
	537	* This function gets called when a part of the kernel has a new latency
	538	* requirement. This means we need to get all processors out of their C-state,
	539	* and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
	540	* wakes them all right up.
	541	*/
	542	static int cpuidle_latency_notify(struct notifier_block *b,
	543	unsigned long l, void *v)
	544	{
8691e5a8	545	smp_call_function(smp_callback, NULL, 1);
4f86d3a8 LB	546	return NOTIFY_OK;
	547	}
	548
	549	static struct notifier_block cpuidle_latency_notifier = {
	550	.notifier_call = cpuidle_latency_notify,
	551	};
	552
d82b3518 MG	553	static inline void latency_notifier_init(struct notifier_block *n)
	554	{
	555	pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
	556	}
4f86d3a8 LB	557
	558	#else /* CONFIG_SMP */
	559
	560	#define latency_notifier_init(x) do { } while (0)
	561
	562	#endif /* CONFIG_SMP */
	563
	564	/**
	565	* cpuidle_init - core initializer
	566	*/
	567	static int __init cpuidle_init(void)
	568	{
	569	int ret;
	570
62027aea LB	571	if (cpuidle_disabled())
	572	return -ENODEV;
	573
8a25a2fd	574	ret = cpuidle_add_interface(cpu_subsys.dev_root);
4f86d3a8 LB	575	if (ret)
	576	return ret;
	577
	578	latency_notifier_init(&cpuidle_latency_notifier);
	579
	580	return 0;
	581	}
	582
62027aea	583	module_param(off, int, 0444);
4f86d3a8	584	core_initcall(cpuidle_init);