xref: /arm-trusted-firmware/docs/components/measured_boot/event_log.rst (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700SchasingluluDTB binding for Event Log properties
2*91f16700Schasinglulu====================================
3*91f16700Schasinglulu
4*91f16700SchasingluluThis document describes the device tree format of Event Log properties.
5*91f16700SchasingluluThese properties are not related to a specific platform and can be queried
6*91f16700Schasinglulufrom common code.
7*91f16700Schasinglulu
8*91f16700SchasingluluDynamic configuration for Event Log
9*91f16700Schasinglulu~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10*91f16700Schasinglulu
11*91f16700SchasingluluMeasured Boot driver expects a *tpm_event_log* node with the following field
12*91f16700Schasingluluin 'tb_fw_config', 'nt_fw_config' and 'tsp_fw_config' DTS files:
13*91f16700Schasinglulu
14*91f16700Schasinglulu- compatible [mandatory]
15*91f16700Schasinglulu   - value type: <string>
16*91f16700Schasinglulu   - Must be the string "arm,tpm_event_log".
17*91f16700Schasinglulu
18*91f16700SchasingluluThen a list of properties representing Event Log configuration, which
19*91f16700Schasinglulucan be used by Measured Boot driver. Each property is named according
20*91f16700Schasingluluto the information it contains:
21*91f16700Schasinglulu
22*91f16700Schasinglulu- tpm_event_log_sm_addr [fvp_nt_fw_config.dts with OP-TEE]
23*91f16700Schasinglulu    - value type: <u64>
24*91f16700Schasinglulu    - Event Log base address in secure memory.
25*91f16700Schasinglulu
26*91f16700SchasingluluNote. Currently OP-TEE does not support reading DTBs from Secure memory
27*91f16700Schasingluluand this property should be removed when this feature is supported.
28*91f16700Schasinglulu
29*91f16700Schasinglulu- tpm_event_log_addr [mandatory]
30*91f16700Schasinglulu    - value type: <u64>
31*91f16700Schasinglulu    - Event Log base address in non-secure memory.
32*91f16700Schasinglulu
33*91f16700Schasinglulu- tpm_event_log_size [mandatory]
34*91f16700Schasinglulu    - value type: <u32>
35*91f16700Schasinglulu    - Event Log size.
36*91f16700Schasinglulu
37*91f16700Schasinglulu- tpm_event_log_max_size [mandatory]
38*91f16700Schasinglulu    - value type: <u32>
39*91f16700Schasinglulu    - Event Log maximum size.
40*91f16700Schasinglulu
41*91f16700Schasinglulu--------------
42*91f16700Schasinglulu
43*91f16700Schasinglulu*Copyright (c) 2023, Arm Limited and Contributors. All rights reserved.*
44