Skip to content

Commit

Permalink
doc: ti: k3: Add TIFS Stub documentation
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
DhruvaG2000 authored and trini committed Aug 9, 2024
1 parent 4623094 commit 962f60a
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 14 deletions.
4 changes: 4 additions & 0 deletions doc/board/ti/am62ax_sk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions doc/board/ti/am62px_sk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
----------------

Expand Down
4 changes: 4 additions & 0 deletions doc/board/ti/am62x_sk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
47 changes: 33 additions & 14 deletions doc/board/ti/k3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,24 +182,43 @@ 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):
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):

* **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_sources
OR
.. k3_rst_include_start_boot_firmwares
* **SYSFW** - System firmware - consists of both TIFS and DM both running on
the security enclave.
* **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_sources
.. 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
---------------
Expand Down
4 changes: 4 additions & 0 deletions doc/board/toradex/verdin-am62.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
----------------

Expand Down

0 comments on commit 962f60a

Please sign in to comment.