/* * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * Neither the name of ARM nor the names of its contributors may be used * to endorse or promote products derived from this software without specific * prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #ifndef __PSCI_PRIVATE_H__ #define __PSCI_PRIVATE_H__ #include #include #include /******************************************************************************* * The following two data structures hold the generic information to bringup * a suspended/hotplugged out cpu ******************************************************************************/ typedef struct eret_params { unsigned long entrypoint; unsigned long spsr; } eret_params_t; typedef struct ns_entry_info { eret_params_t eret_info; unsigned long context_id; unsigned int scr; unsigned int sctlr; } ns_entry_info_t; /******************************************************************************* * The following two data structures hold the topology tree which in turn tracks * the state of the all the affinity instances supported by the platform. ******************************************************************************/ typedef struct aff_map_node { unsigned long mpidr; unsigned short ref_count; unsigned char state; unsigned char level; unsigned int data; bakery_lock_t lock; } aff_map_node_t; typedef struct aff_limits_node { int min; int max; } aff_limits_node_t; /******************************************************************************* * This data structure holds secure world context that needs to be preserved * across cpu_suspend calls which enter the power down state. ******************************************************************************/ typedef struct suspend_context { unsigned int power_state; } __aligned(CACHE_WRITEBACK_GRANULE) suspend_context_t; typedef aff_map_node_t (*mpidr_aff_map_nodes_t[MPIDR_MAX_AFFLVL]); typedef unsigned int (*afflvl_power_on_finisher_t)(unsigned long, aff_map_node_t *); /******************************************************************************* * Data prototypes ******************************************************************************/ extern suspend_context_t psci_suspend_context[PSCI_NUM_AFFS]; extern ns_entry_info_t psci_ns_entry_info[PSCI_NUM_AFFS]; extern unsigned int psci_ns_einfo_idx; extern aff_limits_node_t psci_aff_limits[MPIDR_MAX_AFFLVL + 1]; extern const plat_pm_ops_t *psci_plat_pm_ops; extern aff_map_node_t psci_aff_map[PSCI_NUM_AFFS]; extern afflvl_power_on_finisher_t psci_afflvl_off_finish_handlers[]; extern afflvl_power_on_finisher_t psci_afflvl_sus_finish_handlers[]; /******************************************************************************* * SPD's power management hooks registered with PSCI ******************************************************************************/ extern const spd_pm_ops_t *psci_spd_pm; /******************************************************************************* * Function prototypes ******************************************************************************/ /* Private exported functions from psci_common.c */ extern int get_max_afflvl(void); extern unsigned short psci_get_state(aff_map_node_t *node); extern unsigned short psci_get_phys_state(aff_map_node_t *node); extern void psci_set_state(aff_map_node_t *node, unsigned short state); extern void psci_get_ns_entry_info(unsigned int index); extern unsigned long mpidr_set_aff_inst(unsigned long, unsigned char, int); extern int psci_validate_mpidr(unsigned long, int); extern int get_power_on_target_afflvl(unsigned long mpidr); extern void psci_afflvl_power_on_finish(unsigned long, int, int, afflvl_power_on_finisher_t *); extern int psci_set_ns_entry_info(unsigned int index, unsigned long entrypoint, unsigned long context_id); extern int psci_check_afflvl_range(int start_afflvl, int end_afflvl); extern void psci_acquire_afflvl_locks(unsigned long mpidr, int start_afflvl, int end_afflvl, mpidr_aff_map_nodes_t mpidr_nodes); extern void psci_release_afflvl_locks(unsigned long mpidr, int start_afflvl, int end_afflvl, mpidr_aff_map_nodes_t mpidr_nodes); /* Private exported functions from psci_setup.c */ extern int psci_get_aff_map_nodes(unsigned long mpidr, int start_afflvl, int end_afflvl, mpidr_aff_map_nodes_t mpidr_nodes); extern aff_map_node_t *psci_get_aff_map_node(unsigned long, int); /* Private exported functions from psci_affinity_on.c */ extern int psci_afflvl_on(unsigned long, unsigned long, unsigned long, int, int); /* Private exported functions from psci_affinity_off.c */ extern int psci_afflvl_off(unsigned long, int, int); /* Private exported functions from psci_affinity_suspend.c */ extern void psci_set_suspend_power_state(aff_map_node_t *node, unsigned int power_state); extern int psci_get_aff_map_node_suspend_afflvl(aff_map_node_t *node); extern int psci_afflvl_suspend(unsigned long, unsigned long, unsigned long, unsigned int, int, int); extern unsigned int psci_afflvl_suspend_finish(unsigned long, int, int); #endif /* __PSCI_PRIVATE_H__ */