blob: 2955de7a0f3532cf5ffcf76589f747619f86a1e5 [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_PRIVATE_H__
32#define __PSCI_PRIVATE_H__
33
Achin Guptaa59caa42013-12-05 14:21:04 +000034#include <arch.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010035#include <bakery_lock.h>
Soby Mathew8595b872015-01-06 15:36:38 +000036#include <bl_common.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010037#include <psci.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010038
Soby Mathew523d6332015-01-08 18:02:19 +000039/*
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 Thoelke56f44702014-06-20 00:36:14 +010047#else
Soby Mathew523d6332015-01-08 18:02:19 +000048#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 Thoelke56f44702014-06-20 00:36:14 +010053#endif
54
Soby Mathew6cdddaf2015-01-07 11:10:22 +000055/*
56 * The PSCI capability which are provided by the generic code but does not
57 * depend on the platform or spd capabilities.
58 */
59#define PSCI_GENERIC_CAP \
60 (define_psci_cap(PSCI_VERSION) | \
61 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \
62 define_psci_cap(PSCI_FEATURES))
63
64/*
65 * The PSCI capabilities mask for 64 bit functions.
66 */
67#define PSCI_CAP_64BIT_MASK \
68 (define_psci_cap(PSCI_CPU_SUSPEND_AARCH64) | \
69 define_psci_cap(PSCI_CPU_ON_AARCH64) | \
70 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \
71 define_psci_cap(PSCI_MIG_AARCH64) | \
Soby Mathew96168382014-12-17 14:47:57 +000072 define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64) | \
73 define_psci_cap(PSCI_SYSTEM_SUSPEND_AARCH64))
Soby Mathew6cdddaf2015-01-07 11:10:22 +000074
75
Achin Gupta4f6ad662013-10-25 09:08:21 +010076/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +010077 * The following two data structures hold the topology tree which in turn tracks
78 * the state of the all the affinity instances supported by the platform.
79 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010080typedef struct aff_map_node {
Achin Gupta4f6ad662013-10-25 09:08:21 +010081 unsigned long mpidr;
Soby Mathew523d6332015-01-08 18:02:19 +000082 unsigned char ref_count;
Achin Gupta4f6ad662013-10-25 09:08:21 +010083 unsigned char state;
Achin Gupta75f73672013-12-05 16:33:10 +000084 unsigned char level;
Soby Mathew523d6332015-01-08 18:02:19 +000085#if USE_COHERENT_MEM
Dan Handleye2712bc2014-04-10 15:37:22 +010086 bakery_lock_t lock;
Soby Mathew523d6332015-01-08 18:02:19 +000087#else
88 /* For indexing the bakery_info array in per CPU data */
89 unsigned char aff_map_index;
90#endif
Dan Handleye2712bc2014-04-10 15:37:22 +010091} aff_map_node_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +010092
Dan Handleye2712bc2014-04-10 15:37:22 +010093typedef struct aff_limits_node {
Achin Gupta4f6ad662013-10-25 09:08:21 +010094 int min;
95 int max;
Dan Handleye2712bc2014-04-10 15:37:22 +010096} aff_limits_node_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +010097
Soby Mathewe2b2d8f2014-12-04 14:14:12 +000098typedef aff_map_node_t (*mpidr_aff_map_nodes_t[MPIDR_MAX_AFFLVL + 1]);
Soby Mathew74e52a72014-10-02 16:56:51 +010099typedef void (*afflvl_power_on_finisher_t)(aff_map_node_t *);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100100
101/*******************************************************************************
102 * Data prototypes
103 ******************************************************************************/
Dan Handleya4cb68e2014-04-23 13:47:06 +0100104extern const plat_pm_ops_t *psci_plat_pm_ops;
Dan Handleye2712bc2014-04-10 15:37:22 +0100105extern aff_map_node_t psci_aff_map[PSCI_NUM_AFFS];
Soby Mathew96168382014-12-17 14:47:57 +0000106extern aff_limits_node_t psci_aff_limits[MPIDR_MAX_AFFLVL + 1];
Soby Mathew6cdddaf2015-01-07 11:10:22 +0000107extern uint32_t psci_caps;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100108
109/*******************************************************************************
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000110 * SPD's power management hooks registered with PSCI
Achin Gupta607084e2014-02-09 18:24:19 +0000111 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100112extern const spd_pm_ops_t *psci_spd_pm;
Achin Gupta607084e2014-02-09 18:24:19 +0000113
114/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100115 * Function prototypes
116 ******************************************************************************/
117/* Private exported functions from psci_common.c */
Dan Handleya17fefa2014-05-14 12:38:32 +0100118unsigned short psci_get_state(aff_map_node_t *node);
119unsigned short psci_get_phys_state(aff_map_node_t *node);
120void psci_set_state(aff_map_node_t *node, unsigned short state);
Dan Handleya17fefa2014-05-14 12:38:32 +0100121unsigned long mpidr_set_aff_inst(unsigned long, unsigned char, int);
122int psci_validate_mpidr(unsigned long, int);
Achin Guptaf3ccbab2014-07-25 14:52:47 +0100123int get_power_on_target_afflvl(void);
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100124void psci_afflvl_power_on_finish(int,
Dan Handleya17fefa2014-05-14 12:38:32 +0100125 int,
126 afflvl_power_on_finisher_t *);
Soby Mathew8595b872015-01-06 15:36:38 +0000127int psci_get_ns_ep_info(entry_point_info_t *ep,
128 uint64_t entrypoint, uint64_t context_id);
Dan Handleya17fefa2014-05-14 12:38:32 +0100129int psci_check_afflvl_range(int start_afflvl, int end_afflvl);
Achin Guptacab78e42014-07-28 00:09:01 +0100130void psci_do_afflvl_state_mgmt(uint32_t start_afflvl,
131 uint32_t end_afflvl,
Achin Gupta56bcdc22014-07-28 00:15:23 +0100132 aff_map_node_t *mpidr_nodes[],
Achin Guptacab78e42014-07-28 00:09:01 +0100133 uint32_t state);
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100134void psci_acquire_afflvl_locks(int start_afflvl,
Achin Gupta56bcdc22014-07-28 00:15:23 +0100135 int end_afflvl,
136 aff_map_node_t *mpidr_nodes[]);
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100137void psci_release_afflvl_locks(int start_afflvl,
Dan Handleya17fefa2014-05-14 12:38:32 +0100138 int end_afflvl,
139 mpidr_aff_map_nodes_t mpidr_nodes);
Juan Castillo4dc4a472014-08-12 11:17:06 +0100140void psci_print_affinity_map(void);
Achin Guptaf6b9e992014-07-31 11:19:11 +0100141void psci_set_max_phys_off_afflvl(uint32_t afflvl);
142uint32_t psci_find_max_phys_off_afflvl(uint32_t start_afflvl,
143 uint32_t end_afflvl,
Achin Gupta56bcdc22014-07-28 00:15:23 +0100144 aff_map_node_t *mpidr_nodes[]);
Soby Mathew96168382014-12-17 14:47:57 +0000145unsigned int psci_is_last_on_cpu(void);
Soby Mathew110fe362014-10-23 10:35:34 +0100146int psci_spd_migrate_info(uint64_t *mpidr);
Achin Gupta0959db52013-12-02 17:33:04 +0000147
Achin Gupta4f6ad662013-10-25 09:08:21 +0100148/* Private exported functions from psci_setup.c */
Dan Handleya17fefa2014-05-14 12:38:32 +0100149int psci_get_aff_map_nodes(unsigned long mpidr,
150 int start_afflvl,
151 int end_afflvl,
Achin Gupta56bcdc22014-07-28 00:15:23 +0100152 aff_map_node_t *mpidr_nodes[]);
Dan Handleya17fefa2014-05-14 12:38:32 +0100153aff_map_node_t *psci_get_aff_map_node(unsigned long, int);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100154
155/* Private exported functions from psci_affinity_on.c */
Soby Mathew8595b872015-01-06 15:36:38 +0000156int psci_afflvl_on(unsigned long target_cpu,
157 entry_point_info_t *ep,
158 int start_afflvl,
159 int end_afflvl);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100160
161/* Private exported functions from psci_affinity_off.c */
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100162int psci_afflvl_off(int, int);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100163
164/* Private exported functions from psci_affinity_suspend.c */
Soby Mathew74e52a72014-10-02 16:56:51 +0100165void psci_afflvl_suspend(entry_point_info_t *ep,
Soby Mathew8595b872015-01-06 15:36:38 +0000166 int start_afflvl,
167 int end_afflvl);
168
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100169unsigned int psci_afflvl_suspend_finish(int, int);
Achin Guptaf3ccbab2014-07-25 14:52:47 +0100170void psci_set_suspend_power_state(unsigned int power_state);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000171
Achin Guptae1aa5162014-06-26 09:58:52 +0100172/* Private exported functions from psci_helpers.S */
173void psci_do_pwrdown_cache_maintenance(uint32_t affinity_level);
174void psci_do_pwrup_cache_maintenance(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100175
Juan Castillo4dc4a472014-08-12 11:17:06 +0100176/* Private exported functions from psci_system_off.c */
177void __dead2 psci_system_off(void);
178void __dead2 psci_system_reset(void);
179
Achin Gupta4f6ad662013-10-25 09:08:21 +0100180#endif /* __PSCI_PRIVATE_H__ */