1 /*
2  * Copyright (c) 2020-2024, 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/auth/crypto_mod.h>
15 #include <drivers/measured_boot/event_log/tcg.h>
16 
17 /*
18  * Set Event Log debug level to one of:
19  *
20  * LOG_LEVEL_ERROR
21  * LOG_LEVEL_INFO
22  * LOG_LEVEL_WARNING
23  * LOG_LEVEL_VERBOSE
24  */
25 #if EVENT_LOG_LEVEL   == LOG_LEVEL_ERROR
26 #define	LOG_EVENT	ERROR
27 #elif EVENT_LOG_LEVEL == LOG_LEVEL_NOTICE
28 #define	LOG_EVENT	NOTICE
29 #elif EVENT_LOG_LEVEL == LOG_LEVEL_WARNING
30 #define	LOG_EVENT	WARN
31 #elif EVENT_LOG_LEVEL == LOG_LEVEL_INFO
32 #define	LOG_EVENT	INFO
33 #elif EVENT_LOG_LEVEL == LOG_LEVEL_VERBOSE
34 #define	LOG_EVENT	VERBOSE
35 #else
36 #error "Not supported EVENT_LOG_LEVEL"
37 #endif
38 
39 /* Number of hashing algorithms supported */
40 #define HASH_ALG_COUNT		1U
41 
42 #define EVLOG_INVALID_ID	UINT32_MAX
43 
44 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member)
45 
46 typedef struct {
47 	unsigned int id;
48 	const char *name;
49 	unsigned int pcr;
50 } event_log_metadata_t;
51 
52 #define	ID_EVENT_SIZE	(sizeof(id_event_headers_t) + \
53 			(sizeof(id_event_algorithm_size_t) * HASH_ALG_COUNT) + \
54 			sizeof(id_event_struct_data_t))
55 
56 #define	LOC_EVENT_SIZE	(sizeof(event2_header_t) + \
57 			sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \
58 			sizeof(event2_data_t) + \
59 			sizeof(startup_locality_event_t))
60 
61 #define	LOG_MIN_SIZE	(ID_EVENT_SIZE + LOC_EVENT_SIZE)
62 
63 #define EVENT2_HDR_SIZE	(sizeof(event2_header_t) + \
64 			sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \
65 			sizeof(event2_data_t))
66 
67 /* Functions' declarations */
68 void event_log_buf_init(uint8_t *event_log_start, uint8_t *event_log_finish);
69 void event_log_init(uint8_t *event_log_start, uint8_t *event_log_finish);
70 void event_log_write_specid_event(void);
71 void event_log_write_header(void);
72 void dump_event_log(uint8_t *log_addr, size_t log_size);
73 int event_log_measure(uintptr_t data_base, uint32_t data_size,
74 		      unsigned char hash_data[CRYPTO_MD_MAX_SIZE]);
75 void event_log_record(const uint8_t *hash, uint32_t event_type,
76 		      const event_log_metadata_t *metadata_ptr);
77 int event_log_measure_and_record(uintptr_t data_base, uint32_t data_size,
78 				 uint32_t data_id,
79 				 const event_log_metadata_t *metadata_ptr);
80 size_t event_log_get_cur_size(uint8_t *event_log_start);
81 
82 #endif /* EVENT_LOG_H */
83