begriffs open source - freertos/blob - portable/GCC/ARM_CM35P_NTZ/non_secure/portmacrocommon.h

   1 /*
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * SPDX-License-Identifier: MIT
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   8  * this software and associated documentation files (the "Software"), to deal in
   9  * the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  11  * the Software, and to permit persons to whom the Software is furnished to do so,
  12  * subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in all
  15  * copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * https://www.FreeRTOS.org
  25  * https://github.com/FreeRTOS
  26  *
  27  */
  28
  29 #ifndef PORTMACROCOMMON_H
  30 #define PORTMACROCOMMON_H
  31
  32 /* *INDENT-OFF* */
  33 #ifdef __cplusplus
  34     extern "C" {
  35 #endif
  36 /* *INDENT-ON* */
  37
  38 /*------------------------------------------------------------------------------
  39  * Port specific definitions.
  40  *
  41  * The settings in this file configure FreeRTOS correctly for the given hardware
  42  * and compiler.
  43  *
  44  * These settings should not be altered.
  45  *------------------------------------------------------------------------------
  46  */
  47
  48 #ifndef configENABLE_FPU
  49     #error configENABLE_FPU must be defined in FreeRTOSConfig.h.  Set configENABLE_FPU to 1 to enable the FPU or 0 to disable the FPU.
  50 #endif /* configENABLE_FPU */
  51
  52 #ifndef configENABLE_MPU
  53     #error configENABLE_MPU must be defined in FreeRTOSConfig.h.  Set configENABLE_MPU to 1 to enable the MPU or 0 to disable the MPU.
  54 #endif /* configENABLE_MPU */
  55
  56 #ifndef configENABLE_TRUSTZONE
  57     #error configENABLE_TRUSTZONE must be defined in FreeRTOSConfig.h.  Set configENABLE_TRUSTZONE to 1 to enable TrustZone or 0 to disable TrustZone.
  58 #endif /* configENABLE_TRUSTZONE */
  59
  60 /*-----------------------------------------------------------*/
  61
  62 /**
  63  * @brief Type definitions.
  64  */
  65 #define portCHAR          char
  66 #define portFLOAT         float
  67 #define portDOUBLE        double
  68 #define portLONG          long
  69 #define portSHORT         short
  70 #define portSTACK_TYPE    uint32_t
  71 #define portBASE_TYPE     long
  72
  73 typedef portSTACK_TYPE   StackType_t;
  74 typedef long             BaseType_t;
  75 typedef unsigned long    UBaseType_t;
  76
  77 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  78     typedef uint16_t     TickType_t;
  79     #define portMAX_DELAY              ( TickType_t ) 0xffff
  80 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  81     typedef uint32_t     TickType_t;
  82     #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  83
  84 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  85  * not need to be guarded with a critical section. */
  86     #define portTICK_TYPE_IS_ATOMIC    1
  87 #else
  88     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  89 #endif
  90 /*-----------------------------------------------------------*/
  91
  92 /**
  93  * Architecture specifics.
  94  */
  95 #define portSTACK_GROWTH                   ( -1 )
  96 #define portTICK_PERIOD_MS                 ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  97 #define portBYTE_ALIGNMENT                 8
  98 #define portNOP()
  99 #define portINLINE                         __inline
 100 #ifndef portFORCE_INLINE
 101     #define portFORCE_INLINE               inline __attribute__( ( always_inline ) )
 102 #endif
 103 #define portHAS_STACK_OVERFLOW_CHECKING    1
 104 /*-----------------------------------------------------------*/
 105
 106 /**
 107  * @brief Extern declarations.
 108  */
 109 extern BaseType_t xPortIsInsideInterrupt( void );
 110
 111 extern void vPortYield( void ) /* PRIVILEGED_FUNCTION */;
 112
 113 extern void vPortEnterCritical( void ) /* PRIVILEGED_FUNCTION */;
 114 extern void vPortExitCritical( void ) /* PRIVILEGED_FUNCTION */;
 115
 116 extern uint32_t ulSetInterruptMask( void ) /* __attribute__(( naked )) PRIVILEGED_FUNCTION */;
 117 extern void vClearInterruptMask( uint32_t ulMask ) /* __attribute__(( naked )) PRIVILEGED_FUNCTION */;
 118
 119 #if ( configENABLE_TRUSTZONE == 1 )
 120     extern void vPortAllocateSecureContext( uint32_t ulSecureStackSize );     /* __attribute__ (( naked )) */
 121     extern void vPortFreeSecureContext( uint32_t * pulTCB ) /* __attribute__ (( naked )) PRIVILEGED_FUNCTION */;
 122 #endif /* configENABLE_TRUSTZONE */
 123
 124 #if ( configENABLE_MPU == 1 )
 125     extern BaseType_t xIsPrivileged( void ) /* __attribute__ (( naked )) */;
 126     extern void vResetPrivilege( void ) /* __attribute__ (( naked )) */;
 127 #endif /* configENABLE_MPU */
 128 /*-----------------------------------------------------------*/
 129
 130 /**
 131  * @brief MPU specific constants.
 132  */
 133 #if ( configENABLE_MPU == 1 )
 134     #define portUSING_MPU_WRAPPERS    1
 135     #define portPRIVILEGE_BIT         ( 0x80000000UL )
 136 #else
 137     #define portPRIVILEGE_BIT         ( 0x0UL )
 138 #endif /* configENABLE_MPU */
 139
 140 /* MPU settings that can be overriden in FreeRTOSConfig.h. */
 141 #ifndef configTOTAL_MPU_REGIONS
 142     /* Define to 8 for backward compatibility. */
 143     #define configTOTAL_MPU_REGIONS    ( 8UL )
 144 #endif
 145
 146 /* MPU regions. */
 147 #define portPRIVILEGED_FLASH_REGION                   ( 0UL )
 148 #define portUNPRIVILEGED_FLASH_REGION                 ( 1UL )
 149 #define portUNPRIVILEGED_SYSCALLS_REGION              ( 2UL )
 150 #define portPRIVILEGED_RAM_REGION                     ( 3UL )
 151 #define portSTACK_REGION                              ( 4UL )
 152 #define portFIRST_CONFIGURABLE_REGION                 ( 5UL )
 153 #define portLAST_CONFIGURABLE_REGION                  ( configTOTAL_MPU_REGIONS - 1UL )
 154 #define portNUM_CONFIGURABLE_REGIONS                  ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )
 155 #define portTOTAL_NUM_REGIONS                         ( portNUM_CONFIGURABLE_REGIONS + 1 )       /* Plus one to make space for the stack region. */
 156
 157 /* Device memory attributes used in MPU_MAIR registers.
 158  *
 159  * 8-bit values encoded as follows:
 160  *  Bit[7:4] - 0000 - Device Memory
 161  *  Bit[3:2] - 00 --> Device-nGnRnE
 162  *              01 --> Device-nGnRE
 163  *              10 --> Device-nGRE
 164  *              11 --> Device-GRE
 165  *  Bit[1:0] - 00, Reserved.
 166  */
 167 #define portMPU_DEVICE_MEMORY_nGnRnE                  ( 0x00 )       /* 0000 0000 */
 168 #define portMPU_DEVICE_MEMORY_nGnRE                   ( 0x04 )       /* 0000 0100 */
 169 #define portMPU_DEVICE_MEMORY_nGRE                    ( 0x08 )       /* 0000 1000 */
 170 #define portMPU_DEVICE_MEMORY_GRE                     ( 0x0C )       /* 0000 1100 */
 171
 172 /* Normal memory attributes used in MPU_MAIR registers. */
 173 #define portMPU_NORMAL_MEMORY_NON_CACHEABLE           ( 0x44 )       /* Non-cacheable. */
 174 #define portMPU_NORMAL_MEMORY_BUFFERABLE_CACHEABLE    ( 0xFF )       /* Non-Transient, Write-back, Read-Allocate and Write-Allocate. */
 175
 176 /* Attributes used in MPU_RBAR registers. */
 177 #define portMPU_REGION_NON_SHAREABLE                  ( 0UL << 3UL )
 178 #define portMPU_REGION_INNER_SHAREABLE                ( 1UL << 3UL )
 179 #define portMPU_REGION_OUTER_SHAREABLE                ( 2UL << 3UL )
 180
 181 #define portMPU_REGION_PRIVILEGED_READ_WRITE          ( 0UL << 1UL )
 182 #define portMPU_REGION_READ_WRITE                     ( 1UL << 1UL )
 183 #define portMPU_REGION_PRIVILEGED_READ_ONLY           ( 2UL << 1UL )
 184 #define portMPU_REGION_READ_ONLY                      ( 3UL << 1UL )
 185
 186 #define portMPU_REGION_EXECUTE_NEVER                  ( 1UL )
 187 /*-----------------------------------------------------------*/
 188
 189 /**
 190  * @brief Settings to define an MPU region.
 191  */
 192 typedef struct MPURegionSettings
 193 {
 194     uint32_t ulRBAR;     /**< RBAR for the region. */
 195     uint32_t ulRLAR;     /**< RLAR for the region. */
 196 } MPURegionSettings_t;
 197
 198 /**
 199  * @brief MPU settings as stored in the TCB.
 200  */
 201 typedef struct MPU_SETTINGS
 202 {
 203     uint32_t ulMAIR0;                                                  /**< MAIR0 for the task containing attributes for all the 4 per task regions. */
 204     MPURegionSettings_t xRegionsSettings[ portTOTAL_NUM_REGIONS ];     /**< Settings for 4 per task regions. */
 205 } xMPU_SETTINGS;
 206 /*-----------------------------------------------------------*/
 207
 208 /**
 209  * @brief Validate priority of ISRs that are allowed to call FreeRTOS
 210  * system calls.
 211  */
 212 #ifdef configASSERT
 213     #if ( portHAS_BASEPRI == 1 )
 214         void vPortValidateInterruptPriority( void );
 215         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
 216     #endif
 217 #endif
 218
 219 /**
 220  * @brief SVC numbers.
 221  */
 222 #define portSVC_ALLOCATE_SECURE_CONTEXT    0
 223 #define portSVC_FREE_SECURE_CONTEXT        1
 224 #define portSVC_START_SCHEDULER            2
 225 #define portSVC_RAISE_PRIVILEGE            3
 226 /*-----------------------------------------------------------*/
 227
 228 /**
 229  * @brief Scheduler utilities.
 230  */
 231 #define portYIELD()    vPortYield()
 232 #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
 233 #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
 234 #define portEND_SWITCHING_ISR( xSwitchRequired )                                 \
 235     do { if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; } \
 236     while( 0 )
 237 #define portYIELD_FROM_ISR( x )    portEND_SWITCHING_ISR( x )
 238 /*-----------------------------------------------------------*/
 239
 240 /**
 241  * @brief Critical section management.
 242  */
 243 #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMask()
 244 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMask( x )
 245 #define portENTER_CRITICAL()                      vPortEnterCritical()
 246 #define portEXIT_CRITICAL()                       vPortExitCritical()
 247 /*-----------------------------------------------------------*/
 248
 249 /**
 250  * @brief Tickless idle/low power functionality.
 251  */
 252 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 253     extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 254     #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 255 #endif
 256 /*-----------------------------------------------------------*/
 257
 258 /**
 259  * @brief Task function macros as described on the FreeRTOS.org WEB site.
 260  */
 261 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 262 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 263 /*-----------------------------------------------------------*/
 264
 265 #if ( configENABLE_TRUSTZONE == 1 )
 266
 267 /**
 268  * @brief Allocate a secure context for the task.
 269  *
 270  * Tasks are not created with a secure context. Any task that is going to call
 271  * secure functions must call portALLOCATE_SECURE_CONTEXT() to allocate itself a
 272  * secure context before it calls any secure function.
 273  *
 274  * @param[in] ulSecureStackSize The size of the secure stack to be allocated.
 275  */
 276     #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )    vPortAllocateSecureContext( ulSecureStackSize )
 277
 278 /**
 279  * @brief Called when a task is deleted to delete the task's secure context,
 280  * if it has one.
 281  *
 282  * @param[in] pxTCB The TCB of the task being deleted.
 283  */
 284     #define portCLEAN_UP_TCB( pxTCB )                           vPortFreeSecureContext( ( uint32_t * ) pxTCB )
 285 #endif /* configENABLE_TRUSTZONE */
 286 /*-----------------------------------------------------------*/
 287
 288 #if ( configENABLE_MPU == 1 )
 289
 290 /**
 291  * @brief Checks whether or not the processor is privileged.
 292  *
 293  * @return 1 if the processor is already privileged, 0 otherwise.
 294  */
 295     #define portIS_PRIVILEGED()      xIsPrivileged()
 296
 297 /**
 298  * @brief Raise an SVC request to raise privilege.
 299  *
 300  * The SVC handler checks that the SVC was raised from a system call and only
 301  * then it raises the privilege. If this is called from any other place,
 302  * the privilege is not raised.
 303  */
 304     #define portRAISE_PRIVILEGE()    __asm volatile ( "svc %0 \n" ::"i" ( portSVC_RAISE_PRIVILEGE ) : "memory" );
 305
 306 /**
 307  * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
 308  * register.
 309  */
 310     #define portRESET_PRIVILEGE()    vResetPrivilege()
 311 #else
 312     #define portIS_PRIVILEGED()
 313     #define portRAISE_PRIVILEGE()
 314     #define portRESET_PRIVILEGE()
 315 #endif /* configENABLE_MPU */
 316 /*-----------------------------------------------------------*/
 317
 318 /**
 319  * @brief Barriers.
 320  */
 321 #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )
 322 /*-----------------------------------------------------------*/
 323
 324 /* *INDENT-OFF* */
 325 #ifdef __cplusplus
 326     }
 327 #endif
 328 /* *INDENT-ON* */
 329
 330 #endif /* PORTMACROCOMMON_H */