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