mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/tz_context.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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