Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Dan Handley | ab2d31e | 2013-12-02 19:25:12 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013, 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 | |
| 34 | /******************************************************************************* |
| 35 | * Defines for runtime services func ids |
| 36 | ******************************************************************************/ |
| 37 | #define PSCI_VERSION 0x84000000 |
| 38 | #define PSCI_CPU_SUSPEND_AARCH32 0x84000001 |
| 39 | #define PSCI_CPU_SUSPEND_AARCH64 0xc4000001 |
| 40 | #define PSCI_CPU_OFF 0x84000002 |
| 41 | #define PSCI_CPU_ON_AARCH32 0x84000003 |
| 42 | #define PSCI_CPU_ON_AARCH64 0xc4000003 |
| 43 | #define PSCI_AFFINITY_INFO_AARCH32 0x84000004 |
| 44 | #define PSCI_AFFINITY_INFO_AARCH64 0xc4000004 |
| 45 | #define PSCI_MIG_AARCH32 0x84000005 |
| 46 | #define PSCI_MIG_AARCH64 0xc4000005 |
| 47 | #define PSCI_MIG_INFO_TYPE 0x84000006 |
| 48 | #define PSCI_MIG_INFO_UP_CPU_AARCH32 0x84000007 |
| 49 | #define PSCI_MIG_INFO_UP_CPU_AARCH64 0xc4000007 |
| 50 | #define PSCI_SYSTEM_OFF 0x84000008 |
| 51 | #define PSCI_SYSTEM_RESET 0x84000009 |
| 52 | |
| 53 | /******************************************************************************* |
| 54 | * PSCI Migrate and friends |
| 55 | ******************************************************************************/ |
| 56 | #define PSCI_TOS_UP_MIG_CAP 0 |
| 57 | #define PSCI_TOS_NOT_UP_MIG_CAP 1 |
| 58 | #define PSCI_TOS_NOT_PRESENT 2 |
| 59 | |
| 60 | /******************************************************************************* |
| 61 | * PSCI CPU_SUSPEND 'power_state' parameter specific defines |
| 62 | ******************************************************************************/ |
| 63 | #define PSTATE_ID_SHIFT 15 |
| 64 | #define PSTATE_TYPE_SHIFT 16 |
| 65 | #define PSTATE_AFF_LVL_SHIFT 25 |
| 66 | |
| 67 | #define PSTATE_ID_MASK 0xffff |
| 68 | #define PSTATE_TYPE_MASK 0x1 |
| 69 | #define PSTATE_AFF_LVL_MASK 0x3 |
| 70 | |
| 71 | #define psci_get_pstate_id(pstate) (pstate >> PSTATE_ID_SHIFT) & \ |
| 72 | PSTATE_ID_MASK |
| 73 | #define psci_get_pstate_type(pstate) (pstate >> PSTATE_TYPE_SHIFT) & \ |
| 74 | PSTATE_TYPE_MASK |
| 75 | #define psci_get_pstate_afflvl(pstate) (pstate >> PSTATE_AFF_LVL_SHIFT) & \ |
| 76 | PSTATE_AFF_LVL_MASK |
| 77 | |
| 78 | /******************************************************************************* |
| 79 | * PSCI version |
| 80 | ******************************************************************************/ |
| 81 | #define PSCI_MAJOR_VER (0 << 16) |
| 82 | #define PSCI_MINOR_VER 0x2 |
| 83 | |
| 84 | /******************************************************************************* |
| 85 | * PSCI error codes |
| 86 | ******************************************************************************/ |
| 87 | #define PSCI_E_SUCCESS 0 |
| 88 | #define PSCI_E_NOT_SUPPORTED -1 |
| 89 | #define PSCI_E_INVALID_PARAMS -2 |
| 90 | #define PSCI_E_DENIED -3 |
| 91 | #define PSCI_E_ALREADY_ON -4 |
| 92 | #define PSCI_E_ON_PENDING -5 |
| 93 | #define PSCI_E_INTERN_FAIL -6 |
| 94 | #define PSCI_E_NOT_PRESENT -7 |
| 95 | #define PSCI_E_DISABLED -8 |
| 96 | |
| 97 | /******************************************************************************* |
| 98 | * PSCI affinity state related constants. An affinity instance could be present |
| 99 | * or absent physically to cater for asymmetric topologies. If present then it |
| 100 | * could in one of the 4 further defined states. |
| 101 | ******************************************************************************/ |
| 102 | #define PSCI_STATE_SHIFT 1 |
| 103 | #define PSCI_STATE_MASK 0x7 |
| 104 | #define psci_get_state(x) (x >> PSCI_STATE_SHIFT) & PSCI_STATE_MASK |
| 105 | #define psci_set_state(x,y) x &= ~(PSCI_STATE_MASK << PSCI_STATE_SHIFT); \ |
| 106 | x |= (y & PSCI_STATE_MASK) << PSCI_STATE_SHIFT; |
| 107 | |
| 108 | #define PSCI_AFF_ABSENT 0x0 |
| 109 | #define PSCI_AFF_PRESENT 0x1 |
| 110 | #define PSCI_STATE_OFF 0x0 |
| 111 | #define PSCI_STATE_ON_PENDING 0x1 |
| 112 | #define PSCI_STATE_SUSPEND 0x2 |
| 113 | #define PSCI_STATE_ON 0x3 |
| 114 | |
| 115 | /* Number of affinity instances whose state this psci imp. can track */ |
| 116 | #define PSCI_NUM_AFFS 32ull |
| 117 | |
| 118 | #ifndef __ASSEMBLY__ |
| 119 | /******************************************************************************* |
| 120 | * Structure populated by platform specific code to export routines which |
| 121 | * perform common low level pm functions |
| 122 | ******************************************************************************/ |
| 123 | typedef struct { |
| 124 | int (*affinst_standby)(unsigned int); |
| 125 | int (*affinst_on)(unsigned long, |
| 126 | unsigned long, |
| 127 | unsigned long, |
| 128 | unsigned int, |
| 129 | unsigned int); |
| 130 | int (*affinst_off)(unsigned long, unsigned int, unsigned int); |
| 131 | int (*affinst_suspend)(unsigned long, |
| 132 | unsigned long, |
| 133 | unsigned long, |
| 134 | unsigned int, |
| 135 | unsigned int); |
| 136 | int (*affinst_on_finish)(unsigned long, unsigned int, unsigned int); |
| 137 | int (*affinst_suspend_finish)(unsigned long, |
| 138 | unsigned int, |
| 139 | unsigned int); |
| 140 | } plat_pm_ops; |
| 141 | |
| 142 | /******************************************************************************* |
| 143 | * Function & Data prototypes |
| 144 | ******************************************************************************/ |
| 145 | extern unsigned int psci_version(void); |
| 146 | extern int psci_cpu_on(unsigned long, |
| 147 | unsigned long, |
| 148 | unsigned long); |
| 149 | extern int __psci_cpu_suspend(unsigned int, unsigned long, unsigned long); |
| 150 | extern int __psci_cpu_off(void); |
| 151 | extern int psci_affinity_info(unsigned long, unsigned int); |
| 152 | extern int psci_migrate(unsigned int); |
| 153 | extern unsigned int psci_migrate_info_type(void); |
| 154 | extern unsigned long psci_migrate_info_up_cpu(void); |
| 155 | extern void psci_system_off(void); |
| 156 | extern void psci_system_reset(void); |
| 157 | extern int psci_cpu_on(unsigned long, |
| 158 | unsigned long, |
| 159 | unsigned long); |
| 160 | extern void psci_aff_on_finish_entry(void); |
| 161 | extern void psci_aff_suspend_finish_entry(void); |
| 162 | extern void psci_setup(unsigned long); |
| 163 | #endif /*__ASSEMBLY__*/ |
| 164 | |
| 165 | |
| 166 | #endif /* __PSCI_H__ */ |