Re-factor header files for easier PSCI library integration
authorSoby Mathew <soby.mathew@arm.com>
Mon, 13 Feb 2017 12:46:28 +0000 (12:46 +0000)
committerSoby Mathew <soby.mathew@arm.com>
Mon, 27 Mar 2017 14:53:44 +0000 (15:53 +0100)
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>
include/common/bl_common.h
include/common/ep_info.h [new file with mode: 0644]
include/common/param_header.h [new file with mode: 0644]
include/lib/el3_runtime/context_mgmt.h
include/lib/psci/psci.h
include/lib/psci/psci_lib.h [new file with mode: 0644]

index 66c20fc53137951f8085ed0c7d847623fea2cb3a..38be6283575ee53a970baf316ea3596eb60c2aa5 100644 (file)
@@ -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:
@@ -31,9 +31,8 @@
 #ifndef __BL_COMMON_H__
 #define __BL_COMMON_H__
 
-#define SECURE         0x0
-#define NON_SECURE     0x1
-#define sec_state_is_valid(s) (((s) == SECURE) || ((s) == NON_SECURE))
+#include <ep_info.h>
+#include <param_header.h>
 
 #define UP     1
 #define DOWN   0
 #define TOP    0x1
 #define BOTTOM !TOP
 
-/*******************************************************************************
- * Constants that allow assembler code to access members of and the
- * 'entry_point_info' structure at their correct offsets.
- ******************************************************************************/
-#define ENTRY_POINT_INFO_PC_OFFSET     0x08
-#ifdef AARCH32
-#define ENTRY_POINT_INFO_ARGS_OFFSET   0x10
-#else
-#define ENTRY_POINT_INFO_ARGS_OFFSET   0x18
-#endif
-
-/* The following are used to set/get image attributes. */
-#define PARAM_EP_SECURITY_MASK         (0x1)
-
-#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
-#define SET_SECURITY_STATE(x, security) \
-                       ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
-
-
 /*
  * The following are used for image state attributes.
  * Image can only be in one of the following state.
 #define IMAGE_STATE_EXECUTED                   4
 #define IMAGE_STATE_INTERRUPTED                        5
 
-#define EP_EE_MASK     0x2
-#define EP_EE_LITTLE   0x0
-#define EP_EE_BIG      0x2
-#define EP_GET_EE(x) (x & EP_EE_MASK)
-#define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee))
-
-#define EP_ST_MASK     0x4
-#define EP_ST_DISABLE  0x0
-#define EP_ST_ENABLE   0x4
-#define EP_GET_ST(x) (x & EP_ST_MASK)
-#define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee))
-
-#define EP_EXE_MASK    0x8
-#define NON_EXECUTABLE 0x0
-#define EXECUTABLE     0x8
-#define EP_GET_EXE(x) (x & EP_EXE_MASK)
-#define EP_SET_EXE(x, ee) ((x) = ((x) & ~EP_EXE_MASK) | (ee))
-
-#define EP_FIRST_EXE_MASK      0x10
-#define EP_FIRST_EXE           0x10
-#define EP_GET_FIRST_EXE(x) ((x) & EP_FIRST_EXE_MASK)
-#define EP_SET_FIRST_EXE(x, ee) ((x) = ((x) & ~EP_FIRST_EXE_MASK) | (ee))
-
-#define PARAM_EP               0x01
-#define PARAM_IMAGE_BINARY     0x02
-#define PARAM_BL31             0x03
-#define PARAM_BL_LOAD_INFO     0x04
-#define PARAM_BL_PARAMS                0x05
-#define PARAM_PSCI_LIB_ARGS    0x06
-
 #define IMAGE_ATTRIB_SKIP_LOADING      0x02
 #define IMAGE_ATTRIB_PLAT_SETUP                0x04
 
-#define VERSION_1      0x01
-#define VERSION_2      0x02
-
 #define INVALID_IMAGE_ID               (0xFFFFFFFF)
 
-#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
-       (_p)->h.type = (uint8_t)(_type); \
-       (_p)->h.version = (uint8_t)(_ver); \
-       (_p)->h.size = (uint16_t)sizeof(*_p); \
-       (_p)->h.attr = (uint32_t)(_attr) ; \
-       } while (0)
-
-/* Following is used for populating structure members statically. */
-#define SET_STATIC_PARAM_HEAD(_p, _type, _ver, _p_type, _attr) \
-       ._p.h.type = (uint8_t)(_type), \
-       ._p.h.version = (uint8_t)(_ver), \
-       ._p.h.size = (uint16_t)sizeof(_p_type), \
-       ._p.h.attr = (uint32_t)(_attr)
-
-
 /*******************************************************************************
  * Constants to indicate type of exception to the common exception handler.
  ******************************************************************************/
 #define SERROR_AARCH32                 0xf
 
 #ifndef __ASSEMBLY__
-#include <cdefs.h> /* For __dead2 */
 #include <cassert.h>
-#include <stdint.h>
 #include <stddef.h>
+#include <stdint.h>
 #include <types.h>
 #include <utils.h> /* To retain compatibility */
 
@@ -185,7 +116,6 @@ extern uintptr_t __COHERENT_RAM_START__;
 extern uintptr_t __COHERENT_RAM_END__;
 #endif
 
-
 /*******************************************************************************
  * Structure used for telling the next BL how much of a particular type of
  * memory is available for its use and how much is already used.
@@ -199,55 +129,6 @@ typedef struct meminfo {
 #endif
 } meminfo_t;
 
-typedef struct aapcs64_params {
-       u_register_t arg0;
-       u_register_t arg1;
-       u_register_t arg2;
-       u_register_t arg3;
-       u_register_t arg4;
-       u_register_t arg5;
-       u_register_t arg6;
-       u_register_t arg7;
-} aapcs64_params_t;
-
-typedef struct aapcs32_params {
-       u_register_t arg0;
-       u_register_t arg1;
-       u_register_t arg2;
-       u_register_t arg3;
-} aapcs32_params_t;
-
-/***************************************************************************
- * This structure provides version information and the size of the
- * structure, attributes for the structure it represents
- ***************************************************************************/
-typedef struct param_header {
-       uint8_t type;           /* type of the structure */
-       uint8_t version;    /* version of this structure */
-       uint16_t size;      /* size of this structure in bytes */
-       uint32_t attr;      /* attributes: unused bits SBZ */
-} param_header_t;
-
-/*****************************************************************************
- * This structure represents the superset of information needed while
- * switching exception levels. The only two mechanisms to do so are
- * ERET & SMC. Security state is indicated using bit zero of header
- * attribute
- * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start
- * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while
- * processing SMC to jump to BL31.
- *****************************************************************************/
-typedef struct entry_point_info {
-       param_header_t h;
-       uintptr_t pc;
-       uint32_t spsr;
-#ifdef AARCH32
-       aapcs32_params_t args;
-#else
-       aapcs64_params_t args;
-#endif
-} entry_point_info_t;
-
 /*****************************************************************************
  * Image info binary provides information from the image loader that
  * can be used by the firmware to manage available trusted RAM.
@@ -338,24 +219,6 @@ typedef struct bl31_params {
 
 #endif /* LOAD_IMAGE_V2 */
 
-/*
- * Compile time assertions related to the 'entry_point_info' structure to
- * ensure that the assembler and the compiler view of the offsets of
- * the structure members is the same.
- */
-CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
-               __builtin_offsetof(entry_point_info_t, pc), \
-               assert_BL31_pc_offset_mismatch);
-
-CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
-               __builtin_offsetof(entry_point_info_t, args), \
-               assert_BL31_args_offset_mismatch);
-
-CASSERT(sizeof(uintptr_t) ==
-               __builtin_offsetof(entry_point_info_t, spsr) - \
-               __builtin_offsetof(entry_point_info_t, pc), \
-               assert_entrypoint_and_spsr_should_be_adjacent);
-
 /*******************************************************************************
  * Function & variable prototypes
  ******************************************************************************/
diff --git a/include/common/ep_info.h b/include/common/ep_info.h
new file mode 100644 (file)
index 0000000..3613614
--- /dev/null
@@ -0,0 +1,145 @@
+/*
+ * 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 __EP_INFO_H__
+#define __EP_INFO_H__
+
+#include <param_header.h>
+
+#define SECURE         0x0
+#define NON_SECURE     0x1
+#define sec_state_is_valid(s) (((s) == SECURE) || ((s) == NON_SECURE))
+
+/*******************************************************************************
+ * Constants that allow assembler code to access members of and the
+ * 'entry_point_info' structure at their correct offsets.
+ ******************************************************************************/
+#define ENTRY_POINT_INFO_PC_OFFSET     0x08
+#ifdef AARCH32
+#define ENTRY_POINT_INFO_ARGS_OFFSET   0x10
+#else
+#define ENTRY_POINT_INFO_ARGS_OFFSET   0x18
+#endif
+
+/* The following are used to set/get image attributes. */
+#define PARAM_EP_SECURITY_MASK         (0x1)
+
+#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
+#define SET_SECURITY_STATE(x, security) \
+                       ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
+
+#define EP_EE_MASK     0x2
+#define EP_EE_LITTLE   0x0
+#define EP_EE_BIG      0x2
+#define EP_GET_EE(x) (x & EP_EE_MASK)
+#define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee))
+
+#define EP_ST_MASK     0x4
+#define EP_ST_DISABLE  0x0
+#define EP_ST_ENABLE   0x4
+#define EP_GET_ST(x) (x & EP_ST_MASK)
+#define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee))
+
+#define EP_EXE_MASK    0x8
+#define NON_EXECUTABLE 0x0
+#define EXECUTABLE     0x8
+#define EP_GET_EXE(x) (x & EP_EXE_MASK)
+#define EP_SET_EXE(x, ee) ((x) = ((x) & ~EP_EXE_MASK) | (ee))
+
+#define EP_FIRST_EXE_MASK      0x10
+#define EP_FIRST_EXE           0x10
+#define EP_GET_FIRST_EXE(x) ((x) & EP_FIRST_EXE_MASK)
+#define EP_SET_FIRST_EXE(x, ee) ((x) = ((x) & ~EP_FIRST_EXE_MASK) | (ee))
+
+#ifndef __ASSEMBLY__
+
+#include <cassert.h>
+#include <types.h>
+
+typedef struct aapcs64_params {
+       u_register_t arg0;
+       u_register_t arg1;
+       u_register_t arg2;
+       u_register_t arg3;
+       u_register_t arg4;
+       u_register_t arg5;
+       u_register_t arg6;
+       u_register_t arg7;
+} aapcs64_params_t;
+
+typedef struct aapcs32_params {
+       u_register_t arg0;
+       u_register_t arg1;
+       u_register_t arg2;
+       u_register_t arg3;
+} aapcs32_params_t;
+
+/*****************************************************************************
+ * This structure represents the superset of information needed while
+ * switching exception levels. The only two mechanisms to do so are
+ * ERET & SMC. Security state is indicated using bit zero of header
+ * attribute
+ * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start
+ * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while
+ * processing SMC to jump to BL31.
+ *****************************************************************************/
+typedef struct entry_point_info {
+       param_header_t h;
+       uintptr_t pc;
+       uint32_t spsr;
+#ifdef AARCH32
+       aapcs32_params_t args;
+#else
+       aapcs64_params_t args;
+#endif
+} entry_point_info_t;
+
+/*
+ * Compile time assertions related to the 'entry_point_info' structure to
+ * ensure that the assembler and the compiler view of the offsets of
+ * the structure members is the same.
+ */
+CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
+               __builtin_offsetof(entry_point_info_t, pc), \
+               assert_BL31_pc_offset_mismatch);
+
+CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
+               __builtin_offsetof(entry_point_info_t, args), \
+               assert_BL31_args_offset_mismatch);
+
+CASSERT(sizeof(uintptr_t) ==
+               __builtin_offsetof(entry_point_info_t, spsr) - \
+               __builtin_offsetof(entry_point_info_t, pc), \
+               assert_entrypoint_and_spsr_should_be_adjacent);
+
+#endif /*__ASSEMBLY__*/
+
+#endif /* __EP_INFO_H__ */
+
diff --git a/include/common/param_header.h b/include/common/param_header.h
new file mode 100644 (file)
index 0000000..176fc95
--- /dev/null
@@ -0,0 +1,78 @@
+/*
+ * 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 __PARAM_HEADER_H__
+#define __PARAM_HEADER_H__
+
+/* Param header types */
+#define PARAM_EP               0x01
+#define PARAM_IMAGE_BINARY     0x02
+#define PARAM_BL31             0x03
+#define PARAM_BL_LOAD_INFO     0x04
+#define PARAM_BL_PARAMS                0x05
+#define PARAM_PSCI_LIB_ARGS    0x06
+
+/* Param header version */
+#define VERSION_1      0x01
+#define VERSION_2      0x02
+
+#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
+       (_p)->h.type = (uint8_t)(_type); \
+       (_p)->h.version = (uint8_t)(_ver); \
+       (_p)->h.size = (uint16_t)sizeof(*_p); \
+       (_p)->h.attr = (uint32_t)(_attr) ; \
+       } while (0)
+
+/* Following is used for populating structure members statically. */
+#define SET_STATIC_PARAM_HEAD(_p, _type, _ver, _p_type, _attr) \
+       ._p.h.type = (uint8_t)(_type), \
+       ._p.h.version = (uint8_t)(_ver), \
+       ._p.h.size = (uint16_t)sizeof(_p_type), \
+       ._p.h.attr = (uint32_t)(_attr)
+
+#ifndef __ASSEMBLY__
+
+#include <types.h>
+
+/***************************************************************************
+ * This structure provides version information and the size of the
+ * structure, attributes for the structure it represents
+ ***************************************************************************/
+typedef struct param_header {
+       uint8_t type;           /* type of the structure */
+       uint8_t version;    /* version of this structure */
+       uint16_t size;      /* size of this structure in bytes */
+       uint32_t attr;      /* attributes: unused bits SBZ */
+} param_header_t;
+
+#endif /*__ASSEMBLY__*/
+
+#endif /* __PARAM_HEADER_H__ */
+
index 676973cecb85f6b4ef0314a889a707df4d9ff93a..ca868ddb59df446a7a825cc8bbb073e3d5b31133 100644 (file)
@@ -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:
@@ -31,7 +31,9 @@
 #ifndef __CM_H__
 #define __CM_H__
 
+#ifndef AARCH32
 #include <arch.h>
+#endif
 
 /*******************************************************************************
  * Forward declarations
index 34de4c28a5dc37be9f062c6c6dec9ef54c9d983f..fa85e0bcf1f9b7b3e0d21e84d16c03abbad7ba81 100644 (file)
@@ -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__ */
diff --git a/include/lib/psci/psci_lib.h b/include/lib/psci/psci_lib.h
new file mode 100644 (file)
index 0000000..2169d6d
--- /dev/null
@@ -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 */
+