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

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