2008-08-19 11:08:40 +03:00
/*
2010-12-21 21:05:14 -07:00
* OMAP2 / 3 / 4 powerdomain control
2008-08-19 11:08:40 +03:00
*
2010-12-21 21:05:16 -07:00
* Copyright ( C ) 2007 - 2008 , 2010 Texas Instruments , Inc .
2011-03-07 19:28:15 -07:00
* Copyright ( C ) 2007 - 2011 Nokia Corporation
2008-08-19 11:08:40 +03:00
*
2010-12-21 21:05:16 -07:00
* Paul Walmsley
2008-08-19 11:08:40 +03:00
*
* 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 .
2010-12-21 20:01:20 -07:00
*
* XXX This should be moved to the mach - omap2 / directory at the earliest
* opportunity .
2008-08-19 11:08:40 +03:00
*/
2010-12-21 21:05:16 -07:00
# ifndef __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
# define __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
2008-08-19 11:08:40 +03:00
# include <linux/types.h>
# include <linux/list.h>
2010-12-21 21:05:16 -07:00
# include <linux/atomic.h>
2008-08-19 11:08:40 +03:00
2009-10-20 09:40:47 -07:00
# include <plat/cpu.h>
2008-08-19 11:08:40 +03:00
2011-03-23 07:22:23 -07:00
# include "voltage.h"
2008-08-19 11:08:40 +03:00
/* Powerdomain basic power states */
# define PWRDM_POWER_OFF 0x0
# define PWRDM_POWER_RET 0x1
# define PWRDM_POWER_INACTIVE 0x2
# define PWRDM_POWER_ON 0x3
2009-12-08 16:33:12 -07:00
# define PWRDM_MAX_PWRSTS 4
2008-08-19 11:08:40 +03:00
/* Powerdomain allowable state bitfields */
2010-05-18 20:24:01 -06:00
# define PWRSTS_ON (1 << PWRDM_POWER_ON)
2011-03-07 19:28:15 -07:00
# define PWRSTS_INACTIVE (1 << PWRDM_POWER_INACTIVE)
# define PWRSTS_RET (1 << PWRDM_POWER_RET)
2010-09-27 14:02:56 -06:00
# define PWRSTS_OFF (1 << PWRDM_POWER_OFF)
2008-08-19 11:08:40 +03:00
2011-03-07 19:28:15 -07:00
# define PWRSTS_OFF_ON (PWRSTS_OFF | PWRSTS_ON)
# define PWRSTS_OFF_RET (PWRSTS_OFF | PWRSTS_RET)
# define PWRSTS_RET_ON (PWRSTS_RET | PWRSTS_ON)
# define PWRSTS_OFF_RET_ON (PWRSTS_OFF_RET | PWRSTS_ON)
2008-08-19 11:08:40 +03:00
[ARM] OMAP3 pwrdm: add hardware save-and-restore (SAR) support
OMAP3430ES2+ introduces a new feature: optional powerdomain context
hardware save-and-restore (SAR). Currently, this feature only applies
to USBHOST and USBTLL module context when the USBHOST or CORE
powerdomains enter a low-power sleep state[1]. This feature avoids
re-enumeration of USB devices when the powerdomains return from idle,
which is potentially time-consuming.
This patch adds support for enabling and disabling hardware
save-and-restore to the powerdomain code. Three new functions are
added, pwrdm_enable_hdwr_sar(), pwrdm_disable_hdwr_sar(), and
pwrdm_can_hdwr_sar(). A new struct powerdomain "flags" field is
added, with a PWRDM_HAS_HDWR_SAR flag to indicate powerdomains with
SAR support.
Thanks to Jouni Högander <jouni.hogander@nokia.com> for reviewing an
earlier version of these patches, and Richard Woodruff <r-woodruff2@ti.com>
for clarifying the purpose of these bits.
1. For the USBHOST controller module, context loss occurs when the
USBHOST powerdomain enters off-idle. For USBTLL, context loss
occurs either if CORE enters off-idle, or if the CORE logic is
configured to turn off when CORE enters retention-idle (OSWR).
34xx ES2 TRM 4.8.6.1.1, 4.8.6.1.2
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
2008-06-25 18:09:37 -06:00
/* Powerdomain flags */
# define PWRDM_HAS_HDWR_SAR (1 << 0) /* hardware save-and-restore support */
2009-12-08 16:33:15 -07:00
# define PWRDM_HAS_MPU_QUIRK (1 << 1) / * MPU pwr domain has MEM bank 0 bits
* in MEM bank 1 position . This is
* true for OMAP3430
*/
2010-05-18 20:24:03 -06:00
# define PWRDM_HAS_LOWPOWERSTATECHANGE (1 << 2) / *
* support to transition from a
* sleep state to a lower sleep
* state without waking up the
* powerdomain
*/
[ARM] OMAP3 pwrdm: add hardware save-and-restore (SAR) support
OMAP3430ES2+ introduces a new feature: optional powerdomain context
hardware save-and-restore (SAR). Currently, this feature only applies
to USBHOST and USBTLL module context when the USBHOST or CORE
powerdomains enter a low-power sleep state[1]. This feature avoids
re-enumeration of USB devices when the powerdomains return from idle,
which is potentially time-consuming.
This patch adds support for enabling and disabling hardware
save-and-restore to the powerdomain code. Three new functions are
added, pwrdm_enable_hdwr_sar(), pwrdm_disable_hdwr_sar(), and
pwrdm_can_hdwr_sar(). A new struct powerdomain "flags" field is
added, with a PWRDM_HAS_HDWR_SAR flag to indicate powerdomains with
SAR support.
Thanks to Jouni Högander <jouni.hogander@nokia.com> for reviewing an
earlier version of these patches, and Richard Woodruff <r-woodruff2@ti.com>
for clarifying the purpose of these bits.
1. For the USBHOST controller module, context loss occurs when the
USBHOST powerdomain enters off-idle. For USBTLL, context loss
occurs either if CORE enters off-idle, or if the CORE logic is
configured to turn off when CORE enters retention-idle (OSWR).
34xx ES2 TRM 4.8.6.1.1, 4.8.6.1.2
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
2008-06-25 18:09:37 -06:00
2008-08-19 11:08:40 +03:00
/*
2010-01-26 20:12:52 -07:00
* Number of memory banks that are power - controllable . On OMAP4430 , the
* maximum is 5.
2008-08-19 11:08:40 +03:00
*/
2010-01-26 20:12:52 -07:00
# define PWRDM_MAX_MEM_BANKS 5
2008-08-19 11:08:40 +03:00
2008-08-19 11:08:44 +03:00
/*
* Maximum number of clockdomains that can be associated with a powerdomain .
2010-01-26 20:12:52 -07:00
* CORE powerdomain on OMAP4 is the worst case
2008-08-19 11:08:44 +03:00
*/
2010-01-26 20:12:52 -07:00
# define PWRDM_MAX_CLKDMS 9
2008-08-19 11:08:44 +03:00
2008-08-19 11:08:40 +03:00
/* XXX A completely arbitrary number. What is reasonable here? */
# define PWRDM_TRANSITION_BAILOUT 100000
2008-08-19 11:08:44 +03:00
struct clockdomain ;
2008-08-19 11:08:40 +03:00
struct powerdomain ;
2010-01-26 20:13:02 -07:00
/**
* struct powerdomain - OMAP powerdomain
* @ name : Powerdomain name
2011-03-23 07:22:23 -07:00
* @ voltdm : voltagedomain containing this powerdomain
2010-01-26 20:13:02 -07:00
* @ prcm_offs : the address offset from CM_BASE / PRM_BASE
2010-12-21 21:05:14 -07:00
* @ prcm_partition : ( OMAP4 only ) the PRCM partition ID containing @ prcm_offs
2010-01-26 20:13:02 -07:00
* @ pwrsts : Possible powerdomain power states
* @ pwrsts_logic_ret : Possible logic power states when pwrdm in RETENTION
* @ flags : Powerdomain flags
* @ banks : Number of software - controllable memory banks in this powerdomain
* @ pwrsts_mem_ret : Possible memory bank pwrstates when pwrdm in RETENTION
* @ pwrsts_mem_on : Possible memory bank pwrstates when pwrdm in ON
* @ pwrdm_clkdms : Clockdomains in this powerdomain
* @ node : list_head linking all powerdomains
2011-03-16 16:13:15 -07:00
* @ voltdm_node : list_head linking all powerdomains in a voltagedomain
2010-01-26 20:13:02 -07:00
* @ state :
* @ state_counter :
* @ timer :
* @ state_timer :
2010-12-21 21:05:14 -07:00
*
* @ prcm_partition possible values are defined in mach - omap2 / prcm44xx . h .
2010-01-26 20:13:02 -07:00
*/
2008-08-19 11:08:40 +03:00
struct powerdomain {
const char * name ;
2011-03-23 07:22:23 -07:00
union {
const char * name ;
struct voltagedomain * ptr ;
} voltdm ;
2010-01-26 20:13:01 -07:00
const s16 prcm_offs ;
2008-08-19 11:08:40 +03:00
const u8 pwrsts ;
const u8 pwrsts_logic_ret ;
[ARM] OMAP3 pwrdm: add hardware save-and-restore (SAR) support
OMAP3430ES2+ introduces a new feature: optional powerdomain context
hardware save-and-restore (SAR). Currently, this feature only applies
to USBHOST and USBTLL module context when the USBHOST or CORE
powerdomains enter a low-power sleep state[1]. This feature avoids
re-enumeration of USB devices when the powerdomains return from idle,
which is potentially time-consuming.
This patch adds support for enabling and disabling hardware
save-and-restore to the powerdomain code. Three new functions are
added, pwrdm_enable_hdwr_sar(), pwrdm_disable_hdwr_sar(), and
pwrdm_can_hdwr_sar(). A new struct powerdomain "flags" field is
added, with a PWRDM_HAS_HDWR_SAR flag to indicate powerdomains with
SAR support.
Thanks to Jouni Högander <jouni.hogander@nokia.com> for reviewing an
earlier version of these patches, and Richard Woodruff <r-woodruff2@ti.com>
for clarifying the purpose of these bits.
1. For the USBHOST controller module, context loss occurs when the
USBHOST powerdomain enters off-idle. For USBTLL, context loss
occurs either if CORE enters off-idle, or if the CORE logic is
configured to turn off when CORE enters retention-idle (OSWR).
34xx ES2 TRM 4.8.6.1.1, 4.8.6.1.2
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
2008-06-25 18:09:37 -06:00
const u8 flags ;
2008-08-19 11:08:40 +03:00
const u8 banks ;
const u8 pwrsts_mem_ret [ PWRDM_MAX_MEM_BANKS ] ;
const u8 pwrsts_mem_on [ PWRDM_MAX_MEM_BANKS ] ;
2010-12-21 21:05:14 -07:00
const u8 prcm_partition ;
2008-08-19 11:08:44 +03:00
struct clockdomain * pwrdm_clkdms [ PWRDM_MAX_CLKDMS ] ;
2008-08-19 11:08:40 +03:00
struct list_head node ;
2011-03-16 16:13:15 -07:00
struct list_head voltdm_node ;
2008-10-15 17:48:43 +03:00
int state ;
2009-12-08 16:33:12 -07:00
unsigned state_counter [ PWRDM_MAX_PWRSTS ] ;
2010-02-24 12:05:50 -07:00
unsigned ret_logic_off_counter ;
unsigned ret_mem_off_counter [ PWRDM_MAX_MEM_BANKS ] ;
2008-10-15 18:13:48 +03:00
# ifdef CONFIG_PM_DEBUG
s64 timer ;
2009-12-08 16:33:12 -07:00
s64 state_timer [ PWRDM_MAX_PWRSTS ] ;
2008-10-15 18:13:48 +03:00
# endif
2008-08-19 11:08:40 +03:00
} ;
2010-12-21 20:01:18 -07:00
/**
2011-03-30 22:57:33 -03:00
* struct pwrdm_ops - Arch specific function implementations
2010-12-21 20:01:18 -07:00
* @ pwrdm_set_next_pwrst : Set the target power state for a pd
* @ pwrdm_read_next_pwrst : Read the target power state set for a pd
* @ pwrdm_read_pwrst : Read the current power state of a pd
* @ pwrdm_read_prev_pwrst : Read the prev power state entered by the pd
* @ pwrdm_set_logic_retst : Set the logic state in RET for a pd
* @ pwrdm_set_mem_onst : Set the Memory state in ON for a pd
* @ pwrdm_set_mem_retst : Set the Memory state in RET for a pd
* @ pwrdm_read_logic_pwrst : Read the current logic state of a pd
* @ pwrdm_read_prev_logic_pwrst : Read the previous logic state entered by a pd
* @ pwrdm_read_logic_retst : Read the logic state in RET for a pd
* @ pwrdm_read_mem_pwrst : Read the current memory state of a pd
* @ pwrdm_read_prev_mem_pwrst : Read the previous memory state entered by a pd
* @ pwrdm_read_mem_retst : Read the memory state in RET for a pd
* @ pwrdm_clear_all_prev_pwrst : Clear all previous power states logged for a pd
* @ pwrdm_enable_hdwr_sar : Enable Hardware Save - Restore feature for the pd
* @ pwrdm_disable_hdwr_sar : Disable Hardware Save - Restore feature for a pd
* @ pwrdm_set_lowpwrstchange : Enable pd transitions from a shallow to deep sleep
* @ pwrdm_wait_transition : Wait for a pd state transition to complete
*/
struct pwrdm_ops {
int ( * pwrdm_set_next_pwrst ) ( struct powerdomain * pwrdm , u8 pwrst ) ;
int ( * pwrdm_read_next_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_read_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_read_prev_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_set_logic_retst ) ( struct powerdomain * pwrdm , u8 pwrst ) ;
int ( * pwrdm_set_mem_onst ) ( struct powerdomain * pwrdm , u8 bank , u8 pwrst ) ;
int ( * pwrdm_set_mem_retst ) ( struct powerdomain * pwrdm , u8 bank , u8 pwrst ) ;
int ( * pwrdm_read_logic_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_read_prev_logic_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_read_logic_retst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_read_mem_pwrst ) ( struct powerdomain * pwrdm , u8 bank ) ;
int ( * pwrdm_read_prev_mem_pwrst ) ( struct powerdomain * pwrdm , u8 bank ) ;
int ( * pwrdm_read_mem_retst ) ( struct powerdomain * pwrdm , u8 bank ) ;
int ( * pwrdm_clear_all_prev_pwrst ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_enable_hdwr_sar ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_disable_hdwr_sar ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_set_lowpwrstchange ) ( struct powerdomain * pwrdm ) ;
int ( * pwrdm_wait_transition ) ( struct powerdomain * pwrdm ) ;
} ;
2008-08-19 11:08:40 +03:00
2011-09-14 16:01:21 -06:00
int pwrdm_register_platform_funcs ( struct pwrdm_ops * custom_funcs ) ;
int pwrdm_register_pwrdms ( struct powerdomain * * pwrdm_list ) ;
int pwrdm_complete_init ( void ) ;
2008-08-19 11:08:40 +03:00
struct powerdomain * pwrdm_lookup ( const char * name ) ;
2008-10-15 18:13:47 +03:00
int pwrdm_for_each ( int ( * fn ) ( struct powerdomain * pwrdm , void * user ) ,
void * user ) ;
2009-10-01 10:01:55 +03:00
int pwrdm_for_each_nolock ( int ( * fn ) ( struct powerdomain * pwrdm , void * user ) ,
void * user ) ;
2008-08-19 11:08:40 +03:00
2008-08-19 11:08:44 +03:00
int pwrdm_add_clkdm ( struct powerdomain * pwrdm , struct clockdomain * clkdm ) ;
int pwrdm_del_clkdm ( struct powerdomain * pwrdm , struct clockdomain * clkdm ) ;
int pwrdm_for_each_clkdm ( struct powerdomain * pwrdm ,
int ( * fn ) ( struct powerdomain * pwrdm ,
struct clockdomain * clkdm ) ) ;
2011-03-16 15:52:47 -07:00
struct voltagedomain * pwrdm_get_voltdm ( struct powerdomain * pwrdm ) ;
2008-08-19 11:08:44 +03:00
2008-08-19 11:08:40 +03:00
int pwrdm_get_mem_bank_count ( struct powerdomain * pwrdm ) ;
int pwrdm_set_next_pwrst ( struct powerdomain * pwrdm , u8 pwrst ) ;
int pwrdm_read_next_pwrst ( struct powerdomain * pwrdm ) ;
2009-01-27 19:12:50 -07:00
int pwrdm_read_pwrst ( struct powerdomain * pwrdm ) ;
2008-08-19 11:08:40 +03:00
int pwrdm_read_prev_pwrst ( struct powerdomain * pwrdm ) ;
int pwrdm_clear_all_prev_pwrst ( struct powerdomain * pwrdm ) ;
int pwrdm_set_logic_retst ( struct powerdomain * pwrdm , u8 pwrst ) ;
int pwrdm_set_mem_onst ( struct powerdomain * pwrdm , u8 bank , u8 pwrst ) ;
int pwrdm_set_mem_retst ( struct powerdomain * pwrdm , u8 bank , u8 pwrst ) ;
int pwrdm_read_logic_pwrst ( struct powerdomain * pwrdm ) ;
int pwrdm_read_prev_logic_pwrst ( struct powerdomain * pwrdm ) ;
2010-02-24 12:05:49 -07:00
int pwrdm_read_logic_retst ( struct powerdomain * pwrdm ) ;
2008-08-19 11:08:40 +03:00
int pwrdm_read_mem_pwrst ( struct powerdomain * pwrdm , u8 bank ) ;
int pwrdm_read_prev_mem_pwrst ( struct powerdomain * pwrdm , u8 bank ) ;
2010-02-24 12:05:49 -07:00
int pwrdm_read_mem_retst ( struct powerdomain * pwrdm , u8 bank ) ;
2008-08-19 11:08:40 +03:00
[ARM] OMAP3 pwrdm: add hardware save-and-restore (SAR) support
OMAP3430ES2+ introduces a new feature: optional powerdomain context
hardware save-and-restore (SAR). Currently, this feature only applies
to USBHOST and USBTLL module context when the USBHOST or CORE
powerdomains enter a low-power sleep state[1]. This feature avoids
re-enumeration of USB devices when the powerdomains return from idle,
which is potentially time-consuming.
This patch adds support for enabling and disabling hardware
save-and-restore to the powerdomain code. Three new functions are
added, pwrdm_enable_hdwr_sar(), pwrdm_disable_hdwr_sar(), and
pwrdm_can_hdwr_sar(). A new struct powerdomain "flags" field is
added, with a PWRDM_HAS_HDWR_SAR flag to indicate powerdomains with
SAR support.
Thanks to Jouni Högander <jouni.hogander@nokia.com> for reviewing an
earlier version of these patches, and Richard Woodruff <r-woodruff2@ti.com>
for clarifying the purpose of these bits.
1. For the USBHOST controller module, context loss occurs when the
USBHOST powerdomain enters off-idle. For USBTLL, context loss
occurs either if CORE enters off-idle, or if the CORE logic is
configured to turn off when CORE enters retention-idle (OSWR).
34xx ES2 TRM 4.8.6.1.1, 4.8.6.1.2
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
2008-06-25 18:09:37 -06:00
int pwrdm_enable_hdwr_sar ( struct powerdomain * pwrdm ) ;
int pwrdm_disable_hdwr_sar ( struct powerdomain * pwrdm ) ;
bool pwrdm_has_hdwr_sar ( struct powerdomain * pwrdm ) ;
2008-08-19 11:08:40 +03:00
int pwrdm_wait_transition ( struct powerdomain * pwrdm ) ;
2008-10-15 17:48:43 +03:00
int pwrdm_state_switch ( struct powerdomain * pwrdm ) ;
int pwrdm_clkdm_state_switch ( struct clockdomain * clkdm ) ;
int pwrdm_pre_transition ( void ) ;
int pwrdm_post_transition ( void ) ;
2010-10-08 09:58:35 -07:00
int pwrdm_set_lowpwrstchange ( struct powerdomain * pwrdm ) ;
2011-06-09 16:56:23 +03:00
int pwrdm_get_context_loss_count ( struct powerdomain * pwrdm ) ;
2011-03-07 19:28:15 -07:00
bool pwrdm_can_ever_lose_context ( struct powerdomain * pwrdm ) ;
2008-10-15 17:48:43 +03:00
2011-09-14 11:34:21 -06:00
extern void omap242x_powerdomains_init ( void ) ;
extern void omap243x_powerdomains_init ( void ) ;
2010-12-21 20:01:20 -07:00
extern void omap3xxx_powerdomains_init ( void ) ;
extern void omap44xx_powerdomains_init ( void ) ;
2010-12-21 21:05:16 -07:00
extern struct pwrdm_ops omap2_pwrdm_operations ;
extern struct pwrdm_ops omap3_pwrdm_operations ;
extern struct pwrdm_ops omap4_pwrdm_operations ;
/* Common Internal functions used across OMAP rev's */
extern u32 omap2_pwrdm_get_mem_bank_onstate_mask ( u8 bank ) ;
extern u32 omap2_pwrdm_get_mem_bank_retst_mask ( u8 bank ) ;
extern u32 omap2_pwrdm_get_mem_bank_stst_mask ( u8 bank ) ;
extern struct powerdomain wkup_omap2_pwrdm ;
extern struct powerdomain gfx_omap2_pwrdm ;
2008-08-19 11:08:40 +03:00
# endif