1 /* 2 * Copyright (c) 2020-2022, Arm Limited. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef EVENT_LOG_H 8 #define EVENT_LOG_H 9 10 #include <stdint.h> 11 12 #include <common/debug.h> 13 #include <common/tbbr/tbbr_img_def.h> 14 #include <drivers/measured_boot/event_log/tcg.h> 15 16 /* 17 * Set Event Log debug level to one of: 18 * 19 * LOG_LEVEL_ERROR 20 * LOG_LEVEL_INFO 21 * LOG_LEVEL_WARNING 22 * LOG_LEVEL_VERBOSE 23 */ 24 #if EVENT_LOG_LEVEL == LOG_LEVEL_ERROR 25 #define LOG_EVENT ERROR 26 #elif EVENT_LOG_LEVEL == LOG_LEVEL_NOTICE 27 #define LOG_EVENT NOTICE 28 #elif EVENT_LOG_LEVEL == LOG_LEVEL_WARNING 29 #define LOG_EVENT WARN 30 #elif EVENT_LOG_LEVEL == LOG_LEVEL_INFO 31 #define LOG_EVENT INFO 32 #elif EVENT_LOG_LEVEL == LOG_LEVEL_VERBOSE 33 #define LOG_EVENT VERBOSE 34 #else 35 #error "Not supported EVENT_LOG_LEVEL" 36 #endif 37 38 /* Number of hashing algorithms supported */ 39 #define HASH_ALG_COUNT 1U 40 41 #define EVLOG_INVALID_ID UINT32_MAX 42 43 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member) 44 45 /* 46 * Each event log entry has some metadata (i.e. a string) that identifies 47 * what is measured.These macros define these strings. 48 * Note that these strings follow the standardization recommendations 49 * defined in the Arm Server Base Security Guide (a.k.a. SBSG, Arm DEN 0086), 50 * where applicable. They should not be changed in the code. 51 * Where the SBSG does not make recommendations, we are free to choose any 52 * naming convention. 53 * The key thing is to choose meaningful strings so that when the TPM event 54 * log is used in attestation, the different components can be identified. 55 */ 56 #define EVLOG_BL2_STRING "BL_2" 57 #define EVLOG_BL31_STRING "SECURE_RT_EL3" 58 #if defined(SPD_opteed) 59 #define EVLOG_BL32_STRING "SECURE_RT_EL1_OPTEE" 60 #elif defined(SPD_tspd) 61 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TSPD" 62 #elif defined(SPD_tlkd) 63 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TLKD" 64 #elif defined(SPD_trusty) 65 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TRUSTY" 66 #else 67 #define EVLOG_BL32_STRING "SECURE_RT_EL1_UNKNOWN" 68 #endif 69 #define EVLOG_BL32_EXTRA1_STRING "SECURE_RT_EL1_OPTEE_EXTRA1" 70 #define EVLOG_BL32_EXTRA2_STRING "SECURE_RT_EL1_OPTEE_EXTRA2" 71 #define EVLOG_BL33_STRING "BL_33" 72 #define EVLOG_FW_CONFIG_STRING "FW_CONFIG" 73 #define EVLOG_HW_CONFIG_STRING "HW_CONFIG" 74 #define EVLOG_NT_FW_CONFIG_STRING "NT_FW_CONFIG" 75 #define EVLOG_SCP_BL2_STRING "SYS_CTRL_2" 76 #define EVLOG_SOC_FW_CONFIG_STRING "SOC_FW_CONFIG" 77 #define EVLOG_STM32_STRING "STM32" 78 #define EVLOG_TB_FW_CONFIG_STRING "TB_FW_CONFIG" 79 #define EVLOG_TOS_FW_CONFIG_STRING "TOS_FW_CONFIG" 80 #define EVLOG_RMM_STRING "RMM" 81 #define EVLOG_SP1_STRING "SP1" 82 #define EVLOG_SP2_STRING "SP2" 83 #define EVLOG_SP3_STRING "SP3" 84 #define EVLOG_SP4_STRING "SP4" 85 #define EVLOG_SP5_STRING "SP5" 86 #define EVLOG_SP6_STRING "SP6" 87 #define EVLOG_SP7_STRING "SP7" 88 #define EVLOG_SP8_STRING "SP8" 89 90 typedef struct { 91 unsigned int id; 92 const char *name; 93 unsigned int pcr; 94 } event_log_metadata_t; 95 96 #define ID_EVENT_SIZE (sizeof(id_event_headers_t) + \ 97 (sizeof(id_event_algorithm_size_t) * HASH_ALG_COUNT) + \ 98 sizeof(id_event_struct_data_t)) 99 100 #define LOC_EVENT_SIZE (sizeof(event2_header_t) + \ 101 sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \ 102 sizeof(event2_data_t) + \ 103 sizeof(startup_locality_event_t)) 104 105 #define LOG_MIN_SIZE (ID_EVENT_SIZE + LOC_EVENT_SIZE) 106 107 #define EVENT2_HDR_SIZE (sizeof(event2_header_t) + \ 108 sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \ 109 sizeof(event2_data_t)) 110 111 /* Functions' declarations */ 112 void event_log_init(uint8_t *event_log_start, uint8_t *event_log_finish); 113 void event_log_write_header(void); 114 void dump_event_log(uint8_t *log_addr, size_t log_size); 115 const event_log_metadata_t *plat_event_log_get_metadata(void); 116 int event_log_measure_and_record(uintptr_t data_base, uint32_t data_size, 117 uint32_t data_id); 118 size_t event_log_get_cur_size(uint8_t *event_log_start); 119 120 #endif /* EVENT_LOG_H */ 121
