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