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