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 | |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 31 | #include <arch.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 32 | #include <arch_helpers.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 33 | #include <assert.h> |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 34 | #include <debug.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 35 | #include <string.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 36 | #include "psci_private.h" |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 37 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 38 | typedef void (*afflvl_off_handler_t)(aff_map_node_t *node); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 39 | |
| 40 | /******************************************************************************* |
| 41 | * The next three functions implement a handler for each supported affinity |
| 42 | * level which is called when that affinity level is turned off. |
| 43 | ******************************************************************************/ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 44 | static void psci_afflvl0_off(aff_map_node_t *cpu_node) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 45 | { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 46 | assert(cpu_node->level == MPIDR_AFFLVL0); |
| 47 | |
| 48 | /* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 49 | * Arch. management. Perform the necessary steps to flush all |
| 50 | * cpu caches. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 51 | */ |
Achin Gupta | e1aa516 | 2014-06-26 09:58:52 +0100 | [diff] [blame] | 52 | psci_do_pwrdown_cache_maintenance(MPIDR_AFFLVL0); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 53 | |
| 54 | /* |
| 55 | * Plat. management: Perform platform specific actions to turn this |
| 56 | * cpu off e.g. exit cpu coherency, program the power controller etc. |
| 57 | */ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 58 | psci_plat_pm_ops->affinst_off(cpu_node->level, |
| 59 | psci_get_phys_state(cpu_node)); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 60 | } |
| 61 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 62 | static void psci_afflvl1_off(aff_map_node_t *cluster_node) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 63 | { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 64 | /* Sanity check the cluster level */ |
| 65 | assert(cluster_node->level == MPIDR_AFFLVL1); |
| 66 | |
| 67 | /* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 68 | * Arch. Management. Flush all levels of caches to PoC if |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 69 | * the cluster is to be shutdown. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 70 | */ |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 71 | psci_do_pwrdown_cache_maintenance(MPIDR_AFFLVL1); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 72 | |
| 73 | /* |
Achin Gupta | 3140a9e | 2013-12-02 16:23:12 +0000 | [diff] [blame] | 74 | * Plat. Management. Allow the platform to do its cluster |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 75 | * specific bookeeping e.g. turn off interconnect coherency, |
| 76 | * program the power controller etc. |
| 77 | */ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 78 | psci_plat_pm_ops->affinst_off(cluster_node->level, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 79 | psci_get_phys_state(cluster_node)); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 80 | } |
| 81 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 82 | static void psci_afflvl2_off(aff_map_node_t *system_node) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 83 | { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 84 | /* Cannot go beyond this level */ |
| 85 | assert(system_node->level == MPIDR_AFFLVL2); |
| 86 | |
| 87 | /* |
| 88 | * Keep the physical state of the system handy to decide what |
| 89 | * action needs to be taken |
| 90 | */ |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 91 | |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 92 | /* |
| 93 | * Arch. Management. Flush all levels of caches to PoC if |
| 94 | * the system is to be shutdown. |
| 95 | */ |
| 96 | psci_do_pwrdown_cache_maintenance(MPIDR_AFFLVL2); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 97 | |
| 98 | /* |
Achin Gupta | 3140a9e | 2013-12-02 16:23:12 +0000 | [diff] [blame] | 99 | * Plat. Management : Allow the platform to do its bookeeping |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 100 | * at this affinity level |
| 101 | */ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 102 | psci_plat_pm_ops->affinst_off(system_node->level, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 103 | psci_get_phys_state(system_node)); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 104 | } |
| 105 | |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 106 | static const afflvl_off_handler_t psci_afflvl_off_handlers[] = { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 107 | psci_afflvl0_off, |
| 108 | psci_afflvl1_off, |
| 109 | psci_afflvl2_off, |
| 110 | }; |
| 111 | |
| 112 | /******************************************************************************* |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 113 | * This function takes an array of pointers to affinity instance nodes in the |
| 114 | * topology tree and calls the off handler for the corresponding affinity |
| 115 | * levels |
| 116 | ******************************************************************************/ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 117 | static void psci_call_off_handlers(aff_map_node_t *mpidr_nodes[], |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 118 | int start_afflvl, |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 119 | int end_afflvl) |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 120 | { |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 121 | int level; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 122 | aff_map_node_t *node; |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 123 | |
| 124 | for (level = start_afflvl; level <= end_afflvl; level++) { |
| 125 | node = mpidr_nodes[level]; |
| 126 | if (node == NULL) |
| 127 | continue; |
| 128 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 129 | psci_afflvl_off_handlers[level](node); |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 130 | } |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | /******************************************************************************* |
| 134 | * Top level handler which is called when a cpu wants to power itself down. |
| 135 | * It's assumed that along with turning the cpu off, higher affinity levels will |
| 136 | * be turned off as far as possible. It traverses through all the affinity |
| 137 | * levels performing generic, architectural, platform setup and state management |
| 138 | * e.g. for a cluster that's to be powered off, it will call the platform |
| 139 | * specific code which will disable coherency at the interconnect level if the |
| 140 | * cpu is the last in the cluster. For a cpu it could mean programming the power |
| 141 | * the power controller etc. |
| 142 | * |
| 143 | * The state of all the relevant affinity levels is changed prior to calling the |
| 144 | * affinity level specific handlers as their actions would depend upon the state |
| 145 | * the affinity level is about to enter. |
| 146 | * |
| 147 | * The affinity level specific handlers are called in ascending order i.e. from |
| 148 | * the lowest to the highest affinity level implemented by the platform because |
| 149 | * to turn off affinity level X it is neccesary to turn off affinity level X - 1 |
| 150 | * first. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 151 | ******************************************************************************/ |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 152 | int psci_afflvl_off(int start_afflvl, |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 153 | int end_afflvl) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 154 | { |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 155 | int rc; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 156 | mpidr_aff_map_nodes_t mpidr_nodes; |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 157 | unsigned int max_phys_off_afflvl; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 158 | |
| 159 | /* |
Soby Mathew | 61e615b | 2015-01-15 11:49:49 +0000 | [diff] [blame^] | 160 | * This function must only be called on platforms where the |
| 161 | * CPU_OFF platform hooks have been implemented. |
| 162 | */ |
| 163 | assert(psci_plat_pm_ops->affinst_off); |
| 164 | |
| 165 | /* |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 166 | * Collect the pointers to the nodes in the topology tree for |
| 167 | * each affinity instance in the mpidr. If this function does |
| 168 | * not return successfully then either the mpidr or the affinity |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 169 | * levels are incorrect. Either way, this an internal TF error |
| 170 | * therefore assert. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 171 | */ |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 172 | rc = psci_get_aff_map_nodes(read_mpidr_el1() & MPIDR_AFFINITY_MASK, |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 173 | start_afflvl, |
| 174 | end_afflvl, |
| 175 | mpidr_nodes); |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 176 | assert(rc == PSCI_E_SUCCESS); |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 177 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 178 | /* |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 179 | * This function acquires the lock corresponding to each affinity |
| 180 | * level so that by the time all locks are taken, the system topology |
| 181 | * is snapshot and state management can be done safely. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 182 | */ |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 183 | psci_acquire_afflvl_locks(start_afflvl, |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 184 | end_afflvl, |
| 185 | mpidr_nodes); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 186 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 187 | |
| 188 | /* |
| 189 | * Call the cpu off handler registered by the Secure Payload Dispatcher |
| 190 | * to let it do any bookkeeping. Assume that the SPD always reports an |
| 191 | * E_DENIED error if SP refuse to power down |
| 192 | */ |
| 193 | if (psci_spd_pm && psci_spd_pm->svc_off) { |
| 194 | rc = psci_spd_pm->svc_off(0); |
| 195 | if (rc) |
| 196 | goto exit; |
| 197 | } |
| 198 | |
Achin Gupta | cab78e4 | 2014-07-28 00:09:01 +0100 | [diff] [blame] | 199 | /* |
| 200 | * This function updates the state of each affinity instance |
| 201 | * corresponding to the mpidr in the range of affinity levels |
| 202 | * specified. |
| 203 | */ |
| 204 | psci_do_afflvl_state_mgmt(start_afflvl, |
| 205 | end_afflvl, |
| 206 | mpidr_nodes, |
| 207 | PSCI_STATE_OFF); |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 208 | |
| 209 | max_phys_off_afflvl = psci_find_max_phys_off_afflvl(start_afflvl, |
| 210 | end_afflvl, |
| 211 | mpidr_nodes); |
| 212 | assert(max_phys_off_afflvl != PSCI_INVALID_DATA); |
| 213 | |
| 214 | /* Stash the highest affinity level that will enter the OFF state. */ |
| 215 | psci_set_max_phys_off_afflvl(max_phys_off_afflvl); |
| 216 | |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 217 | /* Perform generic, architecture and platform specific handling */ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 218 | psci_call_off_handlers(mpidr_nodes, |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 219 | start_afflvl, |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 220 | end_afflvl); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 221 | |
| 222 | /* |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 223 | * Invalidate the entry for the highest affinity level stashed earlier. |
| 224 | * This ensures that any reads of this variable outside the power |
| 225 | * up/down sequences return PSCI_INVALID_DATA. |
| 226 | * |
| 227 | */ |
| 228 | psci_set_max_phys_off_afflvl(PSCI_INVALID_DATA); |
| 229 | |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame] | 230 | exit: |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 231 | /* |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 232 | * Release the locks corresponding to each affinity level in the |
| 233 | * reverse order to which they were acquired. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 234 | */ |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 235 | psci_release_afflvl_locks(start_afflvl, |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 236 | end_afflvl, |
| 237 | mpidr_nodes); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 238 | |
Soby Mathew | 26fb90e | 2015-01-06 21:36:55 +0000 | [diff] [blame] | 239 | /* |
| 240 | * Check if all actions needed to safely power down this cpu have |
| 241 | * successfully completed. Enter a wfi loop which will allow the |
| 242 | * power controller to physically power down this cpu. |
| 243 | */ |
| 244 | if (rc == PSCI_E_SUCCESS) |
| 245 | psci_power_down_wfi(); |
| 246 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 247 | return rc; |
| 248 | } |