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 | |
| 31 | #ifndef __PSCI_PRIVATE_H__ |
| 32 | #define __PSCI_PRIVATE_H__ |
| 33 | |
Achin Gupta | a59caa4 | 2013-12-05 14:21:04 +0000 | [diff] [blame] | 34 | #include <arch.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 35 | #include <bakery_lock.h> |
Soby Mathew | 8595b87 | 2015-01-06 15:36:38 +0000 | [diff] [blame] | 36 | #include <bl_common.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 37 | #include <psci.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 38 | |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 39 | /* |
| 40 | * The following helper macros abstract the interface to the Bakery |
| 41 | * Lock API. |
| 42 | */ |
| 43 | #if USE_COHERENT_MEM |
| 44 | #define psci_lock_init(aff_map, idx) bakery_lock_init(&(aff_map)[(idx)].lock) |
| 45 | #define psci_lock_get(node) bakery_lock_get(&((node)->lock)) |
| 46 | #define psci_lock_release(node) bakery_lock_release(&((node)->lock)) |
Andrew Thoelke | 56f4470 | 2014-06-20 00:36:14 +0100 | [diff] [blame] | 47 | #else |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 48 | #define psci_lock_init(aff_map, idx) ((aff_map)[(idx)].aff_map_index = (idx)) |
| 49 | #define psci_lock_get(node) bakery_lock_get((node)->aff_map_index, \ |
| 50 | CPU_DATA_PSCI_LOCK_OFFSET) |
| 51 | #define psci_lock_release(node) bakery_lock_release((node)->aff_map_index,\ |
| 52 | CPU_DATA_PSCI_LOCK_OFFSET) |
Andrew Thoelke | 56f4470 | 2014-06-20 00:36:14 +0100 | [diff] [blame] | 53 | #endif |
| 54 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 55 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 56 | * The following two data structures hold the topology tree which in turn tracks |
| 57 | * the state of the all the affinity instances supported by the platform. |
| 58 | ******************************************************************************/ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 59 | typedef struct aff_map_node { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 60 | unsigned long mpidr; |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 61 | unsigned char ref_count; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 62 | unsigned char state; |
Achin Gupta | 75f7367 | 2013-12-05 16:33:10 +0000 | [diff] [blame] | 63 | unsigned char level; |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 64 | #if USE_COHERENT_MEM |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 65 | bakery_lock_t lock; |
Soby Mathew | 523d633 | 2015-01-08 18:02:19 +0000 | [diff] [blame] | 66 | #else |
| 67 | /* For indexing the bakery_info array in per CPU data */ |
| 68 | unsigned char aff_map_index; |
| 69 | #endif |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 70 | } aff_map_node_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 71 | |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 72 | typedef struct aff_limits_node { |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 73 | int min; |
| 74 | int max; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 75 | } aff_limits_node_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 76 | |
Soby Mathew | e2b2d8f | 2014-12-04 14:14:12 +0000 | [diff] [blame] | 77 | typedef aff_map_node_t (*mpidr_aff_map_nodes_t[MPIDR_MAX_AFFLVL + 1]); |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame^] | 78 | typedef void (*afflvl_power_on_finisher_t)(aff_map_node_t *); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 79 | |
| 80 | /******************************************************************************* |
| 81 | * Data prototypes |
| 82 | ******************************************************************************/ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 83 | extern const plat_pm_ops_t *psci_plat_pm_ops; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 84 | extern aff_map_node_t psci_aff_map[PSCI_NUM_AFFS]; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 85 | |
| 86 | /******************************************************************************* |
Jeenu Viswambharan | 7f36660 | 2014-02-20 17:11:00 +0000 | [diff] [blame] | 87 | * SPD's power management hooks registered with PSCI |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 88 | ******************************************************************************/ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 89 | extern const spd_pm_ops_t *psci_spd_pm; |
Achin Gupta | 607084e | 2014-02-09 18:24:19 +0000 | [diff] [blame] | 90 | |
| 91 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 92 | * Function prototypes |
| 93 | ******************************************************************************/ |
| 94 | /* Private exported functions from psci_common.c */ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 95 | int get_max_afflvl(void); |
| 96 | unsigned short psci_get_state(aff_map_node_t *node); |
| 97 | unsigned short psci_get_phys_state(aff_map_node_t *node); |
| 98 | void psci_set_state(aff_map_node_t *node, unsigned short state); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 99 | unsigned long mpidr_set_aff_inst(unsigned long, unsigned char, int); |
| 100 | int psci_validate_mpidr(unsigned long, int); |
Achin Gupta | f3ccbab | 2014-07-25 14:52:47 +0100 | [diff] [blame] | 101 | int get_power_on_target_afflvl(void); |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 102 | void psci_afflvl_power_on_finish(int, |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 103 | int, |
| 104 | afflvl_power_on_finisher_t *); |
Soby Mathew | 8595b87 | 2015-01-06 15:36:38 +0000 | [diff] [blame] | 105 | int psci_get_ns_ep_info(entry_point_info_t *ep, |
| 106 | uint64_t entrypoint, uint64_t context_id); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 107 | int psci_check_afflvl_range(int start_afflvl, int end_afflvl); |
Achin Gupta | cab78e4 | 2014-07-28 00:09:01 +0100 | [diff] [blame] | 108 | void psci_do_afflvl_state_mgmt(uint32_t start_afflvl, |
| 109 | uint32_t end_afflvl, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 110 | aff_map_node_t *mpidr_nodes[], |
Achin Gupta | cab78e4 | 2014-07-28 00:09:01 +0100 | [diff] [blame] | 111 | uint32_t state); |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 112 | void psci_acquire_afflvl_locks(int start_afflvl, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 113 | int end_afflvl, |
| 114 | aff_map_node_t *mpidr_nodes[]); |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 115 | void psci_release_afflvl_locks(int start_afflvl, |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 116 | int end_afflvl, |
| 117 | mpidr_aff_map_nodes_t mpidr_nodes); |
Juan Castillo | 4dc4a47 | 2014-08-12 11:17:06 +0100 | [diff] [blame] | 118 | void psci_print_affinity_map(void); |
Achin Gupta | f6b9e99 | 2014-07-31 11:19:11 +0100 | [diff] [blame] | 119 | void psci_set_max_phys_off_afflvl(uint32_t afflvl); |
| 120 | uint32_t psci_find_max_phys_off_afflvl(uint32_t start_afflvl, |
| 121 | uint32_t end_afflvl, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 122 | aff_map_node_t *mpidr_nodes[]); |
Achin Gupta | 0959db5 | 2013-12-02 17:33:04 +0000 | [diff] [blame] | 123 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 124 | /* Private exported functions from psci_setup.c */ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 125 | int psci_get_aff_map_nodes(unsigned long mpidr, |
| 126 | int start_afflvl, |
| 127 | int end_afflvl, |
Achin Gupta | 56bcdc2 | 2014-07-28 00:15:23 +0100 | [diff] [blame] | 128 | aff_map_node_t *mpidr_nodes[]); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 129 | aff_map_node_t *psci_get_aff_map_node(unsigned long, int); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 130 | |
| 131 | /* Private exported functions from psci_affinity_on.c */ |
Soby Mathew | 8595b87 | 2015-01-06 15:36:38 +0000 | [diff] [blame] | 132 | int psci_afflvl_on(unsigned long target_cpu, |
| 133 | entry_point_info_t *ep, |
| 134 | int start_afflvl, |
| 135 | int end_afflvl); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 136 | |
| 137 | /* Private exported functions from psci_affinity_off.c */ |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 138 | int psci_afflvl_off(int, int); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 139 | |
| 140 | /* Private exported functions from psci_affinity_suspend.c */ |
Soby Mathew | 74e52a7 | 2014-10-02 16:56:51 +0100 | [diff] [blame^] | 141 | void psci_afflvl_suspend(entry_point_info_t *ep, |
Soby Mathew | 8595b87 | 2015-01-06 15:36:38 +0000 | [diff] [blame] | 142 | int start_afflvl, |
| 143 | int end_afflvl); |
| 144 | |
Andrew Thoelke | 2bc0785 | 2014-06-09 12:44:21 +0100 | [diff] [blame] | 145 | unsigned int psci_afflvl_suspend_finish(int, int); |
Achin Gupta | f3ccbab | 2014-07-25 14:52:47 +0100 | [diff] [blame] | 146 | void psci_set_suspend_power_state(unsigned int power_state); |
Jeenu Viswambharan | caa8493 | 2014-02-06 10:36:15 +0000 | [diff] [blame] | 147 | |
Achin Gupta | e1aa516 | 2014-06-26 09:58:52 +0100 | [diff] [blame] | 148 | /* Private exported functions from psci_helpers.S */ |
| 149 | void psci_do_pwrdown_cache_maintenance(uint32_t affinity_level); |
| 150 | void psci_do_pwrup_cache_maintenance(void); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 151 | |
Juan Castillo | 4dc4a47 | 2014-08-12 11:17:06 +0100 | [diff] [blame] | 152 | /* Private exported functions from psci_system_off.c */ |
| 153 | void __dead2 psci_system_off(void); |
| 154 | void __dead2 psci_system_reset(void); |
| 155 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 156 | #endif /* __PSCI_PRIVATE_H__ */ |