begriffs open source - freertos/blob - portable/IAR/ARM_CM33/secure/secure_context.h

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