blob: 7a81e9cbcdd43909e21f6c501833e72365bd392e [file] [log] [blame]
Max Shvetsov103e0562021-02-04 16:58:31 +00001/*
J-Alves32ccd2b2021-12-14 14:59:51 +00002 * Copyright (c) 2021-2022, Arm Limited. All rights reserved.
Max Shvetsov103e0562021-02-04 16:58:31 +00003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef SPM_COMMON_H
8#define SPM_COMMON_H
9
J-Alves79c08f12021-10-27 15:15:16 +010010#include <plat/common/platform.h>
11
Max Shvetsov103e0562021-02-04 16:58:31 +000012#include <stdint.h>
13#include <string.h>
14
J-Alves79c08f12021-10-27 15:15:16 +010015#include <ffa_helpers.h>
16
Olivier Deprez569be402022-07-08 10:24:39 +020017#include <lib/extensions/sve.h>
18
Max Shvetsov103e0562021-02-04 16:58:31 +000019/* Hypervisor ID at physical FFA instance */
20#define HYP_ID (0)
Daniel Boulby198deda2021-03-03 11:35:25 +000021/* SPMC ID */
22#define SPMC_ID U(0x8000)
Max Shvetsov103e0562021-02-04 16:58:31 +000023
Olivier Deprez6967c242021-04-09 09:24:08 +020024/* ID for the first Secure Partition. */
25#define SPM_VM_ID_FIRST SP_ID(1)
26
Manish Pandeyf7aafef2021-03-03 11:31:47 +000027/* INTID for the managed exit virtual interrupt. */
28#define MANAGED_EXIT_INTERRUPT_ID U(4)
29
J-Alves4439ece2021-11-05 11:52:54 +000030/* INTID for the notification pending interrupt. */
31#define NOTIFICATION_PENDING_INTERRUPT_INTID 5
32
Manish Pandey58971b62020-09-21 21:10:38 +010033/** IRQ/FIQ pin used for signaling a virtual interrupt. */
34enum interrupt_pin {
35 INTERRUPT_TYPE_IRQ,
36 INTERRUPT_TYPE_FIQ,
37};
38
Max Shvetsov103e0562021-02-04 16:58:31 +000039/*
40 * The bit 15 of the FF-A ID indicates whether the partition is executing
41 * in the normal world, in case it is a Virtual Machine (VM); or in the
42 * secure world, in case it is a Secure Partition (SP).
43 *
44 * If bit 15 is set partition is an SP; if bit 15 is clear partition is
45 * a VM.
46 */
47#define SP_ID_MASK U(1 << 15)
48#define SP_ID(x) ((x) | SP_ID_MASK)
J-Alvesd5d87152021-10-29 11:48:37 +010049#define VM_ID(x) (x & ~SP_ID_MASK)
Max Shvetsov103e0562021-02-04 16:58:31 +000050#define IS_SP_ID(x) ((x & SP_ID_MASK) != 0U)
51
Daniel Boulby4a2888a2022-05-31 16:07:36 +010052#define NULL_UUID (const struct ffa_uuid) { .uuid = {0} }
53
Max Shvetsov103e0562021-02-04 16:58:31 +000054struct ffa_features_test {
55 const char *test_name;
56 unsigned int feature;
57 unsigned int expected_ret;
Daniel Boulby198deda2021-03-03 11:35:25 +000058 unsigned int version_added;
Max Shvetsov103e0562021-02-04 16:58:31 +000059};
Max Shvetsov103e0562021-02-04 16:58:31 +000060
61struct mailbox_buffers {
62 void *recv;
63 void *send;
64};
65
66#define CONFIGURE_MAILBOX(mb_name, buffers_size) \
67 do { \
68 /* Declare RX/TX buffers at virtual FF-A instance */ \
69 static struct { \
70 uint8_t rx[buffers_size]; \
71 uint8_t tx[buffers_size]; \
72 } __aligned(PAGE_SIZE) mb_buffers; \
73 mb_name.recv = (void *)mb_buffers.rx; \
74 mb_name.send = (void *)mb_buffers.tx; \
75 } while (false)
76
77#define CONFIGURE_AND_MAP_MAILBOX(mb_name, buffers_size, smc_ret) \
78 do { \
79 CONFIGURE_MAILBOX(mb_name, buffers_size); \
80 smc_ret = ffa_rxtx_map( \
81 (uintptr_t)mb_name.send, \
J-Alves43887ec2021-02-22 12:21:44 +000082 (uintptr_t)mb_name.recv, \
Max Shvetsov103e0562021-02-04 16:58:31 +000083 buffers_size / PAGE_SIZE \
84 ); \
85 } while (false)
86
J-Alves43887ec2021-02-22 12:21:44 +000087/**
88 * Helpers to evaluate returns of FF-A calls.
89 */
Daniel Boulbyce386b12022-03-29 18:36:36 +010090bool is_ffa_call_error(struct ffa_value val);
91bool is_expected_ffa_error(struct ffa_value ret, int32_t error_code);
92bool is_ffa_direct_response(struct ffa_value ret);
93bool is_expected_ffa_return(struct ffa_value ret, uint32_t func_id);
94bool is_expected_cactus_response(struct ffa_value ret, uint32_t expected_resp,
J-Alves227065a2021-03-11 10:01:36 +000095 uint32_t arg);
Daniel Boulbyce386b12022-03-29 18:36:36 +010096void dump_ffa_value(struct ffa_value ret);
J-Alves43887ec2021-02-22 12:21:44 +000097
Olivier Deprez881b1992020-12-01 15:34:34 +010098/*
Olivier Deprez569be402022-07-08 10:24:39 +020099 * Max. vector length:
Olivier Deprez881b1992020-12-01 15:34:34 +0100100 * SIMD: 128 bits = 16 bytes
101 */
102#define SIMD_VECTOR_LEN_BYTES 16
Max Shvetsov959be332021-03-16 14:18:13 +0000103
Olivier Deprez881b1992020-12-01 15:34:34 +0100104#define SIMD_NUM_VECTORS 32
Olivier Deprez569be402022-07-08 10:24:39 +0200105
Olivier Deprez881b1992020-12-01 15:34:34 +0100106typedef uint8_t simd_vector_t[SIMD_VECTOR_LEN_BYTES];
107
108/*
Max Shvetsov959be332021-03-16 14:18:13 +0000109 * Fills SIMD/SVE registers with the content of the container v.
110 * Number of vectors is assumed to be SIMD/SVE_NUM_VECTORS.
Olivier Deprez881b1992020-12-01 15:34:34 +0100111 */
112void fill_simd_vector_regs(const simd_vector_t v[SIMD_NUM_VECTORS]);
Max Shvetsov959be332021-03-16 14:18:13 +0000113void fill_sve_vector_regs(const sve_vector_t v[SVE_NUM_VECTORS]);
Olivier Deprez881b1992020-12-01 15:34:34 +0100114
115/*
Max Shvetsov959be332021-03-16 14:18:13 +0000116 * Reads contents of SIMD/SVE registers into the provided container v.
117 * Number of vectors is assumed to be SIMD/SVE_NUM_VECTORS.
Olivier Deprez881b1992020-12-01 15:34:34 +0100118 */
119void read_simd_vector_regs(simd_vector_t v[SIMD_NUM_VECTORS]);
Max Shvetsov959be332021-03-16 14:18:13 +0000120void read_sve_vector_regs(sve_vector_t v[SVE_NUM_VECTORS]);
Olivier Deprez881b1992020-12-01 15:34:34 +0100121
Max Shvetsov103e0562021-02-04 16:58:31 +0000122bool check_spmc_execution_level(void);
123
Olivier Deprez881b1992020-12-01 15:34:34 +0100124unsigned int get_ffa_feature_test_target(const struct ffa_features_test **test_target);
125
J-Alvesbe1519a2021-02-19 14:33:54 +0000126/**
127 * Helper to conduct a memory retrieve. This is to be called by the receiver
128 * of a memory share operation.
129 */
130bool memory_retrieve(struct mailbox_buffers *mb,
131 struct ffa_memory_region **retrieved, uint64_t handle,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000132 ffa_id_t sender, ffa_id_t receiver,
Olivier Deprez20b9b172021-04-22 14:39:54 +0200133 ffa_memory_region_flags_t flags);
J-Alvesbe1519a2021-02-19 14:33:54 +0000134
135/**
136 * Helper to conduct a memory relinquish. The caller is usually the receiver,
137 * after it being done with the memory shared, identified by the 'handle'.
138 */
139bool memory_relinquish(struct ffa_mem_relinquish *m, uint64_t handle,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000140 ffa_id_t id);
J-Alvesbe1519a2021-02-19 14:33:54 +0000141
142ffa_memory_handle_t memory_send(
143 struct ffa_memory_region *memory_region, uint32_t mem_func,
Daniel Boulbyce386b12022-03-29 18:36:36 +0100144 uint32_t fragment_length, uint32_t total_length, struct ffa_value *ret);
J-Alvesbe1519a2021-02-19 14:33:54 +0000145
146ffa_memory_handle_t memory_init_and_send(
147 struct ffa_memory_region *memory_region, size_t memory_region_max_size,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000148 ffa_id_t sender, ffa_id_t receiver,
J-Alvesbe1519a2021-02-19 14:33:54 +0000149 const struct ffa_memory_region_constituent* constituents,
Daniel Boulbyce386b12022-03-29 18:36:36 +0100150 uint32_t constituents_count, uint32_t mem_func, struct ffa_value *ret);
J-Alvesbe1519a2021-02-19 14:33:54 +0000151
Max Shvetsov0b7d25f2021-03-05 13:46:42 +0000152bool ffa_partition_info_helper(struct mailbox_buffers *mb,
153 const struct ffa_uuid uuid,
154 const struct ffa_partition_info *expected,
155 const uint16_t expected_size);
156
Max Shvetsov103e0562021-02-04 16:58:31 +0000157#endif /* SPM_COMMON_H */