mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2026-07-03 05:02:40 +00:00
Boyan Karatotev
1e8b535457
There are a few, functionally identical, ways to call the preprocessor on a non-C file, depending on the file. They differ in subtle, not entirely correct, ways - one is missing a dependency to the makefiles, another generates its .d inline, and the prints are different. That has resulted in platforms reimplementing this functionality, making the build brittle - a change to the overall build system doesn't propagate. So add a MAKE_PRE macro that will make a rule with all the bells and whistles to run the preprocessor on an arbitrary file. This patch converts the arm platforms' cot_descriptors DTS rules. The files are renamed to fit with the build rule and all extra flags are dropped. Those flags are only necessary for building BL2 c files, which will be passed to the output C file. Only the DTS flags are needed for the preprocessing step, which will be passed automatically. Change-Id: I3c1cc0ecf93b87d828f868214928c1bc9bcb5758 Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
120 lines
3.4 KiB
ReStructuredText
120 lines
3.4 KiB
ReStructuredText
TF-A CoT dt2c Tool
|
|
==================
|
|
|
|
This tool is used to automatically generate the corresponding c file for a
|
|
CoT DT file. Since currently TF-A support two type of CoT file: static c file
|
|
and CoT DT binding. This is error prone and hard to maintain, therefore this
|
|
tool can generate the c file for the platform that does not support CoT DT
|
|
binding, given the CoT DT file so the c file can be deprecated.
|
|
|
|
Prerequisites
|
|
~~~~~~~~~~~~~
|
|
|
|
#. Python (3.8 or later)
|
|
#. `Poetry`_ Python package manager
|
|
|
|
Getting Started
|
|
~~~~~~~~~~~~~~~
|
|
|
|
``cot-dt2c`` is installed by default with TF-A's poetry environment. All of it's
|
|
dependencies are listed in `tools/cot_dt2c/pyproject.toml`_.
|
|
|
|
``cot-dt2c`` requires a standard DTS file without #ifdef, macros, or other
|
|
preprocessor directives. Therefore, you need to provide a preprocessed device
|
|
tree source(DTS) as input to the tool.
|
|
|
|
#. Usage of the tool
|
|
|
|
.. code::
|
|
|
|
cot-dt2c
|
|
|
|
This command will output the following as usage for this command
|
|
|
|
.. code-block:: text
|
|
|
|
Usage: cot-dt2c [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Options:
|
|
--version Show the version and exit.
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
convert-to-c
|
|
validate-cot
|
|
visualize-cot
|
|
validate-dt
|
|
|
|
Convert CoT descriptors to C file
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To convert the CoT descriptors
|
|
|
|
This command is for the platform that does not use CoT DT parser,
|
|
which can generate the C file given the CoT descriptors. Before
|
|
the conversion to C file, the tool will do an implicit checks on
|
|
the validity of the CoT DT file.
|
|
|
|
.. code::
|
|
|
|
cot-dt2c convert-to-c [INPUT DTS PATH] [OUTPUT C PATH]
|
|
cot-dt2c convert-to-c fdts/tbbr_cot_descriptors.dts test.c
|
|
|
|
|
|
Validate CoT descriptors
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To validate the certificate
|
|
|
|
The tests folder in the tool folder provides some bad-example of the
|
|
DT file, and the tool will print out "not a valid CoT DT file" on console.
|
|
|
|
The command will check the format of the CoT file
|
|
|
|
#. The open bracket
|
|
#. The open ifdef macro
|
|
#. The missing mandatory attribute
|
|
#. Malformed DT file (cert missing parent, missing root certs. etc.)
|
|
|
|
Currently the validation is specifically for checking the CoT DT file
|
|
|
|
.. code::
|
|
|
|
cot-dt2c validate-cot [INPUT DTS PATH]
|
|
cot-dt2c validate-cot fdts/tbbr_cot_descriptors.dts
|
|
|
|
|
|
Visualize CoT descriptors
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This command create a HTML to visualize the relationship between
|
|
the certificates and the image of a CoT DT file.
|
|
|
|
.. code::
|
|
|
|
cot-dt2c visualize-cot [INPUT DTS PATH]
|
|
cot-dt2c visualize-cot fdts/tbbr_cot_descriptors.dts
|
|
|
|
|
|
Validate Other DT files
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The command will transform the dtsi/dts file into a more standard
|
|
dtsi/dts file inside /tmp folder that can be used as input to dt-schema
|
|
for further validation. Currently the tool will perform some basic validation
|
|
for the file (syntax) and dt-schema can be used for advance checks. dt-schema
|
|
is not installed along with the tool.
|
|
|
|
.. code::
|
|
|
|
cot-dt2c validate-dt [INPUT DTS PATH or INPUT DTS folder]
|
|
cot-dt2c validate-dt fdts/
|
|
cot-dt2c validate-dt fdts/fvp-bsae-gicv3.dtsi
|
|
|
|
--------------
|
|
|
|
*Copyright (c) 2024-2025, Arm Limited. All rights reserved.*
|
|
|
|
.. _tools/cot_dt2c/pyproject.toml: https://review.trustedfirmware.org/plugins/gitiles/TF-A/trusted-firmware-a/+/refs/heads/integration/tools/cot_dt2c/pyproject.toml
|
|
.. _Poetry: https://python-poetry.org/docs/
|