1 /* 2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __PSCI_H__ 32 #define __PSCI_H__ 33 34 #include <bakery_lock.h> 35 #include <platform_def.h> /* for PLATFORM_NUM_AFFS */ 36 37 /******************************************************************************* 38 * Number of affinity instances whose state this psci imp. can track 39 ******************************************************************************/ 40 #ifdef PLATFORM_NUM_AFFS 41 #define PSCI_NUM_AFFS PLATFORM_NUM_AFFS 42 #else 43 #define PSCI_NUM_AFFS (2 * PLATFORM_CORE_COUNT) 44 #endif 45 46 /******************************************************************************* 47 * Defines for runtime services func ids 48 ******************************************************************************/ 49 #define PSCI_VERSION 0x84000000 50 #define PSCI_CPU_SUSPEND_AARCH32 0x84000001 51 #define PSCI_CPU_SUSPEND_AARCH64 0xc4000001 52 #define PSCI_CPU_OFF 0x84000002 53 #define PSCI_CPU_ON_AARCH32 0x84000003 54 #define PSCI_CPU_ON_AARCH64 0xc4000003 55 #define PSCI_AFFINITY_INFO_AARCH32 0x84000004 56 #define PSCI_AFFINITY_INFO_AARCH64 0xc4000004 57 #define PSCI_MIG_AARCH32 0x84000005 58 #define PSCI_MIG_AARCH64 0xc4000005 59 #define PSCI_MIG_INFO_TYPE 0x84000006 60 #define PSCI_MIG_INFO_UP_CPU_AARCH32 0x84000007 61 #define PSCI_MIG_INFO_UP_CPU_AARCH64 0xc4000007 62 #define PSCI_SYSTEM_OFF 0x84000008 63 #define PSCI_SYSTEM_RESET 0x84000009 64 #define PSCI_FEATURES 0x8400000A 65 #define PSCI_SYSTEM_SUSPEND_AARCH32 0x8400000E 66 #define PSCI_SYSTEM_SUSPEND_AARCH64 0xc400000E 67 68 /* Macro to help build the psci capabilities bitfield */ 69 #define define_psci_cap(x) (1 << (x & 0x1f)) 70 71 /* 72 * Number of PSCI calls (above) implemented 73 */ 74 #define PSCI_NUM_CALLS 18 75 76 /******************************************************************************* 77 * PSCI Migrate and friends 78 ******************************************************************************/ 79 #define PSCI_TOS_UP_MIG_CAP 0 80 #define PSCI_TOS_NOT_UP_MIG_CAP 1 81 #define PSCI_TOS_NOT_PRESENT_MP 2 82 83 /******************************************************************************* 84 * PSCI CPU_SUSPEND 'power_state' parameter specific defines 85 ******************************************************************************/ 86 #define PSTATE_ID_SHIFT 0 87 #define PSTATE_TYPE_SHIFT 16 88 #define PSTATE_AFF_LVL_SHIFT 24 89 90 #define PSTATE_ID_MASK 0xffff 91 #define PSTATE_TYPE_MASK 0x1 92 #define PSTATE_AFF_LVL_MASK 0x3 93 #define PSTATE_VALID_MASK 0xFCFE0000 94 95 #define PSTATE_TYPE_STANDBY 0x0 96 #define PSTATE_TYPE_POWERDOWN 0x1 97 98 #define psci_get_pstate_id(pstate) (((pstate) >> PSTATE_ID_SHIFT) & \ 99 PSTATE_ID_MASK) 100 #define psci_get_pstate_type(pstate) (((pstate) >> PSTATE_TYPE_SHIFT) & \ 101 PSTATE_TYPE_MASK) 102 #define psci_get_pstate_afflvl(pstate) (((pstate) >> PSTATE_AFF_LVL_SHIFT) & \ 103 PSTATE_AFF_LVL_MASK) 104 #define psci_make_powerstate(state_id, type, afflvl) \ 105 (((state_id) & PSTATE_ID_MASK) << PSTATE_ID_SHIFT) |\ 106 (((type) & PSTATE_TYPE_MASK) << PSTATE_TYPE_SHIFT) |\ 107 (((afflvl) & PSTATE_AFF_LVL_MASK) << PSTATE_AFF_LVL_SHIFT) 108 109 /******************************************************************************* 110 * PSCI CPU_FEATURES feature flag specific defines 111 ******************************************************************************/ 112 /* Features flags for CPU SUSPEND power state parameter format. Bits [1:1] */ 113 #define FF_PSTATE_SHIFT 1 114 #define FF_PSTATE_ORIG 0 115 #define FF_PSTATE_EXTENDED 1 116 117 /* Features flags for CPU SUSPEND OS Initiated mode support. Bits [0:0] */ 118 #define FF_MODE_SUPPORT_SHIFT 0 119 #define FF_SUPPORTS_OS_INIT_MODE 1 120 121 /******************************************************************************* 122 * PSCI version 123 ******************************************************************************/ 124 #define PSCI_MAJOR_VER (1 << 16) 125 #define PSCI_MINOR_VER 0x0 126 127 /******************************************************************************* 128 * PSCI error codes 129 ******************************************************************************/ 130 #define PSCI_E_SUCCESS 0 131 #define PSCI_E_NOT_SUPPORTED -1 132 #define PSCI_E_INVALID_PARAMS -2 133 #define PSCI_E_DENIED -3 134 #define PSCI_E_ALREADY_ON -4 135 #define PSCI_E_ON_PENDING -5 136 #define PSCI_E_INTERN_FAIL -6 137 #define PSCI_E_NOT_PRESENT -7 138 #define PSCI_E_DISABLED -8 139 140 /******************************************************************************* 141 * PSCI affinity state related constants. An affinity instance could be present 142 * or absent physically to cater for asymmetric topologies. If present then it 143 * could in one of the 4 further defined states. 144 ******************************************************************************/ 145 #define PSCI_STATE_SHIFT 1 146 #define PSCI_STATE_MASK 0xff 147 148 #define PSCI_AFF_ABSENT 0x0 149 #define PSCI_AFF_PRESENT 0x1 150 #define PSCI_STATE_ON 0x0 151 #define PSCI_STATE_OFF 0x1 152 #define PSCI_STATE_ON_PENDING 0x2 153 #define PSCI_STATE_SUSPEND 0x3 154 155 #define PSCI_INVALID_DATA -1 156 157 #define get_phys_state(x) (x != PSCI_STATE_ON ? \ 158 PSCI_STATE_OFF : PSCI_STATE_ON) 159 160 #define psci_validate_power_state(pstate) (pstate & PSTATE_VALID_MASK) 161 162 163 #ifndef __ASSEMBLY__ 164 165 #include <stdint.h> 166 167 /******************************************************************************* 168 * Structure used to store per-cpu information relevant to the PSCI service. 169 * It is populated in the per-cpu data array. In return we get a guarantee that 170 * this information will not reside on a cache line shared with another cpu. 171 ******************************************************************************/ 172 typedef struct psci_cpu_data { 173 uint32_t power_state; 174 uint32_t max_phys_off_afflvl; /* Highest affinity level in physically 175 powered off state */ 176 #if !USE_COHERENT_MEM 177 bakery_info_t pcpu_bakery_info[PSCI_NUM_AFFS]; 178 #endif 179 } psci_cpu_data_t; 180 181 /******************************************************************************* 182 * Structure populated by platform specific code to export routines which 183 * perform common low level pm functions 184 ******************************************************************************/ 185 typedef struct plat_pm_ops { 186 void (*affinst_standby)(unsigned int power_state); 187 int (*affinst_on)(unsigned long mpidr, 188 unsigned long sec_entrypoint, 189 unsigned int afflvl, 190 unsigned int state); 191 void (*affinst_off)(unsigned int afflvl, unsigned int state); 192 void (*affinst_suspend)(unsigned long sec_entrypoint, 193 unsigned int afflvl, 194 unsigned int state); 195 void (*affinst_on_finish)(unsigned int afflvl, unsigned int state); 196 void (*affinst_suspend_finish)(unsigned int afflvl, 197 unsigned int state); 198 void (*system_off)(void) __dead2; 199 void (*system_reset)(void) __dead2; 200 int (*validate_power_state)(unsigned int power_state); 201 int (*validate_ns_entrypoint)(unsigned long ns_entrypoint); 202 unsigned int (*get_sys_suspend_power_state)(void); 203 } plat_pm_ops_t; 204 205 /******************************************************************************* 206 * Optional structure populated by the Secure Payload Dispatcher to be given a 207 * chance to perform any bookkeeping before PSCI executes a power mgmt. 208 * operation. It also allows PSCI to determine certain properties of the SP e.g. 209 * migrate capability etc. 210 ******************************************************************************/ 211 typedef struct spd_pm_ops { 212 void (*svc_on)(uint64_t target_cpu); 213 int32_t (*svc_off)(uint64_t __unused); 214 void (*svc_suspend)(uint64_t __unused); 215 void (*svc_on_finish)(uint64_t __unused); 216 void (*svc_suspend_finish)(uint64_t suspend_level); 217 int32_t (*svc_migrate)(uint64_t from_cpu, uint64_t to_cpu); 218 int32_t (*svc_migrate_info)(uint64_t *resident_cpu); 219 void (*svc_system_off)(void); 220 void (*svc_system_reset)(void); 221 } spd_pm_ops_t; 222 223 /******************************************************************************* 224 * Function & Data prototypes 225 ******************************************************************************/ 226 unsigned int psci_version(void); 227 int psci_affinity_info(unsigned long, unsigned int); 228 int psci_migrate(unsigned long); 229 int psci_migrate_info_type(void); 230 long psci_migrate_info_up_cpu(void); 231 int psci_cpu_on(unsigned long, 232 unsigned long, 233 unsigned long); 234 void __dead2 psci_power_down_wfi(void); 235 void psci_aff_on_finish_entry(void); 236 void psci_aff_suspend_finish_entry(void); 237 void psci_register_spd_pm_hook(const spd_pm_ops_t *); 238 int psci_get_suspend_stateid_by_mpidr(unsigned long); 239 int psci_get_suspend_stateid(void); 240 int psci_get_suspend_afflvl(void); 241 uint32_t psci_get_max_phys_off_afflvl(void); 242 243 uint64_t psci_smc_handler(uint32_t smc_fid, 244 uint64_t x1, 245 uint64_t x2, 246 uint64_t x3, 247 uint64_t x4, 248 void *cookie, 249 void *handle, 250 uint64_t flags); 251 252 /* PSCI setup function */ 253 int32_t psci_setup(void); 254 255 256 #endif /*__ASSEMBLY__*/ 257 258 259 #endif /* __PSCI_H__ */ 260
