git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/ARM_CM3_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 #define portSWITCH_TO_USER_MODE() __asm volatile ( " mrs r0, control \n orr r0, #1 \n msr control, r0 " :::"r0" )\r
 136 \r
 137 typedef struct MPU_REGION_REGISTERS\r
 138 {\r
 139         uint32_t ulRegionBaseAddress;\r
 140         uint32_t ulRegionAttribute;\r
 141 } xMPU_REGION_REGISTERS;\r
 142 \r
 143 /* Plus 1 to create space for the stack region. */\r
 144 typedef struct MPU_SETTINGS\r
 145 {\r
 146         xMPU_REGION_REGISTERS xRegion[ portTOTAL_NUM_REGIONS ];\r
 147 } xMPU_SETTINGS;\r
 148 \r
 149 /* Architecture specifics. */\r
 150 #define portSTACK_GROWTH                        ( -1 )\r
 151 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 152 #define portBYTE_ALIGNMENT                      8\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 /* SVC numbers for various services. */\r
 156 #define portSVC_START_SCHEDULER                         0\r
 157 #define portSVC_YIELD                                           1\r
 158 #define portSVC_RAISE_PRIVILEGE                         2\r
 159 \r
 160 /* Scheduler utilities. */\r
 161 \r
 162 #define portYIELD()                             __asm volatile ( "      SVC     %0      \n" :: "i" (portSVC_YIELD) )\r
 163 #define portYIELD_WITHIN_API()                                                                                                  \\r
 164 {                                                                                                                                                               \\r
 165         /* Set a PendSV to request a context switch. */                                                         \\r
 166         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                                                         \\r
 167                                                                                                                                                                 \\r
 168         /* Barriers are normally not required but do ensure the code is completely      \\r
 169         within the specified behaviour for the architecture. */                                         \\r
 170         __asm volatile( "dsb" );                                                                                                        \\r
 171         __asm volatile( "isb" );                                                                                                        \\r
 172 }\r
 173 \r
 174 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 175 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 176 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
 177 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 /* Critical section management. */\r
 181 extern void vPortEnterCritical( void );\r
 182 extern void vPortExitCritical( void );\r
 183 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortRaiseBASEPRI()\r
 184 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 185 #define portDISABLE_INTERRUPTS()                                vPortRaiseBASEPRI()\r
 186 #define portENABLE_INTERRUPTS()                                 vPortSetBASEPRI(0)\r
 187 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 188 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 189 \r
 190 /*-----------------------------------------------------------*/\r
 191 \r
 192 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 193 not necessary for to use this port.  They are defined so the common demo files\r
 194 (which build with all the ports) will build. */\r
 195 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 196 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\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         /* Generic helper function. */\r
 207         __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )\r
 208         {\r
 209         uint8_t ucReturn;\r
 210 \r
 211                 __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );\r
 212                 return ucReturn;\r
 213         }\r
 214 \r
 215         /* Check the configuration. */\r
 216         #if( configMAX_PRIORITIES > 32 )\r
 217                 #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
 218         #endif\r
 219 \r
 220         /* Store/clear the ready priorities in a bit map. */\r
 221         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 222         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 223 \r
 224         /*-----------------------------------------------------------*/\r
 225 \r
 226         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )\r
 227 \r
 228 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 229 \r
 230 /*-----------------------------------------------------------*/\r
 231 \r
 232 #ifdef configASSERT\r
 233         void vPortValidateInterruptPriority( void );\r
 234         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 235 #endif\r
 236 \r
 237 /* portNOP() is not required by this port. */\r
 238 #define portNOP()\r
 239 \r
 240 #define portINLINE      __inline\r
 241 \r
 242 #ifndef portFORCE_INLINE\r
 243         #define portFORCE_INLINE inline __attribute__(( always_inline))\r
 244 #endif\r
 245 \r
 246 /* Set the privilege level to user mode if xRunningPrivileged is false. */\r
 247 portFORCE_INLINE static void vPortResetPrivilege( BaseType_t xRunningPrivileged )\r
 248 {\r
 249         if( xRunningPrivileged != pdTRUE )\r
 250         {\r
 251                 __asm volatile ( " mrs r0, control      \n" \\r
 252                                                  " orr r0, #1           \n" \\r
 253                                                  " msr control, r0      \n"     \\r
 254                                                  :::"r0" );\r
 255         }\r
 256 }\r
 257 /*-----------------------------------------------------------*/\r
 258 \r
 259 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )\r
 260 {\r
 261 uint32_t ulCurrentInterrupt;\r
 262 BaseType_t xReturn;\r
 263 \r
 264         /* Obtain the number of the currently executing interrupt. */\r
 265         __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );\r
 266 \r
 267         if( ulCurrentInterrupt == 0 )\r
 268         {\r
 269                 xReturn = pdFALSE;\r
 270         }\r
 271         else\r
 272         {\r
 273                 xReturn = pdTRUE;\r
 274         }\r
 275 \r
 276         return xReturn;\r
 277 }\r
 278 \r
 279 /*-----------------------------------------------------------*/\r
 280 \r
 281 portFORCE_INLINE static void vPortRaiseBASEPRI( void )\r
 282 {\r
 283 uint32_t ulNewBASEPRI;\r
 284 \r
 285         __asm volatile\r
 286         (\r
 287                 "       mov %0, %1                                                                                              \n"     \\r
 288                 "       msr basepri, %0                                                                                 \n" \\r
 289                 "       isb                                                                                                             \n" \\r
 290                 "       dsb                                                                                                             \n" \\r
 291                 :"=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
 292         );\r
 293 }\r
 294 \r
 295 /*-----------------------------------------------------------*/\r
 296 \r
 297 portFORCE_INLINE static uint32_t ulPortRaiseBASEPRI( void )\r
 298 {\r
 299 uint32_t ulOriginalBASEPRI, ulNewBASEPRI;\r
 300 \r
 301         __asm volatile\r
 302         (\r
 303                 "       mrs %0, basepri                                                                                 \n" \\r
 304                 "       mov %1, %2                                                                                              \n"     \\r
 305                 "       msr basepri, %1                                                                                 \n" \\r
 306                 "       isb                                                                                                             \n" \\r
 307                 "       dsb                                                                                                             \n" \\r
 308                 :"=r" (ulOriginalBASEPRI), "=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
 309         );\r
 310 \r
 311         /* This return will not be reached but is necessary to prevent compiler\r
 312         warnings. */\r
 313         return ulOriginalBASEPRI;\r
 314 }\r
 315 /*-----------------------------------------------------------*/\r
 316 \r
 317 portFORCE_INLINE static void vPortSetBASEPRI( uint32_t ulNewMaskValue )\r
 318 {\r
 319         __asm volatile\r
 320         (\r
 321                 "       msr basepri, %0 " :: "r" ( ulNewMaskValue )\r
 322         );\r
 323 }\r
 324 /*-----------------------------------------------------------*/\r
 325 \r
 326 \r
 327 #ifdef __cplusplus\r
 328 }\r
 329 #endif\r
 330 \r
 331 #endif /* PORTMACRO_H */\r
 332 \r