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

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