Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Dan Handley | e83b0ca | 2014-01-14 18:17:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 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 | |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 34 | #include <bakery_lock.h> |
| 35 | #include <platform_def.h> /* for PLATFORM_NUM_AFFS */ |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 36 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 37 | /******************************************************************************* |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 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 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 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 |
Jeenu Viswambharan | 1814a3e | 2014-02-28 10:08:33 +0000 | [diff] [blame] | 62 | #define PSCI_SYSTEM_OFF 0x84000008 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 63 | #define PSCI_SYSTEM_RESET 0x84000009 |
Soby Mathew | 6cdddaf | 2015-01-07 11:10:22 +0000 | [diff] [blame] | 64 | #define PSCI_FEATURES 0x8400000A |
| 65 | |
| 66 | /* Macro to help build the psci capabilities bitfield */ |
| 67 | #define define_psci_cap(x) (1 << (x & 0x1f)) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 68 | |
Jeenu Viswambharan | 1814a3e | 2014-02-28 10:08:33 +0000 | [diff] [blame] | 69 | /* |
Juan Castillo | 4dc4a47 | 2014-08-12 11:17:06 +0100 | [diff] [blame] | 70 | * Number of PSCI calls (above) implemented |
Jeenu Viswambharan | 1814a3e | 2014-02-28 10:08:33 +0000 | [diff] [blame] | 71 | */ |
Soby Mathew | 6cdddaf | 2015-01-07 11:10:22 +0000 | [diff] [blame] | 72 | #define PSCI_NUM_CALLS 16 |
Jeenu Viswambharan | 1814a3e | 2014-02-28 10:08:33 +0000 | [diff] [blame] | 73 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 74 | /******************************************************************************* |
| 75 | * PSCI Migrate and friends |
| 76 | ******************************************************************************/ |
| 77 | #define PSCI_TOS_UP_MIG_CAP 0 |
| 78 | #define PSCI_TOS_NOT_UP_MIG_CAP 1 |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 79 | #define PSCI_TOS_NOT_PRESENT_MP 2 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 80 | |
| 81 | /******************************************************************************* |
| 82 | * PSCI CPU_SUSPEND 'power_state' parameter specific defines |
| 83 | ******************************************************************************/ |
Achin Gupta | 994dfce | 2013-10-26 13:10:31 +0100 | [diff] [blame] | 84 | #define PSTATE_ID_SHIFT 0 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 85 | #define PSTATE_TYPE_SHIFT 16 |
Achin Gupta | 994dfce | 2013-10-26 13:10:31 +0100 | [diff] [blame] | 86 | #define PSTATE_AFF_LVL_SHIFT 24 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 87 | |
| 88 | #define PSTATE_ID_MASK 0xffff |
| 89 | #define PSTATE_TYPE_MASK 0x1 |
| 90 | #define PSTATE_AFF_LVL_MASK 0x3 |
Vikram Kanigiri | f100f41 | 2014-04-01 19:26:26 +0100 | [diff] [blame] | 91 | #define PSTATE_VALID_MASK 0xFCFE0000 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 92 | |
Vikram Kanigiri | 3b7c59b | 2014-03-21 11:57:10 +0000 | [diff] [blame] | 93 | #define PSTATE_TYPE_STANDBY 0x0 |
| 94 | #define PSTATE_TYPE_POWERDOWN 0x1 |
| 95 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 96 | #define psci_get_pstate_id(pstate) ((pstate >> PSTATE_ID_SHIFT) & \ |
| 97 | PSTATE_ID_MASK) |
| 98 | #define psci_get_pstate_type(pstate) ((pstate >> PSTATE_TYPE_SHIFT) & \ |
| 99 | PSTATE_TYPE_MASK) |
| 100 | #define psci_get_pstate_afflvl(pstate) ((pstate >> PSTATE_AFF_LVL_SHIFT) & \ |
| 101 | PSTATE_AFF_LVL_MASK) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 102 | |
| 103 | /******************************************************************************* |
Soby Mathew | 6cdddaf | 2015-01-07 11:10:22 +0000 | [diff] [blame] | 104 | * PSCI CPU_FEATURES feature flag specific defines |
| 105 | ******************************************************************************/ |
| 106 | /* Features flags for CPU SUSPEND power state parameter format. Bits [1:1] */ |
| 107 | #define FF_PSTATE_SHIFT 1 |
| 108 | #define FF_PSTATE_ORIG 0 |
| 109 | #define FF_PSTATE_EXTENDED 1 |
| 110 | |
| 111 | /* Features flags for CPU SUSPEND OS Initiated mode support. Bits [0:0] */ |
| 112 | #define FF_MODE_SUPPORT_SHIFT 0 |
| 113 | #define FF_SUPPORTS_OS_INIT_MODE 1 |
| 114 | |
| 115 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 116 | * PSCI version |
| 117 | ******************************************************************************/ |
Soby Mathew | 1df077b | 2015-01-15 11:49:58 +0000 | [diff] [blame] | 118 | #define PSCI_MAJOR_VER (1 << 16) |
| 119 | #define PSCI_MINOR_VER 0x0 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 120 | |
| 121 | /******************************************************************************* |
| 122 | * PSCI error codes |
| 123 | ******************************************************************************/ |
| 124 | #define PSCI_E_SUCCESS 0 |
| 125 | #define PSCI_E_NOT_SUPPORTED -1 |
| 126 | #define PSCI_E_INVALID_PARAMS -2 |
| 127 | #define PSCI_E_DENIED -3 |
| 128 | #define PSCI_E_ALREADY_ON -4 |
| 129 | #define PSCI_E_ON_PENDING -5 |
| 130 | #define PSCI_E_INTERN_FAIL -6 |
| 131 | #define PSCI_E_NOT_PRESENT -7 |
| 132 | #define PSCI_E_DISABLED -8 |
| 133 | |
| 134 | /******************************************************************************* |
| 135 | * PSCI affinity state related constants. An affinity instance could be present |
| 136 | * or absent physically to cater for asymmetric topologies. If present then it |
| 137 | * could in one of the 4 further defined states. |
| 138 | ******************************************************************************/ |
| 139 | #define PSCI_STATE_SHIFT 1 |
Achin Gupta | 75f7367 | 2013-12-05 16:33:10 +0000 | [diff] [blame] | 140 | #define PSCI_STATE_MASK 0xff |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 141 | |
| 142 | #define PSCI_AFF_ABSENT 0x0 |
| 143 | #define PSCI_AFF_PRESENT 0x1 |
Achin Gupta | 994dfce | 2013-10-26 13:10:31 +0100 | [diff] [blame] | 144 | #define PSCI_STATE_ON 0x0 |
| 145 | #define PSCI_STATE_OFF 0x1 |
| 146 | #define PSCI_STATE_ON_PENDING 0x2 |
| 147 | #define PSCI_STATE_SUSPEND 0x3 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 148 | |
Vikram Kanigiri | f100f41 | 2014-04-01 19:26:26 +0100 | [diff] [blame] | 149 | #define PSCI_INVALID_DATA -1 |
| 150 | |
Achin Gupta | 75f7367 | 2013-12-05 16:33:10 +0000 | [diff] [blame] | 151 | #define get_phys_state(x) (x != PSCI_STATE_ON ? \ |
| 152 | PSCI_STATE_OFF : PSCI_STATE_ON) |
| 153 | |
Vikram Kanigiri | f100f41 | 2014-04-01 19:26:26 +0100 | [diff] [blame] | 154 | #define psci_validate_power_state(pstate) (pstate & PSTATE_VALID_MASK) |
| 155 | |
| 156 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 157 | #ifndef __ASSEMBLY__ |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 158 | |
| 159 | #include <stdint.h> |
| 160 | |
Achin Gupta | f3ccbab | 2014-07-25 14:52:47 +0100 | [diff] [blame] | 161 | /******************************************************************************* |
| 162 | * Structure used to store per-cpu information relevant to the PSCI service. |
| 163 | * It is populated in the per-cpu data array. In return we get a guarantee that |
| 164 | * this information will not reside on a cache line shared with another cpu. |
| 165 | ******************************************************************************/ |
| 166 | typedef struct psci_cpu_data { |
| 167 | uint32_t power_state; |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 168 | uint32_t max_phys_off_afflvl; /* Highest affinity level in physically |
| 169 | powered off state */ |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 170 | #if !USE_COHERENT_MEM |
| 171 | bakery_info_t pcpu_bakery_info[PSCI_NUM_AFFS]; |
| 172 | #endif |
Achin Gupta | f3ccbab | 2014-07-25 14:52:47 +0100 | [diff] [blame] | 173 | } psci_cpu_data_t; |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 174 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 175 | /******************************************************************************* |
| 176 | * Structure populated by platform specific code to export routines which |
| 177 | * perform common low level pm functions |
| 178 | ******************************************************************************/ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 179 | typedef struct plat_pm_ops { |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 180 | void (*affinst_standby)(unsigned int power_state); |
Soby Mathew | ffb4ab1 | 2014-09-26 15:08:52 +0100 | [diff] [blame] | 181 | int (*affinst_on)(unsigned long mpidr, |
| 182 | unsigned long sec_entrypoint, |
| 183 | unsigned int afflvl, |
| 184 | unsigned int state); |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 185 | void (*affinst_off)(unsigned int afflvl, unsigned int state); |
| 186 | void (*affinst_suspend)(unsigned long sec_entrypoint, |
Soby Mathew | ffb4ab1 | 2014-09-26 15:08:52 +0100 | [diff] [blame] | 187 | unsigned int afflvl, |
| 188 | unsigned int state); |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 189 | void (*affinst_on_finish)(unsigned int afflvl, unsigned int state); |
| 190 | void (*affinst_suspend_finish)(unsigned int afflvl, |
Soby Mathew | ffb4ab1 | 2014-09-26 15:08:52 +0100 | [diff] [blame] | 191 | unsigned int state); |
Juan Castillo | 4dc4a47 | 2014-08-12 11:17:06 +0100 | [diff] [blame] | 192 | void (*system_off)(void) __dead2; |
| 193 | void (*system_reset)(void) __dead2; |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 194 | int (*validate_power_state)(unsigned int power_state); |
| 195 | int (*validate_ns_entrypoint)(unsigned long ns_entrypoint); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 196 | } plat_pm_ops_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 197 | |
| 198 | /******************************************************************************* |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 199 | * Optional structure populated by the Secure Payload Dispatcher to be given a |
| 200 | * chance to perform any bookkeeping before PSCI executes a power mgmt. |
| 201 | * operation. It also allows PSCI to determine certain properties of the SP e.g. |
| 202 | * migrate capability etc. |
| 203 | ******************************************************************************/ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 204 | typedef struct spd_pm_ops { |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 205 | void (*svc_on)(uint64_t target_cpu); |
| 206 | int32_t (*svc_off)(uint64_t __unused); |
Soby Mathew | f512157 | 2014-09-30 11:19:51 +0100 | [diff] [blame] | 207 | void (*svc_suspend)(uint64_t __unused); |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 208 | void (*svc_on_finish)(uint64_t __unused); |
| 209 | void (*svc_suspend_finish)(uint64_t suspend_level); |
Soby Mathew | 110fe36 | 2014-10-23 10:35:34 +0100 | [diff] [blame] | 210 | int32_t (*svc_migrate)(uint64_t from_cpu, uint64_t to_cpu); |
| 211 | int32_t (*svc_migrate_info)(uint64_t *resident_cpu); |
Juan Castillo | 4dc4a47 | 2014-08-12 11:17:06 +0100 | [diff] [blame] | 212 | void (*svc_system_off)(void); |
| 213 | void (*svc_system_reset)(void); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 214 | } spd_pm_ops_t; |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 215 | |
| 216 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 217 | * Function & Data prototypes |
| 218 | ******************************************************************************/ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 219 | unsigned int psci_version(void); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 220 | int psci_affinity_info(unsigned long, unsigned int); |
Soby Mathew | 110fe36 | 2014-10-23 10:35:34 +0100 | [diff] [blame] | 221 | int psci_migrate(unsigned long); |
| 222 | int psci_migrate_info_type(void); |
| 223 | long psci_migrate_info_up_cpu(void); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 224 | int psci_cpu_on(unsigned long, |
| 225 | unsigned long, |
| 226 | unsigned long); |
| 227 | void __dead2 psci_power_down_wfi(void); |
| 228 | void psci_aff_on_finish_entry(void); |
| 229 | void psci_aff_suspend_finish_entry(void); |
| 230 | void psci_register_spd_pm_hook(const spd_pm_ops_t *); |
Achin Gupta | f3ccbab | 2014-07-25 14:52:47 +0100 | [diff] [blame] | 231 | int psci_get_suspend_stateid_by_mpidr(unsigned long); |
| 232 | int psci_get_suspend_stateid(void); |
| 233 | int psci_get_suspend_afflvl(void); |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 234 | uint32_t psci_get_max_phys_off_afflvl(void); |
Vikram Kanigiri | f100f41 | 2014-04-01 19:26:26 +0100 | [diff] [blame] | 235 | |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 236 | uint64_t psci_smc_handler(uint32_t smc_fid, |
| 237 | uint64_t x1, |
| 238 | uint64_t x2, |
| 239 | uint64_t x3, |
| 240 | uint64_t x4, |
| 241 | void *cookie, |
| 242 | void *handle, |
| 243 | uint64_t flags); |
Dan Handley | 27f6e7d | 2014-04-23 15:22:18 +0100 | [diff] [blame] | 244 | |
| 245 | /* PSCI setup function */ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 246 | int32_t psci_setup(void); |
Dan Handley | 27f6e7d | 2014-04-23 15:22:18 +0100 | [diff] [blame] | 247 | |
| 248 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 249 | #endif /*__ASSEMBLY__*/ |
| 250 | |
| 251 | |
| 252 | #endif /* __PSCI_H__ */ |