mirror of
				https://github.com/FreeRTOS/FreeRTOS-Kernel.git
				synced 2025-11-04 11:09:01 +01:00 
			
		
		
		
	Update the README to align with TF-Mv1.4.0 in TF-M integration (#384)
Change-Id: I41fc8e18657086e86eacd38ed70f474555739a3c Signed-off-by: Sherry Zhang <sherry.zhang2@arm.com>
This commit is contained in:
		
							parent
							
								
									0b1e9d79c8
								
							
						
					
					
						commit
						c290780e34
					
				
							
								
								
									
										21
									
								
								portable/ThirdParty/GCC/ARM_CM33_TFM/README.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										21
									
								
								portable/ThirdParty/GCC/ARM_CM33_TFM/README.md
									
									
									
									
										vendored
									
									
								
							@ -14,8 +14,8 @@ for Arm M-profile architecture. Please get the details from this [link](https://
 | 
			
		||||
# Derivation of the source code
 | 
			
		||||
 | 
			
		||||
* ```os_wrapper_freertos.c```
 | 
			
		||||
  The implementation of APIs which are defined in ```os_wrapper\mutex.h``` by TF-M
 | 
			
		||||
  (tag: TF-Mv1.2.0). The implementation is based on FreeRTOS mutex type semaphore.
 | 
			
		||||
  The implementation of APIs which are defined in ```\os_wrapper\mutex.h``` by tf-m-tests
 | 
			
		||||
  (tag: TF-Mv1.4.0). The implementation is based on FreeRTOS mutex type semaphore.
 | 
			
		||||
 | 
			
		||||
# Usage notes
 | 
			
		||||
 | 
			
		||||
@ -27,18 +27,19 @@ To build a project based on this port:
 | 
			
		||||
 | 
			
		||||
### Get the TF-M source code
 | 
			
		||||
 | 
			
		||||
See the [link](https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/) to get the source code. This port is based on TF-M version **tag: TF-Mv1.2.0**.
 | 
			
		||||
See the [link](https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/) to get the source code. This port is based on TF-M version **tag: TF-Mv1.4.0**.
 | 
			
		||||
 | 
			
		||||
### Build TF-M
 | 
			
		||||
 | 
			
		||||
Please refer to this [link](https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/tree/docs/getting_started/tfm_build_instruction.rst) to build the secure side.
 | 
			
		||||
_**Note:** ```CONFIG_TFM_ENABLE_CTX_MGMT``` must be configured as "OFF" when building TF-M_.
 | 
			
		||||
Please refer to this [link](https://tf-m-user-guide.trustedfirmware.org/docs/technical_references/instructions/tfm_build_instruction.html) to build the secure side.
 | 
			
		||||
_**Note:** ```TFM_NS_CLIENT_IDENTIFICATION``` must be configured as "OFF" when building TF-M_.
 | 
			
		||||
 | 
			
		||||
## Build the Non-Secure Side
 | 
			
		||||
 | 
			
		||||
Please copy all the files in ```freertos_kernel\portable\GCC\ARM_CM33_NTZ``` into the ```freertos_kernel\portable\ThirdParty\GCC\ARM_CM33_TFM``` folder before using this port. Note that TrustZone is enabled in this port. The TF-M runs in the Secure Side.
 | 
			
		||||
 | 
			
		||||
Please call the API ```tfm_ns_interface_init()``` which is defined in ```tfm_ns_interface.c``` at the very beginning of your application. Otherwise, it will always fail when calling a TF-M service in the Nonsecure Side.
 | 
			
		||||
Please call the API ```tfm_ns_interface_init()``` which is defined in ```tfm_ns_interface.c``` by tf-m-tests
 | 
			
		||||
(tag: TF-Mv1.4.0)at the very beginning of your application. Otherwise, it will always fail when calling a TF-M service in the Nonsecure Side.
 | 
			
		||||
 | 
			
		||||
### Configuration in FreeRTOS kernel
 | 
			
		||||
 | 
			
		||||
@ -57,15 +58,15 @@ This macro should be configured as 0 because TF-M doesn't use the secure context
 | 
			
		||||
### Integrate TF-M Non-Secure interface with FreeRTOS project
 | 
			
		||||
 | 
			
		||||
To enable calling TF-M services by the Non-Secure Side, the files below should be included in the FreeRTOS project and built together.
 | 
			
		||||
* files in ```trusted-firmware-m\build\install\export\tfm\src```
 | 
			
		||||
* files in ```trusted-firmware-m\build\install\interface\src```
 | 
			
		||||
  These files contain the implementation of PSA Functional Developer APIs which can be called by Non-Secure Side directly and PSA Firmware Framework APIs in the IPC model. These files should be taken
 | 
			
		||||
  as part of the Non-Secure source code.
 | 
			
		||||
* files in ```trusted-firmware-m\build\install\export\tfm\include```
 | 
			
		||||
* files in ```trusted-firmware-m\build\install\interface\include```
 | 
			
		||||
  These files are the necessary header files to call TF-M services.
 | 
			
		||||
* ```trusted-firmware-m\build\install\export\tfm\lib\s_veneers.o```
 | 
			
		||||
* ```trusted-firmware-m\build\install\interface\lib\s_veneers.o```
 | 
			
		||||
  This object file contains all the Non-Secure callable functions exported by
 | 
			
		||||
  TF-M and it should be linked when generating the Non-Secure image.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
*Copyright (c) 2020, Arm Limited. All rights reserved.*
 | 
			
		||||
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user