Skip to content

Commit b2c1fe0

Browse files
author
Oren Cohen
committed
Add README.md for tools/psa
1 parent c37ac83 commit b2c1fe0

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

tools/psa/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# PSA Tools
2+
3+
This document will describe the following scripts:
4+
5+
* \_\_init\_\_.py
6+
* generate_partition_code.py
7+
* mbed_spm_tfm_common.py
8+
* generate_mbed_spm_partition_code.py
9+
* generate_tfm_partition_code.py
10+
* release.py
11+
12+
## \_\_init\_\_.py
13+
14+
This file holds common function dedicated to help SiP with their post-build logic.
15+
16+
* find_secure_image - Scans a Resource object to find the correct binary of the secure image to merge with the non-secure build.
17+
18+
19+
## Code generation scripts
20+
21+
mbed-os holds 2 implementations of PSA:
22+
* MBED_SPM - Implementation for dual core v7 targets.
23+
* TF-M - Implementation for v8 targets.
24+
25+
each implementation requires a set of auto generated files describing the secure partitions.
26+
27+
* `generate_partition_code.py` - Generate files for both implementations.
28+
* `generate_mbed_spm_partition_code.py` - Generate files for BMED_SPM.
29+
* `generate_tfm_partition_code.py` - Generate files for TF-M.
30+
* `mbed_spm_tfm_common.py` - Holds common functions for both.
31+
32+
## Secure image generation
33+
34+
`release.py` is the script assigned with compiling the secure images.
35+
36+
```python
37+
usage: release.py [-h] [-m MCU]
38+
39+
optional arguments:
40+
-h, --help show this help message and exit
41+
-m MCU, --mcu MCU build for the given MCU
42+
```
43+
44+
when `MCU ` is not specified the script will compile all the images for all the targets
45+
46+
This script should be ran in following scenarios:
47+
* Release.
48+
* Update to files originating in the secure side.
49+
* Drivers update.
50+
* PSA updates.

0 commit comments

Comments
 (0)