mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-05-08 18:41:22 +00:00
Re-factor header files for easier PSCI library integration
This patch re-factors the following headers to make it easier to
integrate the PSCI library with an AArch32 Secure Payload :
* bl_common.h : The entry point information and the param
header data structures are factored out into separate
headers ep_info.h and param_headers.h
* psci.h : The PSCI library interfaces are factored out
into the new header psci_lib.h
* context_mgmt.h : The header file is modified to not include
arch.h when compiled for AArch32 mode.
No functional changes are introduced by this patch.
Change-Id: I5e21a843c0af2ba8e47dee4e577cf95929be8cd4
Signed-off-by: Soby Mathew <soby.mathew@arm.com>
This commit is contained in:
Soby Mathew
parent
891685a511
commit
5dffb46c9c
6 changed files with 348 additions and 218 deletions
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved.
|
||||
* Copyright (c) 2013-2017, 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:
|
||||
|
|
@ -37,6 +37,7 @@
|
|||
#if ENABLE_PLAT_COMPAT
|
||||
#include <psci_compat.h>
|
||||
#endif
|
||||
#include <psci_lib.h> /* To maintain compatibility for SPDs */
|
||||
|
||||
/*******************************************************************************
|
||||
* Number of power domains whose state this PSCI implementation can track
|
||||
|
|
@ -310,24 +311,6 @@ typedef struct plat_psci_ops {
|
|||
int (*get_node_hw_state)(u_register_t mpidr, unsigned int power_level);
|
||||
} plat_psci_ops_t;
|
||||
|
||||
/*******************************************************************************
|
||||
* Optional structure populated by the Secure Payload Dispatcher to be given a
|
||||
* chance to perform any bookkeeping before PSCI executes a power management
|
||||
* operation. It also allows PSCI to determine certain properties of the SP e.g.
|
||||
* migrate capability etc.
|
||||
******************************************************************************/
|
||||
typedef struct spd_pm_ops {
|
||||
void (*svc_on)(u_register_t target_cpu);
|
||||
int32_t (*svc_off)(u_register_t __unused);
|
||||
void (*svc_suspend)(u_register_t max_off_pwrlvl);
|
||||
void (*svc_on_finish)(u_register_t __unused);
|
||||
void (*svc_suspend_finish)(u_register_t max_off_pwrlvl);
|
||||
int32_t (*svc_migrate)(u_register_t from_cpu, u_register_t to_cpu);
|
||||
int32_t (*svc_migrate_info)(u_register_t *resident_cpu);
|
||||
void (*svc_system_off)(void);
|
||||
void (*svc_system_reset)(void);
|
||||
} spd_pm_ops_t;
|
||||
|
||||
/*******************************************************************************
|
||||
* Function & Data prototypes
|
||||
******************************************************************************/
|
||||
|
|
@ -357,63 +340,6 @@ void psci_arch_setup(void);
|
|||
*/
|
||||
void psci_entrypoint(void) __deprecated;
|
||||
|
||||
/*
|
||||
* Function prototype for the warmboot entrypoint function which will be
|
||||
* programmed in the mailbox by the platform.
|
||||
*/
|
||||
typedef void (*mailbox_entrypoint_t)(void);
|
||||
|
||||
/******************************************************************************
|
||||
* Structure to pass PSCI Library arguments.
|
||||
*****************************************************************************/
|
||||
typedef struct psci_lib_args {
|
||||
/* The version information of PSCI Library Interface */
|
||||
param_header_t h;
|
||||
/* The warm boot entrypoint function */
|
||||
mailbox_entrypoint_t mailbox_ep;
|
||||
} psci_lib_args_t;
|
||||
|
||||
/* Helper macro to set the psci_lib_args_t structure at runtime */
|
||||
#define SET_PSCI_LIB_ARGS_V1(_p, _entry) do { \
|
||||
SET_PARAM_HEAD(_p, PARAM_PSCI_LIB_ARGS, VERSION_1, 0); \
|
||||
(_p)->mailbox_ep = (_entry); \
|
||||
} while (0)
|
||||
|
||||
/* Helper macro to define the psci_lib_args_t statically */
|
||||
#define DEFINE_STATIC_PSCI_LIB_ARGS_V1(_name, _entry) \
|
||||
static const psci_lib_args_t (_name) = { \
|
||||
.h.type = (uint8_t)PARAM_PSCI_LIB_ARGS, \
|
||||
.h.version = (uint8_t)VERSION_1, \
|
||||
.h.size = (uint16_t)sizeof(_name), \
|
||||
.h.attr = 0, \
|
||||
.mailbox_ep = (_entry) \
|
||||
}
|
||||
|
||||
/* Helper macro to verify the pointer to psci_lib_args_t structure */
|
||||
#define VERIFY_PSCI_LIB_ARGS_V1(_p) ((_p) \
|
||||
&& ((_p)->h.type == PARAM_PSCI_LIB_ARGS) \
|
||||
&& ((_p)->h.version == VERSION_1) \
|
||||
&& ((_p)->h.size == sizeof(*(_p))) \
|
||||
&& ((_p)->h.attr == 0) \
|
||||
&& ((_p)->mailbox_ep))
|
||||
|
||||
/******************************************************************************
|
||||
* PSCI Library Interfaces
|
||||
*****************************************************************************/
|
||||
u_register_t psci_smc_handler(uint32_t smc_fid,
|
||||
u_register_t x1,
|
||||
u_register_t x2,
|
||||
u_register_t x3,
|
||||
u_register_t x4,
|
||||
void *cookie,
|
||||
void *handle,
|
||||
u_register_t flags);
|
||||
int psci_setup(const psci_lib_args_t *lib_args);
|
||||
void psci_warmboot_entrypoint(void);
|
||||
void psci_register_spd_pm_hook(const spd_pm_ops_t *pm);
|
||||
void psci_prepare_next_non_secure_ctx(
|
||||
entry_point_info_t *next_image_info);
|
||||
|
||||
#endif /*__ASSEMBLY__*/
|
||||
|
||||
#endif /* __PSCI_H__ */
|
||||
|
|
|
|||
116
include/lib/psci/psci_lib.h
Normal file
116
include/lib/psci/psci_lib.h
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
/*
|
||||
* Copyright (c) 2017, 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_LIB_H__
|
||||
#define __PSCI_LIB_H__
|
||||
|
||||
#include <ep_info.h>
|
||||
|
||||
#ifndef __ASSEMBLY__
|
||||
#include <types.h>
|
||||
|
||||
/*******************************************************************************
|
||||
* Optional structure populated by the Secure Payload Dispatcher to be given a
|
||||
* chance to perform any bookkeeping before PSCI executes a power management
|
||||
* operation. It also allows PSCI to determine certain properties of the SP e.g.
|
||||
* migrate capability etc.
|
||||
******************************************************************************/
|
||||
typedef struct spd_pm_ops {
|
||||
void (*svc_on)(u_register_t target_cpu);
|
||||
int32_t (*svc_off)(u_register_t __unused);
|
||||
void (*svc_suspend)(u_register_t max_off_pwrlvl);
|
||||
void (*svc_on_finish)(u_register_t __unused);
|
||||
void (*svc_suspend_finish)(u_register_t max_off_pwrlvl);
|
||||
int32_t (*svc_migrate)(u_register_t from_cpu, u_register_t to_cpu);
|
||||
int32_t (*svc_migrate_info)(u_register_t *resident_cpu);
|
||||
void (*svc_system_off)(void);
|
||||
void (*svc_system_reset)(void);
|
||||
} spd_pm_ops_t;
|
||||
|
||||
/*
|
||||
* Function prototype for the warmboot entrypoint function which will be
|
||||
* programmed in the mailbox by the platform.
|
||||
*/
|
||||
typedef void (*mailbox_entrypoint_t)(void);
|
||||
|
||||
/******************************************************************************
|
||||
* Structure to pass PSCI Library arguments.
|
||||
*****************************************************************************/
|
||||
typedef struct psci_lib_args {
|
||||
/* The version information of PSCI Library Interface */
|
||||
param_header_t h;
|
||||
/* The warm boot entrypoint function */
|
||||
mailbox_entrypoint_t mailbox_ep;
|
||||
} psci_lib_args_t;
|
||||
|
||||
/* Helper macro to set the psci_lib_args_t structure at runtime */
|
||||
#define SET_PSCI_LIB_ARGS_V1(_p, _entry) do { \
|
||||
SET_PARAM_HEAD(_p, PARAM_PSCI_LIB_ARGS, VERSION_1, 0); \
|
||||
(_p)->mailbox_ep = (_entry); \
|
||||
} while (0)
|
||||
|
||||
/* Helper macro to define the psci_lib_args_t statically */
|
||||
#define DEFINE_STATIC_PSCI_LIB_ARGS_V1(_name, _entry) \
|
||||
static const psci_lib_args_t (_name) = { \
|
||||
.h.type = (uint8_t)PARAM_PSCI_LIB_ARGS, \
|
||||
.h.version = (uint8_t)VERSION_1, \
|
||||
.h.size = (uint16_t)sizeof(_name), \
|
||||
.h.attr = 0, \
|
||||
.mailbox_ep = (_entry) \
|
||||
}
|
||||
|
||||
/* Helper macro to verify the pointer to psci_lib_args_t structure */
|
||||
#define VERIFY_PSCI_LIB_ARGS_V1(_p) ((_p) \
|
||||
&& ((_p)->h.type == PARAM_PSCI_LIB_ARGS) \
|
||||
&& ((_p)->h.version == VERSION_1) \
|
||||
&& ((_p)->h.size == sizeof(*(_p))) \
|
||||
&& ((_p)->h.attr == 0) \
|
||||
&& ((_p)->mailbox_ep))
|
||||
|
||||
/******************************************************************************
|
||||
* PSCI Library Interfaces
|
||||
*****************************************************************************/
|
||||
u_register_t psci_smc_handler(uint32_t smc_fid,
|
||||
u_register_t x1,
|
||||
u_register_t x2,
|
||||
u_register_t x3,
|
||||
u_register_t x4,
|
||||
void *cookie,
|
||||
void *handle,
|
||||
u_register_t flags);
|
||||
int psci_setup(const psci_lib_args_t *lib_args);
|
||||
void psci_warmboot_entrypoint(void);
|
||||
void psci_register_spd_pm_hook(const spd_pm_ops_t *pm);
|
||||
void psci_prepare_next_non_secure_ctx(
|
||||
entry_point_info_t *next_image_info);
|
||||
#endif /* __ASSEMBLY__ */
|
||||
|
||||
#endif /* __PSCI_LIB_H */
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue