1 /* 2 * Copyright (c) 2023, Arm Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef CPU_OPS_H 8 #define CPU_OPS_H 9 10 #include <arch.h> 11 12 #define CPU_IMPL_PN_MASK (MIDR_IMPL_MASK << MIDR_IMPL_SHIFT) | \ 13 (MIDR_PN_MASK << MIDR_PN_SHIFT) 14 15 /* Hardcode to keep compatible with assembly. sizeof(uintptr_t) */ 16 #if __aarch64__ 17 #define CPU_WORD_SIZE 8 18 #else 19 #define CPU_WORD_SIZE 4 20 #endif /* __aarch64__ */ 21 22 /* The number of CPU operations allowed */ 23 #define CPU_MAX_PWR_DWN_OPS 2 24 /* Special constant to specify that CPU has no reset function */ 25 #define CPU_NO_RESET_FUNC 0 26 27 #if __aarch64__ 28 #define CPU_NO_EXTRA1_FUNC 0 29 #define CPU_NO_EXTRA2_FUNC 0 30 #define CPU_NO_EXTRA3_FUNC 0 31 #endif /* __aarch64__ */ 32 33 34 /* 35 * Define the sizes of the fields in the cpu_ops structure. Word size is set per 36 * Aarch so keep these definitions the same and each can include whatever it 37 * needs. 38 */ 39 #define CPU_MIDR_SIZE CPU_WORD_SIZE 40 #ifdef IMAGE_AT_EL3 41 #define CPU_RESET_FUNC_SIZE CPU_WORD_SIZE 42 #else 43 #define CPU_RESET_FUNC_SIZE 0 44 #endif /* IMAGE_AT_EL3 */ 45 #define CPU_EXTRA1_FUNC_SIZE CPU_WORD_SIZE 46 #define CPU_EXTRA2_FUNC_SIZE CPU_WORD_SIZE 47 #define CPU_EXTRA3_FUNC_SIZE CPU_WORD_SIZE 48 #define CPU_E_HANDLER_FUNC_SIZE CPU_WORD_SIZE 49 /* The power down core and cluster is needed only in BL31 and BL32 */ 50 #if defined(IMAGE_BL31) || defined(IMAGE_BL32) 51 #define CPU_PWR_DWN_OPS_SIZE CPU_WORD_SIZE * CPU_MAX_PWR_DWN_OPS 52 #else 53 #define CPU_PWR_DWN_OPS_SIZE 0 54 #endif /* defined(IMAGE_BL31) || defined(IMAGE_BL32) */ 55 56 #define CPU_ERRATA_LIST_START_SIZE CPU_WORD_SIZE 57 #define CPU_ERRATA_LIST_END_SIZE CPU_WORD_SIZE 58 /* Fields required to print errata status */ 59 #if REPORT_ERRATA 60 #define CPU_ERRATA_FUNC_SIZE CPU_WORD_SIZE 61 #define CPU_CPU_STR_SIZE CPU_WORD_SIZE 62 /* BL1 doesn't require mutual exclusion and printed flag. */ 63 #if defined(IMAGE_BL31) || defined(IMAGE_BL32) 64 #define CPU_ERRATA_LOCK_SIZE CPU_WORD_SIZE 65 #define CPU_ERRATA_PRINTED_SIZE CPU_WORD_SIZE 66 #else 67 #define CPU_ERRATA_LOCK_SIZE 0 68 #define CPU_ERRATA_PRINTED_SIZE 0 69 #endif /* defined(IMAGE_BL31) || defined(IMAGE_BL32) */ 70 #else 71 #define CPU_ERRATA_FUNC_SIZE 0 72 #define CPU_CPU_STR_SIZE 0 73 #define CPU_ERRATA_LOCK_SIZE 0 74 #define CPU_ERRATA_PRINTED_SIZE 0 75 #endif /* REPORT_ERRATA */ 76 77 #if defined(IMAGE_BL31) && CRASH_REPORTING 78 #define CPU_REG_DUMP_SIZE CPU_WORD_SIZE 79 #else 80 #define CPU_REG_DUMP_SIZE 0 81 #endif /* defined(IMAGE_BL31) && CRASH_REPORTING */ 82 83 84 /* 85 * Define the offsets to the fields in cpu_ops structure. Every offset is 86 * defined based on the offset and size of the previous field. 87 */ 88 #define CPU_MIDR 0 89 #define CPU_RESET_FUNC CPU_MIDR + CPU_MIDR_SIZE 90 #if __aarch64__ 91 #define CPU_EXTRA1_FUNC CPU_RESET_FUNC + CPU_RESET_FUNC_SIZE 92 #define CPU_EXTRA2_FUNC CPU_EXTRA1_FUNC + CPU_EXTRA1_FUNC_SIZE 93 #define CPU_EXTRA3_FUNC CPU_EXTRA2_FUNC + CPU_EXTRA2_FUNC_SIZE 94 #define CPU_E_HANDLER_FUNC CPU_EXTRA3_FUNC + CPU_EXTRA3_FUNC_SIZE 95 #define CPU_PWR_DWN_OPS CPU_E_HANDLER_FUNC + CPU_E_HANDLER_FUNC_SIZE 96 #else 97 #define CPU_PWR_DWN_OPS CPU_RESET_FUNC + CPU_RESET_FUNC_SIZE 98 #endif /* __aarch64__ */ 99 #define CPU_ERRATA_LIST_START CPU_PWR_DWN_OPS + CPU_PWR_DWN_OPS_SIZE 100 #define CPU_ERRATA_LIST_END CPU_ERRATA_LIST_START + CPU_ERRATA_LIST_START_SIZE 101 #define CPU_ERRATA_FUNC CPU_ERRATA_LIST_END + CPU_ERRATA_LIST_END_SIZE 102 #define CPU_CPU_STR CPU_ERRATA_FUNC + CPU_ERRATA_FUNC_SIZE 103 #define CPU_ERRATA_LOCK CPU_CPU_STR + CPU_CPU_STR_SIZE 104 #define CPU_ERRATA_PRINTED CPU_ERRATA_LOCK + CPU_ERRATA_LOCK_SIZE 105 #if __aarch64__ 106 #define CPU_REG_DUMP CPU_ERRATA_PRINTED + CPU_ERRATA_PRINTED_SIZE 107 #define CPU_OPS_SIZE CPU_REG_DUMP + CPU_REG_DUMP_SIZE 108 #else 109 #define CPU_OPS_SIZE CPU_ERRATA_PRINTED + CPU_ERRATA_PRINTED_SIZE 110 #endif /* __aarch64__ */ 111 112 #ifndef __ASSEMBLER__ 113 #include <lib/cassert.h> 114 #include <lib/spinlock.h> 115 116 struct cpu_ops { 117 unsigned long midr; 118 #ifdef IMAGE_AT_EL3 119 void (*reset_func)(void); 120 #endif /* IMAGE_AT_EL3 */ 121 #if __aarch64__ 122 void (*extra1_func)(void); 123 void (*extra2_func)(void); 124 void (*extra3_func)(void); 125 void (*e_handler_func)(long es); 126 #endif /* __aarch64__ */ 127 #if (defined(IMAGE_BL31) || defined(IMAGE_BL32)) && CPU_MAX_PWR_DWN_OPS 128 void (*pwr_dwn_ops[CPU_MAX_PWR_DWN_OPS])(void); 129 #endif /* (defined(IMAGE_BL31) || defined(IMAGE_BL32)) && CPU_MAX_PWR_DWN_OPS */ 130 void *errata_list_start; 131 void *errata_list_end; 132 #if REPORT_ERRATA 133 void (*errata_func)(void); 134 char *cpu_str; 135 #if defined(IMAGE_BL31) || defined(IMAGE_BL32) 136 spinlock_t *errata_lock; 137 unsigned int *errata_reported; 138 #endif /* defined(IMAGE_BL31) || defined(IMAGE_BL32) */ 139 #endif /* REPORT_ERRATA */ 140 #if defined(IMAGE_BL31) && CRASH_REPORTING 141 void (*reg_dump)(void); 142 #endif /* defined(IMAGE_BL31) && CRASH_REPORTING */ 143 } __packed; 144 145 CASSERT(sizeof(struct cpu_ops) == CPU_OPS_SIZE, 146 assert_cpu_ops_asm_c_different_sizes); 147 148 long cpu_get_rev_var(void); 149 void *get_cpu_ops_ptr(void); 150 151 #endif /* __ASSEMBLER__ */ 152 #endif /* CPU_OPS_H */ 153