lib/main/CMSIS/Core/Include/tz_context.h

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