begriffs open source - freertos/blob - portable/GCC/ARM_CM3_MPU/portmacro.h

   1 /*
   2  * FreeRTOS SMP 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
  29 #ifndef PORTMACRO_H
  30     #define PORTMACRO_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
  40  * given hardware and compiler.
  41  *
  42  * These settings should not be altered.
  43  *-----------------------------------------------------------
  44  */
  45
  46 /* Type definitions. */
  47     #define portCHAR          char
  48     #define portFLOAT         float
  49     #define portDOUBLE        double
  50     #define portLONG          long
  51     #define portSHORT         short
  52     #define portSTACK_TYPE    uint32_t
  53     #define portBASE_TYPE     long
  54
  55     typedef portSTACK_TYPE   StackType_t;
  56     typedef long             BaseType_t;
  57     typedef unsigned long    UBaseType_t;
  58
  59     #if ( configUSE_16_BIT_TICKS == 1 )
  60         typedef uint16_t     TickType_t;
  61         #define portMAX_DELAY              ( TickType_t ) 0xffff
  62     #else
  63         typedef uint32_t     TickType_t;
  64         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  65
  66 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  67  * not need to be guarded with a critical section. */
  68         #define portTICK_TYPE_IS_ATOMIC    1
  69     #endif
  70 /*-----------------------------------------------------------*/
  71
  72 /* MPU specific constants. */
  73     #define portUSING_MPU_WRAPPERS                                   1
  74     #define portPRIVILEGE_BIT                                        ( 0x80000000UL )
  75
  76     #define portMPU_REGION_READ_WRITE                                ( 0x03UL << 24UL )
  77     #define portMPU_REGION_PRIVILEGED_READ_ONLY                      ( 0x05UL << 24UL )
  78     #define portMPU_REGION_READ_ONLY                                 ( 0x06UL << 24UL )
  79     #define portMPU_REGION_PRIVILEGED_READ_WRITE                     ( 0x01UL << 24UL )
  80     #define portMPU_REGION_PRIVILEGED_READ_WRITE_UNPRIV_READ_ONLY    ( 0x02UL << 24UL )
  81     #define portMPU_REGION_CACHEABLE_BUFFERABLE                      ( 0x07UL << 16UL )
  82     #define portMPU_REGION_EXECUTE_NEVER                             ( 0x01UL << 28UL )
  83
  84     #define portUNPRIVILEGED_FLASH_REGION                            ( 0UL )
  85     #define portPRIVILEGED_FLASH_REGION                              ( 1UL )
  86     #define portPRIVILEGED_RAM_REGION                                ( 2UL )
  87     #define portGENERAL_PERIPHERALS_REGION                           ( 3UL )
  88     #define portSTACK_REGION                                         ( 4UL )
  89     #define portFIRST_CONFIGURABLE_REGION                            ( 5UL )
  90     #define portLAST_CONFIGURABLE_REGION                             ( 7UL )
  91     #define portNUM_CONFIGURABLE_REGIONS                             ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )
  92     #define portTOTAL_NUM_REGIONS                                    ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */
  93
  94     #define portSWITCH_TO_USER_MODE()    __asm volatile ( " mrs r0, control \n orr r0, #1 \n msr control, r0 " ::: "r0", "memory" )
  95
  96     typedef struct MPU_REGION_REGISTERS
  97     {
  98         uint32_t ulRegionBaseAddress;
  99         uint32_t ulRegionAttribute;
 100     } xMPU_REGION_REGISTERS;
 101
 102 /* Plus 1 to create space for the stack region. */
 103     typedef struct MPU_SETTINGS
 104     {
 105         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];
 106     } xMPU_SETTINGS;
 107
 108 /* Architecture specifics. */
 109     #define portSTACK_GROWTH      ( -1 )
 110     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 111     #define portBYTE_ALIGNMENT    8
 112     #define portDONT_DISCARD      __attribute__( ( used ) )
 113 /*-----------------------------------------------------------*/
 114
 115 /* SVC numbers for various services. */
 116     #define portSVC_START_SCHEDULER    0
 117     #define portSVC_YIELD              1
 118     #define portSVC_RAISE_PRIVILEGE    2
 119
 120 /* Scheduler utilities. */
 121
 122     #define portYIELD()    __asm volatile ( "   SVC     %0      \n"::"i" ( portSVC_YIELD ) : "memory" )
 123     #define portYIELD_WITHIN_API()                      \
 124     {                                                   \
 125         /* Set a PendSV to request a context switch. */ \
 126         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
 127                                                         \
 128         /* Barriers are normally not required but do ensure the code is completely \
 129          * within the specified behaviour for the architecture. */ \
 130         __asm volatile ( "dsb" ::: "memory" );                     \
 131         __asm volatile ( "isb" );                                  \
 132     }
 133
 134     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
 135     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
 136     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT
 137     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
 138 /*-----------------------------------------------------------*/
 139
 140 /* Critical section management. */
 141     extern void vPortEnterCritical( void );
 142     extern void vPortExitCritical( void );
 143     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortRaiseBASEPRI()
 144     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vPortSetBASEPRI( x )
 145     #define portDISABLE_INTERRUPTS()                  vPortRaiseBASEPRI()
 146     #define portENABLE_INTERRUPTS()                   vPortSetBASEPRI( 0 )
 147     #define portENTER_CRITICAL()                      vPortEnterCritical()
 148     #define portEXIT_CRITICAL()                       vPortExitCritical()
 149
 150 /*-----------------------------------------------------------*/
 151
 152 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
 153  * not necessary for to use this port.  They are defined so the common demo files
 154  * (which build with all the ports) will build. */
 155     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 156     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 157 /*-----------------------------------------------------------*/
 158
 159 /* Architecture specific optimisations. */
 160     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 161         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
 162     #endif
 163
 164     #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
 165
 166 /* Generic helper function. */
 167         __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )
 168         {
 169             uint8_t ucReturn;
 170
 171             __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) : "memory" );
 172
 173             return ucReturn;
 174         }
 175
 176 /* Check the configuration. */
 177         #if ( configMAX_PRIORITIES > 32 )
 178             #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
 179         #endif
 180
 181 /* Store/clear the ready priorities in a bit map. */
 182         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
 183         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
 184
 185 /*-----------------------------------------------------------*/
 186
 187         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )
 188
 189     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 190
 191 /*-----------------------------------------------------------*/
 192
 193     #ifdef configASSERT
 194         void vPortValidateInterruptPriority( void );
 195         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
 196     #endif
 197
 198 /* portNOP() is not required by this port. */
 199     #define portNOP()
 200
 201     #define portINLINE              __inline
 202
 203     #ifndef portFORCE_INLINE
 204         #define portFORCE_INLINE    inline __attribute__( ( always_inline ) )
 205     #endif
 206 /*-----------------------------------------------------------*/
 207
 208     extern BaseType_t xIsPrivileged( void );
 209     extern void vResetPrivilege( void );
 210
 211 /**
 212  * @brief Checks whether or not the processor is privileged.
 213  *
 214  * @return 1 if the processor is already privileged, 0 otherwise.
 215  */
 216     #define portIS_PRIVILEGED()      xIsPrivileged()
 217
 218 /**
 219  * @brief Raise an SVC request to raise privilege.
 220  */
 221     #define portRAISE_PRIVILEGE()    __asm volatile ( "svc %0 \n" ::"i" ( portSVC_RAISE_PRIVILEGE ) : "memory" );
 222
 223 /**
 224  * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
 225  * register.
 226  */
 227     #define portRESET_PRIVILEGE()    vResetPrivilege()
 228 /*-----------------------------------------------------------*/
 229
 230     portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
 231     {
 232         uint32_t ulCurrentInterrupt;
 233         BaseType_t xReturn;
 234
 235         /* Obtain the number of the currently executing interrupt. */
 236         __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
 237
 238         if( ulCurrentInterrupt == 0 )
 239         {
 240             xReturn = pdFALSE;
 241         }
 242         else
 243         {
 244             xReturn = pdTRUE;
 245         }
 246
 247         return xReturn;
 248     }
 249
 250 /*-----------------------------------------------------------*/
 251
 252     portFORCE_INLINE static void vPortRaiseBASEPRI( void )
 253     {
 254         uint32_t ulNewBASEPRI;
 255
 256         __asm volatile
 257         (
 258             "   mov %0, %1                                                                                              \n"\
 259             "   msr basepri, %0                                                                                 \n"\
 260             "   isb                                                                                                             \n"\
 261             "   dsb                                                                                                             \n"\
 262             : "=r" ( ulNewBASEPRI ) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "memory"
 263         );
 264     }
 265
 266 /*-----------------------------------------------------------*/
 267
 268     portFORCE_INLINE static uint32_t ulPortRaiseBASEPRI( void )
 269     {
 270         uint32_t ulOriginalBASEPRI, ulNewBASEPRI;
 271
 272         __asm volatile
 273         (
 274             "   mrs %0, basepri                                                                                 \n"\
 275             "   mov %1, %2                                                                                              \n"\
 276             "   msr basepri, %1                                                                                 \n"\
 277             "   isb                                                                                                             \n"\
 278             "   dsb                                                                                                             \n"\
 279             : "=r" ( ulOriginalBASEPRI ), "=r" ( ulNewBASEPRI ) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "memory"
 280         );
 281
 282         /* This return will not be reached but is necessary to prevent compiler
 283          * warnings. */
 284         return ulOriginalBASEPRI;
 285     }
 286 /*-----------------------------------------------------------*/
 287
 288     portFORCE_INLINE static void vPortSetBASEPRI( uint32_t ulNewMaskValue )
 289     {
 290         __asm volatile
 291         (
 292             "   msr basepri, %0 "::"r" ( ulNewMaskValue ) : "memory"
 293         );
 294     }
 295 /*-----------------------------------------------------------*/
 296
 297     #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )
 298
 299     #ifndef configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY
 300         #warning "configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY is not defined. We recommend defining it to 1 in FreeRTOSConfig.h for better security. https://www.FreeRTOS.org/FreeRTOS-V10.3.x.html"
 301         #define configENFORCE_SYSTEM_CALLS_FROM_KERNEL_ONLY    0
 302     #endif
 303 /*-----------------------------------------------------------*/
 304     #ifdef __cplusplus
 305         }
 306     #endif
 307
 308 #endif /* PORTMACRO_H */