/* * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * Neither the name of ARM nor the names of its contributors may be used * to endorse or promote products derived from this software without specific * prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #ifndef __PSCI_H__ #define __PSCI_H__ #include #include /* for PLAT_NUM_PWR_DOMAINS */ #if ENABLE_PLAT_COMPAT #include #endif /******************************************************************************* * Number of power domains whose state this PSCI implementation can track ******************************************************************************/ #ifdef PLAT_NUM_PWR_DOMAINS #define PSCI_NUM_PWR_DOMAINS PLAT_NUM_PWR_DOMAINS #else #define PSCI_NUM_PWR_DOMAINS (2 * PLATFORM_CORE_COUNT) #endif #define PSCI_NUM_NON_CPU_PWR_DOMAINS (PSCI_NUM_PWR_DOMAINS - \ PLATFORM_CORE_COUNT) /* This is the power level corresponding to a CPU */ #define PSCI_CPU_PWR_LVL 0 /* * The maximum power level supported by PSCI. Since PSCI CPU_SUSPEND * uses the old power_state parameter format which has 2 bits to specify the * power level, this constant is defined to be 3. */ #define PSCI_MAX_PWR_LVL 3 /******************************************************************************* * Defines for runtime services function ids ******************************************************************************/ #define PSCI_VERSION 0x84000000 #define PSCI_CPU_SUSPEND_AARCH32 0x84000001 #define PSCI_CPU_SUSPEND_AARCH64 0xc4000001 #define PSCI_CPU_OFF 0x84000002 #define PSCI_CPU_ON_AARCH32 0x84000003 #define PSCI_CPU_ON_AARCH64 0xc4000003 #define PSCI_AFFINITY_INFO_AARCH32 0x84000004 #define PSCI_AFFINITY_INFO_AARCH64 0xc4000004 #define PSCI_MIG_AARCH32 0x84000005 #define PSCI_MIG_AARCH64 0xc4000005 #define PSCI_MIG_INFO_TYPE 0x84000006 #define PSCI_MIG_INFO_UP_CPU_AARCH32 0x84000007 #define PSCI_MIG_INFO_UP_CPU_AARCH64 0xc4000007 #define PSCI_SYSTEM_OFF 0x84000008 #define PSCI_SYSTEM_RESET 0x84000009 #define PSCI_FEATURES 0x8400000A #define PSCI_SYSTEM_SUSPEND_AARCH32 0x8400000E #define PSCI_SYSTEM_SUSPEND_AARCH64 0xc400000E #define PSCI_STAT_RESIDENCY_AARCH32 0x84000010 #define PSCI_STAT_RESIDENCY_AARCH64 0xc4000010 #define PSCI_STAT_COUNT_AARCH32 0x84000011 #define PSCI_STAT_COUNT_AARCH64 0xc4000011 /* Macro to help build the psci capabilities bitfield */ #define define_psci_cap(x) (1 << (x & 0x1f)) /* * Number of PSCI calls (above) implemented */ #if ENABLE_PSCI_STAT #define PSCI_NUM_CALLS 22 #else #define PSCI_NUM_CALLS 18 #endif /******************************************************************************* * PSCI Migrate and friends ******************************************************************************/ #define PSCI_TOS_UP_MIG_CAP 0 #define PSCI_TOS_NOT_UP_MIG_CAP 1 #define PSCI_TOS_NOT_PRESENT_MP 2 /******************************************************************************* * PSCI CPU_SUSPEND 'power_state' parameter specific defines ******************************************************************************/ #define PSTATE_ID_SHIFT 0 #if PSCI_EXTENDED_STATE_ID #define PSTATE_VALID_MASK 0xB0000000 #define PSTATE_TYPE_SHIFT 30 #define PSTATE_ID_MASK 0xfffffff #else #define PSTATE_VALID_MASK 0xFCFE0000 #define PSTATE_TYPE_SHIFT 16 #define PSTATE_PWR_LVL_SHIFT 24 #define PSTATE_ID_MASK 0xffff #define PSTATE_PWR_LVL_MASK 0x3 #define psci_get_pstate_pwrlvl(pstate) (((pstate) >> PSTATE_PWR_LVL_SHIFT) & \ PSTATE_PWR_LVL_MASK) #define psci_make_powerstate(state_id, type, pwrlvl) \ (((state_id) & PSTATE_ID_MASK) << PSTATE_ID_SHIFT) |\ (((type) & PSTATE_TYPE_MASK) << PSTATE_TYPE_SHIFT) |\ (((pwrlvl) & PSTATE_PWR_LVL_MASK) << PSTATE_PWR_LVL_SHIFT) #endif /* __PSCI_EXTENDED_STATE_ID__ */ #define PSTATE_TYPE_STANDBY 0x0 #define PSTATE_TYPE_POWERDOWN 0x1 #define PSTATE_TYPE_MASK 0x1 #define psci_get_pstate_id(pstate) (((pstate) >> PSTATE_ID_SHIFT) & \ PSTATE_ID_MASK) #define psci_get_pstate_type(pstate) (((pstate) >> PSTATE_TYPE_SHIFT) & \ PSTATE_TYPE_MASK) #define psci_check_power_state(pstate) ((pstate) & PSTATE_VALID_MASK) /******************************************************************************* * PSCI CPU_FEATURES feature flag specific defines ******************************************************************************/ /* Features flags for CPU SUSPEND power state parameter format. Bits [1:1] */ #define FF_PSTATE_SHIFT 1 #define FF_PSTATE_ORIG 0 #define FF_PSTATE_EXTENDED 1 #if PSCI_EXTENDED_STATE_ID #define FF_PSTATE FF_PSTATE_EXTENDED #else #define FF_PSTATE FF_PSTATE_ORIG #endif /* Features flags for CPU SUSPEND OS Initiated mode support. Bits [0:0] */ #define FF_MODE_SUPPORT_SHIFT 0 #define FF_SUPPORTS_OS_INIT_MODE 1 /******************************************************************************* * PSCI version ******************************************************************************/ #define PSCI_MAJOR_VER (1 << 16) #define PSCI_MINOR_VER 0x0 /******************************************************************************* * PSCI error codes ******************************************************************************/ #define PSCI_E_SUCCESS 0 #define PSCI_E_NOT_SUPPORTED -1 #define PSCI_E_INVALID_PARAMS -2 #define PSCI_E_DENIED -3 #define PSCI_E_ALREADY_ON -4 #define PSCI_E_ON_PENDING -5 #define PSCI_E_INTERN_FAIL -6 #define PSCI_E_NOT_PRESENT -7 #define PSCI_E_DISABLED -8 #define PSCI_E_INVALID_ADDRESS -9 #define PSCI_INVALID_MPIDR ~((u_register_t)0) #ifndef __ASSEMBLY__ #include #include /* * These are the states reported by the PSCI_AFFINITY_INFO API for the specified * CPU. The definitions of these states can be found in Section 5.7.1 in the * PSCI specification (ARM DEN 0022C). */ typedef enum { AFF_STATE_ON = 0, AFF_STATE_OFF = 1, AFF_STATE_ON_PENDING = 2 } aff_info_state_t; /* * Macro to represent invalid affinity level within PSCI. */ #define PSCI_INVALID_PWR_LVL (PLAT_MAX_PWR_LVL + 1) /* * Type for representing the local power state at a particular level. */ typedef uint8_t plat_local_state_t; /* The local state macro used to represent RUN state. */ #define PSCI_LOCAL_STATE_RUN 0 /* * Macro to test whether the plat_local_state is RUN state */ #define is_local_state_run(plat_local_state) \ ((plat_local_state) == PSCI_LOCAL_STATE_RUN) /* * Macro to test whether the plat_local_state is RETENTION state */ #define is_local_state_retn(plat_local_state) \ (((plat_local_state) > PSCI_LOCAL_STATE_RUN) && \ ((plat_local_state) <= PLAT_MAX_RET_STATE)) /* * Macro to test whether the plat_local_state is OFF state */ #define is_local_state_off(plat_local_state) \ (((plat_local_state) > PLAT_MAX_RET_STATE) && \ ((plat_local_state) <= PLAT_MAX_OFF_STATE)) /***************************************************************************** * This data structure defines the representation of the power state parameter * for its exchange between the generic PSCI code and the platform port. For * example, it is used by the platform port to specify the requested power * states during a power management operation. It is used by the generic code to * inform the platform about the target power states that each level should * enter. ****************************************************************************/ typedef struct psci_power_state { /* * The pwr_domain_state[] stores the local power state at each level * for the CPU. */ plat_local_state_t pwr_domain_state[PLAT_MAX_PWR_LVL + 1]; } psci_power_state_t; /******************************************************************************* * Structure used to store per-cpu information relevant to the PSCI service. * It is populated in the per-cpu data array. In return we get a guarantee that * this information will not reside on a cache line shared with another cpu. ******************************************************************************/ typedef struct psci_cpu_data { /* State as seen by PSCI Affinity Info API */ aff_info_state_t aff_info_state; /* * Highest power level which takes part in a power management * operation. */ unsigned char target_pwrlvl; /* The local power state of this CPU */ plat_local_state_t local_state; } psci_cpu_data_t; /******************************************************************************* * Structure populated by platform specific code to export routines which * perform common low level power management functions ******************************************************************************/ typedef struct plat_psci_ops { void (*cpu_standby)(plat_local_state_t cpu_state); int (*pwr_domain_on)(u_register_t mpidr); void (*pwr_domain_off)(const psci_power_state_t *target_state); void (*pwr_domain_suspend)(const psci_power_state_t *target_state); void (*pwr_domain_on_finish)(const psci_power_state_t *target_state); void (*pwr_domain_suspend_finish)( const psci_power_state_t *target_state); void (*pwr_domain_pwr_down_wfi)( const psci_power_state_t *target_state) __dead2; void (*system_off)(void) __dead2; void (*system_reset)(void) __dead2; int (*validate_power_state)(unsigned int power_state, psci_power_state_t *req_state); int (*validate_ns_entrypoint)(uintptr_t ns_entrypoint); void (*get_sys_suspend_power_state)( psci_power_state_t *req_state); int (*get_pwr_lvl_state_idx)(plat_local_state_t pwr_domain_state, int pwrlvl); int (*translate_power_state_by_mpidr)(u_register_t mpidr, unsigned int power_state, psci_power_state_t *output_state); } plat_psci_ops_t; /******************************************************************************* * Optional structure populated by the Secure Payload Dispatcher to be given a * chance to perform any bookkeeping before PSCI executes a power management * operation. It also allows PSCI to determine certain properties of the SP e.g. * migrate capability etc. ******************************************************************************/ typedef struct spd_pm_ops { void (*svc_on)(u_register_t target_cpu); int32_t (*svc_off)(u_register_t __unused); void (*svc_suspend)(u_register_t max_off_pwrlvl); void (*svc_on_finish)(u_register_t __unused); void (*svc_suspend_finish)(u_register_t max_off_pwrlvl); int32_t (*svc_migrate)(u_register_t from_cpu, u_register_t to_cpu); int32_t (*svc_migrate_info)(u_register_t *resident_cpu); void (*svc_system_off)(void); void (*svc_system_reset)(void); } spd_pm_ops_t; /******************************************************************************* * Function & Data prototypes ******************************************************************************/ unsigned int psci_version(void); int psci_cpu_on(u_register_t target_cpu, uintptr_t entrypoint, u_register_t context_id); int psci_cpu_suspend(unsigned int power_state, uintptr_t entrypoint, u_register_t context_id); int psci_system_suspend(uintptr_t entrypoint, u_register_t context_id); int psci_cpu_off(void); int psci_affinity_info(u_register_t target_affinity, unsigned int lowest_affinity_level); int psci_migrate(u_register_t target_cpu); int psci_migrate_info_type(void); long psci_migrate_info_up_cpu(void); int psci_features(unsigned int psci_fid); void __dead2 psci_power_down_wfi(void); void psci_entrypoint(void); void psci_register_spd_pm_hook(const spd_pm_ops_t *); uintptr_t psci_smc_handler(uint32_t smc_fid, u_register_t x1, u_register_t x2, u_register_t x3, u_register_t x4, void *cookie, void *handle, u_register_t flags); /* PSCI setup function */ int psci_setup(void); #endif /*__ASSEMBLY__*/ #endif /* __PSCI_H__ */