blob: 07fecb66c849d4dd33379eab385d45acacc2598d [file] [log] [blame]
Achin Gupta86f23532019-10-11 15:41:16 +01001/*
Daniel Boulby9460a232021-12-09 11:20:13 +00002 * Copyright (c) 2019-2022, ARM Limited and Contributors. All rights reserved.
Achin Gupta86f23532019-10-11 15:41:16 +01003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef SPMD_PRIVATE_H
8#define SPMD_PRIVATE_H
9
10#include <context.h>
11
12/*******************************************************************************
13 * Constants that allow assembler code to preserve callee-saved registers of the
14 * C runtime context while performing a security state switch.
15 ******************************************************************************/
16#define SPMD_C_RT_CTX_X19 0x0
17#define SPMD_C_RT_CTX_X20 0x8
18#define SPMD_C_RT_CTX_X21 0x10
19#define SPMD_C_RT_CTX_X22 0x18
20#define SPMD_C_RT_CTX_X23 0x20
21#define SPMD_C_RT_CTX_X24 0x28
22#define SPMD_C_RT_CTX_X25 0x30
23#define SPMD_C_RT_CTX_X26 0x38
24#define SPMD_C_RT_CTX_X27 0x40
25#define SPMD_C_RT_CTX_X28 0x48
26#define SPMD_C_RT_CTX_X29 0x50
27#define SPMD_C_RT_CTX_X30 0x58
28
29#define SPMD_C_RT_CTX_SIZE 0x60
30#define SPMD_C_RT_CTX_ENTRIES (SPMD_C_RT_CTX_SIZE >> DWORD_SHIFT)
31
32#ifndef __ASSEMBLER__
Achin Gupta86f23532019-10-11 15:41:16 +010033#include <stdint.h>
Olivier Deprez9afca122019-10-28 09:15:52 +000034#include <lib/psci/psci_lib.h>
35#include <plat/common/platform.h>
36#include <services/ffa_svc.h>
Achin Gupta86f23532019-10-11 15:41:16 +010037
Achin Gupta86f23532019-10-11 15:41:16 +010038typedef enum spmc_state {
39 SPMC_STATE_RESET = 0,
Olivier Deprez7c016332019-10-28 09:03:13 +000040 SPMC_STATE_OFF,
41 SPMC_STATE_ON_PENDING,
42 SPMC_STATE_ON
Achin Gupta86f23532019-10-11 15:41:16 +010043} spmc_state_t;
44
45/*
46 * Data structure used by the SPM dispatcher (SPMD) in EL3 to track context of
47 * the SPM core (SPMC) at the next lower EL.
48 */
49typedef struct spmd_spm_core_context {
50 uint64_t c_rt_ctx;
51 cpu_context_t cpu_ctx;
52 spmc_state_t state;
Olivier Depreza664c492020-08-05 11:27:42 +020053 bool secure_interrupt_ongoing;
Achin Gupta86f23532019-10-11 15:41:16 +010054} spmd_spm_core_context_t;
55
56/*
J-Alves2672cde2020-05-07 18:42:25 +010057 * Reserve ID for NS physical FFA Endpoint.
Max Shvetsove79062e2020-03-12 15:16:40 +000058 */
Olivier Deprezebc34772020-04-16 16:59:21 +020059#define FFA_NS_ENDPOINT_ID U(0)
60
Daniel Boulby9460a232021-12-09 11:20:13 +000061/* Define SPMD target function IDs for framework messages to the SPMC */
Daniel Boulby9460a232021-12-09 11:20:13 +000062#define SPMD_FWK_MSG_FFA_VERSION_REQ U(0x8)
63#define SPMD_FWK_MSG_FFA_VERSION_RESP U(0x9)
64
65/* Function to build SPMD to SPMC message */
66void spmd_build_spmc_message(gp_regs_t *gpregs, uint8_t target,
67 unsigned long long message);
68
Olivier Deprez2bae35f2020-04-16 13:39:06 +020069/* Functions used to enter/exit SPMC synchronously */
Achin Gupta86f23532019-10-11 15:41:16 +010070uint64_t spmd_spm_core_sync_entry(spmd_spm_core_context_t *ctx);
71__dead2 void spmd_spm_core_sync_exit(uint64_t rc);
72
73/* Assembly helpers */
74uint64_t spmd_spm_core_enter(uint64_t *c_rt_ctx);
75void __dead2 spmd_spm_core_exit(uint64_t c_rt_ctx, uint64_t ret);
76
Olivier Deprez9afca122019-10-28 09:15:52 +000077/* SPMD SPD power management handlers */
78extern const spd_pm_ops_t spmd_pm;
79
Olivier Deprez87a9ee72019-10-28 08:52:45 +000080/* SPMC entry point information helper */
81entry_point_info_t *spmd_spmc_ep_info_get(void);
82
Olivier Deprezc7631a52020-03-23 09:53:06 +010083/* SPMC ID getter */
84uint16_t spmd_spmc_id_get(void);
85
Olivier Deprez73ef0dc2020-06-19 15:33:41 +020086/* SPMC context on CPU based on mpidr */
87spmd_spm_core_context_t *spmd_get_context_by_mpidr(uint64_t mpidr);
88
Olivier Deprez2bae35f2020-04-16 13:39:06 +020089/* SPMC context on current CPU get helper */
90spmd_spm_core_context_t *spmd_get_context(void);
91
Olivier Deprezeae45962021-01-19 15:06:47 +010092int spmd_pm_secondary_ep_register(uintptr_t entry_point);
Olivier Deprez33e44122020-04-16 17:54:27 +020093bool spmd_check_address_in_binary_image(uint64_t address);
94
Achin Gupta86f23532019-10-11 15:41:16 +010095#endif /* __ASSEMBLER__ */
96
97#endif /* SPMD_PRIVATE_H */