xref: /rk3399_ARM-atf/include/lib/el3_runtime/cpu_data.h (revision 82cb2c1ad9897473743f08437d0a3995bed561b9)
1 /*
2  * Copyright (c) 2014-2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef __CPU_DATA_H__
8 #define __CPU_DATA_H__
9 
10 #ifdef AARCH32
11 
12 #if CRASH_REPORTING
13 #error "Crash reporting is not supported in AArch32"
14 #endif
15 #define CPU_DATA_CPU_OPS_PTR		0x0
16 
17 #else /* AARCH32 */
18 
19 /* Offsets for the cpu_data structure */
20 #define CPU_DATA_CRASH_BUF_OFFSET	0x18
21 /* need enough space in crash buffer to save 8 registers */
22 #define CPU_DATA_CRASH_BUF_SIZE		64
23 #define CPU_DATA_CPU_OPS_PTR		0x10
24 
25 #endif /* AARCH32 */
26 
27 #if CRASH_REPORTING
28 #define CPU_DATA_LOG2SIZE		7
29 #define CPU_DATA_CRASH_BUF_END		(CPU_DATA_CRASH_BUF_OFFSET + \
30 						CPU_DATA_CRASH_BUF_SIZE)
31 #else
32 #define CPU_DATA_LOG2SIZE		6
33 #define CPU_DATA_CRASH_BUF_END		CPU_DATA_CRASH_BUF_OFFSET
34 #endif
35 
36 #if ENABLE_RUNTIME_INSTRUMENTATION
37 /* Temporary space to store PMF timestamps from assembly code */
38 #define CPU_DATA_PMF_TS_COUNT		1
39 #define CPU_DATA_PMF_TS0_OFFSET		CPU_DATA_CRASH_BUF_END
40 #define CPU_DATA_PMF_TS0_IDX		0
41 #endif
42 
43 #ifndef __ASSEMBLY__
44 
45 #include <arch_helpers.h>
46 #include <cassert.h>
47 #include <platform_def.h>
48 #include <psci.h>
49 #include <stdint.h>
50 
51 /* Offsets for the cpu_data structure */
52 #define CPU_DATA_PSCI_LOCK_OFFSET	__builtin_offsetof\
53 		(cpu_data_t, psci_svc_cpu_data.pcpu_bakery_info)
54 
55 #if PLAT_PCPU_DATA_SIZE
56 #define CPU_DATA_PLAT_PCPU_OFFSET	__builtin_offsetof\
57 		(cpu_data_t, platform_cpu_data)
58 #endif
59 
60 /*******************************************************************************
61  * Function & variable prototypes
62  ******************************************************************************/
63 
64 /*******************************************************************************
65  * Cache of frequently used per-cpu data:
66  *   Pointers to non-secure and secure security state contexts
67  *   Address of the crash stack
68  * It is aligned to the cache line boundary to allow efficient concurrent
69  * manipulation of these pointers on different cpus
70  *
71  * TODO: Add other commonly used variables to this (tf_issues#90)
72  *
73  * The data structure and the _cpu_data accessors should not be used directly
74  * by components that have per-cpu members. The member access macros should be
75  * used for this.
76  ******************************************************************************/
77 typedef struct cpu_data {
78 #ifndef AARCH32
79 	void *cpu_context[2];
80 #endif
81 	uintptr_t cpu_ops_ptr;
82 #if CRASH_REPORTING
83 	u_register_t crash_buf[CPU_DATA_CRASH_BUF_SIZE >> 3];
84 #endif
85 #if ENABLE_RUNTIME_INSTRUMENTATION
86 	uint64_t cpu_data_pmf_ts[CPU_DATA_PMF_TS_COUNT];
87 #endif
88 	struct psci_cpu_data psci_svc_cpu_data;
89 #if PLAT_PCPU_DATA_SIZE
90 	uint8_t platform_cpu_data[PLAT_PCPU_DATA_SIZE];
91 #endif
92 } __aligned(CACHE_WRITEBACK_GRANULE) cpu_data_t;
93 
94 #if CRASH_REPORTING
95 /* verify assembler offsets match data structures */
96 CASSERT(CPU_DATA_CRASH_BUF_OFFSET == __builtin_offsetof
97 	(cpu_data_t, crash_buf),
98 	assert_cpu_data_crash_stack_offset_mismatch);
99 #endif
100 
101 CASSERT((1 << CPU_DATA_LOG2SIZE) == sizeof(cpu_data_t),
102 	assert_cpu_data_log2size_mismatch);
103 
104 CASSERT(CPU_DATA_CPU_OPS_PTR == __builtin_offsetof
105 		(cpu_data_t, cpu_ops_ptr),
106 		assert_cpu_data_cpu_ops_ptr_offset_mismatch);
107 
108 #if ENABLE_RUNTIME_INSTRUMENTATION
109 CASSERT(CPU_DATA_PMF_TS0_OFFSET == __builtin_offsetof
110 		(cpu_data_t, cpu_data_pmf_ts[0]),
111 		assert_cpu_data_pmf_ts0_offset_mismatch);
112 #endif
113 
114 struct cpu_data *_cpu_data_by_index(uint32_t cpu_index);
115 
116 #ifndef AARCH32
117 /* Return the cpu_data structure for the current CPU. */
118 static inline struct cpu_data *_cpu_data(void)
119 {
120 	return (cpu_data_t *)read_tpidr_el3();
121 }
122 #else
123 struct cpu_data *_cpu_data(void);
124 #endif
125 
126 /**************************************************************************
127  * APIs for initialising and accessing per-cpu data
128  *************************************************************************/
129 
130 void init_cpu_data_ptr(void);
131 void init_cpu_ops(void);
132 
133 #define get_cpu_data(_m)		   _cpu_data()->_m
134 #define set_cpu_data(_m, _v)		   _cpu_data()->_m = _v
135 #define get_cpu_data_by_index(_ix, _m)	   _cpu_data_by_index(_ix)->_m
136 #define set_cpu_data_by_index(_ix, _m, _v) _cpu_data_by_index(_ix)->_m = _v
137 
138 #define flush_cpu_data(_m)	   flush_dcache_range((uintptr_t)	  \
139 						      &(_cpu_data()->_m), \
140 						      sizeof(_cpu_data()->_m))
141 #define inv_cpu_data(_m)	   inv_dcache_range((uintptr_t)	  	  \
142 						      &(_cpu_data()->_m), \
143 						      sizeof(_cpu_data()->_m))
144 #define flush_cpu_data_by_index(_ix, _m)	\
145 				   flush_dcache_range((uintptr_t)	  \
146 					 &(_cpu_data_by_index(_ix)->_m),  \
147 					 sizeof(_cpu_data_by_index(_ix)->_m))
148 
149 
150 #endif /* __ASSEMBLY__ */
151 #endif /* __CPU_DATA_H__ */
152