1 /*
2  * Copyright (c) 2022-2024 Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier:    BSD-3-Clause
5  *
6  */
7 #ifndef DRTM_MAIN_H
8 #define DRTM_MAIN_H
9 
10 #include <stdint.h>
11 
12 #include <assert.h>
13 #include <lib/smccc.h>
14 
15 #include "drtm_dma_prot.h"
16 
17 #define ALIGNED_UP(x, a) __extension__ ({ \
18 	__typeof__(a) _a = (a); \
19 	__typeof__(a) _one = 1; \
20 	assert(IS_POWER_OF_TWO(_a)); \
21 	((x) + (_a - _one)) & ~(_a - _one); \
22 })
23 
24 #define ALIGNED_DOWN(x, a) __extension__ ({ \
25 	__typeof__(a) _a = (a); \
26 	__typeof__(a) _one = 1; \
27 	assert(IS_POWER_OF_TWO(_a)); \
28 	(x) & ~(_a - _one); \
29 })
30 
31 #define DRTM_PAGE_SIZE		(4 * (1 << 10))
32 #define DRTM_PAGE_SIZE_STR	"4-KiB"
33 
34 #define DL_ARGS_GET_DMA_PROT_TYPE(a)    (((a)->features >> 3) & 0x7U)
35 #define DL_ARGS_GET_PCR_SCHEMA(a)	(((a)->features >> 1) & 0x3U)
36 #define DL_ARGS_GET_DLME_ENTRY_POINT(a)	\
37 		(((a)->dlme_paddr + (a)->dlme_img_off + (a)->dlme_img_ep_off))
38 
39 /*
40  * Range(Min/Max) of DRTM parameter structure versions supported
41  */
42 #define ARM_DRTM_PARAMS_MIN_VERSION	U(1)
43 #define ARM_DRTM_PARAMS_MAX_VERSION	U(1)
44 
45 enum drtm_dlme_el {
46 	DLME_AT_EL1 = MODE_EL1,
47 	DLME_AT_EL2 = MODE_EL2
48 };
49 
50 enum drtm_retc {
51 	SUCCESS = SMC_OK,
52 	NOT_SUPPORTED = SMC_UNK,
53 	INVALID_PARAMETERS = -2,
54 	DENIED = -3,
55 	NOT_FOUND = -4,
56 	INTERNAL_ERROR = -5,
57 	MEM_PROTECT_INVALID = -6,
58 	COPROCESSOR_ERROR = -7,
59 	OUT_OF_RESOURCE = -8,
60 	INVALID_DATA = -9,
61 	SECONDARY_PE_NOT_OFF = -10,
62 	ALREADY_CLOSED = -11,
63 	TPM_ERROR = -12
64 };
65 
66 typedef struct {
67 	uint64_t tpm_features;
68 	uint64_t minimum_memory_requirement;
69 	uint64_t dma_prot_features;
70 	uint64_t boot_pe_id;
71 	uint64_t tcb_hash_features;
72 } drtm_features_t;
73 
74 struct __packed drtm_dl_args_v1 {
75 	uint16_t version;	/* Must be 1. */
76 	uint8_t __res[2];
77 	uint32_t features;
78 	uint64_t dlme_paddr;
79 	uint64_t dlme_size;
80 	uint64_t dlme_img_off;
81 	uint64_t dlme_img_ep_off;
82 	uint64_t dlme_img_size;
83 	uint64_t dlme_data_off;
84 	uint64_t dce_nwd_paddr;
85 	uint64_t dce_nwd_size;
86 	drtm_dl_dma_prot_args_v1_t dma_prot_args;
87 } __aligned(__alignof(uint16_t /* First member's type, `uint16_t version' */));
88 
89 struct __packed dlme_data_header_v1 {
90 	uint16_t version;	/* Must be 1. */
91 	uint16_t this_hdr_size;
92 	uint8_t __res[4];
93 	uint64_t dlme_data_size;
94 	uint64_t dlme_prot_regions_size;
95 	uint64_t dlme_addr_map_size;
96 	uint64_t dlme_tpm_log_size;
97 	uint64_t dlme_tcb_hashes_table_size;
98 	uint64_t dlme_acpi_tables_region_size;
99 	uint64_t dlme_impdef_region_size;
100 } __aligned(__alignof(uint16_t /* First member's type, `uint16_t version'. */));
101 
102 typedef struct dlme_data_header_v1 struct_dlme_data_header;
103 
104 drtm_memory_region_descriptor_table_t *drtm_build_address_map(void);
105 uint64_t drtm_get_address_map_size(void);
106 
107 /*
108  * Version-independent type.  May be used to avoid excessive line of code
109  * changes when migrating to new struct versions.
110  */
111 typedef struct drtm_dl_args_v1 struct_drtm_dl_args;
112 
113 #endif /* DRTM_MAIN_H */
114