mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_STEVAL_3DP001V1/tz_context.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
163:e59c8e839560 
mbed library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 169:a7c7b631e539 1 /******************************************************************************
Anna Bridge 169:a7c7b631e539 2 * @file tz_context.h
Anna Bridge 169:a7c7b631e539 3 * @brief Context Management for Armv8-M TrustZone
Anna Bridge 169:a7c7b631e539 4 * @version V1.0.1
Anna Bridge 169:a7c7b631e539 5 * @date 10. January 2018
Anna Bridge 169:a7c7b631e539 6 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 7 /*
Anna Bridge 169:a7c7b631e539 8 * Copyright (c) 2017-2018 Arm Limited. All rights reserved.
AnnaBridge 161:aa5281ff4a02 9 *
AnnaBridge 161:aa5281ff4a02 10 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 161:aa5281ff4a02 11 *
AnnaBridge 161:aa5281ff4a02 12 * Licensed under the Apache License, Version 2.0 (the License); you may
AnnaBridge 161:aa5281ff4a02 13 * not use this file except in compliance with the License.
AnnaBridge 161:aa5281ff4a02 14 * You may obtain a copy of the License at
AnnaBridge 161:aa5281ff4a02 15 *
AnnaBridge 161:aa5281ff4a02 16 * www.apache.org/licenses/LICENSE-2.0
AnnaBridge 161:aa5281ff4a02 17 *
AnnaBridge 161:aa5281ff4a02 18 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 161:aa5281ff4a02 19 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
AnnaBridge 161:aa5281ff4a02 20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 161:aa5281ff4a02 21 * See the License for the specific language governing permissions and
AnnaBridge 161:aa5281ff4a02 22 * limitations under the License.
Anna Bridge 169:a7c7b631e539 23 */
Anna Bridge 169:a7c7b631e539 24
Anna Bridge 169:a7c7b631e539 25 #if defined ( __ICCARM__ )
Anna Bridge 169:a7c7b631e539 26 #pragma system_include /* treat file as system include file for MISRA check */
Anna Bridge 169:a7c7b631e539 27 #elif defined (__clang__)
Anna Bridge 169:a7c7b631e539 28 #pragma clang system_header /* treat file as system include file */
Anna Bridge 169:a7c7b631e539 29 #endif
Anna Bridge 169:a7c7b631e539 30
AnnaBridge 161:aa5281ff4a02 31 #ifndef TZ_CONTEXT_H
AnnaBridge 161:aa5281ff4a02 32 #define TZ_CONTEXT_H
AnnaBridge 161:aa5281ff4a02 33
AnnaBridge 161:aa5281ff4a02 34 #include <stdint.h>
AnnaBridge 161:aa5281ff4a02 35
AnnaBridge 161:aa5281ff4a02 36 #ifndef TZ_MODULEID_T
AnnaBridge 161:aa5281ff4a02 37 #define TZ_MODULEID_T
AnnaBridge 161:aa5281ff4a02 38 /// \details Data type that identifies secure software modules called by a process.
AnnaBridge 161:aa5281ff4a02 39 typedef uint32_t TZ_ModuleId_t;
AnnaBridge 161:aa5281ff4a02 40 #endif
AnnaBridge 161:aa5281ff4a02 41
AnnaBridge 161:aa5281ff4a02 42 /// \details TZ Memory ID identifies an allocated memory slot.
AnnaBridge 161:aa5281ff4a02 43 typedef uint32_t TZ_MemoryId_t;
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /// Initialize secure context memory system
AnnaBridge 161:aa5281ff4a02 46 /// \return execution status (1: success, 0: error)
AnnaBridge 161:aa5281ff4a02 47 uint32_t TZ_InitContextSystem_S (void);
AnnaBridge 161:aa5281ff4a02 48
AnnaBridge 161:aa5281ff4a02 49 /// Allocate context memory for calling secure software modules in TrustZone
AnnaBridge 161:aa5281ff4a02 50 /// \param[in] module identifies software modules called from non-secure mode
AnnaBridge 161:aa5281ff4a02 51 /// \return value != 0 id TrustZone memory slot identifier
AnnaBridge 161:aa5281ff4a02 52 /// \return value 0 no memory available or internal error
AnnaBridge 161:aa5281ff4a02 53 TZ_MemoryId_t TZ_AllocModuleContext_S (TZ_ModuleId_t module);
AnnaBridge 161:aa5281ff4a02 54
AnnaBridge 161:aa5281ff4a02 55 /// Free context memory that was previously allocated with \ref TZ_AllocModuleContext_S
AnnaBridge 161:aa5281ff4a02 56 /// \param[in] id TrustZone memory slot identifier
AnnaBridge 161:aa5281ff4a02 57 /// \return execution status (1: success, 0: error)
AnnaBridge 161:aa5281ff4a02 58 uint32_t TZ_FreeModuleContext_S (TZ_MemoryId_t id);
AnnaBridge 161:aa5281ff4a02 59
AnnaBridge 161:aa5281ff4a02 60 /// Load secure context (called on RTOS thread context switch)
AnnaBridge 161:aa5281ff4a02 61 /// \param[in] id TrustZone memory slot identifier
AnnaBridge 161:aa5281ff4a02 62 /// \return execution status (1: success, 0: error)
AnnaBridge 161:aa5281ff4a02 63 uint32_t TZ_LoadContext_S (TZ_MemoryId_t id);
AnnaBridge 161:aa5281ff4a02 64
AnnaBridge 161:aa5281ff4a02 65 /// Store secure context (called on RTOS thread context switch)
AnnaBridge 161:aa5281ff4a02 66 /// \param[in] id TrustZone memory slot identifier
AnnaBridge 161:aa5281ff4a02 67 /// \return execution status (1: success, 0: error)
AnnaBridge 161:aa5281ff4a02 68 uint32_t TZ_StoreContext_S (TZ_MemoryId_t id);
AnnaBridge 161:aa5281ff4a02 69
AnnaBridge 161:aa5281ff4a02 70 #endif // TZ_CONTEXT_H