scripts: Add HTML build report script

This change adds a script to generate an HTML report, invoked via
west, providing a consolidated and user-friendly view of various build
artifacts and metrics. This includes footprint information (as both
tables and plots), configuration tracing, sys init levels, an interactive
devicetree browser, and more.

Signed-off-by: Graham Roff <grahamr@qti.qualcomm.com>

Author: grahamroff-dev

.gitignore

@@ -17,6 +17,7 @@
 build*/
 !doc/build/
 !scripts/build
+!scripts/buildreport
 !share/sysbuild/build
 !tests/drivers/build_all
 !scripts/pylib/build_helpers

cmake/reports/CMakeLists.txt

@@ -156,3 +156,14 @@ if(NOT ${PAHOLE} STREQUAL PAHOLE-NOTFOUND)
     USES_TERMINAL
     )
 endif()
+
+add_custom_target(
+  buildreport
+  ${PYTHON_EXECUTABLE}
+  ${ZEPHYR_BASE}/scripts/buildreport/buildreport.py
+  --output ${CMAKE_BINARY_DIR}/report
+  --zephyr-base ${ZEPHYR_BASE}
+  ${CMAKE_BINARY_DIR}
+  DEPENDS ${logical_target_for_zephyr_elf}
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  )

cmake/usage/usage.cmake

@@ -33,6 +33,7 @@ message("  ram_plot     - Build and create RAM usage in a sunburst chart as a vi
 message("  rom_plot     - Build and create ROM usage in a sunburst chart as a visual representation")
 message("  traceconfig  - Generate a file in the build directory that details how each symbol got its final value")
 message("  footprint    - Create JSON RAM/ROM usage report in the build directory")
+message("  buildreport  - Generate an HTML report with footprint, traceconfig, initlevels, devicetree, and other details")
 message("  initlevels   - Display the initialization sequence")
 message("  boards       - Display supported boards")
 message("  shields      - Display supported shields")

doc/develop/optimizations/build_report.png

@@ -5,6 +5,8 @@ Optimization Tools
 
 The available optimization tools let you analyse :ref:`footprint_tools`
 and :ref:`data_structure_tools` using different build system targets.
+An :ref:`HTML report <build_report>` can be also be generated for a
+user-friendly view of build artifacts and metrics.
 
 .. _footprint_tools:
 
@@ -300,3 +302,37 @@ Pahole will generate something similar to the output below in the console::
     };
     ...
     ...
+
+.. _build_report:
+
+Build Report
+************
+
+An HTML build report can be generated that consolidates the various tool
+outputs and artifacts into one simple view. In addition to a basic summary of
+the build results, the following details are included:
+
+* Full memory reports (ram, rom) in drill-down table form as well as
+  :ref:`plots <footprint_tools_plot>` (as per the ``footprint``, ``ram_plot``,
+  and ``rom_plot`` build targets).
+* Kconfig symbol values and sources (as per the ``traceconfig`` build target).
+* Init-levels with function names, and report on any priority issues with sys-init
+  against devicetree (as per the ``initlevels`` build target).
+* Navigable devicetree view with property values and details from any bindings.
+
+Use the ``buildreport`` target with your board, as in the following example.
+If you are using :ref:`sysbuild`, see :ref:`sysbuild_dedicated_image_build_targets` instead.
+
+.. zephyr-app-commands::
+    :tool: all
+    :zephyr-app: samples/hello_world
+    :board: reel_board
+    :goals: buildreport
+
+This will generate the following output file::
+
+    build/report/index.html
+
+.. image:: build_report.png
+   :align: center
+   :alt: Build report

doc/develop/optimizations/tools.rst

@@ -343,6 +343,11 @@ def check_edt(self):
             for dep in dev.depends_on:
                 self._check_dep(dev_ord, dep.dep_ordinal)
 
+    @property
+    def initlevels(self):
+        """Get the dictionary of initlevels."""
+        return self._obj.initlevels
+
     def print_initlevels(self):
         for level, calls in self._obj.initlevels.items():
             print(level)