blob: ff6942e41861d6e22499ed20cbcbce98bbd703a3 [file] [log] [blame]
Achin Gupta86f23532019-10-11 15:41:16 +01001/*
Madhukar Pappireddy042043b2023-03-02 16:33:25 -06002 * Copyright (c) 2019-2023, 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
Claus Pedersen785e66c2022-09-12 22:42:58 +000010#include <common/bl_common.h>
Achin Gupta86f23532019-10-11 15:41:16 +010011#include <context.h>
12
13/*******************************************************************************
14 * Constants that allow assembler code to preserve callee-saved registers of the
15 * C runtime context while performing a security state switch.
16 ******************************************************************************/
17#define SPMD_C_RT_CTX_X19 0x0
18#define SPMD_C_RT_CTX_X20 0x8
19#define SPMD_C_RT_CTX_X21 0x10
20#define SPMD_C_RT_CTX_X22 0x18
21#define SPMD_C_RT_CTX_X23 0x20
22#define SPMD_C_RT_CTX_X24 0x28
23#define SPMD_C_RT_CTX_X25 0x30
24#define SPMD_C_RT_CTX_X26 0x38
25#define SPMD_C_RT_CTX_X27 0x40
26#define SPMD_C_RT_CTX_X28 0x48
27#define SPMD_C_RT_CTX_X29 0x50
28#define SPMD_C_RT_CTX_X30 0x58
29
30#define SPMD_C_RT_CTX_SIZE 0x60
31#define SPMD_C_RT_CTX_ENTRIES (SPMD_C_RT_CTX_SIZE >> DWORD_SHIFT)
32
33#ifndef __ASSEMBLER__
Achin Gupta86f23532019-10-11 15:41:16 +010034#include <stdint.h>
Olivier Deprez9afca122019-10-28 09:15:52 +000035#include <lib/psci/psci_lib.h>
36#include <plat/common/platform.h>
37#include <services/ffa_svc.h>
Achin Gupta86f23532019-10-11 15:41:16 +010038
Achin Gupta86f23532019-10-11 15:41:16 +010039typedef enum spmc_state {
40 SPMC_STATE_RESET = 0,
Olivier Deprez7c016332019-10-28 09:03:13 +000041 SPMC_STATE_OFF,
42 SPMC_STATE_ON_PENDING,
43 SPMC_STATE_ON
Achin Gupta86f23532019-10-11 15:41:16 +010044} spmc_state_t;
45
46/*
47 * Data structure used by the SPM dispatcher (SPMD) in EL3 to track context of
48 * the SPM core (SPMC) at the next lower EL.
49 */
50typedef struct spmd_spm_core_context {
51 uint64_t c_rt_ctx;
52 cpu_context_t cpu_ctx;
53 spmc_state_t state;
Olivier Depreza664c492020-08-05 11:27:42 +020054 bool secure_interrupt_ongoing;
Achin Gupta86f23532019-10-11 15:41:16 +010055} spmd_spm_core_context_t;
56
57/*
J-Alves2672cde2020-05-07 18:42:25 +010058 * Reserve ID for NS physical FFA Endpoint.
Max Shvetsove79062e2020-03-12 15:16:40 +000059 */
Olivier Deprezebc34772020-04-16 16:59:21 +020060#define FFA_NS_ENDPOINT_ID U(0)
61
Daniel Boulby9460a232021-12-09 11:20:13 +000062/* Define SPMD target function IDs for framework messages to the SPMC */
Daniel Boulby9460a232021-12-09 11:20:13 +000063#define SPMD_FWK_MSG_FFA_VERSION_REQ U(0x8)
64#define SPMD_FWK_MSG_FFA_VERSION_RESP U(0x9)
65
66/* Function to build SPMD to SPMC message */
67void spmd_build_spmc_message(gp_regs_t *gpregs, uint8_t target,
68 unsigned long long message);
69
Olivier Deprez2bae35f2020-04-16 13:39:06 +020070/* Functions used to enter/exit SPMC synchronously */
Achin Gupta86f23532019-10-11 15:41:16 +010071uint64_t spmd_spm_core_sync_entry(spmd_spm_core_context_t *ctx);
72__dead2 void spmd_spm_core_sync_exit(uint64_t rc);
73
74/* Assembly helpers */
75uint64_t spmd_spm_core_enter(uint64_t *c_rt_ctx);
76void __dead2 spmd_spm_core_exit(uint64_t c_rt_ctx, uint64_t ret);
77
Olivier Deprez9afca122019-10-28 09:15:52 +000078/* SPMD SPD power management handlers */
79extern const spd_pm_ops_t spmd_pm;
80
Olivier Deprez87a9ee72019-10-28 08:52:45 +000081/* SPMC entry point information helper */
82entry_point_info_t *spmd_spmc_ep_info_get(void);
83
Olivier Deprezc7631a52020-03-23 09:53:06 +010084/* SPMC ID getter */
85uint16_t spmd_spmc_id_get(void);
86
Olivier Deprez73ef0dc2020-06-19 15:33:41 +020087/* SPMC context on CPU based on mpidr */
88spmd_spm_core_context_t *spmd_get_context_by_mpidr(uint64_t mpidr);
89
Olivier Deprez2bae35f2020-04-16 13:39:06 +020090/* SPMC context on current CPU get helper */
91spmd_spm_core_context_t *spmd_get_context(void);
92
Olivier Deprezeae45962021-01-19 15:06:47 +010093int spmd_pm_secondary_ep_register(uintptr_t entry_point);
Olivier Deprez33e44122020-04-16 17:54:27 +020094bool spmd_check_address_in_binary_image(uint64_t address);
95
Madhukar Pappireddy042043b2023-03-02 16:33:25 -060096/*
97 * Platform hook in EL3 firmware to handle for Group0 secure interrupt.
98 * Return values:
99 * 0 = success
100 * otherwise it returns a negative value
101 */
102int plat_spmd_handle_group0_interrupt(uint32_t id);
Achin Gupta86f23532019-10-11 15:41:16 +0100103#endif /* __ASSEMBLER__ */
104
105#endif /* SPMD_PRIVATE_H */