git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/ARMv8M/non_secure/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.2.0\r
   3  * Copyright (C) 2019 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  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 #ifndef PORTMACRO_H\r
  29 #define PORTMACRO_H\r
  30 \r
  31 #ifdef __cplusplus\r
  32 extern "C" {\r
  33 #endif\r
  34 \r
  35 /*------------------------------------------------------------------------------\r
  36  * Port specific definitions.\r
  37  *\r
  38  * The settings in this file configure FreeRTOS correctly for the given hardware\r
  39  * and compiler.\r
  40  *\r
  41  * These settings should not be altered.\r
  42  *------------------------------------------------------------------------------\r
  43  */\r
  44 \r
  45 /**\r
  46  * @brief Type definitions.\r
  47  */\r
  48 #define portCHAR                                            char\r
  49 #define portFLOAT                                           float\r
  50 #define portDOUBLE                                          double\r
  51 #define portLONG                                            long\r
  52 #define portSHORT                                           short\r
  53 #define portSTACK_TYPE                                      uint32_t\r
  54 #define portBASE_TYPE                                       long\r
  55 \r
  56 typedef portSTACK_TYPE                                      StackType_t;\r
  57 typedef long                                                BaseType_t;\r
  58 typedef unsigned long                                       UBaseType_t;\r
  59 \r
  60 #if( configUSE_16_BIT_TICKS == 1 )\r
  61     typedef uint16_t TickType_t;\r
  62     #define portMAX_DELAY ( TickType_t )                    0xffff\r
  63 #else\r
  64     typedef uint32_t TickType_t;\r
  65     #define portMAX_DELAY ( TickType_t )                    0xffffffffUL\r
  66 \r
  67     /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  68      * not need to be guarded with a critical section. */\r
  69     #define portTICK_TYPE_IS_ATOMIC                         1\r
  70 #endif\r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 /**\r
  74  * Architecture specifics.\r
  75  */\r
  76 #define portSTACK_GROWTH                                    ( -1 )\r
  77 #define portTICK_PERIOD_MS                                  ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  78 #define portBYTE_ALIGNMENT                                  8\r
  79 #define portNOP()\r
  80 #define portINLINE                                          __inline\r
  81 #ifndef portFORCE_INLINE\r
  82     #define portFORCE_INLINE                                inline __attribute__(( always_inline ))\r
  83 #endif\r
  84 #define portHAS_STACK_OVERFLOW_CHECKING                     1\r
  85 /*-----------------------------------------------------------*/\r
  86 \r
  87 /**\r
  88  * @brief Extern declarations.\r
  89  */\r
  90 extern void vPortYield( void ) /* PRIVILEGED_FUNCTION */;\r
  91 \r
  92 extern void vPortEnterCritical( void ) /* PRIVILEGED_FUNCTION */;\r
  93 extern void vPortExitCritical( void ) /* PRIVILEGED_FUNCTION */;\r
  94 \r
  95 extern uint32_t ulSetInterruptMaskFromISR( void ) /* __attribute__(( naked )) PRIVILEGED_FUNCTION */;\r
  96 extern void vClearInterruptMaskFromISR( uint32_t ulMask ) /* __attribute__(( naked )) PRIVILEGED_FUNCTION */;\r
  97 \r
  98 #if( configENABLE_TRUSTZONE == 1 )\r
  99     extern void vPortAllocateSecureContext( uint32_t ulSecureStackSize );\r
 100     extern void vPortFreeSecureContext( uint32_t *pulTCB ) /* PRIVILEGED_FUNCTION */;\r
 101 #endif /* configENABLE_TRUSTZONE */\r
 102 \r
 103 #if( configENABLE_MPU == 1 )\r
 104     extern BaseType_t xIsPrivileged( void ) /* __attribute__ (( naked )) */;\r
 105     extern void vResetPrivilege( void ) /* __attribute__ (( naked )) */;\r
 106 #endif /* configENABLE_MPU */\r
 107 /*-----------------------------------------------------------*/\r
 108 \r
 109 /**\r
 110  * @brief MPU specific constants.\r
 111  */\r
 112 #if( configENABLE_MPU == 1 )\r
 113     #define portUSING_MPU_WRAPPERS                          1\r
 114     #define portPRIVILEGE_BIT                               ( 0x80000000UL )\r
 115 #else\r
 116     #define portPRIVILEGE_BIT                               ( 0x0UL )\r
 117 #endif /* configENABLE_MPU */\r
 118 \r
 119 \r
 120 /* MPU regions. */\r
 121 #define portPRIVILEGED_FLASH_REGION                         ( 0UL )\r
 122 #define portUNPRIVILEGED_FLASH_REGION                       ( 1UL )\r
 123 #define portPRIVILEGED_RAM_REGION                           ( 2UL )\r
 124 #define portUNPRIVILEGED_DEVICE_REGION                      ( 3UL )\r
 125 #define portSTACK_REGION                                    ( 4UL )\r
 126 #define portFIRST_CONFIGURABLE_REGION                       ( 5UL )\r
 127 #define portLAST_CONFIGURABLE_REGION                        ( 7UL )\r
 128 #define portNUM_CONFIGURABLE_REGIONS                        ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )\r
 129 #define portTOTAL_NUM_REGIONS                               ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */\r
 130 \r
 131 /* Devices Region. */\r
 132 #define portDEVICE_REGION_START_ADDRESS                     ( 0x50000000 )\r
 133 #define portDEVICE_REGION_END_ADDRESS                       ( 0x5FFFFFFF )\r
 134 \r
 135 /* Device memory attributes used in MPU_MAIR registers.\r
 136  *\r
 137  * 8-bit values encoded as follows:\r
 138  *  Bit[7:4] - 0000 - Device Memory\r
 139  *  Bit[3:2] - 00 --> Device-nGnRnE\r
 140  *             01 --> Device-nGnRE\r
 141  *             10 --> Device-nGRE\r
 142  *             11 --> Device-GRE\r
 143  *  Bit[1:0] - 00, Reserved.\r
 144  */\r
 145 #define portMPU_DEVICE_MEMORY_nGnRnE                        ( 0x00 ) /* 0000 0000 */\r
 146 #define portMPU_DEVICE_MEMORY_nGnRE                         ( 0x04 ) /* 0000 0100 */\r
 147 #define portMPU_DEVICE_MEMORY_nGRE                          ( 0x08 ) /* 0000 1000 */\r
 148 #define portMPU_DEVICE_MEMORY_GRE                           ( 0x0C ) /* 0000 1100 */\r
 149 \r
 150 /* Normal memory attributes used in MPU_MAIR registers. */\r
 151 #define portMPU_NORMAL_MEMORY_NON_CACHEABLE                 ( 0x44 ) /* Non-cacheable. */\r
 152 #define portMPU_NORMAL_MEMORY_BUFFERABLE_CACHEABLE          ( 0xFF ) /* Non-Transient, Write-back, Read-Allocate and Write-Allocate. */\r
 153 \r
 154 /* Attributes used in MPU_RBAR registers. */\r
 155 #define portMPU_REGION_NON_SHAREABLE                        ( 0UL << 3UL )\r
 156 #define portMPU_REGION_INNER_SHAREABLE                      ( 1UL << 3UL )\r
 157 #define portMPU_REGION_OUTER_SHAREABLE                      ( 2UL << 3UL )\r
 158 \r
 159 #define portMPU_REGION_PRIVILEGED_READ_WRITE                ( 0UL << 1UL )\r
 160 #define portMPU_REGION_READ_WRITE                           ( 1UL << 1UL )\r
 161 #define portMPU_REGION_PRIVILEGED_READ_ONLY                 ( 2UL << 1UL )\r
 162 #define portMPU_REGION_READ_ONLY                            ( 3UL << 1UL )\r
 163 \r
 164 #define portMPU_REGION_EXECUTE_NEVER                        ( 1UL )\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 /**\r
 168  * @brief Settings to define an MPU region.\r
 169  */\r
 170 typedef struct MPURegionSettings\r
 171 {\r
 172     uint32_t ulRBAR;    /**< RBAR for the region. */\r
 173     uint32_t ulRLAR;    /**< RLAR for the region. */\r
 174 } MPURegionSettings_t;\r
 175 \r
 176 /**\r
 177  * @brief MPU settings as stored in the TCB.\r
 178  */\r
 179 typedef struct MPU_SETTINGS\r
 180 {\r
 181     uint32_t ulMAIR0;   /**< MAIR0 for the task containing attributes for all the 4 per task regions. */\r
 182     MPURegionSettings_t xRegionsSettings[ portTOTAL_NUM_REGIONS ]; /**< Settings for 4 per task regions. */\r
 183 } xMPU_SETTINGS;\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 /**\r
 187  * @brief SVC numbers.\r
 188  */\r
 189 #define portSVC_ALLOCATE_SECURE_CONTEXT                     0\r
 190 #define portSVC_FREE_SECURE_CONTEXT                         1\r
 191 #define portSVC_START_SCHEDULER                             2\r
 192 #define portSVC_RAISE_PRIVILEGE                             3\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 /**\r
 196  * @brief Scheduler utilities.\r
 197  */\r
 198 #define portYIELD()                                         vPortYield()\r
 199 #define portNVIC_INT_CTRL_REG                               ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 200 #define portNVIC_PENDSVSET_BIT                              ( 1UL << 28UL )\r
 201 #define portEND_SWITCHING_ISR( xSwitchRequired )            if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
 202 #define portYIELD_FROM_ISR( x )                             portEND_SWITCHING_ISR( x )\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 /**\r
 206  * @brief Critical section management.\r
 207  */\r
 208 #define portSET_INTERRUPT_MASK_FROM_ISR()                   ulSetInterruptMaskFromISR()\r
 209 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)                vClearInterruptMaskFromISR( x )\r
 210 #define portDISABLE_INTERRUPTS()                            __asm volatile ( " cpsid i " ::: "memory" )\r
 211 #define portENABLE_INTERRUPTS()                             __asm volatile ( " cpsie i " ::: "memory" )\r
 212 #define portENTER_CRITICAL()                                vPortEnterCritical()\r
 213 #define portEXIT_CRITICAL()                                 vPortExitCritical()\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 /**\r
 217  * @brief Task function macros as described on the FreeRTOS.org WEB site.\r
 218  */\r
 219 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )  void vFunction( void *pvParameters )\r
 220 #define portTASK_FUNCTION( vFunction, pvParameters )        void vFunction( void *pvParameters )\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 #if( configENABLE_TRUSTZONE == 1 )\r
 224     /**\r
 225      * @brief Allocate a secure context for the task.\r
 226      *\r
 227      * Tasks are not created with a secure context. Any task that is going to call\r
 228      * secure functions must call portALLOCATE_SECURE_CONTEXT() to allocate itself a\r
 229      * secure context before it calls any secure function.\r
 230      *\r
 231      * @param[in] ulSecureStackSize The size of the secure stack to be allocated.\r
 232      */\r
 233     #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )    vPortAllocateSecureContext( ulSecureStackSize )\r
 234 \r
 235     /**\r
 236      * @brief Called when a task is deleted to delete the task's secure context,\r
 237      * if it has one.\r
 238      *\r
 239      * @param[in] pxTCB The TCB of the task being deleted.\r
 240      */\r
 241     #define portCLEAN_UP_TCB( pxTCB )                           vPortFreeSecureContext( ( uint32_t * ) pxTCB )\r
 242 #else\r
 243     #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )\r
 244     #define portCLEAN_UP_TCB( pxTCB )\r
 245 #endif /* configENABLE_TRUSTZONE */\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 #if( configENABLE_MPU == 1 )\r
 249     /**\r
 250      * @brief Checks whether or not the processor is privileged.\r
 251      *\r
 252      * @return 1 if the processor is already privileged, 0 otherwise.\r
 253      */\r
 254     #define portIS_PRIVILEGED()                                 xIsPrivileged()\r
 255 \r
 256     /**\r
 257      * @brief Raise an SVC request to raise privilege.\r
 258      *\r
 259      * The SVC handler checks that the SVC was raised from a system call and only\r
 260      * then it raises the privilege. If this is called from any other place,\r
 261      * the privilege is not raised.\r
 262      */\r
 263     #define portRAISE_PRIVILEGE()                               __asm volatile ( "svc %0 \n" :: "i" ( portSVC_RAISE_PRIVILEGE ) : "memory" );\r
 264 \r
 265     /**\r
 266      * @brief Lowers the privilege level by setting the bit 0 of the CONTROL\r
 267      * register.\r
 268      */\r
 269     #define portRESET_PRIVILEGE()                               vResetPrivilege()\r
 270 #else\r
 271     #define portIS_PRIVILEGED()\r
 272     #define portRAISE_PRIVILEGE()\r
 273     #define portRESET_PRIVILEGE()\r
 274 #endif /* configENABLE_MPU */\r
 275 /*-----------------------------------------------------------*/\r
 276 \r
 277 #ifdef __cplusplus\r
 278 }\r
 279 #endif\r
 280 \r
 281 #endif /* PORTMACRO_H */\r