Skip to content

Commit f5c4cf1

Browse files
greg-ferrlubos
authored andcommitted
doc: tf-m: remove irrelevant doc set pages
Removed TF-M doc set pages that are not relevant for providing background info about the TF-M integration in the NCS. NCSDK-32856. NCSDK-26703. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 0b632f3 commit f5c4cf1

File tree

4 files changed

+61
-18
lines changed

4 files changed

+61
-18
lines changed

doc/nrf/glossary.rst

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ Glossary
4141
Application Programming Interface (API)
4242
A language and message format used by a program to communicate with an operating system, application, or other services.
4343

44+
Application RoT
45+
A concept related to `Platform Security Architecture (PSA)`_ and :term:`Root of Trust (RoT)`.
46+
It is the security domain in which additional security services are implemented.
47+
In the |NCS|, Trusted Firmware-M (TF-M) implements a set of Application RoT Services.
48+
For more information, see :ref:`ug_tfm_architecture_rot_services_application`.
49+
4450
Assisted GNSS (A-GNSS)
4551
A form of assistance provided to devices trying to obtain a :term:`Global Navigation Satellite System (GNSS)` fix.
4652
It improves the :term:`Time to First Fix (TTFF)` by utilizing a connection (for example, over cellular) to the internet to retrieve the :term:`almanac data` and :term:`ephemeris data`.
@@ -182,7 +188,7 @@ Glossary
182188
Most memory and peripherals can be flexibly allocated to cores at compile time.
183189

184190
Cortex Microcontroller Software Interface Standard (CMSIS)
185-
A vendor-independent hardware abstraction layer for the Cortex-M processor series that defines generic tool interfaces.
191+
A vendor-independent :term:`Hardware Abstraction Layer (HAL)` for the Cortex-M processor series that defines generic tool interfaces.
186192

187193
Cortex-M Security Extensions (CMSE)
188194
A group term for different security extensions for the Arm Cortex-M33 processor.
@@ -377,6 +383,9 @@ Glossary
377383
Global Positioning System (GPS)
378384
A satellite-based radio navigation system that provides its users with accurate location and time information over the globe.
379385

386+
Hardware Abstraction Layer (HAL)
387+
An interface to abstract hardware-oriented operations and provide a set of APIs to the upper layers.
388+
380389
Hardware Flow Control (HWFC)
381390
A handshaking mechanism used to prevent an overflow of bytes in modems.
382391
It uses two dedicated pins on the RS-232 connector, :term:`Request to Send (RTS)` and :term:`Clear to Send (CTS)`.
@@ -436,6 +445,10 @@ Glossary
436445
Isochronous channels (ISO)
437446
A feature of the :term:`LE Audio` standard that allows for relaying audio data to multiple devices at the same time (isochronously) without having to split the stereo stream.
438447

448+
Internal Trusted Storage (ITS)
449+
One of :term:`Platform RoT` services, which provides trusted storage of key material in internal flash.
450+
For more information, see :ref:`ug_tfm_services_its`.
451+
439452
Just In Time Provisioning (JITP)
440453
A device is provisioned when it first tries to connect to the IoT broker and presents its device certificate.
441454
Before the first communication, the device is not known to the broker and is not stored in the fleet registry.
@@ -537,6 +550,7 @@ Glossary
537550
Memory Privilege Controller (MPC)
538551
Performs security configuration, enforcement, and bus decoding.
539552
It implements security filtering, checking bus accesses against the configured access properties and blocking any unauthorized accesses.
553+
Do not confuse this with Memory Protection Controller from the Arm architecture, which is not used in the |NCS|.
540554

541555
Memory-to-memory Vector Direct Memory Access (MVDMA)
542556
A peripheral capable of copying data from one memory address to another memory address.
@@ -602,6 +616,11 @@ Glossary
602616
Noise Factor (NF)
603617
The relation of the :term:`Signal-to-Noise Ratio (SNR)` in the device input to the SNR in the device output.
604618

619+
Non-secure image
620+
A concept related to :ref:`ug_tfm_security_by_separation`.
621+
In the context of the |NCS| and `ARM TrustZone`_, this is a firmware image that is executed in the :term:`Non-Secure Processing Environment (NSPE)`.
622+
It is typically built using the ``*/ns`` :ref:`board target variant <app_boards_names>`.
623+
605624
Non-Secure Processing Environment (NSPE)
606625
One of the two processing environments when using Cortex-M Security Extensions.
607626
When firmware is separated between NSPE and :term:`Secure Processing Environment (SPE)`, NSPE is used to store the application core firmware.
@@ -701,6 +720,12 @@ Glossary
701720
Physically Unclonable Function (PUF)
702721
A function device that exploits inherent randomness introduced during manufacturing to give a physical entity a unique "fingerprint" or a trust anchor.
703722

723+
Platform RoT
724+
A concept related to `Platform Security Architecture (PSA)`_ and :term:`Root of Trust (RoT)`.
725+
It is the security domain in which platform-specific services are implemented.
726+
In the |NCS|, Trusted Firmware-M (TF-M) implements a set of Platform RoT Services.
727+
For more information, see :ref:`ug_tfm_architecture_rot_services_platform`.
728+
704729
Platform Security Architecture Certified (PSA Certified)
705730
A security certification scheme for Internet of Things (IoT) hardware, software and devices.
706731

@@ -736,6 +761,10 @@ Glossary
736761
Programmable Peripheral Interconnect (PPI)
737762
It enables peripherals to interact autonomously with each other using tasks and events independently of the CPU.
738763

764+
Protected Storage (PS)
765+
One of :term:`Application RoT` services, which provides secure storage with encryption, integrity protection, and rollback protection for non-secure applications.
766+
For more information, see :ref:`tfm_partition_ps`.
767+
739768
Protocol Data Unit (PDU)
740769
Information transferred as a single unit between peer entities of a computer network and containing control and address information or data.
741770
PDU mode is one of the two ways of sending and receiving SMS messages.
@@ -830,6 +859,14 @@ Glossary
830859
A dedicated :term:`Domain` which executes a pre-compiled firmware component that is signed by Nordic Semiconductor.
831860
It exposes security services to the other domains through an Interprocess Communication interface.
832861

862+
Secure image
863+
A concept related to :ref:`ug_tfm_security_by_separation`.
864+
In the context of the |NCS| and `ARM TrustZone`_, this is a firmware image that is provided by Trusted Firmware-M and executed in the :term:`Secure Processing Environment (SPE)`.
865+
It is typically built using the ``*/ns`` :ref:`board target variant <app_boards_names>`.
866+
867+
Secure partition
868+
A memory partition used to store the data of the :term:`Secure Processing Environment (SPE)`.
869+
833870
Serial Peripheral Interface (SPI)
834871
An interface bus commonly used to send data between microcontrollers and small peripherals such as shift registers, sensors, and SD cards.
835872

doc/nrf/links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1667,6 +1667,7 @@
16671667
.. _`ARM Platform Security Model 1.1`: https://developer.arm.com/documentation/den0128/0101b/
16681668
.. _`Trusted Base System Architecture for M (TBSA-M) Specification`: https://developer.arm.com/-/media/Arm%20Developer%20Community/PDF/PSA/DEN0083_PSA_TBSA-M_1.0-bet2.pdf?revision=5f9de99f-a7b5-4851-b041-f698521bf6bf
16691669
.. _`Platform Security Architectures`: https://www.arm.com/architecture/security-features/platform-security
1670+
.. _`Memory Protection Controllers`: https://developer.arm.com/documentation/102803/0000/Functional-Description/Memory-Protection-Controllers
16701671

16711672
.. ### Source: psacertified.org
16721673

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,9 @@ Trusted Firmware-M
163163
nRF54L05 does not support TF-M.
164164
nRF54L10 supports TF-M experimentally.
165165

166+
* Removed several documentation pages from the :ref:`tfm_wrapper` section that were misleading or not relevant for understanding the TF-M integration in the |NCS|.
167+
The section now includes only pages that provide background information about TF-M design that are relevant for the |NCS|.
168+
166169
Protocols
167170
=========
168171

doc/tfm/wrapper.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
.. _tfm_wrapper:
22

3-
Trusted Firmware-M documentation
4-
################################
3+
Trusted Firmware-M reference documentation
4+
##########################################
55

6-
This section includes the official `Trusted Firmware-M (TF-M) <https://www.trustedfirmware.org/projects/tf-m/>`_ documentation.
7-
It is provided for reference only and is intended for the developers working on the integration of TF-M in the nRF Connect SDK.
6+
This section includes a selection of pages from the official `Trusted Firmware-M (TF-M) <https://www.trustedfirmware.org/projects/tf-m/>`_ documentation.
7+
The pages are published as-is using the sources from the downstream `TF-M repository <https://github.com/nrfconnect/sdk-trusted-firmware-m>`_.
88

9-
The section renders the content of the `official TF-M documentation <https://trustedfirmware-m.readthedocs.io/en/latest/index.html>`_ as-is using the sources from the downstream `TF-M repository <https://github.com/nrfconnect/sdk-trusted-firmware-m>`_.
9+
The pages provide background information about some of the aspects of `TF-M integration in the nRF Connect SDK <https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security/tfm/index.html>`_.
10+
Use these pages for reference only.
1011

11-
For information on how TF-M is integrated in the nRF Connect SDK, see the `Security section in the nRF Connect SDK documentation <https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security.html>`_.
12+
.. note::
13+
Not all TF-M features mentioned in this section are used by the nRF Connect SDK.
14+
For more information, see `TF-M support and limitations in the nRF Connect SDK <https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security/tfm/tfm_supported_services.html>`_.
15+
16+
For the complete TF-M upstream documentation, visit the `official TF-M documentation website <https://trustedfirmware-m.readthedocs.io/en/latest/index.html>`_.
1217

1318
.. toctree::
1419
:maxdepth: 1
1520
:caption: Contents
1621

1722
introduction/index.rst
18-
getting_started/index.rst
1923
security/index.rst
20-
releases/index.rst
21-
roadmap.rst
22-
glossary.rst
23-
platform/index.rst
24-
building/tfm_build_instruction.rst
25-
configuration/index.rst
26-
integration_guide/index.rst
24+
configuration/profiles/index.rst
25+
integration_guide/source_structure/source_structure.rst
26+
integration_guide/spm_backends.rst
27+
integration_guide/tfm_fpu_support.rst
28+
integration_guide/tfm_secure_irq_integration_guide.rst
29+
integration_guide/platform_provisioning.rst
30+
integration_guide/branch_protection.rst
31+
integration_guide/services/index.rst
2732
design_docs/index.rst
28-
contributing/index.rst
29-
contributing/lic.rst
30-
contributing/dco.rst

0 commit comments

Comments
 (0)