1.. _tfm_secure_partition:
2
3TF-M Secure Partition Sample
4############################
5
6Overview
7********
8
9A Secure Partition is an isolated module that resides in TF-M. It exposes a number of functions or
10"secure services" to other partitions and/or to the non-secure firmware. TF-M already contains
11standard partitions such as crypto, protected_storage, or firmware_update, but it's also possible to
12create your own partitions.
13
14This sample creates a dummy secure partition and secure service for TF-M and instructs the TF-M
15build system to build it into the secure firmware. The dummy secure service is then called in the
16main file (in the non-secure firmware).
17
18This dummy partition has a single secure service, which can index one of 5 dummy secrets inside the
19partition, and retrieve a hash of the secret.
20
21The partition is located in the ``dummy_partition`` directory. It contains the partition sources,
22build files and build configuration files. The partition is built by the TF-M build system, refer to
23:ref:`tfm_build_system` for more details.
24
25For more information on how to add custom secure partitions refer to TF-M's guide:
26https://tf-m-user-guide.trustedfirmware.org/integration_guide/services/tfm_secure_partition_addition.html
27
28When adapting this partition for your own purposes, please change all occurrences of
29"dummy_partition", "DUMMY_PARTITION", "dp", and "DP" to your own partition name. Also, look through
30both the secure and non-secure CMakeLists.txt file and make relevant changes, as well as the yaml
31files inside "partition".
32
33Building and Running
34********************
35
36This sample can be built with or without CONFIG_TFM_IPC, since it contains code for both.
37
38On Target
39=========
40
41Refer to :ref:`tfm_ipc` for detailed instructions.
42
43On QEMU
44=======
45
46Refer to :ref:`tfm_ipc` for detailed instructions.
47
48Sample Output
49=============
50
51   .. code-block:: console
52
53      *** Booting Zephyr OS build zephyr-v3.0.0-3061-g9bb87f4d46e9  ***
54      Digest: be45cb2605bf36bebde684841a28f0fd43c69850a3dce5fedba69928ee3a8991
55      Digest: 1452c8f04245d355722fdbfb03c69bcfd380b7dff911a3e425013397251f6a4e
56      Digest: d3b4349010abb691b9584b6fd6b41ec54596ef7b98d853fb4f5bfa690f50f222
57      Digest: 5afbcfede855ca834ff5b4e8a44a32206a51381f3cf52f5001a3241f017ac41a
58      Digest: 983318380c325099da63de2e7ca57c1630693b28b4754e08817533295dbfcfbb
59      No valid secret for key, received expected error code
60