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_OFF_ON           ((1 << PWRDM_POWER_OFF) | \
  35                                  (1 << PWRDM_POWER_ON))
  36
  37 #define PWRSTS_OFF_RET          ((1 << PWRDM_POWER_OFF) | \
  38                                  (1 << PWRDM_POWER_RET))
  39
  40 #define PWRSTS_RET_ON           ((1 << PWRDM_POWER_RET) | \
  41                                  (1 << PWRDM_POWER_ON))
  42
  43 #define PWRSTS_OFF_RET_ON       (PWRSTS_OFF_RET | (1 << PWRDM_POWER_ON))
  44
  45
  46 /* Powerdomain flags */
  47 #define PWRDM_HAS_HDWR_SAR      (1 << 0) /* hardware save-and-restore support */
  48 #define PWRDM_HAS_MPU_QUIRK     (1 << 1) /* MPU pwr domain has MEM bank 0 bits
  49                                           * in MEM bank 1 position. This is
  50                                           * true for OMAP3430
  51                                           */
  52
  53 /*
  54  * Number of memory banks that are power-controllable.  On OMAP4430, the
  55  * maximum is 5.
  56  */
  57 #define PWRDM_MAX_MEM_BANKS     5
  58
  59 /*
  60  * Maximum number of clockdomains that can be associated with a powerdomain.
  61  * CORE powerdomain on OMAP4 is the worst case
  62  */
  63 #define PWRDM_MAX_CLKDMS        9
  64
  65 /* XXX A completely arbitrary number. What is reasonable here? */
  66 #define PWRDM_TRANSITION_BAILOUT 100000
  67
  68 struct clockdomain;
  69 struct powerdomain;
  70
  71 /**
  72  * struct powerdomain - OMAP powerdomain
  73  * @name: Powerdomain name
  74  * @omap_chip: represents the OMAP chip types containing this pwrdm
  75  * @prcm_offs: the address offset from CM_BASE/PRM_BASE
  76  * @pwrsts: Possible powerdomain power states
  77  * @pwrsts_logic_ret: Possible logic power states when pwrdm in RETENTION
  78  * @flags: Powerdomain flags
  79  * @banks: Number of software-controllable memory banks in this powerdomain
  80  * @pwrsts_mem_ret: Possible memory bank pwrstates when pwrdm in RETENTION
  81  * @pwrsts_mem_on: Possible memory bank pwrstates when pwrdm in ON
  82  * @pwrdm_clkdms: Clockdomains in this powerdomain
  83  * @node: list_head linking all powerdomains
  84  * @state:
  85  * @state_counter:
  86  * @timer:
  87  * @state_timer:
  88  */
  89 struct powerdomain {
  90         const char *name;
  91         const struct omap_chip_id omap_chip;
  92         const s16 prcm_offs;
  93         const u8 pwrsts;
  94         const u8 pwrsts_logic_ret;
  95         const u8 flags;
  96         const u8 banks;
  97         const u8 pwrsts_mem_ret[PWRDM_MAX_MEM_BANKS];
  98         const u8 pwrsts_mem_on[PWRDM_MAX_MEM_BANKS];
  99         struct clockdomain *pwrdm_clkdms[PWRDM_MAX_CLKDMS];
 100         struct list_head node;
 101         int state;
 102         unsigned state_counter[PWRDM_MAX_PWRSTS];
 103         unsigned ret_logic_off_counter;
 104         unsigned ret_mem_off_counter[PWRDM_MAX_MEM_BANKS];
 105
 106 #ifdef CONFIG_PM_DEBUG
 107         s64 timer;
 108         s64 state_timer[PWRDM_MAX_PWRSTS];
 109 #endif
 110 };
 111
 112
 113 void pwrdm_init(struct powerdomain **pwrdm_list);
 114
 115 struct powerdomain *pwrdm_lookup(const char *name);
 116
 117 int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
 118                         void *user);
 119 int pwrdm_for_each_nolock(int (*fn)(struct powerdomain *pwrdm, void *user),
 120                         void *user);
 121
 122 int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
 123 int pwrdm_del_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
 124 int pwrdm_for_each_clkdm(struct powerdomain *pwrdm,
 125                          int (*fn)(struct powerdomain *pwrdm,
 126                                    struct clockdomain *clkdm));
 127
 128 int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm);
 129
 130 int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst);
 131 int pwrdm_read_next_pwrst(struct powerdomain *pwrdm);
 132 int pwrdm_read_pwrst(struct powerdomain *pwrdm);
 133 int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm);
 134 int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm);
 135
 136 int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst);
 137 int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 138 int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
 139
 140 int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm);
 141 int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm);
 142 int pwrdm_read_logic_retst(struct powerdomain *pwrdm);
 143 int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
 144 int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
 145 int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank);
 146
 147 int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm);
 148 int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm);
 149 bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm);
 150
 151 int pwrdm_wait_transition(struct powerdomain *pwrdm);
 152
 153 int pwrdm_state_switch(struct powerdomain *pwrdm);
 154 int pwrdm_clkdm_state_switch(struct clockdomain *clkdm);
 155 int pwrdm_pre_transition(void);
 156 int pwrdm_post_transition(void);
 157
 158 #endif