[deliverable/linux.git] / arch / arm / mach-omap2 / pm44xx.c

/*
 * OMAP4+ Power Management Routines
 *
 * Copyright (C) 2010-2013 Texas Instruments, Inc.
 * Rajendra Nayak <rnayak@ti.com>
 * Santosh Shilimkar <santosh.shilimkar@ti.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/pm.h>
#include <linux/suspend.h>
#include <linux/module.h>
#include <linux/list.h>
#include <linux/err.h>
#include <linux/slab.h>
#include <asm/system_misc.h>

#include "soc.h"
#include "common.h"
#include "clockdomain.h"
#include "powerdomain.h"
#include "pm.h"

u16 pm44xx_errata;

struct power_state {
	struct powerdomain *pwrdm;
	u32 next_state;
	u32 next_logic_state;
#ifdef CONFIG_SUSPEND
	u32 saved_state;
	u32 saved_logic_state;
#endif
	struct list_head node;
};

static LIST_HEAD(pwrst_list);

#ifdef CONFIG_SUSPEND
static int omap4_pm_suspend(void)
{
	struct power_state *pwrst;
	int state, ret = 0;
	u32 cpu_id = smp_processor_id();

	/* Save current powerdomain state */
	list_for_each_entry(pwrst, &pwrst_list, node) {
		pwrst->saved_state = pwrdm_read_next_pwrst(pwrst->pwrdm);
		pwrst->saved_logic_state = pwrdm_read_logic_retst(pwrst->pwrdm);
	}

	/* Set targeted power domain states by suspend */
	list_for_each_entry(pwrst, &pwrst_list, node) {
		omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
		pwrdm_set_logic_retst(pwrst->pwrdm, pwrst->next_logic_state);
	}

	/*
	 * For MPUSS to hit power domain retention(CSWR or OSWR),
	 * CPU0 and CPU1 power domains need to be in OFF or DORMANT state,
	 * since CPU power domain CSWR is not supported by hardware
	 * Only master CPU follows suspend path. All other CPUs follow
	 * CPU hotplug path in system wide suspend. On OMAP4, CPU power
	 * domain CSWR is not supported by hardware.
	 * More details can be found in OMAP4430 TRM section 4.3.4.2.
	 */
	omap4_enter_lowpower(cpu_id, PWRDM_POWER_OFF);

	/* Restore next powerdomain state */
	list_for_each_entry(pwrst, &pwrst_list, node) {
		state = pwrdm_read_prev_pwrst(pwrst->pwrdm);
		if (state > pwrst->next_state) {
			pr_info("Powerdomain (%s) didn't enter target state %d\n",
				pwrst->pwrdm->name, pwrst->next_state);
			ret = -1;
		}
		omap_set_pwrdm_state(pwrst->pwrdm, pwrst->saved_state);
		pwrdm_set_logic_retst(pwrst->pwrdm, pwrst->saved_logic_state);
	}
	if (ret) {
		pr_crit("Could not enter target state in pm_suspend\n");
		/*
		 * OMAP4 chip PM currently works only with certain (newer)
		 * versions of bootloaders. This is due to missing code in the
		 * kernel to properly reset and initialize some devices.
		 * Warn the user about the bootloader version being one of the
		 * possible causes.
		 * http://www.spinics.net/lists/arm-kernel/msg218641.html
		 */
		pr_warn("A possible cause could be an old bootloader - try u-boot >= v2012.07\n");
	} else {
		pr_info("Successfully put all powerdomains to target state\n");
	}

	return 0;
}
#else
#define omap4_pm_suspend NULL
#endif /* CONFIG_SUSPEND */

static int __init pwrdms_setup(struct powerdomain *pwrdm, void *unused)
{
	struct power_state *pwrst;

	if (!pwrdm->pwrsts)
		return 0;

	/*
	 * Skip CPU0 and CPU1 power domains. CPU1 is programmed
	 * through hotplug path and CPU0 explicitly programmed
	 * further down in the code path
	 */
	if (!strncmp(pwrdm->name, "cpu", 3))
		return 0;

	pwrst = kmalloc(sizeof(struct power_state), GFP_ATOMIC);
	if (!pwrst)
		return -ENOMEM;

	pwrst->pwrdm = pwrdm;
	pwrst->next_state = PWRDM_POWER_RET;
	pwrst->next_logic_state = PWRDM_POWER_OFF;

	list_add(&pwrst->node, &pwrst_list);

	return omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
}

/**
 * omap_default_idle - OMAP4 default ilde routine.'
 *
 * Implements OMAP4 memory, IO ordering requirements which can't be addressed
 * with default cpu_do_idle() hook. Used by all CPUs with !CONFIG_CPU_IDLE and
 * by secondary CPU with CONFIG_CPU_IDLE.
 */
static void omap_default_idle(void)
{
	omap_do_wfi();
}

/**
 * omap4_init_static_deps - Add OMAP4 static dependencies
 *
 * Add needed static clockdomain dependencies on OMAP4 devices.
 * Return: 0 on success or 'err' on failures
 */
static inline int omap4_init_static_deps(void)
{
	struct clockdomain *emif_clkdm, *mpuss_clkdm, *l3_1_clkdm;
	struct clockdomain *ducati_clkdm, *l3_2_clkdm;
	int ret = 0;

	if (omap_rev() == OMAP4430_REV_ES1_0) {
		WARN(1, "Power Management not supported on OMAP4430 ES1.0\n");
		return -ENODEV;
	}

	pr_err("Power Management for TI OMAP4.\n");
	/*
	 * OMAP4 chip PM currently works only with certain (newer)
	 * versions of bootloaders. This is due to missing code in the
	 * kernel to properly reset and initialize some devices.
	 * http://www.spinics.net/lists/arm-kernel/msg218641.html
	 */
	pr_warn("OMAP4 PM: u-boot >= v2012.07 is required for full PM support\n");

	ret = pwrdm_for_each(pwrdms_setup, NULL);
	if (ret) {
		pr_err("Failed to setup powerdomains\n");
		return ret;
	}

	/*
	 * The dynamic dependency between MPUSS -> MEMIF and
	 * MPUSS -> L4_PER/L3_* and DUCATI -> L3_* doesn't work as
	 * expected. The hardware recommendation is to enable static
	 * dependencies for these to avoid system lock ups or random crashes.
	 * The L4 wakeup depedency is added to workaround the OCP sync hardware
	 * BUG with 32K synctimer which lead to incorrect timer value read
	 * from the 32K counter. The BUG applies for GPTIMER1 and WDT2 which
	 * are part of L4 wakeup clockdomain.
	 */
	mpuss_clkdm = clkdm_lookup("mpuss_clkdm");
	emif_clkdm = clkdm_lookup("l3_emif_clkdm");
	l3_1_clkdm = clkdm_lookup("l3_1_clkdm");
	l3_2_clkdm = clkdm_lookup("l3_2_clkdm");
	ducati_clkdm = clkdm_lookup("ducati_clkdm");
	if ((!mpuss_clkdm) || (!emif_clkdm) || (!l3_1_clkdm) ||
		(!l3_2_clkdm) || (!ducati_clkdm))
		return -EINVAL;

	ret = clkdm_add_wkdep(mpuss_clkdm, emif_clkdm);
	ret |= clkdm_add_wkdep(mpuss_clkdm, l3_1_clkdm);
	ret |= clkdm_add_wkdep(mpuss_clkdm, l3_2_clkdm);
	ret |= clkdm_add_wkdep(ducati_clkdm, l3_1_clkdm);
	ret |= clkdm_add_wkdep(ducati_clkdm, l3_2_clkdm);
	if (ret) {
		pr_err("Failed to add MPUSS -> L3/EMIF/L4PER, DUCATI -> L3 wakeup dependency\n");
		return -EINVAL;
	}

	return ret;
}

/**
 * omap4_pm_init_early - Does early initialization necessary for OMAP4+ devices
 *
 * Initializes basic stuff for power management functionality.
 */
int __init omap4_pm_init_early(void)
{
	if (cpu_is_omap446x())
		pm44xx_errata |= PM_OMAP4_ROM_SMP_BOOT_ERRATUM_GICD;

	return 0;
}

/**
 * omap4_pm_init - Init routine for OMAP4+ devices
 *
 * Initializes all powerdomain and clockdomain target states
 * and all PRCM settings.
 * Return: Returns the error code returned by called functions.
 */
int __init omap4_pm_init(void)
{
	int ret = 0;

	if (omap_rev() == OMAP4430_REV_ES1_0) {
		WARN(1, "Power Management not supported on OMAP4430 ES1.0\n");
		return -ENODEV;
	}

	pr_info("Power Management for TI OMAP4+ devices.\n");

	ret = pwrdm_for_each(pwrdms_setup, NULL);
	if (ret) {
		pr_err("Failed to setup powerdomains.\n");
		goto err2;
	}

	if (cpu_is_omap44xx()) {
		ret = omap4_init_static_deps();
		if (ret)
			goto err2;
	}

	ret = omap4_mpuss_init();
	if (ret) {
		pr_err("Failed to initialise OMAP4 MPUSS\n");
		goto err2;
	}

	(void) clkdm_for_each(omap_pm_clkdms_setup, NULL);

	omap_common_suspend_init(omap4_pm_suspend);

	/* Overwrite the default cpu_do_idle() */
	arm_pm_idle = omap_default_idle;

	if (cpu_is_omap44xx())
		omap4_idle_init();

err2:
	return ret;
}
Commit	Line	Data
5643aebb	1	/*
705814b5	2	* OMAP4+ Power Management Routines
5643aebb	3	*
705814b5	4	* Copyright (C) 2010-2013 Texas Instruments, Inc.
5643aebb	5	* Rajendra Nayak <rnayak@ti.com>
e44f9a77	6	* Santosh Shilimkar <santosh.shilimkar@ti.com>
5643aebb RN	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*/
	12
	13	#include <linux/pm.h>
	14	#include <linux/suspend.h>
	15	#include <linux/module.h>
	16	#include <linux/list.h>
	17	#include <linux/err.h>
	18	#include <linux/slab.h>
9f97da78	19	#include <asm/system_misc.h>
5643aebb	20
e4c060db	21	#include "soc.h"
4e65331c	22	#include "common.h"
3c50729b	23	#include "clockdomain.h"
72e06d08	24	#include "powerdomain.h"
e44f9a77	25	#include "pm.h"
5643aebb	26
de70af49 NM	27	u16 pm44xx_errata;
de70af49 NM	28
5643aebb RN	29	struct power_state {
	30	struct powerdomain *pwrdm;
	31	u32 next_state;
46ba5526	32	u32 next_logic_state;
5643aebb RN	33	#ifdef CONFIG_SUSPEND
5643aebb RN	34	u32 saved_state;
3ba2a739	35	u32 saved_logic_state;
5643aebb RN	36	#endif
	37	struct list_head node;
	38	};
	39
	40	static LIST_HEAD(pwrst_list);
	41
	42	#ifdef CONFIG_SUSPEND
5643aebb RN	43	static int omap4_pm_suspend(void)
5643aebb RN	44	{
e44f9a77 SS	45	struct power_state *pwrst;
	46	int state, ret = 0;
	47	u32 cpu_id = smp_processor_id();
	48
	49	/* Save current powerdomain state */
	50	list_for_each_entry(pwrst, &pwrst_list, node) {
	51	pwrst->saved_state = pwrdm_read_next_pwrst(pwrst->pwrdm);
3ba2a739	52	pwrst->saved_logic_state = pwrdm_read_logic_retst(pwrst->pwrdm);
e44f9a77 SS	53	}
	54
	55	/* Set targeted power domain states by suspend */
	56	list_for_each_entry(pwrst, &pwrst_list, node) {
	57	omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
46ba5526	58	pwrdm_set_logic_retst(pwrst->pwrdm, pwrst->next_logic_state);
e44f9a77 SS	59	}
	60
	61	/*
	62	* For MPUSS to hit power domain retention(CSWR or OSWR),
	63	* CPU0 and CPU1 power domains need to be in OFF or DORMANT state,
	64	* since CPU power domain CSWR is not supported by hardware
	65	* Only master CPU follows suspend path. All other CPUs follow
	66	* CPU hotplug path in system wide suspend. On OMAP4, CPU power
	67	* domain CSWR is not supported by hardware.
	68	* More details can be found in OMAP4430 TRM section 4.3.4.2.
	69	*/
	70	omap4_enter_lowpower(cpu_id, PWRDM_POWER_OFF);
	71
	72	/* Restore next powerdomain state */
	73	list_for_each_entry(pwrst, &pwrst_list, node) {
	74	state = pwrdm_read_prev_pwrst(pwrst->pwrdm);
	75	if (state > pwrst->next_state) {
7852ec05 PW	76	pr_info("Powerdomain (%s) didn't enter target state %d\n",
7852ec05 PW	77	pwrst->pwrdm->name, pwrst->next_state);
e44f9a77 SS	78	ret = -1;
	79	}
	80	omap_set_pwrdm_state(pwrst->pwrdm, pwrst->saved_state);
3ba2a739	81	pwrdm_set_logic_retst(pwrst->pwrdm, pwrst->saved_logic_state);
e44f9a77	82	}
60480098	83	if (ret) {
e44f9a77	84	pr_crit("Could not enter target state in pm_suspend\n");
60480098 RN	85	/*
	86	* OMAP4 chip PM currently works only with certain (newer)
	87	* versions of bootloaders. This is due to missing code in the
	88	* kernel to properly reset and initialize some devices.
	89	* Warn the user about the bootloader version being one of the
	90	* possible causes.
	91	* http://www.spinics.net/lists/arm-kernel/msg218641.html
	92	*/
	93	pr_warn("A possible cause could be an old bootloader - try u-boot >= v2012.07\n");
	94	} else {
e44f9a77	95	pr_info("Successfully put all powerdomains to target state\n");
60480098	96	}
e44f9a77	97
5643aebb RN	98	return 0;
5643aebb RN	99	}
2e4b62dc DG	100	#else
2e4b62dc DG	101	#define omap4_pm_suspend NULL
5643aebb RN	102	#endif /* CONFIG_SUSPEND */
	103
	104	static int __init pwrdms_setup(struct powerdomain pwrdm, void unused)
	105	{
	106	struct power_state *pwrst;
	107
	108	if (!pwrdm->pwrsts)
	109	return 0;
	110
e44f9a77 SS	111	/*
	112	* Skip CPU0 and CPU1 power domains. CPU1 is programmed
	113	* through hotplug path and CPU0 explicitly programmed
	114	* further down in the code path
	115	*/
	116	if (!strncmp(pwrdm->name, "cpu", 3))
	117	return 0;
	118
5643aebb RN	119	pwrst = kmalloc(sizeof(struct power_state), GFP_ATOMIC);
	120	if (!pwrst)
	121	return -ENOMEM;
e44f9a77	122
5643aebb	123	pwrst->pwrdm = pwrdm;
e44f9a77	124	pwrst->next_state = PWRDM_POWER_RET;
46ba5526 NM	125	pwrst->next_logic_state = PWRDM_POWER_OFF;
46ba5526 NM	126
5643aebb RN	127	list_add(&pwrst->node, &pwrst_list);
5643aebb RN	128
e44f9a77	129	return omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
5643aebb RN	130	}
5643aebb RN	131
72826b9f SS	132	/**
	133	* omap_default_idle - OMAP4 default ilde routine.'
	134	*
	135	* Implements OMAP4 memory, IO ordering requirements which can't be addressed
62006324 PB	136	* with default cpu_do_idle() hook. Used by all CPUs with !CONFIG_CPU_IDLE and
62006324 PB	137	* by secondary CPU with CONFIG_CPU_IDLE.
72826b9f SS	138	*/
	139	static void omap_default_idle(void)
	140	{
72826b9f	141	omap_do_wfi();
72826b9f SS	142	}
72826b9f SS	143
5643aebb	144	/**
705814b5	145	* omap4_init_static_deps - Add OMAP4 static dependencies
5643aebb	146	*
705814b5 SS	147	* Add needed static clockdomain dependencies on OMAP4 devices.
705814b5 SS	148	* Return: 0 on success or 'err' on failures
5643aebb	149	*/
705814b5	150	static inline int omap4_init_static_deps(void)
5643aebb	151	{
6cf38956	152	struct clockdomain emif_clkdm, mpuss_clkdm, *l3_1_clkdm;
d5336a5a	153	struct clockdomain ducati_clkdm, l3_2_clkdm;
705814b5	154	int ret = 0;
5643aebb	155
361b02f3 SS	156	if (omap_rev() == OMAP4430_REV_ES1_0) {
	157	WARN(1, "Power Management not supported on OMAP4430 ES1.0\n");
	158	return -ENODEV;
	159	}
	160
5643aebb	161	pr_err("Power Management for TI OMAP4.\n");
60480098 RN	162	/*
	163	* OMAP4 chip PM currently works only with certain (newer)
	164	* versions of bootloaders. This is due to missing code in the
	165	* kernel to properly reset and initialize some devices.
	166	* http://www.spinics.net/lists/arm-kernel/msg218641.html
	167	*/
	168	pr_warn("OMAP4 PM: u-boot >= v2012.07 is required for full PM support\n");
5643aebb	169
5643aebb RN	170	ret = pwrdm_for_each(pwrdms_setup, NULL);
	171	if (ret) {
	172	pr_err("Failed to setup powerdomains\n");
705814b5	173	return ret;
5643aebb	174	}
5643aebb	175
12f27826 SS	176	/*
	177	* The dynamic dependency between MPUSS -> MEMIF and
	178	* MPUSS -> L4_PER/L3_* and DUCATI -> L3_* doesn't work as
	179	* expected. The hardware recommendation is to enable static
	180	* dependencies for these to avoid system lock ups or random crashes.
705814b5 SS	181	* The L4 wakeup depedency is added to workaround the OCP sync hardware
	182	* BUG with 32K synctimer which lead to incorrect timer value read
	183	* from the 32K counter. The BUG applies for GPTIMER1 and WDT2 which
	184	* are part of L4 wakeup clockdomain.
12f27826 SS	185	*/
	186	mpuss_clkdm = clkdm_lookup("mpuss_clkdm");
	187	emif_clkdm = clkdm_lookup("l3_emif_clkdm");
	188	l3_1_clkdm = clkdm_lookup("l3_1_clkdm");
	189	l3_2_clkdm = clkdm_lookup("l3_2_clkdm");
12f27826	190	ducati_clkdm = clkdm_lookup("ducati_clkdm");
6cf38956	191	if ((!mpuss_clkdm) \|\| (!emif_clkdm) \|\| (!l3_1_clkdm) \|\|
d5336a5a	192	(!l3_2_clkdm) \|\| (!ducati_clkdm))
705814b5	193	return -EINVAL;
12f27826 SS	194
	195	ret = clkdm_add_wkdep(mpuss_clkdm, emif_clkdm);
	196	ret \|= clkdm_add_wkdep(mpuss_clkdm, l3_1_clkdm);
	197	ret \|= clkdm_add_wkdep(mpuss_clkdm, l3_2_clkdm);
12f27826 SS	198	ret \|= clkdm_add_wkdep(ducati_clkdm, l3_1_clkdm);
	199	ret \|= clkdm_add_wkdep(ducati_clkdm, l3_2_clkdm);
	200	if (ret) {
7852ec05	201	pr_err("Failed to add MPUSS -> L3/EMIF/L4PER, DUCATI -> L3 wakeup dependency\n");
705814b5 SS	202	return -EINVAL;
	203	}
	204
	205	return ret;
de70af49 NM	206	}
	207
	208	/**
	209	* omap4_pm_init_early - Does early initialization necessary for OMAP4+ devices
	210	*
	211	* Initializes basic stuff for power management functionality.
	212	*/
	213	int __init omap4_pm_init_early(void)
	214	{
	215	if (cpu_is_omap446x())
	216	pm44xx_errata \|= PM_OMAP4_ROM_SMP_BOOT_ERRATUM_GICD;
	217
	218	return 0;
705814b5 SS	219	}
	220
	221	/**
	222	* omap4_pm_init - Init routine for OMAP4+ devices
	223	*
	224	* Initializes all powerdomain and clockdomain target states
	225	* and all PRCM settings.
	226	* Return: Returns the error code returned by called functions.
	227	*/
	228	int __init omap4_pm_init(void)
	229	{
	230	int ret = 0;
	231
	232	if (omap_rev() == OMAP4430_REV_ES1_0) {
	233	WARN(1, "Power Management not supported on OMAP4430 ES1.0\n");
	234	return -ENODEV;
	235	}
	236
	237	pr_info("Power Management for TI OMAP4+ devices.\n");
	238
	239	ret = pwrdm_for_each(pwrdms_setup, NULL);
	240	if (ret) {
	241	pr_err("Failed to setup powerdomains.\n");
12f27826 SS	242	goto err2;
	243	}
	244
705814b5 SS	245	if (cpu_is_omap44xx()) {
	246	ret = omap4_init_static_deps();
	247	if (ret)
	248	goto err2;
	249	}
	250
b2b9762f SS	251	ret = omap4_mpuss_init();
	252	if (ret) {
	253	pr_err("Failed to initialise OMAP4 MPUSS\n");
	254	goto err2;
	255	}
	256
92206fd2	257	(void) clkdm_for_each(omap_pm_clkdms_setup, NULL);
3c50729b	258
2e4b62dc	259	omap_common_suspend_init(omap4_pm_suspend);
5643aebb	260
ae940913	261	/* Overwrite the default cpu_do_idle() */
0bcd24b0	262	arm_pm_idle = omap_default_idle;
72826b9f	263
705814b5 SS	264	if (cpu_is_omap44xx())
705814b5 SS	265	omap4_idle_init();
98272660	266
5643aebb RN	267	err2:
	268	return ret;
	269	}