arch/arm/plat-omap/include/plat/powerdomain.h

   1 /*
   2  * OMAP2/3 powerdomain control
   3  *
   4  * Copyright (C) 2007-2008 Texas Instruments, Inc.
   5  * Copyright (C) 2007-2009 Nokia Corporation
   6  *
   7  * Written by Paul Walmsley
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13
  14 #ifndef ASM_ARM_ARCH_OMAP_POWERDOMAIN
  15 #define ASM_ARM_ARCH_OMAP_POWERDOMAIN
  16
  17 #include <linux/types.h>
  18 #include <linux/list.h>
  19
  20 #include <asm/atomic.h>
  21
  22 #include <plat/cpu.h>
  23
  24
  25 /* Powerdomain basic power states */
  26 #define PWRDM_POWER_OFF         0x0
  27 #define PWRDM_POWER_RET         0x1
  28 #define PWRDM_POWER_INACTIVE    0x2
  29 #define PWRDM_POWER_ON          0x3
  30
  31 #define PWRDM_MAX_PWRSTS        4
  32
  33 /* Powerdomain allowable state bitfields */
  34 #define PWRSTS_ON               (1 << PWRDM_POWER_ON)
  35 #define PWRSTS_OFF              (1 << PWRDM_POWER_OFF)
  36 #define PWRSTS_OFF_ON           ((1 << PWRDM_POWER_OFF) | \
  37                                  (1 << PWRDM_POWER_ON))
  38
  39 #define PWRSTS_OFF_RET          ((1 << PWRDM_POWER_OFF) | \
  40                                  (1 << PWRDM_POWER_RET))
  41
  42 #define PWRSTS_RET_ON           ((1 << PWRDM_POWER_RET) | \
  43                                  (1 << PWRDM_POWER_ON))
  44
  45 #define PWRSTS_OFF_RET_ON       (PWRSTS_OFF_RET | (1 << PWRDM_POWER_ON))
  46
  47
  48 /* Powerdomain flags */
  49 #define PWRDM_HAS_HDWR_SAR      (1 << 0) /* hardware save-and-restore support */
  50 #define PWRDM_HAS_MPU_QUIRK     (1 << 1) /* MPU pwr domain has MEM bank 0 bits
  51                                           * in MEM bank 1 position. This is
  52                                           * true for OMAP3430
  53                                           */
  54 #define PWRDM_HAS_LOWPOWERSTATECHANGE   (1 << 2) /*
  55                                                   * support to transition from a
  56                                                   * sleep state to a lower sleep
  57                                                   * state without waking up the
  58                                                   * powerdomain
  59                                                   */
  60
  61 /*
  62  * Number of memory banks that are power-controllable.  On OMAP4430, the
  63  * maximum is 5.
  64  */
  65 #define PWRDM_MAX_MEM_BANKS     5
  66
  67 /*
  68  * Maximum number of clockdomains that can be associated with a powerdomain.
  69  * CORE powerdomain on OMAP4 is the worst case
  70  */
  71 #define PWRDM_MAX_CLKDMS        9
  72
  73 /* XXX A completely arbitrary number. What is reasonable here? */
  74 #define PWRDM_TRANSITION_BAILOUT 100000
  75
  76 struct clockdomain;
  77 struct powerdomain;
  78
  79 /**
  80  * struct powerdomain - OMAP powerdomain
  81  * @name: Powerdomain name
  82  * @omap_chip: represents the OMAP chip types containing this pwrdm
  83  * @prcm_offs: the address offset from CM_BASE/PRM_BASE
  84  * @pwrsts: Possible powerdomain power states
  85  * @pwrsts_logic_ret: Possible logic power states when pwrdm in RETENTION
  86  * @flags: Powerdomain flags
  87  * @banks: Number of software-controllable memory banks in this powerdomain
  88  * @pwrsts_mem_ret: Possible memory bank pwrstates when pwrdm in RETENTION
  89  * @pwrsts_mem_on: Possible memory bank pwrstates when pwrdm in ON
  90  * @pwrdm_clkdms: Clockdomains in this powerdomain
  91  * @node: list_head linking all powerdomains
  92  * @state:
  93  * @state_counter:
  94  * @timer:
  95  * @state_timer:
  96  */
  97 struct powerdomain {
  98         const char *name;
  99         const struct omap_chip_id omap_chip;
 100         const s16 prcm_offs;
 101         const u8 pwrsts;
 102         const u8 pwrsts_logic_ret;
 103         const u8 flags;
 104         const u8 banks;
 105         const u8 pwrsts_mem_ret[PWRDM_MAX_MEM_BANKS];
 106         const u8 pwrsts_mem_on[PWRDM_MAX_MEM_BANKS];
 107         struct clockdomain *pwrdm_clkdms[PWRDM_MAX_CLKDMS];
 108         struct list_head node;
 109         int state;
 110         unsigned state_counter[PWRDM_MAX_PWRSTS];
 111         unsigned ret_logic_off_counter;
 112         unsigned ret_mem_off_counter[PWRDM_MAX_MEM_BANKS];
 113
 114 #ifdef CONFIG_PM_DEBUG
 115         s64 timer;
 116         s64 state_timer[PWRDM_MAX_PWRSTS];
 117 #endif
 118 };
 119
 120 /**
 121  * struct pwrdm_ops - Arch specfic function implementations
 122  * @pwrdm_set_next_pwrst: Set the target power state for a pd
 123  * @pwrdm_read_next_pwrst: Read the target power state set for a pd
 124  * @pwrdm_read_pwrst: Read the current power state of a pd
 125  * @pwrdm_read_prev_pwrst: Read the prev power state entered by the pd
 126  * @pwrdm_set_logic_retst: Set the logic state in RET for a pd
 127  * @pwrdm_set_mem_onst: Set the Memory state in ON for a pd
 128  * @pwrdm_set_mem_retst: Set the Memory state in RET for a pd
 129  * @pwrdm_read_logic_pwrst: Read the current logic state of a pd
 130  * @pwrdm_read_prev_logic_pwrst: Read the previous logic state entered by a pd
 131  * @pwrdm_read_logic_retst: Read the logic state in RET for a pd
 132  * @pwrdm_read_mem_pwrst: Read the current memory state of a pd
 133  * @pwrdm_read_prev_mem_pwrst: Read the previous memory state entered by a pd
 134  * @pwrdm_read_mem_retst: Read the memory state in RET for a pd
 135  * @pwrdm_clear_all_prev_pwrst: Clear all previous power states logged for a pd
 136  * @pwrdm_enable_hdwr_sar: Enable Hardware Save-Restore feature for the pd
 137  * @pwrdm_disable_hdwr_sar: Disable Hardware Save-Restore feature for a pd
 138  * @pwrdm_set_lowpwrstchange: Enable pd transitions from a shallow to deep sleep
 139  * @pwrdm_wait_transition: Wait for a pd state transition to complete
 140  */
 141 struct pwrdm_ops {
 142         int     (*pwrdm_set_next_pwrst)(struct powerdomain *pwrdm, u8 pwrst);
 143         int     (*pwrdm_read_next_pwrst)(struct powerdomain *pwrdm);
 144         int     (*pwrdm_read_pwrst)(struct powerdomain *pwrdm);
 145         int     (*pwrdm_read_prev_pwrst)(struct powerdomain *pwrdm);
 146         int     (*pwrdm_set_logic_retst)(struct powerdomain *pwrdm, u8 pwrst);
 147         int     (*pwrdm_set_mem_onst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 148         int     (*pwrdm_set_mem_retst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 149         int     (*pwrdm_read_logic_pwrst)(struct powerdomain *pwrdm);
 150         int     (*pwrdm_read_prev_logic_pwrst)(struct powerdomain *pwrdm);
 151         int     (*pwrdm_read_logic_retst)(struct powerdomain *pwrdm);
 152         int     (*pwrdm_read_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
 153         int     (*pwrdm_read_prev_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
 154         int     (*pwrdm_read_mem_retst)(struct powerdomain *pwrdm, u8 bank);
 155         int     (*pwrdm_clear_all_prev_pwrst)(struct powerdomain *pwrdm);
 156         int     (*pwrdm_enable_hdwr_sar)(struct powerdomain *pwrdm);
 157         int     (*pwrdm_disable_hdwr_sar)(struct powerdomain *pwrdm);
 158         int     (*pwrdm_set_lowpwrstchange)(struct powerdomain *pwrdm);
 159         int     (*pwrdm_wait_transition)(struct powerdomain *pwrdm);
 160 };
 161
 162 void pwrdm_fw_init(void);
 163 void pwrdm_init(struct powerdomain **pwrdm_list, struct pwrdm_ops *custom_funcs);
 164
 165 struct powerdomain *pwrdm_lookup(const char *name);
 166
 167 int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
 168                         void *user);
 169 int pwrdm_for_each_nolock(int (*fn)(struct powerdomain *pwrdm, void *user),
 170                         void *user);
 171
 172 int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
 173 int pwrdm_del_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
 174 int pwrdm_for_each_clkdm(struct powerdomain *pwrdm,
 175                          int (*fn)(struct powerdomain *pwrdm,
 176                                    struct clockdomain *clkdm));
 177
 178 int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm);
 179
 180 int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst);
 181 int pwrdm_read_next_pwrst(struct powerdomain *pwrdm);
 182 int pwrdm_read_pwrst(struct powerdomain *pwrdm);
 183 int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm);
 184 int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm);
 185
 186 int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst);
 187 int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 188 int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 189
 190 int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm);
 191 int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm);
 192 int pwrdm_read_logic_retst(struct powerdomain *pwrdm);
 193 int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
 194 int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
 195 int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank);
 196
 197 int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm);
 198 int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm);
 199 bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm);
 200
 201 int pwrdm_wait_transition(struct powerdomain *pwrdm);
 202
 203 int pwrdm_state_switch(struct powerdomain *pwrdm);
 204 int pwrdm_clkdm_state_switch(struct clockdomain *clkdm);
 205 int pwrdm_pre_transition(void);
 206 int pwrdm_post_transition(void);
 207 int pwrdm_set_lowpwrstchange(struct powerdomain *pwrdm);
 208
 209 #endif