Moved proj up
This commit is contained in:
Timo Niemann
@@ -0,0 +1,80 @@
|
||||
# Target of this port
|
||||
|
||||
This port adds the support that FreeRTOS applications can call the secure
|
||||
services in Trusted Firmware M(TF-M) through Platform Security Architecture
|
||||
(PSA) API based on the ARM Cortex-M23, Cortex-M33, Cortex-M52, Cortex-M55，
|
||||
Cortex-M85 and Arm China STAR-MC3 platform.
|
||||
|
||||
The Platform Security Architecture (PSA) makes it quicker, easier and cheaper
|
||||
to design security into a device from the ground up. PSA is made up of four key
|
||||
stages: analyze, architect, implement, and certify. See [PSA Resource Page](https://www.arm.com/architecture/security-features/platform-security).
|
||||
|
||||
TF-M is an open source project. It provides a reference implementation of PSA
|
||||
for Arm M-profile architecture. Please get the details from this [link](https://www.trustedfirmware.org/projects/tf-m/).
|
||||
|
||||
# Derivation of the source code
|
||||
|
||||
* `os_wrapper_freertos.c`
|
||||
The implementation of APIs which are defined in `/interface/include/os_wrapper/mutex.h`
|
||||
in trusted-firmware-m (tag: TF-Mv2.0.0). The implementation is based on
|
||||
FreeRTOS mutex type semaphore.
|
||||
|
||||
# Usage notes
|
||||
|
||||
To build a project based on this port:
|
||||
* Step 1: build the secure image. Please follow the **Build the Secure Side** section for details.
|
||||
* Step 2: build the nonsecure image. Please follow the **Build the Non-Secure Side** for details.
|
||||
|
||||
## Build the Secure Side
|
||||
|
||||
### 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 supported by TF-M version **tag: TF-Mv2.0.0**.
|
||||
|
||||
### Build TF-M
|
||||
|
||||
Please refer to this [link](https://trustedfirmware-m.readthedocs.io/en/latest/getting_started/) to build the secure side.
|
||||
_**Note:** `TFM_NS_MANAGE_NSID` 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_[CM23|CM33|CM52|CM55|CM85|STAR_MC3]_NTZ` into the `freertos_kernel/portable/ThirdParty/GCC/ARM_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 `/interface/src/os_wrapper/tfm_ns_interface_rtos.c` by trusted-firmware-m (tag: TF-Mv2.0.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
|
||||
|
||||
* `configRUN_FREERTOS_SECURE_ONLY`
|
||||
This macro should be configured as 0. In this port, TF-M runs in the Secure Side while FreeRTOS
|
||||
Kernel runs in the Non-Secure Side.
|
||||
|
||||
* `configENABLE_FPU`
|
||||
The setting of this macro is decided by the setting in Secure Side which is platform-specific.
|
||||
If the Secure Side enables Non-Secure access to FPU, then this macro can be configured as 0 or 1. Otherwise, this macro can only be configured as 0.
|
||||
Please note that Cortex-M23 does not support FPU.
|
||||
Please refer to [TF-M documentation](https://trustedfirmware-m.readthedocs.io/en/latest/integration_guide/tfm_fpu_support.html) for FPU usage on the Non-Secure side.
|
||||
|
||||
* `configENABLE_MVE`
|
||||
The setting of this macro is decided by the setting in Secure Side which is platform-specific.
|
||||
If the Secure Side enables Non-Secure access to MVE, then this macro can be configured as 0 or 1. Otherwise, this macro can only be configured as 0.
|
||||
Please note that only Cortex-M52, Cortex-M55, Cortex-M85 and STAR-MC3 support MVE.
|
||||
Please refer to [TF-M documentation](https://trustedfirmware-m.readthedocs.io/en/latest/integration_guide/tfm_fpu_support.html) for MVE usage on the Non-Secure side.
|
||||
|
||||
* `configENABLE_TRUSTZONE`
|
||||
This macro should be configured as 0 because TF-M doesn't use the secure context management function of FreeRTOS. New secure context management might be introduced when TF-M supports multiple 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/api_ns/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/api_ns/interface/include`
|
||||
These files are the necessary header files to call TF-M services.
|
||||
* `trusted-firmware-m/build/api_ns/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-2024, Arm Limited. All rights reserved.*
|
||||
@@ -0,0 +1,112 @@
|
||||
/*
|
||||
* Copyright (c) 2019-2024, Arm Limited. All rights reserved.
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file contains the implementation of APIs which are defined in
|
||||
* \interface/include/os_wrapper/mutex.h by TF-M(tag: TF-Mv2.0.0).
|
||||
* The implementation is based on FreeRTOS mutex type semaphore.
|
||||
*/
|
||||
|
||||
#include "os_wrapper/mutex.h"
|
||||
|
||||
#include "FreeRTOS.h"
|
||||
#include "semphr.h"
|
||||
#include "mpu_wrappers.h"
|
||||
|
||||
#if ( configSUPPORT_STATIC_ALLOCATION == 1 )
|
||||
|
||||
/*
|
||||
* In the static allocation, the RAM is required to hold the semaphore's
|
||||
* state.
|
||||
*/
|
||||
StaticSemaphore_t xSecureMutexBuffer;
|
||||
#endif
|
||||
|
||||
void * os_wrapper_mutex_create( void )
|
||||
{
|
||||
SemaphoreHandle_t xMutexHandle = NULL;
|
||||
|
||||
#if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
|
||||
xMutexHandle = xSemaphoreCreateMutex();
|
||||
#elif ( configSUPPORT_STATIC_ALLOCATION == 1 )
|
||||
xMutexHandle = xSemaphoreCreateMutexStatic( &xSecureMutexBuffer );
|
||||
#endif
|
||||
return ( void * ) xMutexHandle;
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
uint32_t os_wrapper_mutex_acquire( void * handle,
|
||||
uint32_t timeout )
|
||||
{
|
||||
BaseType_t xRet;
|
||||
|
||||
if( !handle )
|
||||
{
|
||||
return OS_WRAPPER_ERROR;
|
||||
}
|
||||
|
||||
xRet = xSemaphoreTake( ( SemaphoreHandle_t ) handle,
|
||||
( timeout == OS_WRAPPER_WAIT_FOREVER ) ?
|
||||
portMAX_DELAY : ( TickType_t ) timeout );
|
||||
|
||||
if( xRet != pdPASS )
|
||||
{
|
||||
return OS_WRAPPER_ERROR;
|
||||
}
|
||||
else
|
||||
{
|
||||
return OS_WRAPPER_SUCCESS;
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
uint32_t os_wrapper_mutex_release( void * handle )
|
||||
{
|
||||
BaseType_t xRet;
|
||||
|
||||
if( !handle )
|
||||
{
|
||||
return OS_WRAPPER_ERROR;
|
||||
}
|
||||
|
||||
xRet = xSemaphoreGive( ( SemaphoreHandle_t ) handle );
|
||||
|
||||
if( xRet != pdPASS )
|
||||
{
|
||||
return OS_WRAPPER_ERROR;
|
||||
}
|
||||
else
|
||||
{
|
||||
return OS_WRAPPER_SUCCESS;
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
uint32_t os_wrapper_mutex_delete( void * handle )
|
||||
{
|
||||
vSemaphoreDelete( ( SemaphoreHandle_t ) handle );
|
||||
|
||||
return OS_WRAPPER_SUCCESS;
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
Reference in New Issue
Block a user