begriffs open source - freertos/blob - portable/ARMv8M/secure/context/secure_context.h

   1 /*\r
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * SPDX-License-Identifier: MIT\r
   6  *\r
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   8  * this software and associated documentation files (the "Software"), to deal in\r
   9  * the Software without restriction, including without limitation the rights to\r
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
  11  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  12  * subject to the following conditions:\r
  13  *\r
  14  * The above copyright notice and this permission notice shall be included in all\r
  15  * copies or substantial portions of the Software.\r
  16  *\r
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  23  *\r
  24  * https://www.FreeRTOS.org\r
  25  * https://github.com/FreeRTOS\r
  26  *\r
  27  */\r
  28 \r
  29 #ifndef __SECURE_CONTEXT_H__\r
  30 #define __SECURE_CONTEXT_H__\r
  31 \r
  32 /* Standard includes. */\r
  33 #include <stdint.h>\r
  34 \r
  35 /* FreeRTOS includes. */\r
  36 #include "FreeRTOSConfig.h"\r
  37 \r
  38 /**\r
  39  * @brief PSP value when no secure context is loaded.\r
  40  */\r
  41 #define securecontextNO_STACK    0x0\r
  42 /*-----------------------------------------------------------*/\r
  43 \r
  44 /**\r
  45  * @brief Structure to represent a secure context.\r
  46  *\r
  47  * @note Since stack grows down, pucStackStart is the highest address while\r
  48  * pucStackLimit is the first address of the allocated memory.\r
  49  */\r
  50 typedef struct SecureContext\r
  51 {\r
  52     uint8_t * pucCurrentStackPointer; /**< Current value of stack pointer (PSP). */\r
  53     uint8_t * pucStackLimit;          /**< Last location of the stack memory (PSPLIM). */\r
  54     uint8_t * pucStackStart;          /**< First location of the stack memory. */\r
  55 } SecureContext_t;\r
  56 /*-----------------------------------------------------------*/\r
  57 \r
  58 /**\r
  59  * @brief Opaque handle for a secure context.\r
  60  */\r
  61 typedef uint32_t SecureContextHandle_t;\r
  62 /*-----------------------------------------------------------*/\r
  63 \r
  64 /**\r
  65  * @brief Initializes the secure context management system.\r
  66  *\r
  67  * PSP is set to NULL and therefore a task must allocate and load a context\r
  68  * before calling any secure side function in the thread mode.\r
  69  *\r
  70  * @note This function must be called in the handler mode. It is no-op if called\r
  71  * in the thread mode.\r
  72  */\r
  73 void SecureContext_Init( void );\r
  74 \r
  75 /**\r
  76  * @brief Allocates a context on the secure side.\r
  77  *\r
  78  * @note This function must be called in the handler mode. It is no-op if called\r
  79  * in the thread mode.\r
  80  *\r
  81  * @param[in] ulSecureStackSize Size of the stack to allocate on secure side.\r
  82  * @param[in] ulIsTaskPrivileged 1 if the calling task is privileged, 0 otherwise.\r
  83  *\r
  84  * @return Opaque context handle if context is successfully allocated, NULL\r
  85  * otherwise.\r
  86  */\r
  87 #if ( configENABLE_MPU == 1 )\r
  88     SecureContextHandle_t SecureContext_AllocateContext( uint32_t ulSecureStackSize,\r
  89                                                          uint32_t ulIsTaskPrivileged );\r
  90 #else /* configENABLE_MPU */\r
  91     SecureContextHandle_t SecureContext_AllocateContext( uint32_t ulSecureStackSize );\r
  92 #endif /* configENABLE_MPU */\r
  93 \r
  94 /**\r
  95  * @brief Frees the given context.\r
  96  *\r
  97  * @note This function must be called in the handler mode. It is no-op if called\r
  98  * in the thread mode.\r
  99  *\r
 100  * @param[in] xSecureContextHandle Context handle corresponding to the\r
 101  * context to be freed.\r
 102  */\r
 103 void SecureContext_FreeContext( SecureContextHandle_t xSecureContextHandle );\r
 104 \r
 105 /**\r
 106  * @brief Loads the given context.\r
 107  *\r
 108  * @note This function must be called in the handler mode. It is no-op if called\r
 109  * in the thread mode.\r
 110  *\r
 111  * @param[in] xSecureContextHandle Context handle corresponding to the context\r
 112  * to be loaded.\r
 113  */\r
 114 void SecureContext_LoadContext( SecureContextHandle_t xSecureContextHandle );\r
 115 \r
 116 /**\r
 117  * @brief Saves the given context.\r
 118  *\r
 119  * @note This function must be called in the handler mode. It is no-op if called\r
 120  * in the thread mode.\r
 121  *\r
 122  * @param[in] xSecureContextHandle Context handle corresponding to the context\r
 123  * to be saved.\r
 124  */\r
 125 void SecureContext_SaveContext( SecureContextHandle_t xSecureContextHandle );\r
 126 \r
 127 #endif /* __SECURE_CONTEXT_H__ */\r