blob: 5b30f55ec697504a316300f5cd4eca2172000cad [file] [log] [blame]
Soby Mathewb911cc72017-02-13 12:46:28 +00001/*
Antonio Nino Diaz3ce0e772018-07-16 17:32:37 +01002 * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
Soby Mathewb911cc72017-02-13 12:46:28 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Soby Mathewb911cc72017-02-13 12:46:28 +00005 */
6
Antonio Nino Diaz3ce0e772018-07-16 17:32:37 +01007#ifndef PSCI_LIB_H
8#define PSCI_LIB_H
Soby Mathewb911cc72017-02-13 12:46:28 +00009
10#include <ep_info.h>
11
12#ifndef __ASSEMBLY__
13#include <types.h>
14
15/*******************************************************************************
16 * Optional structure populated by the Secure Payload Dispatcher to be given a
17 * chance to perform any bookkeeping before PSCI executes a power management
18 * operation. It also allows PSCI to determine certain properties of the SP e.g.
19 * migrate capability etc.
20 ******************************************************************************/
21typedef struct spd_pm_ops {
22 void (*svc_on)(u_register_t target_cpu);
Antonio Nino Diaz3ce0e772018-07-16 17:32:37 +010023 int32_t (*svc_off)(u_register_t __unused unused);
Soby Mathewb911cc72017-02-13 12:46:28 +000024 void (*svc_suspend)(u_register_t max_off_pwrlvl);
Antonio Nino Diaz3ce0e772018-07-16 17:32:37 +010025 void (*svc_on_finish)(u_register_t __unused unused);
Soby Mathewb911cc72017-02-13 12:46:28 +000026 void (*svc_suspend_finish)(u_register_t max_off_pwrlvl);
27 int32_t (*svc_migrate)(u_register_t from_cpu, u_register_t to_cpu);
28 int32_t (*svc_migrate_info)(u_register_t *resident_cpu);
29 void (*svc_system_off)(void);
30 void (*svc_system_reset)(void);
31} spd_pm_ops_t;
32
33/*
34 * Function prototype for the warmboot entrypoint function which will be
35 * programmed in the mailbox by the platform.
36 */
37typedef void (*mailbox_entrypoint_t)(void);
38
39/******************************************************************************
40 * Structure to pass PSCI Library arguments.
41 *****************************************************************************/
42typedef struct psci_lib_args {
43 /* The version information of PSCI Library Interface */
44 param_header_t h;
45 /* The warm boot entrypoint function */
46 mailbox_entrypoint_t mailbox_ep;
47} psci_lib_args_t;
48
49/* Helper macro to set the psci_lib_args_t structure at runtime */
50#define SET_PSCI_LIB_ARGS_V1(_p, _entry) do { \
51 SET_PARAM_HEAD(_p, PARAM_PSCI_LIB_ARGS, VERSION_1, 0); \
52 (_p)->mailbox_ep = (_entry); \
53 } while (0)
54
55/* Helper macro to define the psci_lib_args_t statically */
56#define DEFINE_STATIC_PSCI_LIB_ARGS_V1(_name, _entry) \
57 static const psci_lib_args_t (_name) = { \
58 .h.type = (uint8_t)PARAM_PSCI_LIB_ARGS, \
59 .h.version = (uint8_t)VERSION_1, \
60 .h.size = (uint16_t)sizeof(_name), \
Antonio Nino Diaz78a95a62018-07-17 15:10:08 +010061 .h.attr = 0U, \
Soby Mathewb911cc72017-02-13 12:46:28 +000062 .mailbox_ep = (_entry) \
63 }
64
65/* Helper macro to verify the pointer to psci_lib_args_t structure */
Antonio Nino Diaz78a95a62018-07-17 15:10:08 +010066#define VERIFY_PSCI_LIB_ARGS_V1(_p) (((_p) != NULL) \
Soby Mathewb911cc72017-02-13 12:46:28 +000067 && ((_p)->h.type == PARAM_PSCI_LIB_ARGS) \
68 && ((_p)->h.version == VERSION_1) \
69 && ((_p)->h.size == sizeof(*(_p))) \
70 && ((_p)->h.attr == 0) \
Antonio Nino Diaz78a95a62018-07-17 15:10:08 +010071 && ((_p)->mailbox_ep != NULL))
Soby Mathewb911cc72017-02-13 12:46:28 +000072
73/******************************************************************************
74 * PSCI Library Interfaces
75 *****************************************************************************/
76u_register_t psci_smc_handler(uint32_t smc_fid,
77 u_register_t x1,
78 u_register_t x2,
79 u_register_t x3,
80 u_register_t x4,
81 void *cookie,
82 void *handle,
83 u_register_t flags);
84int psci_setup(const psci_lib_args_t *lib_args);
Jeenu Viswambharanbc1a9292017-02-16 14:55:15 +000085int psci_secondaries_brought_up(void);
Soby Mathewb911cc72017-02-13 12:46:28 +000086void psci_warmboot_entrypoint(void);
87void psci_register_spd_pm_hook(const spd_pm_ops_t *pm);
88void psci_prepare_next_non_secure_ctx(
89 entry_point_info_t *next_image_info);
90#endif /* __ASSEMBLY__ */
91
Antonio Nino Diaz3ce0e772018-07-16 17:32:37 +010092#endif /* PSCI_LIB_H */