doc: ti: k3: Add TIFS Stub documentation

* Add documentation to briefly explain the role of TIFS Stub in relevant
  K3 SoC's.
* Shed light on why TIFS Stub isn't package with the DM firmware itself.
* Modify the platform docs wherever the TIFS Stub documentation applies.
* Also, refactor and add a few new labels to help split the firmware
  documentation chunks. This will make it easier to include them one by
  one wherever applicable

Reviewed-by: Nishanth Menon <nm@ti.com>
Signed-off-by: Dhruva Gole <d-gole@ti.com>
Acked-by: Francesco Dolcini <francesco.dolcini@toradex.com> # verdin-am62
This commit is contained in:
Dhruva Gole 2024-08-05 19:59:32 +05:30 committed by Tom Rini
parent 4623094d90
commit 962f60abca
5 changed files with 51 additions and 16 deletions

View File

@ -60,6 +60,10 @@ Sources:
:start-after: .. k3_rst_include_start_boot_sources
:end-before: .. k3_rst_include_end_boot_sources
.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_boot_firmwares
:end-before: .. k3_rst_include_end_tifsstub
Build procedure:
----------------
0. Setup the environment variables:

View File

@ -68,6 +68,10 @@ Sources:
:start-after: .. k3_rst_include_start_boot_sources
:end-before: .. k3_rst_include_end_boot_sources
.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_boot_firmwares
:end-before: .. k3_rst_include_end_tifsstub
Build procedure:
----------------

View File

@ -59,6 +59,10 @@ Sources:
:start-after: .. k3_rst_include_start_boot_sources
:end-before: .. k3_rst_include_end_boot_sources
.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_boot_firmwares
:end-before: .. k3_rst_include_end_tifsstub
Build procedure:
----------------
0. Setup the environment variables:

View File

@ -182,25 +182,44 @@ online
.. note::
The TI Firmware required for functionality of the system can be
one of the following combination (see platform specific boot diagram for
further information as to which component runs on which processor):
* **TIFS** - TI Foundational Security Firmware - Consists of purely firmware
meant to run on the security enclave.
* **DM** - Device Management firmware also called TI System Control Interface
server (TISCI Server) - This component purely plays the role of managing
device resources such as power, clock, interrupts, dma etc. This firmware
runs on a dedicated or multi-use microcontroller outside the security
enclave.
OR
* **SYSFW** - System firmware - consists of both TIFS and DM both running on
the security enclave.
The TI Firmwares required for functionality of the system are (see
platform specific boot diagram for further information as to which
component runs on which processor):
.. k3_rst_include_end_boot_sources
.. k3_rst_include_start_boot_firmwares
* **TIFS** - TI Foundational Security Firmware - Consists of purely firmware
meant to run on the security enclave.
* **DM** - Device Management firmware also called TI System Control Interface
server (TISCI Server) - This component purely plays the role of managing
device resources such as power, clock, interrupts, dma etc. This firmware
runs on a dedicated or multi-use microcontroller outside the security
enclave.
.. k3_rst_include_end_boot_firmwares
.. k3_rst_include_start_tifsstub
* **TIFS Stub** - The TIFS stub is a small piece of binary designed to help
restore the required security context and resume the TIFS firmware when
the system resumes from low-power modes such as suspend-to-RAM/Deep
Sleep. This stub uses the same encryption and customer key signing model
as TIFS and is loaded into the ATCM (Tightly Coupled Memory 'A' of the
DM R5) during DM startup. Due to the independent certificate signing
process, the stub is maintained separately from DM.
.. k3_rst_include_end_tifsstub
OR
.. k3_rst_include_start_boot_firmwares_sysfw
* **SYSFW** - System firmware - consists of both TIFS and DM both running on
the security enclave.
.. k3_rst_include_end_boot_firmwares_sysfw
Build Procedure
---------------

View File

@ -29,6 +29,10 @@ Sources:
:start-after: .. k3_rst_include_start_boot_sources
:end-before: .. k3_rst_include_end_boot_sources
.. include:: ../ti/k3.rst
:start-after: .. k3_rst_include_start_boot_firmwares
:end-before: .. k3_rst_include_end_tifsstub
Build procedure:
----------------