blob: 77f406d282c97789d785707159bd6ccfa7df9ec0 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handleye83b0ca2014-01-14 18:17:09 +00002 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
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
Dan Handley2bd4ef22014-04-09 13:14:54 +010034
Achin Gupta4f6ad662013-10-25 09:08:21 +010035/*******************************************************************************
36 * Defines for runtime services func ids
37 ******************************************************************************/
38#define PSCI_VERSION 0x84000000
39#define PSCI_CPU_SUSPEND_AARCH32 0x84000001
40#define PSCI_CPU_SUSPEND_AARCH64 0xc4000001
41#define PSCI_CPU_OFF 0x84000002
42#define PSCI_CPU_ON_AARCH32 0x84000003
43#define PSCI_CPU_ON_AARCH64 0xc4000003
44#define PSCI_AFFINITY_INFO_AARCH32 0x84000004
45#define PSCI_AFFINITY_INFO_AARCH64 0xc4000004
46#define PSCI_MIG_AARCH32 0x84000005
47#define PSCI_MIG_AARCH64 0xc4000005
48#define PSCI_MIG_INFO_TYPE 0x84000006
49#define PSCI_MIG_INFO_UP_CPU_AARCH32 0x84000007
50#define PSCI_MIG_INFO_UP_CPU_AARCH64 0xc4000007
Jeenu Viswambharan1814a3e2014-02-28 10:08:33 +000051#define PSCI_SYSTEM_OFF 0x84000008
Achin Gupta4f6ad662013-10-25 09:08:21 +010052#define PSCI_SYSTEM_RESET 0x84000009
53
Jeenu Viswambharan1814a3e2014-02-28 10:08:33 +000054/*
55 * Number of PSCI calls (above) implemented. System off and reset aren't
56 * implemented as yet
57 */
58#define PSCI_NUM_CALLS 13
59
Achin Gupta4f6ad662013-10-25 09:08:21 +010060/*******************************************************************************
61 * PSCI Migrate and friends
62 ******************************************************************************/
63#define PSCI_TOS_UP_MIG_CAP 0
64#define PSCI_TOS_NOT_UP_MIG_CAP 1
Achin Gupta607084e2014-02-09 18:24:19 +000065#define PSCI_TOS_NOT_PRESENT_MP 2
Achin Gupta4f6ad662013-10-25 09:08:21 +010066
67/*******************************************************************************
68 * PSCI CPU_SUSPEND 'power_state' parameter specific defines
69 ******************************************************************************/
Achin Gupta994dfce2013-10-26 13:10:31 +010070#define PSTATE_ID_SHIFT 0
Achin Gupta4f6ad662013-10-25 09:08:21 +010071#define PSTATE_TYPE_SHIFT 16
Achin Gupta994dfce2013-10-26 13:10:31 +010072#define PSTATE_AFF_LVL_SHIFT 24
Achin Gupta4f6ad662013-10-25 09:08:21 +010073
74#define PSTATE_ID_MASK 0xffff
75#define PSTATE_TYPE_MASK 0x1
76#define PSTATE_AFF_LVL_MASK 0x3
Vikram Kanigirif100f412014-04-01 19:26:26 +010077#define PSTATE_VALID_MASK 0xFCFE0000
Achin Gupta4f6ad662013-10-25 09:08:21 +010078
Vikram Kanigiri3b7c59b2014-03-21 11:57:10 +000079#define PSTATE_TYPE_STANDBY 0x0
80#define PSTATE_TYPE_POWERDOWN 0x1
81
Achin Gupta4f6ad662013-10-25 09:08:21 +010082#define psci_get_pstate_id(pstate) (pstate >> PSTATE_ID_SHIFT) & \
83 PSTATE_ID_MASK
84#define psci_get_pstate_type(pstate) (pstate >> PSTATE_TYPE_SHIFT) & \
85 PSTATE_TYPE_MASK
86#define psci_get_pstate_afflvl(pstate) (pstate >> PSTATE_AFF_LVL_SHIFT) & \
87 PSTATE_AFF_LVL_MASK
88
89/*******************************************************************************
90 * PSCI version
91 ******************************************************************************/
92#define PSCI_MAJOR_VER (0 << 16)
93#define PSCI_MINOR_VER 0x2
94
95/*******************************************************************************
96 * PSCI error codes
97 ******************************************************************************/
98#define PSCI_E_SUCCESS 0
99#define PSCI_E_NOT_SUPPORTED -1
100#define PSCI_E_INVALID_PARAMS -2
101#define PSCI_E_DENIED -3
102#define PSCI_E_ALREADY_ON -4
103#define PSCI_E_ON_PENDING -5
104#define PSCI_E_INTERN_FAIL -6
105#define PSCI_E_NOT_PRESENT -7
106#define PSCI_E_DISABLED -8
107
108/*******************************************************************************
109 * PSCI affinity state related constants. An affinity instance could be present
110 * or absent physically to cater for asymmetric topologies. If present then it
111 * could in one of the 4 further defined states.
112 ******************************************************************************/
113#define PSCI_STATE_SHIFT 1
Achin Gupta75f73672013-12-05 16:33:10 +0000114#define PSCI_STATE_MASK 0xff
Achin Gupta4f6ad662013-10-25 09:08:21 +0100115
116#define PSCI_AFF_ABSENT 0x0
117#define PSCI_AFF_PRESENT 0x1
Achin Gupta994dfce2013-10-26 13:10:31 +0100118#define PSCI_STATE_ON 0x0
119#define PSCI_STATE_OFF 0x1
120#define PSCI_STATE_ON_PENDING 0x2
121#define PSCI_STATE_SUSPEND 0x3
Achin Gupta4f6ad662013-10-25 09:08:21 +0100122
Vikram Kanigirif100f412014-04-01 19:26:26 +0100123#define PSCI_INVALID_DATA -1
124
Achin Gupta75f73672013-12-05 16:33:10 +0000125#define get_phys_state(x) (x != PSCI_STATE_ON ? \
126 PSCI_STATE_OFF : PSCI_STATE_ON)
127
Vikram Kanigirif100f412014-04-01 19:26:26 +0100128#define psci_validate_power_state(pstate) (pstate & PSTATE_VALID_MASK)
129
130
Achin Gupta4f6ad662013-10-25 09:08:21 +0100131#ifndef __ASSEMBLY__
Dan Handley2bd4ef22014-04-09 13:14:54 +0100132
133#include <stdint.h>
134
135
Achin Gupta4f6ad662013-10-25 09:08:21 +0100136/*******************************************************************************
137 * Structure populated by platform specific code to export routines which
138 * perform common low level pm functions
139 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100140typedef struct plat_pm_ops {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100141 int (*affinst_standby)(unsigned int);
142 int (*affinst_on)(unsigned long,
143 unsigned long,
144 unsigned long,
145 unsigned int,
146 unsigned int);
147 int (*affinst_off)(unsigned long, unsigned int, unsigned int);
148 int (*affinst_suspend)(unsigned long,
149 unsigned long,
150 unsigned long,
151 unsigned int,
152 unsigned int);
153 int (*affinst_on_finish)(unsigned long, unsigned int, unsigned int);
154 int (*affinst_suspend_finish)(unsigned long,
155 unsigned int,
156 unsigned int);
Dan Handleye2712bc2014-04-10 15:37:22 +0100157} plat_pm_ops_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100158
159/*******************************************************************************
Achin Gupta607084e2014-02-09 18:24:19 +0000160 * Optional structure populated by the Secure Payload Dispatcher to be given a
161 * chance to perform any bookkeeping before PSCI executes a power mgmt.
162 * operation. It also allows PSCI to determine certain properties of the SP e.g.
163 * migrate capability etc.
164 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100165typedef struct spd_pm_ops {
Achin Gupta607084e2014-02-09 18:24:19 +0000166 void (*svc_on)(uint64_t target_cpu);
167 int32_t (*svc_off)(uint64_t __unused);
168 void (*svc_suspend)(uint64_t power_state);
169 void (*svc_on_finish)(uint64_t __unused);
170 void (*svc_suspend_finish)(uint64_t suspend_level);
171 void (*svc_migrate)(uint64_t __unused1, uint64_t __unused2);
172 int32_t (*svc_migrate_info)(uint64_t *__unused);
Dan Handleye2712bc2014-04-10 15:37:22 +0100173} spd_pm_ops_t;
Achin Gupta607084e2014-02-09 18:24:19 +0000174
175/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100176 * Function & Data prototypes
177 ******************************************************************************/
Dan Handleya17fefa2014-05-14 12:38:32 +0100178unsigned int psci_version(void);
179int __psci_cpu_suspend(unsigned int, unsigned long, unsigned long);
180int __psci_cpu_off(void);
181int psci_affinity_info(unsigned long, unsigned int);
182int psci_migrate(unsigned int);
183unsigned int psci_migrate_info_type(void);
184unsigned long psci_migrate_info_up_cpu(void);
185void psci_system_off(void);
186void psci_system_reset(void);
187int psci_cpu_on(unsigned long,
188 unsigned long,
189 unsigned long);
190void __dead2 psci_power_down_wfi(void);
191void psci_aff_on_finish_entry(void);
192void psci_aff_suspend_finish_entry(void);
193void psci_register_spd_pm_hook(const spd_pm_ops_t *);
194int psci_get_suspend_stateid(unsigned long mpidr);
195int psci_get_suspend_afflvl(unsigned long mpidr);
Vikram Kanigirif100f412014-04-01 19:26:26 +0100196
Dan Handleya17fefa2014-05-14 12:38:32 +0100197uint64_t psci_smc_handler(uint32_t smc_fid,
198 uint64_t x1,
199 uint64_t x2,
200 uint64_t x3,
201 uint64_t x4,
202 void *cookie,
203 void *handle,
204 uint64_t flags);
Dan Handley27f6e7d2014-04-23 15:22:18 +0100205
206/* PSCI setup function */
Dan Handleya17fefa2014-05-14 12:38:32 +0100207int32_t psci_setup(void);
Dan Handley27f6e7d2014-04-23 15:22:18 +0100208
209
Achin Gupta4f6ad662013-10-25 09:08:21 +0100210#endif /*__ASSEMBLY__*/
211
212
213#endif /* __PSCI_H__ */