• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef PSCI_LIB_H
8 #define PSCI_LIB_H
9 
10 #include <common/ep_info.h>
11 
12 #ifndef __ASSEMBLER__
13 
14 #include <cdefs.h>
15 #include <stdint.h>
16 
17 /*******************************************************************************
18  * Optional structure populated by the Secure Payload Dispatcher to be given a
19  * chance to perform any bookkeeping before PSCI executes a power management
20  * operation. It also allows PSCI to determine certain properties of the SP e.g.
21  * migrate capability etc.
22  ******************************************************************************/
23 typedef struct spd_pm_ops {
24 	void (*svc_on)(u_register_t target_cpu);
25 	int32_t (*svc_off)(u_register_t __unused unused);
26 	void (*svc_suspend)(u_register_t max_off_pwrlvl);
27 	void (*svc_on_finish)(u_register_t __unused unused);
28 	void (*svc_suspend_finish)(u_register_t max_off_pwrlvl);
29 	int32_t (*svc_migrate)(u_register_t from_cpu, u_register_t to_cpu);
30 	int32_t (*svc_migrate_info)(u_register_t *resident_cpu);
31 	void (*svc_system_off)(void);
32 	void (*svc_system_reset)(void);
33 } spd_pm_ops_t;
34 
35 /*
36  * Function prototype for the warmboot entrypoint function which will be
37  * programmed in the mailbox by the platform.
38  */
39 typedef void (*mailbox_entrypoint_t)(void);
40 
41 /******************************************************************************
42  * Structure to pass PSCI Library arguments.
43  *****************************************************************************/
44 typedef struct psci_lib_args {
45 	/* The version information of PSCI Library Interface */
46 	param_header_t		h;
47 	/* The warm boot entrypoint function */
48 	mailbox_entrypoint_t	mailbox_ep;
49 } psci_lib_args_t;
50 
51 /* Helper macro to set the psci_lib_args_t structure at runtime */
52 #define SET_PSCI_LIB_ARGS_V1(_p, _entry)	do {			\
53 	SET_PARAM_HEAD(_p, PARAM_PSCI_LIB_ARGS, VERSION_1, 0);		\
54 	(_p)->mailbox_ep = (_entry);					\
55 	} while (0)
56 
57 /* Helper macro to define the psci_lib_args_t statically */
58 #define DEFINE_STATIC_PSCI_LIB_ARGS_V1(_name, _entry)		\
59 	static const psci_lib_args_t (_name) = {		\
60 		.h.type = (uint8_t)PARAM_PSCI_LIB_ARGS,		\
61 		.h.version = (uint8_t)VERSION_1,		\
62 		.h.size = (uint16_t)sizeof(_name),		\
63 		.h.attr = 0U,					\
64 		.mailbox_ep = (_entry)				\
65 	}
66 
67 /* Helper macro to verify the pointer to psci_lib_args_t structure */
68 #define VERIFY_PSCI_LIB_ARGS_V1(_p)	(((_p) != NULL)		\
69 		&& ((_p)->h.type == PARAM_PSCI_LIB_ARGS)	\
70 		&& ((_p)->h.version == VERSION_1)		\
71 		&& ((_p)->h.size == sizeof(*(_p)))		\
72 		&& ((_p)->h.attr == 0)				\
73 		&& ((_p)->mailbox_ep != NULL))
74 
75 /******************************************************************************
76  * PSCI Library Interfaces
77  *****************************************************************************/
78 u_register_t psci_smc_handler(uint32_t smc_fid,
79 			  u_register_t x1,
80 			  u_register_t x2,
81 			  u_register_t x3,
82 			  u_register_t x4,
83 			  void *cookie,
84 			  void *handle,
85 			  u_register_t flags);
86 int psci_setup(const psci_lib_args_t *lib_args);
87 int psci_secondaries_brought_up(void);
88 void psci_warmboot_entrypoint(void);
89 void psci_register_spd_pm_hook(const spd_pm_ops_t *pm);
90 void psci_prepare_next_non_secure_ctx(
91 			  entry_point_info_t *next_image_info);
92 int psci_stop_other_cores(unsigned int wait_ms,
93 			  void (*stop_func)(u_register_t mpidr));
94 #endif /* __ASSEMBLER__ */
95 
96 #endif /* PSCI_LIB_H */
97