From: Dhruva Gole <d-gole@ti.com>
To: Tom Rini <trini@konsulko.com>, Nishant Menon <nm@ti.com>
Cc: <u-boot@lists.denx.de>, Neha Malcom Francis <n-francis@ti.com>,
<c-shilwant@ti.com>, <m-chawdhry@ti.com>, <vigneshr@ti.com>,
Robert Nelson <robertcnelson@gmail.com>,
Vibhore Vardhan <vibhore@ti.com>,
Vishal Mahaveer <vishalm@ti.com>,
Sebin Francis <sebin.francis@ti.com>,
Wadim Egorov <w.egorov@phytec.de>, <t.remmet@phytec.de>,
<mkorpershoek@baylibre.com>, Daniel Schultz <d.schultz@phytec.de>,
Dhruva Gole <d-gole@ti.com>
Subject: [PATCH V7 2/7] doc: ti: k3: Add TIFS Stub documentation
Date: Thu, 25 Jul 2024 15:05:42 +0530 [thread overview]
Message-ID: <20240725093546.4193107-3-d-gole@ti.com> (raw)
In-Reply-To: <20240725093546.4193107-1-d-gole@ti.com>
* 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
Signed-off-by: Dhruva Gole <d-gole@ti.com>
---
doc/board/ti/am62ax_sk.rst | 4 +++
doc/board/ti/am62px_sk.rst | 4 +++
doc/board/ti/am62x_sk.rst | 4 +++
doc/board/ti/k3.rst | 51 +++++++++++++++++++++----------
doc/board/toradex/verdin-am62.rst | 4 +++
5 files changed, 51 insertions(+), 16 deletions(-)
diff --git a/doc/board/ti/am62ax_sk.rst b/doc/board/ti/am62ax_sk.rst
index 60726b6652ce..72fa5a8d8cdd 100644
--- a/doc/board/ti/am62ax_sk.rst
+++ b/doc/board/ti/am62ax_sk.rst
@@ -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:
diff --git a/doc/board/ti/am62px_sk.rst b/doc/board/ti/am62px_sk.rst
index c80b50681176..bcef6653cb92 100644
--- a/doc/board/ti/am62px_sk.rst
+++ b/doc/board/ti/am62px_sk.rst
@@ -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:
----------------
diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index 2a25e84f6c97..e2a848d159ff 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -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:
diff --git a/doc/board/ti/k3.rst b/doc/board/ti/k3.rst
index 67b066a07d3a..c3513f0aee20 100644
--- a/doc/board/ti/k3.rst
+++ b/doc/board/ti/k3.rst
@@ -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
---------------
diff --git a/doc/board/toradex/verdin-am62.rst b/doc/board/toradex/verdin-am62.rst
index e8d902732883..93912adc896d 100644
--- a/doc/board/toradex/verdin-am62.rst
+++ b/doc/board/toradex/verdin-am62.rst
@@ -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:
----------------
--
2.34.1
next prev parent reply other threads:[~2024-07-25 9:38 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-25 9:35 [PATCH V7 0/7] Low Power Mode: Package TIFS Stub in BeaglePlay Dhruva Gole
2024-07-25 9:35 ` [PATCH V7 1/7] MAINTAINERS: Include the TI docs under ARM TI Dhruva Gole
2024-07-25 11:47 ` Nishanth Menon
2024-07-25 9:35 ` Dhruva Gole [this message]
2024-07-25 11:50 ` [PATCH V7 2/7] doc: ti: k3: Add TIFS Stub documentation Nishanth Menon
2024-07-25 9:35 ` [PATCH V7 3/7] doc: board: ti: Update to use the new boot firmware labels Dhruva Gole
2024-07-25 11:58 ` Nishanth Menon
2024-07-29 11:50 ` Francesco Dolcini
2024-07-25 9:35 ` [PATCH V7 4/7] doc: ti: am62*: Mention TIFS Stub in img fmts and boot flow Dhruva Gole
2024-07-25 11:59 ` Nishanth Menon
2024-07-25 9:35 ` [PATCH V7 5/7] arm: dts: k3-am625-beagleplay: Package TIFS Stub Dhruva Gole
2024-07-25 12:04 ` Nishanth Menon
2024-07-25 9:35 ` [PATCH V7 6/7] doc: beagle: am62x_beagleplay: Document the use of " Dhruva Gole
2024-07-25 12:04 ` Nishanth Menon
2024-07-25 9:35 ` [PATCH V7 7/7] arm: dts: phycore-am62x: Package " Dhruva Gole
2024-07-25 9:55 ` Wadim Egorov
2024-07-25 12:05 ` Nishanth Menon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240725093546.4193107-3-d-gole@ti.com \
--to=d-gole@ti.com \
--cc=c-shilwant@ti.com \
--cc=d.schultz@phytec.de \
--cc=m-chawdhry@ti.com \
--cc=mkorpershoek@baylibre.com \
--cc=n-francis@ti.com \
--cc=nm@ti.com \
--cc=robertcnelson@gmail.com \
--cc=sebin.francis@ti.com \
--cc=t.remmet@phytec.de \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=vibhore@ti.com \
--cc=vigneshr@ti.com \
--cc=vishalm@ti.com \
--cc=w.egorov@phytec.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox