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

   1 /*\r
   2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 \r
  71 #ifndef PORTMACRO_H\r
  72 #define PORTMACRO_H\r
  73 \r
  74 #ifdef __cplusplus\r
  75 extern "C" {\r
  76 #endif\r
  77 \r
  78 /*-----------------------------------------------------------\r
  79  * Port specific definitions.\r
  80  *\r
  81  * The settings in this file configure FreeRTOS correctly for the\r
  82  * given hardware and compiler.\r
  83  *\r
  84  * These settings should not be altered.\r
  85  *-----------------------------------------------------------\r
  86  */\r
  87 \r
  88 /* Type definitions. */\r
  89 #define portCHAR                char\r
  90 #define portFLOAT               float\r
  91 #define portDOUBLE              double\r
  92 #define portLONG                long\r
  93 #define portSHORT               short\r
  94 #define portSTACK_TYPE  uint32_t\r
  95 #define portBASE_TYPE   long\r
  96 \r
  97 typedef portSTACK_TYPE StackType_t;\r
  98 typedef long BaseType_t;\r
  99 typedef unsigned long UBaseType_t;\r
 100 \r
 101 #if( configUSE_16_BIT_TICKS == 1 )\r
 102         typedef uint16_t TickType_t;\r
 103         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 104 #else\r
 105         typedef uint32_t TickType_t;\r
 106         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 107 \r
 108         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 109         not need to be guarded with a critical section. */\r
 110         #define portTICK_TYPE_IS_ATOMIC 1\r
 111 #endif\r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* MPU specific constants. */\r
 115 #define portUSING_MPU_WRAPPERS          1\r
 116 #define portPRIVILEGE_BIT                       ( 0x80000000UL )\r
 117 \r
 118 #define portMPU_REGION_READ_WRITE                               ( 0x03UL << 24UL )\r
 119 #define portMPU_REGION_PRIVILEGED_READ_ONLY             ( 0x05UL << 24UL )\r
 120 #define portMPU_REGION_READ_ONLY                                ( 0x06UL << 24UL )\r
 121 #define portMPU_REGION_PRIVILEGED_READ_WRITE    ( 0x01UL << 24UL )\r
 122 #define portMPU_REGION_CACHEABLE_BUFFERABLE             ( 0x07UL << 16UL )\r
 123 #define portMPU_REGION_EXECUTE_NEVER                    ( 0x01UL << 28UL )\r
 124 \r
 125 #define portUNPRIVILEGED_FLASH_REGION           ( 0UL )\r
 126 #define portPRIVILEGED_FLASH_REGION                     ( 1UL )\r
 127 #define portPRIVILEGED_RAM_REGION                       ( 2UL )\r
 128 #define portGENERAL_PERIPHERALS_REGION          ( 3UL )\r
 129 #define portSTACK_REGION                                        ( 4UL )\r
 130 #define portFIRST_CONFIGURABLE_REGION       ( 5UL )\r
 131 #define portLAST_CONFIGURABLE_REGION            ( 7UL )\r
 132 #define portNUM_CONFIGURABLE_REGIONS            ( ( portLAST_CONFIGURABLE_REGION - portFIRST_CONFIGURABLE_REGION ) + 1 )\r
 133 #define portTOTAL_NUM_REGIONS                           ( portNUM_CONFIGURABLE_REGIONS + 1 ) /* Plus one to make space for the stack region. */\r
 134 \r
 135 void vPortSwitchToUserMode( void );\r
 136 #define portSWITCH_TO_USER_MODE()       vPortSwitchToUserMode()\r
 137 \r
 138 typedef struct MPU_REGION_REGISTERS\r
 139 {\r
 140         uint32_t ulRegionBaseAddress;\r
 141         uint32_t ulRegionAttribute;\r
 142 } xMPU_REGION_REGISTERS;\r
 143 \r
 144 /* Plus 1 to create space for the stack region. */\r
 145 typedef struct MPU_SETTINGS\r
 146 {\r
 147         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];\r
 148 } xMPU_SETTINGS;\r
 149 \r
 150 /* Architecture specifics. */\r
 151 #define portSTACK_GROWTH                        ( -1 )\r
 152 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 153 #define portBYTE_ALIGNMENT                      8\r
 154 \r
 155 /* Constants used with memory barrier intrinsics. */\r
 156 #define portSY_FULL_READ_WRITE          ( 15 )\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 /* SVC numbers for various services. */\r
 161 #define portSVC_START_SCHEDULER                         0\r
 162 #define portSVC_YIELD                                           1\r
 163 #define portSVC_RAISE_PRIVILEGE                         2\r
 164 \r
 165 /* Scheduler utilities. */\r
 166 \r
 167 #define portYIELD()                             __asm{ SVC portSVC_YIELD }\r
 168 #define portYIELD_WITHIN_API()                                                                                                  \\r
 169 {                                                                                                                                                               \\r
 170         /* Set a PendSV to request a context switch. */                                                         \\r
 171         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                                                         \\r
 172                                                                                                                                                                 \\r
 173         /* Barriers are normally not required but do ensure the code is completely      \\r
 174         within the specified behaviour for the architecture. */                                         \\r
 175         __dsb( portSY_FULL_READ_WRITE );                                                                                        \\r
 176         __isb( portSY_FULL_READ_WRITE );                                                                                        \\r
 177 }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 181 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 182 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET\r
 183 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 /* Critical section management. */\r
 187 extern void vPortEnterCritical( void );\r
 188 extern void vPortExitCritical( void );\r
 189 \r
 190 #define portDISABLE_INTERRUPTS()                                vPortRaiseBASEPRI()\r
 191 #define portENABLE_INTERRUPTS()                                 vPortSetBASEPRI(0)\r
 192 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 193 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 194 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortRaiseBASEPRI()\r
 195 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 196 \r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 /* Architecture specific optimisations. */\r
 200 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 201         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 202 #endif\r
 203 \r
 204 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 205 \r
 206         /* Check the configuration. */\r
 207         #if( configMAX_PRIORITIES > 32 )\r
 208                 #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
 209         #endif\r
 210 \r
 211         /* Store/clear the ready priorities in a bit map. */\r
 212         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 213         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 214 \r
 215         /*-----------------------------------------------------------*/\r
 216 \r
 217         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) __clz( ( uxReadyPriorities ) ) )\r
 218 \r
 219 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 223 not necessary for to use this port.  They are defined so the common demo files\r
 224 (which build with all the ports) will build. */\r
 225 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 226 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 227 /*-----------------------------------------------------------*/\r
 228 \r
 229 #ifdef configASSERT\r
 230         void vPortValidateInterruptPriority( void );\r
 231         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 232 #endif\r
 233 \r
 234 /* portNOP() is not required by this port. */\r
 235 #define portNOP()\r
 236 \r
 237 #define portINLINE __inline\r
 238 \r
 239 #ifndef portFORCE_INLINE\r
 240         #define portFORCE_INLINE __forceinline\r
 241 #endif\r
 242 \r
 243 /*-----------------------------------------------------------*/\r
 244 \r
 245 static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )\r
 246 {\r
 247         __asm\r
 248         {\r
 249                 /* Barrier instructions are not used as this function is only used to\r
 250                 lower the BASEPRI value. */\r
 251                 msr basepri, ulBASEPRI\r
 252         }\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 static portFORCE_INLINE void vPortRaiseBASEPRI( void )\r
 257 {\r
 258 uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 259 \r
 260         __asm\r
 261         {\r
 262                 /* Set BASEPRI to the max syscall priority to effect a critical\r
 263                 section. */\r
 264                 msr basepri, ulNewBASEPRI\r
 265                 dsb\r
 266                 isb\r
 267         }\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 static portFORCE_INLINE void vPortClearBASEPRIFromISR( void )\r
 272 {\r
 273         __asm\r
 274         {\r
 275                 /* Set BASEPRI to 0 so no interrupts are masked.  This function is only\r
 276                 used to lower the mask in an interrupt, so memory barriers are not \r
 277                 used. */\r
 278                 msr basepri, #0\r
 279         }\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 284 {\r
 285 uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 286 \r
 287         __asm\r
 288         {\r
 289                 /* Set BASEPRI to the max syscall priority to effect a critical\r
 290                 section. */\r
 291                 mrs ulReturn, basepri\r
 292                 msr basepri, ulNewBASEPRI\r
 293                 dsb\r
 294                 isb\r
 295         }\r
 296 \r
 297         return ulReturn;\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt( void )\r
 302 {\r
 303 uint32_t ulCurrentInterrupt;\r
 304 BaseType_t xReturn;\r
 305 \r
 306         /* Obtain the number of the currently executing interrupt. */\r
 307         __asm\r
 308         {\r
 309                 mrs ulCurrentInterrupt, ipsr\r
 310         }\r
 311 \r
 312         if( ulCurrentInterrupt == 0 )\r
 313         {\r
 314                 xReturn = pdFALSE;\r
 315         }\r
 316         else\r
 317         {\r
 318                 xReturn = pdTRUE;\r
 319         }\r
 320 \r
 321         return xReturn;\r
 322 }\r
 323 /*-----------------------------------------------------------*/\r
 324 \r
 325 /* Set the privilege level to user mode if xRunningPrivileged is false. */\r
 326 portFORCE_INLINE static void vPortResetPrivilege( BaseType_t xRunningPrivileged )\r
 327 {\r
 328 uint32_t ulReg;\r
 329         \r
 330         if( xRunningPrivileged != pdTRUE ) \r
 331         {\r
 332                 __asm \r
 333                 {\r
 334                         mrs ulReg, control\r
 335                         orr ulReg, #1\r
 336                         msr control, ulReg\r
 337                 }\r
 338         }\r
 339 }\r
 340 /*-----------------------------------------------------------*/\r
 341 \r
 342 \r
 343 #ifdef __cplusplus\r
 344 }\r
 345 #endif\r
 346 \r
 347 #endif /* PORTMACRO_H */\r
 348 \r