git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CM4_MPU/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 \r
  30 #ifndef PORTMACRO_H\r
  31 #define PORTMACRO_H\r
  32 \r
  33 #ifdef __cplusplus\r
  34 extern "C" {\r
  35 #endif\r
  36 \r
  37 /*-----------------------------------------------------------\r
  38  * Port specific definitions.\r
  39  *\r
  40  * The settings in this file configure FreeRTOS correctly for the\r
  41  * given hardware and compiler.\r
  42  *\r
  43  * These settings should not be altered.\r
  44  *-----------------------------------------------------------\r
  45  */\r
  46 \r
  47 /* Type definitions. */\r
  48 #define portCHAR                char\r
  49 #define portFLOAT               float\r
  50 #define portDOUBLE              double\r
  51 #define portLONG                long\r
  52 #define portSHORT               short\r
  53 #define portSTACK_TYPE  uint32_t\r
  54 #define portBASE_TYPE   long\r
  55 \r
  56 typedef portSTACK_TYPE StackType_t;\r
  57 typedef long BaseType_t;\r
  58 typedef unsigned long UBaseType_t;\r
  59 \r
  60 #if( configUSE_16_BIT_TICKS == 1 )\r
  61         typedef uint16_t TickType_t;\r
  62         #define portMAX_DELAY ( TickType_t ) 0xffff\r
  63 #else\r
  64         typedef uint32_t TickType_t;\r
  65         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  66 \r
  67         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  68         not need to be guarded with a critical section. */\r
  69         #define portTICK_TYPE_IS_ATOMIC 1\r
  70 #endif\r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 /* MPU specific constants. */\r
  74 #define portUSING_MPU_WRAPPERS          1\r
  75 #define portPRIVILEGE_BIT                       ( 0x80000000UL )\r
  76 \r
  77 #define portMPU_REGION_READ_WRITE                               ( 0x03UL << 24UL )\r
  78 #define portMPU_REGION_PRIVILEGED_READ_ONLY             ( 0x05UL << 24UL )\r
  79 #define portMPU_REGION_READ_ONLY                                ( 0x06UL << 24UL )\r
  80 #define portMPU_REGION_PRIVILEGED_READ_WRITE    ( 0x01UL << 24UL )\r
  81 #define portMPU_REGION_CACHEABLE_BUFFERABLE             ( 0x07UL << 16UL )\r
  82 #define portMPU_REGION_EXECUTE_NEVER                    ( 0x01UL << 28UL )\r
  83 \r
  84 #define portUNPRIVILEGED_FLASH_REGION           ( 0UL )\r
  85 #define portPRIVILEGED_FLASH_REGION                     ( 1UL )\r
  86 #define portPRIVILEGED_RAM_REGION                       ( 2UL )\r
  87 #define portGENERAL_PERIPHERALS_REGION          ( 3UL )\r
  88 #define portSTACK_REGION                                        ( 4UL )\r
  89 #define portFIRST_CONFIGURABLE_REGION       ( 5UL )\r
  90 #define portLAST_CONFIGURABLE_REGION            ( 7UL )\r
  91 #define portNUM_CONFIGURABLE_REGIONS            ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )\r
  92 #define portTOTAL_NUM_REGIONS                           ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */\r
  93 \r
  94 void vPortSwitchToUserMode( void );\r
  95 #define portSWITCH_TO_USER_MODE()       vPortSwitchToUserMode()\r
  96 \r
  97 typedef struct MPU_REGION_REGISTERS\r
  98 {\r
  99         uint32_t ulRegionBaseAddress;\r
 100         uint32_t ulRegionAttribute;\r
 101 } xMPU_REGION_REGISTERS;\r
 102 \r
 103 /* Plus 1 to create space for the stack region. */\r
 104 typedef struct MPU_SETTINGS\r
 105 {\r
 106         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];\r
 107 } xMPU_SETTINGS;\r
 108 \r
 109 /* Architecture specifics. */\r
 110 #define portSTACK_GROWTH                        ( -1 )\r
 111 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 112 #define portBYTE_ALIGNMENT                      8\r
 113 \r
 114 /* Constants used with memory barrier intrinsics. */\r
 115 #define portSY_FULL_READ_WRITE          ( 15 )\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* SVC numbers for various services. */\r
 120 #define portSVC_START_SCHEDULER                         0\r
 121 #define portSVC_YIELD                                           1\r
 122 #define portSVC_RAISE_PRIVILEGE                         2\r
 123 \r
 124 /* Scheduler utilities. */\r
 125 \r
 126 #define portYIELD()                             __asm{ SVC portSVC_YIELD }\r
 127 #define portYIELD_WITHIN_API()                                                                                                  \\r
 128 {                                                                                                                                                               \\r
 129         /* Set a PendSV to request a context switch. */                                                         \\r
 130         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                                                         \\r
 131                                                                                                                                                                 \\r
 132         /* Barriers are normally not required but do ensure the code is completely      \\r
 133         within the specified behaviour for the architecture. */                                         \\r
 134         __dsb( portSY_FULL_READ_WRITE );                                                                                        \\r
 135         __isb( portSY_FULL_READ_WRITE );                                                                                        \\r
 136 }\r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 140 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 141 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
 142 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /* Critical section management. */\r
 146 extern void vPortEnterCritical( void );\r
 147 extern void vPortExitCritical( void );\r
 148 \r
 149 #define portDISABLE_INTERRUPTS()                                vPortRaiseBASEPRI()\r
 150 #define portENABLE_INTERRUPTS()                                 vPortSetBASEPRI(0)\r
 151 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 152 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 153 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortRaiseBASEPRI()\r
 154 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 155 \r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 /* Architecture specific optimisations. */\r
 159 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 160         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 161 #endif\r
 162 \r
 163 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 164 \r
 165         /* Check the configuration. */\r
 166         #if( configMAX_PRIORITIES > 32 )\r
 167                 #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.\r
 168         #endif\r
 169 \r
 170         /* Store/clear the ready priorities in a bit map. */\r
 171         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 172         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 173 \r
 174         /*-----------------------------------------------------------*/\r
 175 \r
 176         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) __clz( ( uxReadyPriorities ) ) )\r
 177 \r
 178 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 182 not necessary for to use this port.  They are defined so the common demo files\r
 183 (which build with all the ports) will build. */\r
 184 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 185 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 #ifdef configASSERT\r
 189         void vPortValidateInterruptPriority( void );\r
 190         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 191 #endif\r
 192 \r
 193 /* portNOP() is not required by this port. */\r
 194 #define portNOP()\r
 195 \r
 196 #define portINLINE __inline\r
 197 \r
 198 #ifndef portFORCE_INLINE\r
 199         #define portFORCE_INLINE __forceinline\r
 200 #endif\r
 201 \r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )\r
 205 {\r
 206         __asm\r
 207         {\r
 208                 /* Barrier instructions are not used as this function is only used to\r
 209                 lower the BASEPRI value. */\r
 210                 msr basepri, ulBASEPRI\r
 211         }\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 static portFORCE_INLINE void vPortRaiseBASEPRI( void )\r
 216 {\r
 217 uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 218 \r
 219         __asm\r
 220         {\r
 221                 /* Set BASEPRI to the max syscall priority to effect a critical\r
 222                 section. */\r
 223                 msr basepri, ulNewBASEPRI\r
 224                 dsb\r
 225                 isb\r
 226         }\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 static portFORCE_INLINE void vPortClearBASEPRIFromISR( void )\r
 231 {\r
 232         __asm\r
 233         {\r
 234                 /* Set BASEPRI to 0 so no interrupts are masked.  This function is only\r
 235                 used to lower the mask in an interrupt, so memory barriers are not\r
 236                 used. */\r
 237                 msr basepri, #0\r
 238         }\r
 239 }\r
 240 /*-----------------------------------------------------------*/\r
 241 \r
 242 static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 243 {\r
 244 uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 245 \r
 246         __asm\r
 247         {\r
 248                 /* Set BASEPRI to the max syscall priority to effect a critical\r
 249                 section. */\r
 250                 mrs ulReturn, basepri\r
 251                 msr basepri, ulNewBASEPRI\r
 252                 dsb\r
 253                 isb\r
 254         }\r
 255 \r
 256         return ulReturn;\r
 257 }\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt( void )\r
 261 {\r
 262 uint32_t ulCurrentInterrupt;\r
 263 BaseType_t xReturn;\r
 264 \r
 265         /* Obtain the number of the currently executing interrupt. */\r
 266         __asm\r
 267         {\r
 268                 mrs ulCurrentInterrupt, ipsr\r
 269         }\r
 270 \r
 271         if( ulCurrentInterrupt == 0 )\r
 272         {\r
 273                 xReturn = pdFALSE;\r
 274         }\r
 275         else\r
 276         {\r
 277                 xReturn = pdTRUE;\r
 278         }\r
 279 \r
 280         return xReturn;\r
 281 }\r
 282 /*-----------------------------------------------------------*/\r
 283 \r
 284 /* Set the privilege level to user mode if xRunningPrivileged is false. */\r
 285 portFORCE_INLINE static void vPortResetPrivilege( BaseType_t xRunningPrivileged )\r
 286 {\r
 287 uint32_t ulReg;\r
 288 \r
 289         if( xRunningPrivileged != pdTRUE )\r
 290         {\r
 291                 __asm\r
 292                 {\r
 293                         mrs ulReg, control\r
 294                         orr ulReg, #1\r
 295                         msr control, ulReg\r
 296                 }\r
 297         }\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 \r
 302 #ifdef __cplusplus\r
 303 }\r
 304 #endif\r
 305 \r
 306 #endif /* PORTMACRO_H */\r
 307 \r