blob: ffe666ffc90b4955e1c8bfb895fce47bbd7c0d96 [file] [log] [blame]
Max Shvetsov103e0562021-02-04 16:58:31 +00001/*
2 * Copyright (c) 2021, Arm Limited. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef SPM_COMMON_H
8#define SPM_COMMON_H
9
10#include <ffa_helpers.h>
11#include <stdint.h>
12#include <string.h>
13
14/* Hypervisor ID at physical FFA instance */
15#define HYP_ID (0)
Daniel Boulby198deda2021-03-03 11:35:25 +000016/* SPMC ID */
17#define SPMC_ID U(0x8000)
Max Shvetsov103e0562021-02-04 16:58:31 +000018
Olivier Deprez6967c242021-04-09 09:24:08 +020019/* ID for the first Secure Partition. */
20#define SPM_VM_ID_FIRST SP_ID(1)
21
Manish Pandeyf7aafef2021-03-03 11:31:47 +000022/* INTID for the managed exit virtual interrupt. */
23#define MANAGED_EXIT_INTERRUPT_ID U(4)
24
Manish Pandey58971b62020-09-21 21:10:38 +010025/** IRQ/FIQ pin used for signaling a virtual interrupt. */
26enum interrupt_pin {
27 INTERRUPT_TYPE_IRQ,
28 INTERRUPT_TYPE_FIQ,
29};
30
Max Shvetsov103e0562021-02-04 16:58:31 +000031/*
32 * The bit 15 of the FF-A ID indicates whether the partition is executing
33 * in the normal world, in case it is a Virtual Machine (VM); or in the
34 * secure world, in case it is a Secure Partition (SP).
35 *
36 * If bit 15 is set partition is an SP; if bit 15 is clear partition is
37 * a VM.
38 */
39#define SP_ID_MASK U(1 << 15)
40#define SP_ID(x) ((x) | SP_ID_MASK)
41#define IS_SP_ID(x) ((x & SP_ID_MASK) != 0U)
42
43struct ffa_features_test {
44 const char *test_name;
45 unsigned int feature;
46 unsigned int expected_ret;
Daniel Boulby198deda2021-03-03 11:35:25 +000047 unsigned int version_added;
Max Shvetsov103e0562021-02-04 16:58:31 +000048};
Max Shvetsov103e0562021-02-04 16:58:31 +000049
50struct mailbox_buffers {
51 void *recv;
52 void *send;
53};
54
55#define CONFIGURE_MAILBOX(mb_name, buffers_size) \
56 do { \
57 /* Declare RX/TX buffers at virtual FF-A instance */ \
58 static struct { \
59 uint8_t rx[buffers_size]; \
60 uint8_t tx[buffers_size]; \
61 } __aligned(PAGE_SIZE) mb_buffers; \
62 mb_name.recv = (void *)mb_buffers.rx; \
63 mb_name.send = (void *)mb_buffers.tx; \
64 } while (false)
65
66#define CONFIGURE_AND_MAP_MAILBOX(mb_name, buffers_size, smc_ret) \
67 do { \
68 CONFIGURE_MAILBOX(mb_name, buffers_size); \
69 smc_ret = ffa_rxtx_map( \
70 (uintptr_t)mb_name.send, \
J-Alves43887ec2021-02-22 12:21:44 +000071 (uintptr_t)mb_name.recv, \
Max Shvetsov103e0562021-02-04 16:58:31 +000072 buffers_size / PAGE_SIZE \
73 ); \
74 } while (false)
75
J-Alves43887ec2021-02-22 12:21:44 +000076/**
77 * Helpers to evaluate returns of FF-A calls.
78 */
79bool is_ffa_call_error(smc_ret_values val);
80bool is_ffa_direct_response(smc_ret_values ret);
81bool is_expected_ffa_return(smc_ret_values ret, uint32_t func_id);
82
Olivier Deprez881b1992020-12-01 15:34:34 +010083/*
84 * Vector length:
85 * SIMD: 128 bits = 16 bytes
Max Shvetsov959be332021-03-16 14:18:13 +000086 * SVE: 512 bits = 64 bytes
Olivier Deprez881b1992020-12-01 15:34:34 +010087 */
88#define SIMD_VECTOR_LEN_BYTES 16
Max Shvetsov959be332021-03-16 14:18:13 +000089#define SVE_VECTOR_LEN_BYTES 64
90
Olivier Deprez881b1992020-12-01 15:34:34 +010091#define SIMD_NUM_VECTORS 32
Max Shvetsov959be332021-03-16 14:18:13 +000092#define SVE_NUM_VECTORS 32
Olivier Deprez881b1992020-12-01 15:34:34 +010093typedef uint8_t simd_vector_t[SIMD_VECTOR_LEN_BYTES];
Max Shvetsov959be332021-03-16 14:18:13 +000094typedef uint8_t sve_vector_t[SVE_VECTOR_LEN_BYTES];
Olivier Deprez881b1992020-12-01 15:34:34 +010095
96/*
Max Shvetsov959be332021-03-16 14:18:13 +000097 * Fills SIMD/SVE registers with the content of the container v.
98 * Number of vectors is assumed to be SIMD/SVE_NUM_VECTORS.
Olivier Deprez881b1992020-12-01 15:34:34 +010099 */
100void fill_simd_vector_regs(const simd_vector_t v[SIMD_NUM_VECTORS]);
Max Shvetsov959be332021-03-16 14:18:13 +0000101void fill_sve_vector_regs(const sve_vector_t v[SVE_NUM_VECTORS]);
Olivier Deprez881b1992020-12-01 15:34:34 +0100102
103/*
Max Shvetsov959be332021-03-16 14:18:13 +0000104 * Reads contents of SIMD/SVE registers into the provided container v.
105 * Number of vectors is assumed to be SIMD/SVE_NUM_VECTORS.
Olivier Deprez881b1992020-12-01 15:34:34 +0100106 */
107void read_simd_vector_regs(simd_vector_t v[SIMD_NUM_VECTORS]);
Max Shvetsov959be332021-03-16 14:18:13 +0000108void read_sve_vector_regs(sve_vector_t v[SVE_NUM_VECTORS]);
Olivier Deprez881b1992020-12-01 15:34:34 +0100109
Max Shvetsov103e0562021-02-04 16:58:31 +0000110bool check_spmc_execution_level(void);
111
Olivier Deprez881b1992020-12-01 15:34:34 +0100112unsigned int get_ffa_feature_test_target(const struct ffa_features_test **test_target);
113
J-Alvesbe1519a2021-02-19 14:33:54 +0000114/**
115 * Helper to conduct a memory retrieve. This is to be called by the receiver
116 * of a memory share operation.
117 */
118bool memory_retrieve(struct mailbox_buffers *mb,
119 struct ffa_memory_region **retrieved, uint64_t handle,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000120 ffa_id_t sender, ffa_id_t receiver,
J-Alvesbe1519a2021-02-19 14:33:54 +0000121 uint32_t mem_func);
122
123/**
124 * Helper to conduct a memory relinquish. The caller is usually the receiver,
125 * after it being done with the memory shared, identified by the 'handle'.
126 */
127bool memory_relinquish(struct ffa_mem_relinquish *m, uint64_t handle,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000128 ffa_id_t id);
J-Alvesbe1519a2021-02-19 14:33:54 +0000129
130ffa_memory_handle_t memory_send(
131 struct ffa_memory_region *memory_region, uint32_t mem_func,
132 uint32_t fragment_length, uint32_t total_length);
133
134ffa_memory_handle_t memory_init_and_send(
135 struct ffa_memory_region *memory_region, size_t memory_region_max_size,
Daniel Boulbye79d2072021-03-03 11:34:53 +0000136 ffa_id_t sender, ffa_id_t receiver,
J-Alvesbe1519a2021-02-19 14:33:54 +0000137 const struct ffa_memory_region_constituent* constituents,
138 uint32_t constituents_count, uint32_t mem_func);
139
Max Shvetsov0b7d25f2021-03-05 13:46:42 +0000140bool ffa_partition_info_helper(struct mailbox_buffers *mb,
141 const struct ffa_uuid uuid,
142 const struct ffa_partition_info *expected,
143 const uint16_t expected_size);
144
Max Shvetsov103e0562021-02-04 16:58:31 +0000145#endif /* SPM_COMMON_H */