blob: bbc8c3232d354eac25b29bb9422a8f8ed8a3b9a2 [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>
Andrew Thoelke56f44702014-06-20 00:36:14 +010036#include <platform_def.h> /* for PLATFORM_NUM_AFFS */
Dan Handley2bd4ef22014-04-09 13:14:54 +010037#include <psci.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010038
Andrew Thoelke56f44702014-06-20 00:36:14 +010039/* Number of affinity instances whose state this psci imp. can track */
40#ifdef PLATFORM_NUM_AFFS
41#define PSCI_NUM_AFFS PLATFORM_NUM_AFFS
42#else
43#define PSCI_NUM_AFFS (2 * PLATFORM_CORE_COUNT)
44#endif
45
Achin Gupta4f6ad662013-10-25 09:08:21 +010046/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +010047 * The following two data structures hold the topology tree which in turn tracks
48 * the state of the all the affinity instances supported by the platform.
49 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010050typedef struct aff_map_node {
Achin Gupta4f6ad662013-10-25 09:08:21 +010051 unsigned long mpidr;
Achin Gupta75f73672013-12-05 16:33:10 +000052 unsigned short ref_count;
Achin Gupta4f6ad662013-10-25 09:08:21 +010053 unsigned char state;
Achin Gupta75f73672013-12-05 16:33:10 +000054 unsigned char level;
Dan Handleye2712bc2014-04-10 15:37:22 +010055 bakery_lock_t lock;
56} aff_map_node_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +010057
Dan Handleye2712bc2014-04-10 15:37:22 +010058typedef struct aff_limits_node {
Achin Gupta4f6ad662013-10-25 09:08:21 +010059 int min;
60 int max;
Dan Handleye2712bc2014-04-10 15:37:22 +010061} aff_limits_node_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +010062
Dan Handleye2712bc2014-04-10 15:37:22 +010063typedef aff_map_node_t (*mpidr_aff_map_nodes_t[MPIDR_MAX_AFFLVL]);
Andrew Thoelke2bc07852014-06-09 12:44:21 +010064typedef unsigned int (*afflvl_power_on_finisher_t)(aff_map_node_t *);
Achin Gupta4f6ad662013-10-25 09:08:21 +010065
66/*******************************************************************************
67 * Data prototypes
68 ******************************************************************************/
Dan Handleya4cb68e2014-04-23 13:47:06 +010069extern const plat_pm_ops_t *psci_plat_pm_ops;
Dan Handleye2712bc2014-04-10 15:37:22 +010070extern aff_map_node_t psci_aff_map[PSCI_NUM_AFFS];
Achin Gupta4f6ad662013-10-25 09:08:21 +010071
72/*******************************************************************************
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000073 * SPD's power management hooks registered with PSCI
Achin Gupta607084e2014-02-09 18:24:19 +000074 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010075extern const spd_pm_ops_t *psci_spd_pm;
Achin Gupta607084e2014-02-09 18:24:19 +000076
77/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +010078 * Function prototypes
79 ******************************************************************************/
80/* Private exported functions from psci_common.c */
Dan Handleya17fefa2014-05-14 12:38:32 +010081int get_max_afflvl(void);
82unsigned short psci_get_state(aff_map_node_t *node);
83unsigned short psci_get_phys_state(aff_map_node_t *node);
84void psci_set_state(aff_map_node_t *node, unsigned short state);
Dan Handleya17fefa2014-05-14 12:38:32 +010085unsigned long mpidr_set_aff_inst(unsigned long, unsigned char, int);
86int psci_validate_mpidr(unsigned long, int);
Achin Guptaf3ccbab2014-07-25 14:52:47 +010087int get_power_on_target_afflvl(void);
Andrew Thoelke2bc07852014-06-09 12:44:21 +010088void psci_afflvl_power_on_finish(int,
Dan Handleya17fefa2014-05-14 12:38:32 +010089 int,
90 afflvl_power_on_finisher_t *);
Andrew Thoelke4e126072014-06-04 21:10:52 +010091int psci_save_ns_entry(uint64_t mpidr,
92 uint64_t entrypoint, uint64_t context_id,
93 uint32_t caller_scr_el3, uint32_t caller_sctlr_el1);
Dan Handleya17fefa2014-05-14 12:38:32 +010094int psci_check_afflvl_range(int start_afflvl, int end_afflvl);
Achin Guptacab78e42014-07-28 00:09:01 +010095void psci_do_afflvl_state_mgmt(uint32_t start_afflvl,
96 uint32_t end_afflvl,
97 mpidr_aff_map_nodes_t mpidr_nodes,
98 uint32_t state);
Andrew Thoelke2bc07852014-06-09 12:44:21 +010099void psci_acquire_afflvl_locks(int start_afflvl,
Dan Handleya17fefa2014-05-14 12:38:32 +0100100 int end_afflvl,
101 mpidr_aff_map_nodes_t mpidr_nodes);
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100102void psci_release_afflvl_locks(int start_afflvl,
Dan Handleya17fefa2014-05-14 12:38:32 +0100103 int end_afflvl,
104 mpidr_aff_map_nodes_t mpidr_nodes);
Juan Castillo4dc4a472014-08-12 11:17:06 +0100105void psci_print_affinity_map(void);
Achin Guptaf6b9e992014-07-31 11:19:11 +0100106void psci_set_max_phys_off_afflvl(uint32_t afflvl);
107uint32_t psci_find_max_phys_off_afflvl(uint32_t start_afflvl,
108 uint32_t end_afflvl,
109 mpidr_aff_map_nodes_t mpidr_nodes);
Achin Gupta0959db52013-12-02 17:33:04 +0000110
Achin Gupta4f6ad662013-10-25 09:08:21 +0100111/* Private exported functions from psci_setup.c */
Dan Handleya17fefa2014-05-14 12:38:32 +0100112int psci_get_aff_map_nodes(unsigned long mpidr,
113 int start_afflvl,
114 int end_afflvl,
115 mpidr_aff_map_nodes_t mpidr_nodes);
116aff_map_node_t *psci_get_aff_map_node(unsigned long, int);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100117
118/* Private exported functions from psci_affinity_on.c */
Dan Handleya17fefa2014-05-14 12:38:32 +0100119int psci_afflvl_on(unsigned long,
120 unsigned long,
121 unsigned long,
122 int,
123 int);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100124
125/* Private exported functions from psci_affinity_off.c */
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100126int psci_afflvl_off(int, int);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100127
128/* Private exported functions from psci_affinity_suspend.c */
Dan Handleya17fefa2014-05-14 12:38:32 +0100129int psci_afflvl_suspend(unsigned long,
130 unsigned long,
Dan Handleya17fefa2014-05-14 12:38:32 +0100131 unsigned int,
132 int,
133 int);
Andrew Thoelke2bc07852014-06-09 12:44:21 +0100134unsigned int psci_afflvl_suspend_finish(int, int);
Achin Guptaf3ccbab2014-07-25 14:52:47 +0100135void psci_set_suspend_power_state(unsigned int power_state);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000136
Achin Guptae1aa5162014-06-26 09:58:52 +0100137/* Private exported functions from psci_helpers.S */
138void psci_do_pwrdown_cache_maintenance(uint32_t affinity_level);
139void psci_do_pwrup_cache_maintenance(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100140
Juan Castillo4dc4a472014-08-12 11:17:06 +0100141/* Private exported functions from psci_system_off.c */
142void __dead2 psci_system_off(void);
143void __dead2 psci_system_reset(void);
144
Achin Gupta4f6ad662013-10-25 09:08:21 +0100145#endif /* __PSCI_PRIVATE_H__ */