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

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

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

static void __cpuidle_unregister_device(struct cpuidle_device *dev)
{
	struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);

	list_del(&dev->device_list);
	per_cpu(cpuidle_devices, dev->cpu) = NULL;
	module_put(drv->owner);
}

static void __cpuidle_device_init(struct cpuidle_device *dev)
{
	memset(dev->states_usage, 0, sizeof(dev->states_usage));
	dev->last_residency = 0;
}

/**
 * __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_coupled_register_device(dev);
	if (ret) {
		__cpuidle_unregister_device(dev);
		return ret;
	}

	dev->registered = 1;
	return 0;
}

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

	if (!dev)
		return -EINVAL;

	mutex_lock(&cpuidle_lock);

	if (dev->registered)
		goto out_unlock;

	__cpuidle_device_init(dev);

	ret = __cpuidle_register_device(dev);
	if (ret)
		goto out_unlock;

	ret = cpuidle_add_sysfs(dev);
	if (ret)
		goto out_unregister;

	ret = cpuidle_enable_device(dev);
	if (ret)
		goto out_sysfs;

	cpuidle_install_idle_handler();

out_unlock:
	mutex_unlock(&cpuidle_lock);

	return ret;

out_sysfs:
	cpuidle_remove_sysfs(dev);
out_unregister:
	__cpuidle_unregister_device(dev);
	goto out_unlock;
}

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)
{
	if (dev->registered == 0)
		return;

	cpuidle_pause_and_lock();

	cpuidle_disable_device(dev);

	cpuidle_remove_sysfs(dev);

	__cpuidle_unregister_device(dev);

	cpuidle_coupled_unregister_device(dev);

	cpuidle_resume_and_unlock();
}

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